chop 0.13.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3067a61bdc457c0ed1ce15521f79adc1fbddc02
-  data.tar.gz: 17b710c74fc8587c8625497483661cf366cf2816
+  metadata.gz: 02300b6137cd03b63ebfef375d7d9de7402a8892
+  data.tar.gz: d353af7ed05239dca230b63825034ea30d74430e
 SHA512:
-  metadata.gz: 45971725107ac1af7adde1dd5b21e209e8f17de1a09746d8f6ef129feb61fdccae846cb9b03da28a5b935171c8cc7737e5af12e58f7a214c27212e30e233f758
-  data.tar.gz: e7d1d46c071f5ef0f668a0a984aa4533482829eee38303a234ddc4eb9b05adcc472b8065d753d0185b28eff9376da877b110b371ebf0f91af4883d393d37d2da
+  metadata.gz: cb5dfb4be29ef2ca2e548b37f2176c8a3e7da2b83e3a985aa9d3f7a53d9c7b92a74d293ba567a995f5055b3824babecbb83f143a32a9d1ca52cb8169642d17a2
+  data.tar.gz: 07787e5e960bb7532855d46fbfbf363e855e2c0814b9fb56a1afcb87cb65440e239a679fc13acf31a0cb08ea6b3e12e290b5ab8eac959c3ddae860ca4cc6b968

data/README.md

@@ -16,13 +16,13 @@ end
 
 Chop monkeypatches Cucumber tables with three new methods:
 
-* `#build!`: Creates ActiveRecord instances. Also supports FactoryGirl.
+* `#create!`: Creates ActiveRecord instances. Also supports FactoryGirl.
 * `#diff!`: Enhances existing method to also accept a CSS selector. Currently supports diffing `<table>`, `<dl>`, and `<ul>`.
 * `#fill_in!`: Fills in a form on the current page.
 
 All these methods accept blocks for customization.
 
-### Block methods for `#build!`:
+### Block methods for `#create!`:
 
 Transform the attributes hash derived from the table before passing to `ActiveRecord.create!`.
 
@@ -36,12 +36,28 @@ High-level declarative transformations:
 * `#rename`: Renames one or more fields.
 
 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.
+* `#field`: performs transformations on a specific oield value.
 * `#transformation`: performs transformations on the attributes hash.
 
 ### Block methods for `#diff!`:
 
-TODO: Pending API overhaul. 
+Transform the table of Capybara nodes before converting them to text and passing to `diff!`.
+
+Overide Capybara finders:
+* `#rows`: overrides existing default row finder.
+* `#cells`: overrides existing default cell finder.
+* `#text`: overrides existing default text finder.
+* `#allow_not_found`: diffing against a missing element will diff against `[[]]` instead of raising an exception.
+
+High-level declarative transformations:
+* `#image`: Replaces the specified cell with the alt text of the first image within it.
+
+All these methods are implemented in terms of the following low-level methods, useful for when you need more control over the transformation:
+* `#header`: add or transform the table header, depending on block arity.
+* `#header(key)`: transform the specified header column, specified either by numeric index, or by hash key.
+* `#field`: performs transformations on a specific field value.
+* `#hash_transformation`: performs arbitrary transformations on an array of hashes constructed by assuming a header row. Hash keys are downcased and underscored.
+* `#transformation`: performs arbitrary transformations on the 2d array of Capybara nodes.
 
 ### Block methods for `#fill_in!`:
 
@@ -113,7 +129,9 @@ end
 
 Then /^I should see the following "(.+?)" stories:$/ do |industry_name, table|
   within "dfn", text: industry_name do
-    table.diff! "table"
+    table.diff! "table" do
+      image :image
+    end
   end
 end
 ```
@@ -123,7 +141,7 @@ end
 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.create! table, Users
 Chop.diff! table, "table"
 Chop.fill_in! table
 ```

data/lib/chop.rb

@@ -1,5 +1,5 @@
 require "chop/version"
-require "chop/builder"
+require "chop/create"
 require "chop/table"
 require "chop/definition_list"
 require "chop/unordered_list"

data/lib/chop/{builder.rb → create.rb}

@@ -2,9 +2,9 @@ require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/object/blank"
 
 module Chop
-  class Builder < Struct.new(:table, :klass, :block)
-    def self.build! table, klass, &block
-      new(table, klass, block).build!
+  class Create < Struct.new(:table, :klass, :block)
+    def self.create! table, klass, &block
+      new(table, klass, block).create!
     end
 
     attr_accessor :transformations
@@ -16,7 +16,7 @@ module Chop
       instance_eval &other_block if block_given?
     end
 
-    def build! cucumber_table = table
+    def create! cucumber_table = table
       cucumber_table.hashes.map do |attributes|
         transformations.each { |transformation| transformation.call(attributes) }
         if klass.is_a?(Hash)

