active_record-events 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2VhZTQxOTNiMmU4MzdmNjgyYjIzNzMwNjMzZjY1MjM3ODJiOGJhZQ==
+    Njk0YzdlMmY0YzRiMmYxNzdjMmE3OTMyODUwNjIzNjgwZmEzOTZiMg==
   data.tar.gz: !binary |-
-    YzRmYWY5M2JmYmNmMGY0ODdiMTIwY2QyZDdkYjhkZDMxODMzYzM3MQ==
+    NDNiMmViY2U5NTNmZmY5ZjQ3NzdkMTY5Mjg4YTlmMTJmMTI3NjI3Yw==
 SHA512:
   metadata.gz: !binary |-
-    Y2NjZTY3YmIyMDBjZjNlMmZiNWU1NjdlZGExMTE0ZGViYTg3NWY4YWY3ZmM3
-    YzBmZjJlNWI4MWFlYWQ0ZWQ5ZmRmZDgxMmI3NTYzM2VlNGZmNGYyYzEyNmE2
-    ZjQ0YzAzNzhmMjk5ZTE0OGZkNjM2YzAzM2IwNzI5MTkxMTU1MmU=
+    OTlhYzQ1ODkwNjg1ZjNkYjhjZTY3ZTgwZWIyYjgxYTgzNDM1NmJlNmExODEy
+    ZTU1MTYxOTllMDAwNmUwOTM0MTVkM2FlODZlN2ZjNzViOTYzNmFmOTk2NTEw
+    Y2JlNzEzZGUyN2EyMTk4M2Q2YWZiNTQ2ODI5NjAzYWY1ZWMwNjY=
   data.tar.gz: !binary |-
-    MDA2M2M3MjY2NzUyYTVhYjJkMmU4ZDhjYmJjNDcxOGU3NDFlNWE5MmFkMDMy
-    ODdhZTFkOWJlYWEyOTcxNjM5MTMxOGEzMmFmZDBlMDc3NDllYjMzZjRlZThl
-    ZTM5ZThmZWM3NzE1NjIyOTY1ZTUyZWY1NTE5MmY5MjY2YmQzZTk=
+    YWZmMzdhYjNmODJlMmY5ZDExOGE1ODBjNmQ3NTc4YTJmOWZlMjIwODU0ZTMz
+    MmJiZjU1ZTJlYjQyOWI4NDA3N2U2NzZjYWFkNDAxNTIyYTE0MDEyMWExOWQz
+    YTA0MmE4MGQzNzNjMWQwNjQzZGQzMzJmZTE3YzBmNDBjMzdlMDg=

data/README.md

