activerecord_nested_scope 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a69c4a48717739fd16dacdb44003583d15f8989c
-  data.tar.gz: 7362eef6445f2ca2969cd9df5d04618c30aedba5
+SHA256:
+  metadata.gz: 6e06209d1f222b99ba36ec6619390cec6465e41000e4dc9100a0de23e47e962b
+  data.tar.gz: 7ed179db041bff9e317e0eb4e51b7e6e8877c0a2ef782cbd1e464c5fe640dec3
 SHA512:
-  metadata.gz: 43628d21ea4aae5f2dd93d78e913eb7a659b0fab1232a2a0a183f0cbf46f0a39ea6485176edb1dac944bfeb41c136f77fbce9a3defef4da93d9cc5f8b8f7677e
-  data.tar.gz: b832f7295a60cd32e4af55507cf7a05a504179c0658c6d025ce77def50582e7c6aac24fbf800204801521482bed18c8b5fbbf7ee32fe230328e3f129785bb195
+  metadata.gz: 2a2b55f78f24d9e1e1cf50f3d2260dff3e62dc70ce2ba6594835192e0189eee3b222d17a2b55e6f0ff5351a2927befcd35f0f3e660c45ec6679d5a186a3fb18a
+  data.tar.gz: 73a819a21306bb1ed00645063af41eea0851687c944942a8aa7a9f8b2f209980ca9bb99b007e778f197c1c40126d0585f199f9a9d5742a57937cd3fb6fd1220b

data/.gitignore

@@ -4,12 +4,12 @@
 Gemfile.lock
 _yardoc/
 coverage/
