mobility-ransack 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e1f7aa59365ce176d9a5baccd87f8091b1d5c23f4532b66c019cf4766b23e43
-  data.tar.gz: 81b3dc8e4294177dbdad6b2403057adfd41756c103e0e803369e7c4a62884140
+  metadata.gz: 9e2b2fb4a83837ab504f3094122475e7f3dd47370419e475553eb6a50dcd32b6
+  data.tar.gz: afbe3bacb2c1acbf5d2e83f07c72e03f51ff02aab08b1de8e00f59ecb4ba06b8
 SHA512:
-  metadata.gz: 6f7daffdd7c1f8bb740628ffdbdfe5f52322705afaf970d56a7a7cd56bd06b14673c4af4897c0080bc6d74867d69b8beb5a1b4cda00051d763b98a04e41bbebf
-  data.tar.gz: ae9f596d2d64ff45b5f7a3e562c04dd6ee6fc9e593fddd91f92cc1294384a355360d30d6e75089f22d0ee92ce42755c67706d528c57ec971d23f578e0c2e6f25
+  metadata.gz: 9746d4b0acf3509a5080bfc091b364cc4774b4e62e2c43824f68c286f5c2d2c3776f31024b5b13d113d2b1324abba4745f5b8cba2bb31d0927f86a572f87582f
+  data.tar.gz: a17f31df6addb9f42a6c22e0a081746dc9a07d67538596588801bab37d2ce210105921e3193e1019c1b4bbab99d895965e6994d6ee90e1d0c45ddf068a89fc44

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Mobility Ransack Changelog
 
