datamappify 0.60.0 → 0.70.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7fa8132e32a3dec1dd746263e0df0eff57b5448
-  data.tar.gz: 7536658c8651e4f89cb6ff9021dcfe7107bc59ca
+  metadata.gz: 42a1f0451b17ea3e731eab36334ca301d2f82c54
+  data.tar.gz: fe1e60e36f3c5885829e0b3e109e1c6ae799572d
 SHA512:
-  metadata.gz: 51787e716646495a2ccff4474e783805ad8e81d1a1de59f3600c0b2b9a3a89e509eb56016fd0f9728ee8310a14fb8fbde2e72f28b9346c193a8a7a2247b6716c
-  data.tar.gz: 421115bd3c70db49fefe9a136ba9caedce4357d6e921e37c53533d350481a6f71e8304346c77389171451b6930ff01c4a6b998cb0fb24f0afa08c61363bee866
+  metadata.gz: 32641a2d06c6f2eb8281422edee1e292bb414c932266fcf04b0fd4fa7b59ddb75ae370c4d30295fd08d4b84f5f555c8208efe0a43bdfe1847d3b7051976f9b81
+  data.tar.gz: 12f10eda25ac22872ca671ef411531709448d547822bad740ca822ac306c2958cebf788cd6749c64ec28300c7919356abddf70a6d86b424b518646c0c649c1c1

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
 env:
   - COV=2

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## master
 
+## 0.70.0.beta1 [2013-09-26]
+
+- Fixed dirty tracking for entities returned from `where` and `all`.
+- Fixed a bug where in certain situations duplicated data records are created upon updating an entity.
+- Fixed a bug where reversed mapping option `:via` generates wrong join queries.
+- New API: Added `match` for repository.
+- Added preliminary support for composed search criteria.
+  - Added `where` as a composable criteria.
+  - Added `match` as a composable criteria.
+  - Added `limit` as a composable criteria.
+  - Added `order` as a composable criteria.
+- Added experimental support for associations.
+  - Added `reference_key` option to `map_attribute`.
+  - Added support for ActiveRecord-style attribute-nesting, e.g. `form.fields_for`.
+  - Added validation aggregation for associated entities.
+  - Added the ability to destroy associated items.
+- Performance optimisations.
+  - Refactored the way Datamappify walks attributes to allow query optimisations.
+  - Optimised ActiveRecord queries for entities.
+
 ## 0.60.0 [2013-07-23]
 
 - New API: Introduced `Datamappify.config` for configuring default behaviours.

data/README.md

@@ -27,17 +27,22 @@ Datamappify consists of three components:
 
 Below is a high level and somewhat simplified overview of Datamappify's architecture.
 
