search_lingo 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4c58f28e8b25ab5ec35bf08089b12ccae7a0f88
-  data.tar.gz: 81bfba3fafebdadbe909ff5a6a4506e2fac965cc
+SHA256:
+  metadata.gz: 473413fa017d4fe273ea20952b89c778fd07d98735efaeef1c28954bc70c96ea
+  data.tar.gz: 11df6b8d3f02b8147afc5a7248a548861b038c8e7e9dffd854dca506e185fa7e
 SHA512:
-  metadata.gz: e8c453f5e4bd238077618415c6fd93840c3583358279793791ac94936d45152b2c3d07ed895a80f17a9076d064775c6e03042e8940cfcacd9c63ffb5a51322d1
-  data.tar.gz: 23077beb4f9a66b6a0f78f84a95939c1abb987d53adddef1650790a7069075fea6b92745a6b3fc44b3aab09699c461fc7eb12098ffa0f9eec99e8f8226f75258
+  metadata.gz: a6783a0cb4a8d8db96ddaf4a9cff6704484a6421f93351de009202a7f680c46a50d44c62672e7201a7cdaeb3999ac9df7646b1905471cfef43ef2c9c2e6ef87d
+  data.tar.gz: bed0ac621a52ffc67fc50ee32f5dd560f58a3f11444741bc3bae63a9be8f1d0e7e59e0656b5d1cab07cc2a05c1c200889d408c1c7142ceab31416a156edc9d38

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.1.6
-  - 2.2.2
+  - 2.4.4
+  - 2.5.1

data/README.md

@@ -276,11 +276,10 @@ Additionally, there are parsers for handling closed date ranges (e.g.,
 `12/31/15`). Look at the files in `lib/search_lingo/parsers` for more details.
 
 The date parser are specifically designed to work with US-formatted dates. Time
-permitting, I will work on making them more flexible. As implemented they are
-also ActiveRecord-centric; this also needs to be reexamined reexamined, either
-by finding a more agnostic implementation or renaming the parser classes to
-indicate they are ActiveRecord-only implementations. (If going the latter
-route, a Sequel-specific implementation should also be provided.)
+permitting, I will work on making them more flexible.
+
+As implemented they generate queries using AREL. In the future, we should try
+generalizing this behavior to also support Sequel for generating queries.
 
 ## Development
 

data/examples/complex.rb

@@ -21,36 +21,18 @@ module Parsers # :nodoc:
 end
 
 class JobSearch < SearchLingo::AbstractSearch # :nodoc:
+  parser SearchLingo::Parsers::DateParser.new Job.arel_table[:date]
   parser Parsers::IdParser.new Job.table_name
 
-  parser SearchLingo::Parsers::DateParser.new Job.table_name,
-    :date
-  parser SearchLingo::Parsers::DateRangeParser.new Job.table_name,
-    :date
-  parser SearchLingo::Parsers::OpenDateRangeParser.new Job.table_name,
-    :date, connection: Job.connection
-
   def default_parse(token)
-    [:where, 'jobs.name LIKE ?', "%#{token}%"]
+    [:where, Job.arel_table[:name].lower.like("%#{token}%")]
   end
 end
 
 class ReceiptSearch < SearchLingo::AbstractSearch # :nodoc:
-  parser Parsers::IdParser.new Receipt.table_name
-
-  parser SearchLingo::Parsers::DateParser.new Receipt.table_name,
-    :check_date
-  parser SearchLingo::Parsers::DateRangeParser.new Receipt.table_name,
-    :check_date
-  parser SearchLingo::Parsers::OpenDateRangeParser.new Receipt.table_name,
-    :check_date, connection: Receipt.connection
-
-  parser SearchLingo::Parsers::DateParser.new Receipt.table_name,
-    :post_date, 'posted'
-  parser SearchLingo::Parsers::DateRangeParser.new Receipt.table_name,
-    :post_date, 'posted'
-  parser SearchLingo::Parsers::OpenDateRangeParser.new Receipt.table_name,
-    :post_date, 'posted', connection: Receipt.connection
+  parser SearchLingo::Parsers::DateParser.new Receipt.arel_table[:check_date]
+  parser SearchLingo::Parsers::DateParser.new Receipt.arel_table[:post_date],
+    modifier: 'posted'
 
   parser do |token|
     token.match /\Aamount: (\d+(?:\.\d+)?)\z/ do |m|
@@ -59,19 +41,19 @@ class ReceiptSearch < SearchLingo::AbstractSearch # :nodoc:
   end
 
   def default_parse(token)
-    [:where, 'receipts.check_no LIKE ?', token]
+    [:where, Receipt.arel_table[:check_no].like(token)]
   end
 end
 
 search = JobSearch.new('6/4/15-6/5/15 id: 42 "foo bar"')
