aduki 0.0.4 → 0.0.5

data/README.md

@@ -48,6 +48,7 @@ Here's an abbreviated version:
       attr_accessor :name, :weight, :speed, :builder, :team
       attr_accessor :assemblies, :dimensions
       aduki :assemblies => Assembly, :builder => MachineBuilder
+      aduki :helpers => { :key => MachineBuilder }
     end
 
     class Model
@@ -71,6 +72,13 @@ This line instructs aduki to initialise the #gadget field with a Gadget object.
 array with a Machine object. Aduki decides to create an object or an array of objects depending on the attributes-hash contents, rather than on any
 metadata you may specify here.
 
+
+The following line tells aduki to expect a hash for the #helpers attribute, and for each value in the hash is should construct a new MachineBuilder instance:
+
+      aduki :helpers => { :key => MachineBuilder }
+
+
+
 ## Contributing
 
 1. Fork it

data/aduki.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
 
 
   gem.add_development_dependency 'rspec', '~> 2.9'
+  gem.add_development_dependency 'rspec_numbering_formatter'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/aduki.rb

@@ -1,30 +1,71 @@
 require "aduki/version"
 
 module Aduki
+  def self.to_aduki obj, collector={ }, key="", join=""
+    case obj
+    when Hash
+      obj.keys.inject(collector) { |result, k|
+        v = obj[k]
+        to_aduki v, collector, "#{key}#{join}#{k}", "."
+        result
+      }
+    when Array
+      obj.each_with_index do |av, ix|
+        to_aduki av, collector, "#{key}[#{ix}]", "."
+      end
+    when String, Numeric, Symbol
+      collector[key] = obj
+    else
+      vv = obj.instance_variables
+      vv.each do |v|
+        accessor = v.to_s.gsub(/^@/, "").to_sym
+        if obj.respond_to?(accessor) && obj.respond_to?("#{accessor}=".to_sym)
+          to_aduki obj.send(accessor), collector, "#{key}#{join}#{accessor}", "."
+        end
+      end
+    end
+    collector
+  end
+
   def self.to_value klass, setter, value
     type = klass.aduki_type_for_attribute_name setter
-    type ? type.new(value) : value
+    if type.is_a? Hash
+      to_typed_hash type.values.first, value
+    else
+      type ? type.new(value) : value
+    end
   end
 
-  def self.apply_attributes object, attrs
-    setters = { }
-    klass = object.class
+  def self.to_typed_hash klass, value
+    setters = split_attributes value
+    hsh = { }
+    setters.each { |k, v|
+      hsh[k] = klass.new(v)
+    }
+    hsh
+  end
 
+  def self.split_attributes attrs
+    setters = { }
     attrs.each do |setter, value|
-      if setter.match /\./
+      if setter.match(/\./)
         first, rest = setter.split(/\./, 2)
         setters[first] ||= { }
         setters[first][rest] = value
-      elsif setter.match /\[\d+\]/
-        setters[setter] = value
       else
-        object.send "#{setter}=", value
+        setters[setter] = value
       end
     end
+    setters
+  end
+
+  def self.apply_attributes object, attrs
+    setters = split_attributes attrs
+    klass = object.class
 
     setters.each do |setter, value|
-      if setter.match /\[\d+\]/
-        setter = setter.gsub /\[\d+\]/, ''
+      if setter.match(/\[\d+\]/)
+        setter = setter.gsub(/\[\d+\]/, '')
         array = object.send setter.to_sym
         if array == nil
           array = []
@@ -32,7 +73,6 @@ module Aduki
         end
         array << to_value(klass, setter, value)
       else
-        type = klass.aduki_type_for_attribute_name setter
         object.send "#{setter}=", to_value(klass, setter, value)
       end
     end

data/lib/aduki/version.rb

@@ -1,3 +1,3 @@
 module Aduki
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/initializer_spec.rb

@@ -35,6 +35,18 @@ describe Aduki::Initializer do
       "machines[0].team.lead"       => "Shakespeare", # there is no class definition for #team, so Aduki will apply a hash with properties #lead, #code, #design
       "machines[0].team.code"       => "Chaucer",
       "machines[0].team.design"     => "Jobs",
