active_record-events 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d3c49af800cff40043af18ec6357dd41a8492a75942525701fa607b078a0bb0
-  data.tar.gz: 01b3d06c56050a764fa67b772e8fdf6f791603be7e220773d7e7547a53450ef6
+  metadata.gz: 5039a0306f7a2a2c89a4e6cea36d6995153caeaf8e2941ac12baea60e351f9bd
+  data.tar.gz: ffaa64e1917f5824b67e9a9b72f6edff09a25b05149aff624c08974e8ab264b5
 SHA512:
-  metadata.gz: a3f18c26a27d1eca9ee0517ea19dbf087019200e02fa02b95f0412c4901f4a2aec4239115fc38191d1e6ad7f643067f1567fde10633ace0beb71ddb4623f027b
-  data.tar.gz: a388c51a55a45a13bccc7aad2288aefbef85c49ba322f6bd7fe0791aa4f378b1be1e41ac85562c732168be41553499560e1f8d79a2e0ea2b4691d25980189087
+  metadata.gz: ce136868ee5545c3a13d28a766b43adb868c3b6f4e92574f006eb7338d1247982fceeff0aca60f39ad395b90bfb002a65f964f2180914dde566397e79676918b
+  data.tar.gz: 9acbffdd536499d00fb481d3eb16d60798fb34e6cfdefb0daf5c6f1400e5b3cb750d5e50892dea62c897c673d0f2e14221173ea1cba486cccc77f6b6ffe4055a

data/README.md

@@ -1,4 +1,4 @@
-# ActiveRecord::Events [![Gem version](https://img.shields.io/gem/v/active_record-events.svg)](https://rubygems.org/gems/active_record-events) [![Build status](https://img.shields.io/travis/pienkowb/active_record-events.svg)](https://travis-ci.org/pienkowb/active_record-events)
+# ActiveRecord::Events [![Gem version](https://img.shields.io/gem/v/active_record-events)](https://rubygems.org/gems/active_record-events) [![Build status](https://img.shields.io/travis/pienkowb/active_record-events/develop)](https://travis-ci.org/pienkowb/active_record-events) [![Coverage status](https://img.shields.io/coveralls/github/pienkowb/active_record-events/develop)](https://coveralls.io/github/pienkowb/active_record-events) [![Maintainability status](https://img.shields.io/codeclimate/maintainability/pienkowb/active_record-events)](https://codeclimate.com/github/pienkowb/active_record-events)
 
 An ActiveRecord extension providing convenience methods for timestamp management.
 
@@ -93,14 +93,24 @@ In such a case, many lines of code can be replaced with an expressive one-liner.
 has_events :complete, :archive
 ```
 
-### Setting a field type
+### Date fields
 
-In case of date fields, which by convention have names ending with `_on` instead of `_at` (e.g. `delivered_on`), the `field_type` option needs to be passed to the macro:
+In case of date fields, which by convention have names ending with `_on` instead of `_at` (e.g. `completed_on`), the `field_type` option needs to be passed to the macro:
 
 ```ruby
