ransack-enum 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7d29a6d9f1aeb5b49f746c0c16e41b4690ebe4070f90fa5186572927b8ac2ee
-  data.tar.gz: a2358d2de52e1297aa65ef24c8a3a4529ff484e657716b7777d670483f9608b9
+  metadata.gz: f1afbcd408f71081fbc447ce1eaf591e6e902978969e802a0c3bf96448e93d48
+  data.tar.gz: 10aa583067d1b8704027191cad180353af7675178baf1e3b28dbaecfd5965306
 SHA512:
-  metadata.gz: 64372e91b20d14ccf56ee0567f2aecc9940e2d39c83ca505173a49cea70dc6083fdc6586882c9608e2225d55ac46e8c9009e9e689bb2c5ec6ced8d9934cf7ea1
-  data.tar.gz: a3d1790361f9886debedc89d336cab5fea1eb4e17a4faa216c76262dcdc32535666b213bf1b1a60e62db9e53635b47f08a6f7977a1324275a8306767991d6708
+  metadata.gz: 43734b3d37556813d8a4a5837270342a90ddf7ee3f1d9f0a607846313b415ae57ed58dfd9b86c269e5b10cb571c2e3d825ef625e5cba3320ce2c9bdbe20088ea
+  data.tar.gz: 5efb2f770b16591b7ca3e382f845802de16bab83c30bbd8c5f65ffac600bbfeae64bc60935a1d587d12583ef7239a8fa4795677cbf7984308fff773dc7c12e06

data/.gitignore

@@ -12,3 +12,5 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/.rubocop.yml

@@ -1,5 +1,16 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.6
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb
+
+Naming/FileName:
+  Exclude:
+    - lib/ransack-enum.rb

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 1.0.0 / 2021-12-31
+### New features
+- Supported version 7 of ActiveRecord.
+### Incompatible changes
+- Require name of gem has changed from `ransack/enum` to `ransack-enum`.
+- Module of gem has changed from `Ransack::Enum` to `RansackEnum`.
+
 ## 0.3.0 / 2020-09-28
 ### New features
 - Support boolean enum value

data/Gemfile

@@ -6,5 +6,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'rspec'
-gem 'sqlite3'
+gem 'ransack', require: false
+gem 'rspec', require: false
+gem 'rubocop', require: false
+gem 'rubocop-performance', require: false
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false
+gem 'sqlite3', require: false
+gem 'yard', require: false

data/README.md

@@ -1,18 +1,21 @@
-# Ransack::Enum
+# RansackEnum
 
-Allow Enum values to be used in [Ransack](https://github.com/activerecord-hackery/ransack) searches.
+Enable enum values in [Ransack](https://github.com/activerecord-hackery/ransack) search.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ransack-enum', '~> 0.3'
+gem 'ransack', '~> 2.0'
+gem 'ransack-enum', '~> 1.0'
 ```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle install
+```
 
 ## Usage
 
@@ -22,6 +25,9 @@ There is no need to add any special code.
 ```ruby
 class Post < ActiveRecord::Base
   enum status: { unpublished: 0, published: 1 }
+
+  # after ActiveRecord 7, the following is also possible.
+  # enum :status, { unpublished: 0, published: 1 }
 end
 ```
 
@@ -55,8 +61,8 @@ Ransack.configure do |config|
   # ...
 end
 
-Ransack::Enum.configure do |config|
-  # enabled
+RansackEnum.configure do |config|
+  # enabled (default)
   config.enabled = true
 
   # disabled
@@ -70,7 +76,7 @@ end
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` 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`.
 

data/Rakefile

@@ -1,8 +1,23 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:lint) do |t|
+  t.options = %w[--parallel]
+end
+namespace :lint do
+  desc 'Lint fix (Rubocop)'
+  task fix: :auto_correct
+end
+
+require 'yard'
+desc 'document'
+task :doc do
+  YARD::CLI::CommandParser.run
+end
+
+task default: %i[lint spec]

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'ransack/enum'
+require 'ransack-enum'
 
 # 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.

data/lib/ransack-enum.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'ransack_enum'

data/lib/ransack_enum/adapters/active_record_6.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RansackEnum
+  module Adapters
+    # RansackEnum::Adapters::ActiveRecord6
+    module ActiveRecord6
+      # @param definitions [Hash]
+      # @return [void]
+      def enum(definitions)
+        ::RansackEnum::Ransacker.new(self, nil, nil, **definitions.to_h.deep_dup).then do |enum_ransacker|
+          super.tap { enum_ransacker.call }
+        end
+      end
+    end
+
+    private_constant :ActiveRecord6
+  end
+end

data/lib/ransack_enum/adapters/active_record_7.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RansackEnum
+  module Adapters
+    # RansackEnum::Adapters::ActiveRecord7
+    module ActiveRecord7
+      # @param name [Symbol, nil]
+      # @param values [Hash, nil]
+      # @param options [Hash]
+      # @return [void]
+      def enum(name = nil, values = nil, **options)
+        ::RansackEnum::Ransacker.new(self, name, values.deep_dup, **options.deep_dup).then do |enum_ransacker|
+          super.tap { enum_ransacker.call }
+        end
+      end
+    end
+
+    private_constant :ActiveRecord7
+  end
+end

data/lib/ransack_enum/adapters.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'adapters/active_record_6'
+require_relative 'adapters/active_record_7'
+
+module RansackEnum
+  # RansackEnum::Adapters
+  module Adapters
+    ::ActiveSupport.on_load(:active_record) do
+      if Integer(::ActiveRecord::VERSION::STRING.split('.').first) >= 7
+        extend ActiveRecord7
+      else
+        extend ActiveRecord6
+      end
+    end
+  end
+
+  private_constant :Adapters
+end

data/lib/ransack_enum/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RansackEnum
+  # RansackEnum::Configuration
+  class Configuration
+    # @return [void]
+    def initialize
+      @enabled = true
+    end
+
+    # @param enabled [Boolean]
+    # @return [void]
+    # @raise [ArgumentError]
+    def enabled=(enabled)
+      raise ArgumentError if !enabled.is_a?(::TrueClass) && !enabled.is_a?(::FalseClass)
+
+      @enabled = enabled
+    end
+
+    # @return [Boolean]
+    def enabled?
+      enabled
+    end
+
+    private
+
+    # @!attribute [r] enabled
+    # @return [Boolean]
+    attr_reader :enabled
+  end
+end

data/lib/ransack_enum/formatter.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RansackEnum
+  # RansackEnum::Formatter
+  class Formatter
+    # @param model_class [Class]
+    # @param name [String]
+    # @param values [Array, Hash]
+    # @return [void]
+    def initialize(model_class, name, values)
+      @model_class = model_class
+      @name = name
+      @normalized_values = normalize_values(values)
+    end
+
+    # @param value [Object]
+    # @return [Object]
+    def call(value)
+      value.is_a?(::Array) ? (value.map { |val| normalize_value(val) }) : normalize_value(value)
+    end
+
+    private
+
+    # @!attribute [r] model_class
+    # @return [Class]
+    attr_reader :model_class
+    # @!attribute [r] name
+    # @return [String]
+    attr_reader :name
+    # @!attribute [r] normalized_values
+    # @return [Hash]
+    attr_reader :normalized_values
+
+    # @param values [Array, Hash]
+    # @return [Hash]
+    def normalize_values(values)
+      (values.is_a?(::Hash) ? values : [values, ::Array.new(values.size, &:itself)].transpose.to_h).symbolize_keys
+    end
+
+    # @param value [Object]
+    # @return [Object]
+    def normalize_value(value)
+      enum_value(value).then { |val| cast_value(val.nil? ? value : val) }
+    end
+
+    # @param value [Object]
+    # @return [Object]
+    def enum_value(value)
+      normalized_values[value.to_sym] if ::RansackEnum.config.enabled? && value.respond_to?(:to_sym)
+    end
+
+    # @param value [Object]
+    # @return [Object]
+    def cast_value(value)
+      ::Ransack::Nodes::Value.new(nil, value).cast(model_class.attribute_types[name]&.type)
+    end
+  end
+end

data/lib/ransack_enum/ransacker.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RansackEnum
+  # RansackEnum::Ransacker
+  class Ransacker
+    # @param model_class [Class]
+    # @param name [Symbol, nil]
+    # @param values [Hash, nil]
+    # @param options [Hash]
+    # @return [void]
+    def initialize(model_class, name = nil, values = nil, **options)
+      @model_class = model_class
+      if name
+        @name = name
+        @values = values || options
+      else
+        @name, @values = options.slice!(:_prefix, :_suffix, :_scopes, :_default).to_a.first
+      end
+    end
+
+    # @return [void]
+    def call
+      return if !model_class.respond_to?(:ransacker) || !name || !values
+
+      model_class.ransacker(name.to_sym, formatter: ::RansackEnum::Formatter.new(model_class, name.to_s, values))
+    end
+
+    private
+
+    # @!attribute [r] model_class
+    # @return [Class]
+    attr_reader :model_class
+    # @!attribute [r] name
+    # @return [Symbol, nil]
+    attr_reader :name
+    # @!attribute [r] values
+    # @return [Hash, nil]
+    attr_reader :values
+  end
+end

data/lib/ransack_enum/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RansackEnum
+  # @return [String]
+  VERSION = '1.0.0'
+end

data/lib/ransack_enum.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require_relative 'ransack_enum/version'
+require_relative 'ransack_enum/configuration'
+require_relative 'ransack_enum/formatter'
+require_relative 'ransack_enum/ransacker'
+require_relative 'ransack_enum/adapters'
+
+# RansackEnum
+module RansackEnum
+  # RansackEnum::Error
+  class Error < StandardError; end
+
+  class << self
+    # @return [RansackEnum::Configuration]
+    def config
+      @config ||= ::RansackEnum::Configuration.new
+    end
+
+    # @yieldparam config [RansackEnum::Configuration]
+    # @yieldreturn [void]
+    # @return [void]
+    def configure
+      raise ::RansackEnum::Error, 'No block is given!' unless block_given?
+
+      yield config
+    end
+  end
+end

data/ransack-enum.gemspec

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require_relative 'lib/ransack/enum/version'
+require_relative 'lib/ransack_enum/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'ransack-enum'
-  spec.version       = Ransack::Enum::VERSION
+  spec.version       = RansackEnum::VERSION
   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.summary       = 'Enable enum values in Ransack search'
+  spec.description   = 'Enable enum values in Ransack search'
   spec.homepage      = 'https://github.com/shoma07/ransack-enum'
   spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
@@ -26,6 +26,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
-
-  spec.add_dependency 'ransack', '~> 2.0'
+  spec.metadata = { 'rubygems_mfa_required' => 'true' }
 end

metadata

@@ -1,30 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ransack-enum
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - shoma07
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-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.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-description: Allow Enum values to be used in Ransack searches
+date: 2021-12-31 00:00:00.000000000 Z
+dependencies: []
+description: Enable enum values in Ransack search
 email:
 - 23730734+shoma07@users.noreply.github.com
 executables: []
@@ -41,20 +27,22 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/ransack/enum.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
+- lib/ransack-enum.rb
+- lib/ransack_enum.rb
+- lib/ransack_enum/adapters.rb
+- lib/ransack_enum/adapters/active_record_6.rb
+- lib/ransack_enum/adapters/active_record_7.rb
+- lib/ransack_enum/configuration.rb
+- lib/ransack_enum/formatter.rb
+- lib/ransack_enum/ransacker.rb
+- lib/ransack_enum/version.rb
 - ransack-enum.gemspec
 homepage: https://github.com/shoma07/ransack-enum
 licenses:
 - MIT
 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/v0.3.0/CHANGELOG.md
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,15 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: Allow Enum values to be used in Ransack searches
+summary: Enable enum values in Ransack search
 test_files: []

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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Ransack
-  module Enum
-    module Adapters
-      module ActiveRecord
-        # Ransack::Enum::Adapters::ActiveRecord::Base
-        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
-          end
-
-          private
-
-          # @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
-
-          # @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?
-
-              Ransack::Nodes::Value.new(nil, value).cast(attribute_types[name]&.type)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'ransack/enum/adapters/active_record/base'
-
-ActiveSupport.on_load(:active_record) do
-  extend Ransack::Enum::Adapters::ActiveRecord::Base
-end

data/lib/ransack/enum/configuration.rb

@@ -1,27 +0,0 @@
-# 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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Ransack
-  module Enum
-    VERSION = '0.3.0'
-  end
-end

data/lib/ransack/enum.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext'
-require 'ransack'
-require 'ransack/enum/version'
-require 'ransack/enum/configuration'
-require 'ransack/enum/adapters/active_record'
-
-module Ransack
-  # Ransack::Enum
-  module Enum
-    extend Configuration
-  end
-end