+      "machines[0].helpers.jim.name"   => "Jim Appleby",
+      "machines[0].helpers.jim.email"  => "Jim.Appleby@example.com",
+      "machines[0].helpers.jim.phone"  => "123 456 789",
+      "machines[0].helpers.jim.office" => "Elephant & Castle",
+      "machines[0].helpers.ben.name"   => "Ben Barnes",
+      "machines[0].helpers.ben.email"  => "Ben.Barnes@example.com",
+      "machines[0].helpers.ben.phone"  => "123 456 790",
+      "machines[0].helpers.ben.office" => "Cockney",
+      "machines[0].helpers.pat.name"   => "Patrick O'Brien",
+      "machines[0].helpers.pat.email"  => "Patrick.O.Brien@example.com",
+      "machines[0].helpers.pat.phone"  => "123 456 791",
+      "machines[0].helpers.pat.office" => "Hammersmith",
       "machines[1].name"           => "The Second Machine",
       "machines[1].weight"         => "34",
       "machines[1].speed"          => "289",
@@ -104,6 +116,21 @@ describe Aduki::Initializer do
     model.machines[0].dimensions[2].should == "3859.39"
     model.machines[0].dimensions[3].should == "2365.68"
     model.machines[0].team.should == { "lead" => "Shakespeare", "code" => "Chaucer", "design" => "Jobs"}
+    model.machines[0].helpers["jim"].should be_a MachineBuilder
+    model.machines[0].helpers["jim"].name.should == "Jim Appleby"
+    model.machines[0].helpers["jim"].email.should == "Jim.Appleby@example.com"
+    model.machines[0].helpers["jim"].phone.should == "123 456 789"
+    model.machines[0].helpers["jim"].office.should == "Elephant & Castle"
+    model.machines[0].helpers["ben"].should be_a MachineBuilder
+    model.machines[0].helpers["ben"].name.should == "Ben Barnes"
+    model.machines[0].helpers["ben"].email.should == "Ben.Barnes@example.com"
+    model.machines[0].helpers["ben"].phone.should == "123 456 790"
+    model.machines[0].helpers["ben"].office.should == "Cockney"
+    model.machines[0].helpers["pat"].should be_a MachineBuilder
+    model.machines[0].helpers["pat"].name.should == "Patrick O'Brien"
+    model.machines[0].helpers["pat"].email.should == "Patrick.O.Brien@example.com"
+    model.machines[0].helpers["pat"].phone.should == "123 456 791"
+    model.machines[0].helpers["pat"].office.should == "Hammersmith"
     model.machines[1].name.should == "The Second Machine"
     model.machines[1].weight.should == "34"
     model.machines[1].speed.should == "289"
@@ -138,5 +165,36 @@ describe Aduki::Initializer do
     model.countries[2].should == "Germany"
     model.countries[3].should == "Ireland"
     model.countries[4].should == "Spain"
+
+    sensibly_indexed_props = props.merge({
+      "machines[1].assemblies[0].name"   => "second machine, first assembly",  # the array index distinguishes items but does not order them
+      "machines[1].assemblies[0].colour" => "purple",
+      "machines[1].assemblies[0].size"   => "pretty small",
+      "machines[1].assemblies[1].name"   => "second machine, second assembly",
+      "machines[1].assemblies[1].colour" => "turquoise",
+      "machines[1].assemblies[1].size"   => "large-ish",
+      "machines[1].assemblies[2].name"   => "second machine, third assembly",
+      "machines[1].assemblies[2].colour" => "magenta",
+      "machines[1].assemblies[2].size"   => "gigantic",
+      "machines[1].dimensions[0]"   => "1985.85",
+      "machines[1].dimensions[1]"   => "7234.92",
+      "machines[1].dimensions[2]"   => "9725.52",
+      "machines[1].dimensions[3]"   => "3579.79",
+    })
+
+    silly_keys = [ "machines[1].assemblies[98].name",
+                   "machines[1].assemblies[98].colour",
+                   "machines[1].assemblies[98].size",
+                   "machines[1].assemblies[99].name",
+                   "machines[1].assemblies[99].colour",
+                   "machines[1].assemblies[99].size",
+                   "machines[1].dimensions[20]",
+                   "machines[1].dimensions[30]",
+                   "machines[1].dimensions[40]",
+                   "machines[1].dimensions[50]"]
+
+    silly_keys.each { |k| sensibly_indexed_props.delete k }
+
+    Aduki.to_aduki(model).should == sensibly_indexed_props
   end
 end

data/spec/spec_helper.rb

@@ -28,8 +28,9 @@ end
 class Machine
   include Aduki::Initializer
   attr_accessor :name, :weight, :speed, :builder, :team
-  attr_accessor :assemblies, :dimensions
+  attr_accessor :assemblies, :dimensions, :helpers
   aduki :assemblies => Assembly, :builder => MachineBuilder
+  aduki :helpers => { :key => MachineBuilder }
 end
 
 class Model