+## 0.2
+
+### 0.2.2
+- Remove version pinning for Ransack dependency
+  ([#6](https://github.com/shioyama/mobility-ransack/pull/6)), thanks
+  [peterwalker](https://github.com/petewalker)!
+
+### 0.2.1
+- Extend ransack search with module
+  ([#4](https://github.com/shioyama/mobility-ransack/pull/4))
+- Refactor `Mobility::Plugins::Ransack.apply`
+  ([#3](https://github.com/shioyama/mobility-ransack/pull/3))
+
+### 0.2.0
+
+- Support sorting on translated attributes
+  ([#2](https://github.com/shioyama/mobility-ransack/pull/2))
+
 ## 0.1
 
 ### 0.1.1
@@ -9,5 +27,7 @@
 ### 0.1.0
 - Loosen Ransack dependency to allow up to 2.1
 
+## 0.0
+
 ### 0.0.1
 - Add plugin code.

data/Gemfile

@@ -6,15 +6,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 group :development, :test do
-  if ENV['RAILS_VERSION'] == '5.1'
-    gem 'rails', '>= 5.1', '< 5.2'
-  elsif ENV['RAILS_VERSION'] == '5.0'
-    gem 'rails', '>= 5.0', '< 5.1'
-  else
-    gem 'rails', '>= 5.2.0.rc2', '< 5.3'
-    # see: https://github.com/activerecord-hackery/ransack/issues/948#issuecomment-412414365
-    gem 'ransack', '~> 2.0.0'
-  end
+  gem 'rails', "~> #{ENV['RAILS_VERSION'] || '6.0'}"
 
   gem 'pry'
   gem 'pry-byebug'

data/Gemfile.lock

@@ -1,166 +1,182 @@
 PATH
   remote: .
   specs:
-    mobility-ransack (0.1.0)
-      mobility (~> 0.8.0)
-      ransack (>= 1.8.0, < 2.1)
+    mobility-ransack (1.0.0)
+      mobility (~> 1.0.0)
+      ransack (>= 1.8.0, < 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.1)
-      actionpack (= 5.2.1)
+    actioncable (6.0.3.4)
+      actionpack (= 6.0.3.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.1)
-      actionpack (= 5.2.1)
-      actionview (= 5.2.1)
-      activejob (= 5.2.1)
+    actionmailbox (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.1)
-      actionview (= 5.2.1)
-      activesupport (= 5.2.1)
-      rack (~> 2.0)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.1)
-      activesupport (= 5.2.1)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.1)
-      activesupport (= 5.2.1)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.4)
+      activesupport (= 6.0.3.4)
       globalid (>= 0.3.6)
-    activemodel (5.2.1)
-      activesupport (= 5.2.1)
-    activerecord (5.2.1)
-      activemodel (= 5.2.1)
-      activesupport (= 5.2.1)
-      arel (>= 9.0)
-    activestorage (5.2.1)
-      actionpack (= 5.2.1)
-      activerecord (= 5.2.1)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activestorage (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
       marcel (~> 0.3.1)
-    activesupport (5.2.1)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
-    builder (3.2.3)
-    byebug (10.0.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    byebug (11.1.1)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    database_cleaner (1.8.4)
     diff-lcs (1.3)
-    erubi (1.7.1)
-    globalid (0.4.1)
+    erubi (1.9.0)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.0.1)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.2)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.7.0)
+    mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.2)
+    marcel (0.3.3)
       mimemagic (~> 0.3.2)
-    method_source (0.9.0)
-    mimemagic (0.3.2)
-    mini_mime (1.0.1)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    mobility (0.8.0)
-      i18n (>= 0.6.10, < 1.1)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.2)
+    mobility (1.0.0)
+      i18n (>= 0.6.10, < 2)
       request_store (~> 1.0)
-    nio4r (2.3.1)
-    nokogiri (1.8.4)
-      mini_portile2 (~> 2.3.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    rack (2.0.5)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.1)
-      actioncable (= 5.2.1)
-      actionmailer (= 5.2.1)
-      actionpack (= 5.2.1)
-      actionview (= 5.2.1)
-      activejob (= 5.2.1)
-      activemodel (= 5.2.1)
-      activerecord (= 5.2.1)
-      activestorage (= 5.2.1)
-      activesupport (= 5.2.1)
+    rails (6.0.3.4)
+      actioncable (= 6.0.3.4)
+      actionmailbox (= 6.0.3.4)
+      actionmailer (= 6.0.3.4)
+      actionpack (= 6.0.3.4)
+      actiontext (= 6.0.3.4)
+      actionview (= 6.0.3.4)
+      activejob (= 6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activerecord (= 6.0.3.4)
+      activestorage (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       bundler (>= 1.3.0)
-      railties (= 5.2.1)
+      railties (= 6.0.3.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.1)
-      actionpack (= 5.2.1)
-      activesupport (= 5.2.1)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
-    rake (10.5.0)
-    ransack (2.0.1)
-      actionpack (>= 5.0)
-      activerecord (>= 5.0)
-      activesupport (>= 5.0)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    ransack (2.4.0)
+      activerecord (>= 5.2.4)
+      activesupport (>= 5.2.4)
       i18n
-    request_store (1.4.1)
+    request_store (1.5.0)
       rack (>= 1.4)
-    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.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sprockets (3.7.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.13)
-    thor (0.20.0)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  database_cleaner (~> 1.7, >= 1.7.0)
   mobility-ransack!
   pry
   pry-byebug
-  rails (>= 5.2.0.rc2, < 5.3)
-  rake (~> 10.0)
-  ransack (~> 2.0.0)
+  rails (~> 6.0)
+  rake (>= 12.3.3)
   rspec (~> 3.0)
-  sqlite3
+  sqlite3 (~> 1.3, >= 1.3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.0.2

data/README.md

@@ -2,10 +2,12 @@ Mobility Ransack
 ================
 
 [![Gem Version](https://badge.fury.io/rb/mobility-ransack.svg)][gem]
-[![Build Status](https://travis-ci.org/shioyama/mobility-ransack.svg?branch=master)][travis]
+[![Build Status](https://github.com/shioyama/mobility-ransack/workflows/CI/badge.svg)][actions]
+[![Code Climate](https://api.codeclimate.com/v1/badges/2494f02bcd6b65a545fa/maintainability.svg)][codeclimate]
 
-[gem]: https://rubygems.org/gems/friendly_id-mobility
-[travis]: https://travis-ci.org/shioyama/friendly_id-mobility
+[gem]: https://rubygems.org/gems/mobility-ransack
+[actions]: https://github.com/shioyama/mobility-ransack/actions
+[codeclimate]: https://codeclimate.com/github/shioyama/mobility-ransack
 
 Search on translated attributes with
 [Mobility](https://github.com/shioyama/mobility) and
@@ -16,29 +18,31 @@ Search on translated attributes with
 Just add the gem to your Gemfile:
 
 ```ruby
-gem 'mobility-ransack', '~> 0.1.1'
+gem 'mobility-ransack', '~> 1.0.0'
 ```
 
-Now enable the `ransack` plugin in Mobility's configuration so that it can be
-used, and optionally set the value for the `:ransack` key in `default_options`
-to `true` to enable it for all translated attributes on all models.
+(For Mobility versions earlier than 1.0, replace `1.0.0` with `0.2.2`, but be
+aware this version is no longer supported.)
+
+Now enable the `ransack` plugin in Mobility's configuration:
 
 ```ruby
-Mobility.configure do |config|
-  # ...
-  config.plugins += [:ransack]
-  # config.default_options[:ransack] = true
+Mobility.configure do
+  plugins do
+    ransack
+
+    # ...
+  end
 end
 ```
 
-If you left the `default_options` line above commented out, you will need to
-explicitly enable ransack for each attribute you want to search on with the
-`ransack` option, like this:
+This will enable the ransack plugin for all models. Disable it by passing
+`false` to the `ransack` option:
 
 ```ruby
 class Post < ApplicationRecord
   extend Mobility
-  translates :foo, ransack: true
+  translates :foo, ransack: false
 end
 ```
 

data/lib/mobility/plugins/ransack.rb

@@ -4,36 +4,52 @@ require "mobility"
 module Mobility
   module Plugins
     module Ransack
+      extend Plugin
+
+      default true
+      requires :backend, include: :before
+      requires :active_record
+
       # Applies ransack plugin.
       # @param [Attributes] attributes
       # @param [Boolean] option
-      def self.apply(attributes, option)
-        if option
-          backend_class = attributes.backend_class
-          plugin = self
-          attributes.model_class.class_eval do
-            attributes.each do |attr|
-              ransacker(attr) { backend_class.build_node(attr, Mobility.locale) }
-            end
-            extend plugin
+      included_hook do |klass, backend_class|
+        if options[:ransack]
+          names.each do |name|
+            klass.ransacker(name) { backend_class.build_node(name, Mobility.locale) }
           end
+          klass.extend ClassMethods
         end
       end
 
-      def ransack(params = {}, options = {})
-        Search.new(self, params, options)
+      module ClassMethods
+        def ransack(*)
+          super.extend(Search)
+        end
       end
 
-      class Search < ::Ransack::Search
+      module Search
         def result(opts = {})
-          conditions.inject(super) do |relation, condition|
-            predicate = condition.arel_predicate
-            (condition.attributes.compact.flatten.map(&:name) & object.mobility_attributes).inject(relation) do |i18n_rel, attr|
-              object.mobility_backend_class(attr).apply_scope(i18n_rel, predicate)
-            end
+          sorted = sorts.inject(super) do |relation, sort|
+            predicate = ::Ransack::Visitor.new.visit_Ransack_Nodes_Sort(sort)
+            apply_mobility_scope(relation, predicate, [sort.attr_name])
+          end
+          conditions.inject(sorted) do |relation, condition|
+            apply_mobility_scope(relation, condition.arel_predicate, condition.attributes.compact.flatten.map(&:name))
+          end
+        end
+
+        private
+
+        def apply_mobility_scope(relation, predicate, attributes)
+          mobility_attributes = attributes.select { |attr| object.mobility_attribute?(attr) }
+          mobility_attributes.inject(relation) do |i18n_rel, attr|
+            object.mobility_backend_class(attr).apply_scope(i18n_rel, predicate)
           end
         end
       end
     end
+
+    register_plugin(:ransack, Ransack)
   end
 end

data/lib/mobility/ransack/version.rb

@@ -1,5 +1,5 @@
 module Mobility
   module Ransack
-    VERSION = "0.1.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mobility-ransack
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Salzberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-12 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ransack
@@ -19,7 +19,7 @@ dependencies:
         version: 1.8.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,35 +29,35 @@ dependencies:
         version: 1.8.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mobility
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -78,15 +78,41 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: 1.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description:
 email:
 - chris@dejimata.com
 executables: []
@@ -106,7 +132,7 @@ homepage: https://github.com/shioyama/mobility-ransack
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,9 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Search attributes translated by Mobility with Ransack.
 test_files: []