pursuit 0.4.5 → 1.1.0

data/spec/lib/pursuit/term_parser_spec.rb

@@ -0,0 +1,271 @@
+# frozen_string_literal: true
+
+RSpec.describe Pursuit::TermParser do
+  subject(:parser) { described_class.new }
+
+  describe '#space' do
+    subject(:space) { parser.space }
+
+    context 'when parsing an empty value' do
+      subject(:parse) { space.parse('') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+
+    context 'when parsing one or more spaces' do
+      subject(:parse) { space.parse(value) }
+
+      let(:value) { ' ' * rand(1..10) }
+
+      it 'is expected to eq the parsed spaces' do
+        expect(parse).to eq(value)
+      end
+    end
+  end
+
+  describe '#space?' do
+    subject(:space?) { parser.space? }
+
+    context 'when parsing an empty value' do
+      subject(:parse) { space?.parse('') }
+
+      it 'is expected to eq the empty value' do
+        expect(parse).to eq('')
+      end
+    end
+
+    context 'when parsing one or more spaces' do
+      subject(:parse) { space?.parse(value) }
+
+      let(:value) { ' ' * rand(1..10) }
+
+      it 'is expected to eq the parsed spaces' do
+        expect(parse).to eq(value)
+      end
+    end
+  end
+
+  describe '#escaped_character' do
+    subject(:escaped_character) { parser.escaped_character }
+
+    context 'when parsing an escaped character' do
+      subject(:parse) { escaped_character.parse('\\"') }
+
+      it 'is expected to eq the escaped character' do
+        expect(parse).to eq('\\"')
+      end
+    end
+
+    context 'when parsing an unescaped character' do
+      subject(:parse) { escaped_character.parse('"') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+  end
+
+  describe '#string_double_quotes' do
+    subject(:string_double_quotes) { parser.string_double_quotes }
+
+    context 'when parsing a double quoted string' do
+      subject(:parse) { string_double_quotes.parse('"Double \"Quoted\""') }
+
+      it 'is expected to capture the contents of the double quotes as :string_double_quotes' do
+        expect(parse).to eq(string_double_quotes: 'Double \"Quoted\"')
+      end
+    end
+
+    context 'when parsing a single quoted string' do
+      subject(:parse) { string_double_quotes.parse("'Single Quoted'") }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+
+    context 'when parsing an unquoted string' do
+      subject(:parse) { string_double_quotes.parse('Unquoted') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+  end
+
+  describe '#string_single_quotes' do
+    subject(:string_single_quotes) { parser.string_single_quotes }
+
+    context 'when parsing a single quoted string' do
+      subject(:parse) { string_single_quotes.parse("'Single \\'Quoted\\''") }
+
+      it 'is expected to capture the contents of the single quotes as :string_single_quotes' do
+        expect(parse).to eq(string_single_quotes: "Single \\'Quoted\\'")
+      end
+    end
+
+    context 'when parsing a double quoted string' do
+      subject(:parse) { string_single_quotes.parse('"Double Quoted"') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+
+    context 'when parsing an unquoted string' do
+      subject(:parse) { string_single_quotes.parse('Unquoted') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+  end
+
+  describe '#string_no_quotes' do
+    subject(:string_no_quotes) { parser.string_no_quotes }
+
+    context 'when parsing an unquoted string with no spaces or symbols' do
+      subject(:parse) { string_no_quotes.parse('Unquoted') }
+
+      it 'is expected to eq the parsed value' do
+        expect(parse).to eq(string_no_quotes: 'Unquoted')
+      end
+    end
+
+    context 'when parsing an unquoted string with spaces' do
+      subject(:parse) { string_no_quotes.parse('No Quotes') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+
+    context 'when parsing an unquoted string with symbols' do
+      subject(:parse) { string_no_quotes.parse('No:Quotes') }
+
+      it 'is expected to eq the parsed value' do
+        expect(parse).to eq(string_no_quotes: 'No:Quotes')
+      end
+    end
+  end
+
+  describe '#string' do
+    subject(:string) { parser.string }
+
+    context 'when parsing a double quoted string' do
+      subject(:parse) { string.parse('"Double \"Quoted\""') }
+
+      it 'is expected to capture the contents of the double quotes as :string_double_quotes' do
+        expect(parse).to eq(string_double_quotes: 'Double \"Quoted\"')
+      end
+    end
+
+    context 'when parsing a single quoted string' do
+      subject(:parse) { string.parse("'Single \\'Quoted\\''") }
+
+      it 'is expected to capture the contents of the single quotes as :string_single_quotes' do
+        expect(parse).to eq(string_single_quotes: "Single \\'Quoted\\'")
+      end
+    end
+
+    context 'when parsing an unquoted string' do
+      subject(:parse) { string.parse('Unquoted') }
+
+      it 'is expected to eq the parsed value' do
+        expect(parse).to eq(string_no_quotes: 'Unquoted')
+      end
+    end
+
+    context 'when parsing an unquoted string with spaces' do
+      subject(:parse) { string.parse('No Quotes') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+
+    context 'when parsing an unquoted string with symbols' do
+      subject(:parse) { string.parse('a@b.c') }
+
+      it 'is expected to eq the parsed value' do
+        expect(parse).to eq(string_no_quotes: 'a@b.c')
+      end
+    end
+  end
+
+  describe '#term' do
+    subject(:term) { parser.term }
+
+    context 'when parsing a string' do
+      subject(:parse) { term.parse('Hello') }
+
+      it 'is expected to capture the value as :term' do
+        expect(parse).to match(hash_including(term: { string_no_quotes: 'Hello' }))
+      end
+    end
+  end
+
+  describe '#term_pair' do
+    subject(:term_pair) { parser.term_pair }
+
+    context 'when parsing a term' do
+      subject(:parse) { term_pair.parse('Hello') }
+
+      it { expect { parse }.to raise_exception(Parslet::ParseFailed) }
+    end
+
+    context 'when parsing two terms separated by a space' do
+      subject(:parse) { term_pair.parse('Hello World') }
+
+      it 'is expected to capture the first term as :left' do
+        expect(parse).to match(hash_including(left: { term: { string_no_quotes: 'Hello' } }))
+      end
+
+      it 'is expected to capture the second term as :right' do
+        expect(parse).to match(hash_including(right: { term: { string_no_quotes: 'World' } }))
+      end
+    end
+  end
+
+  describe '#term_node' do
+    subject(:term_node) { parser.term_node }
+
+    context 'when parsing a term' do
+      subject(:parse) { term_node.parse('Hello') }
+
+      it 'is expected to eq the term result' do
+        expect(parse).to match(hash_including(term: { string_no_quotes: 'Hello' }))
+      end
+    end
+
+    context 'when parsing multiple terms' do
+      subject(:parse) { term_node.parse('Hello World') }
+
+      it 'is expected to eq the term list result' do
+        expect(parse).to match(
+          hash_including(
+            left: { term: { string_no_quotes: 'Hello' } },
+            right: { term: { string_no_quotes: 'World' } }
+          )
+        )
+      end
+    end
+  end
+
+  describe '#terms' do
+    subject(:terms) { parser.terms }
+
+    context 'when parsing a complex list of terms' do
+      subject(:parse) { terms.parse(" FirstTerm \"Second Term\" Third<>Term 'Fourth Term' ") }
+
+      it 'is expected to eq the correct term tree' do
+        expect(parse).to match(
+          hash_including(
+            left: { term: { string_no_quotes: 'FirstTerm' } },
+            right: {
+              left: { term: { string_double_quotes: 'Second Term' } },
+              right: {
+                left: { term: { string_no_quotes: 'Third<>Term' } },
+                right: { term: { string_single_quotes: 'Fourth Term' } }
+              }
+            }
+          )
+        )
+      end
+    end
+  end
+
+  describe '#root' do
+    subject(:root) { parser.root }
+
+    it 'is expected to eq #terms' do
+      expect(root).to eq(parser.terms)
+    end
+  end
+end

data/spec/lib/pursuit/term_search_spec.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+RSpec.describe Pursuit::TermSearch do
+  subject(:term_search) { described_class.new(default_table: Product.arel_table) }
+
+  describe '#initialize' do
+    it 'is expected to set #default_table eq `default_table`' do
+      expect(term_search).to have_attributes(default_table: Product.arel_table)
+    end
+
+    it 'is expected to invoke the passed block' do
+      expect { |block| described_class.new(&block) }.to yield_control
+    end
+  end
+
+  describe '#parser' do
+    subject(:parser) { term_search.parser }
+
+    it { is_expected.to be_a(Pursuit::TermParser) }
+  end
+
+  describe '#transform' do
+    subject(:transform) { term_search.transform }
+
+    it { is_expected.to be_a(Pursuit::TermTransform) }
+  end
+
+  describe '#search_attribute' do
+    subject(:search_attribute) { term_search.search_attribute(attribute) }
+
+    context 'when `attribute` is a Symbol' do
+      let(:attribute) { :title }
+
+      it 'is expected to add the attribute from #default_table to #attributes' do
+        search_attribute
+        expect(term_search.attributes).to include(Product.arel_table[:title])
+      end
+    end
+
+    context 'when `attribute` is an Arel::Attributes::Attribute' do
+      let(:attribute) { ProductVariation.arel_table[:currency] }
+
+      it 'is expected to add the attribute to #attributes' do
+        search_attribute
+        expect(term_search.attributes).to include(ProductVariation.arel_table[:currency])
+      end
+    end
+  end
+
+  describe '#parse' do
+    subject(:parse) { term_search.parse('Shirt') }
+
+    before do
+      term_search.attributes << Product.arel_table[:title]
+      term_search.attributes << ProductVariation.arel_table[:title]
+    end
+
+    it 'is expected to equal the ARel node' do
+      expect(parse).to eq(
+        Product.arel_table[:title].matches('%Shirt%').or(
+          ProductVariation.arel_table[:title].matches('%Shirt%')
+        )
+      )
+    end
+  end
+
+  describe '#apply' do
+    subject(:apply) { term_search.apply('Shirt', Product.left_outer_joins(:variations).group(:id)) }
+
+    before do
+      term_search.attributes << Product.arel_table[:title]
+      term_search.attributes << ProductVariation.arel_table[:title]
+    end
+
+    it 'is expected to equal `relation` with term clauses applied' do
+      expect(apply).to eq(
+        Product.left_outer_joins(:variations).group(:id).where(
+          Product.arel_table[:title].matches('%Shirt%').or(
+            ProductVariation.arel_table[:title].matches('%Shirt%')
+          )
+        )
+      )
+    end
+  end
+end

data/spec/lib/pursuit/term_transform_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+RSpec.describe Pursuit::TermTransform do
+  subject(:transform) { described_class.new }
+
+  describe '#apply' do
+    subject(:apply) { transform.apply(tree, attributes: attributes) }
+
+    let(:attributes) do
+      [
+        Product.arel_table[:title],
+        ProductVariation.arel_table[:title]
+      ].to_set
+    end
+
+    context 'when passed an empty double quoted string' do
+      let(:tree) do
+        { string_double_quotes: [] }
+      end
+
+      it 'is expected to equal an empty string' do
+        expect(apply).to eq('')
+      end
+    end
+
+    context 'when passed a double quoted string' do
+      let(:tree) do
+        { string_double_quotes: 'Hello \\"World\\"' }
+      end
+
+      it 'is expected to equal the correct string' do
+        expect(apply).to eq('Hello "World"')
+      end
+    end
+
+    context 'when passed an empty single quoted string' do
+      let(:tree) do
+        { string_single_quotes: [] }
+      end
+
+      it 'is expected to equal an empty string' do
+        expect(apply).to eq('')
+      end
+    end
+
+    context 'when passed a single quoted string' do
+      let(:tree) do
+        { string_single_quotes: "Hello \\'World\\'" }
+      end
+
+      it 'is expected to equal the correct string' do
+        expect(apply).to eq("Hello 'World'")
+      end
+    end
+
+    context 'when passed an unquoted string' do
+      let(:tree) do
+        { string_no_quotes: 'hello_world' }
+      end
+
+      it 'is expected to equal the correct string' do
+        expect(apply).to eq('hello_world')
+      end
+    end
+
+    context 'when passed a term' do
+      let(:tree) do
+        { term: { string_no_quotes: 'Shirt' } }
+      end
+
+      it 'is expected to equal the correct ARel node' do
+        expect(apply).to eq(
+          Product.arel_table[:title].matches('%Shirt%').or(
+            ProductVariation.arel_table[:title].matches('%Shirt%')
+          )
+        )
+      end
+    end
+
+    context 'when passed multiple terms' do
+      let(:tree) do
+        {
+          left: {
+            term: { string_no_quotes: 'Shirt' }
+          },
+          right: {
+            term: { string_no_quotes: 'Green' }
+          }
+        }
+      end
+
+      it 'is expected to equal the correct ARel node' do
+        expect(apply).to eq(
+          Product.arel_table[:title].matches('%Shirt%').or(
+            ProductVariation.arel_table[:title].matches('%Shirt%')
+          ).and(
+            Product.arel_table[:title].matches('%Green%').or(
+              ProductVariation.arel_table[:title].matches('%Green%')
+            )
+          )
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pursuit
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Nialto Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2023-11-03 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.2.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.2.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.2.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +47,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description:
 email:
 - support@nialtoservices.co.uk
@@ -57,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
@@ -73,31 +87,42 @@ 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/app/searches/product_category_search.rb
+- spec/internal/app/searches/product_search.rb
+- spec/internal/app/searches/product_variation_search.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
 - travis/gemfiles/7.1.gemfile
-homepage: https://github.com/nialtoservices/pursuit
+homepage: https://github.com/NialtoServices/pursuit
 licenses:
 - Apache-2.0
 metadata:

data/.travis.yml

@@ -1,26 +0,0 @@
-language: ruby
-rvm:
-  - 3.2.2
-gemfile:
-  - travis/gemfiles/5.2.gemfile
-  - travis/gemfiles/6.0.gemfile
-  - travis/gemfiles/6.1.gemfile
-  - travis/gemfiles/7.0.gemfile
-  - travis/gemfiles/7.1.gemfile
-services:
-  - postgresql
-before_install:
-  - gem update --system
-  - gem install bundler
-before_script:
-  - psql -c 'CREATE DATABASE pursuit_test;' -U postgres
-addons:
-  postgresql: 16
-  apt:
-    packages:
-      - postgresql-16
-      - postgresql-client-16
-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