vorpal 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTFlNjY4ZjU3YWRhNmY2ZDFmZmFiMTBiMTk3ZWY5ZjVhYjc1NTAzYw==
+    YWYyMjQxMmIzZmI2MDc1Zjg0MWNkNGNmZDBjZmE1YWFmMjRkYmYzZQ==
   data.tar.gz: !binary |-
-    N2FkZmQzZDBiMjg1MWU5MzJjYzcwMzUxNGNjMzk1NGE0NjkyMjNkYw==
+    ZjhmMTY1ZmY3Y2QwZmE3ZGM4ZjNlOGM0MTFjM2EyZjRiZTI0ZWY0Ng==
 SHA512:
   metadata.gz: !binary |-
-    NTA5MTJmMWMzM2I5YzE5MmNkYjYzNDhlMzA0NjczZThkMzE1M2M2NDBiYzFj
-    ZGE3OTU0Zjc0NGNlNzA4Y2RiNTM4OTgyZjk1ZmY2MjgzNjY4NTNmM2NkMDI4
-    MjFlMGYwNzQzZWNiN2FiYTA1MzE3YTk1YmNmZTRmOTNlYzM2MWI=
+    MzI5ZjJkNTkwMGViNDViNWFjNTYzMzYwNTY3ZjRlYzkxZTY2ZjZiZDVjNGVh
+    ODY0MjcxNzA3OTY5MWY1ZjM3MmRjMDRmZmU2OGQ3NTQ5MjkxM2RjYjliZTdl
+    ZGE4NjdhYzM1YjM5YTUzMmJjNWM3Yjk1YThhNTNmNjA4OWIwMjM=
   data.tar.gz: !binary |-
-    YTJhOTJhMjFkZmYwMDJlYmQwZDVmZWY0MzkwMzgyNzRhZDA0NWYyZGFlM2Iy
-    NDZmYzc5MzUyNGM4MzFiOTIwYWIxMDRiNWUzMzJlYTcwY2YwMWEzNjRmOGM3
-    MGM4Nzg1MzRjMzUxNzgzZmFjOTg2YjU3ZDQ2ZmM0NTlkZDNkMWE=
+    NDc0MTcxNzdiZmJlMGIwYmZmZWVlOTEyZDU1YjIxMmViNTQ0NTk1ZjM2Zjhl
+    MzZjZWU4ZWVmNDM0NjE0ZTlmNzNhOTA3NjM5YzUyYjBjZjE0MjZmYjYxMzdl
+    Y2E1M2U4ODQ1NDM4MDMxZmNkZjNlN2MxNjgwY2Q5ZDQ0MzNmMzg=

data/README.md

@@ -230,7 +230,7 @@ For example:
 
 **Q.** How do I get serialization?
 
