searchable-by 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '008edf75bb0e4b27410f7e889cbfd26eda27d0391dd7e70be3e984a962ddd756'
+  data.tar.gz: 9b2fbbc4cc13b2cfe6e23998616ec48e49617bfb67db3143f800c5d35134b2df
+SHA512:
+  metadata.gz: 0fa58611207ecef62a12c698be927aa34659e0b19f5c5a4ce6c8c2c87b77df49349fb72a4356683f406a80110727442e854448f4b1dc20bc04527e1981af03a2
+  data.tar.gz: b9dbbde8350310301567ed1ba6cf8a45d80813e7f99415a6e0a6dc6d1a69b4dbd0f340a39851b8db4e291b503f21c2f4f9e8d74311cdaa5fe705a3a06a9201e1

data/.gitignore

@@ -0,0 +1,4 @@
+spec/tmp
+pkg
+*.gem
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require: rubocop-performance
+inherit_from:
+  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+
+AllCops:
+  TargetRubyVersion: "2.4"
+
+Naming/FileName:
+  Exclude:
+    - lib/searchable-by.rb

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.6
+  - 2.5
+  - 2.4
+cache: bundler
+before_install:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    searchable-by (0.5.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    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.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.2.0)
+      rubocop (>= 0.68.0)
+    ruby-progressbar (1.10.0)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  searchable-by!
+  sqlite3
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2019 Black Square Media Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,42 @@
+# Searchable By
+
+ActiveRecord plugin to quickly create search scopes.
+
+## Installation
+
+Add `gem 'searchable-by'` to your Gemfile.
+
+## Usage
+
+```ruby
+class Post < ActiveRecord::Base
+  belongs_to :author
+
+  # Limit the number of terms per query to 3.
+  searchable_by max_terms: 3 do
+    # Allow to search strings.
+    column :title
+
+    # ... and integers.
+    column :id, type: :integer
+
+    # Allow custom arel nodes.
+    column { Author.arel_table[:name] }
+    column { Arel::Nodes::NamedFunction.new('CONCAT', [arel_table[:prefix], arel_table[:suffix]]) }
+
+    # Support custom scopes.
+    scope do
+      joins(:author)
+    end
+  end
+end
+
+# Search for 'alice'
+Post.search_by('alice') # => ActiveRecord::Relation
+
+# Search for 'alice' AND 'pie recipe'
+Post.search_by('alice "pie recipe"')
+
+# Search for 'alice' but NOT for 'pie recipe'
+Post.search_by('alice -"pie recipe"')
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/lib/searchable-by.rb

@@ -0,0 +1 @@
+require 'searchable_by'

data/lib/searchable_by.rb

@@ -0,0 +1,111 @@
+require 'active_record'
+require 'shellwords'
+
+module ActiveRecord
+  module SearchableBy
+    class Config < Hash
+      def initialize
+        update columns: [], max_terms: 5
+        scope { all }
+      end
+
+      def column(*attrs, &block)
+        opts = attrs.extract_options!
+        cols = self[:columns]
+        attrs.each do |attr|
+          cols.push(opts.merge(column: attr))
+        end
+        cols.push(opts.merge(column: block)) if block
+        cols
+      end
+
+      def scope(&block)
+        self[:scope] = block
+      end
+    end
+
+    def self.norm_values(query)
+      values = Shellwords.split(query.to_s)
+      values.flatten!
+      values.reject!(&:blank?)
+      values.uniq!
+      values
+    end
+
+    def self.build_clauses(relations, values)
+      clauses = values.map do |value|
+        negate = value[0] == '-'
+        value.slice!(0) if negate || value[0] == '+'
+
+        c0, *cn = relations.map do |opts|
+          build_condition(opts, value)
+        end.compact
+        next unless c0
+
+        [cn.inject(c0) {|x, part| x.or(part) }, negate]
+      end
+      clauses.compact!
+      clauses
+    end
+
+    def self.build_condition(opts, value)
+      case opts[:type]
+      when :int, :integer
+        begin
+          opts[:rel].eq(Integer(value))
+        rescue ArgumentError
+          nil
+        end
+      else
+        value = value.dup
+        value.gsub!('%', '\%')
+        value.gsub!('_', '\_')
+        opts[:rel].matches("%#{value}%")
+      end
+    end
+
+    module ClassMethods
+      def self.extended(base) # :nodoc:
+        base.class_attribute :_searchable_by_config, instance_accessor: false, instance_predicate: false
+        base._searchable_by_config = Config.new
+        super
+      end
+
+      def inherited(base) # :nodoc:
+        base._searchable_by_config = _searchable_by_config.deep_dup
+        super
+      end
+
+      def searchable_by(max_terms: 5, &block)
+        _searchable_by_config.instance_eval(&block)
+        _searchable_by_config[:max_terms] = max_terms if max_terms
+      end
+
+      # @param [String] query the search query
+      # @return [ActiveRecord::Relation] the scoped relation
+      def search_by(query)
+        columns = _searchable_by_config[:columns]
+        return all if columns.empty?
+
+        values = SearchableBy.norm_values(query).first(_searchable_by_config[:max_terms])
+        return all if values.empty?
+
+        relations = columns.map do |opts|
+          rel = opts[:column].is_a?(Proc) ? opts[:column].call : arel_table[opts[:column]]
+          opts.merge(rel: rel)
+        end
+        clauses = SearchableBy.build_clauses(relations, values)
+        return all if clauses.empty?
+
+        scope = instance_exec(&_searchable_by_config[:scope])
+        clauses.inject(scope) do |x, (clause, negate)|
+          negate ? x.where.not(clause) : x.where(clause)
+        end
+      end
+    end
+  end
+
+  class Base
+    extend SearchableBy::ClassMethods
+  end
+end

data/searchable-by.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'searchable-by'
+  s.version     = '0.5.0'
+  s.authors     = ['Dimitrij Denissenko']
+  s.email       = ['dimitrij@blacksquaremedia.com']
+  s.summary     = 'Generate search scopes'
+  s.description = 'ActiveRecord plugin'
+  s.homepage    = 'https://github.com/bsm/sortable-by'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^spec/}) }
+  s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.4'
+
+  s.add_dependency 'activerecord'
+  s.add_dependency 'activesupport'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/searchable_by_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ActiveRecord::SearchableBy do
+  it 'should ignore bad inputs' do
+    expect(Post.search_by(nil).count).to eq(4)
+    expect(Post.search_by('').count).to eq(4)
+  end
+
+  it 'should generate SQL' do
+    sql = Post.search_by('123').to_sql
+    expect(sql).to include(%("posts"."id" = 123))
+    expect(sql).to include(%("posts"."title" LIKE '%123%'))
+
+    sql = Post.search_by('foo%bar').to_sql
+    expect(sql).not_to include(%("posts"."id"))
+    expect(sql).to include(%("posts"."title" LIKE '%foo\\%bar%'))
+  end
+
+  it 'should search' do
+    expect(Post.search_by('ALICE').pluck(:title)).to match_array(%w[titla title])
+    expect(Post.search_by('bOb').pluck(:title)).to match_array(%w[titlo titlu])
+  end
+
+  it 'should search across multiple words' do
+    expect(Post.search_by('ALICE title').pluck(:title)).to match_array(%w[title])
+  end
+
+  it 'should support search markers' do
+    expect(Post.search_by('aLiCe -title').pluck(:title)).to match_array(%w[titla])
+    expect(Post.search_by('+alice "pie recipe"').pluck(:title)).to match_array(%w[title])
+    expect(Post.search_by('bob -"piu recipe"').pluck(:title)).to match_array(%w[titlo])
+  end
+
+  it 'should search within scopes' do
+    expect(Post.where(title: 'title').search_by('ALICE').pluck(:title)).to match_array(%w[title])
+    expect(Post.where(title: 'title').search_by('bOb').pluck(:title)).to match_array(%w[])
+  end
+
+  it 'should search integers' do
+    expect(Post.search_by(POSTS[:alice1].id.to_s).count).to eq(1)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+ENV['RACK_ENV'] ||= 'test'
+require 'searchable-by'
+require 'rspec'
+
+ActiveRecord::Base.configurations['test'] = { 'adapter' => 'sqlite3', 'database' => ':memory:' }
+ActiveRecord::Base.establish_connection :test
+
+ActiveRecord::Base.connection.instance_eval do
+  create_table :authors do |t|
+    t.string  :name
+  end
+  create_table :posts do |t|
+    t.integer :author_id, null: false
+    t.string  :title
+    t.text    :body
+  end
+end
+
+class AbstractModel < ActiveRecord::Base
+  self.abstract_class = true
+
+  searchable_by do
+    column :id, type: :integer
+  end
+end
+
+class Author < AbstractModel
+  has_many :posts
+end
+
+class Post < AbstractModel
+  belongs_to :author
+
+  searchable_by do
+    column :title, :body
+    column { Author.arel_table[:name] }
+
+    scope do
+      joins(:author)
+    end
+  end
+end
+
+AUTHORS = {
+  alice: Author.create!(name: 'Alice'),
+  bob: Author.create!(name: 'Bob'),
+}.freeze
+
+POSTS = {
+  alice1: AUTHORS[:alice].posts.create!(title: 'titla', body: 'my pia recipe '),
+  alice2: AUTHORS[:alice].posts.create!(title: 'title', body: 'your pie recipe'),
+  bob1: AUTHORS[:bob].posts.create!(title: 'titlo', body: 'her pio recipe'),
+  bob2: AUTHORS[:bob].posts.create!(title: 'titlu', body: 'our piu recipe'),
+}.freeze

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: searchable-by
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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'
+- !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: ActiveRecord plugin
+email:
+- dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/searchable-by.rb
+- lib/searchable_by.rb
+- searchable-by.gemspec
+- spec/searchable_by_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/sortable-by
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+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: Generate search scopes
+test_files:
+- spec/searchable_by_spec.rb
+- spec/spec_helper.rb