The Ruby Way, Second Edition: Solutions and Techniques in Ruby Programming (2nd Edition)

Contents......Page 11
Chapter 1 Rails Environments and Configuration......Page 60
  Default Environment Settings......Page 61
  Bootstrapping......Page 62
  RubyGems......Page 64
  Default Load Paths......Page 65
  Rails, Modules, and Auto-Loading Code......Page 66
  Builtin Rails Info......Page 67
  Configuration......Page 68
  Additional Configuration......Page 72
 Development Mode......Page 73
  The Rails Class Loader......Page 74
 Production Mode......Page 76
 Logging......Page 77
  Rails Log Files......Page 79
  Log File Analysis......Page 81
  Syslog......Page 83
 References......Page 84
Chapter 2 Working with Controllers......Page 86
  Request Handling......Page 87
  Getting Intimate with the Dispatcher......Page 88
 Render unto View.........Page 90
  When in Doubt, Render......Page 91
  Rendering Another Action\'s Template......Page 92
  Rendering a Different Template Altogether......Page 93
  Rendering Text......Page 94
  Rendering Nothing......Page 95
  Rendering Options......Page 96
 Redirecting......Page 98
 Controller/View Communication......Page 101
 Filters......Page 102
  Filter Inheritance......Page 103
  Filter Types......Page 105
  Filter Chain Ordering......Page 106
  Around Filters......Page 107
  Filter Chain Skipping......Page 108
  Filter Chain Halting......Page 109
  send_data(data, options = {})......Page 110
  send_file(path, options = {})......Page 111
  Letting the Web Server Send Files......Page 114
 References......Page 115
