search_lingo 2.0.0 → 3.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d697959cb461bb00ba17b4dbd3fe71037db81c65d3253fc22c42c27b69228f2e
-  data.tar.gz: 2a96f4b480d60d052bd1bf7f7ae02f645386144dbebccfacaa9ecfbf56fbbd30
+  metadata.gz: 06b21144b96415a618c188261eca38aab055ca218d294a966f96f543c41759a2
+  data.tar.gz: eff6897cd99f4abf444a9dd9c8c5d1d545b1da5277d507a8fb8b7a685756ca44
 SHA512:
-  metadata.gz: aa98221d0840199c0ed21f96412f39fd82567210d8f99d1b2767a0b8f718ba2f1039f1624e7f9d04a63bd7b0c6a22d00ecbe81ddb4c8986322dfdda99da84b4f
-  data.tar.gz: 3ecc60bea0e32cc52548bbe5999e80704bc52e89ec0218f3076473220c14f8f4b2a5214bd8dadca5490b90a2229291dea960289819f53c9689bb4f3ab8859ac7
+  metadata.gz: fbd45adde84bf9a73d73c15cb91545e1e46b7ddbc2b0647506a087dcf77cf1aa7777ed29e57c8329a101b98b01b647308ed5657157fc60cc9858bd5281a25ca0
+  data.tar.gz: a05213f9fd31a2049f649bc935ac9d5edf0e4c8cd4bc390ee423bdc660180d78fb1a9802ffe7ff428b886b70911f93c98d469edb1dfb59b5c9e43c13c4eb1a74

data/.gitignore

@@ -8,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.tool-versions

data/.gitlab-ci.yml

@@ -0,0 +1,27 @@
+before_script:
+  - gem install bundler --no-document -v '~> 2.3.11'
+  - bundle install --jobs="$(nproc)" --retry=3
+
+build:rubocop:
+  stage: build
+  image: "ruby:3.1"
+  script:
+    - bundle exec rubocop
+
+test:ruby-2.7:
+  stage: test
+  image: "ruby:2.7"
+  script:
+    - bundle exec rake test
+
+test:ruby-3.0:
+  stage: test
+  image: "ruby:3.0"
+  script:
+    - bundle exec rake test
+
+test:ruby-3.1:
+  stage: test
+  image: "ruby:3.1"
+  script:
+    - bundle exec rake test

data/.rubocop.yml

@@ -1,14 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.3.0
-Layout/AlignParameters:
-  Enabled: false
-Metrics/AbcSize:
-  Max: 25
-Style/AndOr:
-  EnforcedStyle: conditionals
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7.0
 Style/TrailingCommaInArrayLiteral:
-  Enabled: false
+  EnforcedStyleForMultiline: consistent_comma
 Style/TrailingCommaInHashLiteral:
-  Enabled: false
-Style/NumericPredicate:
-  Enabled: false
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
+  - "2.7"
+  - "3.0"
+  - "3.1"
+before_install:
+  - gem install bundler

data/examples/complex.rb

@@ -40,9 +40,11 @@ class JobSearch < SearchLingo::AbstractSearch # :nodoc:
 end
 
 class ReceiptSearch < SearchLingo::AbstractSearch # :nodoc:
-  parser SearchLingo::Parsers::DateParser.new Receipt.arel_table[:check_date]
-  parser SearchLingo::Parsers::DateParser.new Receipt.arel_table[:post_date],
-    modifier: 'posted'
+  # You might prefer to include SearchLingo::Parsers if you you are going to
+  # instantiate multiple DateParsers.
+  include SearchLingo::Parsers
+  parser DateParser.new Receipt.arel_table[:check_date]
+  parser DateParser.new Receipt.arel_table[:post_date], modifier: 'posted'
 
   parser do |token, chain|
     token.match(/\Aamount: (\d+(?:\.\d+)?)\z/) do |m|

data/examples/sequel_example.rb

@@ -56,13 +56,11 @@ class TaskSearch < SearchLingo::AbstractSearch # :nodoc:
   # 7/4/17   => Tasks with due_date == Date.new(2017, 7, 4)
   parser do |token, chain|
     token.match %r{\A(?<m>\d{1,2})/(?<d>\d{1,2})/(?<y>\d{2}\d{2}?)\z} do |m|
