multiparameter_attributes_handler 0.0.2 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWFmYjJjMmVhMDMzMGY1NGFlMTY3Yzc1Mjk2OTIyYjdmZjM5MTE3ZA==
+  data.tar.gz: !binary |-
+    ZmEzZWIzMzcwMzM5MGQyZmUzMDkyNTBiODlmN2U1NmFjODUyZGU5OQ==
+SHA512:
+  metadata.gz: !binary |-
+    OTkwYmE5ZTFmNDRiYzQxMWJhMTNmMTU5N2E5YTUyMjVjZjJiNTZjNzIzMjll
+    NTVhOTZjZTI2MTg1ODA2M2Y4NTY0MTI0MzQ5MjZmMTI0OGY4YmIxOTRkYzMx
+    MDI5N2YyNDY5MmFkOTdjODhjNWNhNTNiYzZjMjI3ODQ5NGQ5NzQ=
+  data.tar.gz: !binary |-
+    YzVjZTY3NmIyZGU5ODdlMDE3OTc0NWIyZjUwMzQ2OGE0ODMzODM2NWYzMDNi
+    M2NhZGFlNjI4NTkwMzI0MDU5YzIxNjU5ZTUzOGVhOTdiNzMzOTZiNTA2YWM2
+    MzA3NzRlNjY2ZWZjY2ViYjdjNjA5NWQzNDEwZGYwMTUyNWZlZGY=

data/README.rdoc

@@ -1,6 +1,6 @@
-== Multiparameter Attributes Handler
+= Multiparameter Attributes Handler
 
-=== Background
+== Background
 
 Rails form helpers for time, datetime and date return multiparameter attributes
 that ActiveRecord objects are able to convert into parent attributes. 
@@ -18,9 +18,9 @@ when set to 24th June 2004, will generate
    }
     
 ActiveRecord understands this and converts these key/value pairs into a date
-object that is passed to thing.last_read=
+object that is passed to thing#last_read= method.
 
-=== A solution without ActiveRecord
+== A solution without ActiveRecord
 
 Multiparameter Attributes Handler allows other objects to do the same.
 
@@ -35,6 +35,24 @@ This creates a last_read key with a time object derived from the values
         "last_read"     => Time.local('2004', '6', '24')
     }
 
+=== Modifying the output
+
+If you need to modify the derived values, pass a block to manipulate_all, and
+that will be called on each output value.
+
+  thing_params = MultiparameterAttributesHandler.manipulate_all(params[:thing], &:to_s)
+
+Will create
+
+    thing_params == {
+        "last_read(1i)" => "2004", 
+        "last_read(2i)" => "6", 
+        "last_read(3i)" => "24",
+        "last_read"     => Time.local('2004', '6', '24').to_s
+    }
+
+== An ActiveResource example
+
 So for a ActiveResource Thing, this functionality can be added by over-riding
 the attributes setter:
 
@@ -44,6 +62,8 @@ the attributes setter:
       end
     end
 
+== Use within a Rails controller 
+
 However, as the params splitting and rebuilding is happening in the views and
 controller space, it might well make more sense to do the manipulation in the
 controller:
@@ -64,16 +84,14 @@ controller:
       end
     end
 
-=== Only setter affected
+== Only setter affected
 
 Note that this gem provides handling of the parameters received from the form
-submission. For the form helpers to work, they need to passed a date or time
-to the form.
+submission. For the form helpers to work, they need to be passed a date or time.
 
 One solution is to override the getter in the model. So for the Thing example
 above:
 
-    require 'date'
     class Thing < ActiveResource::Base
 
       def last_read
@@ -83,9 +101,9 @@ above:
 
 Rails form date helpers will then work for last_read:
 
-    datetime_select(:thing, :last_read)
+    date_select(:thing, :last_read)
 
-=== Installation
+== Installation
 
 This functionality is made available via the multiparameter_attributes_handler 
 gem. So add this to your gemfile:

data/lib/multiparameter_attributes_handler.rb

@@ -2,8 +2,8 @@ require_relative 'multiparameter_attributes_handler/manipulator'
 require_relative 'multiparameter_attributes_handler/multiparameter_attributes_handler_error'
 module MultiparameterAttributesHandler
   
-  def self.manipulate_all(hash)
-    Manipulator.new(hash).output
+  def self.manipulate_all(hash, &value_mod)
+    Manipulator.new(hash, &value_mod).output
   end
     
 end

data/lib/multiparameter_attributes_handler/manipulator.rb

@@ -1,10 +1,11 @@
 module MultiparameterAttributesHandler
   class Manipulator
     
-    attr_accessor :hash
+    attr_accessor :hash, :value_mod
     
-    def initialize(hash)
+    def initialize(hash, &value_mod)
       @hash = hash
