flatter 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8c9d3f37b6dfdb2b990df2a47c1682af45a526b
-  data.tar.gz: 83e78ea63b40fcbceea19a6f940f97747a00bd2f
+  metadata.gz: 542b10f00cb2f869988def6cd621cf3c6588c50f
+  data.tar.gz: 482d1248aa1204fe7831898ac84e98214d961673
 SHA512:
-  metadata.gz: bed580ee036c3d9a21ce0c24e293e4472f0664ae6d4f8acbd93cb8a2cbdf8018cf5e5a3e4b5a873e1a7c8cd799ae2a3c100c5bd865792e8141e44c37f063a830
-  data.tar.gz: 8463c12d806db30ad17305ceaaf3b9493e65b9074fff674e21e5b2a3fcfc22f3427d6bfc8f7f73991dbe81fa3cfc96e65806d6b387a3156dbcfd0ef6b86b46f9
+  metadata.gz: 3b9a7a0eb25675f0402768233e990e854f2a73bb6473af393e575434134002041e3257a74b150f262290e5c38c4e9ba8a0b42f6ee291d6e02505402e089c11e8
+  data.tar.gz: 182d1f6281a6713f07271a7533db99c56b777f479ed527a1d719398f999992d92a29a9ffeff5ce99ca536b6ce0c5bc8f5eb7a180e6c9bcd3eb2c4caaf40749b8

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.2.2
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -163,6 +163,13 @@ Mappers include `ActiveModel::Validation` module and thus support `ActiveSupport
 callbacks. Additionally, `:save` callbacks have been defined for `Flatter::Mapper`,
 so you can do something like `set_callback :save, :after, :send_invitation`.
 
+### Mapper and Target Validations
+
+If mapper's target responds to `valid?` method, it will be called upon mapper's
+validation. If target is invalid, mapper will receive `:target, :invalid` error.
+Additionally, all target's errors on attributes that have declared mapping will
+be consolidated with mapper's errors.
+
 ### Traits
 
 Traits are another powerful mapper ability. Traits allow to encapsulate named sets
@@ -602,9 +609,10 @@ mapper.errors.messages # =>
 
 ### Extensions
 
-Aside from core functionality and behavior defined in this gem, there is also
-[flatter-extensions](https://github.com/akuzko/flatter-extensions) gem that
-provides extensions to help you use mappers more efficiently. At this point there
+Aside from core functionality and behavior described above, there is also
+number of handy [extensions](https://github.com/akuzko/flatter/wiki/Extensions)
+(which originally were hosted in their own gem, but now are the part of the flatter)
+that have aim to help you use mappers more efficiently. At this point there
 are following extensions:
 
 - `:multiparam` Allows you to define multiparam mappings by adding `:multiparam`

data/flatter.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 3.2"
   spec.add_dependency "activemodel", ">= 3.0"
 
+  spec.add_development_dependency "activerecord", ">= 3.2"
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/flatter/extensions/active_record.rb

@@ -0,0 +1,160 @@
+module Flatter::Extensions
+  module ActiveRecord
+    extend ::Flatter::Extension
+
+    register_as :active_record
+
+    hooked do
+      Flatter::Mapper::Collection::Concern.module_eval do
+        alias build_collection_item_without_ar build_collection_item
+
+        def build_collection_item
+          return build_collection_item_without_ar unless mounter!.try(:ar?)
+
+          mounter!.target.association(name.to_sym).try(:build) ||
+            build_collection_item_without_ar
+        end
+      end
+    end
+
+    factory.extend do
+      def default_target_from(mapper)
+        return super unless mapper.ar?
+
+        target_from_association(mapper.target) || super
+      end
+      private :default_target_from
+
+      def target_from_association(target)
+        reflection = reflection_from_target(target)
+
+        return unless reflection.present?
+
+        case reflection.macro
+        when :has_one, :belongs_to
+          target.public_send(name) || target.public_send("build_#{name}")
+        when :has_many
+          association = target.association(reflection.name)
+          collection? ? association.load_target : association.build
+        end
+      end
+      private :target_from_association
+
+      def reflection_from_target(target)
+        target_class = target.class
+        reflection   = target_class.reflect_on_association(name.to_sym)
+        reflection || target_class.reflect_on_association(name.pluralize.to_sym)
+      end
+      private :reflection_from_target
+    end
+
+    mapper.add_options :foreign_key, :mounter_foreign_key do
+      extend ActiveSupport::Concern
+      attr_reader :ar_error
+
+      def set_target!(target)
+        super
+        add_skip_autosave_association_extension_to(target.class) if ar?
+        target
+      end
+
+      def apply(*)
+        return super unless ar?
+
+        ::ActiveRecord::Base.transaction do
+          super or raise ::ActiveRecord::Rollback
+        end
+      end
+
+      def save
+        ::ActiveRecord::Base.transaction do
+          begin
+            @ar_error = nil
+            super
+          rescue ::ActiveRecord::StatementInvalid => e
+            @ar_error = e
+            raise ::ActiveRecord::Rollback
+          end
+        end
+      end
+
+      def delete_target_item(item)
+        item.destroy! if ar?(item)
+        super
+      end
+
+      def save_target
+        return super unless ar?
+
+        assign_foreign_keys_from_mountings
+        result = target.without_association_callbacks{ target.save }
+        assign_foreign_keys_for_mountings if result
+
+        result != false
+      end
+      protected :save_target
+
+      def target_valid?
+        return super unless ar?
+        target.without_association_callbacks{ super }
+      end
+      private :target_valid?
+
+      def assign_foreign_keys_from_mountings
+        associated_mountings(:mounter_foreign_key).each do |mounting|
+          target[mounting.mounter_foreign_key] ||= mounting.target.id
+        end
+      end
+      private :assign_foreign_keys_from_mountings
+
+      def assign_foreign_keys_for_mountings
+        associated_mountings(:foreign_key).each do |mounting|
+          mounting.target[mounting.foreign_key] ||= target.id
+        end
+      end
+      private :assign_foreign_keys_for_mountings
+
+      def associated_mountings(key)
+        root_mountings.select do |mounting|
+          mounter = mounting.mounter
+          mounter = mounter.mounter if mounter.trait?
+          mounting.options.key?(key) && mounter == self
+        end
+      end
+      private :associated_mountings
+
+      def add_skip_autosave_association_extension_to(klass)
+        return if klass.const_defined?('SkipAutosaveAssociationExtension')
+
+        klass.const_set('SkipAutosaveAssociationExtension', skip_autosave_association_extension_for(klass))
+        klass.send(:prepend, klass::SkipAutosaveAssociationExtension)
+      end
+      private :add_skip_autosave_association_extension_to
+
+      def skip_autosave_association_extension_for(klass)
+        association_autosave_methods = klass.instance_methods.grep(/autosave_associated_records_for_/)
+        association_validation_methods = klass.instance_methods.grep(/validate_associated_records_for_/)
+
+        Module.new do
+          (association_autosave_methods + association_validation_methods).each do |name|
+            define_method(name) do
+              @skip_association_callbacks || super()
+            end
+          end
+
+          def without_association_callbacks
+            @skip_association_callbacks = true
+            yield
+          ensure
+            remove_instance_variable('@skip_association_callbacks')
+          end
+        end
+      end
+      private :skip_autosave_association_extension_for
+
+      def ar?(object = target)
+        object.class < ::ActiveRecord::Base
+      end
+    end
+  end
+end

data/lib/flatter/extensions/multiparam.rb

@@ -0,0 +1,51 @@
+module Flatter::Extensions
+  module Multiparam
+    extend ::Flatter::Extension
+
+    register_as :multiparam
+
+    mapping.add_option :multiparam do
+      def write(value)
+        return super unless multiparam?
+
+        write!(multiparam.new(*value))
+      end
+    end
+
+    mapper.extend do
+      def write(params)
+        extract_multiparams!(params)
+
+        super(params)
+      end
+
+      def extract_multiparams!(params)
+        return super if collection?
+
+        local_mappings.each do |mapping|
+          next unless mapping.multiparam?
+
+          param_keys = params.keys.
+            select{ |key| key.to_s =~ /#{mapping.name}\(\d+[if]\)/ }.
+            sort_by{ |key| key.to_s[/\((\d+).*\)/, 1].to_i }
+
+          next if param_keys.empty?
+
+          args = param_keys.each_with_object([]) do |key, values|
+            value = params.delete key
+            type  = key[/\(\d+([if]*)\)/, 1]
+
+            value = if value.present?
+              type.blank? ? value : value.send("to_#{type}")
+            end
+
+            values.push value
+          end
+
+          params[mapping.name] = args
+        end
+      end
+      private :extract_multiparams!
+    end
+  end
+end

data/lib/flatter/extensions/order.rb

@@ -0,0 +1,32 @@
+module Flatter::Extensions
+  module Order
+    extend ::Flatter::Extension
+
+    register_as :order
+
+    mapping.add_option :index do
+      def index
+        options[:index] || 0
+      end
+    end
+
+    mapper.add_option :index do
+      def index
+        options[:index] || 0
+      end
+
+      def local_mappings
+        @_local_mappings ||= super.sort_by(&:index)
+      end
+      protected :local_mappings
+
+      def mappers_chain(context)
+        super.sort_by do |mapper|
+          index = mapper.index
+          index.is_a?(Hash) ? (index[context] || 0) : index
+        end
+      end
+      private :mappers_chain
+    end
+  end
+end

data/lib/flatter/extensions/skipping.rb

@@ -0,0 +1,56 @@
+module Flatter::Extensions
+  module Skipping
+    extend ::Flatter::Extension
+
+    register_as :skipping
+
+    hooked do
+      ::Flatter::Mapper::Collection.module_eval do
+        alias extract_data_without_reject extract_data
+
+        def extract_data(params)
+          extract_data_without_reject(params).tap do |data|
+            data.reject!{ |params| reject_if[params] } if reject_if?
+          end
+        end
+      end
+    end
+
+    mapper.add_options :skip_if, :reject_if do
+      extend ActiveSupport::Concern
+
+      included do
+        set_callback :validate, :before, :ignore_skipped_mountings
+      end
+
+      def run_validations!
+        if skipped?
+          errors.clear
+          true
+        else
+          super
+        end
+      end
+
+      def run_save!
+        skipped? ? true : super
+      end
+
+      def skip!
+        collection.each(&:skip!) if collection?
+        @skipped = true
+      end
+
+      def skipped?
+        !!@skipped
+      end
+
+      def ignore_skipped_mountings
+        local_mountings.each do |mapper|
+          mapper.skip! if mapper.skip_if? && instance_exec(&mapper.skip_if)
+        end
+      end
+      private :ignore_skipped_mountings
+    end
+  end
+end

data/lib/flatter/extensions.rb

@@ -0,0 +1,7 @@
+require 'flatter/extensions/multiparam'
+require 'flatter/extensions/order'
+require 'flatter/extensions/skipping'
+
+if defined? ActiveRecord
+  require 'flatter/extensions/active_record'
+end

data/lib/flatter/mapper/validation.rb

@@ -0,0 +1,27 @@
+module Flatter
+  module Mapper::Validation
+    extend ActiveSupport::Concern
+
+    included do
+      validate :target_validation
+    end
+
+    def target_validation
+      return if target_valid?
+
+      errors.add(:target, :invalid)
+
+      local_mappings.each do |mapping|
+        target.errors[mapping.target_attribute].each do |message|
+          errors.add(mapping.name, message)
+        end
+      end
+    end
+    private :target_validation
+
+    def target_valid?
+      !target.respond_to?(:valid?) || target.valid?
+    end
+    private :target_valid?
+  end
+end

data/lib/flatter/mapper.rb

@@ -9,6 +9,7 @@ module Flatter
     autoload :Traits
     autoload :Target
     autoload :AttributeMethods
+    autoload :Validation
     autoload :Persistence
     autoload :ModelName
     autoload :Collection
@@ -21,6 +22,7 @@ module Flatter
     include Target
     include AttributeMethods
     include ActiveModel::Validations
+    include Validation
     include Persistence
     prepend ModelName
     prepend Collection

data/lib/flatter/version.rb

@@ -1,3 +1,3 @@
 module Flatter
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/lib/flatter.rb

@@ -28,3 +28,5 @@ module Flatter
     modules.each{ |mod| klass.send(:include, mod) }
   end
 end
+
+require 'flatter/extensions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flatter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Artem Kuzko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-05 00:00:00.000000000 Z
+date: 2017-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +193,11 @@ files:
 - lib/flatter/extension/mapper.rb
 - lib/flatter/extension/mapping.rb
 - lib/flatter/extension/registrar.rb
+- lib/flatter/extensions.rb
+- lib/flatter/extensions/active_record.rb
+- lib/flatter/extensions/multiparam.rb
+- lib/flatter/extensions/order.rb
+- lib/flatter/extensions/skipping.rb
 - lib/flatter/mapper.rb
 - lib/flatter/mapper/attribute_methods.rb
 - lib/flatter/mapper/collection.rb
@@ -176,6 +209,7 @@ files:
 - lib/flatter/mapper/persistence.rb
 - lib/flatter/mapper/target.rb
 - lib/flatter/mapper/traits.rb
+- lib/flatter/mapper/validation.rb
 - lib/flatter/mapper/write_with_indifferent_access.rb
 - lib/flatter/mapping.rb
 - lib/flatter/mapping/factory.rb