hash_mapper 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fcd7f8475d938cf6002450682f5e4bf17865074
-  data.tar.gz: a16e082eb53d60cf26fc99c67cbecb31c04787b0
+  metadata.gz: 4ccb1b38f4a738cf5b7f1a147cc998463f14246e
+  data.tar.gz: bb40000c4e4f03cc7cda222bea3f9182189e7faf
 SHA512:
-  metadata.gz: 1075ad77863f0b6ec01b6178a1257d5bb676c556dfe02183dfa5bb3ec67e90548871e58943b3bb6e6e5fedf87a77172793e089bb8c80ee9adbcc12f09007358e
-  data.tar.gz: ce2cdf149dd160c82ad29e441fa17f4eacde912b36fe31ac93f3e3edd74b74776747d94a83b5bdecef5ce5aef380c53e4a001f31e1117147d3e55723843ae4af
+  metadata.gz: 71dc27f23fae5c544caa5389fd7a31c1ae0bd04cfa84b007dfc18197f4dbee1349cbd7d677d59e8420505dcd2fa4c981f4c792429580fe05b656f9fad2046dc5
+  data.tar.gz: 68946b78bc3dc7dd2d0b7d287649125b63bb0ffb5f357fddac4cbd48fd1c944b1b7f3880813d0cce8d73b05605e49c8e19e47cec72acb6c9513a8cdf2b5ee596

data/README.md

@@ -114,6 +114,26 @@ You guessed it. That means that you can actually pass custom blocks to each to()
 map from('/one'), to('/one'){|value| value.to_i}
 ```
 
+#### Default values
+
+You want to make sure that a value is present in the output (even if it's not in the input) so that:
+
+```ruby
+{'one' => '1'}
+```
+
+gets translated to
+
+```ruby
+{:one => 1, :two => 2}
+```
+
+Do this:
+
+```ruby
+map from('/two'), to('/two'), default: 2
+```
+
 #### Custom value filtering
 
 You want to pass the final value of a key through a custom filter:
@@ -204,7 +224,7 @@ class ProjectMapper
   extend HashMapper
   map from('/project'), 		to('/project_name')
   map from('/url'),			to('/url')
-  map from('/author_names'),	to('/author'), using(UserMapper)
+  map from('/author_names'),	to('/author'), using: UserMapper
 end
 ```
 
@@ -231,7 +251,7 @@ end
 But HashMapper's nested mappers will actually do that for you if a value is an array, so:
 
 ```ruby	
-map from('/employees'),	to('employees'), using(UserMapper)
+map from('/employees'),	to('employees'), using: UserMapper
 ```
 ... Will map each employee using UserMapper.
 

data/lib/hash_mapper.rb

@@ -47,9 +47,9 @@ module HashMapper
     end
   end
 
-  def map(from, to, using=nil, &filter)
+  def map(from, to, options={}, &filter)
     self.maps = self.maps.dup
-    self.maps << Map.new(from, to, using)
+    self.maps << Map.new(from, to, options)
     to.filter = filter if block_given? # Useful if just one block given
   end
 
@@ -62,7 +62,8 @@ module HashMapper
   alias :to :from
 
   def using(mapper_class)
-    mapper_class
+    warn "[DEPRECATION] `using` is deprecated, instead of `using(#{mapper_class.name})` you should specify `{ using: #{mapper_class.name} }`"
+    { using: mapper_class }
   end
 
   def normalize(a_hash)
@@ -113,16 +114,19 @@ module HashMapper
   #
   class Map
 
-    attr_reader :path_from, :path_to, :delegated_mapper
+    attr_reader :path_from, :path_to, :delegated_mapper, :default_value
 
-    def initialize(path_from, path_to, delegated_mapper = nil)
-      @path_from, @path_to, @delegated_mapper = path_from, path_to, delegated_mapper
+    def initialize(path_from, path_to, options = {})
+      @path_from = path_from
+      @path_to = path_to
+      @delegated_mapper = options.fetch(:using, nil)
+      @default_value = options.fetch(:default, :hash_mapper_no_default)
     end
 
     def process_into(output, input, meth = :normalize)
       path_1, path_2 = (meth == :normalize ? [path_from, path_to] : [path_to, path_from])
       value = get_value_from_input(output, input, path_1, meth)
-      add_value_to_hash!(output, path_2, value) unless value == :hash_mapper_no_value
+      set_value_in_output(output, path_2, value)
     end
     protected
 
@@ -139,6 +143,16 @@ module HashMapper
       delegated_mapper ? delegate_to_nested_mapper(value, meth) : value
     end
 
+    def set_value_in_output(output, path, value)
+      if value == :hash_mapper_no_value
+        if default_value == :hash_mapper_no_default
+          return
+        else
+          value = default_value
+        end
+      end
+      add_value_to_hash!(output, path, value)
+    end
 
     def delegate_to_nested_mapper(value, meth)
       case value

data/lib/hash_mapper/version.rb

@@ -1,3 +1,3 @@
 module HashMapper
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/hash_mapper_spec.rb

@@ -426,3 +426,24 @@ describe "dealing with strings and symbols" do
   
 end
 
+class DefaultValues
+  extend HashMapper
+
+  map from('/without_default'), to('not_defaulted')
+  map from('/with_default'),    to('defaulted'), default: 'the_default_value'
+end
+
+describe "default values" do
+  it "should use a default value whenever a key is not set" do
+    DefaultValues.normalize(
+      'without_default' => 'some_value'
+    ).should == { not_defaulted: 'some_value', defaulted: 'the_default_value' }
+  end
+
+  it "should not use a default if a key is set (even if the value is falsy)" do
+    DefaultValues.normalize({
+        'without_default' => 'some_value',
+        'with_default' => false
+      }).should == { not_defaulted: 'some_value', defaulted: false }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Ismael Celis