search_cop 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d50fc64d55fb96b64906163d2f2e88f253974e8aeb0653307795fcab40eb636
-  data.tar.gz: 86184be05de8b457dbe709c89c4938aa35f600adf5cd1c20d38819a1ba933b86
+  metadata.gz: a1f72257612f45ef71a297f5ae8924fca0d8dad9f3c19e6e0b6e2c96e60f36ac
+  data.tar.gz: 2aa35b3f92c08cd24266d28f4c1e3fe195b627bb478be415ff4669b2344676de
 SHA512:
-  metadata.gz: abc70826323ea53b7966a415d78f18a64a10e004e9e6e08687c6118ebcd60964a5732691706c3d2d52aea05d919d9154484c57517a4882b4f9056518bf8ab4f3
-  data.tar.gz: 47c56ea7175559e06bbde1c830f6dc8437279cfb6639446babc6d2b731a86037c815fb8664f4fba64f6832cac33168a6e6f86cf79275cc410eec1b0cce17fb72
+  metadata.gz: ee27a86501f8c3f2588f50b5d78889b8ad6ae9e2d28fcd219617d4839590f61d98c80850f8247da34a5081e12075315d53918a61b3b9636618645d138fd7bd4c
+  data.tar.gz: 046c39f90c8a541d1e000f95772fb5d8eeb2095fc8afe8717b5b95f5672576d988375853525243923852029728d485b3cfd1046f6bd68c9134065738a69f31bf

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 
 # Changelog
 
+Version 1.3.0:
+
+* Support json fields for postgres, mysql and sqlite
+* Support jsonb and hstore fields for postgres
+* Add support for timestamptz for postgres
+
 Version 1.2.3:
 
 * Fix table name for namespaced and inherited models #70 #67

data/Gemfile

@@ -4,7 +4,13 @@ source "https://rubygems.org"
 gemspec
 
 platforms :ruby do
+  gem "activerecord", ">= 3.0.0"
+  gem "bundler"
+  gem "factory_bot"
+  gem "minitest"
   gem "mysql2"
   gem "pg"
+  gem "rake"
+  gem "rubocop"
   gem "sqlite3"
 end

data/README.md

@@ -103,8 +103,9 @@ Book.search("Harry Potter")
 # ... WHERE (books.title LIKE '%Harry%' OR books.description LIKE '%Harry%' OR ...) AND (books.title LIKE '%Potter%' OR books.description LIKE '%Potter%' ...)
 
 Book.search("available:yes OR created_at:2014")
