multiparameter_attributes_handler 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Rob Nichols
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,85 @@
+== Multiparameter Attributes Handler
+
+=== Background
+
+Rails form helpers for time, datetime and date return multiparameter attributes
+that ActiveRecord objects are able to convert into parent attributes. 
+
+For example
+
+    date_select(:thing, :last_read)
+
+when set to 24th June 2004, will generate
+
+   'thing' => {
+        "last_read(1i)" => "2004", 
+        "last_read(2i)" => "6", 
+        "last_read(3i)" => "24"
+   }
+    
+ActiveRecord understands this and converts these key/value pairs into a date
+object that is passed to thing.last_record=
+
+=== A solution without ActiveRecord
+
+Multiparameter Attributes Handler allows other objects to do the same. In 
+particular, ActiveResource models.
+
+It does this by modifying the way attributes= works. So for the above example,
+the values passed down the attributes= chain gets converted to:
+
+   'thing' => {
+        "last_read(1i)" => "2004", 
+        "last_read(2i)" => "6", 
+        "last_read(3i)" => "24",
+        "last_read"     => Time.local('2004', '6', '24')
+   }
+
+So for a ActiveResource Thing, this functionality is added like this:
+
+    class Thing < ActiveResource::Base
+      include MultiparameterAttributesHandler
+    end
+
+=== 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.
+
+One solution is to over-ride the getter in the model. So for the Thing example
+above, the complete solution would look like this:
+
+    require 'date'
+    class Thing < ActiveResource::Base
+      include MultiparameterAttributesHandler
+
+      def last_read
+        Date.parse(super)
+      end
+    end 
+
+Rails form date helpers will then work for last_read:
+
+    date_select(:thing, :last_read)
+
+And in the controller's create and update methods:
+
+    thing.attributes = params[:thing]
+
+Or
+
+    Thing.new(params[:thing])
+
+Or
+
+    thing.update_attributes(params[:thing])
+
+
+=== Installation
+
+This functionality is made available via the multiparameter_attributes_handler 
+gem. So add this to your gemfile:
+
+    gem 'multiparameter_attributes_handler'
+

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rdoc/task'
+require 'rake/testtask'
+
+Rake::RDocTask.new do |rdoc|
+  files =['README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "MultiparameterAttributesHandler Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/lib/multiparameter_attributes_handler.rb

@@ -0,0 +1,9 @@
+require_relative 'multiparameter_attributes_handler/manipulator'
+require_relative 'multiparameter_attributes_handler/multiparameter_attributes_handler_error'
+module MultiparameterAttributesHandler
+  
+  def attributes=(new_attributes)
+    super Manipulator.new(new_attributes).output
+  end
+    
+end

data/lib/multiparameter_attributes_handler/manipulator.rb

@@ -0,0 +1,120 @@
+module MultiparameterAttributesHandler
+  class Manipulator
+    
+    attr_accessor :hash
+    
+    def initialize(hash)
+      @hash = hash
+    end
+    
+    def multiparameters
+      keys = multiparameter_keys.collect do |k| 
+        k.gsub(ends_with_number_letter_in_brackets, "")
+      end
+      keys.uniq!
+      keys.delete_if{|k| empty_date_values_for? k}
+      return keys
+    end
+    
+    def values_for(multiparameter)
+      return hash[multiparameter] unless multiparameters.include? multiparameter
+      keys_for(multiparameter).collect{|k| hash[k]}
+    end
+    
+    def value_of(multiparameter)
+      values = values_for(multiparameter)
+      return values unless values.kind_of? Array
+      convert_to_time(multiparameter, values)
+    end
+    
+    def output
+      begin
+        multiparameters.each do |multiparameter|
+          hash[multiparameter] = value_of(multiparameter)
+        end
+      rescue => e
+        errors << e
+      end
+      return hash if errors.empty?
+      raise_combined_error(errors)
+    end
+    
+    private
+    def convert_to_time(multiparameter, values)
+      begin
+        Time.local(*values)
+      rescue => e
+        msg = "Error determining value_of #{multiparameter} from #{values} (#{e.message})"
+        raise_assignment_errors(multiparameter, values, msg, e)
+      end
+    end
+    
+    def multiparameter_keys
+      hash.keys.select{|k| k =~ ends_with_number_letter_in_brackets}
+    end
+    
+    def ends_with_number_letter_in_brackets
+      /\(\d+\w+\)$/
+    end    
+    
+    def keys_for(multiparameter)
+      keys = multiparameter_keys.select{|k| /^#{multiparameter}\(/ =~ k}
+      add_missing_keys_for(multiparameter, keys)
+      return keys.sort if sequence_starting_at_one?(keys)
+      
+      raise_assignment_errors(
+        multiparameter, 
+        keys, 
+        "key number sequence incomplete or not starting at one"
+      )
+      
+    end
+    
+    def add_missing_keys_for(multiparameter, keys)
+      postscript = characters_after_sequence_number(keys.first)
+      numbers = sequence_numbers(keys)
+      (1..numbers.last).each do |number|
+        next if number < 3 # don't replace missing date keys
+        next if numbers.include? number
+        key = "#{multiparameter}(#{number}#{postscript})"
+        hash[key] = '00'
+        keys << key
+      end
+    end
+    
+    def characters_after_sequence_number(sample_key)
+      match = sample_key.match(/\(\d+(\w*)\)/)
+      match ? match[1] : ""
+    end
+    
+    def empty_date_values_for?(multiparameter)
+      keys = keys_for(multiparameter)[0..2].select{|p| hash[p].empty?}
+      !keys.empty?
+    end
+    
+    def sequence_starting_at_one?(keys)
+      numbers = sequence_numbers(keys)
+      expected = (1..10).to_a
+      numbers == expected[0..(numbers.length - 1)]
+    end
+    
+    def sequence_numbers(keys)
+      keys.collect{|k| m = k.match(/\((\d+)\w+\)/); m ? m[1].to_i : nil}.sort
+    end
+    
+    def errors
+      @errors ||= []
+    end
+    
+    def raise_assignment_errors(multiparameter, values, message, error = StandardError)
+      msg = "Error determining value_of #{multiparameter} from #{values} (#{message})"
+      raise AttributeAssignmentError.new(error, multiparameter), msg
+    end
+    
+    def raise_combined_error(errors)
+      error_descriptions = errors.collect { |ex| ex.message }.join(",")
+      msg = "#{errors.size} error(s) on determining value of multiparameter attributes [#{error_descriptions}]"
+      raise MultiparameterAssignmentErrors.new(errors), msg
+    end    
+  end
+end

data/lib/multiparameter_attributes_handler/multiparameter_attributes_handler_error.rb

@@ -0,0 +1,29 @@
+
+module MultiparameterAttributesHandler
+  
+  class MultiparameterAttributesHandlerError < StandardError
+
+  end
+  
+  # Raised when an error occurred while doing a mass assignment to an attribute through the
+  # <tt>attributes=</tt> method. The exception has an +attribute_name+ property that is 
+  # the name of the offending attribute.
+  class AttributeAssignmentError < MultiparameterAttributesHandlerError
+    attr_reader :exception_raised, :attribute_name
+    def initialize(exception_raised, attribute_name)
+      @exception_raised = exception_raised
+      @attribute_name = attribute_name
+    end
+  end
+
+  # Raised when there are multiple errors while doing a mass assignment through the +attributes+
+  # method. The exception has an +errors+ property that contains an array of AttributeAssignmentError
+  # objects, each corresponding to the error while assigning to an attribute.
+  class MultiparameterAssignmentErrors < MultiparameterAttributesHandlerError
+    attr_reader :errors
+    def initialize(errors)
+      @errors = errors
+    end
+    
+  end
+end

data/lib/multiparameter_attributes_handler/version.rb

@@ -0,0 +1,13 @@
+module MultiparameterAttributesHandler
+  VERSION = "0.0.1"
+end
+
+# History
+# =======
+# 
+# 0.0.1: First gem
+# ----------------
+# 
+# Released for testing and review of functionality.
+# 
+

data/test/multiparameter_attributes_handler/manipulator_test.rb

@@ -0,0 +1,85 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+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)
+    end
+
+    def test_values_for
+      assert_equal(@hash['foo'], @manipulator.values_for('foo'))
+    end    
+    
+    def test_values_for_multiparameter
+      assert_equal(['2004', '6', '24'], @manipulator.values_for('last_read'))
+    end
+    
+    def test_value_of
+      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'))
+    end
+    
+    def test_output_returns_original_content     
+      @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)
+    end
+    
+    def test_output_returns_multiparameter_content
+      @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)
+    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 []")
+      end
+    end
+    
+  end
+end

