HornsAndHooves-flat_map 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 23416b70e99b971920d90bd08042a9eb6546c491
-  data.tar.gz: 3cbae8bc6cae945dcddf3227747c01f2828661a4
+SHA256:
+  metadata.gz: 4db8b5781fc2f7f28c54c20e3700d40c9b10f32e6cdb19d37a208a3bfc717f7a
+  data.tar.gz: e8af14f2b65a782da9c337f6121902b66bcf26e2168d6a4cfc3bacbc8a300323
 SHA512:
-  metadata.gz: 7842dba339d91147a548440e9fe725a6646349854f59c1723e3683bef6fde7a2b6c956bf550496331dcf378e4281b0264f7530355d94caef59ffcf62715feaae
-  data.tar.gz: 848349e424a794e646cedee5e1ac3cdfc23129bd695d61914222ff1a29fe41079f54284f1f632fabe4f866bb28f4d1e69092f83ca52222716b20f3dacdb086e9
+  metadata.gz: 3467cd650843ef17dac92e7ae48ddfcae67fee7ce459cfe11f86fc814f09f1d325e1173c1c38aea454cfdfafc0dde3b4336013d827b31ed3cfd50bf06c5e87a9
+  data.tar.gz: 027eeff4f646833fcafd9efeefa0efee4c11b9b93d523a82d407c6ca905d920f497f0283fe69282cfe8d372fd3255655b8d5d5208a37b729c4afa29c63886afd

data/.ruby-version

@@ -1 +1 @@
-2.2
+2.6.6

data/Gemfile

@@ -3,19 +3,16 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in flat_map.gemspec
 gemspec
 
-group :development do
-  gem 'redcarpet'
-  gem 'yard'
-end
+gem "activerecord"
+gem "activesupport"
 
-group :development, :test do
-  # code metrics:
-  gem "metric_fu"
-  gem "pry"
-end
+gem 'redcarpet'
+gem 'yard'
 
-group :test do
-  gem 'colorize'           , :require => false
-  gem 'simplecov'          , :require => false
-  gem 'simplecov-rcov-text', :require => false
-end
+# code metrics:
+gem "metric_fu"
+gem "pry"
+
+gem 'colorize'           , :require => false
+gem 'simplecov'          , :require => false
+gem 'simplecov-rcov-text', :require => false

data/HornsAndHooves-flat_map.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_dependency(%q<activesupport>, ["~> 4.2"])
-  s.add_dependency(%q<activerecord>, ["~> 4.2"])
-  s.add_dependency(%q<yard>, [">= 0"])
+  s.add_dependency "activesupport", ">= 5", "< 7.0.0"
+  s.add_dependency "activerecord", ">= 5", "< 7.0.0"
+  s.add_dependency "yard"
 
-  s.add_development_dependency "rspec", ['~> 3.5']
+  s.add_development_dependency "rspec", '~> 3.5'
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "rake"
 end

data/lib/flat_map/model_mapper/associations.rb

