active_cucumber 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd6e427a1ea5dd697035f91e1344e7dbfe0f8717
-  data.tar.gz: 0998293ca8816de728f5f1b5419e350ac42f712c
+  metadata.gz: 96a25a05107846a537f60fc80260a9ee6b97f3c8
+  data.tar.gz: a7fb3796f5d4ebaa91548f42fdaef7b254a9024e
 SHA512:
-  metadata.gz: 0c2ce7cc37de5e7bd600080238d73f8c10f7db99b623db4a51208d7cef6ea66697de28b814830d732df24ea1608f3cb7b15b06e313edf7a158b6c031a4bd5c78
-  data.tar.gz: 12bad9a4a815ba38efefed654a9175cf276317d6aea7c9f658a9e7c45db9fe4c9cfea613a6145338ac164f28c4f78b8bd9b44e879ae5a2022bde47e3018f36bc
+  metadata.gz: 32929e7bd142fe4b48f84ffa3b9d6e565ea3ed710ad0d3b72ceb0032159a66b84dd1288dfad9a6dd39f9238ddbb72f8f196133d6a55d2b113cf263609b1bb58b
+  data.tar.gz: 66855ff32104d2d3b7ffb69a7807a792e12a5b5251d95035940674cb36458e8a2b57d68a717fd5a5cd5434fdd3906868b38998c71c6493f8b912e55e65788c3f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_cucumber (0.0.4)
+    active_cucumber (0.0.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,25 +1,29 @@
 # ActiveCucumber [![Circle CI](https://circleci.com/gh/Originate/active_cucumber.svg?style=shield)](https://circleci.com/gh/Originate/active_cucumber)
 
-High-level Cucumber helpers for [creating](#creating-database-records)
-and [verifying](#verifying-database-records)
+High-level Cucumber helpers for performing
 [ActiveRecord](http://guides.rubyonrails.org/active_record_basics.html)-based
-database entries using Cucumber tables.
+database operations using Cucumber tables in tests.
 
 
 ## Creating database records
 
-Creating simple fields works out of the box.
-Let's assume we have an application that stores TV shows and their episodes,
-and our tests contain this Cucumber table:
+ActiveCucumber allows to create ActiveRecord objects from data in Cucumber tables.
+
+Let's assume we have an application that stores TV shows and their episodes.
+
+
+### Creating simple fields
+
+Simple fields works out of the box. Let's say our tests contain this Cucumber table:
 
 ```cucumber
 Given the episodes:
-  | NAME                  | YEAR |
-  | Encounter at Farpoint | 1987 |
-  | All Good Things       | 1994 |
+  | NAME                  |
+  | Encounter at Farpoint |
+  | All Good Things       |
 ```
 
-Implementing this step looks like:
+ActiveCucumber makes it trivially easy to implement this step:
 
 ```ruby
 Given(/^the episodes:$/) do |table|
@@ -54,9 +58,11 @@ class EpisodeCreator < ActiveCucumber::Creator
 end
 ```
 
-ActiveCucumber automatically uses creator classes that follow the given naming schema:
-* name is `<class name>Creator`
-* method names are `value_for_<attribute name>`
+ActiveCucumber automatically uses classes named `<class name>Creator`
+as creator classes for the respective class.
+This class must have methods named `value_for_<attribute name>`.
+They receive the value of the respective attribute in the Cucumber table (a string),
+and return whatever value should be assigned to that attribute on the ActiveRecord instance.
 
 
 ### Other columns
@@ -64,6 +70,9 @@ ActiveCucumber automatically uses creator classes that follow the given naming s
 Cucumber tables can contain columns that provide other test data,
 and don't correspond to attributes on the created object.
 
+For example, let's say series belong to a `Genre` class that specifies
+the genre that the series is in.
+
 ```cucumber
 Given the episodes:
   | GENRE           | SERIES              | NAME                    |
@@ -71,8 +80,15 @@ Given the episodes:
   | Comedy          | The Big Bang Theory | The Big Bran Hypothesis |
 ```
 
-A `Genre` has many series, and a series belongs to a genre.
-Episodes are not directly associated with genres.
+Implementing this with Creators is simple:
+
+Creators decorate the data structure that
+is sent to FactoryGirl to create the record.
+This means `self` inside creator methods behaves like a Hash
+that is pre-populated with the Cucumber table data.
+You can modify this hash, use other field values,
+add or remove fields,
+or store instance variables to be used later.
 
 ```ruby
 class EpisodeCreator < ActiveCucumber::Creator
@@ -82,21 +98,13 @@ class EpisodeCreator < ActiveCucumber::Creator
     delete :genre
   end
 
-  def value_for_show show_name
-    Show.find_by(name: show_name) || FactoryGirl.create(:show, name: show_name, genre: @genre)
+  def value_for_series series_name
+    Series.find_by(name: series_name) || FactoryGirl.create(:series, name: series_name, genre: @genre)
   end
 
 end
 ```
 
-Creators decorate the data structure that
-is sent to FactoryGirl to create the record.
-This means `self` inside creator methods behaves like a Hash
-that is pre-populated with the Cucumber table data.
-You can modify this hash, use other field values,
-add or remove fields,
-or store instance variables to be used later.
-
 
 ## Verifying database records
 

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.4'
+  s.version       = '0.0.5'
   s.authors       = ['Kevin Goslar']
   s.email         = ['kevin.goslar@gmail.com']
   s.summary       = %s(ActiveRecord tools for Cucumber)

data/lib/active_cucumber.rb

@@ -13,6 +13,7 @@ module ActiveCucumber
     builder.create_many ActiveCucumber.horizontal_table(cucumber_table)
   end
 
+
   # Creates an entry of the given ActiveRecord class
   # specified by the given vertical Cucumber table
   def self.create_one activerecord_class, cucumber_table
@@ -49,5 +50,4 @@ module ActiveCucumber
     table.rows_hash
   end
 
-
 end

data/lib/active_cucumber/creator.rb

@@ -1,11 +1,10 @@
 module ActiveCucumber
 
-  # Converts an attributes hash in Cucumber format
-  # into a hash consumable by FactoryGirl
-  #
-  # Subclasses define methods to convert particular fields.
+  # Creates ActiveRecord entries with data from given Cucumber tables.
   class Creator
 
+    include FactoryGirl::Syntax::Methods
+
     def initialize attributes
       @attributes = attributes
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_cucumber
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -218,8 +218,8 @@ files:
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - features/support/episode.rb
+- features/support/episode_creator.rb
 - features/support/episode_cucumberator.rb
-- features/support/episode_cureator.rb
 - features/support/genre.rb
 - features/support/show.rb
 - features/support/show_cucumberator.rb