id 0.0.0 → 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle
+/log/*.log
+/tmp
+/tags
+/coverage
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    id (0.0.1)
+      active_support
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    diff-lcs (1.2.1)
+    multi_json (1.7.2)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  id!
+  rspec
+  simplecov

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2012 On The Beach Ltd
+
+MIT License
+
+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/id.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name          = 'id'
+  s.version       = '0.0.1'
+  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"
+  s.authors       = ["Russell Dunphy", "Radek Molenda"]
+  s.email         = ['russell@russelldunphy.com', 'radek.molenda@gmail.com']
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.homepage      = 'http://rubygems.org/gems/id'
+
+  s.add_dependency "active_support"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+
+end

data/lib/id.rb

@@ -1,2 +1,3 @@
-module Id
-end
+require 'active_support/inflector'
+require 'active_support/core_ext/string/inflections'
+require_relative 'id/all'

data/lib/id/all.rb

@@ -0,0 +1,3 @@
+require_relative 'missing_attribute_error'
+require_relative 'model/all'
+require_relative 'model'

data/lib/id/missing_attribute_error.rb

@@ -0,0 +1,4 @@
+module Id
+  class MissingAttributeError < StandardError
+  end
+end

data/lib/id/model.rb

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

data/lib/id/model/all.rb

@@ -0,0 +1,4 @@
+require_relative 'field'
+require_relative 'association'
+require_relative 'has_one'
+require_relative 'has_many'

data/lib/id/model/association.rb

@@ -0,0 +1,47 @@
+module Id
+  module Model
+    class Association < Field
+
+      def type
+        options.fetch(:type) { inferred_class }
+      end
+
+      def inferred_class
+        hierarchy.parent.const_get(inferred_class_name)
+      end
+
+      def inferred_class_name
+        @inferred_class_name ||= name.to_s.classify
+      end
+
+      def hierarchy
+        @hierarchy ||= Hierarchy.new(model.name, inferred_class_name)
+      end
+
+      class Hierarchy
+
+        def initialize(path, child)
+          @path = path
+          @child = child
+        end
+
+        def parent
+          @parent ||= constants.find { |c| c.const_defined? child }
+        end
+
+        def constants
+          hierarchy.map(&:constantize)
+        end
+
+        private
+
+        def hierarchy(name=path)
+          name.match /(.*)::.*$/
+          $1 ? [name] + hierarchy($1) : [name]
+        end
+
+        attr_reader :path, :child
+      end
+    end
+  end
+end

data/lib/id/model/field.rb

@@ -0,0 +1,30 @@
+module Id
+  module Model
+    class Field
+
+      def initialize(model, name, options)
+        @model = model
+        @name = name
+        @options = options
+      end
+
+      def define
+        field = self
+        model.send :define_method, name do
+          data.fetch(field.key) { field.default or raise MissingAttributeError }
+        end
+      end
+
+      def key
+        options.fetch(:key, name).to_s
+      end
+
+      def default
+        options.fetch(:default, nil)
+      end
+
+      attr_reader :model, :name, :options
+    end
+
+  end
+end

data/lib/id/model/has_many.rb

@@ -0,0 +1,16 @@
+module Id
+  module Model
+    class HasMany < Association
+
+      def define
+        field = self
+        model.send :define_method, name do
+          memoize field.name do
+            data.fetch(field.key, []).map { |r| field.type.new(r) }
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/id/model/has_one.rb

@@ -0,0 +1,16 @@
+module Id
+  module Model
+    class HasOne < Association
+
+      def define
+        field = self
+        model.send :define_method, name do
+          memoize field.name do
+            field.type.new(data.fetch(field.key) { raise MissingAttributeError })
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/id_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+class NestedModel
+  include Id::Model
+  field :yak
+end
+
+class TestModel
+  include Id::Model
+
+  field :foo
+  field :bar, key: 'baz'
+  field :quux, default: 'kwak'
+
+  has_one :aliased_model, type: NestedModel
+  has_one :nested_model, key: 'aliased_model'
+  has_one :extra_nested_model
+  has_one :test_model
+  has_many :nested_models
+
+  class ExtraNestedModel
+    include Id::Model
+    field :cats!
+  end
+end
+
+describe Id::Model do
+  let (:model) { TestModel.new(foo: 3,
+                               baz: 6,
+                               test_model: {},
+                               aliased_model: { 'yak' => 11},
+                               nested_models: [{ 'yak' => 11}, { yak: 14 }],
+                               extra_nested_model: { cats!: "MIAOW" }) }
+
+  describe ".field" do
+    it 'defines an accessor on the model' do
+      model.foo.should eq 3
+    end
+
+    it 'allows key aliases' do
+      model.bar.should eq 6
+    end
+
+    it 'allows default values' do
+      model.quux.should eq 'kwak'
+    end
+
+  end
+
+  describe ".has_one" do
+    it "allows nested models" do
+      model.aliased_model.should be_a NestedModel
+    end
+    it "allows nested models" do
+      model.nested_model.should be_a NestedModel
+      model.nested_model.yak.should eq 11
+    end
+    it "allows associations to be nested within the class" do
+      model.extra_nested_model.should be_a TestModel::ExtraNestedModel
+      model.extra_nested_model.cats!.should eq 'MIAOW'
+    end
+    it "allows recursively defined models" do
+      model.test_model.should be_a TestModel
+    end
+  end
+
+  describe ".has_many" do
+    it 'creates an array of nested models' do
+      model.nested_models.should be_a Array
+      model.nested_models.first.should be_a NestedModel
+      model.nested_models.first.yak.should eq 11
+      model.nested_models.last.yak.should eq 14
+    end
+  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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'rspec'
+require_relative '../lib/id'
+
+
+RSpec.configure do |config|
+  config.order = :rand
+  config.color_enabled = true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: id
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,8 +11,56 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-03-28 00:00:00.000000000 Z
-dependencies: []
-description: ''
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Developed at On The Beach Ltd. Contact russell.dunphy@onthebeach.co.uk
 email:
 - russell@russelldunphy.com
 - radek.molenda@gmail.com
@@ -20,7 +68,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- id.gemspec
 - lib/id.rb
+- lib/id/all.rb
+- lib/id/missing_attribute_error.rb
+- lib/id/model.rb
+- lib/id/model/all.rb
+- lib/id/model/association.rb
+- lib/id/model/field.rb
+- lib/id/model/has_many.rb
+- lib/id/model/has_one.rb
+- spec/lib/id_spec.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/id
 licenses: []
 post_install_message: 
@@ -45,4 +108,6 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Simple models based on hashes
-test_files: []
+test_files:
+- spec/lib/id_spec.rb
+- spec/spec_helper.rb