chop 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f361d4f1d6428136b9187e57b495e8a7a2d1b8cb
-  data.tar.gz: 7405d53d647c0af2468fc92cbeaf8f860cb8a921
+  metadata.gz: 59d92389e8d22766ebf98088ebd74d94e8688985
+  data.tar.gz: c9faf716a53e8723cbf06557536a40874acf63b1
 SHA512:
-  metadata.gz: 5a991f6f01794ef5dc5cf033713daeaae096c09b358a602302893491329a23a55e2c5fbaf592a920903370e77972862aea944e2c7036d1a071612f2883573a6f
-  data.tar.gz: 3ebb468ac5ad8ce0aeacb38611ee92b4cc2932fd809d9b61ec7142e802468987d70729af4c45c81c7054a04f1b902a4eb0acbaed965f71a09eed4a08f8336ab5
+  metadata.gz: 96cd9da2dad570c6ea2cd5dc499241defd524dd46112cb45b64ce34049f032734a80362e08ebc3a5b50b08ddaa5951f26bd1f8583b976b9787190045bcff45ef
+  data.tar.gz: 478895292a06647dfa5ee2df7dbef98986bef6c68febe0447d31fe8d79bde787a1a0b1526674182ee2cc40ffe795efa34a0e945aaeac243a3c3d33e0deba5348

data/README.md

@@ -17,12 +17,16 @@ end
 
 Chop monkeypatches Cucumber tables with three new methods:
 
-* `#create!`: Creates ActiveRecord instances. Also supports FactoryGirl.
+* `#create!`: Creates entities. Built-in support for ActiveRecord (default) and FactoryGirl, at present.
 * `#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.
 
+### Configuration methods for `Chop`:
+
+* `.register_creation_strategy`: Provide a key and a block to register alternate strategies for `.create!`, e.g. FactoryGirl.
+
 ### Block methods for `#create!`:
 
 Transform the attributes hash derived from the table before passing to `ActiveRecord.create!`.
@@ -35,11 +39,16 @@ High-level declarative transformations:
 * `#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.
 * `#rename`: Renames one or more fields.
+* `#delete`: Deletes 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 oield value.
+* `#field`: performs transformations on a specific field value.
 * `#transformation`: performs transformations on the attributes hash.
 
+Lifecycle hooks:
+* `#after`: Temporarily removes zero or more fields, and then after record creation, yields them to the block, along with the created record.
+* `#create`: Override the default creation strategy.
+
 ### Block methods for `#diff!`:
 
 Transform the table of Capybara nodes before converting them to text and passing to `diff!`.

data/lib/chop.rb

@@ -5,8 +5,10 @@ require "chop/definition_list"
 require "chop/unordered_list"
 require "chop/form"
 require "chop/dsl"
+require "chop/config"
 
 module Chop
   extend DSL
+  extend Config
 end
 

data/lib/chop/config.rb

@@ -0,0 +1,7 @@
+module Chop
+  module Config
+    def register_creation_strategy *args, &block
+      Chop::Create.register_creation_strategy *args, &block
+    end
+  end
+end

data/lib/chop/create.rb

@@ -1,6 +1,7 @@
 require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/object/blank"
 require "active_support/hash_with_indifferent_access"
+require "active_support/core_ext/class/attribute"
 
 module Chop
   class Create < Struct.new(:klass, :table, :block)
@@ -8,11 +9,28 @@ module Chop
       new(klass, table, block).create!
     end
 
-    attr_accessor :transformations
+    class_attribute :creation_strategies
+    self.creation_strategies = {}
+
+    def self.register_creation_strategy key, &block
+      creation_strategies[key] = block
+    end
+
+    register_creation_strategy nil do |klass, attributes|
+      klass.create! attributes
+    end
+
+    register_creation_strategy :factory_girl do |factory, attributes|
+      FactoryGirl.create factory, attributes
+    end
+
+    attr_accessor :transformations, :deferred_attributes, :after_hooks
 
     def initialize(*, &other_block)
       super
       self.transformations = []
+      self.deferred_attributes = HashWithIndifferentAccess.new
+      self.after_hooks = []
       instance_eval &block if block.respond_to?(:call)
       instance_eval &other_block if block_given?
     end
@@ -23,22 +41,35 @@ module Chop
         attributes = transformations.reduce(attributes) do |attrs, transformation|
           transformation.call(attrs)
         end
-        if klass.is_a?(Hash)
-          if factory = klass[:factory_girl]
-            FactoryGirl.create factory, attributes
-          else
-            raise "Unknown building strategy"
-          end
-        else
-          klass.create! attributes
+
+        strategy, factory = klass.is_a?(Hash) ? klass.to_a.first : [nil, klass]
+        args = [factory, attributes]
+        record = creation_strategies[strategy].call(*args.compact)
+
+        after_hooks.each do |after_hook|
+          after_hook.call(record, attributes.merge(deferred_attributes))
         end
+        record
       end
     end
 
+    def create &block
+      self.creation_strategies = Proc.new { block }
+    end
+
     def transformation &block
       transformations << block
     end
 
+    def delete *keys
+      transformation do |attributes|
+        keys.reduce(attributes) do |attrs, key|
+          attributes.delete(key)
+          attributes
+        end
+      end
+    end
+
     def rename mappings
       transformation do |attributes|
         mappings.reduce(attributes) do |attrs, (old, new)|
@@ -110,6 +141,20 @@ module Chop
     end
     alias_method :belongs_to, :has_one
 
+    def after *keys, &block
+      defer *keys
+      after_hooks << block
+    end
+
+    def defer *keys
+      transformation do |attributes|
+        keys.each do |key|
+          self.deferred_attributes[key] = attributes.delete(key)
+        end
+        attributes
+      end
+    end
+
     private
 
     def extract_options! keys

data/lib/chop/version.rb

@@ -1,3 +1,3 @@
 module Chop
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chop
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -126,6 +126,7 @@ files:
 - bin/setup
 - chop.gemspec
 - lib/chop.rb
+- lib/chop/config.rb
 - lib/chop/create.rb
 - lib/chop/definition_list.rb
 - lib/chop/diff.rb