-search.results  # =>  Job
-                #       .where('jobs' => { date: Date.new(2015, 6, 4)..Date.new(2015, 6, 5) })
-                #       .where('jobs' => { id: '42' })
-                #       .where('jobs.name LIKE ?', '%foo bar%')
+search.results
+# => Job.where(Job.arel_table[:date].in(Date.new(2015,6,4)..Date.new(2015,6,5)))
+#       .where('jobs' => { id: '42' })
+#       .where(Job.arel_table[:name].lower.like('%foo bar%'))
 
 search = ReceiptSearch.new('-6/4/15 posted: 6/5/15- amount: 1000 123')
-search.results  # =>  Receipt
-                #       .where('"receipts"."check_date" <= ?', Date.new(2015, 6, 4))
-                #       .where('"receipts"."post_date" >= ?', Date.new(2015, 6, 5))
-                #       .where(receipts: { amount: '1000' })
-                #       .where('receipts.check_no LIKE ?', 123)
+search.results
+# => Receipt.where(Receipt.arel_table[:check_date].lteq(Date.new(2015,6,4)))
+#           .where(Receipt.arel_table[:post_date].gteq(Date.new(2015,6,5)))
+#           .where(receipts: { amount: '1000' })
+#           .where(Receipt.arel_table[:check_no].matches('123'))

data/examples/sequel_example.rb

@@ -31,7 +31,7 @@ end
 class CategoryParser # :nodoc:
   def call(token)
     if token.modifier == 'cat'
-      [:where, { category__name: token.term }]
+      [:where, { Sequel.qualify('category', 'name') => token.term }]
     end
   end
 end
@@ -39,12 +39,20 @@ end
 class TaskSearch < SearchLingo::AbstractSearch # :nodoc:
   parser CategoryParser.new
 
+  # Match categories with priority less than or greater than a given value.
+  #
+  # <2 => Categories with priority < 2
+  # >5 => Categories with priority > 5
   parser do |token|
     token.match /\A([<>])([[:digit:]]+)\z/ do |m|
-      [:where, ->{ priority.send m[1], m[2] }]
+      [:where, Sequel.expr { priority.send m[1], m[2] }]
     end
   end
 
+  # Match tasks with a given due_date.
+  #
+  # 7/4/1776 => Tasks with due_date == Date.new(1776, 7, 4)
+  # 7/4/17   => Tasks with due_date == Date.new(2017, 7, 4)
   parser do |token|
     token.match %r{\A(?<m>\d{1,2})/(?<d>\d{1,2})/(?<y>\d{2}\d{2}?)\z} do |m|
       begin
@@ -54,8 +62,12 @@ class TaskSearch < SearchLingo::AbstractSearch # :nodoc:
     end
   end
 
+  # Match tasks with names that contain a given term.
+  #
+  # pay bills   => Match tasks with names like "pay bills", "pay bills by today"
+  # brush teeth => Match tasks with names like "brush teeth", "brush teeth and floss"
   def default_parse(token)
-    [:where, 'tasks.name LIKE ?', "%#{token.term}%"]
+    [:where, Sequel.lit('tasks.name LIKE ?', "%#{token.term}%")]
   end
 
   def scope

data/lib/search_lingo/abstract_search.rb

@@ -23,34 +23,30 @@ module SearchLingo
     ##
     # Adds a new parser to the list of parsers used by this class.
     #
-    # The parser to be added can be passed in as an argument which responds to
-    # +#call+ or as a block. Raises +ArgumentError+ if neither a callable
-    # object nor a block is passed in. If both a callable argument and a block
-    # are passed in, a warning will be displayed, the callable argument will be
-    # used as the parser; the block will be ignored.
+    # The parser may be given as an anonymous block or as any argument which
+    # 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.
     #
     #   class MyParser
-    #     def call
+    #     def call(token)
     #       # return something
     #     end
     #   end
     #
     #   class MySearch < SearchLingo::AbstractSearch
     #     parser MyParser.new
-    #     parser do
+    #     parser do |token|
     #       # return something
     #     end
     #   end
-    def self.parser(callable = nil, &block)
-      unless callable || block_given?
-        raise ArgumentError, 'parse must be called with callable or block'
-      end
-      if callable && block_given?
-        # TODO: should this raise an error instead?
-        warn "WARNING: parse called with callable and block (#{caller.first}"
+    def self.parser(parser = nil, &block)
+      unless block_given? ^ parser.respond_to?(:call)
+        raise ArgumentError, 'parse must be called with callable OR block'
       end
-
-      parsers << (callable || block)
+      parsers << (parser || block)
     end
 
     ##
@@ -62,7 +58,13 @@ module SearchLingo
     ##
     # Returns the results of executing the search.
     def results
