chop 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a2a2f159e4a080262c2e468d7d9ce0cd47c581
-  data.tar.gz: ff743ac73daf8117ce661f9d54b13ae0505dfb2f
+  metadata.gz: 5e7cb04d85d09ab8d21ecdc9d07c59972a4daba7
+  data.tar.gz: 72c5efe46c120810aeadcb6958f870b983a631cd
 SHA512:
-  metadata.gz: 8d7ee5f0b4ebd55566dd3f307b4f3f96cf3fd6b0b71319a1a14915a2dafe4f907dfd6a33ede4f24523e3d0119611b80fa9e2b0e1e3f4f3ac9217472aeb067b1c
-  data.tar.gz: 40d30162f232c7b34cbfa4e4c0b2a4ea65b9d0964e4cb882532a2cea3898d6914b7296302d551fb8664ee09a8313bd65a0818fc5cdffed397dbfbfde62957e0e
+  metadata.gz: a72bf7733a5db76a20212921d0f5cbd8f1ab57c7abd2ed6545474e26c96d20faa15330025fb26de45fc5df7a4933e441e669abb16042645f81e58367228ae10f
+  data.tar.gz: 8d044df36e430cd64032f42917dff0abf449ae76eaa7f1bf2d8151bd816bf176c667b854885ea7028929b10f7189e33e01f6afd678edb3dd882bb034aedeb843

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-version
+.ruby-gemset

data/README.md

@@ -1,6 +1,6 @@
 # Chop
 
-Slice and dice your Cucumber tables with ease!
+Slice and dice your Cucumber tables with ease! Assumes usage of ActiveRecord and Capybara.
 
 ## Installation
 
@@ -12,13 +12,93 @@ end
 
 ## Usage
 
-TODO: Write more usage instructions here. See the source for usage in the meantime.
+Chop monkeypatches Cucumber tables with two new methods:
 
-* `Chop::Builder`: Create ActiveRecord instances from a Cucumber table.
+* `#build!`: Creates ActiveRecord instances.
+* `#diff!`: Enhances existing method to also accept a CSS selector. Currently supports diffing `<table>`, `<dl>`, and `<ul>`.
 
-* `Chop::Table`: Diff a Cucumber table with a <table>.
-* `Chop::DefinitionList`: Diff a Cucumber table with a <dl>.
-* `Chop::UnorderedList`: Diff a Cucumber table with a <ul>.
+Both these methods accept blocks for customization.
+
+### Block methods for `#build!`:
+
+Transform the attributes hash derived from the table before passing to `ActiveRecord.create!`.
+
+High-level declarative transformations:
+
+* `#file`: Replaces a file path with a file handle. Looks in `features/support/fixtures` by default.
+* `#files`: Replaces a space-delimited list of file paths with an array of file handles. Looks in `features/support/fixtures` by default.
+* `#has_one/#belongs_to`: Replaces an entity name with that entity. Uses `.find_by_name` by default.
+* `#has_many`: Replaces a comma-delimited list of entity names with an array of those entities. Uses `.find_by_name` by default.
+* `#underscore_keys`: Converts all hash keys to underscored versions.
+
+All these methods are implemented in terms of the following low-level methods, useful for when you need more control over the transformation:
+* `#field`: performs transformations on a specific field value.
+* `#transformation`: performs transformations on the attributes hash.
+
+### Block methods for `#diff!`:
+
+TODO: Pending API overhaul. 
+
+### Example
+
+```gherkin
+# features/manage_industries.feature
+
+Given the following industries exist:
+  | name              | wall_background_file | table_background_file |
+  | Another industry  | wall.jpg             | table.jpg             |
+  | Example industry  | wall.jpg             | table.jpg             |
+
+Given the following stories exist:
+  | industry          | image_file   | headline          |
+  | Example industry  | example.jpg  | Example headline  |
+  | Example industry  | example.jpg  | Another headline  |
+
+Given I am on the home page
+Then I should see the following industries:
+  | ANOTHER INDUSTRY |
+  | EXAMPLE INDUSTRY |
+And I should see the following "EXAMPLE INDUSTRY" stories:
+  | IMAGE       | HEADLINE          |
+  | example.jpg | Example headline  |
+  | example.jpg | Another headline  |
+```
+
+```ruby
+# features/step_definition/industry_steps.rb
+
+Given "the following industries exist:" do |table|
+  table.create! ConversationTable::Industry do
+    file :wall_background_file, :table_background_file
+  end
+end
+
+Given "the following stories exist:" do |table|
+  table.create! ConversationTable::Story do
+    belongs_to :industry, ConversationTable::Industry
+    file :image_file
+  end
+end
+
+Then "I should see the following industries:" do |table|
+  table.diff! "dl"
+end
+
+Then /^I should see the following "(.+?)" stories:$/ do |industry_name, table|
+  within "dfn", text: industry_name do
+    table.diff! "table"
+  end
+end
+```
+
+### Don't like monkeypatching?
+
+Load `chop` before `cucumber` in your Gemfile, and call the two methods directly on the `Chop` module, passing the cucumber table in as the first argument.
+
+```ruby
+Chop.build! table, Users
+Chop.diff! table, "table"
+```
 
 ## Development
 