data/spec/to_aduki_spec.rb

@@ -0,0 +1,115 @@
+require "aduki"
+require "spec_helper"
+
+describe Aduki do
+  it "should return a plain hash structure" do
+    hsh = { "foo" => "bar" }
+    props = Aduki.to_aduki hsh
+    props.should == { "foo" => "bar" }
+  end
+
+  it "should flatten nested keys" do
+    hsh = { "foo" => "bar", "bing" => { "boo" => "wogga", "tingle" => "wimp" } }
+    props = Aduki.to_aduki hsh
+    props.should == {
+      "foo"         => "bar",
+      "bing.boo"    => "wogga",
+      "bing.tingle" => "wimp"
+    }
+  end
+
+  it "should flatten deeply nested keys" do
+    hsh = {
+      "foo" => "bar",
+      "bing" => {
+        "boo" => "wogga",
+        "tingle" => "wimp",
+        "harpoon" => {
+          "shonk" => "twaddle",
+          "scorn" => "shart"
+        }} }
+    props = Aduki.to_aduki hsh
+    props.should == {
+      "foo"         => "bar",
+      "bing.boo"    => "wogga",
+      "bing.tingle" => "wimp",
+      "bing.harpoon.shonk" => "twaddle",
+      "bing.harpoon.scorn" => "shart",
+    }
+  end
+
+  it "should flatten array keys also " do
+    hsh = {
+      "foo" => "bar",
+      "bing" => {
+        "boo" => "wogga",
+        "tingle" => "wimp",
+        "harpoon" => ["shonk",
+                      "twaddle",
+                      "scorn",
+                      "shart" ]
+      } }
+    props = Aduki.to_aduki hsh
+    props.should == {
+      "foo"         => "bar",
+      "bing.boo"    => "wogga",
+      "bing.tingle" => "wimp",
+      "bing.harpoon[0]" => "shonk",
+      "bing.harpoon[1]" => "twaddle",
+      "bing.harpoon[2]" => "scorn",
+      "bing.harpoon[3]" => "shart",
+    }
+  end
+
+  it "should flatten nested arrays " do
+    hsh = {
+      "foo" => "bar",
+      "bing" => {
+        "boo" => "wogga",
+        "tingle" => "wimp",
+        "harpoon" => ["shonk",
+                      "twaddle",
+                      %w{alpha beta gamma},
+                      { wing: :tip, tail: :fin } ]
+      } }
+    props = Aduki.to_aduki hsh
+    props.should == {
+      "foo"         => "bar",
+      "bing.boo"    => "wogga",
+      "bing.tingle" => "wimp",
+      "bing.harpoon[0]" => "shonk",
+      "bing.harpoon[1]" => "twaddle",
+      "bing.harpoon[2][0]" => "alpha",
+      "bing.harpoon[2][1]" => "beta",
+      "bing.harpoon[2][2]" => "gamma",
+      "bing.harpoon[3].wing" => :tip,
+      "bing.harpoon[3].tail" => :fin,
+    }
+  end
+
+  it "should flatten aduki objects " do
+    hsh = {
+      "foo" => "bar",
+      "bing" => {
+        "boo" => "wogga",
+        "tingle" => "wimp",
+        "harpoon" => ["shonk",
+                      "twaddle",
+                      %w{alpha beta gamma},
+                      { wing: :tip, tail: :fin } ]
+      } }
+    props = Aduki.to_aduki hsh
+    props.should == {
+      "foo"         => "bar",
+      "bing.boo"    => "wogga",
+      "bing.tingle" => "wimp",
+      "bing.harpoon[0]" => "shonk",
+      "bing.harpoon[1]" => "twaddle",
+      "bing.harpoon[2][0]" => "alpha",
+      "bing.harpoon[2][1]" => "beta",
+      "bing.harpoon[2][2]" => "gamma",
+      "bing.harpoon[3].wing" => :tip,
+      "bing.harpoon[3].tail" => :fin,
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aduki
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec_numbering_formatter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: recursive attribute setting for ruby objects
 email:
 - conan@conandalton.net
@@ -46,6 +62,7 @@ files:
 - spec/initializer_spec.rb
 - spec/model.rb
 - spec/spec_helper.rb
+- spec/to_aduki_spec.rb
 homepage: https://github.com/conanite/aduki
 licenses:
 - MIT
@@ -75,3 +92,4 @@ test_files:
 - spec/initializer_spec.rb
 - spec/model.rb
 - spec/spec_helper.rb
+- spec/to_aduki_spec.rb