activerecord_nested_scope 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 166d91ad4f5ed349c3bade4dc78b7b03a5d23dbd
+  data.tar.gz: 41a8f213a1b5c800ecf0ab98a986a6f2f90e5e48
+SHA512:
+  metadata.gz: ae33da5f637a1a078f147a5b9f0a14152c73e01a046f5f8a71c57475d111be6c4f686d3a4900582c3583954d579cf03944e8ec8b36c71742ac829204185169c2
+  data.tar.gz: 406a41e50108e30684e84c69fc89347603f8b612dd56a611a01f5509521b2d7aea7bfb0968b4c1597cb5951a6bdd9c0d847f27e25d94d2664e5ec59e3b5a9c83

data/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+.yardoc
+.project
+Gemfile.lock
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+spec/dummy/config/database.yml
+spec/dummy/db/schema.rb
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/*
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+services:
+  - mysql
+  - postgresql
+addons:
+  postgresql: "9.5"
+env:
+  - DATABASE=sqlite
+  - DATABASE=mysql
+  - DATABASE=postgresql
+gemfile:
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails52.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
+  - cd ../..
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2018 Yoshikazu Kaneta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# ActiveRecordNestedScope
+
+An ActiveRecord extension to build nested scopes through pre-defined associations.
+
+## Dependencies
+
+* ruby 2.3+
+* rails 5.0+ (activerecord and activesupport)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_nested_scope'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+For example, define `in_group` scope using nested_scope as follows:
+
+```ruby
+class Group < ActiveRecord::Base
+  nested_scope :in_group  # root scope
+  ...
+end
+
+class User < ActiveRecord::Base
+  belongs_to :group
+  nested_scope :in_group, through: :group  # User belongs to Group
+  ...
+end
+
+class UserConfig < ActiveRecord::Base
+  belongs_to :user
+  nested_scope :in_group, through: :user  # UserConfig belongs to Group through User
+  ...
+end
+```
+
+`in_group` scope generates SQL as follows:
+
+```ruby
+User.in_group(id: 1)
+#=> SELECT "users".* FROM "users" WHERE "users"."group_id" IN (
+#     SELECT "groups"."id" FROM "groups" WHERE "groups"."id" = 1)
+
+UserConfig.in_group(id: 1)
+#=> SELECT "user_configs".* 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))
+```
+
+### Polymorphic association
+
+If you define a polymorphic association like that,
+
+```ruby
+class Name < ActiveRecord::Base
+  belongs_to :data, polymorphic: true
+  nested_scope :in_group, through: :data
+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
+```
+
+Note that the first SQL is executed to load `data_type`, and the second SQL is built using loaded `data_type` variations.
+
+### Scope examples
+
+```ruby
+# pass a integer
+User.in_group(1)
+
+# pass a hash
+User.in_group(id: 1)
+
+# pass an AR relation
+User.in_group(Group.where(id: 1))
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/kanety/activerecord_nested_scope.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord_nested_scope.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord_nested_scope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord_nested_scope"
+  spec.version       = ActiveRecordNestedScope::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{An ActiveRecord extension to build nested scopes}
+  spec.description   = %q{An ActiveRecord extension to build nested scopes through pre-defined associations}
+  spec.homepage      = "https://github.com/kanety/activerecord_nested_scope"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 5.0"
+  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/rails50.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.0.0"
+gem "sqlite3", "~> 1.3.6"
+gem "mysql2", "~> 0.4.4"
+gem "pg", "~> 0.18"
+
+gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.1.0"
+gem "sqlite3", "~> 1.3.6"
+gem "mysql2", "~> 0.4.4"
+gem "pg", "~> 0.18"
+
+gemspec path: "../"

data/gemfiles/rails52.gemfile

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

data/lib/activerecord_nested_scope.rb

@@ -0,0 +1,3 @@
+require 'activerecord_nested_scope/version'
+require 'activerecord_nested_scope/extension'
+require 'activerecord_nested_scope/railtie' if defined?(Rails)

data/lib/activerecord_nested_scope/builder.rb

@@ -0,0 +1,93 @@
+module ActiveRecordNestedScope
+  class Builder
+    def initialize(klass, name, args)
+      @klass = klass
+      @name = name
+      @args = args
+    end
+
+    def build
+      build_for(@klass)
+    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
+      else
+        klass.none
+      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
+    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))
+    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))
+    end
+
+    def belongs_to_polymorphic_relation(klass, ref)
+      types = klass.unscoped.group(ref.foreign_type).pluck(ref.foreign_type)
+      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)
+    end
+
+    def root_relation(klass)
+      if @args.is_a?(Integer) || @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)
+      else
+        klass.all
+      end
+    end
+
+    def scoped(klass, scope)
+      rel = klass.all
+      rel = rel.instance_eval(&scope) if scope
+      rel
+    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
+    end
+  end
+end

data/lib/activerecord_nested_scope/extension.rb

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

data/lib/activerecord_nested_scope/railtie.rb

@@ -0,0 +1,7 @@
+module ActiveRecordNestedScope
+  class Railtie < Rails::Railtie
+    ActiveSupport.on_load :active_record do
+      ActiveRecord::Base.send :include, ActiveRecordNestedScope::Extension
+    end
+  end
+end

data/lib/activerecord_nested_scope/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordNestedScope
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_nested_scope
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    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: pg
+  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: 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: rspec-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: simplecov
+  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-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:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord_nested_scope.gemspec
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- lib/activerecord_nested_scope.rb
+- lib/activerecord_nested_scope/builder.rb
+- lib/activerecord_nested_scope/extension.rb
+- lib/activerecord_nested_scope/railtie.rb
+- lib/activerecord_nested_scope/version.rb
+homepage: https://github.com/kanety/activerecord_nested_scope
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: An ActiveRecord extension to build nested scopes
+test_files: []