active_cucumber 1.0.0 → 1.1.0

data/features/active_cucumber/diff_all/filtering_columns.feature

@@ -1,14 +1,5 @@
 Feature: Verifying only certain columns
 
-  As a developer working only on a subset of database columns
-  I want to specify only those columns in my tests
-  So that my specs are concise, noise free, and to the point.
-
-  Rules:
-  - tables given to `diff_all!` can contain only a subset of the existing columns
-  - only the given columns are verified against the database content
-
-
   Background:
     Given the episodes:
       | SHOW          | NAME                  | YEAR |
@@ -17,7 +8,7 @@ Feature: Verifying only certain columns
 
 
   Scenario: verifying all columns
-    When running "ActiveCucumber.diff_all! Episode, table" with this table:
+    When running "ActiveCucumber.diff_all!(Episode, table)" with this table:
       | SHOW          | NAME                  | YEAR |
       | Star Trek TNG | Encounter at Farpoint | 1987 |
       | Star Trek TNG | All Good Things       | 1994 |
@@ -25,7 +16,7 @@ Feature: Verifying only certain columns
 
 
   Scenario: verifying a subset of columns
-    When running "ActiveCucumber.diff_all! Episode, table" with this table:
+    When running "ActiveCucumber.diff_all!(Episode, table)" with this table:
       | YEAR |
       | 1987 |
       | 1994 |

data/features/active_cucumber/diff_all/filtering_rows.feature

@@ -1,16 +1,5 @@
 Feature: Verifying only certain database rows
 
-  As a developer specifying the result of database operations
-  I want to have the choice to verify either the full database content or only a part of it
-  So that my specs aren't polluted by independent side effects and remain focussed on the functionality described.
-
-  Rules:
-  - when providing an ActiveRecord class to `ActiveCucumber.diff_all!`
-    it verifies the whole database table
-  - when providing an AREL query to `ActiveCucumber.diff_all!`
-    it verifies only the specified records in the respective table
-
-
   Background:
     Given the episodes:
       | SHOW          | NAME                  | YEAR |
@@ -20,7 +9,7 @@ Feature: Verifying only certain database rows
 
 
   Scenario: comparing against the whole table by providing an ActiveRecord class
-    When running "ActiveCucumber.diff_all! Episode, table" with this table:
+    When running "ActiveCucumber.diff_all!(Episode, table)" with this table:
       | SHOW          | NAME                  | YEAR |
       | Star Trek TOS | The Paradise Syndrome | 1968 |
       | Star Trek TNG | Encounter at Farpoint | 1987 |
@@ -29,7 +18,7 @@ Feature: Verifying only certain database rows
 
 
   Scenario: comparing against a subset of a table by providing an AREL query
-    When running "ActiveCucumber.diff_all! Show.first.episodes, table" with this table:
+    When running "ActiveCucumber.diff_all!(Show.first.episodes, table)" with this table:
       | SHOW          | NAME                  | YEAR |
       | Star Trek TOS | The Paradise Syndrome | 1968 |
     Then the test passes

data/features/active_cucumber/diff_all/mismatching_data.feature

@@ -1,15 +1,5 @@
 Feature: comparing against all existing records
 
-  As a developer verifying my database content
-  I want that my specs verify the exact database content
-  So that I can be sure that my application behaves exactly as I think it does.
-
-  Rules:
-  - missing rows cause test failure
-  - extra rows cause test failure
-  - mismatching fields cause test failure
-
-
   Background:
     Given the episodes:
       | SHOW          | NAME                  | YEAR |
@@ -18,7 +8,7 @@ Feature: comparing against all existing records
 
 
   Scenario: complete table match
-    When running "ActiveCucumber.diff_all! Episode, table" with this table:
+    When running "ActiveCucumber.diff_all!(Episode, table)" with this table:
       | SHOW          | NAME                  | YEAR |
       | Star Trek TNG | Encounter at Farpoint | 1987 |
       | Star Trek TNG | All Good Things       | 1994 |