data/test/multiparameter_attributes_handler/multiparameter_attributes_handler_error_test.rb

@@ -0,0 +1,28 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+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'
+      end
+      assert_equal('d', error.message)
+      assert_equal('b', error.exception_raised)
+      assert_equal('c', error.attribute_name)
+    end
+
+  end
+end

data/test/thing.rb

@@ -0,0 +1,16 @@
+require_relative '../lib/multiparameter_attributes_handler'
+
+class Parent
+  attr_accessor :attributes
+end
+
+
+class Thing < Parent
+  
+  include MultiparameterAttributesHandler
+  
+  def initialize
+    
+  end
+end
+

data/test/thing_test.rb

@@ -0,0 +1,183 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'date'
+require_relative 'thing'
+
+class ThingTest < Test::Unit::TestCase
+  
+  def setup
+    @thing = Thing.new
+  end
+  
+  def test_multiparameter_attributes_on_date
+    attributes = { "last_read(1i)" => "2004", "last_read(2i)" => "6", "last_read(3i)" => "24" }
+    @thing.attributes = attributes
+    # note that extra #to_date call allows test to pass for Oracle, which
+    # treats dates/times the same
+    assert_equal Time.local(2004, 6, 24), @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_date_with_empty_year
+    attributes = { "last_read(1i)" => "", "last_read(2i)" => "6", "last_read(3i)" => "24" }
+    @thing.attributes = attributes
+    # note that extra #to_date call allows test to pass for Oracle, which
+    # treats dates/times the same
+    assert_nil @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_date_with_empty_month
+    attributes = { "last_read(1i)" => "2004", "last_read(2i)" => "", "last_read(3i)" => "24" }
+    @thing.attributes = attributes
+    # note that extra #to_date call allows test to pass for Oracle, which
+    # treats dates/times the same
+    assert_nil @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_date_with_empty_day
+    attributes = { "last_read(1i)" => "2004", "last_read(2i)" => "6", "last_read(3i)" => "" }
+    @thing.attributes = attributes
+    # note that extra #to_date call allows test to pass for Oracle, which
+    # treats dates/times the same
+    assert_nil @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_date_with_empty_day_and_year
+    attributes = { "last_read(1i)" => "", "last_read(2i)" => "6", "last_read(3i)" => "" }
+    @thing.attributes = attributes
+    # note that extra #to_date call allows test to pass for Oracle, which
+    # treats dates/times the same
+    assert_nil @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_date_with_empty_day_and_month
+    attributes = { "last_read(1i)" => "2004", "last_read(2i)" => "", "last_read(3i)" => "" }
+    @thing.attributes = attributes
+    # note that extra #to_date call allows test to pass for Oracle, which
+    # treats dates/times the same
+    assert_nil @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_date_with_empty_year_and_month
+    attributes = { "last_read(1i)" => "", "last_read(2i)" => "", "last_read(3i)" => "24" }
+    @thing.attributes = attributes
+    # note that extra #to_date call allows test to pass for Oracle, which
+    # treats dates/times the same
+    assert_nil @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_date_with_all_empty
+    attributes = { "last_read(1i)" => "", "last_read(2i)" => "", "last_read(3i)" => "" }
+    @thing.attributes = attributes
+    assert_nil @thing.attributes['last_read']
+  end
+
+  def test_multiparameter_attributes_on_time
+    attributes = {
+      "written_on(1i)" => "2004", "written_on(2i)" => "6", "written_on(3i)" => "24",
+      "written_on(4i)" => "16", "written_on(5i)" => "24", "written_on(6i)" => "00"
+    }
+    @thing.attributes = attributes
+    assert_equal Time.local(2004, 6, 24, 16, 24, 0), @thing.attributes['written_on']
+  end
+
+  def test_multiparameter_attributes_on_time_with_no_date
+    ex = assert_raise(MultiparameterAttributesHandler::MultiparameterAssignmentErrors) do
+      attributes = {
+        "written_on(4i)" => "16", "written_on(5i)" => "24", "written_on(6i)" => "00"
+      }
+      @thing.attributes = attributes
+    end
+    assert_equal("written_on", ex.errors[0].attribute_name)
+  end
+
+  def test_multiparameter_attributes_on_time_with_invalid_time_params
+    ex = assert_raise(MultiparameterAttributesHandler::MultiparameterAssignmentErrors) do
+      attributes = {
+        "written_on(1i)" => "2004", "written_on(2i)" => "6", "written_on(3i)" => "24",
+        "written_on(4i)" => "2004", "written_on(5i)" => "36", "written_on(6i)" => "64",
+      }
+      @thing.attributes = attributes
+    end
+    assert_equal("written_on", ex.errors[0].attribute_name)
+  end
+
+  def test_multiparameter_attributes_on_time_with_old_date
+    attributes = {
+      "written_on(1i)" => "1850", "written_on(2i)" => "6", "written_on(3i)" => "24",
+      "written_on(4i)" => "16", "written_on(5i)" => "24", "written_on(6i)" => "00"
+    }
+    @thing.attributes = attributes
+    # testing against to_s(:db) representation because either a Time or a DateTime might be returned, depending on platform
+    assert_equal "1850-06-24 16:24:00", @thing.attributes['written_on'].strftime("%Y-%m-%d %H:%M:%S")
+  end
+
+  def test_multiparameter_attributes_on_time_will_raise_on_big_time_if_missing_date_parts
+    ex = assert_raise(MultiparameterAttributesHandler::MultiparameterAssignmentErrors) do
+      attributes = {
+        "written_on(4i)" => "16", "written_on(5i)" => "24"
+      }
+      @thing.attributes = attributes
+    end
+    assert_equal("written_on", ex.errors[0].attribute_name)
+  end
+
+  def test_multiparameter_attributes_on_time_with_raise_on_small_time_if_missing_date_parts
+    ex = assert_raise(MultiparameterAttributesHandler::MultiparameterAssignmentErrors) do
+      attributes = {
+        "written_on(4i)" => "16", "written_on(5i)" => "12", "written_on(6i)" => "02"
+      }
+      @thing.attributes = attributes
+    end
+    assert_equal("written_on", ex.errors[0].attribute_name)
+  end
+
+  def test_multiparameter_attributes_on_time_will_ignore_hour_if_missing
+    attributes = {
+      "written_on(1i)" => "2004", "written_on(2i)" => "12", "written_on(3i)" => "12",
+      "written_on(5i)" => "12", "written_on(6i)" => "02"
+    }
+    @thing.attributes = attributes
+    assert_equal Time.local(2004, 12, 12, 0, 12, 2), @thing.attributes['written_on']
+  end
+  
+  def test_multiparameter_attributes_on_time_will_ignore_hour_if_blank
+    attributes = {
+      "written_on(1i)" => "", "written_on(2i)" => "", "written_on(3i)" => "",
+      "written_on(4i)" => "", "written_on(5i)" => "12", "written_on(6i)" => "02"
+    }
+    @thing.attributes = attributes
+    assert_nil @thing.attributes['written_on']
+  end
+
+  def test_multiparameter_attributes_on_time_will_ignore_date_if_empty
+    attributes = {
+      "written_on(1i)" => "", "written_on(2i)" => "", "written_on(3i)" => "",
+      "written_on(4i)" => "16", "written_on(5i)" => "24"
+    }
+
+    @thing.attributes = attributes
+    assert_nil @thing.attributes['written_on']
+  end
+  
+  def test_multiparameter_attributes_on_time_with_seconds_will_ignore_date_if_empty
+    attributes = {
+      "written_on(1i)" => "", "written_on(2i)" => "", "written_on(3i)" => "",
+      "written_on(4i)" => "16", "written_on(5i)" => "12", "written_on(6i)" => "02"
+    }
+
+    @thing.attributes = attributes
+    assert_nil @thing.attributes['written_on']
+  end
+
+  def test_multiparameter_attributes_on_time_with_empty_seconds
+    attributes = {
+      "written_on(1i)" => "2004", "written_on(2i)" => "6", "written_on(3i)" => "24",
+      "written_on(4i)" => "16", "written_on(5i)" => "24", "written_on(6i)" => ""
+    }
+
+    @thing.attributes = attributes
+    assert_equal Time.local(2004, 6, 24, 16, 24, 0), @thing.attributes['written_on']
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: multiparameter_attributes_handler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 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
+  attributes,
+email:
+- rob@undervale.co.uk
+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
+- test/multiparameter_attributes_handler/manipulator_test.rb
+- test/thing_test.rb
+homepage: https://github.com/reggieb/multiparameter_attributes_handler
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Allows objects with attributes, to handle multiparameter params
+test_files:
+- test/thing.rb
+- test/multiparameter_attributes_handler/multiparameter_attributes_handler_error_test.rb
+- test/multiparameter_attributes_handler/manipulator_test.rb
+- test/thing_test.rb