-![](http://i.imgur.com/I9GpLds.png)
+![](http://i.imgur.com/BvtEO1u.png)
 
 Note: Datamappify is NOT affiliated with the [Datamapper](https://github.com/datamapper/) project.
 
 ### Built-in ORMs for Persistence
 
-You may implement your own [data provider and criterias](lib/datamappify/data), but Datamappify comes with build-in support for the following ORMS:
+You may implement your own [data provider and criteria](lib/datamappify/data), but Datamappify comes with build-in support for the following ORMS:
 
 - ActiveRecord
 - Sequel
 
+## Requirements
+
+- ruby 2.0+
+- ActiveModel 4.0+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -205,6 +210,12 @@ class UserRepository
   #
   # this is useful for mapping form fields (similar to ActiveRecord's nested attributes)
   map_attribute :hobby_name, :to => 'Hobby#name', :via => :hobby_id
+
+  # by default, Datamappify maps attributes using an inferred reference (foreign) key,
+  # for example, the first mapping below will look for the `user_id` key in `Bio`,
+  # the second mapping below will look for the `person_id` key in `Bio` instead
+  map_attribute :bio, :to => 'Bio#body'
+  map_attribute :bio, :to => 'Bio#body', :reference_key => :person_id
 end
 ```
 
@@ -284,10 +295,41 @@ users = UserRepository.all
 
 Returns an array of entities.
 
+##### Simple
+
 ```ruby
 users = UserRepository.where(:first_name => 'Fred', :driver_license => 'AABBCCDD')
 ```
 
+##### Match
+
+```ruby
+users = UserRepository.match(:first_name => 'Fre%', :driver_license => '%bbcc%')
+```
+
+##### Advanced
+
+You may compose search criteria via the `criteria` method.
+
+```ruby
+users = UserRepository.criteria(
+  :where => {
+    :first_name => 'Fred'
+  },
+  :order => {
+    :last_name => :asc
+  },
+  :limit => 10
+)
+```
+
+Currently implemented criteria options:
+
+- where(Hash)
+- match(Hash)
+- order(Hash)
+- limit(Integer)
+
 _Note: it does not currently support searching attributes from different data providers._
 
 #### Saving/updating entities
@@ -381,6 +423,76 @@ end
 
 Note: Returning either `nil` or `false` from the callback will cancel all subsequent callbacks (and the action itself, if it's a `before_` callback).
 
+### Association
+
+Datamappify also supports entity association. It is experimental and it currently supports the following association types:
+
+- belongs_to
+- has_many
+
+Set up your entities and repositories:
+
+```ruby
+# entities
+
+class User
+  include Datamappify::Entity
+
+  has_many :posts, :via => Post
+end
+
+class Post
+  include Datamappify::Entity
+
+  belongs_to :user
+end
+
+# repositories
+
+class UserRepository
+  include Datamappify::Repository
+
+  for_entity User
+
+  references :posts, :via => PostRepository
+end
+
+class PostRepository
+  include Datamappify::Repository
+
+  for_entity Post
+end
+```
+
+Usage examples:
+
+```ruby
+new_post         = Post.new(post_attributes)
+another_new_post = Post.new(post_attributes)
+user             = UserRepository.find(1)
+user.posts       = [new_post, another_new_post]
+
+persisted_user   = UserRepository.save!(user)
+
+persisted_user.posts #=> an array of associated posts
+```
+
+### Nested attributes in forms
+
+Like ActiveRecord and ActionView, Datamappify also supports nested attributes via `fields_for` or `simple_fields_for`.
+
+```ruby
+# slim template
+
+= simple_form_for @post do |f|
+  = f.input :title
+  = f.input :body
+
+  = f.simple_fields_for :comment do |fp|
+    = fp.input :author_name
+    = fp.input :comment_body
+```
+
 ### Default configuration
 
 You may configure Datamappify's default behaviour. In Rails you would put it in an initializer file.
@@ -391,6 +503,11 @@ Datamappify.config do |c|
 end
 ```
 
+## API Documentation
+
+- [Rubygem release version](http://rubydoc.info/gems/datamappify/frames)
+- [Github master version](http://rubydoc.info/github/fredwu/datamappify/master/frames)
+
 ## More Reading
 
 You may check out this [article](http://fredwu.me/post/54009567748/) for more examples.
@@ -415,7 +532,7 @@ Refer to [CHANGELOG](CHANGELOG.md).
 
 - [Fred Wu](http://fredwu.me/) - author.
 - [James Ladd](http://jamesladdcode.com/) for reviewing the code and giving advice on architectural decisions.
-- [Locomote](http://www.locomote.com.au/) - where Datamappify is built and being tested in product development.
+- [Locomote](http://www.locomote.com.au/) - where Datamappify is built and used in our products.
 - And with these [awesome contributors](https://github.com/fredwu/datamappify/contributors)!
 
 ## License

data/datamappify.gemspec

@@ -18,8 +18,8 @@ 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.beta0", "<= 2.0"
-  spec.add_dependency "activemodel", ">= 4.0.0.rc1", "< 5"
+  spec.add_dependency "virtus",      ">= 1.0.0.beta6", "< 2.0"
+  spec.add_dependency "activemodel", "~> 4.0.0"
   spec.add_dependency "hooks",       "~> 0.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "sequel"
-  spec.add_development_dependency "activerecord",     ">= 4.0.0.rc1", "< 5"
+  spec.add_development_dependency "activerecord",     "~> 4.0.0"
   spec.add_development_dependency "database_cleaner", "~> 1.0.1"
 end

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

@@ -1,5 +1,3 @@
-require 'datamappify/data/criteria/relational/count'
-
 module Datamappify
   module Data
     module Criteria

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

@@ -0,0 +1,10 @@
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class Criteria < Relational::Criteria
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'datamappify/data/criteria/relational/criteria_method'
+
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class CriteriaMethod < Relational::CriteriaMethod
+          private
+
+          # @param scope [ActiveRecord::Relation]
+          #
+          # @return [ActiveRecord::Relation]
+          def records_scope(scope = nil)
+            (scope || source_class).includes(associated.map(&:association_key))
+                                   .references(associated.map(&:association_key))
+          end
+
+          # @return [Array<Attribute>]
+          def associated
+            attributes.select(&:secondary_attribute?)
+          end
+
+          # @param primaries [Array<Attribute>]
+          #
+          # @param secondaries [Array<Attribute>]
+          #
+          # @return [Hash]
+          def structured_criteria
+            _criteria = {}
+
+            primaries.each do |primary|
+              _criteria[primary.source_attribute_key] = primary.value
+            end
+
+            secondaries.each do |secondary|
+              table_alias = detect_table_alias(secondary)
+
+              _criteria[table_alias] ||= {}
+              _criteria[table_alias][secondary.source_attribute_key] = secondary.value
+            end
+
+            _criteria
+          end
+
+          # @see https://github.com/rails/rails/issues/12224
+          #
+          # @param [Attribute]
+          #
+          # @return [Symbol]
+          def detect_table_alias(attribute)
+            reflection = records_scope.send(:construct_join_dependency_for_association_find).join_parts.detect do |join|
+              join.try(:reflection).try(:name) == attribute.association_key
+            end
+
+            if reflection
+              reflection.tables[0].try(:right) || attribute.source_table
+            else
+              attribute.source_table
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,10 +1,18 @@
-require 'datamappify/data/criteria/relational/find'
+require 'datamappify/data/criteria/relational/concerns/find'
+require 'datamappify/data/criteria/active_record/criteria_method'
 
 module Datamappify
   module Data
     module Criteria
       module ActiveRecord
-        class Find < Relational::Find
+        class Find < CriteriaMethod
+          include Relational::Concerns::Find
+
+          private
+
+          def record
+            records_scope.where(criteria).first
+          end
         end
       end
     end

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

@@ -1,10 +1,12 @@
-require 'datamappify/data/criteria/relational/find_by_key'
+require 'datamappify/data/criteria/relational/concerns/find_by_key'
+require 'datamappify/data/criteria/active_record/find'
 
 module Datamappify
   module Data
     module Criteria
       module ActiveRecord
-        class FindByKey < Relational::FindByKey
+        class FindByKey < Find
+          include Relational::Concerns::FindByKey
         end
       end
     end

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

@@ -0,0 +1,10 @@
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class Limit < Relational::Limit
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+require 'datamappify/data/criteria/active_record/criteria_method'
+
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class Match < CriteriaMethod
+          # @param scope [ActiveRecord::Relation]
+          #
+          # @return [ActiveRecord::Relation]
+          def records(scope = nil)
+            records_scope(scope).where(string_criteria, *criteria.values)
+          end
+
+          private
+
+          # @return [String]
+          def string_criteria
+            structured_criteria.map do |column, value|
+              "lower(#{column}) LIKE lower(?)"
+            end.join(' AND ')
+          end
+
+          # @return [Hash]
+          def structured_criteria
+            Hash[*super.flat_map do |table, values|
+              if values.is_a?(Hash)
+                values.flat_map do |column, value|
+                  ["#{table}.#{column}", value]
+                end
+              else
+                ["#{records_scope.table.name}.#{table}", values]
+              end
+            end]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'datamappify/data/criteria/active_record/criteria_method'
+
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class Order < CriteriaMethod
+          def initialize(*args)
+            super
+
+            validate_order_args
+          end
+
+          # @param scope [ActiveRecord::Relation]
+          #
+          # @return [ActiveRecord::Relation]
+          def records(scope = nil)
+            structured_criteria.inject(records_scope(scope)) do |scope, (table, values)|
+              if values.is_a?(Hash)
+                values.inject(scope) do |s, (column, value)|
+                  s.order("#{table}.#{column} #{value}")
+                end
+              else
+                scope.order(table => values)
+              end
+            end
+          end
+
+          private
+
+          # @return [void]
+          def validate_order_args
+            unless (criteria.values - [:asc, :desc]).empty?
+              raise ArgumentError.new('Order direction should be :asc or :desc')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class Rollback < Common
+          def perform
+            raise ::ActiveRecord::Rollback
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,3 @@
-require 'datamappify/data/criteria/relational/save'
 require 'datamappify/data/criteria/concerns/update_primary_record'
 
 module Datamappify
@@ -6,7 +5,7 @@ module Datamappify
     module Criteria
       module ActiveRecord
         class Save < Relational::Save
-          include Concerns::UpdatePrimaryRecord
+          prepend Concerns::UpdatePrimaryRecord
 
           private
 
@@ -17,8 +16,6 @@ module Datamappify
 
           def save(record)
             record.update_attributes attributes_and_values
-
-            super
           end
         end
       end

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

@@ -1,4 +1,3 @@
-require 'datamappify/data/criteria/relational/save_by_key'
 require 'datamappify/data/criteria/active_record/save'
 
 module Datamappify

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

@@ -0,0 +1,18 @@
+require 'datamappify/data/criteria/active_record/criteria_method'
+
+module Datamappify
+  module Data
+    module Criteria
+      module ActiveRecord
+        class Where < CriteriaMethod
+          # @param scope [ActiveRecord::Relation]
+          #
+          # @return [ActiveRecord::Relation]
+          def records(scope = nil)
+            records_scope(scope).where(structured_criteria)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -32,6 +32,9 @@ module Datamappify
           @source_class = source_class
           @entity, @criteria, @attributes, @options = *args
           @block = block
+
+          @criteria ||= {}
+          @options  ||= {}
         end
 
         # Performs the action (defined by child method classes) with callbacks
@@ -76,7 +79,7 @@ module Datamappify
         #
         # @return [Symbol]
         def key_name
-          primary_record? ? :id : any_attribute.primary_reference_key
+          primary_record? || options[:via] ? :id : any_attribute.reference_key
         end
 
         # The value of {#key_name}
@@ -111,7 +114,7 @@ module Datamappify
         #
         # @return [Boolean]
         def ignore?
-          attributes_and_values.empty?
+          attributes_and_values.empty? && !primary_record?
         end
 
         # Stores the attribute value in {Mapper::Attribute} for later use

data/lib/datamappify/data/criteria/concerns/update_primary_record.rb

@@ -6,6 +6,8 @@ module Datamappify
           private
 
           def save(record)
+            super
+
             if options && options[:via] && options[:primary_record]
               update_primary_record_with(record)
             end

data/lib/datamappify/data/criteria/relational/concerns/find.rb

@@ -0,0 +1,35 @@
+module Datamappify
+  module Data
+    module Criteria
+      module Relational
+        module Concerns
+          module Find
+            def perform
+              record = records_scope.where(criteria).first
+
+              update_entity_with(record) if record
+
+              record
+            end
+
+            private
+
+            def update_entity_with(record)
+              attributes.each do |attribute|
+                if attribute.secondary_attribute? || attribute.reverse_mapped?
+                  update_entity_attribute_with(attribute, record.send(attribute.association_key))
+                else
+                  update_entity_attribute_with(attribute, record)
+                end
+              end
+            end
+
+            def update_entity_attribute_with(attribute, record)
+              entity.send("#{attribute.name}=", record.send(attribute.source_attribute_name)) if record
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datamappify/data/criteria/relational/concerns/find_by_key.rb

@@ -0,0 +1,19 @@
+require 'datamappify/data/criteria/relational/concerns/set_criteria'
+
+module Datamappify
+  module Data
+    module Criteria
+      module Relational
+        module Concerns
+          module FindByKey
+            include SetCriteria
+
+            def initialize(source_class, entity, attributes, options = {}, &block)
+              super(source_class, entity, nil, attributes, options, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'datamappify/data/criteria/relational/criteria_base_method'
+
+module Datamappify
+  module Data
+    module Criteria
+      module Relational
+        class Criteria < CriteriaBaseMethod
+          # @return
+          #   a collection represents the records, e.g. `ActiveRecord::Relation` or `Sequel::DataSet`
+          def records
+            criteria.inject(nil) do |scope, (name, method_criteria)|
+              criteria_class(name).new(
+                source_class, entity, method_criteria, attributes, options
+              ).records(scope)
+            end
+          end
+
+          private
+
+          # @return [Class]
+          #   the criteria class, e.g. `Where` or `Limit`
+          def criteria_class(name)
+            self.class.name.deconstantize.constantize.const_get(name.to_s.classify)
+          end
+        end
+      end
+    end
+  end
+end