aduki 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 269ae6607c034416e171d45d6452c4fba0e5bf84
-  data.tar.gz: bcd5234c6bf73552897059acb43633df077ce4bb
+  metadata.gz: 79dc256c2fd9daa39c568a3a85d1f30a3104a70b
+  data.tar.gz: 46d3a666d1711db748a7d8657c7eca5000dd1739
 SHA512:
-  metadata.gz: 30966ec2c14406a5a3d91e7c3943119997c0285f90bf7f4de39166d65801374de6674a6c8278bf39b7710f35d52e720d7257817b8fbc7b542c9bc7c87248d9c0
-  data.tar.gz: cbd2ae5d83392f9b1c6ed3e8158d10b46aff04685ad67ae06cacb137c3e44155e473177d05c00b36de9d7be08a0deac1e3eb7cab045bf647d1220b456f52f887
+  metadata.gz: 0cf02afb1c9e116f720ade13f302d67fe54d7f1c29195a03211be5d5f7bdddcd804633889cb32da08dc446fced8f4d529aac230138f64308ef41897534daeb62
+  data.tar.gz: b97ea592dd63f5bb6cd986ccae8ed1f13dfbb03e7885894829df5668aaf078a973d9e3f006af7c1e3eb3dea08ebc932e475306fbeb4ee6464ca68fd2271c9dc7

data/README.md

@@ -34,49 +34,159 @@ Or install it yourself as:
 
 ## Usage
 
-For a complete example, please see the spec. It's a single file.
+For a complete example, please see the specs.
 
-Here's an abbreviated version:
+#### Initializing attributes
 
     class Assembly
       include Aduki::Initializer
       attr_accessor :name, :colour, :size
     end
 
+    a = Assembly.new name: "Cooker", colour: "blue", size: "4"
+
+    a.name   # => "Cooker"
+    a.colour # => "blue"
+    a.size   # => "4"
+
+So far, so unsurprising. Let's tell aduki that `size` is an integer
+
     class Machine
+
+    class Assembly
       include Aduki::Initializer
-      attr_accessor :name, :weight, :speed, :builder, :team
-      attr_accessor :assemblies, :dimensions
-      aduki :assemblies => Assembly, :builder => MachineBuilder
-      aduki :helpers => { :key => MachineBuilder }
+      attr_accessor :name, :colour
+      aduki size: Integer
     end
 
-    class Model
+    a = Assembly.new name: "Cooker", colour: "blue", size: "4"
+
+    a.name   # => "Cooker"
+    a.colour # => "blue"
+    a.size   # => 4
+
+Yay!
+
+#### Nested object types
+
+Suppose you have a Machine that uses an Assembly instance
+
+    class Machine
       include Aduki::Initializer
+      attr_accessor :name, :speed
+      aduki :assembly => Assembly
+    end
 
-      attr_accessor :name, :email, :item, :thing, :gadget
-      attr_accessor :machines, :contraptions, :countries
-      aduki :gadget => Gadget, :machines => Machine, :contraptions => Contraption
+    class Assembly
+      include Aduki::Initializer
+      attr_accessor :name, :colour
+      aduki size: Integer
     end
 
+    props = {
+      "name"            => "Guillotine",
+      "speed"           => "fast",
+      "assembly.name"   => "blade",
+      "assembly.colour" => "steely-blue",
+      "assembly.size"   => "12",
+    }
+
+    m = Machine.new props
+
+    m.name            # => "Guillotine"
+    m.assembly.name   # => "blade"
+    m.assembly.colour # => "steely-blue"
+    m.assembly.size   # => 12
+
+However, in this configuration, if you don't specify attributes for the Assembly, it will be nil:
+
+    props = {
+      "name"            => "Guillotine",
+      "speed"           => "fast",
+    }
 
-Aduki::Initializer adds an #initialize instance method that knows how to read a hash of properties and apply them, much like ActiveRecord::Base,
-with one major difference: Aduki splits property names on "." and applies the hash recursively. Aduki also pays special attention to "[]" in property
-names, initializing an array of items instead of an item directly. Aduki uses the array index inside "[]" to distinguish elements, but not to order them.
+    m = Machine.new props
 
