microscope 0.5.10 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e689cfc89dab08583830dd95f1f5cd8be83581f
-  data.tar.gz: cf02e022cbb8fccfcf1c0d4bba6d5896a54a056b
+  metadata.gz: 7b92f3130f66038fbee86f9e5adaa467e6800dfe
+  data.tar.gz: 4ee59ea3ff8050b8abd0cc6bb0d9bb668ebaf3ce
 SHA512:
-  metadata.gz: d2ca0c502bd8c445f0fe796ebc412d446c7728bfe871946158d104021b0d9ff3306a05aaca0d8f781c7f0dfbe322f6349a4015e060b0b3d1de1f95e42a3fb4e5
-  data.tar.gz: 12210ee893b5a1603049b2b036397186690a88b7b0bd408865e62898e3212656fb31955f2591b333af7ac3f5a1b25395ca18b573beb68e547b87a48120ab56d2
+  metadata.gz: 08464cec95542735521be16501b95f2d0a8d65cdaeb2bb1baa6b172af3f510e9de8847fec80bd57f8d28b6d0828758e50896b0bf5cc033d646503e4238e765fd
+  data.tar.gz: 5aca9e965185926b4c12ba062b828df3de172e07503c53393cddeef4abea512800f088b7c37a96b35501c1e80eeb14d54fd976a623f9af4f8f5cb31dac9c9352

data/README.md

@@ -29,7 +29,7 @@ create_table "events" do |t|
   t.string   "name"
   t.boolean  "special"
   t.datetime "expired_at"
-  t.date     "started_on"
+  t.date     "archived_on"
 end
 
 class Event < ActiveRecord::Base
@@ -57,39 +57,59 @@ Event.expired_after_or_at(2.months.from_now)
 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.started_before(2.days.ago)
-# SELECT * FROM `events` where `events`.`started_on` < '2013-07-03'
+Event.archived_before(2.days.ago)
+# SELECT * FROM `events` where `events`.`archived_on` < '2013-07-03'
 
-Event.started_between(2.days.ago..3.days.from_now)
-# SELECT * FROM `events` where `events`.`started_on` BETWEEN '2013-07-03' AND '2013-07-08'
+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.started
-# SELECT * FROM `events` where `events`.`started_at` IS NOT NULL AND `events`.`started_at` <= '2013-07-05 15:43:42'
+Event.archived
+# SELECT * FROM `events` where `events`.`archived_on` IS NOT NULL AND `events`.`archived_on` <= '2013-07-05 15:43:42'
 
-Event.not_started
-# SELECT * FROM `events` where `events`.`started_at` IS NULL OR `events`.`started_at` > '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.started.first
-# SELECT * FROM `events` where `events`.`started_at` IS NOT NULL AND `events`.`started_at` <= '2013-07-05 15:43:42' LIMIT 1
+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.started? # => true
-event.not_started? # => false
+event.archived? # => true
+event.not_archived? # => false
 
-event = Event.unstarted.first
-event.started? # => false
+event = Event.unarchived.first
+event.archived? # => false
 