+      @value_mod = value_mod
     end
     
     def multiparameters
@@ -24,7 +25,9 @@ module MultiparameterAttributesHandler
     def value_of(multiparameter)
       values = values_for(multiparameter)
       return values unless values.kind_of? Array
-      convert_to_time(multiparameter, values)
+      time = convert_to_time(multiparameter, values)
+      return time unless value_mod
+      value_mod.call(time)
     end
     
     def output

data/lib/multiparameter_attributes_handler/version.rb

@@ -1,10 +1,17 @@
 module MultiparameterAttributesHandler
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end
 
 # History
 # =======
 # 
+# 0.1.0: Allowed a block to be user to modify the output
+# ------------------------------------------------------
+# A use case was found where the resulting data needed to be stored as a 
+# string, rather than a date. As there may be other ways the output needs
+# modifying, this functionality was added by allowing a block to be
+# passed to manipulate_all.
+# 
 # 0.0.2: Modified usage so that developer decides where manipulation happens
 # ---------------------------------------------------------------------------
 # 

data/test/multiparameter_attributes_handler/manipulator_test.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'
@@ -8,78 +5,108 @@ require_relative '../../lib/multiparameter_attributes_handler'
 
 module MultiparameterAttributesHandler
   class ManipulatorTest < Test::Unit::TestCase
-    
-    def setup
-      @hash = {
-        "last_read(1i)" => "2004", 
-        "last_read(2i)" => "6", 
-        "last_read(3i)" => "24",
-        "other(1i)" => "2012", 
-        "other(2i)" => "2", 
-        "other(3i)" => "2",
-        "other(4i)" => "11",
-        "other(5i)" => "35", 
-        "foo" => 'bar',
-        "something" => 'ho',
-        "something_else" => 'hum'
-      }
-      @original = @hash.clone
-      @manipulator = Manipulator.new(@hash)
-      @output = @manipulator.output
-    end
-    
+
     def test_multiparameters
-      assert_equal(['last_read', 'other'], @manipulator.multiparameters)
+      assert_equal ['last_read', 'other'], manipulator.multiparameters
     end
 
     def test_values_for
-      assert_equal(@hash['foo'], @manipulator.values_for('foo'))
-    end    
-    
+      assert_equal hash['foo'], manipulator.values_for('foo')
+    end
+
     def test_values_for_multiparameter
-      assert_equal(['2004', '6', '24'], @manipulator.values_for('last_read'))
+      assert_equal ['2004', '6', '24'], manipulator.values_for('last_read')
     end
-    
+
     def test_value_of
-      assert_equal(@hash['foo'], @manipulator.value_of('foo'))
+      assert_equal hash['foo'], manipulator.value_of('foo')
     end
-    
+
     def test_value_of_multiparameter
-      assert_equal(Time.local(*@manipulator.values_for('last_read')), @manipulator.value_of('last_read'))
-      assert_equal(Time.local(*@manipulator.values_for('other')), @manipulator.value_of('other'))
+      assert_equal time_for('last_read'), manipulator.value_of('last_read')
+      assert_equal time_for('other'), manipulator.value_of('other')
+    end
+
+    def test_value_mod_changes_values
+      manipulator = Manipulator.new(hash, &:to_s)
+      assert_equal time_for('last_read').to_s, manipulator.value_of('last_read')
     end
     
-    def test_output_returns_original_content     
-      @hash.each do |key, value|
-        assert_equal(value, @output[key])
+    def test_value_mod_with_lambda
+      manipulator = Manipulator.new(hash) {|value| value + 1}
+      assert_equal (time_for('last_read') + 1), manipulator.value_of('last_read')
+    end
+
+    def test_output_returns_original_content
+      build_manipulator
+      hash.each do |key, value|
+        assert_equal value, output[key]
       end
     end
-    
+
     def test_output_returns_multiparameter_content_and_original_content
-      combined_length = @original.length + @manipulator.multiparameters.length
-      assert_equal(combined_length, @output.length)
+      combined_length = original.length + manipulator.multiparameters.length
+      assert_equal combined_length, output.length
     end
-    
+
     def test_output_returns_multiparameter_content
-      @manipulator.multiparameters.each do |multiparameter|
-        assert_equal(@manipulator.value_of(multiparameter), @output[multiparameter])
+      manipulator.multiparameters.each do |multiparameter|
+        assert_equal manipulator.value_of(multiparameter), output[multiparameter]
       end
     end
-    
+
     def test_output_manipulates_hash
-      assert_not_equal(@original, @hash)
-      assert_equal(@output, @hash)
+      build_manipulator
+      assert_not_equal(original, hash)
+      assert_equal output, hash
     end