Chapter 3 Routing......Page 116
 The Two Purposes of Routing......Page 117
 Bound Parameters......Page 119
 Wildcard Components (\"Receptors\")......Page 120
 Static Strings......Page 121
 The routes.rb File......Page 122
  The Default Route......Page 124
  Spotlight on the :id Field......Page 125
  Default Route Generation......Page 126
  Modifying the Default Route......Page 127
 The Ante-Default Route and respond_to......Page 128
  respond_to and the HTTP-Accept Header......Page 129
 The Empty Route......Page 130
 Using Static Strings......Page 131
 Using Your Own \"Receptors\"......Page 132
 A Note on Route Order......Page 134
 Default Parameters and the url_for Method......Page 135
  What Happened to :id?......Page 136
 Route Globbing......Page 138
 Globbing Key-Value Pairs......Page 139
  Creating a Named Route......Page 140
  The Question of Using name_path Versus name_url......Page 141
 What to Name Your Routes......Page 142
  Argument Sugar......Page 143
  A Little More Sugar with Your Sugar?......Page 144
 The Special Scope Method with_options......Page 145
 References......Page 147
 REST in a Rather Small Nutshell......Page 148
 REST in Rails......Page 150
 Routing and CRUD......Page 151
  REST Resources and Rails......Page 152
  From Named Routes to REST Support......Page 153
 The Standard RESTful Controller Actions......Page 155
  Singular and Plural RESTful Routes......Page 157
  The Special Pairs: new/create and edit/update......Page 158
 Singular Resource Routes......Page 159
 Nested Resources......Page 160
  Setting :name_prefix Explicitly......Page 162
  All Together Now......Page 164
  Considerations......Page 166
  Deep Nesting?......Page 167
  Extra Member Routes......Page 169
  Extra Collection Routes......Page 170
  Considerations......Page 171
 Controller-Only Resources......Page 172
 Different Representations of Resources......Page 174
  The respond_to Method......Page 175
 The RESTful Rails Action Set......Page 176
  Index......Page 177
  Destroy......Page 180
  New and Create......Page 182
  Edit and Update......Page 183
 Conclusion......Page 184
 Reference......Page 185
 Examining Routes in the Application Console......Page 186
  Dumping Routes......Page 187
  Anatomy of a Route Object......Page 188
  Recognition and Generation in the Console......Page 191
  Named Routes in the Console......Page 193
 Testing Routes......Page 194
 The Routing Navigator Plugin......Page 195
 References......Page 196
Chapter 6 Working with ActiveRecord......Page 198
 The Basics......Page 199
 Migrations......Page 201
  Creating Migrations......Page 202
  Migration API......Page 205
  Defining Columns......Page 208
  Relationship Declarations......Page 214
  Convention over Configuration......Page 215
  Pluralization......Page 216
  Setting Names Manually......Page 217
  Legacy Naming Schemes......Page 218
  Default Attribute Values......Page 219
  Serialized Attributes......Page 221
  Creating New ActiveRecord Instances......Page 222
  Reading ActiveRecord Objects......Page 223
  Reading and Writing Attributes......Page 225
  Accessing and Manipulating Attributes Before They Are Typecast......Page 227
  Dynamic Attribute-Based Finders......Page 228
  Custom SQL Queries......Page 230
  The Query Cache......Page 231
  Updating......Page 233
  Updating a Particular Instance......Page 235
  Convenience Updaters......Page 236
  Deleting and Destroying......Page 237
 Database Locking......Page 238
  Optimistic Locking......Page 239
  Pessimistic Locking......Page 241
  Conditions......Page 242
  Limit and Offset......Page 245
  Select Option......Page 246
  Group By Option......Page 247
 Connections to Multiple Databases in Different Models......Page 248
  The DatabaseStatements Module......Page 250
  Other Connection Methods......Page 253
 Other Configuration Options......Page 255
 Conclusion......Page 256
 References......Page 257
 The Association Hierarchy......Page 258
 One-to-Many Relationships......Page 260
  Adding Associated Objects to a Collection......Page 262
  AssociationCollection Methods......Page 263
 The belongs_to Association......Page 266
  Building and Creating Related Objects via the Association......Page 267
  belongs_to Options......Page 268
 The has_many Association......Page 274
  has_many Options......Page 275
  Proxy Methods......Page 283
  has_and_belongs_to_many......Page 284
  has_many :through......Page 292
  has_many :through Options......Page 297
  has_one......Page 300
  has_one Options......Page 303
  One-to-One Associations......Page 305
 Association Extensions......Page 306
 The AssociationProxy Class......Page 308
 Conclusion......Page 309
 References......Page 310
 Finding Errors......Page 312
  validates_acceptance_of......Page 313
  validates_associated......Page 314
  validates_each......Page 315
  validates_existence_of......Page 316
  validates_format_of......Page 317
  validates_length_of......Page 318
  validates_numericality_of......Page 319
  validates_uniqueness_of......Page 320
  :message......Page 322
 Conditional Validation......Page 323
  Usage and Considerations......Page 324
 Working with the Errors Object......Page 325
  Checking for Errors......Page 326
 Custom Validation......Page 327
 Skipping Validations......Page 328
 Reference......Page 329
 Callbacks......Page 330
  Callback Registration......Page 331
  Halting Execution......Page 333
  Callback Usages......Page 334
  Special Callbacks: after_initialize and after_find......Page 337
  Callback Classes......Page 338
 Observers......Page 341
  Registration of Observers......Page 342
 Single-Table Inheritance (STI)......Page 343
  Mapping Inheritance to the Database......Page 345
  STI and Associations......Page 347
 Abstract Base Model Classes......Page 350
 Polymorphic has_many Relationships......Page 351
  In the Case of Models with Comments......Page 352
 Modules for Reusing Common Behavior......Page 355
  A Review of Class Scope and Contexts......Page 358
  The included Callback......Page 359
 Modifying ActiveRecord Classes at Runtime......Page 360
  Ruby and Domain-Specific Languages......Page 362
 References......Page 364
Chapter 10 ActionView......Page 366
  ERb Practice......Page 367
  Commenting Out ERb Delimiters......Page 369
  RHTML? RXML? RJS?......Page 370
 Layouts and Templates......Page 371
  Yielding Content......Page 372
  Template Variables......Page 374
  Protecting the Integrity of Your View from User-Submitted Content......Page 378
 Partials......Page 379
  Simple Use Cases......Page 380
  Reuse of Partials......Page 381
  Shared Partials......Page 382
  Passing Variables to Partials......Page 383
  Render Collections......Page 384
 Caching......Page 386
  Action Caching......Page 387
  Fragment Caching......Page 389
  Expiration of Cached Content......Page 392
  Automatic Cache Expiry with Sweepers......Page 394
  Action Cache Plugin......Page 396
  Cache Storage......Page 397
 References......Page 399
Chapter 11 All About Helpers......Page 400
  Reporting Validation Errors......Page 401
  Automatic Form Creation......Page 403
  Customizing the Way Validation Errors Are Highlighted......Page 405
  Head Helpers......Page 407
  For Plugins Only, Add Default JavaScript Includes......Page 411
 CacheHelper......Page 412
 CaptureHelper......Page 413
  The Date and Time Selection Helpers......Page 414
  The Individual Date and Time Select Helpers......Page 415
  distance_in_time Methods with Complex Descriptive Names......Page 418
 DebugHelper......Page 420
  Creating Forms for ActiveRecord Models......Page 421
  How Form Helpers Get Their Values......Page 429
  Select Helpers......Page 430
  Option Helpers......Page 432
 FormTagHelper......Page 437
 JavaScriptHelper......Page 440
 NumberHelper......Page 442
  will_paginate......Page 445
  paginator......Page 446
 RecordIdentificationHelper......Page 447
 RecordTagHelper......Page 449
 TagHelper......Page 450
 TextHelper......Page 452
 UrlHelper......Page 459
  Small Optimizations: The Title Helper......Page 466
  Encapsulating View Logic: The photo_for Helper......Page 467
  Smart View: The breadcrumbs Helper......Page 468
  A tiles Helper......Page 469
  Generalizing Partials......Page 473
 References......Page 476
Chapter 12 Ajax on Rails......Page 478
 Prototype......Page 479
  The Prototype API......Page 480
  Top-Level Functions......Page 481
  Class......Page 483
  Extensions to JavaScript\'s Object Class......Page 484
  Extensions to JavaScript\'s Array Class......Page 485
  Extensions to the Event Class......Page 487
  Extensions to JavaScript\'s Function Class......Page 489
  Extensions to JavaScript\'s Number Class......Page 491
  Extensions to JavaScript\'s String class......Page 492
  The Ajax Object......Page 495
  Enumerable......Page 496
  Hash......Page 502
  ObjectRange......Page 503
  link_to_remote......Page 504
  remote_form_for......Page 508
  observe_field......Page 510
 RJS—Writing Javascript in Ruby......Page 512
  RJS Templates......Page 514
  <<(javascript)......Page 515
  call(function, *arguments, &block)......Page 516
  insert_html(position, id, *options_for_render)......Page 517
  remove(*ids)......Page 518
  sortable(id, options = {})......Page 519
 JSON......Page 520
 Drag and Drop......Page 522
 Sortable......Page 524
 Autocompleter......Page 525
 Conclusion......Page 526
 References......Page 527
Chapter 13 Session Management......Page 528
  Session Use Guidelines......Page 529
 Session Options......Page 530
  Disabling Sessions for Robots......Page 531
  ActiveRecord SessionStore......Page 532
  PStore (File-Based)......Page 533
  memcache Session Storage......Page 534
  The Controversial CookieStore......Page 535
  Session Timeout Plugin for Rails......Page 537
  Tracking Active Sessions......Page 538
  Enhanced Session Security......Page 539
 Cookies......Page 540
  Reading and Writing Cookies......Page 541
 References......Page 542
Chapter 14 Login and Authentication......Page 544
  Installation and Setup......Page 545
  The User Model......Page 546
  The Account Controller......Page 555
  Login from Cookie......Page 557
  The Current User......Page 558
 Logging In During Testing......Page 560
 References......Page 561
 The to_xml Method......Page 562
  Customizing to_xml Output......Page 564
  Associations and to_xml......Page 566
  Advanced to_xml......Page 567
  Dynamic Runtime Attributes......Page 568
  Learning from Array\'s to_xml Method......Page 569
 The XML Builder......Page 572
  Turning XML into Hashes......Page 574
  XmlSimple......Page 575
  Typecasting......Page 577
  Find......Page 578
  Create......Page 581
  Delete......Page 583
  Headers......Page 585
  Customizing......Page 586
  Hash Forms......Page 587
 Conclusion......Page 588
 Setup......Page 590
 Mailer Models......Page 591
  Preparing Outbound Email Messages......Page 592
  HTML Email Messages......Page 595
  Multipart Messages......Page 596
  File Attachments......Page 598
 Receiving E-Mails......Page 599
  TMail::Mail API Reference......Page 600
 Configuration......Page 602
 References......Page 603
Chapter 17 Testing......Page 604
 Rails Testing Terminology......Page 605
  So Much for Isolation.........Page 606
  Rails Mocks?......Page 607
  Real Mocks and Stubs......Page 608
  Integration Tests......Page 609
  Dealing with the Confusion......Page 610
 Test::Unit......Page 611
  Running Tests......Page 612
 Fixtures......Page 613
  CSV Fixtures......Page 614
  Dynamic Fixture Data......Page 615
  Using Fixture Data in Development Mode......Page 616
  Generating Fixtures from Development Data......Page 617
  Fixtures Options......Page 618
  Everybody Hates Fixtures......Page 619
  Basic Assertions......Page 621
  One Assertion per Test Method......Page 625
  Model Testing Basics......Page 627
  Structure and Setup......Page 629
  Functional Test Methods......Page 630
  Common Assertions......Page 631
 Testing Views with Functional Tests......Page 635
  Testing RJS Behavior......Page 640
  Testing Routing Rules......Page 641
  Basics......Page 643
  The Integration Test API......Page 644
  Working with Sessions......Page 645
 Rake Tasks Related to Testing......Page 646
  Acceptance Test First?......Page 647
  Basics......Page 648
  Getting Started......Page 650
  RSelenese......Page 651
 Conclusion......Page 652
 References......Page 653
 Introduction to RSpec......Page 656
  Should and Expectations......Page 657
  Predicates......Page 658
  Custom Expectation Matchers......Page 660
  Multiple Examples per Behavior......Page 662
  Shared Behaviors......Page 663
  RSpec\'s Mocks and Stubs......Page 666
  Running Specs......Page 669
 The RSpec on Rails Plugin......Page 672
  Model Specs......Page 673
  Controller Specs......Page 676
  View Specs......Page 680
  Scaffolding......Page 682
  RCov......Page 683
 Conclusion......Page 684
 References......Page 685
Chapter 19 Extending Rails with Plugins......Page 686
  Reusing Code......Page 687
  The Plugin Script......Page 688
  Subversion and script/plugin......Page 692
  Installation......Page 695
  Importing a Vendor Library......Page 696
  Updating......Page 697
  Piston Properties......Page 698
  The init.rb Hook......Page 699
  The lib Directory......Page 701
  Extending Rails Classes......Page 702
  The README and MIT-LICENSE File......Page 703
  The install.rb and uninstall.rb Files......Page 704
  Custom Rake Tasks......Page 706
  The Plugin\'s Rakefile......Page 707
 Conclusion......Page 708
 References......Page 709
Chapter 20 Rails Production Configurations......Page 710
 Some Basic Prerequisites......Page 711
 The Stack Checklist......Page 713
  Server and Network Environment......Page 714
  Database Tier......Page 715
 Installations......Page 716
  RubyGems......Page 717
  Nginx......Page 718
  MySQL......Page 719
 Configurations......Page 720
  Configuring Mongrel Cluster......Page 721
  Configuring Nginx......Page 722
  Configuring Monit......Page 726
  Nginx init Script......Page 729
  Mongrel init Script......Page 731
  Monit Configuration......Page 732
 Other Production Stack Considerations......Page 734
  Performance and Scalability......Page 735
  Security......Page 736
 Conclusion......Page 737
 References......Page 738
 Overview of Capistrano......Page 740
  The Basics......Page 741
  Installation......Page 743
  \"Capify\" Your Rails Application......Page 744
  Configuring the Deployment......Page 746
  A Little Spin, Please…......Page 747
  Set Up the Deployment Machine......Page 748
  Using a Remote User Account......Page 750
  Working without SCM Access from the Deployment Machine......Page 751
  What If I Don\'t Store database.yml in My SCM Repository?......Page 752
  Variables and Their Scope......Page 755
  Exercise #1: Staging......Page 757
  Exercise #2: Managing Other Services......Page 760
 Multiserver Deployments......Page 761
 Transactions......Page 762
 Proxied Access to Deployment Machines......Page 764
 References......Page 765
Chapter 22 Background Processing......Page 766
  Getting Started......Page 767
  Usage Notes......Page 768
 DRb......Page 769
  Using DRb from Rails......Page 770
  DRb Considerations......Page 771
  Getting Started......Page 772
  Configuration......Page 773
  Using the MiddleMan......Page 774
  Caveats......Page 776
  BackGrounDRb Considerations......Page 777
  Usage......Page 778
  Introducing Threads......Page 779
 References......Page 781
Appendix A: ActiveSupport API Reference......Page 782
Appendix B: Rails Essentials......Page 864
Afterword: What Is the Rails Way (To You)?......Page 874
 A......Page 890
 B......Page 892
 C......Page 893
 D......Page 894
 E......Page 895
 F......Page 896
 H......Page 897
 J-K......Page 898
 M......Page 899
 N......Page 901
 P......Page 902
 Q-R......Page 904
 S......Page 906
 T......Page 908
 W......Page 909
 X-Y-Z......Page 910