ransack-enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97f30e49879d033fe4c565d88b0684425231f15f587e8aec3c172733f93933c1
+  data.tar.gz: ca2b830be92aa094cff2582b3bba3564a39c13a00470c220f2fe74be470491d6
+SHA512:
+  metadata.gz: 8c66bafa64fe674569f78b7221ecd2090d311423e69fe937623aff056134536650bed8283a724ff5cb952e4793578772b330085750b72bf331dd2746f21ecb26
+  data.tar.gz: f516648b499dbab637d630b237501fc1a357f8d0994e507dcdd7f7ebb49f83b52307580bff7908675ad0c860fcde7ae8ed779337b3105139785ba97735cd7fea

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+.DS_Store
+Gemfile.lock
+.rspec
+
+# rspec failure tracking
+.rspec_status

data/.rubocop.yml

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0 / 2019-11-30
+### New features
+- create gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ransack-enum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 shoma07
+
+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,65 @@
+# Ransack::Enum
+
+Allow Enum values to be used in [Ransack](https://github.com/activerecord-hackery/ransack) searches.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ransack-enum',
+    git: 'https://github.com/shoma07/ransack-enum.git',
+    branch: 'master'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+When enum is defined in ActiveRecord, the search method of ransack is redefined.
+There is no need to add any special code.
+
+```ruby
+class Post < ActiveRecord::Base
+  enum status: { unpublished: 0, published: 1 }
+end
+```
+
+### Search by enum value.
+
+```ruby
+Post.ransack(status_eq: 'published').result.to_sql
+# SELECT "posts".* FROM "posts" WHERE "posts"."status" = 1
+Post.ransack(status_in: %w[unpublished published]).result.to_sql
+# SELECT "posts".* FROM "posts" WHERE "posts"."status" IN (0, 1)
+```
+
+### Search with actual values as before.
+
+```ruby
+Post.ransack(status_eq: 1).result.to_sql
+# SELECT "posts".* FROM "posts" WHERE "posts"."status" = 1
+Post.ransack(status_in: [0, 1]).result.to_sql
+# SELECT "posts".* FROM "posts" WHERE "posts"."status" IN (0, 1)
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shoma07/ransack-enum.
+
+## 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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+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.
+
+# (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/ransack/enum.rb

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

data/lib/ransack/enum/adapters.rb

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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,53 @@
+# 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
+          def enum(definitions)
+            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]
+
+                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
+
+              formatter = proc do |val|
+                if val.is_a?(Array)
+                  val.map { |v| fmt.call(v) }
+                else
+                  fmt.call(val)
+                end
+              end
+
+              ransacker name.to_sym, formatter: formatter
+            end
+          end
+          # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+        end
+      end
+    end
+  end
+end

data/lib/ransack/enum/version.rb

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

data/ransack-enum.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ransack/enum/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ransack-enum"
+  spec.version       = Ransack::Enum::VERSION
+  spec.authors       = ["shoma07"]
+  spec.email         = ["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.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"
+
+  # 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
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  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.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"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ransack-enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shoma07
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-30 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
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/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/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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Allow Enum values to be used in Ransack searches
+test_files: []