active_cucumber 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31fc83494b273be00aaa3b52b7d3376a31b86e55
-  data.tar.gz: d1ca0c141ab1195f7e2cd8637dc993e2b57cb08b
+  metadata.gz: d79075dcae64e837aac60d1fcd14e2afdbd5e3cd
+  data.tar.gz: f44adf57d12377ea1751400a63469af2be5e350c
 SHA512:
-  metadata.gz: c3d951e2e1ae6b2f2a401589d9c601bb0de1e470c0ddbbe3f4c516f1caa1d9a398500eac0e29b0dee8c4e0fe17db4b1c1df6c9887cbc5f017a11c6bef48a8d79
-  data.tar.gz: 59146c0d3fc96562c18e45a16efbf7bfec5a4e4eb07cbf6fbf9e15bbc0b540f8ec8afd1f8504001cceea96f7e613ed8b633a8c1a53a9e3d7e6476c22483a5d41
+  metadata.gz: 9b644b362eaae699f43e408e9253bf331d7aad0787455a912af9196e8bd4d70b16f1f8aa0722a48a953639162b10b1fa49859d47bdfeba226170cfac582ef64d
+  data.tar.gz: 5a782c450a2166c849c258c64d5174ddae91328d0c8359a13452db7df81e58964bafe8a0819950d49540405d926a97b005aa8bf842504bc0ba55703bb993c6fb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_cucumber (0.0.1)
+    active_cucumber (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -24,6 +24,7 @@ GEM
     astrolabe (1.3.1)
       parser (~> 2.2)
     builder (3.2.2)
+    colorize (0.7.7)
     cucumber (2.1.0)
       builder (>= 2.1.2)
       cucumber-core (~> 1.3.0)
@@ -33,10 +34,21 @@ GEM
       multi_test (>= 0.1.2)
     cucumber-core (1.3.0)
       gherkin3 (~> 3.1.0)
+    cucumber_lint (0.1.2)
+      colorize (~> 0.7.7)
+      gherkin (~> 2.12.2)
+      multi_json (~> 1.11.2)
     diff-lcs (1.2.5)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    faker (1.5.0)
+      i18n (~> 0.5)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
     gherkin3 (3.1.2)
     i18n (0.7.0)
     json (1.8.3)
+    kappamaki (0.0.3)
     minitest (5.8.1)
     mortadella (0.2.1)
     multi_json (1.11.2)
@@ -50,6 +62,8 @@ GEM
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
       rspec-mocks (~> 3.3.0)
+    rspec-collection_matchers (1.1.2)
+      rspec-expectations (>= 2.99.0.beta1)
     rspec-core (3.3.2)
       rspec-support (~> 3.3.0)
     rspec-expectations (3.3.1)
@@ -79,9 +93,14 @@ DEPENDENCIES
   activerecord
   bundler
   cucumber
+  cucumber_lint
+  factory_girl
+  faker
+  kappamaki
   mortadella
   rake
   rspec
+  rspec-collection_matchers
   rubocop
   sqlite3
 

data/README.md

@@ -16,6 +16,11 @@ the ones not listed are ignored.
 
 ### diff_one!
 
+<img width="385"
+     height="144"
+     alt="image of a mismatching vertical Cucumber table"
+     src="documentation/vertical_diff.png">
+
 `ActiveCucumber.diff_one!` compares the given ActiveRecord entry with the given
 _vertical_ Cucumber table.
 These tables have their headers on the left side, and are used to describe
@@ -41,6 +46,11 @@ end
 
 ### diff_all!
 
+<img width="431"
+     height="95"
+     alt="image of a mismatching vertical Cucumber table"
+     src="documentation/horizontal_diff.png">
+
 `ActiveCucumber.diff_all!` verifies that the given _horizontal_ Cucumber table
 describes all existing database entries of the given class.
 Horizontal Cucumber tables have their headers on top, and define several
@@ -80,7 +90,8 @@ for attribute values into the format used in the Cucumber table.
 ```ruby
 class EpisodeCucumberator < Cucumberator
 
-  # In the SHOW column, print the name of the show of the episode truncated
+  # In the SHOW column, print the name of the associated show object,
+  # truncated to 10 characters
   def value_of_show
     show.name.truncate 10
   end

data/Rakefile

@@ -6,7 +6,19 @@ require 'cucumber/rake/task'
 Cucumber::Rake::Task.new :features
 task default: %i(lint features)
 
-desc 'Run linter'
-task 'lint' do
+desc 'Run linters'
+task lint: %w(lint:ruby lint:cucumber)
+
+desc 'Run Cucumber linter'
+task 'lint:cucumber' do
+  sh 'bundle exec cucumber_lint'
+end
+
+desc 'Run Ruby linter'
+task 'lint:ruby' do
+  # NOTE: cannot use "task 'lint:ruby' => [:rubocop]" here,
+  #       because the Heroku toolbelt has issues with JRuby.
+  #       In particular, running "heroku run rake db:migrate"
+  #       fails when JRuby is the active Ruby at this point.
   sh 'bundle exec rubocop'
 end

data/active_cucumber.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name          = 'active_cucumber'
-  s.version       = '0.0.1'
+  s.version       = '0.0.2'
   s.authors       = ['Kevin Goslar']
   s.email         = ['kevin.goslar@gmail.com']
   s.summary       = %s(ActiveRecord tools for Cucumber)
@@ -18,9 +18,14 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'activerecord'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'cucumber_lint'
+  s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'faker'
+  s.add_development_dependency 'kappamaki'
   s.add_development_dependency 'mortadella'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-collection_matchers'
   s.add_development_dependency 'sqlite3'
 end

data/cucumber_lint.yml

@@ -0,0 +1,13 @@
+consistent_empty_lines:
+  enabled: true
+  between_description_and_element: 2
+  between_elements: 2
+  between_feature_and_description: 1
+  between_feature_and_element: 1
+  between_scenario_outline_and_examples: 1
+
+consistent_table_whitespace:
+  enabled: false
+
+consistent_table_headers:
+  enabled: false

data/features/active_cucumber/create_many.feature

@@ -0,0 +1,40 @@
+Feature: ActiveCucumber.create_many
+
+  As a Cucumber user
+  I want to create database records using Cucumber tables
+  So that I can easily and intuitively set up my test environment.
+
+
+  Scenario: creating string columns
+    When running "ActiveCucumber.create_many Episode, table" with this table:
+      | NAME                  |
+      | Encounter at Farpoint |
+      | All Good Things       |
+    Then the database contains the given episodes
+
+
+  Scenario: creating integer columns
+    When running "ActiveCucumber.create_many Episode, table" with this table:
+      | YEAR |
+      | 1987 |
+      | 1994 |
+    Then the database contains the given episodes
+
+
+  Scenario: creating associated objects
+    When running "ActiveCucumber.create_many Episode, table" with this table:
+      | SHOW          | NAME                  |
+      | Star Trek TNG | Encounter at Farpoint |
+      | Star Trek TNG | All Good Things       |
+    Then the database contains the given episodes
+    And the database contains the show "Star Trek TNG"
+
+
+  Scenario: complex example
+    When running "ActiveCucumber.create_many Episode, table" with this table:
+      | SHOW          | NAME                  | YEAR |
+      | Star Trek TNG | Encounter at Farpoint | 1987 |
+      | Star Trek TOS | The Paradise Syndrome | 1994 |
+    Then the database contains the given episodes
+    And the database contains the shows "Star Trek TNG" and "Star Trek TOS"
+

data/features/active_cucumber/create_one.feature

@@ -0,0 +1,33 @@
+Feature: ActiveCucumber.create_one
+
+  (see ./create_many.feature)
+
+
+  Scenario: creating string columns
+    When running "ActiveCucumber.create_one Episode, table" with this table:
+      | NAME                  | Encounter at Farpoint |
+    Then the database contains the given episode
+
+
+  Scenario: creating integer columns
+    When running "ActiveCucumber.create_one Episode, table" with this table:
+      | YEAR                  | 1994 |
+    Then the database contains the given episode
+
+
+  Scenario: creating associated objects
+    When running "ActiveCucumber.create_one Episode, table" with this table:
+      | SHOW          | Star Trek TNG         |
+      | NAME          | Encounter at Farpoint |
+    Then the database contains the given episode
+    And the database contains the show "Star Trek TNG"
+
+
+  Scenario: complex example
+    When running "ActiveCucumber.create_one Episode, table" with this table:
+      | SHOW | Star Trek TNG         |
+      | NAME | Encounter at Farpoint |
+      | YEAR | 1987                  |
+    Then the database contains the given episode
+    And the database contains the show "Star Trek TNG"
+

data/features/{cucumparer → active_cucumber}/diff_all.feature

@@ -1,4 +1,4 @@
-Feature: Cucumparer.diff_all!
+Feature: ActiveCucumber.diff_all!
 
   As a Cucumber user
   I want to verify all existing records using a Cucumber table

data/features/{cucumparer → active_cucumber}/diff_one.feature

@@ -1,4 +1,4 @@
-Feature: Cucumparer.diff_one!
+Feature: ActiveCucumber.diff_one!
 
   As a Cucumber user
   I want to verify a single record using a detailed Cucumber table

data/features/step_definitions/steps.rb

@@ -1,41 +1,55 @@
 Given(/^the TV episode:$/) do |table|
-  data = table.rows_hash
+  data = ActiveCucumber.vertical_table table
   show = Show.find_or_create_by name: data['SHOW']
   @episode = show.episodes.create name: data['NAME'], year: data['YEAR']
 end
 
 
 Given(/^the TV episodes:$/) do |table|
-  table.map_headers! { |header| header.downcase.to_sym }
-  table.hashes.each do |row|
-    show = Show.find_or_create_by name: row[:show]
-    show.episodes.create name: row[:name], year: row[:year]
+  ActiveCucumber.horizontal_table(table).each do |row|
+    show = Show.find_or_create_by name: row['SHOW']
+    show.episodes.create name: row['NAME'], year: row['YEAR']
   end
 end
 
 
 
-# rubocop:disable Lint/UnusedBlockArgument
 Then(/^running "([^"]+)" with this table:$/) do |code, table|
+  @previous_table = table
   begin
-    @exception = false
+    @error_happened = false
     @result = eval code
   rescue StandardError => e
-    @exception = true
+    @error_happened = true
     @error_message = e.message
+    @exception = e
   end
 end
-# rubocop:enable Lint/UnusedBlockArgument
 
 
-Then(/^the test passes$/) do
-  p @error_message if @expectation == true
-  expect(@exception).to be false
+Then(/^the database contains the given episode$/) do
+  expect(Episode).to have(1).instance
+  ActiveCucumber.diff_one! Episode.first, @previous_table
 end
 
 
-Then(/^the test fails$/) do
-  expect(@exception).to be true
+Then(/^the database contains the given episodes$/) do
+  ActiveCucumber.diff_all! Episode, @previous_table
+end
+
+
+Then(/^the database contains the shows? (.+)$/) do |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
+    p @error_message
+    p @exception
+  end
+  expect(@error_happened).to be expected_result != 'passes'
 end
 
 

data/features/support/env.rb

@@ -2,6 +2,10 @@ require 'active_record'
 require 'sqlite3'
 require 'mortadella'
 require 'active_cucumber'
+require 'factory_girl'
+require 'faker'
+require 'kappamaki'
+require 'rspec/collection_matchers'
 
 
 ActiveRecord::Base.establish_connection(
@@ -9,6 +13,7 @@ ActiveRecord::Base.establish_connection(
   database: ':memory:'
 )
 
+
 ActiveRecord::Schema.define do
   create_table :shows, force: true do |t|
     t.string :name
@@ -23,7 +28,26 @@ ActiveRecord::Schema.define do
   end
 end
 
+
+FactoryGirl.define do
+  factory :show do
+    name { Faker::Book.title }
+  end
+
+  factory :episode do
+    name { Faker::Book.title }
+    year { 1960 + rand(40) }
+    show
+  end
+end
+
+
 Before do
   Show.delete_all
   Episode.delete_all
+  @error_checked = false
+end
+
+After do
+  expect(@error_happened).to be false unless @error_checked
 end

data/features/support/episode_cureator.rb

@@ -0,0 +1,7 @@
+class EpisodeCureator < ActiveCucumber::Cureator
+
+  def value_for_show show_name
+    Show.find_by(name: show_name) || FactoryGirl.create(:show, name: show_name)
+  end
+
+end

data/lib/active_cucumber/cureator.rb

@@ -0,0 +1,86 @@
+module ActiveCucumber
+
+  # Creates ActiveRecord entries
+  class Cureator
+
+    # Returns the Cureator instance for the given ActiveRecord class.
+    def self.for activerecord_class
+      cureator_class(activerecord_class).new activerecord_class
+    end
+
+
+    def initialize activerecord_class
+      @clazz = activerecord_class
+    end
+
+
+    # Creates all entries in the given Cucumber table
+    #
+    # Assumes a horizontal Cucumber table.
+    def create_records table
+      table.each do |row|
+        create_record row
+      end
+    end
+
+
+    # Creates a new record in the database,
+    # of the given class, with the given Cucumber-formatted String attributes.
+    def create_record attributes
+      FactoryGirl.create @clazz, factorygirl_row(symbolized_hash(attributes))
+    end
+
+
+  private
+
+    # Returns the Cucumberator subclass to be used by this Cucumparer instance
+    def self.cureator_class activerecord_class
+      cureator_class_name(activerecord_class).constantize
+    rescue NameError
+      Cureator
+    end
+
+
+    # Returns the name of the Cucumberator subclass to be used by this Cucumparer instance.
+    def self.cureator_class_name activerecord_class
+      "#{activerecord_class.name}Cureator"
+    end
+
+
+    # Returns the given row, with values converted to FactoryGirl format
+    #
+    # Assumes the keys of the row are hashes
+    def factorygirl_row row
+      {}.tap do |result|
+        row.each do |key, value|
+          method = method_name key
+          result[key] = respond_to?(method) ? send(method, value) : value
+        end
+      end
+    end
+
+
+    # Returns the name of the value_for method for the given key
+    def method_name key
+      "value_for_#{key}"
+    end
+
+
+    # Converts the key given in Cucumber format into FactoryGirl format
+    def normalized_key key
+      key.downcase.parameterize.underscore
+    end
+
+
+    # Returns a new hash with the keys normalized to symbols
+    def symbolized_hash row
+      {}.tap do |result|
+        row.each do |key, value|
+          result[normalized_key key] = value
+        end
+      end
+    end
+
+  end
+
+end

data/lib/active_cucumber.rb

@@ -1,9 +1,23 @@
 require 'active_cucumber/cucumparer'
 require 'active_cucumber/cucumberator'
+require 'active_cucumber/cureator'
 
 # The main namespace for this gem
 module ActiveCucumber
 
+  # Creates entries of the given ActiveRecord class
+  # specified by the given Cucumber table
+  def self.create_many activerecord_class, cucumber_table
+    Cureator.for(activerecord_class).create_records ActiveCucumber.horizontal_table(cucumber_table)
+  end
+
+  # Creates an entry of the given ActiveRecord class
+  # specified by the given Cucumber table
+  def self.create_one activerecord_class, cucumber_table
+    Cureator.for(activerecord_class).create_record ActiveCucumber.vertical_table(cucumber_table)
+  end
+
+
   # Verifies that the database table for the given ActiveRecord class
   # matches the given horizontal Cucumber table.
   #
@@ -13,10 +27,24 @@ module ActiveCucumber
     cucumber_table.diff! cucumparer.to_horizontal_table
   end
 
+
   # Verifies that the given object matches the given vertical Cucumber table
   def self.diff_one! object, cucumber_table
     cucumparer = Cucumparer.new object.class, cucumber_table
     cucumber_table.diff! cucumparer.to_vertical_table(object)
   end
 
+
+  # Returns the given horizontal Cucumber table in standardized format
+  def self.horizontal_table table
+    table.hashes
+  end
+
+
+  # Returns the given vertical Cucumber table in standardized format
+  def self.vertical_table table
+    table.rows_hash
+  end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_cucumber
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kappamaki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mortadella
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -138,16 +208,23 @@ files:
 - Rakefile
 - active_cucumber.gemspec
 - circle.yml
-- features/cucumparer/diff_all.feature
-- features/cucumparer/diff_one.feature
+- cucumber_lint.yml
+- documentation/horizontal_diff.png
+- documentation/vertical_diff.png
+- features/active_cucumber/create_many.feature
+- features/active_cucumber/create_one.feature
+- features/active_cucumber/diff_all.feature
+- features/active_cucumber/diff_one.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - features/support/episode.rb
 - features/support/episode_cucumberator.rb
+- features/support/episode_cureator.rb
 - features/support/show.rb
 - lib/active_cucumber.rb
 - lib/active_cucumber/cucumberator.rb
 - lib/active_cucumber/cucumparer.rb
+- lib/active_cucumber/cureator.rb
 homepage: https://github.com/Originate/active_cucumber
 licenses:
 - MIT