@@ -26,7 +16,7 @@ Feature: comparing against all existing records
 
 
   Scenario: missing a record
-    When running "ActiveCucumber.diff_all! Episode, table" with this table:
+    When running "ActiveCucumber.diff_all!(Episode, table)" with this table:
       | SHOW          | NAME                  |
       | Star Trek TNG | Encounter at Farpoint |
     Then the test fails
@@ -34,7 +24,7 @@ Feature: comparing against all existing records
 
 
   Scenario: an extra record
-    When running "ActiveCucumber.diff_all! Episode, table" with this table:
+    When running "ActiveCucumber.diff_all!(Episode, table)" with this table:
       | SHOW          | NAME                  |
       | Star Trek TNG | Encounter at Farpoint |
       | Star Trek TNG | All Good Things       |
@@ -44,7 +34,7 @@ Feature: comparing against all existing records
 
 
   Scenario: mismatching data in a table cell
-    When running "ActiveCucumber.diff_all! Episode, table" with this table:
+    When running "ActiveCucumber.diff_all!(Episode, table)" with this table:
       | SHOW          | NAME                  |
       | Star Trek TOS | Encounter at Farpoint |
       | Star Trek TNG | All Good Things       |

data/features/active_cucumber/diff_one.feature

@@ -1,10 +1,5 @@
 Feature: ActiveCucumber.diff_one!
 
-  As a Cucumber user
-  I want to verify a single record using a detailed Cucumber table
-  So that I can easily and intuitively check individual database entries.
-
-
   Background:
     Given the episode:
       | SHOW | Star Trek TNG   |
@@ -13,26 +8,26 @@ Feature: ActiveCucumber.diff_one!
 
 
   Scenario: verifying string fields
-    When running "ActiveCucumber.diff_one! @created_episode, table" with this table:
+    When running "ActiveCucumber.diff_one!(@created_episode, table)" with this table:
       | NAME | All Good Things |
     Then the test passes
 
 
   Scenario: verifying non-string fields
-    When running "ActiveCucumber.diff_one! @created_episode, table" with this table:
-      | YEAR | 1994            |
+    When running "ActiveCucumber.diff_one!(@created_episode, table)" with this table:
+      | YEAR | 1994 |
     Then the test passes
 
 
   Scenario: verifying associated fields
-    When running "ActiveCucumber.diff_one! @created_episode, table" with this table:
+    When running "ActiveCucumber.diff_one!(@created_episode, table)" with this table:
       | SHOW | Star Trek TNG   |
       | NAME | All Good Things |
     Then the test passes
 
 
   Scenario: complete table match
-    When running "ActiveCucumber.diff_one! @created_episode, table" with this table:
+    When running "ActiveCucumber.diff_one!(@created_episode, table)" with this table:
       | SHOW | Star Trek TNG   |
       | NAME | All Good Things |
       | YEAR | 1994            |
@@ -40,7 +35,7 @@ Feature: ActiveCucumber.diff_one!
 
 
   Scenario: providing a non-existing field
-    When running "ActiveCucumber.diff_one! @created_episode, table" with this table:
+    When running "ActiveCucumber.diff_one!(@created_episode, table)" with this table:
       | NAME   | All Good Things |
       | FOOBAR | 1994            |
     Then the test fails
@@ -48,7 +43,7 @@ Feature: ActiveCucumber.diff_one!
 
 
   Scenario: mismatching data in a table cell
-    When running "ActiveCucumber.diff_one! @created_episode, table" with this table:
+    When running "ActiveCucumber.diff_one!(@created_episode, table)" with this table:
       | SHOW | Star Trek TOS   |
       | NAME | All Good Things |
     Then the test fails
@@ -59,7 +54,7 @@ Feature: ActiveCucumber.diff_one!
     Given the subscription:
       | SUBSCRIBER | Q             |
       | SHOW       | Star Trek TNG |
-    When running "ActiveCucumber.diff_one! @created_subscription, table, context: { current_user: 'Q' }" with this table:
+    When running "ActiveCucumber.diff_one!(@created_subscription, table, context: { current_user: 'Q' })" with this table:
       | SUBSCRIBER | me            |
       | SHOW       | Star Trek TNG |
     Then the test passes

