activerecord-autoscope 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 777a569281b2e5c3094260664c157e5dc686f0a0a66b100b01a69934bc3c2c3f
+  data.tar.gz: 74f54e9f786b70788e95d8dddece0e7fba1a87ba3bf6defd7fd596f78e31a6a7
+SHA512:
+  metadata.gz: d60e542cd7d3ff042c8ca8eda7ce0f81e6d3d1e2fba25f622d228a2e6a6cb811015682ed3ee14c208d4c8fbe9f4dcee76cec796eec1d4deb4245fe57b4ee1898
+  data.tar.gz: a7e40c224bdf06159021eb944b67f8e3b002a9d6627f274c3c3cd949275375791779f39894e339d52e568a52a636dc14577f30d92a9bec069e7a023b5b0a774c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-autoscope.gemspec
+gemspec
+
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    activerecord-autoscope (0.1.0)
+      activerecord (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-autoscope!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yoshiyuki Hirano
+
+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,76 @@
+# ActiveRecord::AutoScope
+
+This gem automatically defines scope methods which we often implement
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-autoscope'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-autoscope
+
+## Usage
+
+This gem automatically defines these scope methods **without configuration**
+
+These APIs are similar as [ransack](https://github.com/activerecord-hackery/ransack/)'s one, but these scope methods are simple implementations.
+
+Please check its [implementation](https://github.com/yhirano55/activerecord-autoscope/blob/master/lib/activerecord/auto_scope/scope_methods.rb) if you're interested in.
+
+| Type | Predicate | Description | Notes |
+| ---- | --------- | ----------- | ----- |
+| all | `*_eq` | equal | |
+| all | `*_not_eq` | not equal | |
+| all | `*_is` | equal | |
+| all | `*_is_not` | not equal | |
+| all | `*_null` | is null | |
+| all | `*_not_null` | is not null | |
+| all | `*_present` | not null and not empty | |
+| all | `*_blank` | null or empty | |
+| `:integer` | `*_gt` | greater than | |
+| `:integer` | `*_gteq` | greater than or equal | |
+| `:integer` | `*_lt` | less than | |
+| `:integer` | `*_lteq` | less than or equal | |
+| `:string`, `:text` | `*_start` | starts with | SQL: `col LIKE 'value%'` |
+| `:string`, `:text` | `*_not_start` | does not start with | |
+| `:string`, `:text` | `*_end` | ends with | SQL: `col LIKE '%value'` |
+| `:string`, `:text` | `*_not_end` | does not end with | |
+| `:string`, `:text` | `*_cont` | contains | SQL: `col LIKE '%value%'` |
+| `:string`, `:text` | `*_not_cont` | does not contain | |
+| `:date`, `:datetime` | `*_after` | after | |
+| `:date`, `:datetime` | `*_on_or_after` | on or after | |
+| `:date`, `:datetime` | `*_before` | before | |
+| `:date`, `:datetime` | `*_on_or_before` | on or before | |
+| `:date`, `:datetime` | `*_between` | between | |
+| `:boolean` | `*` | true | SQL: `col IS true` |
+| `:boolean` | `not_*` | false | |
+
+### Manually settings
+
+If you want to define these scope methods manually, you have to add this initializer file:
+
+```ruby
+# config/initializers/activerecord_autoscope.rb
+ActiveRecord::AutoScope.config.auto_define_scopes = false
+```
+
+Then you have to enable inside each models:
+
+```ruby
+class User < ApplicationRecord
+  enable_auto_scopes!
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activerecord-autoscope.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('./lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/auto_scope/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'activerecord-autoscope'
+  s.version       = ActiveRecord::AutoScope::VERSION
+  s.authors       = ['Yoshiyuki Hirano']
+  s.email         = ['yhirano@me.com']
+  s.homepage      = 'https://github.com/yhirano55/activerecord-autoscope'
+  s.summary       = %(activerecord-autoscope automatically add useful scopes)
+  s.description   = s.summary
+  s.license       = 'MIT'
+  s.files         = Dir.chdir(File.expand_path('.', __dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.2.2'
+  s.required_rubygems_version = '>= 1.8.11'
+
+  s.add_dependency 'activerecord', '>= 5.2'
+
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'activerecord/autoscope'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+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/activerecord-autoscope.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'activerecord/auto_scope'

data/lib/activerecord/auto_scope.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require_relative 'auto_scope/config'
+require_relative 'auto_scope/scope_methods'
+require_relative 'auto_scope/version'
+
+begin
+  require 'rails'
+  require_relative 'auto_scope/railtie'
+rescue LoadError
+  nil
+end
+
+module ActiveRecord
+  module AutoScope # :nodoc:
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/activerecord/auto_scope/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module AutoScope
+    class Config # :nodoc:
+      attr_accessor :auto_define_scopes
+
+      def initialize
+        @auto_define_scopes = true
+      end
+    end
+  end
+end

data/lib/activerecord/auto_scope/railtie.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module AutoScope
+    class Railtie < ::Rails::Railtie # :nodoc:
+      config.after_initialize do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.extend ::ActiveRecord::AutoScope::ScopeMethods
+        end
+
+        if ::ActiveRecord::AutoScope.config.auto_define_scopes
+          TracePoint.trace(:end) do |event|
+            next if !event.self.ancestors.include?(ActiveRecord::Base) || event.self.abstract_class?
+
+            event.self.enable_auto_scopes!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/auto_scope/scope_methods.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module AutoScope
+    module ScopeMethods # :nodoc:
+      def enable_auto_scopes!
+        columns.each do |column|
+          attr_name = column.name
+          table_name = column.table_name
+
+          scope("#{attr_name}_eq", ->(value) { where(attr_name => value) })
+          scope("#{attr_name}_not_eq", ->(value) { where.not(attr_name => value) })
+          scope("#{attr_name}_is", ->(value) { where(attr_name => value) })
+          scope("#{attr_name}_is_not", ->(value) { where.not(attr_name => value) })
+          scope("#{attr_name}_null", -> { where(attr_name => nil) })
+          scope("#{attr_name}_not_null", -> { where.not(attr_name => nil) })
+          scope("#{attr_name}_present", -> { where("#{table_name}.#{attr_name} IS NOT NULL AND #{table_name}.#{attr_name} != ''") })
+          scope("#{attr_name}_blank", -> { where("#{table_name}.#{attr_name} IS NULL OR #{table_name}.#{attr_name} = ''") })
+
+          case column.type
+          when :integer
+            scope("#{attr_name}_gt", ->(value) { where("#{table_name}.#{attr_name} > ?", value) })
+            scope("#{attr_name}_gteq", ->(value) { where("#{table_name}.#{attr_name} >= ?", value) })
+            scope("#{attr_name}_lt", ->(value) { where("#{table_name}.#{attr_name} < ?", value) })
+            scope("#{attr_name}_lteq", ->(value) { where("#{table_name}.#{attr_name} <= ?", value) })
+          when :string, :text
+            scope("#{attr_name}_start", ->(value) { where("#{table_name}.#{attr_name} LIKE ?", "#{sanitize_sql_like(value)}%") })
+            scope("#{attr_name}_not_start", ->(value) { where("#{table_name}.#{attr_name} NOT LIKE ?", "#{sanitize_sql_like(value)}%") })
+            scope("#{attr_name}_end", ->(value) { where("#{table_name}.#{attr_name} LIKE ?", "%#{sanitize_sql_like(value)}") })
+            scope("#{attr_name}_not_end", ->(value) { where("#{table_name}.#{attr_name} NOT LIKE ?", "%#{sanitize_sql_like(value)}") })
+            scope("#{attr_name}_cont", ->(value) { where("#{table_name}.#{attr_name} LIKE ?", "%#{sanitize_sql_like(value)}%") })
+            scope("#{attr_name}_not_cont", ->(value) { where("#{table_name}.#{attr_name} NOT LIKE ?", "%#{sanitize_sql_like(value)}%") })
+          when :date, :datetime
+            scope("#{attr_name}_after", ->(value) { where("#{table_name}.#{attr_name} > ?", value) })
+            scope("#{attr_name}_on_or_after", ->(value) { where("#{table_name}.#{attr_name} >= ?", value) })
+            scope("#{attr_name}_before", ->(value) { where("#{table_name}.#{attr_name} < ?", value) })
+            scope("#{attr_name}_on_or_before", ->(value) { where("#{table_name}.#{attr_name} <= ?", value) })
+            scope("#{attr_name}_between", ->(_value) { where(attr_name => format_value) })
+          when :boolean
+            scope(attr_name, -> { where(attr_name => true) })
+            scope("not_#{attr_name}", -> { where(attr_name => false) })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/auto_scope/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module AutoScope
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-autoscope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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: 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: activerecord-autoscope automatically add useful scopes
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-autoscope.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord-autoscope.rb
+- lib/activerecord/auto_scope.rb
+- lib/activerecord/auto_scope/config.rb
+- lib/activerecord/auto_scope/railtie.rb
+- lib/activerecord/auto_scope/scope_methods.rb
+- lib/activerecord/auto_scope/version.rb
+homepage: https://github.com/yhirano55/activerecord-autoscope
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: activerecord-autoscope automatically add useful scopes
+test_files: []