-    
+
     def test_partial_multiparameters_are_ignored
       [
         {"last_read(1i)" => "2004", "last_read(2i)" => "6", "last_read(3i)" => ""},
         {"last_read(1i)" => "2004", "last_read(2i)" => "", "last_read(3i)" => "24"},
         {"last_read(1i)" => "", "last_read(2i)" => "6", "last_read(3i)" => "24"}
       ].each do |params|
-        assert_equal([], Manipulator.new(params).multiparameters, "#{params.inspect} should return []")
+        assert_equal [], Manipulator.new(params).multiparameters, "#{params.inspect} should return []"
       end
     end
+
+    def hash
+      @hash ||= {
+        "last_read(1i)" => "2004",
+        "last_read(2i)" => "6",
+        "last_read(3i)" => "24",
+        "other(1i)" => "2012",
+        "other(2i)" => "2",
+        "other(3i)" => "2",
+        "other(4i)" => "11",
+        "other(5i)" => "35",
+        "foo" => 'bar',
+        "something" => 'ho',
+        "something_else" => 'hum'
+      }
+    end
+
+    def original
+      @original ||= hash.clone
+    end
+
+    def manipulator
+      @manipulator ||= Manipulator.new(hash)
+    end
+
+    def build_manipulator
+      original # make sure original is generated before manipulator built
+      output   # use output to create manipulator to ensure all objects built
+    end
+
+    def output
+      manipulator.output
+    end
     
+    def time_for(field)
+      Time.local *manipulator.values_for(field)
+    end
+
   end
 end

data/test/multiparameter_attributes_handler/multiparameter_attributes_handler_error_test.rb

@@ -1,6 +1,3 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
-
 $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 
 require 'test/unit'
@@ -8,13 +5,13 @@ require_relative '../../lib/multiparameter_attributes_handler'
 
 module MultiparameterAttributesHandler
   class MultiparameterAttributesHandlerErrorTest < Test::Unit::TestCase
-    
+
     def test_error
       assert_raise RuntimeError do
         raise "Oh yes"
       end
     end
-    
+
     def test_attribute_assignment_error
       error = assert_raise AttributeAssignmentError do
         raise AttributeAssignmentError.new('b', 'c'), 'd'

data/test/multiparameter_attributes_handler_test.rb

@@ -0,0 +1,24 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'multiparameter_attributes_handler'
+
+# NB most testing of MultiparameterAttributesHandler.manipulate_all is done 
+# via the thing_test.
+class MultiparameterAttributesHandlerTest < Test::Unit::TestCase
+
+  def test_manipulate_all   
+    output = MultiparameterAttributesHandler.manipulate_all(attributes)
+    assert_equal Time.local(2004, 6, 24), output['last_read']
+  end
+  
+  def test_manipulate_all_with_block
+    output = MultiparameterAttributesHandler.manipulate_all(attributes, &:to_s)
+    assert_equal Time.local(2004, 6, 24).to_s, output['last_read']
+  end
+  
+  def attributes
+    { "last_read(1i)" => "2004", "last_read(2i)" => "6", "last_read(3i)" => "24" }
+  end
+  
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multiparameter_attributes_handler
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Rob Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies: []
 description: Rails forms helpers for date and time fields generate multiparameter
   params. multiparameter_attributes_handler allows objects to assign these to thier
@@ -20,43 +19,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/multiparameter_attributes_handler/version.rb
-- lib/multiparameter_attributes_handler/manipulator.rb
-- lib/multiparameter_attributes_handler/multiparameter_attributes_handler_error.rb
-- lib/multiparameter_attributes_handler.rb
 - MIT-LICENSE
-- Rakefile
 - README.rdoc
-- test/thing.rb
-- test/multiparameter_attributes_handler/multiparameter_attributes_handler_error_test.rb
+- Rakefile
+- lib/multiparameter_attributes_handler.rb
+- lib/multiparameter_attributes_handler/manipulator.rb
+- lib/multiparameter_attributes_handler/multiparameter_attributes_handler_error.rb
+- lib/multiparameter_attributes_handler/version.rb
 - test/multiparameter_attributes_handler/manipulator_test.rb
+- test/multiparameter_attributes_handler/multiparameter_attributes_handler_error_test.rb
+- test/multiparameter_attributes_handler_test.rb
+- test/thing.rb
 - test/thing_test.rb
 homepage: https://github.com/reggieb/multiparameter_attributes_handler
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Allows objects with attributes, to handle multiparameter params
 test_files:
+- test/thing_test.rb
+- test/multiparameter_attributes_handler_test.rb
 - test/thing.rb
 - test/multiparameter_attributes_handler/multiparameter_attributes_handler_error_test.rb
 - test/multiparameter_attributes_handler/manipulator_test.rb
-- test/thing_test.rb