data/features/step_definitions/steps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Given(/^the (\w+):$/) do |class_name, table|
   singular = class_name.singularize
   clazz = singular.humanize.constantize
@@ -9,13 +11,15 @@ Given(/^the (\w+):$/) do |class_name, table|
   instance_variable_set "@created_#{class_name}", created_data
 end
 
-
-
 When(/^running "([^"]+)" with this table:$/) do |code, table|
   @previous_table = table
   begin
     @error_happened = false
-    @result = eval code
+    # rubocop:disable Security/Eval
+    # Eval is used here to test the ActiveCucumber framework itself.
+    # The code strings are hardcoded in feature files under developer control.
+    @result = eval(code, binding, __FILE__, __LINE__)
+    # rubocop:enable Security/Eval
   rescue StandardError => e
     @error_happened = true
     @error_message = e.message
@@ -27,23 +31,23 @@ Then(/^"(.*?)" does not have a director$/) do |show_name|
   expect(Show.find_by(name: show_name).director).to be nil
 end
 
-
 Then(/^it returns the hash$/) do |hash_string|
-  expect(@result).to match eval hash_string
+  # rubocop:disable Security/Eval
+  # Eval is necessary to evaluate Ruby hash literals containing database lookups.
+  # Hash strings are hardcoded in feature files under developer control.
+  expect(@result).to match eval(hash_string, binding, __FILE__, __LINE__)
+  # rubocop:enable Security/Eval
 end
 
-
 Then(/^the database contains no (episodes|shows)$/) do |class_name|
   expect(class_name.classify.constantize).to have(0).records
 end
 
-
 Then(/^the database contains the given episode$/) do
   expect(Episode).to have(1).instance
   ActiveCucumber.diff_one! Episode.first, @previous_table
 end
 
-
 Then(/^the database contains the given episodes$/) do
   ActiveCucumber.diff_all! Episode, @previous_table
 end
@@ -56,23 +60,20 @@ Then(/^the database contains the (\w+):$/) do |class_name, table|
   ActiveCucumber.diff_all! class_name.humanize.singularize.constantize, table
 end
 
-
 Then(/^the database contains the shows? (.+)$/) do |show_names|
-  expect(Show.all.map(&:name)).to match Kappamaki.from_sentence show_names
+  expect(Show.all.map(&:name)).to match Kappamaki.from_sentence(show_names)
 end
 
-
 Then(/^the test (passes|fails)$/) do |expected_result|
   @error_checked = true
-  if expected_result == 'passes' && @error_happened
+  if expected_result == "passes" && @error_happened
     puts "\n#{@error_message}"
-    puts ''
+    puts ""
     @exception.backtrace.take(5).each { |trace| puts "in #{trace}" }
   end
-  expect(@error_happened).to be expected_result != 'passes'
+  expect(@error_happened).to be expected_result != "passes"
 end
 
-
 Then(/^Cucumparer prints the error message "([^"]*)"$/) do |expected_error|
   expect(@error_message).to match expected_error
 end

data/features/support/director.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Director < ActiveRecord::Base
   has_many :shows
 end

data/features/support/env.rb

@@ -1,58 +1,57 @@
-if ENV['CI']
-  require 'coveralls'
-  Coveralls.wear!
-end
+# frozen_string_literal: true
 
-require 'active_record'
-require 'sqlite3'
-require 'mortadella'
-require 'active_cucumber'
-require 'factory_girl'
-require 'faker'
-require 'kappamaki'
-require 'rspec/collection_matchers'
+if ENV["CI"]
+  require "simplecov"
+  SimpleCov.start
+end
 
+require "active_record"
+require "sqlite3"
+require "mortadella"
+require "active_cucumber"
+require "factory_bot"
+require "faker"
+require "kappamaki"
+require "rspec/collection_matchers"
 
 ActiveRecord::Base.establish_connection(
-  adapter: 'sqlite3',
-  database: ':memory:'
+  adapter: "sqlite3",
+  database: ":memory:"
 )
 