-# ... WHERE books.available = 1 OR (books.created_at >= '2014-01-01 00:00:00' and books.created_at <= '2014-12-31 00:00:00')
+# ... WHERE books.available = 1 OR (books.created_at >= '2014-01-01 00:00:00.00000' and books.created_at <= '2014-12-31 23:59:59.99999')
 ```
+SearchCop is using ActiveSupport's beginning_of_year and end_of_year methods for the values used in building the SQL query for this case.
 
 Of course, these `LIKE '%...%'` queries won't achieve optimal performance, but
 check out the section below on SearchCop's fulltext capabilities to
@@ -135,6 +136,30 @@ to prevent SQL injection. While we can never be 100% safe from security issues,
 SearchCop takes security issues seriously. Please report responsibly via
 security at flakks dot com in case you find any security related issues.
 
+## json/jsonb/hstore
+
+SearchCop supports json fields for MySQL, as well as json, jsonb and hstore
+fields for postgres. Currently, field values are always expected to be strings
+and no arrays are supported. You can specify json attributes via:
+
+```ruby
+search_scope :search do
+  attributes user_agent: "context->browser->user_agent"
+
+  # ...
+end
+```
+
+where `context` is a json/jsonb column which e.g. contains:
+
+```json
+{
+  "browser": {
+    "user_agent": "Firefox ..."
+  }
+}
+```
+
 ## Fulltext index capabilities
 
 By default, i.e. if you don't tell SearchCop about your fulltext indices,

data/docker-compose.yml

@@ -6,10 +6,11 @@ services:
     environment:
       - MYSQL_ALLOW_EMPTY_PASSWORD=yes
       - MYSQL_ROOT_PASSWORD=
+      - MYSQL_DATABASE=search_cop
     ports:
       - 3306:3306
   postgres:
-    image: postgres:9.6.6
+    image: styriadigital/postgres_hstore:10
     environment:
       POSTGRES_DB: search_cop
       POSTGRES_USER: search_cop

data/gemfiles/rails5.gemfile

@@ -5,8 +5,13 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.1"
 
 platforms :ruby do
+  gem "bundler"
+  gem "factory_bot"
+  gem "minitest"
   gem "mysql2"
   gem "pg"
+  gem "rake"
+  gem "rubocop"
   gem "sqlite3"
 end
 

data/gemfiles/rails6.gemfile

@@ -5,8 +5,13 @@ source "https://rubygems.org"
 gem "activerecord", "~> 6.0"
 
 platforms :ruby do
+  gem "bundler"
+  gem "factory_bot"
+  gem "minitest"
   gem "mysql2"
   gem "pg"
+  gem "rake"
+  gem "rubocop"
   gem "sqlite3"
 end
 

data/gemfiles/rails7.gemfile

@@ -5,8 +5,13 @@ source "https://rubygems.org"
 gem "activerecord", "~> 7.0"
 
 platforms :ruby do
+  gem "bundler"
+  gem "factory_bot"
+  gem "minitest"
   gem "mysql2"
   gem "pg"
+  gem "rake"
+  gem "rubocop"
   gem "sqlite3"
 end
 

data/lib/search_cop/version.rb

@@ -1,3 +1,3 @@
 module SearchCop
-  VERSION = "1.2.3"
+  VERSION = "1.3.0"
 end

data/lib/search_cop/visitors/mysql.rb

@@ -3,6 +3,10 @@ module SearchCop
     module Mysql
       # rubocop:disable Naming/MethodName
 
+      def visit_SearchCopGrammar_Attributes_Json(attribute)
+        "#{quote_table_name attribute.table_alias}.#{quote_column_name attribute.column_name}->#{quote "$.#{attribute.field_names.join(".")}"}"
+      end
+
       class FulltextQuery < Visitor
         def visit_SearchCopGrammar_Nodes_MatchesFulltextNot(node)
           node.right.split(/[\s+'"<>()~-]+/).collect { |word| "-#{word}" }.join(" ")
@@ -38,8 +42,8 @@ module SearchCop
       def visit_SearchCopGrammar_Nodes_FulltextExpression(node)
         "MATCH(#{visit node.collection}) AGAINST(#{visit FulltextQuery.new(connection).visit(node.node)} IN BOOLEAN MODE)"
       end
-    end
 
-    # rubocop:enable Naming/MethodName
+      # rubocop:enable Naming/MethodName
+    end
   end
 end

data/lib/search_cop/visitors/postgres.rb

@@ -3,6 +3,22 @@ module SearchCop
     module Postgres
       # rubocop:disable Naming/MethodName
 
+      def visit_SearchCopGrammar_Attributes_Json(attribute)
+        elements = ["#{quote_table_name attribute.table_alias}.#{quote_column_name attribute.column_name}", *attribute.field_names.map { |field_name| quote(field_name) }]
+
+        "#{elements[0...-1].join("->")}->>#{elements.last}"
+      end
+
+      def visit_SearchCopGrammar_Attributes_Jsonb(attribute)
+        elements = ["#{quote_table_name attribute.table_alias}.#{quote_column_name attribute.column_name}", *attribute.field_names.map { |field_name| quote(field_name) }]
+
+        "#{elements[0...-1].join("->")}->>#{elements.last}"
+      end
+
+      def visit_SearchCopGrammar_Attributes_Hstore(attribute)
+        "#{quote_table_name attribute.table_alias}.#{quote_column_name attribute.column_name}->#{quote attribute.field_names.first}"
+      end
+
       class FulltextQuery < Visitor
         def visit_SearchCopGrammar_Nodes_MatchesFulltextNot(node)
           "!'#{node.right.gsub(/[\s&|!:'"]+/, " ")}'"

data/lib/search_cop/visitors/sqlite.rb

@@ -0,0 +1,13 @@
+module SearchCop
+  module Visitors
+    module Sqlite
+      # rubocop:disable Naming/MethodName
+
+      def visit_SearchCopGrammar_Attributes_Json(attribute)
+        "json_extract(#{quote_table_name attribute.table_alias}.#{quote_column_name attribute.column_name}, #{quote "$.#{attribute.field_names.join(".")}"})"
+      end
+
+      # rubocop:enable Naming/MethodName
+    end
+  end
+end

data/lib/search_cop/visitors/visitor.rb

@@ -10,10 +10,11 @@ module SearchCop
 
         extend(SearchCop::Visitors::Mysql) if @connection.adapter_name =~ /mysql/i
         extend(SearchCop::Visitors::Postgres) if @connection.adapter_name =~ /postgres|postgis/i
+        extend(SearchCop::Visitors::Sqlite) if @connection.adapter_name =~ /sqlite/i
       end
 
       def visit(visit_node = node)
-        send "visit_#{visit_node.class.name.gsub(/::/, "_")}", visit_node
+        send "visit_#{visit_node.class.name.gsub("::", "_")}", visit_node
       end
 
       def visit_SearchCopGrammar_Nodes_And(node)
@@ -79,6 +80,7 @@ module SearchCop
       alias :visit_SearchCopGrammar_Attributes_Decimal :visit_attribute
       alias :visit_SearchCopGrammar_Attributes_Datetime :visit_attribute
       alias :visit_SearchCopGrammar_Attributes_Timestamp :visit_attribute
+      alias :visit_SearchCopGrammar_Attributes_Timestamptz :visit_attribute
       alias :visit_SearchCopGrammar_Attributes_Date :visit_attribute
       alias :visit_SearchCopGrammar_Attributes_Time :visit_attribute
       alias :visit_SearchCopGrammar_Attributes_Boolean :visit_attribute

data/lib/search_cop/visitors.rb

@@ -1,3 +1,4 @@
 require "search_cop/visitors/visitor"
 require "search_cop/visitors/mysql"
 require "search_cop/visitors/postgres"
+require "search_cop/visitors/sqlite"

data/lib/search_cop_grammar/attributes.rb

@@ -88,12 +88,13 @@ module SearchCopGrammar
       def attribute_for(attribute_definition)
         query_info.references.push attribute_definition
 
-        table, column = attribute_definition.split(".")
+        table, column_with_fields = attribute_definition.split(".")
+        column, *fields = column_with_fields.split("->")
         klass = klass_for(table)
 
         raise(SearchCop::UnknownAttribute, "Unknown attribute #{attribute_definition}") unless klass.columns_hash[column]
 
-        Attributes.const_get(klass.columns_hash[column].type.to_s.classify).new(klass, alias_for(table), column, options)
+        Attributes.const_get(klass.columns_hash[column].type.to_s.classify).new(klass, alias_for(table), column, fields, options)
       end
 
       def generator_for(name)
@@ -110,13 +111,14 @@ module SearchCopGrammar
     end
 
     class Base
-      attr_reader :attribute, :table_alias, :column_name, :options
+      attr_reader :attribute, :table_alias, :column_name, :field_names, :options
 
-      def initialize(klass, table_alias, column_name, options = {})
+      def initialize(klass, table_alias, column_name, field_names, options = {})
         @attribute = klass.arel_table.alias(table_alias)[column_name]
         @klass = klass
         @table_alias = table_alias
         @column_name = column_name
+        @field_names = field_names
         @options = (options || {})
       end
 
@@ -179,6 +181,9 @@ module SearchCopGrammar
     end
 
     class Text < String; end
+    class Jsonb < String; end
+    class Json < String; end
+    class Hstore < String; end
 
     class WithoutMatches < Base
       def matches(value)
@@ -255,6 +260,7 @@ module SearchCopGrammar
     end
 
     class Timestamp < Datetime; end
+    class Timestamptz < Datetime; end
 
     class Date < Datetime
       def parse(value)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_cop
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -24,90 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.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: factory_bot
-  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: minitest
-  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: 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'
 description: Search engine like fulltext query support for ActiveRecord
 email:
 - vetter@flakks.com
@@ -115,8 +31,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -140,34 +54,19 @@ files:
 - lib/search_cop/visitors.rb
 - lib/search_cop/visitors/mysql.rb
 - lib/search_cop/visitors/postgres.rb
+- lib/search_cop/visitors/sqlite.rb
 - lib/search_cop/visitors/visitor.rb
 - lib/search_cop_grammar.rb
 - lib/search_cop_grammar.treetop
 - lib/search_cop_grammar/attributes.rb
 - lib/search_cop_grammar/nodes.rb
-- search_cop.gemspec
-- test/and_test.rb
-- test/boolean_test.rb
-- test/database.yml
-- test/date_test.rb
-- test/datetime_test.rb
-- test/default_operator_test.rb
-- test/error_test.rb
-- test/float_test.rb
-- test/fulltext_test.rb
-- test/hash_test.rb
-- test/integer_test.rb
-- test/not_test.rb
-- test/or_test.rb
-- test/scope_test.rb
-- test/search_cop_test.rb
-- test/string_test.rb
-- test/test_helper.rb
-- test/visitor_test.rb
 homepage: https://github.com/mrkamel/search_cop
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/mrkamel/search_cop
+  source_code_uri: https://github.com/mrkamel/search_cop
+  changelog_uri: https://github.com/mrkamel/search_cop/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/.github/workflows/test.yml

@@ -1,50 +0,0 @@
-name: test
-on: [push, pull_request]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1"]
-        rails: ["rails5", "rails6", "rails7"]
-        database: ["sqlite", "postgres", "mysql"]
-        exclude:
-          - ruby: "3.0"
-            rails: "rails5"
-          - ruby: "3.1"
-            rails: "rails5"
-          - ruby: "2.6"
-            rails: "rails7"
-    services:
-      postgres:
-        image: postgres
-        env:
-          POSTGRES_USER: search_cop
-          POSTGRES_PASSWORD: secret
-          POSTGRES_DB: search_cop
-        ports:
-          - 5432:5432
-      mysql:
-        image: mysql
-        env:
-          MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
-          MYSQL_ROOT_PASSWORD: ""
-          MYSQL_DATABASE: search_cop
-        ports:
-          - 3306:3306
-    steps:
-      - uses: actions/checkout@v1
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: test
-        env:
-          DATABASE: ${{ matrix.database }}
-        run: |
-          gem install bundler
-          bundle config set --local gemfile "gemfiles/${{ matrix.rails }}.gemfile"
-          bundle config set --local path "../vendor/bundle"
-          bundle install
-          bundle exec rake test
-          bundle exec rubocop

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-gemfiles/*.lock

data/search_cop.gemspec

@@ -1,27 +0,0 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "search_cop/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "search_cop"
-  spec.version       = SearchCop::VERSION
-  spec.authors       = ["Benjamin Vetter"]
-  spec.email         = ["vetter@flakks.com"]
-  spec.description   = "Search engine like fulltext query support for ActiveRecord"
-  spec.summary       = "Easily perform complex search engine like fulltext queries on your ActiveRecord models"
-  spec.homepage      = "https://github.com/mrkamel/search_cop"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "treetop"
-
-  spec.add_development_dependency "activerecord", ">= 3.0.0"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "factory_bot"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rubocop"
-end

data/test/and_test.rb

@@ -1,25 +0,0 @@
-require File.expand_path("test_helper", __dir__)
-
-class AndTest < SearchCop::TestCase
-  def test_and_string
-    expected = create(:product, title: "expected title", description: "Description")
-    rejected = create(:product, title: "Rejected title", description: "Description")
-
-    results = Product.search("title: 'Expected title' description: Description")
-
-    assert_includes results, expected
-    refute_includes results, rejected
-
-    assert_equal results, Product.search("title: 'Expected title' AND description: Description")
-  end
-
-  def test_and_hash
-    expected = create(:product, title: "Expected title", description: "Description")
-    rejected = create(:product, title: "Rejected title", description: "Description")
-
-    results = Product.search(and: [{ title: "Expected title" }, { description: "Description" }])
-
-    assert_includes results, expected
-    refute_includes results, rejected
-  end
-end

data/test/boolean_test.rb

@@ -1,51 +0,0 @@
-require File.expand_path("test_helper", __dir__)
-
-class BooleanTest < SearchCop::TestCase
-  def test_mapping
-    product = create(:product, available: true)
-
-    assert_includes Product.search("available: 1"), product
-    assert_includes Product.search("available: true"), product
-    assert_includes Product.search("available: yes"), product
-
-    product = create(:product, available: false)
-
-    assert_includes Product.search("available: 0"), product
-    assert_includes Product.search("available: false"), product
-    assert_includes Product.search("available: no"), product
-  end
-
-  def test_anywhere
-    product = create(:product, available: true)
-
-    assert_includes Product.search("true"), product
-    refute_includes Product.search("false"), product
-  end
-
-  def test_includes
-    product = create(:product, available: true)
-
-    assert_includes Product.search("available: true"), product
-    refute_includes Product.search("available: false"), product
-  end
-
-  def test_equals
-    product = create(:product, available: true)
-
-    assert_includes Product.search("available = true"), product
-    refute_includes Product.search("available = false"), product
-  end
-
-  def test_equals_not
-    product = create(:product, available: false)
-
-    assert_includes Product.search("available != true"), product
-    refute_includes Product.search("available != false"), product
-  end
-
-  def test_incompatible_datatype
-    assert_raises SearchCop::IncompatibleDatatype do
-      Product.unsafe_search "available: Value"
-    end
-  end
-end

data/test/database.yml

@@ -1,20 +0,0 @@
-
-sqlite:
-  adapter: sqlite3
-  database: ":memory:"
-
-mysql:
-  adapter: mysql2
-  database: search_cop
-  host: 127.0.0.1
-  username: root
-  encoding: utf8
-
-postgres:
-  host: 127.0.0.1
-  adapter: postgresql
-  database: search_cop
-  username: search_cop
-  password: secret
-  encoding: utf8
-