-      @results ||= conditions.inject(scope) do |query, condition|
+      @results ||= load_results
+    end
+
+    ##
+    # Constructs and performs the query.
+    def load_results
+      conditions.inject(scope) do |query, condition|
         query.public_send(*condition)
       end
     end
@@ -85,11 +87,16 @@ module SearchLingo
     def conditions
       tokenizer.inject([]) do |conditions, token|
         conditions << catch(:match) do
+          # 1. Try each parser with the token until :match is thrown.
           parse token
+
+          # 2. If :match not thrown and token is compound, simplify and try again.
           if token.compound?
             token = tokenizer.simplify
             parse token
           end
+
+          # 3. If :match still not thrown, fallback on default parser.
           default_parse token
         end
       end
@@ -113,6 +120,7 @@ module SearchLingo
         result = parser.call token
         throw :match, result if result
       end
+      nil
     end
 
     ##

data/lib/search_lingo/parsers/date_parser.rb

@@ -5,33 +5,71 @@ module SearchLingo
     class DateParser
       include MDY
 
-      def initialize(table, column, modifier = nil, **options)
-        @table    = table
-        @column   = column
-        @prefix   = %r{#{modifier}:\s*} if modifier
-
-        post_initialize **options
+      ##
+      # Instantiates a new DateParser object.
+      #
+      # The required argument +column+ should be an Arel attribute.
+      #
+      # If present, the optional argument +modifier+ will be used as the
+      # operator which precedes the date term.
+      #
+      # DateParser.new Booking.arel_table[:date]
+      # DateParser.new Contract.arel_table[:date], modifier: 'contract'
+      def initialize(column, modifier: nil)
+        @column = column
+        @prefix = %r{#{modifier}:[[:space:]]*} if modifier
       end
 
-      attr_reader :table, :column, :prefix
+      attr_reader :column, :prefix
 
-      # This implementation is specific to ActiveRecord::Base#where semantics.
-      # Explore an agnostic implementation or rename the DateParser class (and
-      # its descendants) to indicate that it is ActiveRecord-centric. If going
-      # the latter route, provide a Sequel-specific implementation as well.
+      ##
+      # Attempts to parse the token as a date, closed date range, or open date
+      # range.
+      #
+      # Examples of single dates are 7/14, 7/14/17, and 7/14/2017.
+      # Examples of closed date ranges are 1/1-6/30 and 7/1/16-6/30/18.
+      # Examples of open date ranges are -6/30 and 7/1/17-.
       def call(token)
+        parse_single_date(token)  ||
+          parse_date_range(token) ||
+          parse_lte_date(token)   ||
+          parse_gte_date(token)
+      end
+
+      def inspect # :nodoc:
+        '#<%s:0x%x @prefix=%s @column=%s>' %
+          [self.class, object_id << 1, prefix.inspect, column.inspect]
+      end
+
+      private
+
+      def parse_single_date(token)
         token.match /\A#{prefix}(?<date>#{US_DATE})\z/ do |m|
-          date = parse m[:date]
-          [:where, { table => { column => date } }] if date
+          date = parse(m[:date]) or return nil
+          [:where, column.eq(date)]
         end
       end
 
-      def post_initialize(**) # :nodoc:
+      def parse_date_range(token)
+        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
+          [:where, column.in(min..max)]
+        end
       end
 
-      def inspect # :nodoc:
-        '#<%s:0x%x @table=%s @column=%s @prefix=%s>' %
-          [self.class, object_id << 1, table.inspect, column.inspect, prefix.inspect]
+      def parse_lte_date(token)
+        token.match /\A#{prefix}-(?<date>#{US_DATE})\z/ do |m|
+          date = parse(m[:date]) or return nil
+          [:where, column.lteq(date)]
+        end
+      end
+
+      def parse_gte_date(token)
+        token.match /\A#{prefix}(?<date>#{US_DATE})-\z/ do |m|
+          date = parse(m[:date]) or return nil
+          [:where, column.gteq(date)]
+        end
       end
     end
   end

data/lib/search_lingo/parsers/mdy.rb

@@ -13,8 +13,8 @@ module SearchLingo
       # Returns a +Date+ object for the date represented by +term+. Returns
       # +nil+ if +term+ can not be parsed.
       #
-      # If the year has two digits, it will be expanded into a four-digit by
-      # +Date.parse+.
+      # If the year has two digits, it will be implicitly expanded into a
+      # four-digit year by +Date.parse+. Otherwise it will be used as is.
       #
       # 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
@@ -26,12 +26,13 @@ module SearchLingo
         term.match /\A#{US_DATE}\z/ do |m|
           return Date.parse "#{m[:y]}/#{m[:m]}/#{m[:d]}" if m[:y]
 
+          ref   = relative_to
           day   = Integer(m[:d])
           month = Integer(m[:m])
-          year  = if month < relative_to.month || month == relative_to.month && day <= relative_to.day
-                    relative_to.year
+          year  = if month < ref.month || month == ref.month && day <= ref.day
+                    ref.year
                   else
-                    relative_to.year - 1
+                    ref.year - 1
                   end
 
           Date.new year, month, day

data/lib/search_lingo/parsers.rb

@@ -1,6 +1 @@
 require 'search_lingo/parsers/date_parser'
-require 'search_lingo/parsers/date_range_parser'
-require 'search_lingo/parsers/open_date_range_parser'
-
-require 'search_lingo/parsers/lte_date_parser'
-require 'search_lingo/parsers/gte_date_parser'

data/lib/search_lingo/version.rb

@@ -1,3 +1,3 @@
 module SearchLingo
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/search_lingo.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'sequel'
+  spec.add_development_dependency 'sequel', '~> 4.48'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_lingo
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - John Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.48'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.48'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -117,11 +117,7 @@ files:
 - lib/search_lingo/constants.rb
 - lib/search_lingo/parsers.rb
 - lib/search_lingo/parsers/date_parser.rb
-- lib/search_lingo/parsers/date_range_parser.rb
-- lib/search_lingo/parsers/gte_date_parser.rb
-- lib/search_lingo/parsers/lte_date_parser.rb
 - lib/search_lingo/parsers/mdy.rb
-- lib/search_lingo/parsers/open_date_range_parser.rb
 - lib/search_lingo/token.rb
 - lib/search_lingo/tokenizer.rb
 - lib/search_lingo/version.rb
@@ -150,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Framework for building simple query languages

data/lib/search_lingo/parsers/date_range_parser.rb

@@ -1,15 +0,0 @@
-require 'search_lingo/parsers/date_parser'
-
-module SearchLingo
-  module Parsers # :nodoc:
-    class DateRangeParser < DateParser
-      def call(token)
-        token.match /\A#{prefix}(?<min>#{US_DATE})-(?<max>#{US_DATE})\z/ do |m|
-          min = parse m[:min]
-          max = parse m[:max], relative_to: min.next_year if min
-          [:where, { table => { column => min..max } }] if min && max
-        end
-      end
-    end
-  end
-end

data/lib/search_lingo/parsers/gte_date_parser.rb

@@ -1,13 +0,0 @@
-require 'search_lingo/parsers/open_date_range_parser'
-
-module SearchLingo
-  module Parsers # :nodoc:
-    class GTEDateParser < OpenDateRangeParser # :nodoc:
-      def initialize(*)
-        warn "DEPRECATION WARNING: use SearchLingo::Parsers::OpenDateRangeParser " \
-          "instead of #{self.class} (from #{caller.first})"
-        super
-      end
-    end
-  end
-end

data/lib/search_lingo/parsers/lte_date_parser.rb

@@ -1,13 +0,0 @@
-require 'search_lingo/parsers/open_date_range_parser'
-
-module SearchLingo
-  module Parsers # :nodoc:
-    class LTEDateParser < OpenDateRangeParser # :nodoc:
-      def initialize(*)
-        warn "DEPRECATION WARNING: use SearchLingo::Parsers::OpenDateRangeParser " \
-          "instead of #{self.class} (from #{caller.first})"
-        super
-      end
-    end
-  end
-end

data/lib/search_lingo/parsers/open_date_range_parser.rb

@@ -1,46 +0,0 @@
-require 'search_lingo/parsers/date_parser'
-require 'forwardable'
-
-module SearchLingo
-  module Parsers # :nodoc:
-    class OpenDateRangeParser < DateParser
-      extend Forwardable
-
-      def call(token)
-        parse_lte(token) || parse_gte(token)
-      end
-
-      def post_initialize(connection:, **)
-        @connection = connection
-      end
-
-      def_delegators :@connection, :quote_column_name, :quote_table_name
-
-      private
-
-      def parse_lte(token) # :nodoc:
-        token.match /\A#{prefix}-(?<date>#{US_DATE})\z/ do |m|
-          if date = parse(m[:date])
-            [
-              :where,
-              "#{quote_table_name table}.#{quote_column_name column} <= ?",
-              date
-            ]
-          end
-        end
-      end
-
-      def parse_gte(token) # :nodoc:
-        token.match /\A#{prefix}(?<date>#{US_DATE})-\z/ do |m|
-          if date = parse(m[:date])
-            [
-              :where,
-              "#{quote_table_name table}.#{quote_column_name column} >= ?",
-              date
-            ]
-          end
-        end
-      end
-    end
-  end
-end