rescoped 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bac70612955cc28de9d0fb10afcb8625bf93643ec3e4fda2e886f58999a46698
+  data.tar.gz: a2c7fe40e52a8e322faafe84ba2b1ab3c6dae83d86a44bfab497f0be2bb26d50
+SHA512:
+  metadata.gz: bb1e608aea1c401d8e518fa52b5735af5355a080199e3ba7cdb9636044fa0c489f3329419e97c2b7e4081a8196e19fe873d9e7481300e3678cd70d309229478d
+  data.tar.gz: feaa57e341951a5d5db5ceb3d3546d0d0ba72091337d94cd917c51773bc9ee5ffbea84f1280e544c5fcd0e15761010d07587fccbaceca091f7fc56cdb9545b18

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sqlite3
+
+

data/.rubocop.yml

@@ -0,0 +1,13 @@
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - "tmp/**/*"
+    - "gemfiles/*"
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Changes in 0.1.0
+
+* First release of rescoped

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    rescoped (0.1.0)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.1)
+      activesupport (= 6.0.1)
+    activerecord (6.0.1)
+      activemodel (= 6.0.1)
+      activesupport (= 6.0.1)
+    activesupport (6.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    faker (2.7.0)
+      i18n (>= 1.6, < 1.8)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    parallel (1.19.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  factory_bot
+  faker
+  pry
+  rake (~> 10.0)
+  rescoped!
+  rspec (~> 3.2)
+  rubocop (>= 0.76.0)
+  sqlite3
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Geoff Ereth
+
+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,62 @@
+# Rescoped
+
+Rescoped allows you to remove specific relations from an activerecord `:joins` or `:includes` with some new utilities, `remove_includes`, `remove_joins`, and `remove_left_outer_joins`
+
+### Usage
+
+Consider the following scope:
+
+```ruby
+class Photo < ApplicationRecord
+
+  scope :public_api, lambda {
+    includes(
+      :users,
+      :likes,
+      :region
+    ).viewable.recent
+  }
+end
+```
+
+Rescoped let's you keep an existing scope but **without** the same relations structure.  Here's an example of keeping the `:public_api` scope but removing one of the relations from the `:includes`
+
+  ```ruby
+ # Avoid an includes(:relation).joins(:relation) and instead restructure as a simple INNER JOIN
+
+  Photo.public_api.remove_includes(:region).joins(:region)
+  ```
+
+  Some other **simple** examples:
+
+  1. Remove any number of relations from `:left_outer_joins`. 
+
+  ```ruby
+  Photo.left_outer_joins(:users, :likes, :region).remove_left_outer_joins(:users, :likes)
+  ```
+
+  2. Remove a single relations from the `:joins`
+  ```ruby
+  Photo.joins(:users, :likes).remove_joins(:users)
+  ```
+
+  3. The rescoped utilities can be used anywhere in the chain:
+
+  ```ruby
+  Photo.includes(:users).left_joins(:regions).viewable.recent.remove_includes(:users)
+  ```
+
+## Installation
+
+```ruby
+gem 'rescoped'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Author
+
+Geoff Ereth (github@geoffereth.com)

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rescoped'
+require 'pry'
+require 'irb'
+
+# load models and schema
+require File.expand_path('../spec/support/models.rb', __dir__)
+database = File.join('../spec/rescoped.sqlite3')
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: database)
+load File.expand_path('../spec/support/schema.rb', __dir__)
+
+Pry.start
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rescoped.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'active_support/lazy_load_hooks'
+require 'active_record'
+require 'rescoped/query_methods'
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Relation.include(Rescoped::QueryMethods)
+end

data/lib/rescoped/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rescoped
+  module Error
+    UNSUPPORTED_QUERY_METHOD = Class.new(StandardError)
+  end
+end

data/lib/rescoped/query_methods.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'active_record/relation'
+require 'rescoped/error'
+
+module Rescoped
+  module QueryMethods # :nodoc:
+    SUPPORTED_QUERY_METHODS = %i[joins left_outer_joins includes].freeze
+
+    # @!method remove_joins(*args)
+    # Removes any number of joins relations in scope
+    #
+    # @param args [Array<Symbol>] associations to remove
+    # @return [ActiveRecord::Relation]
+    # @example
+    #   Model.joins(:a, :b, :c).remove_joins(:a, :b)
+
+    # @!method remove_left_outer_joins(*args)
+    # Removes any number of left outer joins relations in scope
+    #
+    # @param args [Array<Symbol>] associations to remove
+    # @return [ActiveRecord::Relation]
+    # @example
+    #   Model.left_joins(:a, :b, :c).remove_left_outer_joins(:b)
+
+    # @!method remove_includes(*args)
+    # Removes any number of eager loaded relations in scope
+    #
+    # @param args [Array<Symbol>] associations to remove
+    # @return [ActiveRecord::Relation]
+    # @example
+    #   Model.includes(:a, :b, :c).remove_includes(:a)
+
+    SUPPORTED_QUERY_METHODS.each do |name|
+      define_method("remove_#{name}") do |*args|
+        rescoped(query_method: name, relations: args)
+      end
+    end
+
+    private
+
+    # @param query_method [Symbol] ActiveRecord::QueryMethods method name
+    # @param relations [Array<Symbol>] relations to remove
+    # @raise [Rescoped::Error::UNSUPPORTED_QUERY_METHOD]
+    #   if query_method is unsupported
+
+    def rescoped(query_method:, relations: [])
+      unless SUPPORTED_QUERY_METHODS.include?(query_method)
+        raise Rescoped::Error::UNSUPPORTED_QUERY_METHOD
+      end
+
+      new_relations = values.fetch(query_method, []) - relations
+      new_values    = values.merge(query_method => new_relations)
+      klass         = @klass || self
+
+      ActiveRecord::Relation.new(klass, values: new_values)
+    end
+  end
+end

data/lib/rescoped/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rescoped
+  VERSION = '0.1.0'
+end

data/rescoped.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rescoped/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rescoped'
+  spec.version       = Rescoped::VERSION
+  spec.authors       = ['Geoff Ereth']
+  spec.email         = ['github@geoffereth.com']
+  spec.summary       = 'Remove includes or joins from an activerecord scope'
+  spec.homepage      = 'https://github.com/gadogado/rescoped'
+  spec.license       = 'MIT'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/gadogado/rescoped'
+  spec.metadata['changelog_uri'] = 'https://github.com/gadogado/rescoped/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '>= 4.0.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'factory_bot'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '>= 0.76.0'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: rescoped
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Ereth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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: faker
+  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
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.76.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'
+description: 
+email:
+- github@geoffereth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rescoped.rb
+- lib/rescoped/error.rb
+- lib/rescoped/query_methods.rb
+- lib/rescoped/version.rb
+- rescoped.gemspec
+homepage: https://github.com/gadogado/rescoped
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gadogado/rescoped
+  source_code_uri: https://github.com/gadogado/rescoped
+  changelog_uri: https://github.com/gadogado/rescoped/master/CHANGELOG.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Remove includes or joins from an activerecord scope
+test_files: []