-event.start!
-event.started? # => true
-event.started_at # => 2013-07-05 15:43:44 (Time.now)
+event.archive!
+event.archived? # => true
+event.archived_at # => 2013-07-05 15:43:44 (Time.now)
 ```
 
 ### Options
 
-You can use a few options when calling `acts_as_microscope`:
+#### 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

data/data/irregular_verbs.yml

@@ -18,7 +18,6 @@ burnt: burn
 burst: burst
 bought: buy
 caught: catch
-canceled: cancel
 cancelled: cancel
 chosen: choose
 clung: cling
@@ -32,17 +31,14 @@ dived: dive
 done: do
 drawn: draw
 dreamt: dream
-dreamed: dream
 drunk: drink
 driven: drive
 eaten: eat
-extracted: extract
 fallen: fall
 fed: feed
 felt: feel
 fought: fight
 found: find
-filtered: filter
 fit: fit
 fled: flee
 flung: fling
@@ -125,7 +121,6 @@ spat: spit
 split: split
 spread: spread
 sprung: spring
-started: start
 stood: stand
 stolen: steal
 stuck: stick

data/lib/microscope.rb

@@ -1,5 +1,6 @@
 require "microscope/version"
 
+require 'ostruct'
 require 'active_record'
 require 'active_support'
 
@@ -16,8 +17,22 @@ require "microscope/instance_method/date_instance_method"
 module Microscope
   IRREGULAR_VERBS_FILE = File.expand_path('../../data/irregular_verbs.yml', __FILE__)
 
-  def self.irregular_verbs
-    @irregular_verbs ||= YAML.load_file(IRREGULAR_VERBS_FILE)
+  def self.special_verbs
+    irregular_verbs_from_yaml ||= YAML.load_file(IRREGULAR_VERBS_FILE)
+    special_verbs_from_configuration ||= configuration.special_verbs
+
+    @special_verbs ||= begin
+      irregular_verbs_from_yaml.merge(special_verbs_from_configuration)
+    end
+  end
+
+  def self.configure
+    @configuration = configuration
+    yield(@configuration)
+  end
+
+  def self.configuration
+    @configuration ||= OpenStruct.new(special_verbs: {})
   end
 end
 

data/lib/microscope/instance_method.rb

@@ -24,8 +24,8 @@ module Microscope
     def self.past_participle_to_infinitive(key)
       *key, participle = key.split('_')
 
-      infinitive = if Microscope.irregular_verbs.include?(participle)
-        Microscope.irregular_verbs[participle]
+      infinitive = if Microscope.special_verbs.include?(participle)
+        Microscope.special_verbs[participle]
       elsif participle =~ /ed$/
         participle.sub(/d$/, '')
       else

data/lib/microscope/version.rb

@@ -1,3 +1,3 @@
 module Microscope
-  VERSION = '0.5.10'
+  VERSION = '0.6'
 end

data/spec/microscope/instance_method/date_instance_method_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 describe Microscope::InstanceMethod::DateInstanceMethod do
   before do
+    Microscope.configure do |config|
+      config.special_verbs = { 'started' => 'start' }
+    end
+
     run_migration do
       create_table(:events, force: true) do |t|
         t.date :start_date, default: nil

data/spec/microscope/instance_method/datetime_instance_method_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 describe Microscope::InstanceMethod::DatetimeInstanceMethod do
   before do
+    Microscope.configure do |config|
+      config.special_verbs = { 'started' => 'start' }
+    end
+
     run_migration do
       create_table(:events, force: true) do |t|
         t.datetime :started_at, default: nil

data/spec/microscope/instance_method_spec.rb

@@ -3,8 +3,14 @@ require 'spec_helper'
 describe Microscope::InstanceMethod do
   describe :ClassMethods do
     describe :past_participle_to_infinitive do
-      let(:past_participles) { ['liked', 'loved', 'gateway_canceled', 'started', 'fed'] }
-      let(:infinitives) { ['like', 'love', 'gateway_cancel', 'start', 'feed'] }
+      before do
+        Microscope.configure do |config|
+          config.special_verbs = { 'started' => 'start', 'foo' => 'bar', 'canceled' => 'cancel' }
+        end
+      end
+
+      let(:past_participles) { ['liked', 'loved', 'gateway_canceled', 'started', 'fed', 'foo'] }
+      let(:infinitives) { ['like', 'love', 'gateway_cancel', 'start', 'feed', 'bar'] }
       let(:mapped_past_participles) { past_participles.map { |v| Microscope::InstanceMethod.past_participle_to_infinitive(v) } }
 
       specify do

data/spec/spec_helper.rb

@@ -19,7 +19,12 @@ RSpec.configure do |config|
   config.include ModelMacros
 
   config.before :each do
+    # Establish ActiveRecord database connection
     adapter = ENV['DB_ADAPTER'] || 'sqlite3'
     setup_database(adapter: adapter, database: 'microscope_test')
+
+    # Reset internal variables
+    Microscope.instance_variable_set(:@configuration, nil)
+    Microscope.instance_variable_set(:@special_verbs, nil)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microscope
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: '0.6'
 platform: ruby
 authors:
 - Simon Prévost
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport