pursuit 0.4.3 → 1.0.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pursuit
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 1.0.1
 platform: ruby
 authors:
 - Nialto Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,191 +47,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: combustion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.44'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.44'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description:
 email:
 - support@nialtoservices.co.uk
@@ -239,12 +71,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubygem.yaml"
 - ".gitignore"
 - ".rbenv-gemsets"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -255,32 +87,41 @@ files:
 - bin/setup
 - config.ru
 - lib/pursuit.rb
+- lib/pursuit/aggregate_modifier_not_found.rb
+- lib/pursuit/aggregate_modifier_required.rb
+- lib/pursuit/aggregate_modifiers_not_available.rb
+- lib/pursuit/attribute_not_found.rb
 - lib/pursuit/constants.rb
-- lib/pursuit/dsl.rb
-- lib/pursuit/railtie.rb
-- lib/pursuit/search.rb
-- lib/pursuit/search_options.rb
-- lib/pursuit/search_term_parser.rb
+- lib/pursuit/error.rb
+- lib/pursuit/predicate_parser.rb
+- lib/pursuit/predicate_search.rb
+- lib/pursuit/predicate_transform.rb
+- lib/pursuit/query_error.rb
+- lib/pursuit/simple_search.rb
+- lib/pursuit/term_parser.rb
+- lib/pursuit/term_search.rb
+- lib/pursuit/term_transform.rb
 - pursuit.gemspec
+- spec/internal/app/models/application_record.rb
 - spec/internal/app/models/product.rb
 - spec/internal/app/models/product_category.rb
 - spec/internal/app/models/product_variation.rb
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
 - spec/internal/log/.keep
-- spec/lib/pursuit/dsl_spec.rb
-- spec/lib/pursuit/search_options_spec.rb
-- spec/lib/pursuit/search_spec.rb
-- spec/lib/pursuit/search_term_parser_spec.rb
+- spec/lib/pursuit/predicate_parser_spec.rb
+- spec/lib/pursuit/predicate_search_spec.rb
+- spec/lib/pursuit/predicate_transform_spec.rb
+- spec/lib/pursuit/simple_search_spec.rb
+- spec/lib/pursuit/term_parser_spec.rb
+- spec/lib/pursuit/term_search_spec.rb
+- spec/lib/pursuit/term_transform_spec.rb
 - spec/lib/pursuit_spec.rb
 - spec/spec_helper.rb
-- travis/gemfiles/5.2.gemfile
-- travis/gemfiles/6.0.gemfile
-- travis/gemfiles/6.1.gemfile
-- travis/gemfiles/7.0.gemfile
-homepage: https://github.com/nialtoservices/pursuit
+- travis/gemfiles/7.1.gemfile
+homepage: https://github.com/NialtoServices/pursuit
 licenses:
-- MIT
+- Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
   yard.run: yri
@@ -299,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Advanced key-based searching for ActiveRecord objects.

data/.travis.yml

@@ -1,25 +0,0 @@
-language: ruby
-rvm:
-  - 3.2.0
-gemfile:
-  - travis/gemfiles/5.2.gemfile
-  - travis/gemfiles/6.0.gemfile
-  - travis/gemfiles/6.1.gemfile
-  - travis/gemfiles/7.0.gemfile
-services:
-  - postgresql
-before_install:
-  - gem update --system
-  - gem install bundler
-before_script:
-  - psql -c 'CREATE DATABASE pursuit_test;' -U postgres
-addons:
-  postgresql: 14
-  apt:
-    packages:
-      - postgresql-14
-      - postgresql-client-14
-env:
-  global:
-    - DATABASE_URL="postgresql://127.0.0.1:5432/pursuit_test"
-    - RSPEC_DEFAULT_FORMATTER=doc

data/lib/pursuit/dsl.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Pursuit
-  module DSL
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def searchable(&block)
-        if respond_to?(:search_options) || respond_to?(:search)
-          raise "#{self} already has #search and #search_options defined."
-        end
-
-        options = SearchOptions.new(self, &block)
-
-        define_singleton_method(:search_options) do
-          options
-        end
-
-        define_singleton_method(:search) do |query|
-          search = Pursuit::Search.new(options)
-          search.perform(query)
-        end
-      end
-    end
-  end
-end