-
 ActiveRecord::Schema.define do
   create_table :genres, force: true do |t|
     t.string :name
-    t.datetime 'created_at'
+    t.datetime "created_at"
   end
 
   create_table :shows, force: true do |t|
     t.belongs_to :genre
     t.belongs_to :director
     t.string :name
-    t.datetime 'created_at'
+    t.datetime "created_at"
   end
 
   create_table :episodes, force: true do |t|
     t.belongs_to :show
     t.string :name
     t.integer :year
-    t.datetime 'created_at'
+    t.datetime "created_at"
   end
 
   create_table :subscriptions, force: true do |t|
     t.string :subscriber
     t.belongs_to :show
-    t.datetime 'created_at'
+    t.datetime "created_at"
   end
 
   create_table :directors, force: true do |t|
     t.string :name
-    t.datetime 'created_at'
+    t.datetime "created_at"
   end
 end
 
-
-FactoryGirl.define do
+FactoryBot.define do
   factory :genre do
     name { Faker::Book.title }
   end
@@ -64,7 +63,7 @@ FactoryGirl.define do
 
   factory :episode do
     name { Faker::Book.title }
-    year { 1960 + rand(40) }
+    year { rand(1960..1999) }
     show
   end
 
@@ -78,7 +77,6 @@ FactoryGirl.define do
   end
 end
 
-
 Before do
   Show.delete_all
   Episode.delete_all
@@ -91,7 +89,7 @@ end
 After do
   if @error_happened && !@error_checked
     puts "\n#{@error_message}"
-    puts ''
+    puts ""
     @exception.backtrace.take(5).each { |trace| puts "in #{trace}" }
     expect(@error_happened).to be false
   end

data/features/support/episode.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Episode < ActiveRecord::Base
   belongs_to :show, required: true
 end

data/features/support/episode_creator.rb

@@ -1,12 +1,12 @@
-class EpisodeCreator < ActiveCucumber::Creator
+# frozen_string_literal: true
 
-  def value_for_show show_name
-    Show.find_by(name: show_name) || FactoryGirl.create(:show, name: show_name, genre: @genre)
+class EpisodeCreator < ActiveCucumber::Creator
+  def value_for_show(show_name)
+    Show.find_by(name: show_name) || FactoryBot.create(:show, name: show_name, genre: @genre)
   end
 
-  def value_for_genre genre_name
-    @genre = Genre.find_by(name: genre_name) || FactoryGirl.create(:genre, name: genre_name)
+  def value_for_genre(genre_name)
+    @genre = Genre.find_by(name: genre_name) || FactoryBot.create(:genre, name: genre_name)
     delete :genre
   end
-
 end

data/features/support/episode_cucumberator.rb

@@ -1,7 +1,7 @@
-class EpisodeCucumberator < ActiveCucumber::Cucumberator
+# frozen_string_literal: true
 
+class EpisodeCucumberator < ActiveCucumber::Cucumberator
   def value_for_show
     show.name
   end
-
 end

data/features/support/genre.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Genre < ActiveRecord::Base
   has_many :shows
 end

data/features/support/show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Show < ActiveRecord::Base
   belongs_to :genre
   belongs_to :director

data/features/support/show_creator.rb

@@ -1,8 +1,9 @@
-class ShowCreator < ActiveCucumber::Creator
+# frozen_string_literal: true
 
-  def value_for_director director_name
+class ShowCreator < ActiveCucumber::Creator
+  def value_for_director(director_name)
     return nil if director_name.blank?
-    Director.find_by(name: director_name) || FactoryGirl.create(:director, name: director_name)
-  end
 
+    Director.find_by(name: director_name) || FactoryBot.create(:director, name: director_name)
+  end
 end

data/features/support/show_cucumberator.rb

@@ -1,11 +1,11 @@
-class ShowCucumberator < ActiveCucumber::Cucumberator
+# frozen_string_literal: true
 
+class ShowCucumberator < ActiveCucumber::Cucumberator
   def value_for_director
