id 0.0.1 → 0.0.2

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -5,7 +5,7 @@ PATH
       active_support
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     active_support (3.0.0)
       activesupport (= 3.0.0)

data/README.md

@@ -0,0 +1,6 @@
+# id
+### simple models based on hashes
+
+JSON is a great way to transfer data between systems, and it's easy to parse into a Ruby hash. But sometimes it's nice to have actual methods to call when you want to get attributes from your data, rather than coupling your entire codebase to the hash representation by littering it with calls to `fetch` or `[]`. The same goes for BSON documents stored in Mongo.
+
+That's where `id` (as in Freud) comes in. You define your model classes using syntax that should look pretty familiar if you've used any popular Ruby ORMs - but `id` is not an ORM. Model objects defined with `id` have a constructor that accepts a hash, and you define the values of this hash that are made readable as fields - but that hash can come from any source.

data/id.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'id'
-  s.version       = '0.0.1'
+  s.version       = '0.0.2'
   s.date          = '2013-03-28'
   s.summary       = "Simple models based on hashes"
   s.description   = "Developed at On The Beach Ltd. Contact russell.dunphy@onthebeach.co.uk"

data/lib/id/model/all.rb

@@ -2,3 +2,4 @@ require_relative 'field'
 require_relative 'association'
 require_relative 'has_one'
 require_relative 'has_many'
+require_relative 'builder'

data/lib/id/model/builder.rb

@@ -0,0 +1,45 @@
+module Id
+  module Model
+    module Builder
+
+      def initialize(model, data={})
+        @model = model
+        @data = data
+      end
+
+      def build
+        model.new data
+      end
+
+      private
+
+      def set(f, value)
+        self.class.new(model, data.merge(f.to_s => ensure_hash(value)))
+      end
+
+      def ensure_hash(value)
+        case value
+        when Id::Model then value.data
+        when Array then value.map { |v| ensure_hash(v) }
+        else value end
+      end
+
+      attr_reader :model, :data
+
+      def self.included(base)
+        base.extend(FieldBuilder)
+      end
+
+      module FieldBuilder
+
+        def field(f)
+          define_method f do |value|
+            set(f, value)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/id/model.rb

@@ -1,18 +1,17 @@
 module Id
   module Model
-
     attr_reader :data
 
     def initialize(data)
       @data = Hash[data.map { |k, v| [k.to_s, v] }]
     end
 
+    private
+
     def self.included(base)
       base.extend(Descriptor)
     end
 
-    private
-
     def memoize(f, &b)
       instance_variable_get("@#{f}") || instance_variable_set("@#{f}", b.call)
     end
@@ -20,14 +19,27 @@ module Id
     module Descriptor
       def field(f, options={})
         Field.new(self, f, options).define
+        builder_class.field f
       end
 
       def has_one(f, options={})
         HasOne.new(self, f, options).define
+        builder_class.field f
       end
 
       def has_many(f, options={})
         HasMany.new(self, f, options).define
+        builder_class.field f
+      end
+
+      def builder
+        builder_class.new(self)
+      end
+
+      private
+
+      def builder_class
+        @builder_class ||= Class.new { include Builder }
       end
     end
 

data/spec/lib/id/model/association_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Id::Model::Association do
+
+  module Foo
+    module Bar
+      module Baz
+        class Quux
+        end
+      end
+    end
+  end
+
+  let (:model) { stub(name: "Foo::Bar::Baz::Quux") }
+  let (:has_one) { Id::Model::Association.new(model, "yak", {}) }
+
+  describe "hierarchy" do
+    it "builds the class and module hierarchy for the model" do
+      has_one.hierarchy.constants.should eq [
+        Foo::Bar::Baz::Quux,
+        Foo::Bar::Baz,
+        Foo::Bar,
+        Foo
+      ]
+    end
+  end
+end

data/spec/lib/id/model/builder_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+class BuilderModel
+  include Id::Model
+
+  field :foo
+  field :bar
+  has_one :nested_builder_model
+  has_many :nested_builder_models
+
+  class NestedBuilderModel
+    include Id::Model
+
+    field :baz
+  end
+
+end
+
+module Id
+  describe Model::Builder do
+
+    it 'models can be built using a builder' do
+      BuilderModel.builder.build.should be_a BuilderModel
+    end
+
+    it 'defines chainable setter methods for each field' do
+      model = BuilderModel.builder.foo(4).bar("hello cat").build
+      model.foo.should eq 4
+      model.bar.should eq "hello cat"
+    end
+
+    it 'allows setting of has_one associations using their respective builders' do
+      nested_model = BuilderModel::NestedBuilderModel.builder.baz(:quux).build
+      model = BuilderModel.builder.nested_builder_model(nested_model).build
+      model.nested_builder_model.baz.should eq :quux
+    end
+
+    it 'allows setting of has_many associations using their respective builders' do
+      nested_model = BuilderModel::NestedBuilderModel.builder.baz(:quux).build
+      model = BuilderModel.builder.nested_builder_models([nested_model]).build
+      model.nested_builder_models.first.baz.should eq :quux
+    end
+
+  end
+end

data/spec/lib/id_spec.rb

@@ -74,28 +74,3 @@ describe Id::Model do
   end
 end
 
-describe Id::Model::HasOne do
-
-  module Foo
-    module Bar
-      module Baz
-        class Quux
-        end
-      end
-    end
-  end
-
-  let (:model) { stub(name: "Foo::Bar::Baz::Quux") }
-  let (:has_one) { Id::Model::HasOne.new(model, "yak", {}) }
-
-  describe "hierarchy" do
-    it "builds the class and module hierarchy for the model" do
-      has_one.hierarchy.constants.should eq [
-        Foo::Bar::Baz::Quux,
-        Foo::Bar::Baz,
-        Foo::Bar,
-        Foo
-      ]
-    end
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: id
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -72,6 +72,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
+- README.md
 - id.gemspec
 - lib/id.rb
 - lib/id/all.rb
@@ -79,9 +80,13 @@ files:
 - lib/id/model.rb
 - lib/id/model/all.rb
 - lib/id/model/association.rb
+- lib/id/model/builder.rb
 - lib/id/model/field.rb
 - lib/id/model/has_many.rb
 - lib/id/model/has_one.rb
+- spec/lib/id/model/association_spec.rb
+- spec/lib/id/model/builder_spec.rb
+- spec/lib/id/model_spec.rb
 - spec/lib/id_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/id
@@ -109,5 +114,9 @@ signing_key:
 specification_version: 3
 summary: Simple models based on hashes
 test_files:
+- spec/lib/id/model/association_spec.rb
+- spec/lib/id/model/builder_spec.rb
+- spec/lib/id/model_spec.rb
 - spec/lib/id_spec.rb
 - spec/spec_helper.rb
+has_rdoc: