ransack-enum 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97f30e49879d033fe4c565d88b0684425231f15f587e8aec3c172733f93933c1
-  data.tar.gz: ca2b830be92aa094cff2582b3bba3564a39c13a00470c220f2fe74be470491d6
+  metadata.gz: e7d29a6d9f1aeb5b49f746c0c16e41b4690ebe4070f90fa5186572927b8ac2ee
+  data.tar.gz: a2358d2de52e1297aa65ef24c8a3a4529ff484e657716b7777d670483f9608b9
 SHA512:
-  metadata.gz: 8c66bafa64fe674569f78b7221ecd2090d311423e69fe937623aff056134536650bed8283a724ff5cb952e4793578772b330085750b72bf331dd2746f21ecb26
-  data.tar.gz: f516648b499dbab637d630b237501fc1a357f8d0994e507dcdd7f7ebb49f83b52307580bff7908675ad0c860fcde7ae8ed779337b3105139785ba97735cd7fea
+  metadata.gz: 64372e91b20d14ccf56ee0567f2aecc9940e2d39c83ca505173a49cea70dc6083fdc6586882c9608e2225d55ac46e8c9009e9e689bb2c5ec6ced8d9934cf7ea1
+  data.tar.gz: a3d1790361f9886debedc89d336cab5fea1eb4e17a4faa216c76262dcdc32535666b213bf1b1a60e62db9e53635b47f08a6f7977a1324275a8306767991d6708

data/.gitignore

@@ -9,7 +9,6 @@
 /vendor
 .DS_Store
 Gemfile.lock
-.rspec
 
 # rspec failure tracking
 .rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -1,14 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6.5
-  Exclude:
-    - Gemfile
-    - Gemfile.lock
-    - ransack-enum.gemspec
-    - vendor/bundle/**/*
-    - vendor/bundler/**/*
+  NewCops: enable
 Metrics/BlockLength:
   Exclude:
-    - spec/**/*
-Metrics/LineLength:
-  Max: 80
-  IgnoredPatterns: ['(\A|\s+)#']
+    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## 0.3.0 / 2020-09-28
+### New features
+- Support boolean enum value
+### Hotfix
+- Change other than #enum to private
+
+## 0.2.1 / 2020-03-17
+### Hotfix
+- Generating an automated security update (rake)
+
+## 0.2.0 / 2019-12-02
+### New features
+- Enable / Disable in ransack configuration
+
+## 0.1.2 / 2019-12-01
+### Hotfix
+- Fix dependencies
+
+## 0.1.1 / 2019-11-30
+### Hotfix
+- Fix dependencies
+
 ## 0.1.0 / 2019-11-30
 ### New features
 - create gem

data/Gemfile

@@ -1,4 +1,10 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ransack-enum.gemspec
 gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'sqlite3'

data/README.md