+gemfiles/*.lock
 doc/
 pkg/
 spec/reports/
 spec/dummy/config/database.yml
-spec/dummy/db/schema.rb
+spec/dummy/db/schema*.rb
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
 spec/dummy/tmp/*
-tmp/

data/.travis.yml

@@ -3,6 +3,8 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7
 services:
   - mysql
   - postgresql
@@ -16,10 +18,16 @@ gemfile:
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
   - gemfiles/rails52.gemfile
+  - gemfiles/rails60.gemfile
+matrix:
+  exclude:
+  - rvm: 2.3
+    gemfile: gemfiles/rails60.gemfile
+  - rvm: 2.4
+    gemfile: gemfiles/rails60.gemfile
 before_script:
   - cd spec/dummy
-  - bundle exec rake db:create RAILS_ENV=test
-  - bundle exec rake db:migrate RAILS_ENV=test
-  - bundle exec rake db:seed RAILS_ENV=test
+  - bundle exec rake db:create db:migrate db:seed RAILS_ENV=test
   - cd ../..
-script: bundle exec rspec
+script:
+  - DEBUG=1 bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# CHANGELOG
+
+## 1.2.0
+
+* Add source_map option to resolve polymorphic type.
+
+## 1.1.1
+
+* Fix query for associations with primary key option.
+
+## 1.1.0
+
+* Add short query feature for simple belongs_to association.
+* Rename `_nested_scope_options` to `nested_scope_options`.
+* Remove support for active_record_union.
+
+## 1.0.4
+
+* Fix query for string value.
+
+## 1.0.3
+
+* Remove nil from polymorphic types.
+
+## 1.0.2
+
+* Fix query error when there are no records in polymorphic tables.
+
+## 1.0.1
+
+* Fix query for array value.
+
+## 1.0.0
+
+* First release.

data/README.md

@@ -5,7 +5,8 @@ An ActiveRecord extension to build nested scopes through pre-defined association
 ## Dependencies
 
 * ruby 2.3+
-* rails 5.0+ (activerecord and activesupport)
+* activerecord 5.0+
+* activesupport 5.0+
 
 ## Installation
 
@@ -57,35 +58,36 @@ UserConfig.in_group(id: 1)
 
 ### Polymorphic association
 
-If you define a polymorphic association like that,
+If you define a polymorphic association,
+`in_group` generates union of subqueries for each polymorpchic type as follows:
 
 ```ruby
-class Name < ActiveRecord::Base
-  belongs_to :data, polymorphic: true
-  nested_scope :in_group, through: :data
+class Polymorphism < ActiveRecord::Base
+  belongs_to :record, polymorphic: true
+  nested_scope :in_group, through: :record
 end
-```
-
-`in_group` scope generates union of subqueries for each polymorpchic type:
 
-```ruby
-Name.in_group(id: 1)
-#=> SELECT "names"."data_type" FROM "names" GROUP BY "names"."data_type"
-#   SELECT "names".* FROM (
-#     SELECT "names".* FROM "names" WHERE "names"."data_type" = 'Group' AND "names"."data_id" IN (SELECT "groups"."id" FROM "groups" WHERE "groups"."id" = 1) UNION 
-#     SELECT "names".* FROM "names" WHERE "names"."data_type" = 'Manager' AND "names"."data_id" IN (SELECT "managers"."id" FROM "managers" WHERE "managers"."id" IN (SELECT "groups"."manager_id" FROM "groups" WHERE "groups"."id" = 1)) UNION 
-#     SELECT "names".* FROM "names" WHERE "names"."data_type" = 'Supervisor' AND "names"."data_id" IN (SELECT "supervisors"."id" FROM "supervisors" WHERE "supervisors"."id" IN (SELECT "managers"."supervisor_id" FROM "managers" WHERE "managers"."id" IN (SELECT "groups"."manager_id" FROM "groups" WHERE "groups"."id" = 1) ORDER BY "managers"."id" ASC)) UNION 
-#     SELECT "names".* FROM "names" WHERE "names"."data_type" = 'User' AND "names"."data_id" IN (SELECT "users"."id" FROM "users" WHERE "users"."group_id" IN (SELECT "groups"."id" FROM "groups" WHERE "groups"."id" = 1))) AS names
+Polymorphism.in_group(id: 1)
+#=> SELECT "polymorphisms"."record_type" FROM "polymorphisms" GROUP BY "polymorphisms"."record_type"
+#=> SELECT "polymorphisms".* FROM (
+#     SELECT "polymorphisms".* FROM "polymorphisms" WHERE "polymorphisms"."record_type" = 'Group' AND "polymorphisms"."record_id" IN (SELECT "groups"."id" FROM "groups" WHERE "groups"."id" = 1) UNION
+#     SELECT "polymorphisms".* FROM "polymorphisms" WHERE "polymorphisms"."record_type" = 'User' AND "polymorphisms"."record_id" IN (SELECT "users"."id" FROM "users" WHERE "users"."group_id" IN (SELECT "groups"."id" FROM "groups" WHERE "groups"."id" = 1)) UNION
+#     SELECT "polymorphisms".* FROM "polymorphisms" WHERE "polymorphisms"."record_type" = 'UserConfig' AND "polymorphisms"."record_id" IN (SELECT "user_configs"."id" FROM "user_configs" WHERE "user_configs"."user_id" IN (SELECT "users"."id" FROM "users" WHERE "users"."group_id" IN (SELECT "groups"."id" FROM "groups" WHERE "groups"."id" = 1)))
+#   ) AS polymorphisms
 ```
 
-Note that the first SQL is executed to load `data_type`, and the second SQL is built using loaded `data_type` variations.
+Note that the first SQL is executed to load `record_type`,
+and the second SQL is built using loaded `record_type` variations.
 
-### Scope examples
+### Scope arguments
 
 ```ruby
 # pass a integer
 User.in_group(1)
 
+# pass an array
+User.in_group([1, 2, 3])
+
 # pass a hash
 User.in_group(id: 1)
 

data/activerecord_nested_scope.gemspec

@@ -21,12 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 5.0"
 
   spec.add_development_dependency "rails", ">= 5.0"
-  spec.add_development_dependency "active_record_union"
   spec.add_development_dependency "mysql2"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "pry-rails"
-  spec.add_development_dependency "pry-byebug"
 end

data/gemfiles/rails52.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
-gem "rails", "~> 5.2.0.rc1"
+gem "rails", "~> 5.2.0"
+gem "sqlite3", "~> 1.3.6"
 
 gemspec path: "../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/lib/activerecord_nested_scope/builder.rb

@@ -1,97 +1,102 @@
 module ActiveRecordNestedScope
   class Builder
     def initialize(klass, name, args)
-      @klass = klass
-      @name = name
+      @node = Node.new(klass, name)
       @args = args
+      @args_type = args_type(args)
     end
 
-    def build
-      build_for(@klass)
+    def build(node = @node)
+      if node.leaf?
+        leaf_relation(node)
+      else
+        build_relation(node)
+      end
     end
 
     private
 
-    def build_for(klass)
-      if klass._nested_scope_options
-        if (through = klass._nested_scope_options[@name][:through])
-          if (ref = klass.reflect_on_association(through))
-            build_relation(klass, ref)
-          else
-            raise ArgumentError.new("can't find reflection #{through} in #{klass}")
-          end
-        else
-          root_relation(klass)
-        end
+    def build_relation(node)
+      if node.has_many?
+        has_many_relation(node)
+      elsif node.polymorphic_belongs_to?
+        polymorphic_belongs_to_relation(node)
+      elsif node.belongs_to?
+        belongs_to_relation(node)
       else
-        klass.none
+        raise ArgumentError.new("unsupported reflection: #{node.reflection} in #{node.klass}")
       end
     end
 
-    def build_relation(klass, ref)
-      case ref.class.to_s
-      when 'ActiveRecord::Reflection::HasManyReflection', 'ActiveRecord::Reflection::HasOneReflection'
-        has_many_relation(klass, ref)
-      when 'ActiveRecord::Reflection::BelongsToReflection'
-        if ref.polymorphic?
-          belongs_to_polymorphic_relation(klass, ref)
-        else
-          belongs_to_relation(klass, ref)
-        end
-      else
-        raise ArgumentError.new("unsupported reflection: #{ref} in #{klass}")
-      end
+    def has_many_relation(node)
+      child = node.children.first
+      return node.klass.none unless child
+
+      relation = child_relation(child, select: node.reflection.foreign_key)
+      node.klass.where(node.reflection.active_record_primary_key => relation)
     end
 
-    def has_many_relation(klass, ref)
-      klass.where(klass.primary_key => build_for(ref.klass).merge(scoped(ref.klass, ref.scope)).select(ref.foreign_key))
+    def belongs_to_relation(node)
+      child = node.children.first
+      return node.klass.none unless child
+
+      relation = child_relation(child, select: node.reflection.active_record_primary_key)
+      node.klass.where(node.reflection.foreign_key => relation)
     end
 
-    def belongs_to_relation(klass, ref)
-      klass.where(ref.foreign_key => build_for(ref.klass).merge(scoped(ref.klass, ref.scope)).select(klass.primary_key))
+    def polymorphic_belongs_to_relation(node)
+      rels = node.children.map do |child|
+        relation = child_relation(child, select: child.klass.primary_key)
+        node.klass.where(
+          node.reflection.foreign_type => child.source_type,
+          node.reflection.foreign_key => relation
+        )
+      end
+
+      union(node.klass, rels)
     end
 
-    def belongs_to_polymorphic_relation(klass, ref)
-      types = klass.unscoped.group(ref.foreign_type).pluck(ref.foreign_type)
-      if types.present?
-        rels = types.map { |type|
-          if (parent = type.safe_constantize)
-            klass.where(ref.foreign_type => type, ref.foreign_key => build_for(parent).merge(scoped(parent, ref.scope)))
-          else
-            klass.none
-          end
-        }
-        union(klass, rels)
+    def child_relation(child, select:)
+      if simple_leaf_relation?(child)
+        @args
       else
-        klass.none
+        relation = build(child).select(select)
+        relation = relation.merge(child.scope) if child.has_scope?
+        relation
       end
     end
 
-    def root_relation(klass)
-      if @args.is_a?(Integer) || @args.is_a?(Array) || @args.is_a?(ActiveRecord::Base)
-        klass.where(klass.primary_key => @args)
-      elsif @args.is_a?(ActiveRecord::Relation)
-        klass.all.merge(@args)
-      elsif @args
-        klass.where(@args)
+    def simple_leaf_relation?(child)
+      @args_type == :simple && child.leaf? && child.parent.belongs_to? && !child.has_scope?
+    end
+
+    def leaf_relation(node)
+      case @args_type
+      when :relation
+        node.klass.all.merge(@args)
+      when :hash
+        node.klass.where(@args)
+      when :simple
+        node.klass.where(node.klass.primary_key => @args)
       else
-        klass.all
+        raise ArgumentError.new("unexpected argument type: #{@args_type}")
       end
     end
 
-    def scoped(klass, scope)
-      rel = klass.all
-      rel = rel.instance_eval(&scope) if scope
-      rel
+    def args_type(args)
+      if args.is_a?(ActiveRecord::Relation)
+        :relation
+      elsif args.is_a?(Hash)
+        :hash
+      else
+        :simple
+      end
     end
 
     def union(klass, rels)
-      if defined? ActiveRecordUnion
-        rels.reduce(:union)
-      else
-        union = rels.map { |rel| "#{rel.to_sql}" }.reject(&:empty?).join(' UNION ')
-        klass.from(Arel.sql("(#{union}) AS #{klass.table_name}"))
-      end
+      return klass.none if rels.blank?
+      union = rels.map { |rel| "#{rel.to_sql}" }.reject(&:empty?).join(' UNION ')
+      klass.from(Arel.sql("(#{union}) AS #{klass.table_name}"))
     end
   end
 end

data/lib/activerecord_nested_scope/extension.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require_relative 'node'
 require_relative 'builder'
 
 module ActiveRecordNestedScope
@@ -6,13 +7,13 @@ module ActiveRecordNestedScope
     extend ActiveSupport::Concern
 
     included do
-      class_attribute :_nested_scope_options
+      class_attribute :nested_scope_options
     end
 
     class_methods do
       def nested_scope(name, options = {})
-        self._nested_scope_options ||= {}
-        self._nested_scope_options[name] = options
+        self.nested_scope_options ||= {}
+        self.nested_scope_options[name] = options
 
         scope name, ->(args) {
           ActiveRecordNestedScope::Builder.new(self, name, args).build

data/lib/activerecord_nested_scope/node.rb

@@ -0,0 +1,111 @@
+module ActiveRecordNestedScope
+  class Node
+    attr_accessor :klass, :name, :parent, :source_type
+
+    def initialize(klass, name, parent = nil, source_type = nil)
+      @klass = klass
+      @name = name
+      @parent = parent
+      @source_type = source_type
+    end
+
+    def has_options?
+      options = @klass.nested_scope_options
+      options && options[@name]
+    end
+
+    def options(key)
+      options = @klass.nested_scope_options.to_h
+      options.dig(@name, key)
+    end
+
+    def reflection
+      @klass.reflect_on_association(options(:through))
+    end
+
+    def leaf?
+      options(:through).blank?
+    end
+
+    def has_many?
+      reflection.class.name.in?(['ActiveRecord::Reflection::HasManyReflection', 'ActiveRecord::Reflection::HasOneReflection'])
+    end
+
+    def belongs_to?
+      reflection.class.name == 'ActiveRecord::Reflection::BelongsToReflection' && !reflection.polymorphic?
+    end
+
+    def polymorphic_belongs_to?
+      reflection.class.name == 'ActiveRecord::Reflection::BelongsToReflection' && reflection.polymorphic?
+    end
+
+    def children
+      @children ||= search_children.select(&:valid?)
+    end
+
+    def search_children
+      if leaf?
+        []
+      elsif polymorphic_belongs_to?
+        types = PolymorphicType.new(self, reflection).resolve
+        types.map { |klass, source_type| Node.new(klass, @name, self, source_type) }
+      else
+        [Node.new(reflection.klass, @name, self)]
+      end
+    end
+
+    def valid?
+      return false unless has_options?
+
+      if options(:through) && !reflection
+        STDERR.puts "can't find reflection for #{options(:through)} in #{klass}"
+        return false
+      end
+
+      return true
+    end
+
+    def has_scope?
+      @parent && @parent.reflection.scope.present?
+    end
+
+    def scope
+      @klass.all.instance_eval(&@parent.reflection.scope) if has_scope?
+    end
+
+    class PolymorphicType
+      def initialize(node, reflection)
+        @node = node
+        @reflection = reflection
+      end
+
+      def resolve
+        types = @node.klass.unscoped.group(@reflection.foreign_type).pluck(@reflection.foreign_type).compact
+        types.map do |type|
+          klass = resolve_source_type(type)&.safe_constantize
+          [klass, type] if klass
+        end.compact
+      end
+
+      private
+
+      def resolve_source_type(type)
+        if (map = @node.options(:source_map))
+          resolve_from_map(type, map)
+        else
+          type
+        end
+      end
+
+      def resolve_from_map(type, map)
+        if map.is_a?(Proc)
+          map.call(type)
+        elsif map.is_a?(Hash)
+          map[type]
+        else
+          raise ArgumentError.new("unsupported argument type for source_map option: #{map.class}.")
+        end
+      end
+    end
+  end
+end

data/lib/activerecord_nested_scope/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordNestedScope
-  VERSION = '1.0.2'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_nested_scope
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: active_record_union
-  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: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -136,34 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-rails
-  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: pry-byebug
-  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'
 description: An ActiveRecord extension to build nested scopes through pre-defined
   associations
 email:
@@ -175,6 +133,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -183,9 +142,11 @@ files:
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - lib/activerecord_nested_scope.rb
 - lib/activerecord_nested_scope/builder.rb
 - lib/activerecord_nested_scope/extension.rb
+- lib/activerecord_nested_scope/node.rb
 - lib/activerecord_nested_scope/railtie.rb
 - lib/activerecord_nested_scope/version.rb
 homepage: https://github.com/kanety/activerecord_nested_scope
@@ -206,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An ActiveRecord extension to build nested scopes