data/lib/pursuit/railtie.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Pursuit
-  class Railtie < Rails::Railtie
-    initializer 'pursuit.active_record.inject_dsl' do
-      ActiveSupport.on_load(:active_record) do
-        require 'pursuit/dsl'
-
-        ActiveRecord::Base.include(Pursuit::DSL)
-      end
-    end
-  end
-end

data/lib/pursuit/search.rb

@@ -1,172 +0,0 @@
-# frozen_string_literal: true
-
-module Pursuit
-  class Search
-    # @return [SearchOptions] The options to use when building the search query.
-    #
-    attr_reader :options
-
-    # Create a new instance to search a specific ActiveRecord record class.
-    #
-    # @param options [SearchOptions]
-    #
-    def initialize(options)
-      @options = options
-    end
-
-    # Perform a search for the specified query.
-    #
-    # @param  query [String]                 The query to transform into a SQL search.
-    # @return       [ActiveRecord::Relation] The search results.
-    #
-    def perform(query)
-      options.record_class.where(build_arel(query))
-    end
-
-    private
-
-    def build_arel(query)
-      parser = SearchTermParser.new(query, keys: options.keys)
-      unkeyed_arel = build_arel_for_unkeyed_term(parser.unkeyed_term)
-      keyed_arel = build_arel_for_keyed_terms(parser.keyed_terms)
-
-      if unkeyed_arel && keyed_arel
-        unkeyed_arel.and(keyed_arel)
-      else
-        unkeyed_arel || keyed_arel
-      end
-    end
-
-    def build_arel_for_unkeyed_term(value)
-      return nil if value.blank?
-
-      sanitized_value = "%#{ActiveRecord::Base.sanitize_sql_like(value)}%"
-      options.unkeyed_attributes.reduce(nil) do |chain, (_attribute_name, node_builder)|
-        node = node_builder.call.matches(sanitized_value)
-        chain ? chain.or(node) : node
-      end
-    end
-
-    def build_arel_for_keyed_terms(terms)
-      return nil if terms.blank?
-
-      terms.reduce(nil) do |chain, term|
-        attribute_name = term.key.to_sym
-        reflection = options.relations.key?(attribute_name) ? options.record_class.reflections[term.key] : nil
-        node = if reflection.present?
-                 attribute_names = options.relations[attribute_name]
-                 build_arel_for_reflection(reflection, attribute_names, term.operator, term.value)
-               else
-                 node_builder = options.keyed_attributes[attribute_name]
-                 build_arel_for_node(node_builder.call, term.operator, term.value)
-               end
-
-        chain ? chain.and(node) : node
-      end
-    end
-
-    def build_arel_for_node(node, operator, value) # rubocop:disable Metrics/CyclomaticComplexity
-      sanitized_value = ActiveRecord::Base.sanitize_sql_like(value)
-      sanitized_value = sanitized_value.to_i if sanitized_value =~ /^[0-9]+$/
-
-      case operator
-      when '>'   then node.gt(sanitized_value)
-      when '>='  then node.gteq(sanitized_value)
-      when '<'   then node.lt(sanitized_value)
-      when '<='  then node.lteq(sanitized_value)
-      when '*='  then node.matches("%#{sanitized_value}%")
-      when '!*=' then node.does_not_match("%#{sanitized_value}%")
-      when '!='  then node.not_eq(sanitized_value)
-      when '=='
-        if value.present?
-          node.eq(sanitized_value)
-        else
-          node.eq(nil).or(node.eq(''))
-        end
-      else
-        raise "The operator '#{operator}' is not supported."
-      end
-    end
-
-    def build_arel_for_reflection(reflection, attribute_names, operator, value)
-      nodes = build_arel_for_reflection_join(reflection)
-      count_nodes = build_arel_for_relation_count(nodes, operator, value) unless reflection.belongs_to?
-      return count_nodes if count_nodes.present?
-
-      match_nodes = attribute_names.reduce(nil) do |chain, attribute_name|
-        node = build_arel_for_node(reflection.klass.arel_table[attribute_name], operator, value)
-        chain ? chain.or(node) : node
-      end
-
-      return nil if match_nodes.blank?
-
-      nodes.where(match_nodes).project(1).exists
-    end
-
-    def build_arel_for_reflection_join(reflection)
-      if reflection.belongs_to?
-        build_arel_for_belongs_to_reflection_join(reflection)
-      else
-        build_arel_for_has_reflection_join(reflection)
-      end
-    end
-
-    def build_arel_for_belongs_to_reflection_join(reflection)
-      reflection_table = reflection.klass.arel_table
-      reflection_table.where(
-        reflection_table[reflection.join_primary_key].eq(
-          options.record_class.arel_table[reflection.join_foreign_key]
-        )
-      )
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    def build_arel_for_has_reflection_join(reflection)
-      reflection_table = reflection.klass.arel_table
-      reflection_through = reflection.through_reflection
-
-      if reflection_through.present?
-        # :has_one through / :has_many through
-        reflection_through_table = reflection_through.klass.arel_table
-        reflection_table.join(reflection_through_table).on(
-          reflection_through_table[reflection.foreign_key].eq(reflection_table[reflection.klass.primary_key])
-        ).where(
-          reflection_through_table[reflection_through.foreign_key].eq(
-            options.record_class.arel_table[options.record_class.primary_key]
-          )
-        )
-      else
-        # :has_one / :has_many
-        reflection_table.where(
-          reflection_table[reflection.foreign_key].eq(
-            options.record_class.arel_table[options.record_class.primary_key]
-          )
-        )
-      end
-    end
-    # rubocop:enable Metrics/AbcSize
-
-    def build_arel_for_relation_count(nodes, operator, value) # rubocop:disable Metrics/CyclomaticComplexity
-      node_builder = proc do |klass|
-        count = ActiveRecord::Base.sanitize_sql_like(value).to_i
-        klass.new(nodes.project(Arel.star.count), count)
-      end
-
-      case operator
-      when '>'  then node_builder.call(Arel::Nodes::GreaterThan)
-      when '>=' then node_builder.call(Arel::Nodes::GreaterThanOrEqual)
-      when '<'  then node_builder.call(Arel::Nodes::LessThan)
-      when '<=' then node_builder.call(Arel::Nodes::LessThanOrEqual)
-      else
-        return nil unless value =~ /^([0-9]+)$/
-
-        case operator
-        when '=='  then node_builder.call(Arel::Nodes::Equality)
-        when '!='  then node_builder.call(Arel::Nodes::NotEqual)
-        when '*='  then node_builder.call(Arel::Nodes::Matches)
-        when '!*=' then node_builder.call(Arel::Nodes::DoesNotMatch)
-        end
-      end
-    end
-  end
-end

data/lib/pursuit/search_options.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-module Pursuit
-  class SearchOptions
-    # @return [Struct] The structure which holds the search options for a single attribute.
-    #
-    AttributeOptions = Struct.new(:keyed, :unkeyed, :block)
-
-    # @return [Class<ActiveRecord::Base>] The `ActiveRecord::Base` child class to search.
-    #
-    attr_reader :record_class
-
-    # @return [Hash<Symbol, Array<Symbol>>] The attribute names of the record's relatives which can be searched.
-    #
-    attr_reader :relations
-
-    # @return [Hash<Symbol, AttributeOptions>] The attributes which can be searched.
-    #
-    attr_reader :attributes
-
-    # Create a new `SearchOptions` and call the passed block to setup the options.
-    #
-    # @params record_class [Class<ActiveRecord::Base>]
-    # @params block        [Proc]
-    #
-    def initialize(record_class, &block)
-      @record_class = record_class
-      @relations = {}
-      @attributes = {}
-
-      block&.call(self)
-    end
-
-    # @return [Hash<Symbol, Proc>] The attributes which can be queried using a keyed term.
-    #
-    def keyed_attributes
-      attributes.each_with_object({}) do |(name, options), keyed_attributes|
-        keyed_attributes[name] = options.block if options.keyed
-      end
-    end
-
-    # @return [Hash<Symbol, Proc>] The attributes which can be queried using an unkeyed term.
-    #
-    def unkeyed_attributes
-      attributes.each_with_object({}) do |(name, options), unkeyed_attributes|
-        unkeyed_attributes[name] = options.block if options.unkeyed
-      end
-    end
-
-    # @return [Array<String>] The collection of all possible attributes which can be used as a keyed term.
-    #
-    def keys
-      keys = relations.keys + attributes.select { |_, a| a.keyed }.keys
-      keys.map(&:to_s).uniq
-    end
-
-    # Add a relation to search.
-    #
-    # @param name            [Symbol] The name of the relationship attribute.
-    # @param attribute_names [Splat]  The name of the attributes within the relationship to search.
-    #
-    def relation(name, *attribute_names)
-      relations[name] = attribute_names
-      nil
-    end
-
-    # Add an attribute to search.
-    #
-    # @param term_name      [Symbol]  The keyed search term (can be an existing attribute, or a custom value when
-    #                                 passing either the `attribute_name` or a block returning an Arel node).
-    # @param attribute_name [Symbol]  The attribute name to search (defaults to the keyword, when left blank and no
-    #                                 block is passed).
-    # @param keyed          [Boolean] `true` when the attribute should be searchable using a keyed term,
-    #                                 `false` otherwise.
-    # @param unkeyed        [Boolean] `true` when the attribute should be searchable using an unkeyed term,
-    #                                 `false` otherwise.
-    # @param block          [Proc]    A block which returns the Arel node to query against. When left blank, the
-    #                                 matching attribute from `.arel_table` is queried instead.
-    #
-    def attribute(term_name, attribute_name = nil, keyed: true, unkeyed: true, &block)
-      block ||= -> { record_class.arel_table[attribute_name || term_name] }
-      attributes[term_name] = AttributeOptions.new(keyed, unkeyed, block)
-      nil
-    end
-  end
-end

data/lib/pursuit/search_term_parser.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Pursuit
-  class SearchTermParser
-    # @return [Struct] Represents a single keyed term extracted from a query.
-    #
-    KeyedTerm = Struct.new(:key, :operator, :value)
-
-    # @return [Array<Pursuit::SearchTermParser::KeyedTerm>] The keys which are permitted for use as keyed terms.
-    #
-    attr_reader :keyed_terms
-
-    # @return [String] The unkeyed term.
-    #
-    attr_reader :unkeyed_term
-
-    # Create a new search term parser by parsing the specified query into an 'unkeyed term' and 'keyed terms'.
-    #
-    # @param query [String]        The query to parse.
-    # @param keys  [Array<String>] The keys which are permitted for use as keyed terms.
-    #
-    def initialize(query, keys: [])
-      @keyed_terms = []
-      @unkeyed_term = query.gsub(/(\s+)?(\w+)(==|\*=|!=|!\*=|<=|>=|<|>)("([^"]+)?"|'([^']+)?'|[^\s]+)(\s+)?/) do |term|
-        key = Regexp.last_match(2)
-        next term unless keys.include?(key)
-
-        operator = Regexp.last_match(3)
-        value = Regexp.last_match(4)
-        value = value[1..-2] if value =~ /^(".*"|'.*')$/
-
-        @keyed_terms << KeyedTerm.new(key, operator, value)
-
-        # Both the starting and ending spaces surrounding the keyed term can be removed, so in this case we'll need to
-        # replace with a single space to ensure the unkeyed term's words are separated correctly.
-        if term =~ /^\s.*\s$/
-          ' '
-        else
-          ''
-        end
-      end
-
-      @unkeyed_term = @unkeyed_term.strip
-    end
-  end
-end