Home > Articles > Web Development

Advanced Active Record in Rails 4

In this chapter from The Rails 4 Way, 3rd Edition, Obie Fernandez and Kevin Faustino wrap up their comprehensive coverage of Active Record by reviewing callbacks, single-table inheritance (STI), and polymorphic models. They also review a little bit of information about metaprogramming and Ruby domain-specific languages (DSLs) as they relate to Active Record.
This chapter is from the book

This chapter is from the book

  • Respectful debate, honesty, passion, and working systems created an environment that not even the most die-hard enterprise architect could ignore, no matter how buried in Java design patterns. Thosewho placed technical excellence and pragmaticism above religious attachment and vendor cronyism were easily convinced of the benefits that broadening their definition of acceptable technologies could bring.
  • —Ryan Tomayko1

Active Record is a simple object-relational mapping (ORM) framework compared to other popular ORM frameworks, such as Hibernate in the Java world. Don’t let that fool you, though: Under its modest exterior, Active Record has some pretty advanced features. To really get the most effectiveness out of Rails development, you need to have more than a basic understanding of Active Record—things like knowing when to break out of the one-table/one-class pattern or how to leverage Ruby modules to keep your code clean and free of duplication.

In this chapter, we wrap up this book’s comprehensive coverage of Active Record by reviewing callbacks, single-table inheritance (STI), and polymorphic models. We also review a little bit of information about metaprogramming and Ruby domain-specific languages (DSLs) as they relate to Active Record.

9.1 Scopes

Scopes (or “named scopes” if you’re old school) allow you to define and chain query criteria in a declarative and reusable manner.


1 class Timesheet < ActiveRecord::Base
2   scope :submitted, -> { where(submitted: true) }
3   scope :underutilized, -> { where('total_hours < 40') }

To declare a scope, use the scope class method, passing it a name as a symbol and a callable object that includes a query criteria within. You can simply use Arel criteria methods such as where, order, and limit to construct the definition as shown in the example. The queries defined in a scope are only evaluated whenever the scope is invoked.


1 class User < ActiveRecord::Base
2   scope :delinquent, -> { where('timesheets_updated_at < ?', 1.week.ago) }

Invoke scopes as you would class methods.


>> User.delinquent
=> [#<User id: 2, timesheets_updated_at: "2013-04-20 20:02:13"...>]

Note that instead of using the scope macro-style method, you can simply define a class method on an Active Record model that returns a scoped method, such as where. To illustrate, the following class method is equivalent to the delinquent scope defined in the previous example.


1 def self.delinquent
2   where('timesheets_updated_at < ?', 1.week.ago)
3 end

9.1.1 Scope Parameters

You can pass arguments to scope invocations by adding parameters to the proc you use to define the scope query.


1 class BillableWeek < ActiveRecord::Base
2   scope :newer_than, ->(date) { where('start_date > ?', date) }

Then pass the argument to the scope as you would normally.


BillableWeek.newer_than(Date.today)

9.1.2 Chaining Scopes

One of the benefits of scopes is that you can chain them together to create complex queries from simple ones:


>> Timesheet.underutilized.submitted.to_a
=> [#<Timesheet id: 3, submitted: true, total_hours: 37 ...

Scopes can be chained together for reuse within scope definitions themselves. For instance, let’s say that we always want to constrain the result set of the underutilized scope to only submitted timesheets:


1 class Timesheet < ActiveRecord::Base
2   scope :submitted, -> { where(submitted: true) }
3   scope :underutilized, -> { submitted.where('total_hours < 40') }

9.1.3 Scopes and has_many

In addition to being available at the class context, scopes are available automatically on has_many association attributes.


>> u = User.find(2)
=> #<User id: 2, username: "obie"...>
>> u.timesheets.size
=> 3
>> u.timesheets.underutilized.size
=> 1

9.1.4 Scopes and Joins

You can use Arel’s join method to create cross model scopes. For instance, if we gave our recurring example Timesheet a submitted_at date attribute instead of just a boolean, we could add a scope to User allowing us to see who is late on their timesheet submission.


1 scope :tardy, -> {
2   joins(:timesheets).
3   where("timesheets.submitted_at <= ?", 7.days.ago).
4   group("users.id")
5 }

Arel’s to_sql method is useful for debugging scope definitions and usage.


>> User.tardy.to_sql
=> "SELECT "users".* FROM "users"
   INNER JOIN "timesheets" ON "timesheets"."user_id" = "users"."id"
   WHERE (timesheets.submitted_at <= '2013-04-13 18:16:15.203293')
   GROUP BY users.id"  # query formatted nicely for the book

Note that as demonstrated in the example, it’s a good idea to use unambiguous column references (including the table name) in cross model scope definitions so that Arel doesn’t get confused.

9.1.5 Scope Combinations

Our example of a cross model scope violates good object-oriented design principles: It contains the logic for determining whether or not a Timesheet is submitted, which is code that properly belongs in the Timesheet class. Luckily, we can use Arel’s merge method to fix it. First, we put the late logic where it belongs—in Timesheet:


scope :late, -> { where("timesheet.submitted_at <= ?", 7.days.ago) }

Then we use our new late scope in tardy:


scope :tardy, -> {
  joins(:timesheets).group("users.id").merge(Timesheet.late)
}

If you have trouble with this technique, make absolutely sure that your scopes’ clauses refer to fully qualified column names. (In other words, don’t forget to prefix column names with tables.) The console and to_sql method is your friend for debugging.

9.1.6 Default Scopes

There may arise use cases where you want certain conditions applied to the finders for your model. Consider that our timesheet application has a default view of open timesheets—we can use a default scope to simplify our general queries.


class Timesheet < ActiveRecord::Base
  default_scope { where(status: "open") }
end

Now when we query for our Timesheets, by default, the open condition will be applied:


>> Timesheet.pluck(:status)
=> ["open", "open", "open"]

Default scopes also get applied to your models when building or creating them, which can be a great convenience or a nuisance if you are not careful. In our previous example, all new Timesheets will be created with a status of “open.”


>> Timesheet.new
=> #<Timesheet id: nil, status: "open">
>> Timesheet.create
=> #<Timesheet id: 1, status: "open">

You can override this behavior by providing your own conditions or scope to override the default setting of the attributes.


>> Timesheet.where(status: "new").new
=> #<Timesheet id: nil, status: "new">
>> Timesheet.where(status: "new").create
=> #<Timesheet id: 1, status: "new">

There may be cases where at runtime you want to create a scope and pass it around as a first-class object leveraging your default scope. In this case, Active Record provides the all method.

>> timesheets = Timesheet.all.order("submitted_at DESC")
=> #<ActiveRecord::Relation [#<Timesheet id: 1, status: "open"]>
>> timesheets.where(name: "Durran Jordan").to_a
=> []

There’s another approach to scopes that provides a sleeker syntax: scoping, which allows the chaining of scopes via nesting within a block.

>> Timesheet.order("submitted_at DESC").scoping do
>>   Timesheet.first
>> end
=> #<Timesheet id: 1, status: "open">

That’s pretty nice, but what if we don’t want our default scope to be included in our queries? In this case, Active Record takes care of us through the unscoped method.

>> Timesheet.unscoped.order("submitted_at DESC").to_a
=> [#<Timesheet id: 2, status: "submitted">]

Similarly to overriding our default scope with a relation when creating new objects, we can supply unscoped as well to remove the default attributes.

>> Timesheet.unscoped.new
=> #<Timesheet id: nil, status: nil>

9.1.7 Using Scopes for CRUD

You have a wide range of Active Record’s CRUD methods available on scopes, which gives you some powerful abilities. For instance, let’s give all our underutilized timesheets some extra hours.

>> u.timesheets.underutilized.pluck(:total_hours)
=> [37, 38]

>> u.timesheets.underutilized.update_all("total_hours = total_hours + 2")
=> 2

>> u.timesheets.underutilized.pluck(:total_hours)
=> [39]

Scopes—including a where clause using hashed conditions—will populate attributes of objects built off of them with those attributes as default values. Admittedly, it’s a bit difficult to think of a plausible case for this feature, but we’ll show it in an example. First, we add the following scope to Timesheet:


scope :perfect, -> { submitted.where(total_hours: 40) }

Now building an object on the perfect scope should give us a submitted timesheet with 40 hours.


> Timesheet.perfect.build
=> #<Timesheet id: nil, submitted: true, user_id: nil, total_hours: 40 ...>

As you’ve probably realized by now, the Arel underpinnings of Active Record are tremendously powerful and truly elevate the Rails platform.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020