Microscope adds useful scopes targeting ActiveRecord boolean, date and datetime fields.

--- ## Installation Add this line to your application's Gemfile: ```ruby gem 'microscope' ``` ## Usage ```ruby create_table "events" do |t| t.string "name" t.boolean "special" t.datetime "expired_at" t.date "archived_on" end class Event < ActiveRecord::Base acts_as_microscope end Event.special # SELECT * FROM `events` where `events`.`special` = 1 Event.not_special # SELECT * FROM `events` where `events`.`special` = 0 Time.now # => 2013-07-05 15:43:42 Event.expired_before(2.months.ago) # SELECT * FROM `events` where `events`.`expired_at` < '2013-05-05 15:43:42' Event.expired_before_now # SELECT * FROM `events` where `events`.`expired_at` < '2013-07-05 15:43:42' Event.expired_after_or_at(2.months.from_now) # SELECT * FROM `events` where `events`.`expired_at` >= '2013-09-05 15:43:42' Event.expired_between(2.months.ago..1.month.from_now) # SELECT * FROM `events` where `events`.`expired_at` BETWEEN '2013-05-05 15:43:42' AND '2013-08-05 15:43:42' Event.archived_before(2.days.ago) # SELECT * FROM `events` where `events`.`archived_on` < '2013-07-03' Event.archived_between(2.days.ago..3.days.from_now) # SELECT * FROM `events` where `events`.`archived_on` BETWEEN '2013-07-03' AND '2013-07-08' Event.archived # SELECT * FROM `events` where `events`.`archived_on` IS NOT NULL AND `events`.`archived_on` <= '2013-07-05 15:43:42' Event.not_archived # SELECT * FROM `events` where `events`.`archived_on` IS NULL OR `events`.`archived_on` > '2013-07-05 15:43:42' ``` Microscope also adds three instance methods to the model per scope. ```ruby event = Event.archived.first # SELECT * FROM `events` where `events`.`archived_on` IS NOT NULL AND `events`.`archived_on` <= '2013-07-05 15:43:42' LIMIT 1 event.archived? # => true event.not_archived? # => false event = Event.unarchived.first event.archived? # => false event.archive! event.archived? # => true event.archived_at # => 2013-07-05 15:43:44 (Time.now) ``` ### Options #### Special verbs Microscope uses a rather simple process to convert field names to infinitive verbs. It just removes the `d` if there’s one at the end of the verb. It also has its own irregular verbs list. For example, a `liked_at` field name will give `like!` and `unlike!` instance methods to records. But you can configure Microscope to use your own special verbs. For example: ```ruby # config/initializers/microscope.rb Microscope.configure do |config| config.special_verbs = { 'extracted' => 'extract', 'started' => 'start' } end ``` #### On `acts_as_microscope` You can also use a few options when calling `acts_as_microscope`: ```ruby class Event < ActiveRecord::Base acts_as_microscope, only: [:created_at] end class User < ActiveRecord::Base acts_as_microscope, except: [:created_at] end Event.created_before(2.months.ago) # works! Event.updated_before(2.months.ago) # NoMethodError User.created_before(2.months.ago) # NoMethodError User.updated_before(2.months.ago) # works! ``` ## License `Microscope` is © 2013-2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause). See the [`LICENSE.md`](https://github.com/mirego/microscope/blob/master/LICENSE.md) file. The microscope logo is based on [this lovely icon](http://thenounproject.com/noun/microscope/#icon-No9056) by [Scott Lewis](http://thenounproject.com/iconify), from The Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license. ## About Mirego [Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org). We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.