-has_event :deliver, field_type: :date
+has_event :complete, field_type: :date
 ```
 
+### Custom field name
+
+If there's a field with a name that doesn't follow the naming convention (i.e. does not end with `_at` or `_on`), you can pass it as the `field_name` option.
+
+```ruby
+has_event :complete, field_name: :completion_time
+```
+
+Note that the `field_name` option takes precedence over the `field_type` option.
+
 ### Specifying an object
 
 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.

data/Rakefile

@@ -22,9 +22,23 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require 'standalone_migrations'
+require 'active_record'
+require 'yaml'
 
-StandaloneMigrations::Tasks.load_tasks
+include ActiveRecord::Tasks
+
+dummy_root = File.expand_path('spec/dummy', __dir__)
+database_config = YAML.load_file("#{dummy_root}/config/database.yml")
+
+DatabaseTasks.root = dummy_root
+DatabaseTasks.env = ENV['RAILS_ENV'] || 'development'
+DatabaseTasks.db_dir = "#{dummy_root}/db"
+DatabaseTasks.database_configuration = database_config
+DatabaseTasks.migrations_paths = "#{dummy_root}/db/migrate"
+
+task :environment do
+  require "#{dummy_root}/config/environment.rb"
+end
 
 ACTIVE_RECORD_MIGRATION_CLASS =
   if ActiveRecord::VERSION::MAJOR >= 5
@@ -33,6 +47,8 @@ ACTIVE_RECORD_MIGRATION_CLASS =
     ActiveRecord::Migration
   end
 
+load 'active_record/railties/databases.rake'
+
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core'

data/lib/active_record/events.rb

@@ -1,57 +1,13 @@
 require 'active_support'
-require 'active_record/events/naming'
-
-module ActiveRecord
-  module Events
-    def has_events(*names)
-      options = names.extract_options!
-      names.each { |n| has_event(n, options) }
-    end
-
-    def has_event(name, options = {})
-      naming = Naming.new(name, options)
-
-      include(Module.new do
-        define_method(naming.predicate) do
-          self[naming.field].present?
-        end
-
-        define_method(naming.inverse_predicate) do
-          !__send__(naming.predicate)
-        end
 
-        define_method(naming.action) do
-          touch(naming.field)
-        end
+require 'active_record/events/version'
 
-        define_method(naming.safe_action) do
-          __send__(naming.action) if __send__(naming.inverse_predicate)
-        end
-      end)
-
-      extend(Module.new do
-        define_method(naming.collective_action) do
-          if respond_to?(:touch_all)
-            touch_all(naming.field)
-          else
-            update_all(naming.field => Time.current)
-          end
-        end
-
-        unless options[:skip_scopes]
-          define_method(naming.scope) do
-            where(arel_table[naming.field].not_eq(nil))
-          end
+require 'active_record/events/naming'
+require 'active_record/events/method_factory'
+require 'active_record/events/extension'
 
-          define_method(naming.inverse_scope) do
-            where(arel_table[naming.field].eq(nil))
-          end
-        end
-      end)
-    end
-  end
-end
+require 'active_record/events/macro'
 
 ActiveSupport.on_load(:active_record) do
-  extend ActiveRecord::Events
+  extend ActiveRecord::Events::Extension
 end

data/lib/active_record/events/extension.rb

@@ -0,0 +1,19 @@
+require 'active_record/events/method_factory'
+
+module ActiveRecord
+  module Events
+    module Extension
+      def has_events(*names)
+        options = names.extract_options!
+        names.each { |n| has_event(n, options) }
+      end
+
+      def has_event(name, options = {})
+        method_factory = MethodFactory.new(name, options)
+
+        include method_factory.instance_methods
+        extend method_factory.class_methods
+      end
+    end
+  end
+end

data/lib/active_record/events/method_factory.rb

@@ -0,0 +1,84 @@
+require 'active_record/events/naming'
+
+module ActiveRecord
+  module Events
+    class MethodFactory
+      def initialize(event_name, options)
+        @options = options
+        @naming = Naming.new(event_name, options)
+      end
+
+      def instance_methods
+        Module.new.tap do |module_|
+          define_predicate_method(module_, naming)
+          define_inverse_predicate_method(module_, naming)
+
+          define_action_method(module_, naming)
+          define_safe_action_method(module_, naming)
+        end
+      end
+
+      def class_methods
+        Module.new.tap do |module_|
+          define_collective_action_method(module_, naming)
+
+          unless options[:skip_scopes]
+            define_scope_method(module_, naming)
+            define_inverse_scope_method(module_, naming)
+          end
+        end
+      end
+
+      private
+
+      attr_reader :options
+      attr_reader :naming
+
+      def define_predicate_method(module_, naming)
+        module_.send(:define_method, naming.predicate) do
+          self[naming.field].present?
+        end
+      end
+
+      def define_inverse_predicate_method(module_, naming)
+        module_.send(:define_method, naming.inverse_predicate) do
+          !__send__(naming.predicate)
+        end
+      end
+
+      def define_action_method(module_, naming)
+        module_.send(:define_method, naming.action) do
+          touch(naming.field)
+        end
+      end
+
+      def define_safe_action_method(module_, naming)
+        module_.send(:define_method, naming.safe_action) do
+          __send__(naming.action) if __send__(naming.inverse_predicate)
+        end
+      end
+
+      def define_collective_action_method(module_, naming)
+        module_.send(:define_method, naming.collective_action) do
+          if respond_to?(:touch_all)
+            touch_all(naming.field)
+          else
+            update_all(naming.field => Time.current)
+          end
+        end
+      end
+
+      def define_scope_method(module_, naming)
+        module_.send(:define_method, naming.scope) do
+          where(arel_table[naming.field].not_eq(nil))
+        end
+      end
+
+      def define_inverse_scope_method(module_, naming)
+        module_.send(:define_method, naming.inverse_scope) do
+          where(arel_table[naming.field].eq(nil))
+        end
+      end
+    end
+  end
+end

data/lib/active_record/events/naming.rb

@@ -1,4 +1,4 @@
-require 'active_record/events/verbs'
+require 'verbs'
 
 module ActiveRecord
   module Events
@@ -6,11 +6,15 @@ module ActiveRecord
       def initialize(infinitive, options = {})
         @infinitive = infinitive
         @object = options[:object].presence
+        @field_name = options[:field_name].to_s
         @field_type = options[:field_type].try(:to_sym)
       end
 
       def field
+        return field_name if field_name.present?
+
         suffix = field_type == :date ? 'on' : 'at'
+
         concatenate(object, past_participle, suffix)
       end
 
@@ -46,6 +50,7 @@ module ActiveRecord
 
       attr_reader :infinitive
       attr_reader :object
+      attr_reader :field_name
       attr_reader :field_type
 
       def concatenate(*parts)

data/lib/active_record/events/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Events
-    VERSION = '3.0.0'.freeze
+    VERSION = '4.0.0'.freeze
   end
 end

data/spec/active_record/events/method_factory_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+RSpec.describe ActiveRecord::Events::MethodFactory do
+  let(:event_name) { :complete }
+  let(:options) { {} }
+
+  subject { described_class.new(event_name, options) }
+
+  it 'generates instance methods' do
+    result = subject.instance_methods
+
+    expect(result).to have_method(:completed?)
+    expect(result).to have_method(:not_completed?)
+    expect(result).to have_method(:complete!)
+    expect(result).to have_method(:complete)
+  end
+
+  it 'generates class methods' do
+    result = subject.class_methods
+
+    expect(result).to have_method(:complete_all)
+    expect(result).to have_method(:completed)
+    expect(result).to have_method(:not_completed)
+  end
+
+  context 'with the object option' do
+    let(:options) { { object: :task } }
+
+    it 'generates instance methods' do
+      result = subject.instance_methods
+
+      expect(result).to have_method(:task_completed?)
+      expect(result).to have_method(:task_not_completed?)
+      expect(result).to have_method(:complete_task!)
+      expect(result).to have_method(:complete_task)
+    end
+
+    it 'generates class methods' do
+      result = subject.class_methods
+
+      expect(result).to have_method(:complete_all_tasks)
+      expect(result).to have_method(:task_completed)
+      expect(result).to have_method(:task_not_completed)
+    end
+  end
+
+  context 'with the skip scopes option' do
+    let(:options) { { skip_scopes: true } }
+
+    it 'generates class methods without scopes' do
+      result = subject.class_methods
+
+      expect(result).to have_method(:complete_all)
+
+      expect(result).not_to have_method(:completed)
+      expect(result).not_to have_method(:not_completed)
+    end
+  end
+end

data/spec/active_record/events/naming_spec.rb

@@ -1,7 +1,10 @@
 require 'spec_helper'
 
 RSpec.describe ActiveRecord::Events::Naming do
-  subject { described_class.new(:complete) }
+  let(:event_name) { :complete }
+  let(:options) { {} }
+
+  subject { described_class.new(event_name, options) }
 
   it 'generates a field name' do
     expect(subject.field).to eq('completed_at')
@@ -36,46 +39,54 @@ RSpec.describe ActiveRecord::Events::Naming do
   end
 
   context 'with an object' do
-    subject { described_class.new(:confirm, object: :email) }
+    let(:options) { { object: :task } }
 
     it 'generates a field name' do
-      expect(subject.field).to eq('email_confirmed_at')
+      expect(subject.field).to eq('task_completed_at')
     end
 
     it 'generates a predicate name' do
-      expect(subject.predicate).to eq('email_confirmed?')
+      expect(subject.predicate).to eq('task_completed?')
     end
 
     it 'generates an inverse predicate name' do
-      expect(subject.inverse_predicate).to eq('email_not_confirmed?')
+      expect(subject.inverse_predicate).to eq('task_not_completed?')
     end
 
     it 'generates an action name' do
-      expect(subject.action).to eq('confirm_email!')
+      expect(subject.action).to eq('complete_task!')
     end
 
     it 'generates a safe action name' do
-      expect(subject.safe_action).to eq('confirm_email')
+      expect(subject.safe_action).to eq('complete_task')
     end
 
     it 'generates a collective action name' do
-      expect(subject.collective_action).to eq('confirm_all_emails')
+      expect(subject.collective_action).to eq('complete_all_tasks')
     end
 
     it 'generates a scope name' do
-      expect(subject.scope).to eq('email_confirmed')
+      expect(subject.scope).to eq('task_completed')
     end
 
     it 'generates an inverse scope name' do
-      expect(subject.inverse_scope).to eq('email_not_confirmed')
+      expect(subject.inverse_scope).to eq('task_not_completed')
     end
   end
 
   context 'with a date field' do
-    subject { described_class.new(:deliver, field_type: :date) }
+    let(:options) { { field_type: :date } }
 
     it 'generates a field name' do
-      expect(subject.field).to eq('delivered_on')
+      expect(subject.field).to eq('completed_on')
+    end
+  end
+
+  context 'with a custom field name' do
+    let(:options) { { field_name: :completion_time } }
+
+    it 'returns the field name' do
+      expect(subject.field).to eq('completion_time')
     end
   end
 end

data/spec/active_record/events_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
 RSpec.describe ActiveRecord::Events do
-  around { |e| Timecop.freeze { e.run } }
+  around(:each) do |example|
+    Timecop.freeze { example.run }
+  end
 
   let!(:task) { create(:task) }
 
@@ -32,6 +34,7 @@ RSpec.describe ActiveRecord::Events do
 
   it 'records multiple timestamps at once' do
     Task.complete_all
+
     expect(task.reload).to be_completed
   end
 
@@ -43,16 +46,6 @@ RSpec.describe ActiveRecord::Events do
     expect(Task.not_completed).to include(task)
   end
 
-  context 'with the skip scopes flag' do
-    it "doesn't define a scope" do
-      expect(Task).not_to respond_to(:archived)
-    end
-
-    it "doesn't define an inverse scope" do
-      expect(Task).not_to respond_to(:not_archived)
-    end
-  end
-
   it 'allows overriding instance methods' do
     expect(ActiveRecord::Base.logger).to receive(:info)
 

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

@@ -1,6 +1,6 @@
 class Task < ActiveRecord::Base
   has_event :complete
-  has_event :archive, skip_scopes: true
+  has_events :archive, skip_scopes: true
 
   def complete!
     super

data/spec/dummy/config/boot.rb

@@ -1,3 +1,4 @@
+ENV['RAILS_ENV'] ||= 'development'
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
 
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/database.yml

@@ -5,7 +5,7 @@
 #   gem 'sqlite3'
 development:
   adapter: sqlite3
-  database: spec/dummy/db/development.sqlite3
+  database: db/development.sqlite3
   pool: 5
   timeout: 5000
 
@@ -14,12 +14,12 @@ development:
 # Do not set this db to the same as development or production.
 test:
   adapter: sqlite3
-  database: spec/dummy/db/test.sqlite3
+  database: db/test.sqlite3
   pool: 5
   timeout: 5000
 
 production:
   adapter: sqlite3
-  database: spec/dummy/db/production.sqlite3
+  database: db/production.sqlite3
   pool: 5
   timeout: 5000

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
 ENV['RAILS_ENV'] ||= 'test'
 
+require 'bundler/setup'
+require 'coveralls'
+
+Coveralls.wear!
+
 require File.expand_path('dummy/config/environment.rb', __dir__)
 
 require 'factory_girl'
@@ -10,9 +15,6 @@ require 'zonebie/rspec'
 Dir["#{__dir__}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-  config.color = true
-  config.order = :random
-
   config.include FactoryGirl::Syntax::Methods
   config.include GeneratorHelpers, type: :generator
 end

data/spec/support/matchers/have_method.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :have_method do |expected|
+  match do |actual|
+    actual.public_instance_methods.include?(expected)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-events
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Bartosz Pieńkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: verbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -114,28 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.13
-- !ruby/object:Gem::Dependency
-  name: standalone_migrations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -175,27 +175,28 @@ files:
 - README.md
 - Rakefile
 - lib/active_record/events.rb
+- lib/active_record/events/extension.rb
 - lib/active_record/events/macro.rb
+- lib/active_record/events/method_factory.rb
 - lib/active_record/events/naming.rb
-- lib/active_record/events/verbs.rb
 - lib/active_record/events/version.rb
 - lib/generators/active_record/event/USAGE
 - lib/generators/active_record/event/event_generator.rb
 - spec/active_record/events/macro_spec.rb
+- spec/active_record/events/method_factory_spec.rb
 - spec/active_record/events/naming_spec.rb
 - spec/active_record/events_spec.rb
 - spec/dummy/app/models/task.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/schema.rb
-- spec/dummy/db/test.sqlite3
 - spec/generators/active_record/event/event_generator_spec.rb
 - spec/spec_helper.rb
-- spec/support/factories.rb
-- spec/support/generator_helpers.rb
+- spec/support/factories/task_factory.rb
+- spec/support/helpers/generator_helpers.rb
+- spec/support/matchers/have_method.rb
 homepage: https://github.com/pienkowb/active_record-events
 licenses:
 - MIT
@@ -226,12 +227,12 @@ test_files:
 - spec/dummy/config/database.yml
 - spec/dummy/config/boot.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
 - spec/dummy/db/migrate/20150813132804_create_tasks.rb
-- spec/dummy/db/development.sqlite3
+- spec/active_record/events/method_factory_spec.rb
 - spec/active_record/events/naming_spec.rb
 - spec/active_record/events/macro_spec.rb
 - spec/active_record/events_spec.rb
-- spec/support/generator_helpers.rb
-- spec/support/factories.rb
+- spec/support/factories/task_factory.rb
+- spec/support/matchers/have_method.rb
+- spec/support/helpers/generator_helpers.rb
 - spec/generators/active_record/event/event_generator_spec.rb

data/lib/active_record/events/verbs.rb

@@ -1,5 +0,0 @@
-require 'verbs'
-
-Verbs::Conjugator.conjugations do |conjugate|
-  conjugate.single_terminal_consonant :deliver
-end