@@ -69,6 +69,19 @@ scope :not_completed, -> { where(completed_at: nil) }
 scope :completed, -> { where.not(completed_at: nil) }
 ```
 
+### Subject
+
+There are events which do not relate to a model itself but to one of its attributes – take the `User` model with the `email_confirmed_at` field as an example.
+In order to keep method names grammatically correct, you can specify a subject using the `subject` option.
+
+```ruby
+class User < ActiveRecord::Base
+  has_event :confirm, subject: :email
+end
+```
+
+This will generate `email_confirmed?`, `confirm_email` and `confirm_email!` methods.
+
 ## See also
 
 - [ActiveRecord::Enum](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html)

data/lib/active_record/events.rb

@@ -1,41 +1,34 @@
 require 'active_support'
-require 'verbs'
+require 'active_record/events/naming'
 
 module ActiveRecord
   module Events
-    def self.past_participle(infinitive)
-      options = { tense: :past, aspect: :perfective }
-      infinitive.verb.conjugate(options)
-    end
-
     def has_events(*names)
-      names.each { |n| has_event(n) }
+      options = names.extract_options!
+      names.each { |n| has_event(n, options) }
     end
 
-    def has_event(name)
-      _module = ActiveRecord::Events
-
-      past_participle = _module.past_participle(name)
-      field_name = "#{past_participle}_at"
+    def has_event(name, options = {})
+      naming = Naming.new(name, options)
 
-      define_method("#{past_participle}?") do
-        self[field_name].present?
+      define_method("#{naming.predicate}?") do
+        self[naming.field].present?
       end
 
-      define_method(name) do
-        touch(field_name) if self[field_name].blank?
+      define_method(naming.action) do
+        touch(naming.field) if self[naming.field].blank?
       end
 
-      define_method("#{name}!") do
-        touch(field_name)
+      define_method("#{naming.action}!") do
+        touch(naming.field)
       end
 
-      define_singleton_method(past_participle) do
-        where(arel_table[field_name].not_eq(nil))
+      define_singleton_method(naming.scope) do
+        where(arel_table[naming.field].not_eq(nil))
       end
 
-      define_singleton_method("not_#{past_participle}") do
-        where(arel_table[field_name].eq(nil))
+      define_singleton_method(naming.inverse_scope) do
+        where(arel_table[naming.field].eq(nil))
       end
     end
   end

data/lib/active_record/events/naming.rb

@@ -0,0 +1,39 @@
+require 'verbs'
+
+module ActiveRecord
+  module Events
+    class Naming
+      def initialize(infinitive, options = {})
+        @infinitive = infinitive
+        @subject = options[:subject].presence
+      end
+
+      def field
+        [@subject, past_participle, 'at'].compact.join('_')
+      end
+
+      def predicate
+        [@subject, past_participle].compact.join('_')
+      end
+
+      def action
+        [@infinitive, @subject].compact.join('_')
+      end
+
+      def scope
+        [@subject, past_participle].compact.join('_')
+      end
+
+      def inverse_scope
+        [@subject, 'not', past_participle].compact.join('_')
+      end
+
+      private
+
+      def past_participle
+        options = { tense: :past, aspect: :perfective }
+        @infinitive.verb.conjugate(options)
+      end
+    end
+  end
+end

data/lib/active_record/events/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Events
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/spec/active_record/events/naming_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+RSpec.describe ActiveRecord::Events::Naming do
+  context 'without a subject' do
+    subject { described_class.new(:complete) }
+
+    it 'generates a field name' do
+      expect(subject.field).to eq('completed_at')
+    end
+
+    it 'generates a predicate name' do
+      expect(subject.predicate).to eq('completed')
+    end
+
+    it 'generates an action name' do
+      expect(subject.action).to eq('complete')
+    end
+
+    it 'generates a scope name' do
+      expect(subject.scope).to eq('completed')
+    end
+
+    it 'generates an inverse scope name' do
+      expect(subject.inverse_scope).to eq('not_completed')
+    end
+  end
+
+  context 'with a subject' do
+    subject { described_class.new(:confirm, subject: :email) }
+
+    it 'generates a field name' do
+      expect(subject.field).to eq('email_confirmed_at')
+    end
+
+    it 'generates a predicate name' do
+      expect(subject.predicate).to eq('email_confirmed')
+    end
+
+    it 'generates an action name' do
+      expect(subject.action).to eq('confirm_email')
+    end
+
+    it 'generates a scope name' do
+      expect(subject.scope).to eq('email_confirmed')
+    end
+
+    it 'generates an inverse scope name' do
+      expect(subject.inverse_scope).to eq('email_not_confirmed')
+    end
+  end
+end

data/spec/active_record/events_spec.rb

@@ -28,4 +28,11 @@ RSpec.describe ActiveRecord::Events do
     expect(Task.not_completed).to include(task)
     expect(Task.completed).not_to include(task)
   end
+
+  let(:user) { create(:user) }
+
+  it 'handles a subject' do
+    user.confirm_email
+    expect(user.email_confirmed?).to be(true)
+  end
 end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_event :confirm, subject: :email
+end

data/spec/dummy/db/migrate/20170103215307_create_users.rb

@@ -0,0 +1,9 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.datetime :email_confirmed_at
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20150813132804) do
+ActiveRecord::Schema.define(:version => 20170103215307) do
 
   create_table "tasks", :force => true do |t|
     t.datetime "completed_at"
@@ -19,4 +19,10 @@ ActiveRecord::Schema.define(:version => 20150813132804) do
     t.datetime "updated_at",   :null => false
   end
 
+  create_table "users", :force => true do |t|
+    t.datetime "email_confirmed_at"
+    t.datetime "created_at",         :null => false
+    t.datetime "updated_at",         :null => false
+  end
+
 end

data/spec/support/factories.rb

@@ -1,3 +1,4 @@
 FactoryGirl.define do
   factory :task
+  factory :user
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-events
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Bartosz Pieńkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -133,14 +133,18 @@ files:
 - README.md
 - Rakefile
 - lib/active_record/events.rb
+- lib/active_record/events/naming.rb
 - lib/active_record/events/version.rb
+- spec/active_record/events/naming_spec.rb
 - spec/active_record/events_spec.rb
 - spec/dummy/app/models/task.rb
+- spec/dummy/app/models/user.rb
 - spec/dummy/config/boot.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/migrate/20150813132804_create_tasks.rb
+- spec/dummy/db/migrate/20170103215307_create_users.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
 - spec/spec_helper.rb
@@ -170,13 +174,16 @@ signing_key:
 specification_version: 4
 summary: Manage timestamps in ActiveRecord models
 test_files:
+- spec/active_record/events/naming_spec.rb
 - spec/active_record/events_spec.rb
 - spec/dummy/app/models/task.rb
+- spec/dummy/app/models/user.rb
 - spec/dummy/config/boot.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/migrate/20150813132804_create_tasks.rb
+- spec/dummy/db/migrate/20170103215307_create_users.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
 - spec/spec_helper.rb