-      begin
-        date = Date.parse "#{m[:y]}/#{m[:m]}/#{m[:d]}"
-        chain.where due_date: date
-      rescue ArgumentError
-        # Fail if Date.parse raises an ArgumentError
-        nil
-      end
+      date = Date.parse "#{m[:y]}/#{m[:m]}/#{m[:d]}"
+      chain.where due_date: date
+    rescue ArgumentError
+      # Fail if Date.parse raises an ArgumentError
+      nil
     end
   end
 

data/lib/search_lingo/abstract_search.rb

@@ -61,8 +61,8 @@ module SearchLingo
     # responds to +#call+. The parser will be send +#call+ with a single
     # argument which will be a token from the query string.
     #
-    # If both a callable object and a block are given, or if neither a callable
-    # object nor a block are given, an +ArgumentError+ will be raised.
+    # Raises +ArgumentError+ if +parser+ does not respond to +#call+ and no
+    # block is given.
     #
     #   class MyParser
     #     def call(token)
@@ -77,11 +77,13 @@ module SearchLingo
     #     end
     #   end
     def self.parser(parser = nil, &block)
-      unless block_given? ^ parser.respond_to?(:call)
-        raise ArgumentError, 'parse must be called with callable OR block'
+      if parser.respond_to? :call
+        parsers << parser
+      elsif block_given?
+        parsers << block
+      else
+        raise ArgumentError, 'parse must be called with block or callable object'
       end
-
-      parsers << (parser || block)
     end
 
     ##
@@ -161,7 +163,7 @@ module SearchLingo
     # implementation should return +chain+. (Doing so would ignore +token+.)
     def default_parse(_token, _chain)
       raise NotImplementedError,
-        "#default_parse must be implemented by #{self.class}"
+            "#default_parse must be implemented by #{self.class}"
     end
   end
 end

data/lib/search_lingo/constants.rb

@@ -3,9 +3,22 @@
 module SearchLingo
   ##
   # Pattern for matching modifiers within a token.
-  MODIFIER = /[[:alnum:]]+/
+  MODIFIER = /[[:alnum:]]+/.freeze
 
   ##
-  # Pattern for matching terms within a token.
-  TERM = /"[^"]+"|[[:graph:]]+/
+  # Pattern for matching a simple token.
+  SIMPLE_TOKEN = /"[^"]+"|[[:graph:]]+/.freeze
+
+  ##
+  # Pattern for matching a simple or compound token.
+  SIMPLE_OR_COMPOUND_TOKEN = /(?:#{MODIFIER}:[[:space:]]*)?#{SIMPLE_TOKEN}/.freeze
+
+  ##
+  # Pattern for matching a simple or compound token, with regex grouping to aid
+  # in decomposing the token into its modifier and term components.
+  SIMPLE_OR_COMPOUND_TOKEN_WITH_GROUPING = /\A(?:(#{MODIFIER}):[[:space:]]*)?(#{SIMPLE_TOKEN})\z/.freeze
+
+  ##
+  # Pattern for matching the delimiter between tokens.
+  DELIMITER = /[[:space:]]*/.freeze
 end

data/lib/search_lingo/parsers/date_parser.rb

@@ -16,7 +16,7 @@ module SearchLingo
     class DateParser
       include MDY
 
-      attr_reader :column, :prefix, :append
+      attr_reader :column, :prefix, :decorator
 
       ##
       # Instantiates a new DateParser object.
@@ -26,10 +26,10 @@ module SearchLingo
       # If present, the optional argument +modifier+ will be used as the
       # token operator which precedes the date term.
       #
-      # If a block is provided, it will be used to append additional methods to
-      # the filter chain. (This is useful for static methods that must be
-      # appended to the filter chain independent of the content of the token,
-      # for example, if you need to join another table.)
+      # If a block is provided, it will be called with the filter chain. This
+      # is useful if you need to send additional messages to the filter chain
+      # which are independent of the content of the token, e.g., if you need to
+      # join another table.
       #
       # DateParser.new Model.arel_table[:date]
       # DateParser.new Model.arel_table[:date], modifier: 'contract'
@@ -39,7 +39,7 @@ module SearchLingo
       def initialize(column, modifier: nil, &block)
         @column = column
         @prefix = /#{modifier}:[[:space:]]*/ if modifier
-        @append = block_given? ? block : ->(chain) { chain }
+        @decorator = block_given? ? block : ->(chain) { chain }
       end
 
       ##
@@ -57,9 +57,9 @@ module SearchLingo
 
       def inspect # :nodoc:
         format '#<%<cls>s @prefix=%<prefix>s @column=%<column>s>',
-          cls: self.class,
-          prefix: prefix.inspect,
-          column: "#{column.relation.name}.#{column.name}".inspect
+               cls: self.class,
+               prefix: prefix.inspect,
+               column: "#{column.relation.name}.#{column.name}".inspect
       end
 
       private
@@ -67,7 +67,7 @@ module SearchLingo
       def parse_single_date(token, chain) # :nodoc:
         token.match(/\A#{prefix}(?<date>#{US_DATE})\z/) do |m|
           date = parse(m[:date]) or return nil
-          throw :halt, append.call(chain).where(column.eq(date))
+          throw :halt, decorate(chain).where(column.eq(date))
         end
       end
 
@@ -75,23 +75,27 @@ module SearchLingo
         token.match(/\A#{prefix}(?<min>#{US_DATE})-(?<max>#{US_DATE})\z/) do |m|
           min = parse(m[:min]) or return nil
           max = parse(m[:max], relative_to: min.next_year) or return nil
-          throw :halt, append.call(chain).where(column.in(min..max))
+          throw :halt, decorate(chain).where(column.between(min..max))
         end
       end
 
       def parse_lte_date(token, chain) # :nodoc:
         token.match(/\A#{prefix}-(?<date>#{US_DATE})\z/) do |m|
           date = parse(m[:date]) or return nil
-          throw :halt, append.call(chain).where(column.lteq(date))
+          throw :halt, decorate(chain).where(column.lteq(date))
         end
       end
 
       def parse_gte_date(token, chain) # :nodoc:
         token.match(/\A#{prefix}(?<date>#{US_DATE})-\z/) do |m|
           date = parse(m[:date]) or return nil
-          throw :halt, append.call(chain).where(column.gteq(date))
+          throw :halt, decorate(chain).where(column.gteq(date))
         end
       end
+
+      def decorate(chain)
+        decorator.call chain
+      end
     end
   end
 end

data/lib/search_lingo/parsers/mdy.rb

@@ -5,14 +5,16 @@ require 'date'
 module SearchLingo
   module Parsers # :nodoc:
     ##
-    # MDY provides a parser for dates that adhere to the MDY format used in the
-    # US.
+    # MDY provides a parser for dates that adhere to the M/D/Y format used in
+    # the US.
     module MDY
       ##
       # Pattern for matching US-formatted date strings.
       #
       # The year may be two or four digits, or it may be omitted.
-      US_DATE = %r{(?<m>\d{1,2})/(?<d>\d{1,2})(?:/(?<y>\d{2}\d{2}?))?}
+      US_DATE = %r{(?<m>\d{1,2})/(?<d>\d{1,2})(?:/(?<y>\d{2}\d{2}?))?}.freeze
+
+      module_function
 
       ##
       # Returns a +Date+ object for the date represented by +term+. Returns
@@ -24,33 +26,32 @@ module SearchLingo
       # If the year is omitted, it will be inferred using +relative_to+ as a
       # reference date. In this scenario, the resulting date will always be
       # less than or equal to the reference date. If +relative_to+ omitted, it
-      # defaults to today's date.
+      # defaults to +Date.today+.
       #
       # Available as both a class method and an instance method.
-      # rubocop:disable Metrics/MethodLength
       def parse(term, relative_to: Date.today)
         term.match(/\A#{US_DATE}\z/) do |m|
-          return Date.parse "#{m[:y]}/#{m[:m]}/#{m[:d]}" if m[:y]
-
-          ref   = relative_to
-          month = Integer m[:m]
-          day   = Integer m[:d]
-          year  = if month < ref.month || month == ref.month && day <= ref.day
-                    ref.year
-                  else
-                    ref.year - 1
-                  end
-          Date.new year, month, day
+          date = reformat_date m, relative_to
+          Date.parse date
         end
       rescue ArgumentError
         # Fail if Date.parse or Date.new raise ArgumentError.
         nil
       end
-      # rubocop:enable Metrics/MethodLength
 
-      # rubocop:disable Style/AccessModifierDeclarations:
-      module_function :parse
-      # rubocop:enable Style/AccessModifierDeclarations:
+      def reformat_date(match, today) # :nodoc:
+        return match.values_at(:y, :m, :d).join('/') if match[:y]
+
+        month = Integer match[:m]
+        day = Integer match[:d]
+        year = if month < today.month || (month == today.month && day <= today.day)
+                 today.year
+               else
+                 today.year - 1
+               end
+
+        "#{year}/#{month}/#{day}"
+      end
     end
   end
 end

data/lib/search_lingo/token.rb

@@ -18,18 +18,14 @@ module SearchLingo
   #   Token.new('foo: bar')
   #   Token.new('foo: "bar baz"')
   class Token < DelegateClass(String)
-    ##
-    # Pattern for decomposing a token into a modifier and a term.
-    STRUCTURE = /\A(?:(#{MODIFIER}):[[:space:]]*)?"?(.+?)"?\z/
-
     ##
     # Returns the modifier portion of the token. Returns +nil+ if token does
     # not have a modifier.
     #
-    #   Token.new('foo: bar').modifier # => 'foo'
+    #   Token.new('foo: bar').modifier # => "foo"
     #   Token.new('bar').modifier      # => nil
     def modifier
-      self[STRUCTURE, 1]
+      self[SIMPLE_OR_COMPOUND_TOKEN_WITH_GROUPING, 1]
     end
 
     alias operator modifier
@@ -38,11 +34,12 @@ module SearchLingo
     # Returns the term portion of the token. If the term is wrapped in quotes,
     # they are removed.
     #
-    #   Token.new('foo: bar').term  # => 'bar'
-    #   Token.new('bar').term       # => 'bar'
-    #   Token.new('"bar baz"').term # => 'bar baz'
+    #   Token.new('foo: bar').term  # => "bar"
+    #   Token.new('bar').term       # => "bar"
+    #   Token.new('"bar baz"').term # => "bar baz"
+    #   Token.new('""').term        # => ""
     def term
-      self[STRUCTURE, 2]
+      self[SIMPLE_OR_COMPOUND_TOKEN_WITH_GROUPING, 2].delete_prefix('"').delete_suffix('"')
     end
 
     ##
@@ -56,10 +53,10 @@ module SearchLingo
 
     def inspect # :nodoc:
       format '#<%<cls>s String(%<str>s) modifier=%<mod>s term=%<term>s>',
-        cls: self.class,
-        str: super,
-        mod: modifier.inspect,
-        term: term.inspect
+             cls: self.class,
+             str: super,
+             mod: modifier.inspect,
+             term: term.inspect
     end
   end
 end

data/lib/search_lingo/tokenizer.rb

@@ -16,18 +16,6 @@ module SearchLingo
     include Enumerable
     extend Forwardable
 
-    ##
-    # Pattern for matching a simple token (a term without a modifier).
-    SIMPLE_TOKEN   = /#{TERM}/
-
-    ##
-    # Pattern for matching a compound token (a term with an optional modifier).
-    COMPOUND_TOKEN = /(?:#{MODIFIER}:[[:space:]]*)?#{TERM}/
-
-    ##
-    # Pattern for matching the delimiter between tokens.
-    DELIMITER      = /[[:space:]]*/
-
     def initialize(query) # :nodoc:
       @scanner = StringScanner.new query.strip
     end
@@ -42,11 +30,11 @@ module SearchLingo
     end
 
     ##
-    # Returns a Token for the next token in the query string. When the end of
+    # Returns a +Token+ for the next token in the query string. When the end of
     # the query string is reached raises +StopIteration+.
     def next
       scanner.skip DELIMITER
-      token = scanner.scan COMPOUND_TOKEN
+      token = scanner.scan SIMPLE_OR_COMPOUND_TOKEN
       raise StopIteration unless token
 
       Token.new token

data/lib/search_lingo/version.rb

@@ -1,5 +1,5 @@
 # frozen-string-literal: true
 
 module SearchLingo
-  VERSION = '2.0.0'
+  VERSION = '3.0.0.pre1'
 end

data/search_lingo.gemspec

@@ -4,7 +4,6 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'search_lingo/version'
 
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'search_lingo'
   spec.version       = SearchLingo::VERSION
@@ -19,25 +18,26 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jparker/search_lingo'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f|
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
-  }
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.rdoc_options += ['-x', 'examples/', '-x', 'test/']
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'minitest-focus'
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
+  spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'sequel', '~> 5.0'
   spec.add_development_dependency 'sqlite3'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end
-# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_lingo
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0.pre1
 platform: ruby
 authors:
 - John Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-25 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -86,16 +86,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,6 +160,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
@@ -169,7 +184,8 @@ files:
 homepage: https://github.com/jparker/search_lingo
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options:
 - "-x"
@@ -182,15 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Framework for defining and parsing search queries.