-**A.** You can use [ActiveModel::Serialization](http://api.rubyonrails.org/classes/ActiveModel/Serialization.html) or [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) but they are not heartily recommended. The former is too coupled to the model and the latter is too coupled to Rails controllers. Vorpal includes the [SimpleSerializer](http://rubydoc.info/github/nulogy/vorpal/master/SimpleSerializer) and [SimpleDeserializer](http://rubydoc.info/github/nulogy/vorpal/master/SimpleDeserializer) for this purpose.
+**A.** You can use [ActiveModel::Serialization](http://api.rubyonrails.org/classes/ActiveModel/Serialization.html) or [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers) but they are not heartily recommended. The former is too coupled to the model and the latter is too coupled to Rails controllers. Vorpal uses [SimpleSerializer](https://github.com/nulogy/simple_serializer) for this purpose.
 
 ## Running Tests
 

data/lib/vorpal/aggregate_repository.rb

@@ -1,4 +1,5 @@
 require 'vorpal/identity_map'
+require 'vorpal/traversal'
 
 module Vorpal
 class AggregateRepository
@@ -52,8 +53,7 @@ class AggregateRepository
   #   operation.
   # @return [Object] Entity with the given primary key value and type.
   def load(id, domain_class, identity_map=IdentityMap.new)
-    db_object = @configs.config_for(domain_class).load_by_id(id)
-    hydrate(db_object, identity_map)
+    load_all([id], domain_class, identity_map).first
   end
 
   # Like {#load} but operates on multiple ids.
@@ -66,7 +66,10 @@ class AggregateRepository
   #   operation.
   # @return [[Object]] Entities with the given primary key values and type.
   def load_all(ids, domain_class, identity_map=IdentityMap.new)
-    ids.map { |id| load(id, domain_class, identity_map) }
+    ids.map do |id|
+      db_object = @configs.config_for(domain_class).load_by_id(id)
+      hydrate(db_object, identity_map)
+    end
   end
 
   # Removes an aggregate from the DB. Even if the aggregate contains unsaved
@@ -146,104 +149,6 @@ class AggregateRepository
   end
 end
 
-# @private
-class Traversal
-  def initialize(configs)
-    @configs = configs
-  end
-
-  def accept_for_domain(object, visitor, already_visited=[])
-    return if object.nil?
-
-    config = @configs.config_for(object.class)
-    return if config.nil?
-
-    return if already_visited.include?(object)
-    already_visited << object
-
-    visitor.visit_object(object, config)
-
-    config.belongs_tos.each do |belongs_to_config|
-      child = belongs_to_config.get_child(object)
-      accept_for_domain(child, visitor, already_visited) if visitor.continue_traversal?(belongs_to_config)
-
-      visitor.visit_belongs_to(object, child, belongs_to_config)
-    end
-
-    config.has_ones.each do |has_one_config|
-      child = has_one_config.get_child(object)
-      accept_for_domain(child, visitor, already_visited) if visitor.continue_traversal?(has_one_config)
-
-      visitor.visit_has_one(object, child, has_one_config)
-    end
-
-    config.has_manys.each do |has_many_config|
-      children = has_many_config.get_children(object)
-      children.each do |child|
-        accept_for_domain(child, visitor, already_visited) if visitor.continue_traversal?(has_many_config)
-      end
-      visitor.visit_has_many(object, children, has_many_config)
-    end
-  end
-
-  def accept_for_db(db_object, visitor, already_visited=[])
-    return if db_object.nil?
-
-    config = @configs.config_for_db(db_object.class)
-    return if config.nil?
-
-    return if already_visited.include?(db_object)
-    already_visited << db_object
-
-    visitor.visit_object(db_object, config)
-
-    config.belongs_tos.each do |belongs_to_config|
-      child = belongs_to_config.load_child(db_object)
-      accept_for_db(child, visitor, already_visited) if visitor.continue_traversal?(belongs_to_config)
-
-      visitor.visit_belongs_to(db_object, child, belongs_to_config)
-    end
-
-    config.has_ones.each do |has_one_config|
-      child = has_one_config.load_child(db_object)
-      accept_for_db(child, visitor, already_visited) if visitor.continue_traversal?(has_one_config)
-
-      visitor.visit_belongs_to(db_object, child, has_one_config)
-    end
-
-    config.has_manys.each do |has_many_config|
-      children = has_many_config.load_children(db_object)
-      children.each do |child|
-        accept_for_db(child, visitor, already_visited) if visitor.continue_traversal?(has_many_config)
-      end
-      visitor.visit_has_many(db_object, children, has_many_config)
-    end
-  end
-end
-
-# @private
-module AggregateVisitorTemplate
-  def visit_object(object, config)
-    # override me!
-  end
-
-  def visit_belongs_to(parent, child, belongs_to_config)
-    # override me!
-  end
-
-  def visit_has_one(parent, child, has_one_config)
-    # override me!
-  end
-
-  def visit_has_many(parent, children, has_many_config)
-    # override me!
-  end
-
-  def continue_traversal?(association_config)
-    true
-  end
-end
-
 # @private
 class SerializeVisitor
   include AggregateVisitorTemplate

data/lib/vorpal/config_builder.rb

@@ -1,5 +1,5 @@
-require 'simple_serializer/simple_serializer'
-require 'simple_serializer/simple_deserializer'
+require 'simple_serializer/serializer'
+require 'simple_serializer/deserializer'
 require 'vorpal/configs'
 
 module Vorpal
@@ -134,13 +134,13 @@ class ConfigBuilder
   end
 
   def serializer(attrs)
-    Class.new(SimpleSerializer) do
+    Class.new(SimpleSerializer::Serializer) do
       attributes *attrs
     end
   end
 
   def deserializer(attrs)
-    Class.new(SimpleDeserializer) do
+    Class.new(SimpleSerializer::Deserializer) do
       data_attributes *attrs
     end
   end

data/lib/vorpal/configs.rb

@@ -58,7 +58,7 @@ class ClassConfig
   end
 
   def find_in_db(object)
-    db_class.find(object.id)
+    load_by_id(object.id)
   end
 
   def load_by_id(id)

data/lib/vorpal/identity_map.rb

@@ -5,22 +5,30 @@ class IdentityMap
   end
 
   def get(key_object)
-    @entities[key_object]
+    @entities[key(key_object)]
   end
 
   def set(key_object, object)
-    @entities[key_object] = object
+    @entities[key(key_object)] = object
   end
 
   def get_and_set(key_object)
     object = get(key_object)
-    object = yield(key_object) if object.nil?
+    object = yield if object.nil?
     set(key_object, object)
     object
   end
 
   def map(key_objects)
-    key_objects.map { |k| @entities[k] }
+    key_objects.map { |k| @entities[key(k)] }
+  end
+
+  private
+
+  def key(key_object)
+    return nil unless key_object
+    raise "Cannot put entity '#{key_object.inspect}' into IdentityMap without an id." if key_object.id.nil?
+    [key_object.id, key_object.class.name]
   end
 end
 end

data/lib/vorpal/traversal.rb

@@ -0,0 +1,98 @@
+
+# @private
+class Traversal
+  def initialize(configs)
+    @configs = configs
+  end
+
+  def accept_for_domain(object, visitor, already_visited=[])
+    return if object.nil?
+
+    config = @configs.config_for(object.class)
+    return if config.nil?
+
+    return if already_visited.include?(object)
+    already_visited << object
+
+    visitor.visit_object(object, config)
+
+    config.belongs_tos.each do |belongs_to_config|
+      child = belongs_to_config.get_child(object)
+      accept_for_domain(child, visitor, already_visited) if visitor.continue_traversal?(belongs_to_config)
+
+      visitor.visit_belongs_to(object, child, belongs_to_config)
+    end
+
+    config.has_ones.each do |has_one_config|
+      child = has_one_config.get_child(object)
+      accept_for_domain(child, visitor, already_visited) if visitor.continue_traversal?(has_one_config)
+
+      visitor.visit_has_one(object, child, has_one_config)
+    end
+
+    config.has_manys.each do |has_many_config|
+      children = has_many_config.get_children(object)
+      children.each do |child|
+        accept_for_domain(child, visitor, already_visited) if visitor.continue_traversal?(has_many_config)
+      end
+      visitor.visit_has_many(object, children, has_many_config)
+    end
+  end
+
+  def accept_for_db(db_object, visitor, already_visited=[])
+    return if db_object.nil?
+
+    config = @configs.config_for_db(db_object.class)
+    return if config.nil?
+
+    return if already_visited.include?(db_object)
+    already_visited << db_object
+
+    visitor.visit_object(db_object, config)
+
+    config.belongs_tos.each do |belongs_to_config|
+      child = belongs_to_config.load_child(db_object)
+      accept_for_db(child, visitor, already_visited) if visitor.continue_traversal?(belongs_to_config)
+
+      visitor.visit_belongs_to(db_object, child, belongs_to_config)
+    end
+
+    config.has_ones.each do |has_one_config|
+      child = has_one_config.load_child(db_object)
+      accept_for_db(child, visitor, already_visited) if visitor.continue_traversal?(has_one_config)
+
+      visitor.visit_belongs_to(db_object, child, has_one_config)
+    end
+
+    config.has_manys.each do |has_many_config|
+      children = has_many_config.load_children(db_object)
+      children.each do |child|
+        accept_for_db(child, visitor, already_visited) if visitor.continue_traversal?(has_many_config)
+      end
+      visitor.visit_has_many(db_object, children, has_many_config)
+    end
+  end
+end
+
+# @private
+module AggregateVisitorTemplate
+  def visit_object(object, config)
+    # override me!
+  end
+
+  def visit_belongs_to(parent, child, belongs_to_config)
+    # override me!
+  end
+
+  def visit_has_one(parent, child, has_one_config)
+    # override me!
+  end
+
+  def visit_has_many(parent, children, has_many_config)
+    # override me!
+  end
+
+  def continue_traversal?(association_config)
+    true
+  end
+end

data/lib/vorpal/version.rb

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

data/spec/vorpal/class_config_builder_spec.rb

@@ -1,4 +1,4 @@
-require 'integration_spec_helper'
+require 'unit_spec_helper'
 
 require 'vorpal/config_builder'
 
@@ -6,8 +6,8 @@ describe Vorpal::ConfigBuilder do
   class Tester; end
 
   it 'includes the primary key in the list of fields' do
-    builder = Vorpal::ConfigBuilder.new(Tester, {})
-    config = builder.build
+    # builder = Vorpal::ConfigBuilder.new(Tester, {})
+    # config = builder.build
     # config.field
   end
 end

data/spec/vorpal/identity_map_spec.rb

@@ -0,0 +1,51 @@
+require 'unit_spec_helper'
+
+require 'vorpal/identity_map'
+
+describe Vorpal::IdentityMap do
+  let(:map) { Vorpal::IdentityMap.new }
+
+  it 'does not rely on the key objects implementation of hash and eql?' do
+    funny1 = build_funny_entity(1)
+    map.set(funny1, 'funny 1')
+
+    funny2 = build_funny_entity(2)
+    map.set(funny2, 'funny 2')
+
+    expect(map.get(funny1)).to eq('funny 1')
+  end
+
+  it 'raises an exception when the key object does not have an id set' do
+    entity = build_entity(nil)
+
+    expect { map.set(entity, 'something') }.to raise_error(/Cannot put entity/)
+  end
+
+  def build_entity(id)
+    entity = Entity.new
+    entity.id = id
+    entity
+  end
+
+  class Entity
+    attr_accessor :id
+  end
+
+  def build_funny_entity(id)
+    funny1 = Funny.new
+    funny1.id = id
+    funny1
+  end
+
+  class Funny
+    attr_accessor :id
+
+    def hash
+      1
+    end
+
+    def eql?(other)
+      true
+    end
+  end
+end

data/vorpal.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "simple_serializer", "~> 0.0.1"
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vorpal
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Sean Kirby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,8 +108,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/simple_serializer/simple_deserializer.rb
-- lib/simple_serializer/simple_serializer.rb
 - lib/vorpal.rb
 - lib/vorpal/aggregate_repository.rb
 - lib/vorpal/config_builder.rb
@@ -103,10 +115,13 @@ files:
 - lib/vorpal/configuration.rb
 - lib/vorpal/hash_initialization.rb
 - lib/vorpal/identity_map.rb
+- lib/vorpal/traversal.rb
 - lib/vorpal/version.rb
 - spec/integration_spec_helper.rb
+- spec/unit_spec_helper.rb
 - spec/vorpal/aggregate_repository_spec.rb
 - spec/vorpal/class_config_builder_spec.rb
+- spec/vorpal/identity_map_spec.rb
 - vorpal.gemspec
 homepage: https://github.com/nulogy/vorpal
 licenses:
@@ -134,5 +149,7 @@ specification_version: 4
 summary: Separate your domain model from your persistence mechanism.
 test_files:
 - spec/integration_spec_helper.rb
+- spec/unit_spec_helper.rb
 - spec/vorpal/aggregate_repository_spec.rb
 - spec/vorpal/class_config_builder_spec.rb
+- spec/vorpal/identity_map_spec.rb

data/lib/simple_serializer/simple_deserializer.rb

@@ -1,67 +0,0 @@
-# Simple framelet for deserialization
-#
-#    class SomeDeserializer < SimpleDeserializer
-#      data_attributes :site_id, :name, :category_id, :integration_key
-#
-#      def integration_key(old_integration_key)
-#        "XX#{@data[:other_attr]}XX#{old_integration_key}XX"
-#      end
-#
-#      def set_category_id(category_id)
-#        object.category = InventoryStatusCategory.from_id(category_id)
-#      end
-#    end
-#
-# Usage:
-#
-#    SomeDeserializer.deserialize(object, data)
-#    SomeDeserializer.new(object, data).deserialize
-#
-#    SomeDeserializer.deserialize_array([object1, object2, ...], [data1, data2, ...])
-#
-class SimpleDeserializer
-  class << self
-    attr_accessor :_attributes
-
-    def inherited(base)
-      base._attributes = []
-    end
-
-    def data_attributes(*attrs)
-      @_attributes.concat attrs
-
-      attrs.each do |attr|
-        define_method attr do |datum|
-          datum
-        end unless method_defined?(attr)
-
-        define_method "set_#{attr}" do |datum|
-          object.send("#{attr}=", send(attr, datum))
-        end unless method_defined?("set_#{attr}")
-      end
-    end
-
-    def deserialize_array(objects, data)
-      objects.zip(data).map { |obj, datum| deserialize(obj, datum) }
-    end
-
-    def deserialize(object, data)
-      self.new(object, data).deserialize
-    end
-  end
-
-  attr_accessor :object
-
-  def initialize(object, data)
-    @object = object
-    @data = data
-  end
-
-  def deserialize
-    self.class._attributes.dup.each do |name|
-      next unless @data.has_key?(name)
-      send("set_#{name}", @data[name])
-    end
-    object
-  end
-end

data/lib/simple_serializer/simple_serializer.rb

@@ -1,72 +0,0 @@
-# Simple framelet for serialization.
-#
-# API compatible with ActiveModel::Serializer but without all the complexity
-# and dependence on ActiveModel
-#
-#    class SomeSerializer < SimpleSerializer
-#      attributes :id, :name, :category_id, :errors
-#
-#      def category_id
-#        object.category.try(:id)
-#      end
-#
-#      def errors
-#        ActiveModelErrorsSerializer.serialize_errors(object.errors, true) if object.errors.any?
-#      end
-#    end
-#
-# Usage:
-#
-#    SomeSerializer.serialize(object)
-#    SomeSerializer.new(object).serialize
-#
-#    SomeSerializer.serialize_array([object])
-#
-class SimpleSerializer
-  class << self
-    attr_accessor :_attributes
-
-    def inherited(base)
-      base._attributes = []
-    end
-
-    def attributes(*attrs)
-      @_attributes.concat attrs
-
-      attrs.each do |attr|
-        define_method attr do
-          object.send(attr)
-        end unless method_defined?(attr)
-      end
-    end
-
-    def serialize_array(objects)
-      objects.map { |obj| serialize(obj) }
-    end
-
-    def serialize(object)
-      self.new(object).serialize
-    end
-
-    alias :as_json :serialize
-  end
-
-  attr_accessor :object
-
-  def initialize(object, _={})
-    @object = object
-  end
-
-  def attributes
-    self.class._attributes.dup.each_with_object({}) do |name, hash|
-      hash[name] = send(name)
-    end
-  end
-
-  def serialize(_={})
-    return nil if object.nil?
-    attributes
-  end
-  alias :as_json :serialize
-end
-