pursuit 0.4.5 → 1.1.0

data/lib/pursuit/term_transform.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Pursuit
+  # Transform for a list of terms.
+  #
+  class TermTransform < Parslet::Transform
+    # String Types
+
+    rule(string_double_quotes: [])             { '' }
+    rule(string_double_quotes: simple(:value)) { value.to_s.gsub(/\\(.)/, '\1') }
+
+    rule(string_single_quotes: [])             { '' }
+    rule(string_single_quotes: simple(:value)) { value.to_s.gsub(/\\(.)/, '\1') }
+
+    rule(string_no_quotes: simple(:value)) { value.to_s }
+
+    # Terms
+
+    rule(term: simple(:term)) do |context|
+      value = ActiveRecord::Base.sanitize_sql_like(context[:term])
+      value = "%#{value}%"
+
+      context[:attributes].inject(nil) do |previous_node, attribute|
+        node = attribute.matches(value)
+        next node unless previous_node
+
+        previous_node.or(node)
+      end
+    end
+
+    # Joins
+
+    rule(left: simple(:left), right: simple(:right)) { left.and(right) }
+  end
+end

data/lib/pursuit.rb

@@ -1,7 +1,21 @@
 # frozen_string_literal: true
 
+require 'active_record'
+require 'active_support'
+require 'bigdecimal'
+require 'parslet'
+
 require_relative 'pursuit/constants'
-require_relative 'pursuit/search_options'
-require_relative 'pursuit/search_term_parser'
-require_relative 'pursuit/search'
-require_relative 'pursuit/railtie' if defined?(Rails::Railtie)
+require_relative 'pursuit/error'
+require_relative 'pursuit/query_error'
+require_relative 'pursuit/aggregate_modifier_not_found'
+require_relative 'pursuit/aggregate_modifier_required'
+require_relative 'pursuit/aggregate_modifiers_not_available'
+require_relative 'pursuit/attribute_not_found'
+require_relative 'pursuit/predicate_parser'
+require_relative 'pursuit/predicate_transform'
+require_relative 'pursuit/predicate_search'
+require_relative 'pursuit/term_parser'
+require_relative 'pursuit/term_transform'
+require_relative 'pursuit/term_search'
+require_relative 'pursuit/simple_search'

data/pursuit.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['support@nialtoservices.co.uk']
 
   spec.summary       = 'Advanced key-based searching for ActiveRecord objects.'
-  spec.homepage      = 'https://github.com/nialtoservices/pursuit'
+  spec.homepage      = 'https://github.com/NialtoServices/pursuit'
   spec.license       = 'Apache-2.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.metadata['rubygems_mfa_required'] = 'true'
   spec.metadata['yard.run'] = 'yri'
 
-  spec.add_runtime_dependency 'activerecord',  '>= 5.2.0', '< 7.2.0'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2.0', '< 7.2.0'
+  spec.add_runtime_dependency 'activerecord',  '>= 5.2.0', '<= 8.0.0'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2.0', '<= 8.0.0'
+  spec.add_runtime_dependency 'parslet',       '~> 2.0'
 end

data/spec/internal/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/internal/app/models/product.rb

@@ -1,22 +1,11 @@
 # frozen_string_literal: true
 
-class Product < ActiveRecord::Base
+class Product < ApplicationRecord
+  include ProductSearch
+
   belongs_to :category, class_name: 'ProductCategory', inverse_of: :products, optional: true
 
   has_many :variations, class_name: 'ProductVariation', inverse_of: :product
 
   validates :title, presence: true
-
-  searchable do |o|
-    o.relation :variations, :title, :stock_status
-
-    o.attribute :title
-    o.attribute :description
-    o.attribute :rating, unkeyed: false
-    o.attribute :title_length, unkeyed: false do
-      Arel::Nodes::NamedFunction.new('LENGTH', [arel_table[:title]])
-    end
-
-    o.attribute :category, :category_id
-  end
 end

data/spec/internal/app/models/product_category.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-class ProductCategory < ActiveRecord::Base
+class ProductCategory < ApplicationRecord
+  include ProductCategorySearch
+
   has_many :products, class_name: 'Product', foreign_key: :category_id, inverse_of: :category, dependent: :nullify
 
   validates :name, presence: true

data/spec/internal/app/models/product_variation.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-class ProductVariation < ActiveRecord::Base
+class ProductVariation < ApplicationRecord
+  include ProductVariationSearch
+
   belongs_to :product
 
   enum stock_status: { in_stock: 1, low_stock: 2, out_of_stock: 3 }