-    director.try :name
+    director&.name
   end
 
   def value_for_genre
     genre.name
   end
-
 end

data/features/support/subscription.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Subscription < ActiveRecord::Base
   belongs_to :show
 end

data/features/support/subscription_creator.rb

@@ -1,11 +1,11 @@
-class SubscriptionCreator < ActiveCucumber::Creator
+# frozen_string_literal: true
 
-  def value_for_show show_name
-    Show.find_by(name: show_name) || FactoryGirl.create(:show, name: show_name)
+class SubscriptionCreator < ActiveCucumber::Creator
+  def value_for_show(show_name)
+    Show.find_by(name: show_name) || FactoryBot.create(:show, name: show_name)
   end
 
-  def value_for_subscriber subscriber_name
-    subscriber_name == 'me' ? @current_user : subscriber_name
+  def value_for_subscriber(subscriber_name)
+    subscriber_name == "me" ? @current_user : subscriber_name
   end
-
 end

data/features/support/subscription_cucumberator.rb

@@ -1,11 +1,11 @@
-class SubscriptionCucumberator < ActiveCucumber::Cucumberator
+# frozen_string_literal: true
 
+class SubscriptionCucumberator < ActiveCucumber::Cucumberator
   def value_for_show
-    show.try :name
+    show&.name
   end
 
   def value_for_subscriber
-    subscriber == @current_user ? 'me' : subscriber
+    subscriber == @current_user ? "me" : subscriber
   end
-
 end

data/lib/active_cucumber/active_record_builder.rb

@@ -1,50 +1,58 @@
-module ActiveCucumber
+# frozen_string_literal: true
 
+module ActiveCucumber
   # Creates ActiveRecord entries with data from given Cucumber tables.
   class ActiveRecordBuilder
-
-    def initialize activerecord_class, context
+    def initialize(activerecord_class, context)
       @clazz = activerecord_class
       @creator_class = creator_class
       @context = context
     end
 
-
-    def attributes_for attributes
-      @creator_class.new(attributes, @context).factorygirl_attributes
+    def attributes_for(attributes)
+      @creator_class.new(attributes, @context).factorybot_attributes
     end
 
-
     # Creates all entries in the given horizontal table hash
-    def create_many table
+    def create_many(table)
       table.map do |row|
         create_record row
       end
     end
 
-
     # Creates a new record with the given attributes in the database
-    def create_record attributes
+    def create_record(attributes)
       creator = @creator_class.new attributes, @context
-      FactoryGirl.create @clazz.name.underscore.to_sym, creator.factorygirl_attributes
+      factorybot_attributes = creator.factorybot_attributes
+      factory_name = @clazz.name.underscore.to_sym
+      create_with_factory(factory_name, factorybot_attributes, attributes)
     end
 
+    private
+
+    # Creates a record using FactoryBot with error handling
+    def create_with_factory(factory_name, factorybot_attributes, attributes)
+      FactoryBot.create factory_name, factorybot_attributes
+    rescue ActiveRecord::RecordInvalid => e
+      record = e.record || @clazz.new
+      raise ActiveRecord::RecordInvalid.new(record,
+                                            "Failed to create #{@clazz.name} with attributes " \
+                                            "#{attributes.inspect}: #{e.message}")
+    rescue ArgumentError => e
+      raise ArgumentError, "Failed to create #{@clazz.name}: #{e.message}. " \
+                           "Make sure a FactoryBot factory is defined for :#{factory_name}"
+    end
 
-  private
-
-    # Returns the Cucumberator subclass to be used by this Cucumparer instance
+    # Returns the Creator subclass to be used by this ActiveRecordBuilder instance.
     def creator_class
       creator_class_name.constantize
     rescue NameError
       Creator
     end
 
-
-    # Returns the name of the Cucumberator subclass to be used by this Cucumparer instance.
+    # Returns the name of the Creator subclass to be used by this ActiveRecordBuilder instance.
     def creator_class_name
       "#{@clazz.name}Creator"
     end
-
   end
-
 end