@@ -0,0 +1,148 @@
+module FlatMap
+  # This module enhances and modifies original FlatMap::OpenMapper::Persistence
+  # functionality for ActiveRecord models as targets.
+  module ModelMapper::Associations
+    extend ActiveSupport::Concern
+
+    # Raised when there is no active record association between models.
+    class AssociationError < StandardError; end
+
+    # ModelMethods class macros
+    module ClassMethods
+      # Build relation for given traits.
+      # Allows to create relation which loads data from all tables related to given traits.
+      # For example:
+      #
+      # class CommentMapper < FlatMap::ModelMapper
+      # end
+      #
+      # class ArticleMapper < FlatMap::ModelMapper
+      #   trait :with_comments do
+      #     mount :comments, mapper_class: CommentMapper
+      #   end
+      # end
+      #
+      # Following call:
+      # ArticleMapper.relation(%i[with_comments]).where(...)
+      #
+      # is same as:
+      # Article.includes(:comments).where(...)
+      #
+      #
+      # @param traits [Array<Symbol>]
+      # @return [ActiveRecord::Relation]
+      def relation(traits)
+        trait_associations = associations(traits)
+        target_class.includes(trait_associations).references(trait_associations)
+      end
+
+      # Return associations list for given traits based on current mapper mounting.
+      # This method allows to receive associations list for given traits.
+      # Then associations list could be used as parameters for .joins method
+      # to build active record relation to select data form tables related to traits.
+      # For example:
+      #
+      # class AuthorMapper < FlatMap::ModelMapper
+      # end
+      #
+      # class TagMapper < FlatMap::ModelMapper
+      # end
+      #
+      # class CommentMapper < FlatMap::ModelMapper
+      #   trait :with_author do
+      #     mount :author, mapper_class: AuthorMapper
+      #   end
+      # end
+      #
+      # class ArticleMapper < FlatMap::ModelMapper
+      #   trait :with_comments do
+      #     mount :comments, mapper_class: CommentMapper
+      #   end
+      #
+      #   trait :with_tags do
+      #     mount :tags, mapper_class: TagMapper
+      #   end
+      # end
+      #
+      # ArticleMapper.associations(%i[ with_comments ])
+      # => :comments
+      #
+      # ArticleMapper.associations(%i[ with_tags ])
+      # => :tags
+      #
+      # ArticleMapper.associations(%i[ with_comments with_tags ])
+      # => [:comments, :tags]
+      #
+      # ArticleMapper.associations(%i[ with_comments with_author ])
+      # => { comments: :author }
+      #
+      #
+      # @param traits [Array<Symbol>]
+      # @return       [Array,Hash]
+      def associations(traits)
+        build_associations(traits, target_class, false)
+      end
+
+      # Return associations list for given traits based on current mapper mounting.
+      #
+      # @param traits       [Array<Symbol>]
+      # @param context      [ActiveRecord::Base]
+      # @param include_self [Boolean]
+      # @return             [Array,Hash]
+      protected def build_associations(traits, context, include_self)
+        classes_list = find_dependency_classes(traits)
+
+        map_classes_to_associations(context, classes_list, include_self)
+      end
+
+      # Return associations list for given traits based on current mapper mounting.
+      #
+      # @param traits [Array<Symbol>]
+      # @return       [Array<Symbol>]
+      private def find_dependency_classes(traits)
+        mountings.map do |mounting|
+          mapper_class = mounting.mapper_class
+
+          if mounting.traited?
+            mapper_class.build_associations(traits, target_class, false) if traits.include?(mounting.trait_name)
+          else
+            mapper_class.build_associations(traits, target_class, true)
+          end
+        end.compact
+      end
+
+      # Map given classes to association object names.
+      #
+      # @param context      [ActiveRecord::Base]
+      # @param classes_list [Array<ActiveRecord::Base>]
+      # @param include_self [Boolean]
+      # @return             [Symbol,Array,Hash,nil]
+      private def map_classes_to_associations(context, classes_list, include_self)
+        if classes_list.empty?
+          include_self ? association_for_class(context) : nil
+        else
+          classes_list = classes_list.first if classes_list.length == 1
+
+          include_self ? { association_for_class(context) => classes_list } : classes_list
+        end
+      end
+
+      # Return association name for target_class in given context.
+      #
+      # @param context [ActiveRecord::Base]
+      # #return        [Symbol,nil]
+      private def association_for_class(context)
+        reflection = context.reflections.find do |_, reflection|
+          reflection.klass == target_class
+        end
+
+        unless reflection
+          raise AssociationError, "No association between #{context.name} and #{target_class.name} models."
+        end
+
+        reflection.first.to_sym
+      end
+    end
+  end
+end
+

data/lib/flat_map/model_mapper/persistence.rb

@@ -19,12 +19,24 @@ module FlatMap
       # Find a record of the +target_class+ by +id+ and use it as a
       # target for a new mapper, with a list of passed +traits+ applied
       # to it.
+      # When `preload: true` option passed calls mapper `relation` method
+      # with traits list. This allows to load all related objects in one query.
       #
       # @param [#to_i] id of the record
       # @param [*Symbol] traits
       # @return [FlatMap::Mapper] mapper
       def find(id, *traits, &block)
-        new(target_class.find(id), *traits, &block)
+        options = { preload: false }
+
+        options.merge!(traits.extract_options!)
+
+        if options[:preload]
+          record = relation(traits).find(id)
+        else
+          record = target_class.find(id)
+        end
+
+        new(record, *traits, &block)
       end
 
       # Fetch a class for the target of the mapper.

data/lib/flat_map/model_mapper.rb

@@ -184,9 +184,11 @@ module FlatMap
   class ModelMapper < OpenMapper
     extend ActiveSupport::Autoload
 
+    autoload :Associations
     autoload :Persistence
     autoload :Skipping
 
+    include Associations
     include Persistence
     include Skipping
 

data/lib/flat_map/open_mapper/associations.rb

@@ -0,0 +1,19 @@
+module FlatMap
+  # This module enhances and modifies original FlatMap::OpenMapper::Persistence
+  # functionality for ActiveRecord models as targets.
+  module OpenMapper::Associations
+    extend ActiveSupport::Concern
+
+    # ModelMethods class macros
+    module ClassMethods
+      # Return association list for given traits.
+      # Used in ModelMapper.
+      #
+      # @return [nil]
+      def associations(*)
+        nil
+      end
+    end
+  end
+end
+