data/lib/chop/definition_list.rb

@@ -1,7 +1,11 @@
-require "chop/base"
+require "chop/diff"
       
 module Chop
-  class DefinitionList < Base
+  class DefinitionList < Diff
+    self.default_selector = "dl"
+    self.rows_finder = ->(root) { root.all("dfn") }
+    self.cells_finder = ->(row) { row.all("dt,dd") }
+
     def column index, &block
       transformation do |raw|
         raw.map!.with_index do |row, row_index|
@@ -21,24 +25,6 @@ module Chop
         raw
       end
     end
-
-    private
-
-    def default_selector
-      "dl"
-    end
-
-    def default_rows_finder
-      Proc.new do |root|
-        root.all("dfn")
-      end
-    end
-
-    def default_cells_finder
-      Proc.new do |row|
-        row.all("dt,dd")
-      end
-    end
   end
 
   Dl = DefinitionList

data/lib/chop/diff.rb

@@ -0,0 +1,168 @@
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/class/attribute"
+
+module Chop
+  class Diff < Struct.new(:selector, :table, :session, :block)
+    def self.diff! selector, table, session: Capybara.current_session, &block
+      new(selector, table, session, block).diff!
+    end
+
+    class_attribute :default_selector, :rows_finder, :cells_finder, :text_finder
+
+    self.rows_finder = -> { raise "Missing rows finder!" }
+    self.cells_finder = -> { raise "Missing cells finder!" }
+    self.text_finder = ->(cell) { cell.text }
+
+    def self.text_or_image_alt_finder
+      ->(cell) do
+        text = cell.text
+        if text.blank? && image = cell.first("img")
+          image["alt"]
+        else
+          text
+        end
+      end
+    end
+
+    attr_accessor :header_transformations, :transformations
+
+    def initialize selector = nil, table = nil, session = Capybara.current_session, block = nil, &other_block
+      super
+      self.selector ||= default_selector
+      self.header_transformations = []
+      self.transformations = []
+      instance_eval &block if block.respond_to?(:call)
+      instance_eval &other_block if block_given?
+    end
+
+    def header_transformation &block
+      header_transformations << block
+    end
+
+    def header index=nil, &block
+      if index
+        header_transformation do |row|
+          if index.is_a?(Symbol)
+            index = row.index do |cell|
+              text_finder.call(cell).parameterize.underscore.to_sym == index
+            end
+          end
+          row[index] = yield(row[index])
+        end
+      else
+        if block.arity.zero?
+          @new_header = yield
+        else
+          header_transformation do |row|
+            row.replace yield(row)
+          end
+        end
+      end
+    end
+
+    def transformation &block
+      transformations << block
+    end
+
+    def hash_transformation &block
+      transformation do |rows|
+        header = rows[0]
+        keys = header.to_a.map { |cell| cell.text.parameterize.underscore.to_sym }
+        body = rows[1..-1]
+        hashes = body.map { |row| Hash[keys.zip(row)] }
+        yield hashes
+        rows.replace [header] + hashes.map(&:values)
+      end
+    end
+
+    def field key
+      hash_transformation do |hashes|
+        hashes.map! do |row|
+          row.merge key => yield(row[key])
+        end
+      end
+    end
+
+    def image *keys
+      keys.each do |key|
+        field(key) do |cell|
+          if image = cell.first("img")
+            image["alt"]
+          else
+            cell
+          end
+        end
+      end
+    end
+
+    def rows &block
+      self.rows_finder = block
+    end
+
+    def cells &block
+      self.cells_finder = block
+    end
+
+    def text &block
+      self.text_finder = block
+    end
+
+    def allow_not_found
+      @allow_not_found = true
+    end
+
+    def to_a
+      rows = rows_finder.call(root).map { |row| cells_finder.call(row).to_a }
+      rows = normalize(rows)
+
+      header = @new_header ? normalize([@new_header]).first : rows.shift
+      header_transformations.each do |transformation|
+        transformation.call(header)
+        header = normalize([header]).first
+      end
+
+      rows = [header] + rows
+
+      transformations.each do |transformation|
+        transformation.call(rows)
+        rows = normalize(rows)
+      end
+
+      rows.map do |row|
+        row.map { |cell| text_finder.call(cell) }
+      end
+    end
+
+    def diff! cucumber_table = table
+      cucumber_table.diff! to_a
+    end
+
+    private
+
+    def normalize rows
+      max = rows.map(&:count).max
+      rows.map do |row|
+        row.to_a << "" while row.length < max
+        row.map { |cell| Node(cell) }
+      end
+    end
+
+    def root
+      @root ||= begin
+        session.find(selector)
+      rescue Capybara::ElementNotFound
+        raise unless @allow_not_found
+        Node("")
+      end
+    end
+
+    def Node value
+      if value.respond_to?(:text)
+        value
+      else
+        Capybara::Node::Simple.new(value.to_s)
+      end
+    end
+  end
+end

data/lib/chop/dsl.rb

@@ -1,7 +1,7 @@
 module Chop
   module DSL
     def create! table, klass, &block
-      Builder.build! table, klass, &block
+      Create.create! table, klass, &block
     end
 
     def diff! selector, table, session: Capybara.current_session, &block

data/lib/chop/table.rb

@@ -1,24 +1,10 @@
-require "chop/base"
+require "chop/diff"
 
 module Chop
-  class Table < Base
-    private
-
-    def default_selector
-      "table"
-    end
-
-    def default_rows_finder
-      Proc.new do |root|
-        root.all("tr")
-      end
-    end
-
-    def default_cells_finder
-      Proc.new do |row|
-        row.all("td,th")
-      end
-    end
+  class Table < Diff
+    self.default_selector = "table"
+    self.rows_finder = ->(root) { root.all("tr") }
+    self.cells_finder = ->(row) { row.all("td,th") }
   end
 end
 

data/lib/chop/unordered_list.rb

@@ -1,24 +1,10 @@
-require "chop/base"
+require "chop/diff"
       
 module Chop
-  class UnorderedList < Base
-    private
-
-    def default_selector
-      "ul"
-    end
-
-    def default_rows_finder
-      Proc.new do |root|
-        root.all("li")
-      end
-    end
-
-    def default_cells_finder
-      Proc.new do |row|
-        [row]
-      end
-    end
+  class UnorderedList < Diff
+    self.default_selector = "ul"
+    self.rows_finder = ->(root) { root.all("li") }
+    self.cells_finder = ->(row) { [row] }
   end
 
   Ul = UnorderedList

data/lib/chop/version.rb

@@ -1,3 +1,3 @@
 module Chop
-  VERSION = "0.13.2"
+  VERSION = "0.14.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chop
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -126,9 +126,9 @@ files:
 - bin/setup
 - chop.gemspec
 - lib/chop.rb
-- lib/chop/base.rb
-- lib/chop/builder.rb
+- lib/chop/create.rb
 - lib/chop/definition_list.rb
+- lib/chop/diff.rb
 - lib/chop/dsl.rb
 - lib/chop/form.rb
 - lib/chop/table.rb

data/lib/chop/base.rb

@@ -1,95 +0,0 @@
-require "active_support/core_ext/object/blank"
-
-module Chop
-  class Base < Struct.new(:selector, :table, :session, :block)
-    def self.diff! selector, table, session: Capybara.current_session, &block
-      new(selector, table, session, block).diff!
-    end
-
-    attr_accessor :rows_finder
-    attr_accessor :cells_finder
-    attr_accessor :transformations
-
-    def initialize selector = nil, table = nil, session = Capybara.current_session, block = nil, &other_block
-      super
-      self.selector ||= default_selector
-      self.rows_finder = default_rows_finder
-      self.cells_finder = default_cells_finder
-      self.transformations = []
-      instance_eval &block if block.respond_to?(:call)
-      instance_eval &other_block if block_given?
-    end
-
-    def transformation &block
-      transformations << block
-    end
-
-    def normalize
-      transformation do |raw|
-        max = raw.map(&:count).max
-        raw.map! do |row|
-          row << "" while row.length < max
-          row
-        end
-      end
-    end
-
-    def rows &block
-      self.rows_finder = block
-    end
-
-    def cells &block
-      self.cells_finder = block
-    end
-
-    def allow_not_found
-      @allow_not_found = true
-    end
-
-    def to_a
-      results = rows_finder.call(root).map do |row|
-        row_to_text(row)
-      end
-      normalize
-      transformations.each { |transformation| transformation.call(results) }
-      results
-    end
-
-    def diff! cucumber_table = table
-      cucumber_table.diff! to_a
-    end
-
-    def hashes
-      rows = to_a.dup
-      header = rows.shift
-      rows.map do |row|
-        Hash[header.zip(row)]
-      end
-    end
-
-    private
-
-    def root
-      @root ||= begin
-        session.find(selector)
-      rescue Capybara::ElementNotFound
-        raise unless @allow_not_found
-        Capybara::Node::Simple.new("")
-      end
-    end
-
-    def row_to_text row
-      cells_finder.call(row).map do |cell|
-        cell_to_text(cell)
-      end
-    end
-
-    def cell_to_text cell
-      text = cell.text
-      if text.blank? and image = cell.all("img").first
-        text = image["alt"]
-      end
-      text
-    end
-  end
-end