pickel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fa31bd97a0458d27fea84bf3ca88f40d5dbb02ed1767425eb5b3604ede6f84a
+  data.tar.gz: fe14b35abfc0466b78714acd5fd824f6ac162f55a3296a230ca3e4dd35985efb
+SHA512:
+  metadata.gz: a408d3e7b92cc62e94bd8fe2b6c85ae62a1dbee88cbbb60f9685dc9fc3007213e3177c794ccae84aa17d5452207a5948e7401942a4ee80645fc27dcedefa76e1
+  data.tar.gz: 4252f85ab7ccc8d61b372ffd153a1ba9397f30e08a87be8b8362a6c5b77ae3ff2ce0d887afe53c5db7a6a15cec222055675c8698ef6468096f1083610ceb09fc

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+  - ruby-head
+before_install:
+  - gem update --system
+  - gem update bundler
+
+gemfile:
+  - gemfiles/activerecord_52.gemfile
+  - gemfiles/activerecord_60.gemfile
+  - gemfiles/activerecord_edge.gemfile
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - gemfile: gemfiles/activerecord_edge.gemfile

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sinsoku.listy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 sinsoku
+
+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,93 @@
+[![Build Status](https://travis-ci.org/sinsoku/pickel.svg?branch=master)](https://travis-ci.org/sinsoku/pickel)
+
+# Pickel
+
+Pickel provides methods that make it easy to build a search form for your Rails app.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'pickel'
+```
+
+## Usage
+
+1. Allow parameters available for search.
+2. Create an object with the `Pickel.search` method.
+3. Create a search form with the `form_for` method.
+
+### In controller
+
+```ruby
+def index
+  search_params = Pickel.permit(params, :name, :age_gt, :posts_title_start)
+  @search = Pickel.search(User, search_params)
+  @users = @search.result
+end
+```
+
+### In view
+
+```erb
+<%= form_for @search do |f| %>
+  <%# Search records contains the value %>
+  <%= f.label :name_cont %>
+  <%= f.search_field :name_cont %>
+
+  <%# Search records grater than the value %>
+  <%= f.label :age_gt %>
+  <%= f.number_field :age_gt %>
+
+  <%# Search records an associated posts.title starts with the value %>
+  <%= f.label :posts_title_start %>
+  <%= f.search_field :posts_title_start %>
+
+  <%= f.submit %>
+<% end %>
+```
+
+## Support predicates
+
+| Predicate     | Description                        |
+|---------------|------------------------------------|
+| `*_eq`        | equals                             |
+| `*_not_eq`    | not equal                          |
+| `*_in`        | in                                 |
+| `*_not_in`    | not in                             |
+| `*_lt`        | less than                          |
+| `*_lteq`      | less than or equal                 |
+| `*_gt`        | greater than                       |
+| `*_gteq`      | greater than or equal              |
+| `*_matches`   | matches with `LIKE`                |
+| `*_cont`      | contains                           |
+| `*_not_cont`  | not contain                        |
+| `*_start`     | starts                             |
+| `*_not_start` | not start                          |
+| `*_end`       | ends                               |
+| `*_not_end`   | not end                            |
+| `*_true`      | is `true`                          |
+| `*_false`     | is `false`                         |
+| `*_null`      | is `NULL`                          |
+| `*_not_null`  | is not `NULL`                      |
+| `*_blank`     | is `NULL` or empty string          |
+| `*_present`   | is not `NULL` and not empty string |
+
+## 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/sinsoku/pickel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pickel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sinsoku/pickel/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pickel"
+
+# 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/gemfiles/activerecord_52.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+
+gemspec path: ".."

data/gemfiles/activerecord_60.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0.rc1"
+
+gemspec path: ".."

data/gemfiles/activerecord_edge.gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+github "rails/rails" do
+  gem "activerecord"
+end
+
+gemspec path: ".."

data/lib/pickel.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support/lazy_load_hooks'
+
+require "pickel/condition"
+require "pickel/predicate"
+require "pickel/search"
+require "pickel/version"
+
+module Pickel
+  class << self
+    def search(klass, search_params)
+      Search.new(klass.all, search_params)
+    end
+
+    def permit(params, *filters)
+      return {} unless params.key?(:q)
+
+      expanded = filters.flat_map do |f|
+        Predicate.find(f.to_s) ? f : Predicate.all.map { |predicate| "#{f}_#{predicate.id}".to_sym }
+      end
+      params[:q].permit(*expanded).to_h.reject { |_, v| v.blank? }
+    end
+  end
+end
+
+ActiveSupport.on_load :action_controller do
+  require "pickel/view_helper"
+  ::ActionController::Base.helper(Pickel::ViewHelper)
+end

data/lib/pickel/condition.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Pickel
+  class Condition
+    class << self
+      def for(klass, key)
+        s_key = key.to_s
+        predicate = Predicate.find(s_key)
+
+        cond = new(klass: klass, predicate: predicate)
+        new_key = s_key.delete_suffix("_#{predicate.id}")
+        cond.assign_column(new_key)
+      end
+    end
+
+    def initialize(klass:, predicate:, column: nil, target: nil, join_tables: [])
+      @klass = klass
+      @predicate = predicate
+      @column = column
+      @target = target
+      @join_tables = join_tables
+    end
+    attr_reader :klass, :predicate, :column, :target, :join_tables
+
+    def assign_column(key, target: klass, join_tables: [])
+      base = { klass: klass, predicate: predicate, target: target, join_tables: join_tables }
+      return Condition.new(base.merge(column: key)) if target.attribute_names.include?(key)
+
+      association = target.reflect_on_all_associations.find { |a| key.start_with?(a.name.to_s) }
+      if association
+        new_key = key.delete_prefix("#{association.name}_")
+        join_tables << association.name
+        new_target = association.klass
+
+        assign_column(new_key, target: new_target, join_tables: join_tables)
+      else
+        Condition.new(base.merge(predicate: nil))
+      end
+    end
+
+    def build(value)
+      return klass.all if predicate.nil?
+
+      rel = predicate.build(target, column, value)
+      join_tables.empty? ? rel : join_relation.merge(rel)
+    end
+
+    private
+
+    def join_relation
+      args = join_tables.reverse_each.inject { |a, b| { b => a } }
+      klass.joins(args)
+    end
+  end
+end

data/lib/pickel/predicate.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Pickel
+  class Predicate
+    AREL = %i[eq in not_eq not_in lt lteq gt gteq matches].freeze
+    MATCHES = %i[cont start end].flat_map { |x| [x, "not_#{x}".to_sym] }.freeze
+    LITERAL = %i[true false null].flat_map { |x| [x, "not_#{x}".to_sym] }.freeze
+    DERIVED = %i[blank present].freeze
+    ESCAPE_ADAPTERS = %w[Mysql2 PostgreSQL].freeze
+
+    class << self
+      def all
+        @all ||= [AREL, MATCHES, LITERAL, DERIVED].flatten
+          .sort_by { |id| -id.size }.map { |id| new(id) }
+      end
+
+      def find(id)
+        all.find { |predicate| id.end_with?("_#{predicate.id}") }
+      end
+    end
+
+    def initialize(id)
+      @id = id
+    end
+    attr_reader :id
+
+    def build(klass, column, value)
+      v = convert(value)
+      args =
+        case id
+        when *AREL
+          klass.arel_table[column].public_send(id, v)
+        when *MATCHES
+          klass.arel_table[column].matches(v)
+        when :blank
+          klass.arel_table[column].eq_any([nil, ''])
+        when :present
+          klass.arel_table[column].not_eq_all([nil, ''])
+        else
+          { column => v }
+        end
+
+      when_not?(value) ? klass.where.not(args) : klass.where(args)
+    end
+
+    private
+
+    def convert(value)
+      case id
+      when :cont, :not_cont
+        "%#{escape_wildcards(value)}%"
+      when :start, :not_start
+        "#{escape_wildcards(value)}%"
+      when :end, :not_end
+        "%#{escape_wildcards(value)}"
+      when :true, :not_true
+        true
+      when :false, :not_false
+        false
+      when :null, :not_null
+        nil
+      else
+        value
+      end
+    end
+
+    def cast_bool(value)
+      ActiveModel::Type::Boolean.new.cast(value)
+    end
+
+    # replace % \ to \% \\
+    def escape_wildcards(unescaped)
+      if ESCAPE_ADAPTERS.include?(ActiveRecord::Base.connection.adapter_name)
+        unescaped.to_s.gsub(/([\\%_.])/, '\\\\\\1')
+      else
+        unescaped
+      end
+    end
+
+    def when_not?(value)
+      return false if AREL.include?(id)
+
+      id.to_s.start_with?('not') || !cast_bool(value)
+    end
+  end
+end

data/lib/pickel/search.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Pickel
+  class Search
+    include ActiveModel::Model
+
+    def initialize(relation, params = {})
+      @relation = relation
+      @klass = relation.klass
+      @params = params || {}
+      @sorts = []
+      @sorts << @params.delete(:s)
+      @sorts << @params.delete(:sorts)
+      @sorts.compact!
+    end
+    attr_reader :relation, :klass, :params, :sorts
+    alias s sorts
+
+    def sorts=(args)
+      @sorts = args
+    end
+    alias s= sorts=
+
+    def result
+      conditions = params.map { |k, v| Condition.for(klass, k).build(v) }
+
+      if sorts.empty?
+        conditions.inject(relation, :merge)
+      else
+        conditions.inject(relation, :merge).order(sorts)
+      end
+    end
+
+    def html_id
+      "#{klass.to_s.underscore}_search"
+    end
+
+    def respond_to?(name, include_all = false)
+      super || params.key?(name)
+    end
+
+    def method_missing(method_id, *args)
+      method_name = method_id.to_s
+      getter_name = method_name.delete_suffix('=')
+      predicate = Predicate.find(getter_name)
+
+      if predicate && method_name.end_with?('=')
+        params[getter_name] = *args
+      elsif predicate
+        params[getter_name]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/pickel/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pickel
+  VERSION = "0.1.0"
+end

data/lib/pickel/view_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Pickel
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    def submit(value = nil, options = {})
+      value, options = nil, value if value.is_a?(Hash)
+      value ||= '検索' # TODO: I18n support
+      super(value, options)
+    end
+  end
+
+  module ViewHelper
+    def form_with(model: nil, scope: nil, url: nil, format: nil, **options)
+      return super unless model.is_a?(Search)
+
+      url ||= polymorphic_path(model.klass, format: format)
+      scope ||= :q
+      options[:builder] ||= FormBuilder
+      options[:id] ||= model.html_id
+      options[:class] ||= model.html_id
+      options[:method] ||= :get
+
+      super(model: model, scope: scope, url: url, **options)
+    end
+
+    def form_for(record, options = {}, &block)
+      return super unless record.is_a?(Search)
+
+      opts = options.dup
+      opts[:scope] = opts.delete(:as)
+      opts[:local] = !(opts.delete(:remote) == true)
+
+      form_with(model: record, **opts, &block)
+    end
+  end
+end

data/pickel.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pickel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pickel"
+  spec.version       = Pickel::VERSION
+  spec.authors       = ["sinsoku"]
+  spec.email         = ["sinsoku.listy@gmail.com"]
+
+  spec.summary       = "A plugin that make it easy to build a search form"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/sinsoku/pickel"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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 "activerecord", ">= 5.0"
+
+  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"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: pickel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sinsoku
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A plugin that make it easy to build a search form
+email:
+- sinsoku.listy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/activerecord_52.gemfile
+- gemfiles/activerecord_60.gemfile
+- gemfiles/activerecord_edge.gemfile
+- lib/pickel.rb
+- lib/pickel/condition.rb
+- lib/pickel/predicate.rb
+- lib/pickel/search.rb
+- lib/pickel/version.rb
+- lib/pickel/view_helper.rb
+- pickel.gemspec
+homepage: https://github.com/sinsoku/pickel
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sinsoku/pickel
+  source_code_uri: https://github.com/sinsoku/pickel
+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: A plugin that make it easy to build a search form
+test_files: []