data/lib/flat_map/open_mapper/persistence.rb

@@ -133,7 +133,7 @@ module FlatMap
     # @return [Array<ActiveModel::Errors>]
     def consolidate_errors!
       mountings.map(&:errors).each do |errs|
-        errors.messages.merge!(errs.to_hash){ |key, old, new| old.concat(new) }
+        errors.merge!(errs)
       end
     end
     private :consolidate_errors!

data/lib/flat_map/open_mapper.rb

@@ -16,6 +16,7 @@ module FlatMap
 
     autoload :Mapping
     autoload :Mounting
+    autoload :Associations
     autoload :Traits
     autoload :Factory
     autoload :AttributeMethods
@@ -24,6 +25,7 @@ module FlatMap
 
     include Mapping
     include Mounting
+    include Associations
     include Traits
     include AttributeMethods
     include ActiveModel::Validations

data/lib/flat_map/version.rb

@@ -1,3 +1,3 @@
 module FlatMap # :nodoc:
-  VERSION = "0.4.0" # :nodoc:
+  VERSION = "0.6.0" # :nodoc:
 end

data/spec/flat_map/mapper/persistence_spec.rb

@@ -54,10 +54,21 @@ module FlatMap
     describe '.find' do
       let(:target){ PersistenceSpec::TargetClass.new('a', 'b') }
 
-      it 'should delegate to target class to find object for mapper' do
-        expect(PersistenceSpec::TargetClass).to receive(:find).with(1).and_return(target)
-        expect(PersistenceSpec::TargetClassMapper).to receive(:new).with(target, :used_trait)
-        PersistenceSpec::TargetClassMapper.find(1, :used_trait)
+      context "with preload" do
+        it 'should preload tables and find object for mapper' do
+          expect(PersistenceSpec::TargetClassMapper).to receive_message_chain(:relation, :find).
+            with([:used_trait]).with(1).and_return(target)
+          expect(PersistenceSpec::TargetClassMapper).to receive(:new).with(target, :used_trait)
+          PersistenceSpec::TargetClassMapper.find(1, :used_trait, preload: true)
+        end
+      end
+
+      context "without preload" do
+        it 'should delegate to target class to find object for mapper' do
+          expect(PersistenceSpec::TargetClass).to receive(:find).with(1).and_return(target)
+          expect(PersistenceSpec::TargetClassMapper).to receive(:new).with(target, :used_trait)
+          PersistenceSpec::TargetClassMapper.find(1, :used_trait)
+        end
       end
     end
 

data/spec/flat_map/mapper/targeting_spec.rb

@@ -54,10 +54,21 @@ module FlatMap
     describe '.find' do
       let(:target){ ModelMethodsSpec::TargetClass.new('a', 'b') }
 
-      it 'should delegate to target class to find object for mapper' do
-        expect(ModelMethodsSpec::TargetClass).to receive(:find).with(1).and_return(target)
-        expect(ModelMethodsSpec::TargetClassMapper).to receive(:new).with(target, :used_trait)
-        ModelMethodsSpec::TargetClassMapper.find(1, :used_trait)
+      context "with preload" do
+        it 'should preload tables and find object for mapper' do
+          expect(ModelMethodsSpec::TargetClassMapper).to receive_message_chain(:relation, :find).
+            with([:used_trait]).with(1).and_return(target)
+          expect(ModelMethodsSpec::TargetClassMapper).to receive(:new).with(target, :used_trait)
+          ModelMethodsSpec::TargetClassMapper.find(1, :used_trait, preload: true)
+        end
+      end
+
+      context "without preload" do
+        it 'should delegate to target class to find object for mapper' do
+          expect(ModelMethodsSpec::TargetClass).to receive(:find).with(1).and_return(target)
+          expect(ModelMethodsSpec::TargetClassMapper).to receive(:new).with(target, :used_trait)
+          ModelMethodsSpec::TargetClassMapper.find(1, :used_trait)
+        end
       end
     end
 