-The #aduki class method allows you identify which types to initialise for each field. When a type is not specified for a field, aduki sets the given value directly.
+    m.name            # => "Guillotine"
+    m.assembly        # => nil
 
-    aduki :gadget => Gadget, :machines => Machine, :contraptions => Contraption
+You can specify an initializer for `assembly` thus:
 
-This line instructs aduki to initialise the #gadget field with a Gadget object. It also instructs aduki to initialize each element of the #machines
-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.
+    class Machine
+      include Aduki::Initializer
+      attr_accessor :name, :speed
+      aduki_initialize :assembly, Assembly
+    end
+
+    props = {
+      "name"            => "Guillotine",
+      "speed"           => "fast",
+    }
 
+    m = Machine.new props
 
-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:
+    m.name            # => "Guillotine"
+    m.assembly.name   # => nil
+
+
+#### Nested array types
+
+What if your Machine needs an array of Assembly instances?
+
+    class Machine
+      include Aduki::Initializer
+      attr_accessor :name, :speed
+      aduki :assemblies => Assembly
+    end
+
+    props = {
+      "name"                 => "Truck",
+      "assemblies[0].name"   => "cabin",
+      "assemblies[0].colour" => "orange",
+      "assemblies[0].size"   => "12",
+      "assemblies[1].name"   => "trailer",
+      "assemblies[1].colour" => "green",
+      "assemblies[1].size"   => "48",
+    }
+
+    m = Machine.new props
+
+    m.name                 # => "Truck"
+    m.assemblies[0].name   # => "cabin"
+    m.assemblies[0].colour # => "orange"
+    m.assemblies[0].size   # => 12
+    m.assemblies[1].name   # => "trailer"
+    m.assemblies[1].colour # => "green"
+    m.assemblies[1].size   # => 48
+
+However, like before, if there are no `assemblies` declarations in the initializer parameter, the `assemblies` attribute will be nil:
+
+    props = {
+      "name"                 => "Truck",
+    }
+
+    m = Machine.new props
+
+    m.name         # => "Truck"
+    m.assemblies   # => nil
+
+
+If you want to be sure to always have an array, even empty, do this:
+
+    class Machine
+      include Aduki::Initializer
+      attr_accessor :name, :speed
+      aduki_initialize :assemblies, Array, Assembly
+    end
+
+    props = {
+      "name"                 => "Truck",
+    }
 
-      aduki :helpers => { :key => MachineBuilder }
+    m = Machine.new props
 
+    m.name         # => "Truck"
+    m.assemblies   # => []
 
 
 ## Contributing

data/lib/aduki.rb

@@ -107,7 +107,11 @@ module Aduki
     if value.is_a?(Hash)
       existing_value = object.send setter if object.respond_to?(setter)
       if existing_value
-        Aduki.apply_attributes existing_value, value
+        if existing_value.is_a? Hash
+          existing_value.merge! value
+        else
+          Aduki.apply_attributes existing_value, value
+        end
         return
       end
     end

data/lib/aduki/version.rb

@@ -1,3 +1,3 @@
 module Aduki
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/initializer_spec.rb

@@ -251,4 +251,18 @@ describe Aduki::Initializer do
 
     expect(model.gadget.speaker.threads).to eq [ 12.4, 8.16, 21.42 ]
   end
+
+  it "should handle pre-initialized hashes with a previously-set array type" do
+    props = {
+      "name"                => "Brackish Water",
+      "gadget.name"         => "The Loud Gadget",
+      "gadget.variables.x" => "29",
+      "gadget.variables.y" => "12.4",
+      "gadget.variables.z" => "8.16",
+    }
+
+    model = Model.new props
+
+    expect(model.gadget.variables).to eq({ "x"=> "29", "y" => "12.4", "z" => "8.16"})
+  end
 end

data/spec/spec_helper.rb

@@ -49,9 +49,10 @@ end
 
 class Gadget
   include Aduki::Initializer
-  attr_accessor :name, :price, :supplier
+  attr_accessor :name, :price, :supplier, :variables
   attr_writer :wattage
   aduki_initialize :speaker, Speaker
+  aduki_initialize :variables, Hash, nil
 
   def watts
     @wattage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aduki
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Conan Dalton