data/lib/chop.rb

@@ -5,5 +5,32 @@ require "chop/definition_list"
 require "chop/unordered_list"
 
 module Chop
+  class << self
+    def create! table, klass, &block
+      Builder.build! table, klass, &block
+    end
+
+    def diff! table, selector, &block
+      class_name = Capybara.current_session.find(selector).tag_name.capitalize
+      klass = const_get(class_name)
+      klass.diff! table, &block
+    end
+  end
+end
+
+if defined?(Cucumber::MultilineArgument::DataTable)
+  Cucumber::MultilineArgument::DataTable.prepend Module.new {
+    def create! klass, &block
+      Chop.create! self, klass, &block
+    end
+
+    def diff! other_table, options={}, &block
+      if other_table.is_a?(String) && !other_table.include?("|")
+        Chop.diff! self, other_table, &block
+      else
+        super
+      end
+    end
+  }
 end
 

data/lib/chop/builder.rb

@@ -9,7 +9,6 @@ module Chop
     def initialize(*)
       super
       self.transformations = []
-      underscore_keys
       instance_eval &block if block.respond_to?(:call)
     end
 
@@ -24,9 +23,9 @@ module Chop
       transformations << block
     end
 
-    def field attribute
+    def field attribute, default: ""
       transformation do |attributes|
-        attributes[attribute.to_s] = yield(attributes.fetch(attribute.to_s, ""))
+        attributes[attribute.to_s] = yield(attributes.fetch(attribute.to_s, default))
       end
     end
 
@@ -39,35 +38,35 @@ module Chop
       end
     end
 
-    def file *keys
+    def file *keys, path: "features/support/fixtures"
       keys.each do |key|
-        field key do |path|
-          File.open("features/support/fixtures/#{path}") if path.present?
+        field key do |file|
+          File.open(File.join(path, file)) if file.present?
         end
       end
     end
 
-    def files *keys
+    def files *keys, path: "features/support/fixtures", delimiter: " "
       keys.each do |key|
         field key do |paths|
-          paths.split(" ").map do |path|
-            File.open("features/support/fixtures/#{path}")
+          paths.split(delimiter).map do |file|
+            File.open(File.join(path, file))
           end
         end
       end
     end
 
-    def has_many key, class_name=nil, delimiter: ", ", name_field: :name
+    def has_many key, klass=nil, delimiter: ", ", name_field: :name
       field key do |names|
         names.split(delimiter).map do |name|
-          class_name.find_by!(name_field => name)
+          klass.find_by!(name_field => name)
         end
       end
     end
 
-    def has_one key, class_name=nil, name_field: :name
+    def has_one key, klass=nil, name_field: :name
       field key do |name|
-        class_name.find_by!(name_field => name)
+        klass.find_by!(name_field => name)
       end
     end
     alias_method :belongs_to, :has_one

data/lib/chop/definition_list.rb

@@ -47,5 +47,7 @@ module Chop
       end
     end
   end
+
+  Dl = DefinitionList
 end
 

data/lib/chop/unordered_list.rb

@@ -47,5 +47,7 @@ module Chop
       end
     end
   end
+
+  Ul = UnorderedList
 end
 

data/lib/chop/version.rb

@@ -1,3 +1,3 @@
 module Chop
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chop
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Slice and dice your cucumber tables with ease!