data/spec/flat_map/model_mapper/associations_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+module FlatMap
+  module AssociationsListSpec
+    # Simulate active record models.
+    # Only .reflections method is used.
+    Reflection = Struct.new(:klass)
+
+    class Author
+      def self.reflections; {}; end
+    end
+
+    class Link
+      def self.reflections; {}; end
+    end
+
+    class Tag
+      def self.reflections; {}; end
+    end
+
+    class Category
+      def self.reflections; {}; end
+    end
+
+    class Comment
+      # belongs_to :author
+      # has_many :links
+
+      def self.reflections
+        {
+          "author" => Reflection.new(Author),
+          "links"  => Reflection.new(Link)
+        }
+      end
+    end
+
+    class Article
+      # has_many :comments
+      # has_many :tags
+
+      def self.reflections
+        {
+          "comments" => Reflection.new(Comment),
+          "tags"     => Reflection.new(Tag)
+        }
+      end
+
+      def self.joins(associations); end
+    end
+
+    # Mappers for models.
+    class AuthorMapper < FlatMap::ModelMapper; end
+
+    class LinkMapper < FlatMap::ModelMapper; end
+
+    class TagMapper < FlatMap::ModelMapper; end
+
+    class CategoryMapper < FlatMap::ModelMapper; end
+
+    class CommentMapper < FlatMap::ModelMapper
+      trait :with_author do
+        mount :author, mapper_class: AuthorMapper
+      end
+
+      trait :with_links do
+        mount :links, mapper_class: LinkMapper
+      end
+    end
+
+    class ArticleMapper < FlatMap::ModelMapper
+      trait :with_comments do
+        mount :comments, mapper_class: CommentMapper
+      end
+
+      trait :with_tags do
+        mount :tags, mapper_class: TagMapper
+      end
+
+      trait :with_category do
+        mount :category, mapper_class: CategoryMapper
+      end
+    end
+
+    describe ".relation" do
+      let(:relation) { double }
+      subject { ArticleMapper.relation(%i[ with_comments with_author ]) }
+
+      it "generates active record relation with correct associations" do
+        expect(Article).to receive_message_chain(:includes, :references).
+          with({ comments: :author }).with({ comments: :author }).
+          and_return(relation)
+
+        is_expected.to eq relation
+      end
+    end
+
+    describe ".associations" do
+      subject { ArticleMapper.associations(traits) }
+
+      context "one mounted class" do
+        let(:traits) { %i[ with_comments ] }
+
+        it { is_expected.to eq :comments }
+      end
+
+      context "nested mounted class" do
+        let(:traits) { %i[ with_comments with_author ] }
+
+        it { is_expected.to eq({ comments: :author }) }
+      end
+
+      context "mounted and nested mounted classes" do
+        let(:traits) { %i[ with_comments with_author with_tags ] }
+
+        it { is_expected.to eq([{ comments: :author }, :tags]) }
+      end
+
+      context "two nested mounted classes" do
+        let(:traits) { %i[ with_comments with_author with_links ] }
+
+        it { is_expected.to eq({ comments: [:author, :links] }) }
+      end
+
+      context "no relation between models" do
+        let(:traits) { %i[ with_category ] }
+
+        it do
+          expect { subject }.to raise_error(FlatMap::ModelMapper::Associations::AssociationError,
+                                            "No association between FlatMap::AssociationsListSpec::Article " \
+                                            "and FlatMap::AssociationsListSpec::Category models.")
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: HornsAndHooves-flat_map
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - HornsAndHooves
@@ -9,39 +9,51 @@ authors:
 - Zachary Belzer
 - Sergey Potapov
 - Bruce Burdick
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2022-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -137,9 +149,11 @@ files:
 - lib/flat_map/mapping/writer/method.rb
 - lib/flat_map/mapping/writer/proc.rb
 - lib/flat_map/model_mapper.rb
+- lib/flat_map/model_mapper/associations.rb
 - lib/flat_map/model_mapper/persistence.rb
 - lib/flat_map/model_mapper/skipping.rb
 - lib/flat_map/open_mapper.rb
+- lib/flat_map/open_mapper/associations.rb
 - lib/flat_map/open_mapper/attribute_methods.rb
 - lib/flat_map/open_mapper/factory.rb
 - lib/flat_map/open_mapper/mapping.rb
@@ -169,6 +183,7 @@ files:
 - spec/flat_map/mapping/writer/method_spec.rb
 - spec/flat_map/mapping/writer/proc_spec.rb
 - spec/flat_map/mapping_spec.rb
+- spec/flat_map/model_mapper/associations_spec.rb
 - spec/flat_map/open_mapper_spec.rb
 - spec/spec_helper.rb
 - tmp/metric_fu/_data/20131218.yml
@@ -177,7 +192,7 @@ homepage: https://github.com/HornsAndHooves/flat_map
 licenses:
 - LICENSE
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,9 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Deep object graph to a plain properties mapper
 test_files:
@@ -219,5 +233,6 @@ test_files:
 - spec/flat_map/mapping/writer/method_spec.rb
 - spec/flat_map/mapping/writer/proc_spec.rb
 - spec/flat_map/mapping_spec.rb
+- spec/flat_map/model_mapper/associations_spec.rb
 - spec/flat_map/open_mapper_spec.rb
 - spec/spec_helper.rb