datamappify 0.70.0.beta1 → 0.70.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42a1f0451b17ea3e731eab36334ca301d2f82c54
-  data.tar.gz: fe1e60e36f3c5885829e0b3e109e1c6ae799572d
+  metadata.gz: b8b5c9791648cd0a93b4a98014a63d37830b40bd
+  data.tar.gz: 24be82a4d65be38dd1097fdeed79d1176e25b66a
 SHA512:
-  metadata.gz: 32641a2d06c6f2eb8281422edee1e292bb414c932266fcf04b0fd4fa7b59ddb75ae370c4d30295fd08d4b84f5f555c8208efe0a43bdfe1847d3b7051976f9b81
-  data.tar.gz: 12f10eda25ac22872ca671ef411531709448d547822bad740ca822ac306c2958cebf788cd6749c64ec28300c7919356abddf70a6d86b424b518646c0c649c1c1
+  metadata.gz: f3dea093938a3ad30b10fb5b84456d7716c6376e2a4a653f472783b6268311bdd9e47cf8b227263b76eded63e48b94ad48cea35e9ca5aeb118a8c17d6f5af4f4
+  data.tar.gz: 631134bfc10968a87b3c9c219c56107a3c030e3481d12bf8c736ed98d9a87a182024386fbc43e83b0e5dc03151b25fc7bf6abd36027ab58ed25df97e2ce0fd7f

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master
 
+## 0.70.0.beta2 [2013-10-22]
+
+- Proper dirty tracking in record updating, fixes an issue of setting an attribute to `nil`.
+- Added `has_one` association.
+- Added `before_load`, `after_load`, `before_find` and `after_find` callbacks.
+- Added `before_init` and `after_init` callbacks.
+- Added `offset` argument to the `limit` criteria.
+- Added support for Kaminari pagination.
+
 ## 0.70.0.beta1 [2013-09-26]
 
 - Fixed dirty tracking for entities returned from `where` and `all`.

data/README.md

@@ -319,7 +319,7 @@ users = UserRepository.criteria(
   :order => {
     :last_name => :asc
   },
-  :limit => 10
+  :limit => [10, 20]
 )
 ```
 
@@ -328,7 +328,7 @@ Currently implemented criteria options:
 - where(Hash)
 - match(Hash)
 - order(Hash)
-- limit(Integer)
+- limit(Array<limit(Integer), offset(Integer)>)
 
 _Note: it does not currently support searching attributes from different data providers._
 
@@ -380,14 +380,30 @@ Note that due to the attributes mapping, any data found in mapped records are no
 UserRepository.destroy(user)
 ```
 
