datamappify 0.40.0 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 425218c5431f6668819ee6dee7cec37c8aa9e23f
-  data.tar.gz: a928d202dd9750197c297721fcb7142279a52d42
+  metadata.gz: 51bd14425d7e0347cf2a97adff354cb262038152
+  data.tar.gz: f7fc7a27a71d6e5cb10c971f9a7e57fc968ac8d0
 SHA512:
-  metadata.gz: 250ba0d6203d7a76ee0deab3ed581783048960851f280821be7670507b4cee18115d5593f97c74a790a628b5c342e4ac9bba6a63b9997bfba2ae1a76a94857cc
-  data.tar.gz: aa64bb2f335e6e480c8ae2b0f3dbb70a70d5a45f924920238ac416a19550e54f0d7e652cb3118769c8af3f351329a4365a6accd7ab2c522c5c8f1cfaaca0d2bf
+  metadata.gz: ef748d505249785e6da9518a05eaab78cca206517eb708900e43e4342bedf01be6f2c369f1570058866dc10a7ac4c7a560b5ddb0371c4b35e0a6b3abdc2e2eaf
+  data.tar.gz: e7a1d50c78433c4945b06507ad60fe366f7f9623fa806cafbf54a3b99229232dafca583ea31e1d3a827729eeffcf108f4712e607b5f80fde005abf66782885e4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## master
 
+## 0.50.0 [2013-05-30]
+
+- Added `all` to repository.
+- Added `PersistentStates#mark_as_dirty`.
+- Added `Entity#references`.
+- Implemented nested composable entities!
+
 ## 0.40.0 [2013-05-21]
 
 - Added dirty attribute tracking.

data/README.md

@@ -14,7 +14,9 @@ Datamappify consists of three components:
 - __Repository__ is responsible for data retrieval and persistence, e.g. `find`, `save` and `destroy`, etc.
 - __Data__ as the name suggests, holds your model data. It contains ORM objects (ActiveRecord and Sequel, etc).
 