data/spec/internal/app/searches/product_category_search.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ProductCategorySearch
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Search for records matching the specified predicate.
+    #
+    # @param  query [String]                 The query with a predicate.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the predicate.
+    #
+    def predicate_search(query)
+      @predicate_search ||= Pursuit::PredicateSearch.new(default_table: arel_table) do
+        permit_attribute :name
+        permit_attribute :product, Product.arel_table[:id]
+        permit_attribute :product_title, Product.arel_table[:title]
+      end
+
+      @predicate_search.apply(query, left_outer_joins(:products).group(:id))
+    end
+
+    # Search for records matching the specified terms.
+    #
+    # @param  query [String]                 The query with one or more terms.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the terms.
+    #
+    def term_search(query)
+      @term_search ||= Pursuit::TermSearch.new(default_table: arel_table) do
+        search_attribute :name
+      end
+
+      # Note that we're using `all` here, but this still works when used in a chain:
+      # => ProductVariation.where(stock_status: :in_stock).search('Green')
+      @term_search.apply(query, all)
+    end
+
+    # Search for records matching the specified query.
+    #
+    # @param  query [String]                 The query.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the query.
+    #
+    def search(query)
+      return none if query.blank?
+
+      predicate_search(query)
+    rescue Parslet::ParseFailed
+      term_search(query)
+    end
+  end
+end

data/spec/internal/app/searches/product_search.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ProductSearch
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Search for records matching the specified predicate.
+    #
+    # @param  query [String]                 The query with a predicate.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the predicate.
+    #
+    def predicate_search(query)
+      @predicate_search ||= Pursuit::PredicateSearch.new(default_table: arel_table) do
+        permit_attribute :title
+        permit_attribute :category, ProductCategory.arel_table[:id]
+        permit_attribute :category_name, ProductCategory.arel_table[:name]
+        permit_attribute :variation, ProductVariation.arel_table[:id]
+        permit_attribute :variation_title, ProductVariation.arel_table[:title]
+        permit_attribute :variation_currency, ProductVariation.arel_table[:currency]
+        permit_attribute :variation_amount, ProductVariation.arel_table[:amount]
+      end
+
+      @predicate_search.apply(query, left_outer_joins(:category, :variations).group(:id).order(:title))
+    end
+
+    # Search for records matching the specified terms.
+    #
+    # @param  query [String]                 The query with one or more terms.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the terms.
+    #
+    def term_search(query)
+      @term_search ||= Pursuit::TermSearch.new(default_table: arel_table) do
+        search_attribute :title
+        search_attribute ProductCategory.arel_table[:name]
+      end
+
+      @term_search.apply(query, left_outer_joins(:category).group(:id).order(:title))
+    end
+
+    # Search for records matching the specified query.
+    #
+    # @param  query [String]                 The query.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the query.
+    #
+    def search(query)
+      return none if query.blank?
+
+      predicate_search(query)
+    rescue Parslet::ParseFailed
+      term_search(query)
+    end
+  end
+end

data/spec/internal/app/searches/product_variation_search.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ProductVariationSearch
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Search for records matching the specified predicate.
+    #
+    # @param  query [String]                 The query with a predicate.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the predicate.
+    #
+    def predicate_search(query)
+      @predicate_search ||= Pursuit::PredicateSearch.new(default_table: arel_table) do
+        permit_attribute :title
+        permit_attribute :stock_status
+        permit_attribute :currency
+        permit_attribute :amount
+        permit_attribute :product, Product.arel_table[:id]
+        permit_attribute :product_title, Product.arel_table[:title]
+      end
+
+      @predicate_search.apply(query, left_outer_joins(:product).group(:id))
+    end
+
+    # Search for records matching the specified terms.
+    #
+    # @param  query [String]                 The query with one or more terms.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the terms.
+    #
+    def term_search(query)
+      @term_search ||= Pursuit::TermSearch.new(default_table: arel_table) do
+        search_attribute :title
+      end
+
+      # Note that we're using `all` here, but this still works when used in a chain:
+      # => ProductVariation.where(stock_status: :in_stock).search('Green')
+      @term_search.apply(query, all)
+    end
+
+    # Search for records matching the specified query.
+    #
+    # @param  query [String]                 The query.
+    # @return       [ActiveRecord::Relation] The current relation filtered by the query.
+    #
+    def search(query)
+      return none if query.blank?
+
+      predicate_search(query)
+    rescue Parslet::ParseFailed
+      term_search(query)
+    end
+  end
+end