+#### Initialising an entity
+
+Accepts an entity class and returns a new entity.
+
+This is useful for using `before_init` and `after_init` callbacks to set up the entity.
+
+```ruby
+UserRepository.init(user_class) #=> user
+```
+
 #### Callbacks
 
 Datamappify supports the following callbacks via [Hooks](https://github.com/apotonick/hooks):
 
+- before_init
+- before_load
+- before_find
 - before_create
 - before_update
 - before_save
 - before_destroy
+- after_init
+- after_load
+- after_find
 - after_create
 - after_update
 - after_save
@@ -427,7 +443,8 @@ Note: Returning either `nil` or `false` from the callback will cancel all subseq
 
 Datamappify also supports entity association. It is experimental and it currently supports the following association types:
 
-- belongs_to
+- belongs_to (partially implemented)
+- has_one
 - has_many
 
 Set up your entities and repositories:
@@ -438,9 +455,16 @@ Set up your entities and repositories:
 class User
   include Datamappify::Entity
 
+  has_one  :title, :via => Title
   has_many :posts, :via => Post
 end
 
+class Title
+  include Datamappify::Entity
+
+  belongs_to :user
+end
+
 class Post
   include Datamappify::Entity
 
@@ -454,9 +478,16 @@ class UserRepository
 
   for_entity User
 
+  references :title, :via => TitleRepository
   references :posts, :via => PostRepository
 end
 
+class TitleRepository
+  include Datamappify::Repository
+
+  for_entity Title
+end
+
 class PostRepository
   include Datamappify::Repository
 
@@ -470,10 +501,12 @@ Usage examples:
 new_post         = Post.new(post_attributes)
 another_new_post = Post.new(post_attributes)
 user             = UserRepository.find(1)
+user.title       = Title.new(title_attributes)
 user.posts       = [new_post, another_new_post]
 
 persisted_user   = UserRepository.save!(user)
 
+persisted_user.title #=> associated title
 persisted_user.posts #=> an array of associated posts
 ```
 
@@ -503,6 +536,25 @@ Datamappify.config do |c|
 end
 ```
 
+### Built-in extensions
+
+Datamappify ships with a few extensions to make certain tasks easier.
+
+#### Kaminari
+
+Use `Criteria` with `page` and `per`.
+
+```ruby
+UserRepository.criteria(
+  :where => {
+    :gender => 'male',
+    :age    => 42
+  },
+  :page => 1,
+  :per  => 10
+)
+```
+
 ## API Documentation
 
 - [Rubygem release version](http://rubydoc.info/gems/datamappify/frames)

data/datamappify.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "virtus",      ">= 1.0.0.beta6", "< 2.0"
+  spec.add_dependency "virtus",      "~> 1.0.0"
   spec.add_dependency "activemodel", "~> 4.0.0"
   spec.add_dependency "hooks",       "~> 0.3.0"
 
@@ -28,11 +28,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-stack_explorer"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "cane"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "sequel"
   spec.add_development_dependency "activerecord",     "~> 4.0.0"
-  spec.add_development_dependency "database_cleaner", "~> 1.0.1"
+  spec.add_development_dependency "kaminari"
+  spec.add_development_dependency "database_cleaner", "~> 1.2.0"
 end

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

@@ -2,7 +2,13 @@ module Datamappify
   module Data
     module Criteria
       module ActiveRecord
-        class Limit < Relational::Limit
+        class Limit < Common
+          def records(scope = nil)
+            limit, offset = criteria
+            offset ||= 0
+
+            (scope || source_class).limit(limit).offset(offset)
+          end
         end
       end
     end

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

@@ -15,7 +15,13 @@ module Datamappify
           end
 
           def save(record)
-            record.update_attributes attributes_and_values
+            sanitise_attributes!(record)
+
+            record.update_attributes(attributes_and_values) unless ignore?
+          end
+
+          def sanitise_attributes!(record)
+            attributes_and_values.delete_if { |_, v| v.nil? } if record.new_record?
           end
         end
       end

data/lib/datamappify/data/criteria/common.rb

@@ -138,13 +138,13 @@ module Datamappify
 
         private
 
-        # Ignores the attribute if it isn't dirty or if it's a primary key
-        #
-        # @todo implement proper dirty attribute tracking
+        # Ignores the attribute accordingly
         #
         # @return [Boolean]
         def ignore_attribute?(attribute)
-          entity.send(attribute.name).nil? || attribute.primary_key?
+          unless new_record? || entity.lazy_loaded?
+            !options[:dirty_attributes].include?(attribute.key)
+          end
         end
       end
     end

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

@@ -1,10 +1,12 @@
+require 'datamappify/data/criteria/relational/criteria'
+
 module Datamappify
   module Data
     module Criteria
       module Relational
-        class Count < Common
+        class Count < Criteria
           def perform
-            source_class.count
+            (records || source_class).count
           end
         end
       end

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

@@ -2,7 +2,10 @@ module Datamappify
   module Data
     module Criteria
       module Sequel
-        class Limit < Relational::Limit
+        class Limit < Common
+          def records(scope = nil)
+            (scope || source_class).limit(*criteria)
+          end
         end
       end
     end

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

@@ -15,7 +15,13 @@ module Datamappify
           end
 
           def save(record)
-            record.update attributes_and_values
+            sanitise_attributes!(record)
+
+            record.update(attributes_and_values) unless ignore?
+          end
+
+          def sanitise_attributes!(record)
+            attributes_and_values.delete_if { |_, v| v.nil? } if record.new?
           end
         end
       end

data/lib/datamappify/entity/association.rb

@@ -28,6 +28,17 @@ module Datamappify
           references name
         end
 
+        # @param name [Symbol, String]
+        #
+        # @param options [Hash]
+        #
+        # @return [void]
+        def has_one(name, options = {})
+          attribute name, options[:via]
+
+          self.associations << name
+        end
+
         # @param name [Symbol, String]
         #
         # @param options [Hash]

data/lib/datamappify/entity/association/validation.rb

@@ -32,7 +32,7 @@ module Datamappify
         # @return [void]
         def aggregate_validation_errors(context)
           self.associations.each do |association|
-            self.send(association).reject(&:destroy?).each do |entity|
+            Array.wrap(self.send(association)).reject(&:destroy?).each do |entity|
               entity.invalid?(context) && referenced_entity_validation_errors(entity)
             end
           end

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

@@ -8,6 +8,8 @@ module Datamappify
 
         def self.included(klass)
           klass.class_eval do
+            extend ClassMethods
+
             attribute :_destroy, Virtus::Attribute::Boolean, :default => false
           end
         end
@@ -16,6 +18,17 @@ module Datamappify
         def destroy?
           !!_destroy
         end
+
+        module ClassMethods
+          # a minimal compatibility implementation needed by nested_form
+          #
+          # @see: https://github.com/ryanb/nested_form/blob/68485d/lib/nested_form/builder_mixin.rb#L28
+          def reflect_on_association(association)
+            if member_type = self.attribute_set.detect { |a| a.name == association }.try(:member_type)
+              Struct.new(:klass).new(member_type.primitive)
+            end
+          end
+        end
       end
     end
   end

data/lib/datamappify/entity/compatibility/association/active_record.rb

@@ -3,10 +3,26 @@ module Datamappify
     module Compatibility
       module Association
         # Compatibility layer for ActionRecord
+        #
+        # adds `association_name_attributes` as required by nested attributes assignment
         module ActiveRecord
-          # Adds `association_name_attributes` as required by
-          # nested attributes assignment
-          #
+          # @param (see DSL#has_one)
+          def has_one(name, options = {})
+            super
+
+            self.class_eval <<-CODE, __FILE__, __LINE__ + 1
+              def #{name}_attributes=(params = {})
+                params.delete('id') if params['id'].blank?
+
+                if self.#{name}
+                  params['id'] = self.#{name}.id
+                end
+
+                self.#{name} = #{options[:via]}.new(params)
+              end
+            CODE
+          end
+
           # @param (see DSL#has_many)
           def has_many(name, options = {})
             super

data/lib/datamappify/entity/composable/attributes.rb

@@ -37,7 +37,7 @@ module Datamappify
               attribute.name
             end
 
-            Virtus::Attribute.build(attribute.type, attribute.options.merge(:name => attribute_name))
+            attribute.rename(attribute_name)
           end
         end
       end

data/lib/datamappify/extensions/kaminari/collection_methods.rb

@@ -0,0 +1,16 @@
+module Datamappify
+  module Extensions
+    module Kaminari
+      module CollectionMethods
+        def self.included(klass)
+          klass.class_eval do
+            include ::Kaminari::ConfigurationMethods::ClassMethods
+            include ::Kaminari::PageScopeMethods
+
+            attr_accessor :limit_value, :offset_value, :total_count
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/extensions/kaminari/criteria_processor.rb

@@ -0,0 +1,36 @@
+require 'datamappify/extensions/kaminari/collection_methods'
+
+module Datamappify
+  module Extensions
+    module Kaminari
+      module CriteriaProcessor
+        # @see (Repository::QueryMethods#criteria)
+        def criteria(criteria)
+          process_criteria!(criteria)
+
+          collection = super
+
+          collection.class_eval { include CollectionMethods }
+
+          collection.limit_value  = @limit
+          collection.offset_value = @offset
+          collection.total_count  = count(criteria.except(:limit))
+
+          collection
+        end
+
+        private
+
+        # @see (Repository::QueryMethods#criteria)
+        def process_criteria!(criteria)
+          if (page = criteria.delete(:page).try(:to_i)) && (per = criteria.delete(:per).try(:to_i))
+            @limit  = per
+            @offset = ([page, 1].max - 1) * per
+
+            criteria[:limit] = [@limit, @offset]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/lazy/attributes_handler.rb

@@ -111,9 +111,9 @@ module Datamappify
             :attributes       => attributes,
             :dirty_aware?     => true,
             :dirty_attributes => []
-          }).execute do |provider_name, source_class, attributes|
+          }).execute do |provider_name, source_class, options|
             entity.repository.data_mapper.provider(provider_name).build_criteria(
-              :FindByKey, source_class, entity, attributes
+              :FindByKey, source_class, entity, options[:attributes]
             )
           end
         end

data/lib/datamappify/repository.rb

@@ -1,3 +1,8 @@
+begin
+  require 'kaminari'
+rescue LoadError
+end
+
 require 'datamappify/repository/lazy_checking'
 require 'datamappify/repository/mapping_dsl'
 require 'datamappify/repository/unit_of_work'
@@ -51,6 +56,10 @@ module Datamappify
           def_delegators :instance, *QueryMethods.instance_methods
         end
       end
+
+      def method_missing(symbol, *args, &block)
+        instance.send(symbol, *args, &block)
+      end
     end
   end
 end