htransform 0.8.0 → 0.9.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+  - "rbx-2"

data/README.md

@@ -1,9 +1,11 @@
 HTransform
 ======
 
+[![Build Status](https://travis-ci.org/joshkrueger/htransform.svg?branch=master)](https://travis-ci.org/joshkrueger/htransform)
+
 HTransform provides a simple DSL to transform a supplied hash with an arbitrary structure to another hash with an even more arbitrary structure.
 
-***Note:*** *HTransform does not simply modify the hash you have passed in. It actually creates a new hash from scratch. It only copies or does transformations on the fields you specify in the transform block.*
+***Note:*** *HTransform does not simply modify the hash you have passed in. It actually creates a new hash from scratch. It only copies or does transformations on the fields you specify in the transform block, unless you use the `passthrough_remaining` option (see below)*
 
 Support
 =======
@@ -130,6 +132,16 @@ Want to combine multiple inputs when one or more are an array?
 
         input [ [ "foo", "bar" ], "baz" ] => "combined nested hash"
 
+Want to simply pass some parts of your original hash through? Simply specify the keys you want passed through:
+
+        passthrough :this_one, :that_one
+
+Want to pass every part of your original hash that was not transformed through? **HTransform CAN DO THAT TOO!** Simply add the following at the _end_ of your `transform` block:
+
+        passthrough_remaining
+
+***Note:*** *You MUST specify it only at the end of your `transform` block, as Tranny needs to know all the keys that were transformed before it!*
+
 Shorthand Limitations
 ==============
 

data/lib/htransform.rb

@@ -24,6 +24,7 @@ class HTransform
     @output_hash = Hash.new { |h,k| h[k] = Hash.new(&h.default_proc) }
     @input_nest = []
     @output_nest = []
+    @inputs = Set.new
   end
 
   def convert(input)
@@ -43,6 +44,14 @@ class HTransform
 
   private
 
+  def record(*keys)
+    keys.each{ |key| @inputs << key }
+  end
+
+  def recorded?(key)
+    @inputs.include? key
+  end
+
   def set_val(dst, val)
 
     dst = (@output_nest + [dst]).flatten unless @output_nest.empty?
@@ -118,6 +127,12 @@ class HTransform
     end
   end
 
+  def passthrough_remaining
+    @input_hash.each_key do |key|
+      passthrough(key) unless recorded?(key)
+    end
+  end
+
   def input_multiple(options)
     from, to, via, default = parse_options(options)
     via = lambda { |x| x.join(" ") } if via.nil?
@@ -139,7 +154,7 @@ class HTransform
       end
     end
 
-
+    record(*from)
     set_val(to, new_value)
   end
 
@@ -166,6 +181,7 @@ class HTransform
       get_val(from)
     end
 
+    record(*from)
     set_val(to, new_value)
   end
 

data/lib/htransform/version.rb

@@ -1,3 +1,3 @@
 class HTransform
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/spec/htransform_spec.rb

@@ -367,6 +367,99 @@ describe HTransform do
 
   end
 
+  context "passthrough_remaining" do
+    it "passes all keys that were not specified in an #input through" do
+      class TestHTransform < HTransform
+        transform do
+          input :bar => :bar_key
+          passthrough :foo
+          passthrough_remaining
+        end
+      end
+
+      input_hash = { :bar => 'one', :foo => 1, :lala => nil, :lolo => 1 }
+      desired_hash = { :bar_key => 'one', :foo => 1, :lala => nil, :lolo => 1 }
+
+      result = TestHTransform.convert(input_hash)
+      result.should == desired_hash
+    end
+
+    it "treats #input_multiple keys as distinct, and does not pass them through" do
+      class TestHTransform < HTransform
+        transform do
+          input_multiple [:bar, :key] => :bar_key
+          passthrough_remaining
+        end
+      end
+
+      input_hash = { :bar => 'one', :key => 'two', :lala => nil, :lolo => 1 }
+      desired_hash = { :bar_key => 'one two', :lala => nil, :lolo => 1 }
+
+      result = TestHTransform.convert(input_hash)
+      result.should == desired_hash
+    end
+
+    it "treats nested inputs as distinct, and does not pass them through" do
+      class TestHTransform < HTransform
+        transform do
+          input [:outer, :bar] => :sandbar
+          passthrough_remaining
+        end
+      end
+
+      input_hash = { :outer => { :bar => 1 }, :bar => :bie, :outer2 => { :bar2 => 2 } }
+      desired_hash = { :sandbar => 1, :outer2 => { :bar2 => 2 } }
+
+      result = TestHTransform.convert(input_hash)
+      result.should == desired_hash
+    end
+
+    it "passes through nested outputs if they were not used as inputs" do
+      class TestHTransform < HTransform
+        transform do
+          input :sandbar => [:outer, :bar]
+          passthrough_remaining
+        end
+      end
+
+      input_hash = { :sandbar => { :inner => 1 }, :bar => :bie, :outer2 => { :bar2 => 2 } }
+      desired_hash = { :outer => { :bar => { :inner => 1 } }, :bar => :bie, :outer2 => { :bar2 => 2 } }
+
+      result = TestHTransform.convert(input_hash)
+      result.should == desired_hash
+    end
+
+    it "Only not passthrough the inputs in a nested-nested situation" do
+      class TestHTransform < HTransform
+        transform do
+          input [:sand, :bar] => [:outer, :otter]
+          passthrough_remaining
+        end
+      end
+
+      input_hash = { :sand => { :bar => 1 }, :bar => :bie, :otter => 2 }
+      desired_hash = { :outer => { :otter => 1 }, :otter => 2 }
+
+      result = TestHTransform.convert(input_hash)
+      result.should == desired_hash
+    end
+
+    it "Treats array-keys as a single entity, and passes their individual components through" do
+      class TestHTransform < HTransform
+        transform do
+          input [[:sand, :bar], :baz] => :combo_bar
+          passthrough_remaining
+        end
+      end
+
+      input_hash = { [:sand, :bar] => { :baz => 1 }, :bar => :bie, :baz => :ket, :otter => 2 }
+      desired_hash = { :combo_bar => 1, :bar => :bie, :otter => 2 }
+
+      result = TestHTransform.convert(input_hash)
+      result.should == desired_hash
+    end
+  end
+
   context "non-hashes" do
     it "works with objects that respond to to_hash" do
       class TestHTransform < HTransform

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: htransform
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,6 +52,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile