store 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df33306fe8b122660bed78924798dd868aaec454
-  data.tar.gz: 14080358cdeb12d1144c083814c4c43f508edfa5
+  metadata.gz: 6f95b1ab0e7baa12a07c3b53d297f42da47440ac
+  data.tar.gz: 0dcaa59a8fe5af7d4678bb9ab714c335cd95894d
 SHA512:
-  metadata.gz: d9f5547caeec781e7091141718d101b7d132c4d7bd684c7c5d6025b430c8154d181fb8ee3b56a696239ba4d68be4bb177634d4152029e8cc0594a4a114d68693
-  data.tar.gz: f009c4f56c166c52b66295a84f217dadb5f2636f4f18fe2e312cc0a4b04877bdfb06360dad5e69421f57e0571523f1a487b9017a9d186ecb446876ac9d7ca68d
+  metadata.gz: a224bbb8c5330b40ae561c85e65c3fc05669afd2eb2b026acc40eddc2b099ca0719fde7e9acad7227afbc309ae3840beb4d559d82ffc0fc881c3145776e4334d
+  data.tar.gz: 4c9595417be360e5b12d35bb6bbcc4f8c36037071027d32af0bdefd513775a4d932198aceeda1f55fdbd2914dce12dea8d92ba8191813eb2f8b32cd8666228c1

data/.gitignore

@@ -1,3 +1,4 @@
 doc
 pkg
 coverage
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode

data/README.md

