ta_has_event 1.0.0

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/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

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+RSpec.describe ActiveRecord::Events::Naming do
+  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')
+  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 action name' do
+    expect(subject.action).to eq('complete!')
+  end
+
+  it 'generates a safe action name' do
+    expect(subject.safe_action).to eq('complete')
+  end
+
+  it 'generates a collective action name' do
+    expect(subject.collective_action).to eq('complete_all')
+  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
+    let(:options) { { object: :task } }
+
+    it 'generates a field name' do
+      expect(subject.field).to eq('task_completed_at')
+    end
+
+    it 'generates a predicate name' do
+      expect(subject.predicate).to eq('task_completed?')
+    end
+
+    it 'generates an inverse predicate name' do
+      expect(subject.inverse_predicate).to eq('task_not_completed?')
+    end
+
+    it 'generates an action name' do
+      expect(subject.action).to eq('complete_task!')
+    end
+
+    it 'generates a safe action name' do
+      expect(subject.safe_action).to eq('complete_task')
+    end
+
+    it 'generates a collective action name' do
+      expect(subject.collective_action).to eq('complete_all_tasks')
+    end
+
+    it 'generates a scope name' do
+      expect(subject.scope).to eq('task_completed')
+    end
+
+    it 'generates an inverse scope name' do
+      expect(subject.inverse_scope).to eq('task_not_completed')
+    end
+  end
+
+  context 'with a date field' do
+    let(:options) { { field_type: :date } }
+
+    it 'generates a field name' do
+      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

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+RSpec.describe ActiveRecord::Events do
+  around(:each) do |example|
+    Timecop.freeze { example.run }
+  end
+
+  let!(:task) { create(:task) }
+
+  it 'records a timestamp' do
+    task.complete
+
+    expect(task.completed?).to eq(true)
+    expect(task.not_completed?).to eq(false)
+
+    expect(task.completed_at).to eq(Time.current)
+  end
+
+  it 'preserves a timestamp' do
+    task = create(:task, completed_at: 3.days.ago)
+
+    task.complete
+
+    expect(task.completed_at).to eq(3.days.ago)
+  end
+
+  it 'updates a timestamp' do
+    task = create(:task, completed_at: 3.days.ago)
+
+    task.complete!
+
+    expect(task.completed_at).to eq(Time.current)
+  end
+
+  context 'with a non-persisted object' do
+    it 'updates the timestamp' do
+      task = build(:task, completed_at: 3.days.ago)
+
+      task.complete!
+
+      expect(task.completed_at).to eq(Time.current)
+    end
+  end
+
+  it 'records multiple timestamps at once' do
+    Task.complete_all
+
+    expect(task.reload).to be_completed
+  end
+
+  it 'defines a scope' do
+    expect(Task.completed).not_to include(task)
+  end
+
+  it 'defines an inverse scope' do
+    expect(Task.not_completed).to include(task)
+  end
+
+  it 'allows overriding instance methods' do
+    expect(ActiveRecord::Base.logger).to receive(:info)
+
+    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

@@ -0,0 +1,14 @@
+class Task < ActiveRecord::Base
+  has_event :complete
+  has_events :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

@@ -0,0 +1,6 @@
+ENV['RAILS_ENV'] ||= 'development'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __dir__))

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,16 @@
+require File.expand_path('boot', __dir__)
+
+require 'active_record'
+
+Bundler.require(:default, ENV['RAILS_ENV'])
+
+# Load application files
+Dir["#{__dir__}/../app/**/*.rb"].each { |f| require f }
+
+# Load the database configuration
+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/migrate/20150813132804_create_tasks.rb

@@ -0,0 +1,9 @@
+class CreateTasks < ACTIVE_RECORD_MIGRATION_CLASS
+  def change
+    create_table :tasks do |t|
+      t.datetime :completed_at
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,21 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2015_08_13_132804) do
+
+  create_table "tasks", force: :cascade do |t|
+    t.datetime "completed_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

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

data/spec/support/factories/task_factory.rb

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

data/spec/support/helpers/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

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