@@ -7,9 +7,7 @@ Allow Enum values to be used in [Ransack](https://github.com/activerecord-hacker
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ransack-enum',
-    git: 'https://github.com/shoma07/ransack-enum.git',
-    branch: 'master'
+gem 'ransack-enum', '~> 0.3'
 ```
 
 And then execute:
@@ -45,16 +43,36 @@ Post.ransack(status_in: [0, 1]).result.to_sql
 # SELECT "posts".* FROM "posts" WHERE "posts"."status" IN (0, 1)
 ```
 
+### Configuration
+
+Enable / Disable enum value search in the configuration.
+Default is enabled.
+
+```ruby
+# config/initializers/ransack.rb
+
+Ransack.configure do |config|
+  # ...
+end
+
+Ransack::Enum.configure do |config|
+  # enabled
+  config.enabled = true
+
+  # disabled
+  # config.enabled = false
+end
+```
+
 ## Feature
 
-- Enable / Disable in ransack configuration
 - Enable to convert enum i18n value to search value
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/ransack/enum.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext'
+require 'ransack'
 require 'ransack/enum/version'
-require 'ransack/enum/adapters'
+require 'ransack/enum/configuration'
+require 'ransack/enum/adapters/active_record'
 
 module Ransack
+  # Ransack::Enum
   module Enum
-    class Error < StandardError; end
-    # Your code goes here...
+    extend Configuration
   end
 end

data/lib/ransack/enum/adapters/active_record.rb

@@ -2,16 +2,6 @@
 
 require 'ransack/enum/adapters/active_record/base'
 
-module Ransack
-  module Enum
-    module Adapters
-      # Ransack::Enum::Adapters::ActiveRecord
-      module ActiveRecord
-      end
-    end
-  end
-end
-
 ActiveSupport.on_load(:active_record) do
   extend Ransack::Enum::Adapters::ActiveRecord::Base
 end

data/lib/ransack/enum/adapters/active_record/base.rb

@@ -8,44 +8,35 @@ module Ransack
         module Base
           # @see https://github.com/rails/rails/blob/66cabeda2c46c582d19738e1318be8d59584cc5b/activerecord/lib/active_record/enum.rb#L150
           # @param [Hash] definitions
+          # @return [Hash]
           def enum(definitions)
+            enum_ransacker(*definitions.to_a.first) if respond_to?(:ransacker)
             super
-            enum_ransacker(definitions)
           end
 
-          # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-          # @param [Hash] definitions
-          def enum_ransacker(definitions)
-            definitions.each do |name, values|
-              fmt = lambda do |v|
-                return values[v.to_sym] if values[v.to_sym]
+          private
 
-                case columns_hash[name.to_s]&.type
-                when :integer
-                  v.to_i
-                when :boolean
-                  if ActiveRecord::VERSION::MAJOR >= 5
-                    ActiveRecord::Type::Boolean.new.cast(v)
-                  else
-                    ActiveRecord::Type::Boolean.new.type_cast_from_database(v)
-                  end
-                else
-                  v
-                end
-              end
+          # @param [Symbol] name
+          # @param [Hash] values
+          # @return [Hash]
+          def enum_ransacker(name, values)
+            converter = enum_ransack_value_converter(name.to_s, values)
+            ransacker name, formatter: lambda { |value|
+              value.is_a?(Array) ? value.map(&converter) : converter.call(value)
+            }
+          end
 
-              formatter = proc do |val|
-                if val.is_a?(Array)
-                  val.map { |v| fmt.call(v) }
-                else
-                  fmt.call(val)
-                end
-              end
+          # @param [String] name
+          # @param [Hash] values
+          # @return [Proc]
+          def enum_ransack_value_converter(name, values)
+            lambda do |value|
+              val = values[value.to_sym]
+              return val if Ransack::Enum.enabled? && !val.nil?
 
-              ransacker name.to_sym, formatter: formatter
+              Ransack::Nodes::Value.new(nil, value).cast(attribute_types[name]&.type)
             end
           end
-          # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
         end
       end
     end

data/lib/ransack/enum/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Ransack
+  module Enum
+    # Ransack::Enum::Configuration
+    module Configuration
+      mattr_accessor :options
+
+      self.options = { enabled: true }
+
+      def configure
+        yield self
+      end
+
+      # @param [TrueClass, FalseClass] enabled
+      # @return [TrueClass, FalseClass]
+      def enabled=(enabled)
+        options[:enabled] = enabled
+      end
+
+      # @return [TrueClass, FalseClass]
+      def enabled?
+        options[:enabled]
+      end
+    end
+  end
+end

data/lib/ransack/enum/version.rb

@@ -2,6 +2,6 @@
 
 module Ransack
   module Enum
-    VERSION = '0.1.0'
+    VERSION = '0.3.0'
   end
 end

data/ransack-enum.gemspec

@@ -1,36 +1,31 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ransack/enum/version"
+# frozen_string_literal: true
+
+require_relative 'lib/ransack/enum/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ransack-enum"
+  spec.name          = 'ransack-enum'
   spec.version       = Ransack::Enum::VERSION
-  spec.authors       = ["shoma07"]
-  spec.email         = ["23730734+shoma07@users.noreply.github.com"]
+  spec.authors       = %w[shoma07]
+  spec.email         = %w[23730734+shoma07@users.noreply.github.com]
 
-  spec.summary       = "Allow Enum values to be used in Ransack searches"
-  spec.description   = "Allow Enum values to be used in Ransack searches"
-  spec.homepage      = "https://github.com/shoma07/ransack-enum"
-  spec.license       = "MIT"
+  spec.summary       = 'Allow Enum values to be used in Ransack searches'
+  spec.description   = 'Allow Enum values to be used in Ransack searches'
+  spec.homepage      = 'https://github.com/shoma07/ransack-enum'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "https://github.com/shoma07/ransack-enum/blob/master/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  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.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "ransack", "~> 2.3"
-  spec.add_dependency "activesupport", ">= 5.2.1"
+  spec.require_paths = %w[lib]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "sqlite3", "~> 1.4"
+  spec.add_dependency 'ransack', '~> 2.0'
 end

metadata

@@ -1,99 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ransack-enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - shoma07
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-30 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ransack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.1
-- !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
+  type: :runtime
   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'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 description: Allow Enum values to be used in Ransack searches
 email:
 - 23730734+shoma07@users.noreply.github.com
@@ -104,7 +34,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -113,9 +42,9 @@ files:
 - bin/console
 - bin/setup
 - lib/ransack/enum.rb
-- lib/ransack/enum/adapters.rb
 - lib/ransack/enum/adapters/active_record.rb
 - lib/ransack/enum/adapters/active_record/base.rb
+- lib/ransack/enum/configuration.rb
 - lib/ransack/enum/version.rb
 - ransack-enum.gemspec
 homepage: https://github.com/shoma07/ransack-enum
@@ -124,7 +53,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/shoma07/ransack-enum
   source_code_uri: https://github.com/shoma07/ransack-enum
-  changelog_uri: https://github.com/shoma07/ransack-enum/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/shoma07/ransack-enum/blob/v0.3.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -133,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Allow Enum values to be used in Ransack searches

data/.travis.yml

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

data/lib/ransack/enum/adapters.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'ransack/enum/adapters/active_record'
-
-module Ransack
-  module Enum
-    # Ransack::Enum::Adapters
-    module Adapters
-    end
-  end
-end