-![](ERD.png)
+Below is a high level and somewhat simplified overview of Datamappify's architecture.
+
+![](http://i.imgur.com/byt6P3f.png)
 
 Note: Datamappify is NOT affiliated with the [Datamapper](https://github.com/datamapper/) project.
 
@@ -48,6 +50,30 @@ class User
   attribute :driver_license, String
   attribute :health_care,    String
 
+  # Nested entity composition - composing the entity with attributes from other entities
+  attributes_from Job
+
+  # optionally you may prefix the attributes, so that:
+  #
+  #   :programming
+  #
+  # becomes:
+  #
+  #   :hobby_programming
+  attributes_from Hobby, :prefix_with => :hobby
+
+  # Entity reference
+  #
+  # `references` is a convenient method for:
+  #
+  #   attribute :account_id, Integer
+  #   attr_accessor :account
+  #
+  # and it assigns `account_id` the correct value:
+  #
+  #   user.account = account #=> user.account_id = account.id
+  references :account
+
   validates :first_name, :presence => true,
                          :length   => { :minimum => 2 }
   validates :passport,   :presence => true,
@@ -100,12 +126,14 @@ class UserRepository
 end
 ```
 
-#### Retrieving entities
+_More repository APIs are being added, below is a list of the currently implemented APIs._
+
+#### Retrieving an entity
 
 Pass in an id.
 
 ```ruby
-user  = UserRepository.find(1)
+user = UserRepository.find(1)
 ```
 
 #### Checking if an entity exists in the repository
@@ -116,6 +144,14 @@ Pass in an entity.
 UserRepository.exists?(user)
 ```
 
+#### Retrieving all entities
+
+Returns an array of user entities.
+
+```ruby
+users = UserRepository.all
+```
+
 #### Saving/updating entities
 
 Pass in an entity.
@@ -128,6 +164,30 @@ UserRepository.save(user)
 
 Datamappify supports attribute dirty tracking - only dirty attributes will be saved.
 
+##### Mark attributes as dirty
+
+Sometimes it's useful to manually mark the whole entity, or some attributes in the entity to be dirty - i.e. when you are submitting a form and only want to update the changed attributes. In this case, you could:
+
+```ruby
+UserRepository.states.mark_as_dirty(user)
+
+UserRepository.states.find(user).changed?            #=> true
+UserRepository.states.find(user).first_name_changed? #=> true
+UserRepository.states.find(user).last_name_changed?  #=> true
+UserRepository.states.find(user).age_changed?        #=> true
+```
+
+Or:
+
+```ruby
+UserRepository.states.mark_as_dirty(user, :first_name, :last_name)
+
+UserRepository.states.find(user).changed?            #=> true
+UserRepository.states.find(user).first_name_changed? #=> true
+UserRepository.states.find(user).last_name_changed?  #=> true
+UserRepository.states.find(user).age_changed?        #=> false
+```
+
 #### Destroying an entity
 
 Pass in an entity.
@@ -190,14 +250,14 @@ Refer to [CHANGELOG](CHANGELOG.md).
 ## Todo
 
 - [Authoritative source](http://msdn.microsoft.com/en-au/library/ff649505.aspx).
-- Enforce attribute type casting.
-- Support for configurable primary keys and foreign keys.
+- Support for configurable primary keys and reference (foreign) keys.
 
 ## Similar Projects
 
 - [Curator](https://github.com/braintree/curator)
 - [Edr](https://github.com/nulogy/edr)
 - [Minimapper](https://github.com/joakimk/minimapper)
+- [Reform](https://github.com/apotonick/reform)
 
 ## Credits
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs.push 'lib'
-  t.test_files = FileList['spec/**/*_spec.rb']
+  t.test_files = FileList['spec/spec_helper', 'spec/**/*_spec.rb']
   t.verbose = true
 end
 

data/datamappify.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "virtus",      "~> 0.5"
   spec.add_dependency "activemodel", ">= 4.0.0.rc1", "< 5"
-  spec.add_dependency "hooks",       "~> 0.2.2"
+  spec.add_dependency "hooks",       "~> 0.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
@@ -34,5 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "sequel"
   spec.add_development_dependency "activerecord",     ">= 4.0.0.rc1", "< 5"
-  spec.add_development_dependency "database_cleaner", ">= 1.0.0.RC1", "< 2"
+  spec.add_development_dependency "database_cleaner", "~> 1.0.1"
 end

data/lib/datamappify/data/criteria/active_record/find_multiple.rb

@@ -0,0 +1,12 @@
+require 'datamappify/data/criteria/relational/find_multiple'
+
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class FindMultiple < Relational::FindMultiple
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/data/criteria/relational/find_multiple.rb

@@ -0,0 +1,28 @@
+module Datamappify
+  module Data
+    module Criteria
+      module Relational
+        class FindMultiple < Common
+          alias_method :entity_class, :entity
+
+          def perform
+            records = source_class.where(criteria)
+            records.map do |record|
+              entity = entity_class.new
+              update_entity(entity, record)
+              entity
+            end
+          end
+
+          private
+
+          def update_entity(entity, record)
+            attributes.each do |attribute|
+              entity.send("#{attribute.name}=", record.send(attribute.source_attribute_name))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/data/criteria/sequel/find_multiple.rb

@@ -0,0 +1,12 @@
+require 'datamappify/data/criteria/relational/find_multiple'
+
+module Datamappify
+  module Data
+    module Criteria
+      module Sequel
+        class FindMultiple < Relational::FindMultiple
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/data/mapper.rb

@@ -34,6 +34,11 @@ module Datamappify
         @default_source_class ||= default_provider.find_or_build_record_class(entity_class.name)
       end
 
+      # @return [String]
+      def default_source_class_name
+        entity_class.name
+      end
+
       # @return [Set<Attribute>]
       def attributes
         @attributes ||= Set.new(default_attributes + custom_attributes)
@@ -45,6 +50,11 @@ module Datamappify
         @classified_attributes ||= Set.new(attributes).classify(&:provider_name)
       end
 
+      # @return [Array<Attribute>]
+      def attributes_from_default_source
+        classified_attributes[default_provider_name].classify(&:source_class_name)[default_source_class_name]
+      end
+
       private
 
       # @return [Array<Symbol>]

data/lib/datamappify/entity/active_model/compatibility.rb

@@ -0,0 +1,13 @@
+module Datamappify
+  module Entity
+    module ActiveModel
+      # Add non-entity related stuff so that an entity can be used in say, forms
+      module Compatibility
+        # @return [Boolean]
+        def persisted?
+          !id.blank?
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/entity/composable.rb

@@ -0,0 +1,53 @@
+module Datamappify
+  module Entity
+    module Composable
+      def self.included(klass)
+        klass.extend DSL
+      end
+
+      module DSL
+        # @param entity_class [Entity]
+        #
+        # @param options [Hash]
+        #
+        # @return [void]
+        def attributes_from(entity_class, options = {})
+          entity_class.attribute_set.each do |attribute|
+            unless excluded_attributes(entity_class).include?(attribute.name)
+              self.attribute_set << tweak_attribute!(attribute, options)
+            end
+          end
+        end
+
+        private
+
+        # @param entity_class [Entity]
+        #
+        # @return [Array]
+        def excluded_attributes(entity_class)
+          @excluded_attributes ||= entity_class.reference_keys << :id
+        end
+
+        # @param attribute [Virtus::Attribute]
+        #
+        # @param options [Hash]
+        #
+        # @return [Virtus::Attribute]
+        def tweak_attribute!(attribute, options)
+          prefix_attribute_name!(attribute, options[:prefix_with]) if options[:prefix_with]
+
+          attribute
+        end
+
+        # @param attribute [Virtus::Attribute]
+        #
+        # @param prefix [Symbol]
+        #
+        # @return [void]
+        def prefix_attribute_name!(attribute, prefix)
+          attribute.instance_variable_set :@name, :"#{prefix}_#{attribute.name}"
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/entity/relation.rb

@@ -0,0 +1,61 @@
+module Datamappify
+  module Entity
+    module Relation
+      def self.included(klass)
+        klass.class_eval do
+          cattr_accessor :reference_keys
+          extend DSL
+
+          self.reference_keys = []
+        end
+      end
+
+      module DSL
+        # @param entity_name [Symbol, String]
+        #
+        # @return [void]
+        def references(entity_name)
+          attribute_name = :"#{entity_name}_id"
+
+          create_attribute attribute_name, Integer
+          create_accessor entity_name
+          record_attribute attribute_name
+        end
+
+        private
+
+        # @param entity_name (see #references)
+        #
+        # @return [void]
+        def create_accessor(entity_name)
+          class_eval <<-CODE, __FILE__, __LINE__ + 1
+            attr_reader :#{entity_name}
+
+            def #{entity_name}=(entity)
+              @#{entity_name}        = entity
+              self.#{entity_name}_id = entity.id
+            end
+          CODE
+        end
+
+        # @param name [Symbol]
+        #
+        # @param type [Class]
+        #
+        # @param options [any]
+        #
+        # @return [void]
+        def create_attribute(name, type, *args)
+          attribute name, type, *args
+        end
+
+        # @param attribute_name [Symbol]
+        #
+        # @return [Array]
+        def record_attribute(attribute_name)
+          self.reference_keys << attribute_name
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/entity.rb

@@ -1,6 +1,9 @@
 require 'observer'
 require 'virtus'
+require 'datamappify/entity/active_model/compatibility'
 require 'datamappify/entity/lazy_checking'
+require 'datamappify/entity/composable'
+require 'datamappify/entity/relation'
 
 module Datamappify
   module Entity
@@ -9,8 +12,11 @@ module Datamappify
         include Observable
         include Virtus
         include Virtus::Equalizer.new(inspect)
-        include ActiveModel::Validations
+        include ::ActiveModel::Model
+        include ActiveModel::Compatibility
         include LazyChecking
+        include Composable
+        include Relation
 
         attribute :id, Integer
       end

data/lib/datamappify/repository/query_method/callbacks.rb

@@ -1,25 +1,5 @@
 require 'hooks'
 
-# Money-patches Hooks
-module Hooks
-  module ClassMethods
-    # Added the ability to ignore callbacks if the previous callback returns `nil` or `false`
-    #
-    # @return [Boolean]
-    def run_hook_for(name, scope, *args)
-      callbacks = callbacks_for_hook(name)
-
-      callbacks.take_while do |callback|
-        if callback.kind_of? Symbol
-          scope.send(callback, *args)
-        else
-          scope.instance_exec(*args, &callback)
-        end
-      end.length == callbacks.length
-    end
-  end
-end
-
 module Datamappify
   module Repository
     module QueryMethod
@@ -31,7 +11,8 @@ module Datamappify
             define_hooks :before_create,  :after_create,
                          :before_update,  :after_update,
                          :before_save,    :after_save,
-                         :before_destroy, :after_destroy
+                         :before_destroy, :after_destroy,
+                         :halts_on_falsey => true
           end
         end
 
@@ -63,7 +44,7 @@ module Datamappify
         # @return [Boolean]
         def run_hooks(types, filter, entity)
           types.take_while do |type|
-            run_hook(hook_for(type, filter), entity)
+            run_hook(hook_for(type, filter), entity).not_halted?
           end.length == types.length
         end
 
@@ -73,9 +54,9 @@ module Datamappify
         # @param filter [Symbol]
         #   e.g. :before or :after
         #
-        # @return [String]
+        # @return [Symbol]
         def hook_for(type, filter)
-          "#{filter}_#{type}"
+          :"#{filter}_#{type}"
         end
       end
     end

data/lib/datamappify/repository/query_method/find_multiple.rb

@@ -0,0 +1,34 @@
+module Datamappify
+  module Repository
+    module QueryMethod
+      class FindMultiple < Method
+        # @param options (see Method#initialize)
+        #
+        # @param where [Hash]
+        #   a hash containing all the find criterias
+        def initialize(options, criteria)
+          super
+          @criteria = criteria
+        end
+
+        # @return [Array<Entity>]
+        def perform
+          dispatch_criteria_to_default_source(
+            :FindMultiple, data_mapper.entity_class, @criteria, attributes
+          )
+        end
+
+        # @see Method#reader?
+        def reader?
+          true
+        end
+
+        private
+
+        def attributes
+          data_mapper.attributes_from_default_source
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/repository/query_methods.rb

@@ -28,6 +28,13 @@ module Datamappify
         QueryMethod::Find.new(query_options, id).perform
       end
 
+      # Returns a collection of all the entities in the repository
+      #
+      # @return [Array<Entity>]
+      def all
+        QueryMethod::FindMultiple.new(query_options, {}).perform
+      end
+
       # @param entity [Entity]
       #   an entity or a collection of entities
       #

data/lib/datamappify/repository/unit_of_work/persistent_states/object.rb

@@ -33,6 +33,20 @@ module Datamappify
             end
           end
 
+          # Mark selected or all attributes as dirty, useful for a non-persisted object
+          # or for manually trigger attributes update
+          #
+          # @param attrs [Symbol]
+          #   An array or a hash of which the keys are attribute symbols
+          #
+          # @return [void]
+          def mark_as_dirty(*attributes)
+            attributes = attributes.any? ? attributes : attributes_for(@entity)
+            attributes.each do |name, _|
+              send(:attribute_will_change!, name)
+            end
+          end
+
           # Is the object new (not persisted yet)?
           #
           # @return [Boolean]
@@ -98,15 +112,6 @@ module Datamappify
             instance_variable_set "@#{name}", Marshal.load(Marshal.dump(value))
           end
 
-          # Mark all attributes as dirty, useful for a non-persisted object
-          #
-          # @return [void]
-          def mark_as_dirty
-            attributes_for(@entity).each do |name, _|
-              send(:attribute_will_change!, name)
-            end
-          end
-
           # Entity attributes, based on whether the entity is lazy loaded
           #
           # @param entity [Entity]

data/lib/datamappify/repository/unit_of_work/persistent_states.rb

@@ -48,6 +48,17 @@ module Datamappify
 
           attach(entity)
         end
+
+        # @param entity [Entity]
+        #
+        # @param attrs (see Object#mark_as_dirty)
+        #
+        # @see Object#mark_as_dirty
+        #
+        # @return (see Object#mark_as_dirty)
+        def mark_as_dirty(entity, *attributes)
+          find(entity).mark_as_dirty(*attributes)
+        end
       end
     end
   end

data/lib/datamappify/version.rb

@@ -1,3 +1,3 @@
 module Datamappify
-  VERSION = '0.40.0'
+  VERSION = '0.50.0'
 end

data/spec/entity/composable_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Datamappify::Entity do
+  subject { Computer.new }
+
+  before do
+    subject.cpu                 = '286'
+    subject.ram                 = 8192
+    subject.hdd                 = 65536
+    subject.gfx                 = 'Voodoo'
+    subject.software_os         = 'OS X'
+    subject.software_osx_id     = 1
+    subject.software_windows_id = 2
+    subject.software_linux_id   = 3
+  end
+
+  its(:cpu)                 { should == '286' }
+  its(:ram)                 { should == 8192 }
+  its(:hdd)                 { should == 65536 }
+  its(:gfx)                 { should == 'Voodoo' }
+  its(:software_os)         { should == 'OS X' }
+  its(:software_osx_id)     { should == 1 }
+  its(:software_windows_id) { should == 2 }
+  its(:software_linux_id)   { should == 3 }
+end

data/spec/entity/relation_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+shared_examples_for "entity relations" do |data_provider|
+  include_context "user repository", data_provider
+
+  let!(:comment_repository) { "CommentRepository#{data_provider}".constantize }
+  let(:comment)             { comment_repository.save!(Comment.new) }
+
+  subject { comment }
+
+  before do
+    subject.user = existing_user
+  end
+
+  its(:user_id) { should == existing_user.id }
+  its(:user)    { should == existing_user }
+end
+
+describe Datamappify::Entity do
+  DATA_PROVIDERS.each do |data_provider|
+    it_behaves_like "entity relations", data_provider
+  end
+end

data/spec/entity_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'spec_helper'
+require 'spec_helper'
 
 describe Datamappify::Entity do
   let(:user)    { User.new }
@@ -36,5 +36,11 @@ describe Datamappify::Entity do
       user.valid?.should == true
     end
   end
+
+  describe "conversion" do
+    subject { user }
+
+    it { should respond_to(:to_key) }
+  end
 end
 

data/spec/lazy_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'spec_helper'
+require 'spec_helper'
 
 describe Datamappify::Lazy do
   let!(:user_repository) { HeroUserRepository }

data/spec/repository/callbacks_spec.rb

@@ -94,6 +94,8 @@ describe Datamappify::Repository do
           subject.should_receive(:performed).with(:before_save_1, entity).ordered
           subject.should_receive(:performed).with(:before_save_2, entity).ordered
           subject.should_receive(:performed).with(:before_save_3, entity).ordered
+          subject.should_receive(:performed).with(:before_create_1, entity).ordered
+          subject.should_receive(:performed).with(:before_create_2, entity).ordered
           subject.should_not_receive(:performed).with(:after_save_1, entity)
           subject.should_not_receive(:performed).with(:after_save_2, entity)
           subject.should_not_receive(:performed).with(:after_save_3, entity)
@@ -108,6 +110,8 @@ describe Datamappify::Repository do
           subject.should_receive(:performed).with(:before_save_1, entity).ordered
           subject.should_receive(:performed).with(:before_save_2, entity).ordered
           subject.should_not_receive(:performed).with(:before_save_3, entity)
+          subject.should_not_receive(:performed).with(:before_create_1, entity)
+          subject.should_not_receive(:performed).with(:before_create_2, entity)
           subject.should_not_receive(:performed).with(:after_save_1, entity)
           subject.should_not_receive(:performed).with(:after_save_2, entity)
           subject.should_not_receive(:performed).with(:after_save_3, entity)
@@ -130,6 +134,8 @@ describe Datamappify::Repository do
           subject.should_receive(:performed).with(:before_save_1, entity).ordered
           subject.should_receive(:performed).with(:before_save_2, entity).ordered
           subject.should_receive(:performed).with(:before_save_3, entity).ordered
+          subject.should_receive(:performed).with(:before_create_1, entity).ordered
+          subject.should_receive(:performed).with(:before_create_2, entity).ordered
           subject.should_receive(:performed).with(:after_save_1, entity).ordered
           subject.should_receive(:performed).with(:after_save_2, entity).ordered
           subject.should_not_receive(:performed).with(:after_save_3, entity)

data/spec/repository/dirty_persistence_spec.rb

@@ -33,6 +33,24 @@ shared_examples_for "dirty persistence" do |data_provider|
 
         user_repository.save(new_valid_user)
       end
+
+      context "attributes manually marked as dirty" do
+        let!(:updated_user) { User.new(existing_user.attributes.merge(:first_name => 'Frasier')) }
+
+        it "performs when some attributes are marked as dirty" do
+          Datamappify::Logger.should_receive(:performed).with(update_method).once
+
+          user_repository.states.mark_as_dirty(updated_user, :first_name)
+          user_repository.save(updated_user)
+        end
+
+        it "performs when the entity is marked as dirty" do
+          Datamappify::Logger.should_receive(:performed).with(update_method).at_least(:twice)
+
+          user_repository.states.mark_as_dirty(updated_user)
+          user_repository.save(updated_user)
+        end
+      end
     end
   end
 end

data/spec/repository/dirty_tracking_spec.rb

@@ -72,6 +72,24 @@ shared_examples_for "dirty tracking" do |data_provider|
         user_repository.states.find(existing_user).changed?.should == false
       end
     end
+
+    describe "manually mark as dirty" do
+      it "marks an entity as dirty" do
+        user_repository.states.mark_as_dirty(existing_user)
+        user_repository.states.find(existing_user).changed?.should == true
+        user_repository.states.find(existing_user).first_name_changed?.should == true
+        user_repository.states.find(existing_user).last_name_changed?.should == true
+        user_repository.states.find(existing_user).age_changed?.should == true
+      end
+
+      it "marks entity attributes as dirty" do
+        user_repository.states.mark_as_dirty(existing_user, :first_name, :age)
+        user_repository.states.find(existing_user).changed?.should == true
+        user_repository.states.find(existing_user).first_name_changed?.should == true
+        user_repository.states.find(existing_user).last_name_changed?.should == false
+        user_repository.states.find(existing_user).age_changed?.should == true
+      end
+    end
   end
 end
 

data/spec/repository/finders_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+shared_examples_for "finders" do |data_provider|
+  include_context "user repository", data_provider
+
+  let!(:existing_user_1) { user_repository.save(new_valid_user.dup) }
+  let!(:existing_user_2) { user_repository.save(new_valid_user.dup) }
+
+  context "#{data_provider}" do
+    describe "#all" do
+      it "finds all entities in a repository" do
+        user_repository.all.should have(3).users
+      end
+
+      it "finds first entity" do
+        user_repository.all.first.should == existing_user
+      end
+
+      it "finds last entity" do
+        user_repository.all.last.should == existing_user_2
+      end
+    end
+  end
+end
+
+describe Datamappify::Repository do
+  DATA_PROVIDERS.each do |data_provider|
+    it_behaves_like "finders", data_provider
+  end
+end

data/spec/repository/persistence_spec.rb

@@ -26,10 +26,12 @@ shared_examples_for "repository persistence" do |data_provider|
           new_user.should be_kind_of(User)
           new_user.first_name.should == 'Batman'
           new_user.driver_license.should == 'ARKHAMCITY'
+          new_user.persisted?.should == true
         end
 
         it "failure" do
           -> { user_repository.save!(new_invalid_user) }.should raise_error(Datamappify::Data::EntityNotSaved)
+          new_invalid_user.persisted?.should == false
         end
 
         it "updates existing records" do
@@ -47,6 +49,7 @@ shared_examples_for "repository persistence" do |data_provider|
 
           persisted_user.first_name.should == 'Vivian'
           persisted_user.driver_license.should == 'LOCOMOTE'
+          persisted_user.persisted?.should == true
         end
 
         it "updates existing and new records" do
@@ -64,6 +67,7 @@ shared_examples_for "repository persistence" do |data_provider|
 
           persisted_user.first_name.should == 'Vivian'
           persisted_user.health_care.should == 'BATMANCAVE'
+          persisted_user.persisted?.should == true
         end
       end
     end

data/spec/repository_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'spec_helper'
+require 'spec_helper'
 
 shared_examples_for "a repository" do |data_provider|
   let(:namespace)       { "Datamappify::Data::Record::#{data_provider}".constantize }

data/spec/spec_helper.rb

@@ -22,7 +22,12 @@ end
 DATA_PROVIDERS = ENV['DATA_PROVIDER'] ? [ENV['DATA_PROVIDER']] : %w{ActiveRecord Sequel}
 
 RSpec.configure do |config|
-  DatabaseCleaner.strategy = :truncation
+  DatabaseCleaner.add_cleaner(:sequel)
+
+  DatabaseCleaner[:sequel].strategy        = :truncation
+  DatabaseCleaner[:active_record].strategy = :truncation
+
+  require File.expand_path('../support/monkey_patches/database_cleaner.rb', __FILE__)
 
   config.before do
     DatabaseCleaner.clean

data/spec/support/entities/comment.rb

@@ -2,4 +2,6 @@ class Comment
   include Datamappify::Entity
 
   attribute :content, String
+
+  references :user
 end

data/spec/support/entities/computer.rb

@@ -0,0 +1,11 @@
+require_relative 'computer_hardware'
+require_relative 'computer_software'
+
+class Computer
+  include Datamappify::Entity
+
+  attribute :brand, String
+
+  attributes_from ComputerHardware
+  attributes_from ComputerSoftware, :prefix_with => :software
+end

data/spec/support/entities/computer_hardware.rb

@@ -0,0 +1,8 @@
+class ComputerHardware
+  include Datamappify::Entity
+
+  attribute :cpu, String
+  attribute :ram, Integer
+  attribute :hdd, Integer
+  attribute :gfx, String
+end

data/spec/support/entities/computer_software.rb

@@ -0,0 +1,9 @@
+class ComputerSoftware
+  include Datamappify::Entity
+
+  attribute :os, String
+
+  references :osx
+  references :windows
+  references :linux
+end

data/spec/support/monkey_patches/database_cleaner.rb

@@ -0,0 +1,12 @@
+# @see https://github.com/bmabey/database_cleaner/pull/211
+module DatabaseCleaner
+  module Sequel
+    class Truncation
+      def each_table
+        tables_to_truncate(db).each do |table|
+          yield db, table.to_sym
+        end
+      end
+    end
+  end
+end

data/spec/support/repositories/callbacks_chaining_repository.rb

@@ -8,21 +8,25 @@ class CallbacksChainingRepository
   map_attribute :last_name,  'Sequel::HeroUserLastName#last_name'
   map_attribute :gender,     'Sequel::HeroUserLastName#gender'
 
-  before_save :before_save_1
-  before_save :before_save_2
-  before_save :before_save_3
-  after_save  :after_save_1
-  after_save  :after_save_2
-  after_save  :after_save_3
+  before_save   :before_save_1
+  before_save   :before_save_2
+  before_save   :before_save_3
+  before_create :before_create_1
+  before_create :before_create_2
+  after_save    :after_save_1
+  after_save    :after_save_2
+  after_save    :after_save_3
 
   private
 
-  def before_save_1(entity); performed(:before_save_1, entity); true; end
-  def before_save_2(entity); performed(:before_save_2, entity); true; end
-  def before_save_3(entity); performed(:before_save_3, entity); true; end
-  def after_save_1 (entity); performed(:after_save_1,  entity); true; end
-  def after_save_2 (entity); performed(:after_save_2,  entity); true; end
-  def after_save_3 (entity); performed(:after_save_3 , entity); true; end
+  def before_save_1  (entity); performed(:before_save_1,   entity); true; end
+  def before_save_2  (entity); performed(:before_save_2,   entity); true; end
+  def before_save_3  (entity); performed(:before_save_3,   entity); true; end
+  def before_create_1(entity); performed(:before_create_1, entity); true; end
+  def before_create_2(entity); performed(:before_create_2, entity); true; end
+  def after_save_1   (entity); performed(:after_save_1,    entity); true; end
+  def after_save_2   (entity); performed(:after_save_2,    entity); true; end
+  def after_save_3   (entity); performed(:after_save_3,    entity); true; end
 
   def performed(*args)
     true
@@ -39,21 +43,25 @@ class CallbacksChainingPauseBeforeRepository
   map_attribute :last_name,  'Sequel::HeroUserLastName#last_name'
   map_attribute :gender,     'Sequel::HeroUserLastName#gender'
 
-  before_save :before_save_1
-  before_save :before_save_2
-  before_save :before_save_3
-  after_save  :after_save_1
-  after_save  :after_save_2
-  after_save  :after_save_3
+  before_save   :before_save_1
+  before_save   :before_save_2
+  before_save   :before_save_3
+  before_create :before_create_1
+  before_create :before_create_2
+  after_save    :after_save_1
+  after_save    :after_save_2
+  after_save    :after_save_3
 
   private
 
-  def before_save_1(entity); performed(:before_save_1, entity); true;  end
-  def before_save_2(entity); performed(:before_save_2, entity); false; end
-  def before_save_3(entity); performed(:before_save_3, entity); true;  end
-  def after_save_1 (entity); performed(:after_save_1,  entity); true;  end
-  def after_save_2 (entity); performed(:after_save_2,  entity); true;  end
-  def after_save_3 (entity); performed(:after_save_3 , entity); true;  end
+  def before_save_1  (entity); performed(:before_save_1,   entity); true;  end
+  def before_save_2  (entity); performed(:before_save_2,   entity); false; end
+  def before_save_3  (entity); performed(:before_save_3,   entity); true;  end
+  def before_create_1(entity); performed(:before_create_1, entity); true;  end
+  def before_create_2(entity); performed(:before_create_2, entity); true;  end
+  def after_save_1   (entity); performed(:after_save_1,    entity); true;  end
+  def after_save_2   (entity); performed(:after_save_2,    entity); true;  end
+  def after_save_3   (entity); performed(:after_save_3,    entity); true;  end
 
   def performed(*args)
     true
@@ -70,21 +78,25 @@ class CallbacksChainingPauseAfterRepository
   map_attribute :last_name,  'Sequel::HeroUserLastName#last_name'
   map_attribute :gender,     'Sequel::HeroUserLastName#gender'
 
-  before_save :before_save_1
-  before_save :before_save_2
-  before_save :before_save_3
-  after_save  :after_save_1
-  after_save  :after_save_2
-  after_save  :after_save_3
+  before_save   :before_save_1
+  before_save   :before_save_2
+  before_save   :before_save_3
+  before_create :before_create_1
+  before_create :before_create_2
+  after_save    :after_save_1
+  after_save    :after_save_2
+  after_save    :after_save_3
 
   private
 
-  def before_save_1(entity); performed(:before_save_1, entity); true;  end
-  def before_save_2(entity); performed(:before_save_2, entity); true;  end
-  def before_save_3(entity); performed(:before_save_3, entity); true;  end
-  def after_save_1 (entity); performed(:after_save_1,  entity); true;  end
-  def after_save_2 (entity); performed(:after_save_2,  entity); false; end
-  def after_save_3 (entity); performed(:after_save_3 , entity); true;  end
+  def before_save_1  (entity); performed(:before_save_1,   entity); true;  end
+  def before_save_2  (entity); performed(:before_save_2,   entity); true;  end
+  def before_save_3  (entity); performed(:before_save_3,   entity); true;  end
+  def before_create_1(entity); performed(:before_create_1, entity); true;  end
+  def before_create_2(entity); performed(:before_create_2, entity); true;  end
+  def after_save_1   (entity); performed(:after_save_1,    entity); true;  end
+  def after_save_2   (entity); performed(:after_save_2,    entity); false; end
+  def after_save_3   (entity); performed(:after_save_3,    entity); true;  end
 
   def performed(*args)
     true

data/spec/unit/entity/composable_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module Datamappify::Entity
+  describe Datamappify::Entity::Composable do
+    class FarDistantEntity
+      include Datamappify::Entity
+
+      attribute :far_distant_attribute_one
+    end
+
+    class DistantEntity
+      include Datamappify::Entity
+
+      attribute :distant_attribute_one, String
+      attribute :distant_attribute_two, Integer, :default => 42
+
+      references :far_distant_entity
+
+      attributes_from FarDistantEntity, :prefix_with => :far
+    end
+
+    class AnotherEntity
+      include Datamappify::Entity
+
+      attribute :attribute_one, String, :default => 'Hello'
+      attribute :attribute_two, Integer
+
+      references :distant_entity
+
+      attributes_from DistantEntity
+    end
+
+    class DummyEntity
+      include Datamappify::Entity
+
+      attribute :attribute_zero, String
+
+      attributes_from AnotherEntity, :prefix_with => :other
+    end
+
+    subject { DummyEntity.new }
+
+    describe "#attributes_from" do
+      its(:attributes) { should have_key(:attribute_zero) }
+      its(:attributes) { should have_key(:other_attribute_one) }
+      its(:attributes) { should have_key(:other_attribute_two) }
+      its(:attributes) { should have_key(:other_distant_attribute_one) }
+      its(:attributes) { should have_key(:other_distant_attribute_two) }
+      its(:attributes) { should have_key(:other_far_far_distant_attribute_one) }
+
+      its(:attributes) { should_not have_key(:attribute_one) }
+      its(:attributes) { should_not have_key(:attribute_two) }
+      its(:attributes) { should_not have_key(:distant_attribute_one) }
+      its(:attributes) { should_not have_key(:distant_attribute_two) }
+
+      its(:attributes) { should_not have_key(:distant_entity_id) }
+      its(:attributes) { should_not have_key(:other_distant_entity_id) }
+      its(:attributes) { should_not have_key(:far_distant_entity_id) }
+      its(:attributes) { should_not have_key(:other_far_distant_entity_id) }
+      its(:attributes) { should_not have_key(:far_far_distant_entity_id) }
+
+      its(:other_attribute_one)   { should == 'Hello' }
+      its(:other_distant_attribute_two) { should == 42 }
+    end
+  end
+end

data/spec/unit/entity/relation_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Datamappify::Entity
+  describe Datamappify::Entity::Relation do
+    class DummyEntity
+      include Datamappify::Entity
+
+      references :another_entity
+    end
+
+    class AnotherEntity
+      include Datamappify::Entity
+    end
+
+    subject { DummyEntity.new }
+
+    describe "#references" do
+      it { should respond_to(:another_entity_id) }
+      it { should respond_to(:another_entity_id=) }
+      it { should respond_to(:another_entity) }
+      it { should respond_to(:another_entity=) }
+
+      describe "assigns the correct attribute" do
+        let(:another_entity) { AnotherEntity.new.tap { |e| e.id = 42 } }
+
+        before do
+          subject.another_entity = another_entity
+        end
+
+        its(:another_entity_id) { should == 42 }
+        its(:another_entity)    { should == another_entity }
+        its(:reference_keys)    { should include(:another_entity_id) }
+      end
+    end
+  end
+end

data/spec/unit/repository/query_method_spec.rb

@@ -37,6 +37,13 @@ module Datamappify::Repository::QueryMethod
       it { should_not be_a_writer }
     end
 
+    describe FindMultiple do
+      subject { FindMultiple }
+
+      it { should     be_a_reader }
+      it { should_not be_a_writer }
+    end
+
     describe Save do
       subject { Save }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datamappify
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.50.0
 platform: ruby
 authors:
 - Fred Wu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -236,22 +236,16 @@ dependencies:
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0.RC1
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0.RC1
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 1.0.1
 description: Compose and manage domain logic and data persistence separately and intelligently.
 email:
 - ifredwu@gmail.com
@@ -264,7 +258,6 @@ files:
 - .travis.yml
 - .yardopts
 - CHANGELOG.md
-- ERD.png
 - Gemfile
 - README.md
 - Rakefile
@@ -277,6 +270,7 @@ files:
 - lib/datamappify/data/criteria/active_record/exists.rb
 - lib/datamappify/data/criteria/active_record/find.rb
 - lib/datamappify/data/criteria/active_record/find_by_key.rb
+- lib/datamappify/data/criteria/active_record/find_multiple.rb
 - lib/datamappify/data/criteria/active_record/save.rb
 - lib/datamappify/data/criteria/active_record/save_by_key.rb
 - lib/datamappify/data/criteria/active_record/transaction.rb
@@ -284,6 +278,7 @@ files:
 - lib/datamappify/data/criteria/relational/count.rb
 - lib/datamappify/data/criteria/relational/find.rb
 - lib/datamappify/data/criteria/relational/find_by_key.rb
+- lib/datamappify/data/criteria/relational/find_multiple.rb
 - lib/datamappify/data/criteria/relational/save.rb
 - lib/datamappify/data/criteria/relational/save_by_key.rb
 - lib/datamappify/data/criteria/sequel/count.rb
@@ -291,6 +286,7 @@ files:
 - lib/datamappify/data/criteria/sequel/exists.rb
 - lib/datamappify/data/criteria/sequel/find.rb
 - lib/datamappify/data/criteria/sequel/find_by_key.rb
+- lib/datamappify/data/criteria/sequel/find_multiple.rb
 - lib/datamappify/data/criteria/sequel/save.rb
 - lib/datamappify/data/criteria/sequel/save_by_key.rb
 - lib/datamappify/data/criteria/sequel/transaction.rb
@@ -303,7 +299,10 @@ files:
 - lib/datamappify/data/provider/sequel.rb
 - lib/datamappify/data/record.rb
 - lib/datamappify/entity.rb
+- lib/datamappify/entity/active_model/compatibility.rb
+- lib/datamappify/entity/composable.rb
 - lib/datamappify/entity/lazy_checking.rb
+- lib/datamappify/entity/relation.rb
 - lib/datamappify/lazy.rb
 - lib/datamappify/lazy/attributes_handler.rb
 - lib/datamappify/lazy/source_attributes_walker.rb
@@ -317,6 +316,7 @@ files:
 - lib/datamappify/repository/query_method/destroy.rb
 - lib/datamappify/repository/query_method/exists.rb
 - lib/datamappify/repository/query_method/find.rb
+- lib/datamappify/repository/query_method/find_multiple.rb
 - lib/datamappify/repository/query_method/method.rb
 - lib/datamappify/repository/query_method/method/source_attributes_walker.rb
 - lib/datamappify/repository/query_method/save.rb
@@ -327,21 +327,28 @@ files:
 - lib/datamappify/repository/unit_of_work/persistent_states/object.rb
 - lib/datamappify/repository/unit_of_work/transaction.rb
 - lib/datamappify/version.rb
+- spec/entity/composable_spec.rb
+- spec/entity/relation_spec.rb
 - spec/entity_spec.rb
 - spec/lazy_spec.rb
 - spec/repository/callbacks_spec.rb
 - spec/repository/dirty_persistence_spec.rb
 - spec/repository/dirty_tracking_spec.rb
+- spec/repository/finders_spec.rb
 - spec/repository/persistence_spec.rb
 - spec/repository/transactions_spec.rb
 - spec/repository/validation_spec.rb
 - spec/repository_spec.rb
 - spec/spec_helper.rb
 - spec/support/entities/comment.rb
+- spec/support/entities/computer.rb
+- spec/support/entities/computer_hardware.rb
+- spec/support/entities/computer_software.rb
 - spec/support/entities/group.rb
 - spec/support/entities/hero_user.rb
 - spec/support/entities/role.rb
 - spec/support/entities/user.rb
+- spec/support/monkey_patches/database_cleaner.rb
 - spec/support/repositories/active_record/comment_repository.rb
 - spec/support/repositories/active_record/group_repository.rb
 - spec/support/repositories/active_record/role_repository.rb
@@ -355,6 +362,8 @@ files:
 - spec/support/shared/contexts.rb
 - spec/support/tables/active_record.rb
 - spec/support/tables/sequel.rb
+- spec/unit/entity/composable_spec.rb
+- spec/unit/entity/relation_spec.rb
 - spec/unit/repository/query_method_spec.rb
 homepage: https://github.com/fredwu/datamappify
 licenses:
@@ -381,21 +390,28 @@ signing_key:
 specification_version: 4
 summary: Compose and manage domain logic and data persistence separately and intelligently.
 test_files:
+- spec/entity/composable_spec.rb
+- spec/entity/relation_spec.rb
 - spec/entity_spec.rb
 - spec/lazy_spec.rb
 - spec/repository/callbacks_spec.rb
 - spec/repository/dirty_persistence_spec.rb
 - spec/repository/dirty_tracking_spec.rb
+- spec/repository/finders_spec.rb
 - spec/repository/persistence_spec.rb
 - spec/repository/transactions_spec.rb
 - spec/repository/validation_spec.rb
 - spec/repository_spec.rb
 - spec/spec_helper.rb
 - spec/support/entities/comment.rb
+- spec/support/entities/computer.rb
+- spec/support/entities/computer_hardware.rb
+- spec/support/entities/computer_software.rb
 - spec/support/entities/group.rb
 - spec/support/entities/hero_user.rb
 - spec/support/entities/role.rb
 - spec/support/entities/user.rb
+- spec/support/monkey_patches/database_cleaner.rb
 - spec/support/repositories/active_record/comment_repository.rb
 - spec/support/repositories/active_record/group_repository.rb
 - spec/support/repositories/active_record/role_repository.rb
@@ -409,5 +425,7 @@ test_files:
 - spec/support/shared/contexts.rb
 - spec/support/tables/active_record.rb
 - spec/support/tables/sequel.rb
+- spec/unit/entity/composable_spec.rb
+- spec/unit/entity/relation_spec.rb
 - spec/unit/repository/query_method_spec.rb
 has_rdoc: