active_record-events 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925ad39a33ff672195121c743c130982bf379388a98dfb9fddefe4a624ce0d3a
-  data.tar.gz: c428f4b9ea6a9c44b5c472c80a5bd4349eaab9337b67209d58e7238325824b72
+  metadata.gz: 4d3c49af800cff40043af18ec6357dd41a8492a75942525701fa607b078a0bb0
+  data.tar.gz: 01b3d06c56050a764fa67b772e8fdf6f791603be7e220773d7e7547a53450ef6
 SHA512:
-  metadata.gz: a5eadfba86bf1b157fcf1906628c3e391b79677524e9851374cedd764b7170867f933781ddb6ee87f435c67b872171e471dccd57904b65700c4534c18a005815
-  data.tar.gz: ba34b744b02a293db01f51dbad13cac7c5afc687aaf4e8ee4d3ac533981d121ba46b8b7099e789b0df26022e5383d788e1c098ca581780c2430b540f6d012d0a
+  metadata.gz: a3f18c26a27d1eca9ee0517ea19dbf087019200e02fa02b95f0412c4901f4a2aec4239115fc38191d1e6ad7f643067f1567fde10633ace0beb71ddb4623f027b
+  data.tar.gz: a388c51a55a45a13bccc7aad2288aefbef85c49ba322f6bd7fe0791aa4f378b1be1e41ac85562c732168be41553499560e1f8d79a2e0ea2b4691d25980189087

data/README.md

@@ -24,21 +24,24 @@ $ gem install active_record-events
 
 ## Usage
 
-Recording a timestamp in order to mark that an event occurred to an object is a common practice when dealing with ActiveRecord models – `created_at` and `updated_at` fields handled by ActiveRecord itself are a good example of such approach.
+Recording a timestamp in order to mark that an event occurred to an object is a common practice when dealing with ActiveRecord models.
+A good example of such an approach is how ActiveRecord handles the `created_at` and `updated_at` fields.
 This gem allows you to manage custom timestamp fields in the exact same manner.
 
+### Example
+
 Consider a `Task` model with a `completed_at` field and the following methods:
 
 ```ruby
 class Task < ActiveRecord::Base
-  def not_completed?
-    !completed?
-  end
-
   def completed?
     completed_at.present?
   end
 
+  def not_completed?
+    !completed?
+  end
+
   def complete
     complete! if not_completed?
   end
@@ -53,7 +56,7 @@ class Task < ActiveRecord::Base
 end
 ```
 
-Instead of defining these five methods explicitly, you can use a macro provided by the gem.
+Instead of defining all of these methods by hand, you can use the `has_event` macro provided by the gem.
 
 ```ruby
 class Task < ActiveRecord::Base
@@ -61,12 +64,10 @@ class Task < ActiveRecord::Base
 end
 ```
 
-This approach is very efficient when more than one field has to be handled that way.
-In such a case, many lines of code can be replaced with an expressive one-liner.
+As a result, the methods will be generated automatically.
 
-```ruby
-has_events :complete, :archive
-```
+*It's important to note that the `completed_at` column has to already exist in the database.*
+*Consider [using the generator](#using-a-rails-generator) to create a necessary migration.*
 
 ### Scopes
 
@@ -77,7 +78,30 @@ scope :not_completed, -> { where(completed_at: nil) }
 scope :completed, -> { where.not(completed_at: nil) }
 ```
 
-### Object
+The inclusion of scope methods can be omitted by passing the `skip_scopes` flag.
+
+```ruby
+has_event :complete, skip_scopes: true
+```
+
+### Multiple events
+
+Using the macro is efficient when more than one field has to be handled that way.
+In such a case, many lines of code can be replaced with an expressive one-liner.
+
+```ruby
+has_events :complete, :archive
+```
+
+### Setting a field type
+
+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:
+
+```ruby
+has_event :deliver, field_type: :date
+```
+
+### 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.
 In order to keep method names grammatically correct, you can specify an object using the `object` option.
@@ -101,6 +125,71 @@ As well as these two scopes:
 - `email_confirmed`
 - `email_not_confirmed`
 
+### Using a Rails generator
+
+If you want to quickly add a new event, you can make use of a Rails generator provided by the gem:
+
+```
+$ rails generate active_record:event task complete
+```
+
+It will create a necessary migration and insert a `has_event` statement into the model class.
+
+```ruby
+# db/migrate/XXX_add_completed_at_to_tasks.rb
+
+class AddCompletedAtToTasks < ActiveRecord::Migration[6.0]
+  def change
+    add_column :tasks, :completed_at, :datetime
+  end
+end
+```
+
+```ruby
+# app/models/task.rb
+
+class Task < ActiveRecord::Base
+  has_event :complete
+end
+```
+
+All of the macro options are supported by the generator and can be passed via the command line.
+For instance:
+
+```
+$ rails generate active_record:event user confirm --object=email --skip-scopes
+```
+
+For more information, run the generator with the `--help` option.
+
+### Overriding methods
+
+If there's a need to override any of the methods generated by the macro, you can define a new method with the same name in the corresponding model class.
+This applies to instance methods as well as class methods.
+In both cases, the `super` keyword invokes the original method.
+
+```ruby
+class Task < ActiveRecord::Base
+  has_event :complete
+
+  def complete!
+    super
+    logger.info("Task #{id} has been completed")
+  end
+
+  def self.complete_all
+    super
+    logger.info('All tasks have been completed')
+  end
+end
+```
+
+## Contributors
+
+- [Bartosz Pieńkowski](https://github.com/pienkowb)
+- [Tomasz Skupiński](https://github.com/tskupinski)
+- [Oskar Janusz](https://github.com/oskaror)
+
 ## See also
 
-- [ActiveRecord::Enum](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html)
+- [ActiveRecord::Enum](https://api.rubyonrails.org/classes/ActiveRecord/Enum.html)

data/Rakefile

@@ -26,11 +26,12 @@ require 'standalone_migrations'
 
 StandaloneMigrations::Tasks.load_tasks
 
-if Gem::Version.new(ActiveRecord::VERSION::STRING) >= Gem::Version.new('5.1.0')
-  ACTIVE_RECORD_MIGRATION_CLASS = ActiveRecord::Migration[4.2]
-else
-  ACTIVE_RECORD_MIGRATION_CLASS = ActiveRecord::Migration
-end
+ACTIVE_RECORD_MIGRATION_CLASS =
+  if ActiveRecord::VERSION::MAJOR >= 5
+    ActiveRecord::Migration[4.2]
+  else
+    ActiveRecord::Migration
+  end
 
 Bundler::GemHelper.install_tasks
 

data/lib/active_record/events.rb

@@ -11,33 +11,43 @@ module ActiveRecord
     def has_event(name, options = {})
       naming = Naming.new(name, options)
 
-      define_method("#{naming.predicate}?") do
-        self[naming.field].present?
-      end
-
-      define_method("#{naming.inverse_predicate}?") do
-        self[naming.field].blank?
-      end
-
-      define_method(naming.action) do
-        touch(naming.field) if self[naming.field].blank?
-      end
-
-      define_method("#{naming.action}!") do
-        touch(naming.field)
-      end
-
-      define_singleton_method(naming.collective_action) do
-        update_all(naming.field => Time.current)
-      end
-
-      define_singleton_method(naming.scope) do
-        where(arel_table[naming.field].not_eq(nil))
-      end
-
-      define_singleton_method(naming.inverse_scope) do
-        where(arel_table[naming.field].eq(nil))
-      end
+      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
+
+        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
+
+          define_method(naming.inverse_scope) do
+            where(arel_table[naming.field].eq(nil))
+          end
+        end
+      end)
     end
   end
 end

data/lib/active_record/events/macro.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  module Events
+    class Macro
+      def initialize(event_name, options)
+        @event_name = event_name.to_s
+        @options = options
+      end
+
+      def to_s
+        "has_event :#{event_name}#{options_list}"
+      end
+
+      private
+
+      def event_name
+        @event_name.underscore
+      end
+
+      def options_list
+        options.unshift('').join(', ') if options.present?
+      end
+
+      def options
+        @options.map { |k, v| "#{k}: #{convert_value(v)}" }
+      end
+
+      def convert_value(value)
+        symbol_or_string?(value) ? ":#{value}" : value
+      end
+
+      def symbol_or_string?(value)
+        value.is_a?(Symbol) || value.is_a?(String)
+      end
+    end
+  end
+end

data/lib/active_record/events/naming.rb

@@ -1,4 +1,4 @@
-require 'verbs'
+require 'active_record/events/verbs'
 
 module ActiveRecord
   module Events
@@ -6,44 +6,58 @@ module ActiveRecord
       def initialize(infinitive, options = {})
         @infinitive = infinitive
         @object = options[:object].presence
+        @field_type = options[:field_type].try(:to_sym)
       end
 
       def field
-        [@object, past_participle, 'at'].compact.join('_')
+        suffix = field_type == :date ? 'on' : 'at'
+        concatenate(object, past_participle, suffix)
       end
 
       def predicate
-        [@object, past_participle].compact.join('_')
+        concatenate(object, past_participle) + '?'
       end
 
       def inverse_predicate
-        [@object, 'not', past_participle].compact.join('_')
+        concatenate(object, 'not', past_participle) + '?'
       end
 
       def action
-        [@infinitive, @object].compact.join('_')
+        concatenate(infinitive, object) + '!'
+      end
+
+      def safe_action
+        concatenate(infinitive, object)
       end
 
       def collective_action
-        [@infinitive, 'all', pluralized_object].compact.join('_')
+        concatenate(infinitive, 'all', plural_object)
       end
 
       def scope
-        [@object, past_participle].compact.join('_')
+        concatenate(object, past_participle)
       end
 
       def inverse_scope
-        [@object, 'not', past_participle].compact.join('_')
+        concatenate(object, 'not', past_participle)
       end
 
       private
 
+      attr_reader :infinitive
+      attr_reader :object
+      attr_reader :field_type
+
+      def concatenate(*parts)
+        parts.compact.join('_')
+      end
+
       def past_participle
-        @infinitive.verb.conjugate(tense: :past, aspect: :perfective)
+        infinitive.verb.conjugate(tense: :past, aspect: :perfective)
       end
 
-      def pluralized_object
-        @object.to_s.pluralize if @object.present?
+      def plural_object
+        object.to_s.pluralize if object.present?
       end
     end
   end

data/lib/active_record/events/verbs.rb

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

data/lib/active_record/events/version.rb

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

data/lib/generators/active_record/event/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generates a database migration and updates the model file (if it exists).
+    Pass the model name, either CamelCased or under_scored, and the event name
+    as an infinitive.
+
+Examples:
+    `bin/rails generate active_record:event task complete`
+
+        Generates a migration adding a `completed_at` column to the `tasks`
+        table and updates the Task model.
+
+    `bin/rails generate active_record:event user confirm --object=email`
+
+        Generates a migration adding an `email_confirmed_at` column to the
+        `users` table and updates the User model.

data/lib/generators/active_record/event/event_generator.rb

@@ -0,0 +1,60 @@
+require 'rails/generators'
+
+require 'active_record/events/naming'
+require 'active_record/events/macro'
+
+module ActiveRecord
+  module Generators
+    class EventGenerator < Rails::Generators::Base
+      MACRO_OPTIONS = %w[object field_type skip_scopes].freeze
+
+      argument :model_name, type: :string
+      argument :event_name, type: :string
+
+      class_option :skip_scopes, type: :boolean,
+        desc: 'Skip the inclusion of scope methods'
+      class_option :field_type, type: :string,
+        desc: 'The field type (datetime or date)'
+      class_option :object, type: :string,
+        desc: 'The name of the object'
+
+      source_root File.expand_path('templates', __dir__)
+
+      def generate_migration_file
+        naming = ActiveRecord::Events::Naming.new(event_name, options)
+
+        table_name = model_name.tableize
+        field_name = naming.field
+        field_type = options[:field_type] || 'datetime'
+
+        migration_name = "add_#{field_name}_to_#{table_name}"
+        attributes = "#{field_name}:#{field_type}"
+
+        invoke 'active_record:migration', [migration_name, attributes]
+      end
+
+      def update_model_file
+        return unless model_file_exists?
+
+        macro_options = options.slice(*MACRO_OPTIONS)
+        macro = ActiveRecord::Events::Macro.new(event_name, macro_options)
+
+        inject_into_file model_file_path, "\s\s#{macro}\n", after: /class.+\n/
+      end
+
+      private
+
+      def model_file_exists?
+        File.exist?(model_file_path)
+      end
+
+      def model_file_path
+        File.expand_path("app/models/#{model_file_name}", destination_root)
+      end
+
+      def model_file_name
+        "#{model_name.underscore.singularize}.rb"
+      end
+    end
+  end
+end

data/spec/active_record/events/macro_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'active_record/events/macro'
+
+RSpec.describe ActiveRecord::Events::Macro do
+  let(:event_name) { :confirm }
+
+  subject { described_class.new(event_name, options) }
+
+  context 'without options' do
+    let(:options) { {} }
+
+    it "doesn't include any options" do
+      expect(subject.to_s).to eq('has_event :confirm')
+    end
+  end
+
+  context 'with a string option' do
+    let(:options) { { object: 'email' } }
+
+    it 'prepends the option value with a colon' do
+      expect(subject.to_s).to eq('has_event :confirm, object: :email')
+    end
+  end
+
+  context 'with a symbol option' do
+    let(:options) { { object: :email } }
+
+    it 'prepends the option value with a colon' do
+      expect(subject.to_s).to eq('has_event :confirm, object: :email')
+    end
+  end
+
+  context 'with a boolean option' do
+    let(:options) { { skip_scopes: true } }
+
+    it "doesn't prepend the option value with a colon" do
+      expect(subject.to_s).to eq('has_event :confirm, skip_scopes: true')
+    end
+  end
+
+  context 'with multiple options' do
+    let(:options) { { object: :email, field_type: :date } }
+
+    it 'includes all of the options' do
+      macro = 'has_event :confirm, object: :email, field_type: :date'
+      expect(subject.to_s).to eq(macro)
+    end
+  end
+end

data/spec/active_record/events/naming_spec.rb

@@ -1,36 +1,38 @@
 require 'spec_helper'
 
 RSpec.describe ActiveRecord::Events::Naming do
-  context 'without an object' do
-    subject { described_class.new(:complete) }
+  subject { described_class.new(:complete) }
 
-    it 'generates a field name' do
-      expect(subject.field).to eq('completed_at')
-    end
+  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 a predicate name' do
+    expect(subject.predicate).to eq('completed?')
+  end
 
-    it 'generates an inverse predicate name' do
-      expect(subject.inverse_predicate).to eq('not_completed')
-    end
+  it 'generates an inverse predicate name' do
+    expect(subject.inverse_predicate).to eq('not_completed?')
+  end
 
-    it 'generates an action name' do
-      expect(subject.action).to eq('complete')
-    end
+  it 'generates an action name' do
+    expect(subject.action).to eq('complete!')
+  end
 
-    it 'generates a collective action name' do
-      expect(subject.collective_action).to eq('complete_all')
-    end
+  it 'generates a safe action name' do
+    expect(subject.safe_action).to eq('complete')
+  end
 
-    it 'generates a scope name' do
-      expect(subject.scope).to eq('completed')
-    end
+  it 'generates a collective action name' do
+    expect(subject.collective_action).to eq('complete_all')
+  end
 
-    it 'generates an inverse scope name' do
-      expect(subject.inverse_scope).to eq('not_completed')
-    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
 
   context 'with an object' do
@@ -41,15 +43,19 @@ RSpec.describe ActiveRecord::Events::Naming do
     end
 
     it 'generates a predicate name' do
-      expect(subject.predicate).to eq('email_confirmed')
+      expect(subject.predicate).to eq('email_confirmed?')
     end
 
     it 'generates an inverse predicate name' do
-      expect(subject.inverse_predicate).to eq('email_not_confirmed')
+      expect(subject.inverse_predicate).to eq('email_not_confirmed?')
     end
 
     it 'generates an action name' do
-      expect(subject.action).to eq('confirm_email')
+      expect(subject.action).to eq('confirm_email!')
+    end
+
+    it 'generates a safe action name' do
+      expect(subject.safe_action).to eq('confirm_email')
     end
 
     it 'generates a collective action name' do
@@ -64,4 +70,12 @@ RSpec.describe ActiveRecord::Events::Naming do
       expect(subject.inverse_scope).to eq('email_not_confirmed')
     end
   end
+
+  context 'with a date field' do
+    subject { described_class.new(:deliver, field_type: :date) }
+
+    it 'generates a field name' do
+      expect(subject.field).to eq('delivered_on')
+    end
+  end
 end

data/spec/active_record/events_spec.rb

@@ -1,69 +1,71 @@
 require 'spec_helper'
 
 RSpec.describe ActiveRecord::Events do
-  around(:each) { |e| Timecop.freeze { e.run } }
+  around { |e| Timecop.freeze { e.run } }
 
-  context 'without an object' do
-    let!(:task) { create(:task) }
+  let!(:task) { create(:task) }
 
-    it 'records a timestamp' do
-      task.complete
+  it 'records a timestamp' do
+    task.complete
 
-      expect(task.completed?).to eq(true)
-      expect(task.not_completed?).to eq(false)
+    expect(task.completed?).to eq(true)
+    expect(task.not_completed?).to eq(false)
 
-      expect(task.completed_at).to eq(Time.current)
-    end
+    expect(task.completed_at).to eq(Time.current)
+  end
 
-    it 'preserves a timestamp' do
-      task = create(:task, completed_at: 3.days.ago)
-      task.complete
+  it 'preserves a timestamp' do
+    task = create(:task, completed_at: 3.days.ago)
 
-      expect(task.completed_at).to eq(3.days.ago)
-    end
+    task.complete
 
-    it 'updates a timestamp' do
-      task = create(:task, completed_at: 3.days.ago)
-      task.complete!
+    expect(task.completed_at).to eq(3.days.ago)
+  end
 
-      expect(task.completed_at).to eq(Time.current)
-    end
+  it 'updates a timestamp' do
+    task = create(:task, completed_at: 3.days.ago)
 
-    it 'records multiple timestamps' do
-      Task.complete_all
-      expect(task.reload.completed?).to eq(true)
-    end
+    task.complete!
 
-    it 'defines a scope' do
-      expect(Task.completed).not_to include(task)
-    end
+    expect(task.completed_at).to eq(Time.current)
+  end
 
-    it 'defines an inverse scope' do
-      expect(Task.not_completed).to include(task)
-    end
+  it 'records multiple timestamps at once' do
+    Task.complete_all
+    expect(task.reload).to be_completed
   end
 
-  context 'with an object' do
-    let!(:user) { create(:user) }
+  it 'defines a scope' do
+    expect(Task.completed).not_to include(task)
+  end
 
-    it 'records a timestamp' do
-      user.confirm_email
+  it 'defines an inverse scope' do
+    expect(Task.not_completed).to include(task)
+  end
 
-      expect(user.email_confirmed?).to eq(true)
-      expect(user.email_not_confirmed?).to eq(false)
+  context 'with the skip scopes flag' do
+    it "doesn't define a scope" do
+      expect(Task).not_to respond_to(:archived)
     end
 
-    it 'records multiple timestamps' do
-      User.confirm_all_emails
-      expect(user.reload.email_confirmed?).to eq(true)
+    it "doesn't define an inverse scope" do
+      expect(Task).not_to respond_to(:not_archived)
     end
+  end
 
-    it 'defines a scope' do
-      expect(User.email_confirmed).not_to include(user)
-    end
+  it 'allows overriding instance methods' do
+    expect(ActiveRecord::Base.logger).to receive(:info)
 
-    it 'defines an inverse scope' do
-      expect(User.email_not_confirmed).to include(user)
-    end
+    task.complete!
+
+    expect(task).to be_completed
+  end
+
+  it 'allows overriding class methods' do
+    expect(ActiveRecord::Base.logger).to receive(:info)
+
+    Task.complete_all
+
+    expect(task.reload).to be_completed
   end
 end

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

@@ -1,3 +1,14 @@
 class Task < ActiveRecord::Base
   has_event :complete
+  has_event :archive, skip_scopes: true
+
+  def complete!
+    super
+    logger.info("Task #{id} has been completed")
+  end
+
+  def self.complete_all
+    super
+    logger.info('All tasks have been completed')
+  end
 end

data/spec/dummy/config/boot.rb

@@ -1,6 +1,5 @@
-# Set up gems listed in the Gemfile
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
 
 require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __dir__))

data/spec/dummy/config/environment.rb

@@ -1,14 +1,16 @@
-require File.expand_path('../boot', __FILE__)
+require File.expand_path('boot', __dir__)
 
 require 'active_record'
 
 Bundler.require(:default, ENV['RAILS_ENV'])
 
 # Load application files
-Dir["#{File.dirname(__FILE__)}/../app/**/*.rb"].each { |f| require f }
+Dir["#{__dir__}/../app/**/*.rb"].each { |f| require f }
 
 # Load the database configuration
-config_file = File.expand_path('../database.yml', __FILE__)
-config = YAML::load_file(config_file)[ENV['RAILS_ENV']]
+config_file = File.expand_path('database.yml', __dir__)
+config = YAML.load_file(config_file)[ENV['RAILS_ENV']]
+
+ActiveRecord::Base.logger = Logger.new(File::NULL)
 
 ActiveRecord::Base.establish_connection(config)

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2017_01_03_215307) do
+ActiveRecord::Schema.define(version: 2015_08_13_132804) do
 
   create_table "tasks", force: :cascade do |t|
     t.datetime "completed_at"
@@ -18,10 +18,4 @@ ActiveRecord::Schema.define(version: 2017_01_03_215307) do
     t.datetime "updated_at", null: false
   end
 
-  create_table "users", force: :cascade do |t|
-    t.datetime "email_confirmed_at"
-    t.datetime "created_at", null: false
-    t.datetime "updated_at", null: false
-  end
-
 end

data/spec/generators/active_record/event/event_generator_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'generators/active_record/event/event_generator'
+
+RSpec.describe ActiveRecord::Generators::EventGenerator, type: :generator do
+  arguments %w[task complete --field-type=date --skip-scopes]
+  destination File.expand_path('../../../../tmp', __dir__)
+
+  before { prepare_destination }
+
+  it 'generates a migration file' do
+    run_generator
+
+    assert_migration 'db/migrate/add_completed_on_to_tasks' do |migration|
+      assert_instance_method :change, migration do |content|
+        assert_match 'add_column :tasks, :completed_on, :date', content
+      end
+    end
+  end
+
+  context 'when the model file exists' do
+    before do
+      write_file 'app/models/task.rb', <<-RUBY.strip_heredoc
+        class Task < ActiveRecord::Base
+        end
+      RUBY
+    end
+
+    it 'updates the model file' do
+      run_generator
+
+      assert_file 'app/models/task.rb', <<-RUBY.strip_heredoc
+        class Task < ActiveRecord::Base
+          has_event :complete, field_type: :date, skip_scopes: true
+        end
+      RUBY
+    end
+  end
+
+  context "when the model file doesn't exist" do
+    it "doesn't create the model file" do
+      run_generator
+      assert_no_file 'app/models/task.rb'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,15 +1,18 @@
 ENV['RAILS_ENV'] ||= 'test'
 
-require File.expand_path('../dummy/config/environment.rb', __FILE__)
+require File.expand_path('dummy/config/environment.rb', __dir__)
 
 require 'factory_girl'
+require 'generator_spec'
 require 'timecop'
+require 'zonebie/rspec'
 
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+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/factories.rb

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

data/spec/support/generator_helpers.rb

@@ -0,0 +1,8 @@
+module GeneratorHelpers
+  def write_file(file_name, contents)
+    file_path = File.expand_path(file_name, destination_root)
+
+    FileUtils.mkdir_p(File.dirname(file_path))
+    File.write(file_path, contents)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-events
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Bartosz Pieńkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -42,30 +42,72 @@ dependencies:
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: standalone_migrations
+  name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.8.1
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -81,47 +123,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.13
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: standalone_migrations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: zonebie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 description: An ActiveRecord extension providing convenience methods for timestamp
   management.
 email: pienkowb@gmail.com
@@ -129,26 +171,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- LICENSE
 - README.md
 - Rakefile
 - lib/active_record/events.rb
+- lib/active_record/events/macro.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/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/generators/active_record/event/event_generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/factories.rb
+- spec/support/generator_helpers.rb
 homepage: https://github.com/pienkowb/active_record-events
 licenses:
 - MIT
@@ -161,30 +208,30 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Manage timestamps in ActiveRecord models
 test_files:
 - spec/spec_helper.rb
-- spec/dummy/app/models/user.rb
 - spec/dummy/app/models/task.rb
 - spec/dummy/config/environment.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/boot.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
-- spec/dummy/db/migrate/20170103215307_create_users.rb
 - spec/dummy/db/migrate/20150813132804_create_tasks.rb
 - spec/dummy/db/development.sqlite3
 - 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/generators/active_record/event/event_generator_spec.rb

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

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

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

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