activerecord_dynamic_scope 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c089df0d3694598d4deff6a7b70ce1f09dcfc0eed24e0e6abf67ba2b20c696a
+  data.tar.gz: dfeb08e59e4fe2430ce324028cbefed06a1e228d0c975b753a1218ca568c4677
+SHA512:
+  metadata.gz: 11c125ba8667bb8c8442696d87fd342717f50dc4fb1df408fe82adc591bcb3e453739ecc2d1e645ff6a8ad74df6f24b6c05127deaa9a5b63d265aa3801527039
+  data.tar.gz: e95e40f5dd9cc72c0e07c6d6412dbaef4a4e24932f626f63d1037c9c64650ac695c3295faa335671b4d5c6a524529a7d289062be5413c15fac49c6f924eb6a3f

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    services:
+      postgres:
+        image: postgres:9.5
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        ports:
+          - 3306:3306
+        options: --health-cmd "mysqladmin ping -h localhost" --health-interval 20s --health-timeout 10s --health-retries 10
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, '3.0', 3.1, 3.2]
+        gemfile: ['rails60', 'rails61', 'rails70']
+        database: ['sqlite', 'mysql', 'postgresql']
+
+    name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}, ${{ matrix.database }}
+
+    env:
+      DATABASE: ${{ matrix.database }}
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Prepare test
+      run: |
+        cd spec/dummy
+        BUNDLE_GEMFILE=../../${{ env.BUNDLE_GEMFILE }} RAILS_ENV=test bundle exec rake db:create db:migrate db:seed
+        cd ../..
+    - name: Run test
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+.bundle/
+Gemfile.lock
+coverage/
+gemfiles/*.lock
+pkg/
+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/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0.0
+
+* First release.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 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,90 @@
+# ActiveRecordDynamicScope
+
+Handling dynamic scope for ActiveRecord.
+
+## Dependencies
+
+* ruby 2.7+
+* activerecord 6.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_dynamic_scope'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+Define a name of dynamic scope in your model using `dynamic_scope`:
+
+```ruby
+class Item < ActiveRecord::Base
+  dynamic_scope :partition
+end
+```
+
+The name of dynamic scope should be same as an attribute name because the name is used as a key of query.
+
+Execute your query using `ActiveRecordDynamicScope.with` as follows:
+
+```ruby
+ActiveRecordDynamicScope.with(partition: 1) do
+  Item.all  #=> SELECT "items".* FROM "items" WHERE "items"."partition" = 1
+end
+```
+
+You can clear dynamic scope using `ActiveRecordDynamicScope.without` as follows:
+
+```ruby
+ActiveRecordDynamicScope.with(partition: 1) do
+  Item.all.to_a  #=> SELECT "items".* FROM "items" WHERE "items"."partition" = 1
+  ActiveRecordDynamicScope.without(:partition) do
+    Item.all  #=> SELECT "items".* FROM "items"
+  end
+end
+```
+
+### Nested scope
+
+You can also nest dynamic scope:
+
+```ruby
+class Item < ActiveRecord::Base
+  dynamic_scope :partition1
+  dynamic_scope :partition2
+end
+
+ActiveRecordDynamicScope.with(partition1: 1) do
+  ActiveRecordDynamicScope.with(partition2: 2) do
+    Item.all  #=> SELECT "items".* FROM "items" WHERE "items"."partition1" = 1 AND "items"."partition2" = 2
+  end
+end
+```
+
+### Alias name
+
+You can use alias name if the name of dynamic scope is different from an attribute name:
+
+```ruby
+class Item < ActiveRecord::Base
+  dynamic_scope :account, as: :partition
+end
+
+ActiveRecordDynamicScope.with(account: 1) do
+  Item.all  #=> SELECT "items".* FROM "items" WHERE "items"."partition1" = 1 AND "items"."partition2" = 2
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/kanety/activerecord_dynamic_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_dynamic_scope.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord_dynamic_scope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord_dynamic_scope"
+  spec.version       = ActiveRecordDynamicScope::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{Handling dynamic scope for ActiveRecord.}
+  spec.description   = %q{Handling dynamic scope for ActiveRecord.}
+  spec.homepage      = "https://github.com/kanety/activerecord_dynamic_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", ">= 6.0"
+  spec.add_dependency "activesupport", ">= 6.0"
+
+  spec.add_development_dependency "rails", ">= 6.0"
+  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"
+end

data/gemfiles/rails60.gemfile

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

data/gemfiles/rails61.gemfile

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

data/gemfiles/rails70.gemfile

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

data/lib/activerecord_dynamic_scope/extension.rb

@@ -0,0 +1,18 @@
+module ActiveRecordDynamicScope
+  module Extension
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def dynamic_scope(name, as: nil)
+        default_scope -> {
+          current_scope = ActiveRecordDynamicScope.current(name)
+          if current_scope
+            where((as || name) => current_scope)
+          else
+            all
+          end
+        }
+      end
+    end
+  end
+end

data/lib/activerecord_dynamic_scope/railtie.rb

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

data/lib/activerecord_dynamic_scope/version.rb

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

data/lib/activerecord_dynamic_scope.rb

@@ -0,0 +1,31 @@
+require 'active_support'
+
+require_relative 'activerecord_dynamic_scope/version'
+require_relative 'activerecord_dynamic_scope/extension'
+require_relative 'activerecord_dynamic_scope/railtie' if defined?(Rails)
+
+module ActiveRecordDynamicScope
+  KEY = :activerecord_dynamic_scope
+
+  class << self
+    def current(name)
+      Thread.current[KEY].to_h[name]
+    end
+
+    def with(hash = {})
+      old = Thread.current[KEY]
+      Thread.current[KEY] = Thread.current[KEY].to_h.merge(hash)
+      yield
+    ensure
+      Thread.current[KEY] = old
+    end
+
+    def without(keys)
+      old = Thread.current[KEY]
+      Thread.current[KEY] = Thread.current[KEY].to_h.except(keys)
+      yield
+    ensure
+      Thread.current[KEY] = old
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_dynamic_scope
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.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'
+description: Handling dynamic scope for ActiveRecord.
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord_dynamic_scope.gemspec
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
+- gemfiles/rails70.gemfile
+- lib/activerecord_dynamic_scope.rb
+- lib/activerecord_dynamic_scope/extension.rb
+- lib/activerecord_dynamic_scope/railtie.rb
+- lib/activerecord_dynamic_scope/version.rb
+homepage: https://github.com/kanety/activerecord_dynamic_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: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Handling dynamic scope for ActiveRecord.
+test_files: []