@@ -1,7 +1,12 @@
-# Store [![Gem Version](https://badge.fury.io/rb/store.png)](http://badge.fury.io/rb/store)
+# Store
+
+[![Gem Version](https://badge.fury.io/rb/store.png)](http://badge.fury.io/rb/store) [![Build Status](https://api.travis-ci.org/holderbaum/store.png)](https://travis-ci.org/holderbaum/store)
 
 Implementations for using the Repository- and Data Mapper Pattern in ruby
 
+**Important:** We are still ignoring dirty tracking, so this is not for
+heavy-load environments! [Issue](https://github.com/holderbaum/store/issues/1)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/example.rb

@@ -18,7 +18,15 @@ class Catalog
 end
 
 class Product
-  attr_accessor :name, :price
+  attr_accessor :name, :price, :discount
+
+  def discounted_price
+    price * (1 - discount)
+  end
+
+  def discount
+    @discount || 0
+  end
 end
 
 # EntityMappers ################################################################
@@ -59,15 +67,17 @@ class ProductEntityMapper < Store::EntityMapper
   def map(product)
     {
       'name' => product.name,
-      'price' => product.price
+      'price' => product.price,
+      'discount' => product.discount
     }
   end
 
   def unmap(cls, mapped)
-    user = cls.new
-    user.name = mapped['name']
-    user.price = mapped['price']
-    user
+    product = cls.new
+    product.name = mapped['name']
+    product.price = mapped['price']
+    product.discount = mapped['discount']
+    product
   end
 end
 
@@ -95,12 +105,12 @@ class MemoryDataMapper < Store::DataMapper
     id
   end
 
-  def single_find(reference)
-    dup(@items[reference])
+  def single_find(id)
+    dup(@items[id])
   end
 
-  def bulk_find(references)
-    @items.values_at(*references).map do |data|
+  def bulk_find(ids)
+    @items.values_at(*ids).map do |data|
       dup data
     end
   end
@@ -171,6 +181,12 @@ class Repo < Store::Repo
   end
 end
 
+class DiscountedProductFactory < Struct.new(:repo)
+  def build(name, price = 100)
+    repo.build 'Product', :name => name, :price => price, :discount => 0.25
+  end
+end
+
 repo = Repo.new(entities, data_mappers, entity_mappers)
 
 # Usage ########################################################################
@@ -179,8 +195,11 @@ editor = repo.build 'User', :name => 'Mr. Repo'
 
 catalog = repo.build 'Catalog', :name => 'Catalog 1', :editor => editor
 
+factory = DiscountedProductFactory.new(repo)
+
 catalog.add_product repo.build('Product', :name => 'Pickaxe', :price => 100)
 catalog.add_product repo.build('Product', :name => 'Scredriver', :price => 400)
+catalog.add_product factory.build('Pair of shoes')
 
 p 'save call'
 repo.save(catalog)

data/lib/store.rb

@@ -2,14 +2,15 @@ require 'store/repo'
 require 'store/ref'
 require 'store/entity_mapper'
 require 'store/data_mapper'
+require 'store/resolver'
+require 'store/entity_references'
 
 class Store
   def initialize(entity_classes, data_mapping, entity_mapping)
-    @entity_classes = entity_classes
-    @data_mapping = data_mapping
-    @entity_mapping = entity_mapping
-
-    @entity_references = Hash.new
+    @entity_classes         = entity_classes
+    @resolver_data_mapper   = Resolver::DataMapper.new(data_mapping)
+    @resolver_entity_mapper = Resolver::EntityMapper.new(self, entity_mapping)
+    @entity_references      = EntityReferences.new
   end
 
   def build(entity_class_name, attributes = {})
@@ -34,7 +35,7 @@ class Store
   end
 
   def remove(entity)
-    data_mapper = data_mapper_for_entity(entity)
+    data_mapper = data_mapper(entity)
     raise_unless_data_mapper_found(entity, data_mapper)
 
     reference = find_entity_reference(entity)
@@ -44,8 +45,7 @@ class Store
   end
 
   def query(query)
-    data_mapper = data_mapper_for_query(query)
-    entity_mapper = entity_mapper_for_query(query)
+    data_mapper = data_mapper(query)
     entity_class = @entity_classes[query.entity]
 
     raise_unless_data_mapper_found(query, data_mapper)
@@ -53,7 +53,7 @@ class Store
     mapped_entities_with_references = data_mapper.select(query) || {}
 
     mapped_entities_with_references.map do |reference, mapped_entity|
-      entity = entity_mapper.new(self).unmap(entity_class, mapped_entity)
+      entity = entity_mapper(query).unmap(entity_class, mapped_entity)
       save_entity_reference reference, entity
       entity
     end
@@ -68,21 +68,19 @@ class Store
   end
 
   def single_load(ref)
-    data_mapper = data_mapper_for_ref(ref)
-    entity_mapper = entity_mapper_for_ref(ref)
+    data_mapper = data_mapper(ref)
     entity_class = @entity_classes[ref.entity_type]
     reference = ref.reference
 
     mapped_entity = data_mapper.single_find(reference)
 
-    entity = entity_mapper.new(self).unmap(entity_class, mapped_entity)
+    entity = entity_mapper(ref).unmap(entity_class, mapped_entity)
     save_entity_reference reference, entity
     entity
   end
 
   def bulk_load(refs)
-    data_mapper = data_mapper_for_ref(refs.first)
-    entity_mapper = entity_mapper_for_ref(refs.first)
+    data_mapper = data_mapper(refs.first)
     entity_class = @entity_classes[refs.first.entity_type]
 
     references = refs.map(&:reference)
@@ -93,7 +91,7 @@ class Store
     references.each_with_index do |reference, i|
       mapped_entity = mapped_entities[i]
 
-      entity = entity_mapper.new(self).unmap(entity_class, mapped_entity)
+      entity = entity_mapper(refs.first).unmap(entity_class, mapped_entity)
       save_entity_reference reference, entity
       entities << entity
     end
@@ -105,82 +103,50 @@ class Store
   def save_entity(entity)
     return nil unless entity
 
-    data_mapper = data_mapper_for_entity(entity)
+    data_mapper = data_mapper(entity)
     raise_unless_data_mapper_found(entity, data_mapper)
 
     reference = find_entity_reference(entity)
     if reference.nil?
-      reference = data_mapper.insert(map_entity entity)
+      reference = data_mapper.insert(extract_entity_attributes(entity))
       save_entity_reference(reference, entity)
     else
-      data_mapper.update(reference, map_entity(entity))
+      data_mapper.update(reference, extract_entity_attributes(entity))
     end
 
-    Ref.new(entity_type(entity), reference)
+    Ref.new(extract_entity_class_name(entity), reference)
   end
 
   def raise_unless_data_mapper_found(source, data_mapper)
     raise "No data_mapper for #{source.inspect} found" unless data_mapper
   end
 
-  def map_entity(entity)
-    entity_mapper = entity_mapper_for_entity(entity)
-    entity_mapper.new(self).map(entity)
-  end
-
-  def entity_mapper_for_entity(entity)
-    type = entity_type(entity)
-    entity_mapper_for_type(type)
-  end
-
-  def entity_mapper_for_query(query)
-    type = query.entity
-    entity_mapper_for_type(type)
-  end
-
-  def entity_mapper_for_ref(ref)
-    type = ref.entity_type
-    entity_mapper_for_type(type)
-  end
-
-  def entity_mapper_for_type(type)
-    @entity_mapping[type]
-  end
-
-  def entity_type(entity)
-    entity_class = entity.class
-    entity_class.name.split('::').last
-  end
-
-  def data_mapper_for_entity(entity)
-    type = entity_type(entity)
-    data_mapper_for_type type
+  def data_mapper(obj)
+    @resolver_data_mapper.resolve_data_mapper(obj)
   end
 
-  def data_mapper_for_query(query)
-    type = query.entity
-    data_mapper_for_type type
+  def entity_mapper(obj)
+    @resolver_entity_mapper.resolve_entity_mapper(obj)
   end
 
-  def data_mapper_for_ref(ref)
-    type = ref.entity_type
-    data_mapper_for_type type
+  def extract_entity_attributes(entity)
+    entity_mapper(entity).map(entity)
   end
 
-  def data_mapper_for_type(type)
-    @data_mapping[type]
+  def extract_entity_class_name(obj)
+    @resolver_entity_mapper.extract_entity_class_name_from_object(obj)
   end
 
   def find_entity_reference(entity)
-    @entity_references[entity.object_id]
+    @entity_references.find(entity)
   end
 
   def save_entity_reference(reference, entity)
-    @entity_references[entity.object_id] = reference
+    @entity_references.save(reference, entity)
   end
 
   def remove_entity_reference(entity)
-    @entity_references.delete entity.object_id
+    @entity_references.remove entity
   end
 
 end

data/lib/store/entity_references.rb

@@ -0,0 +1,17 @@
+class EntityReferences
+  def initialize
+    @hash = Hash.new
+  end
+
+  def save(id, entity)
+    @hash[entity.object_id] = id
+  end
+
+  def find(entity)
+    @hash[entity.object_id]
+  end
+
+  def remove(entity)
+    @hash.delete entity.object_id
+  end
+end

data/lib/store/repo.rb

@@ -10,11 +10,16 @@ class Store
       @store.build(entity, *args)
     end
 
-    def save(entites)
-      @store.save(entites)
+    def save(entities)
+      @store.save(entities)
       true
     end
 
+    def save_and_load(entities)
+      refs = @store.save(entities)
+      @store.load(refs)
+    end
+
     def remove(entity)
       @store.remove(entity)
       true

data/lib/store/resolver.rb

@@ -0,0 +1,18 @@
+require 'store/resolver/entity_mapper'
+require 'store/resolver/data_mapper'
+
+module Resolver
+
+  def extract_entity_class_name_from_ref(ref)
+    ref.entity_type
+  end
+
+  def extract_entity_class_name_from_query(query)
+    query.entity
+  end
+
+  def extract_entity_class_name_from_object(obj)
+    obj.class.name.split('::').last
+  end
+
+end

data/lib/store/resolver/data_mapper.rb

@@ -0,0 +1,22 @@
+module Resolver
+  class DataMapper
+    include Resolver
+  
+    def initialize(mapping)
+      @mapping = mapping
+    end
+  
+    def resolve_data_mapper(obj)
+      @mapping[
+        if obj.kind_of? Store::Ref
+          extract_entity_class_name_from_ref(obj)
+        elsif obj.kind_of? Store::Query
+          extract_entity_class_name_from_query(obj)
+        else
+          extract_entity_class_name_from_object(obj)
+        end
+      ]
+    end
+  
+  end
+end

data/lib/store/resolver/entity_mapper.rb

@@ -0,0 +1,23 @@
+module Resolver
+  class EntityMapper
+    include Resolver
+  
+    def initialize(store, mapping)
+      @store = store
+      @mapping = mapping
+    end
+  
+    def resolve_entity_mapper(obj)
+      @mapping[
+        if obj.kind_of? Store::Ref
+          extract_entity_class_name_from_ref(obj)
+        elsif obj.kind_of? Store::Query
+          extract_entity_class_name_from_query(obj)
+        else
+          extract_entity_class_name_from_object(obj)
+        end
+      ].new(@store)
+    end
+  
+  end
+end

data/lib/store/version.rb

@@ -1,3 +1,3 @@
 class Store
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/entity_references_spec.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+describe 'entity references' do
+
+  subject { EntityReferences.new }
+  let(:id) { 43 }
+  let(:object_id) { 42 }
+  let(:entity) { Struct.new(:object_id).new(object_id) }
+
+  describe 'save' do
+    it 'returns the passed id' do
+      assert_equal id, subject.save(id, entity)
+    end
+  end
+
+  describe 'find' do
+    it 'returns the passed id' do
+      subject.save(id, entity)
+      assert_equal id, subject.find(entity)
+    end
+  end
+
+  describe 'remove' do
+    it 'returns the passed id' do
+      subject.save(id, entity)
+      assert_equal id, subject.remove(entity)
+    end
+  end
+
+  describe 'integration' do
+    it 'saves an entity, finds it and removes it after that' do
+      subject.save(id, entity)
+      assert_equal id, subject.find(entity)
+      subject.remove(entity)
+      assert_nil subject.find(entity)
+    end
+  end
+
+end

data/spec/helper.rb

@@ -10,3 +10,17 @@ require 'ostruct'
 
 require 'store'
 
+class MiniTest::Spec
+
+  def faked_class(class_name)
+    faked_class = Class.new do
+      class << self
+        attr_accessor :name
+      end
+    end
+
+    faked_class.name = class_name
+    faked_class
+  end
+
+end

data/spec/resolver/data_mapper_spec.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+describe Resolver::DataMapper do
+
+  subject { Resolver::DataMapper.new(mapping) }
+
+  # entites
+  let(:foo) { faked_class('Foo').new }
+  let(:bar) { faked_class('Nested::Bar').new }
+
+  # data mapper
+  FooDataMapper = Class.new(Store::DataMapper)
+  BarDataMapper = Class.new(Store::DataMapper)
+
+  let(:mapping) do
+    {
+    'Foo' => FooDataMapper,
+    'Bar' => BarDataMapper,
+    }
+  end
+
+  it 'validates the subject' do
+    assert_instance_of Resolver::DataMapper, subject
+  end
+
+  it 'resolves data mapper class from Store::Ref' do
+    ref = Store::Ref.new('Foo', 42)
+    assert_equal FooDataMapper, subject.resolve_data_mapper(ref)
+  end
+
+  it 'resolves data mapper class from Store::Query' do
+    query = Store::Query.new('Foo', :query_name, :some, :args)
+    assert_equal FooDataMapper, subject.resolve_data_mapper(query)
+  end
+
+  it 'resolves data mapper class from object' do
+    assert_equal FooDataMapper, subject.resolve_data_mapper(foo)
+  end
+
+  it 'resolves data mapper class from namespaced object' do
+    assert_equal BarDataMapper, subject.resolve_data_mapper(bar)
+  end
+
+  it 'includes Resolver module' do
+    assert subject.respond_to? :extract_entity_class_name_from_ref
+    assert subject.respond_to? :extract_entity_class_name_from_query
+    assert subject.respond_to? :extract_entity_class_name_from_object
+  end
+
+end

data/spec/resolver/entity_mapper_spec.rb

@@ -0,0 +1,51 @@
+require 'helper'
+
+describe Resolver::EntityMapper do
+  subject { Resolver::EntityMapper.new(store, mapping) }
+
+  # entites
+  let(:foo) { faked_class('Foo').new }
+  let(:bar) { faked_class('Nested::Bar').new }
+
+  # entity mapper
+  FooEntityMapper = Class.new(Store::EntityMapper)
+  BarEntityMapper = Class.new(Store::EntityMapper)
+
+  let(:mapping) do
+    {
+    'Foo' => FooEntityMapper,
+    'Bar' => BarEntityMapper,
+    }
+  end
+
+  let(:store) { Object.new }
+
+  it 'validates the subject' do
+    assert_instance_of Resolver::EntityMapper, subject
+  end
+
+  it 'resolves entity mapper instance from Store::Ref' do
+    ref = Store::Ref.new('Foo', 42)
+    assert_instance_of FooEntityMapper, subject.resolve_entity_mapper(ref)
+  end
+
+  it 'resolves entity mapper instance from Store::Query' do
+    query = Store::Query.new('Foo', :query_name, :some, :args)
+    assert_instance_of FooEntityMapper, subject.resolve_entity_mapper(query)
+  end
+
+  it 'resolves entity mapper instance from object' do
+    assert_instance_of FooEntityMapper, subject.resolve_entity_mapper(foo)
+  end
+
+  it 'resolves entity mapper instance from namespaced object' do
+    assert_instance_of BarEntityMapper, subject.resolve_entity_mapper(bar)
+  end
+
+  it 'includes Resolver module' do
+    assert subject.respond_to? :extract_entity_class_name_from_ref
+    assert subject.respond_to? :extract_entity_class_name_from_query
+    assert subject.respond_to? :extract_entity_class_name_from_object
+  end
+
+end

data/spec/resolver/resolver_spec.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+describe Resolver do
+
+  let(:subject_class) { Class.new { include Resolver } }
+  subject { subject_class.new }
+
+  # entites
+  let(:foo) { faked_class('Foo').new }
+  let(:bar) { faked_class('Nested::Bar').new }
+
+  it 'extracts entity class name from Store::Ref' do
+    ref = Store::Ref.new('Foo', 42)
+    assert_equal 'Foo', subject.extract_entity_class_name_from_ref(ref)
+  end
+
+  it 'extracts entity class name from Store::Query' do
+    query = Store::Query.new('Foo', :query_name, :some, :args)
+    assert_equal 'Foo', subject.extract_entity_class_name_from_query(query)
+  end
+
+  it 'extracts entity class name from Object' do
+    assert_equal 'Foo', subject.extract_entity_class_name_from_object(foo)
+  end
+
+  it 'extracts entity class from Nested::Object' do
+    assert_equal 'Bar', subject.extract_entity_class_name_from_object(bar)
+  end
+
+end

data/spec/store_repo_spec.rb

@@ -15,19 +15,48 @@ describe 'Store::Repo' do
 
   it 'delegeates save to @store and swallows result' do
     store.expect :save, :result, [:arg]
-    assert_equal true, repo.save(:arg)
+
+    result = repo.save(:arg)
+
+    assert store.verify
+    assert_equal true, result
   end
 
   it 'delegates remove to @store and swallows result' do
     store.expect :remove, :result, [:arg]
-    assert_equal true, repo.remove(:arg)
+    
+    result =  repo.remove(:arg)
+
+    assert store.verify
+    assert_equal true, result
   end
 
-  it 'delegates build to @store and returns result' do
+  it 'delegates build to @store and returns result without args' do
     store.expect :build, :result, [:arg]
-    assert_equal :result, repo.build(:arg)
 
+    result = repo.build(:arg)
+
+    assert store.verify
+    assert_equal :result, result
+  end
+
+  it 'delegates build to @store and returns result with args' do
     store.expect :build, :result, [:arg, :a, :b]
-    assert_equal :result, repo.build(:arg, :a, :b)
+
+    result = repo.build(:arg, :a, :b)
+
+    assert store.verify
+    assert_equal :result, result
+  end
+
+  it 'delegates save_and_load to @store' do
+    store.expect :save, :refs, [:arg]
+    store.expect :load, :entities, [:refs]
+
+    result = repo.save_and_load(:arg)
+
+    assert store.verify
+    assert_equal :entities, result 
   end
+
 end

data/store.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jakob Holderbaum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: 
 email:
 - jakob@featurefabrik.de
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -67,11 +82,19 @@ files:
 - lib/store.rb
 - lib/store/data_mapper.rb
 - lib/store/entity_mapper.rb
+- lib/store/entity_references.rb
 - lib/store/query.rb
 - lib/store/ref.rb
 - lib/store/repo.rb
+- lib/store/resolver.rb
+- lib/store/resolver/data_mapper.rb
+- lib/store/resolver/entity_mapper.rb
 - lib/store/version.rb
+- spec/entity_references_spec.rb
 - spec/helper.rb
+- spec/resolver/data_mapper_spec.rb
+- spec/resolver/entity_mapper_spec.rb
+- spec/resolver/resolver_spec.rb
 - spec/store_query_spec.rb
 - spec/store_ref_spec.rb
 - spec/store_repo_spec.rb
@@ -102,7 +125,11 @@ signing_key:
 specification_version: 4
 summary: Repository Pattern and Data-Mapper Pattern
 test_files:
+- spec/entity_references_spec.rb
 - spec/helper.rb
+- spec/resolver/data_mapper_spec.rb
+- spec/resolver/entity_mapper_spec.rb
+- spec/resolver/resolver_spec.rb
 - spec/store_query_spec.rb
 - spec/store_ref_spec.rb
 - spec/store_repo_spec.rb