lsolr 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c54840a14b31fc2c85a73294fd6617dd5e918584
-  data.tar.gz: 68f92d1fce16534895aaf287eaa33ab6c407f041
+SHA256:
+  metadata.gz: 5e5ca288040ec046e3df00c273dcd6c3ccc6bd31e6db172bb652ff377dddaaf4
+  data.tar.gz: d87df9ae56c1aa37c1b92e11c00c82b0a3afb44abdd7e918e48ab88cce69a7e8
 SHA512:
-  metadata.gz: ffd1a3501680882574ff40442680ee588cdbc539f5906d6d25863e21aeda24777a1d34677dc99cbe67bdc0144595f73bf08687da2d1727eddaefce184d90f043
-  data.tar.gz: 28cae9bcbf02b498c0ebaadfdb77ba0bbf8cff4476fd7c035d546eca45b43ecec28d4e99148dacfa576b132eba53c68158bfde5cd75df6e5ea396e9faef6eed7
+  metadata.gz: 4da503d0ce9a2627630c35848d8e3dc0d1b5fdacbf60839d9973f82a7ac2cd79d29a73a57a4583ed2ebf3a98de9bd14a5488da55f77cc41f24010cb76c091e70
+  data.tar.gz: b0ad4353b239b32cfdaf828cfc201dae3b917f21f861c4c460787b575d0630ec60276ff9cd6a36d3daa8d9ee0cc24730df68206a11ae83ea8d283c83453de95c

data/lib/lsolr.rb

@@ -1,8 +1,40 @@
 # frozen_string_literal: true
 
+require 'date'
+
 # A query builder of Apache Solr standard Lucene type query for Ruby.
 #
-# @example How to use.
+# @example How to use. Part 1:
+#   LSolr.build(term1: 'hoge', term2: true).to_s
+#   #=> 'term1:hoge AND term2:true'
+#
+# @example How to use. Part 2:
+#    params = {
+#      term01: 'hoge',
+#      term02: :fuga,
+#      term03: 14,
+#      term04: 7.3,
+#      term05: true,
+#      term06: false,
+#      term07: Date.new(7000, 7, 1),
+#      term08: DateTime.new(6000, 5, 31, 6, 31, 43),
+#      term09: Time.new(5000, 6, 30, 12, 59, 3),
+#      term10: LSolr.new(:term10).fuzzy_match('foo'),
+#      term11: [1, 2, 3],
+#      term12: 1..10,
+#      term13: 20...40,
+#      term14: Date.new(3000, 1, 1)..Date.new(4000, 12, 31),
+#      term15: (3.0..4.0).step(0.1)
+#    }
+#
+#    LSolr.build(params).to_s
+#    #=> 'term01:hoge AND term02:fuga AND term03:14 AND term04:7.3 AND term05:true
+#    #    AND term06:false AND term07:"7000-07-01T00:00:00Z" AND term08:"6000-05-31T06:31:43Z"
+#    #    AND term09:"5000-06-30T12:59:03Z" AND term10:foo~2.0 AND (term11:1 OR term11:2 OR term11:3)
+#    #    AND term12:[1 TO 10] AND term13:[20 TO 40} AND term14:[3000-01-01T00:00:00Z TO 4000-12-31T00:00:00Z]
+#    #    AND term15:[3.0 TO 4.0]'
+#
+# @example How to use. Part 3:
 #   monoclinic = LSolr.new(:crystal_system).match(:monoclinic)
 #   cubic = LSolr.new(:crystal_system).match(:cubic)
 #   soft = LSolr.new(:mohs_scale).greater_than_or_equal_to('*').less_than(5.0)
@@ -27,7 +59,12 @@ class LSolr
   WILD_CARD = '*'
   PROXIMITY = '~'
   BOOST = '^'
+  PHRASE_MATCH_DELIMITER = ' '
   FUZZY_MATCH_DISTANCE_RANGE = (0.0..2.0).freeze
+  FORMAT_DATE_TIME = '%Y-%m-%dT%H:%M:%SZ'
+  FORMAT_MILLISECOND_FOR_DATE_TYPE = '%Q'
+  FORMAT_MILLISECOND_FOR_TIME_TYPE = '%L'
+  FORMAT_SECOND = '%s'
 
   PARENTHESIS_LEFT = '('
   PARENTHESIS_RIGHT = ')'
@@ -38,6 +75,49 @@ class LSolr
 
   attr_accessor :prev, :operator, :left_parentheses, :right_parentheses
 
+  class << self
+    # Builds composite query and returns builder instance.
+    #
+    # @param params [Hash{Symbol => String, Integer, Float, true, false, Range, Date, Time}] query terms
+    #
+    # @return [LSolr] a instance
+    def build(params)
+      params.map { |f, v| build_query(f, v) }.reduce { |a, e| a.and(e) }
+    end
+
+    private
+
+    def build_query(field, value) # rubocop:disable Metrics/CyclomaticComplexity
+      case value
+      when String, Symbol, Integer, Float, true, false then new(field).match(value)
+      when Date, Time then new(field).date_time_match(value)
+      when LSolr then value
+      when Array then build_array_query(field, value)
+      when Range then build_range_query(field, value)
+      when Enumerator then build_enumerator_query(field, value)
+      else raise ArgumentError, "Could not build solr query. field: #{field}, value: #{value.inspect}"
+      end
+    end
+
+    def build_array_query(field, values)
+      values.map { |v| build_query(field, v) }.reduce { |a, e| a.or(e) }.wrap
+    end
+
+    def build_range_query(field, value)
+      if value.exclude_end?
+        new(field).greater_than_or_equal_to(value.first).less_than(value.last)
+      else
+        new(field).greater_than_or_equal_to(value.first).less_than_or_equal_to(value.last)
+      end
+    end
+
+    def build_enumerator_query(field, values)
+      last = nil
+      values.each { |v| last = v }
+      new(field).greater_than_or_equal_to(values.first).less_than_or_equal_to(last)
+    end
+  end
+
   # Create a new query builder instance.
   #
   # @param field [String] a field name
@@ -125,6 +205,7 @@ class LSolr
   # @return [LSolr] self instance
   def match(value)
     values = clean(value).split
+
     if values.size > 1
       phrase_match(values)
     else
@@ -135,11 +216,19 @@ class LSolr
 
   # Builds a normal query expression with dates and times.
   #
-  # @param value [String] a filter value
+  # @see https://lucene.apache.org/solr/guide/6_6/working-with-dates.html Working with Dates
+  #
+  # @param value [String, Date, Time] a filter value
   #
   # @return [LSolr] self instance
   def date_time_match(value)
-    @value = clean(value, symbols: RESERVED_SYMBOLS - %w[- : . / +])
+    value = if value.is_a?(Date) || value.is_a?(Time)
+              format_date(value)
+            else
+              clean(value, symbols: RESERVED_SYMBOLS - %w[- : . / +])
+            end
+
+    @value = %("#{value}")
     self
   end
 
@@ -165,7 +254,7 @@ class LSolr
   #
   # @return [LSolr] self instance
   def phrase_match(values, distance: 0)
-    value = values.map { |v| clean(v).split }.flatten.join(REPLACEMENT_CHAR)
+    value = values.map { |v| clean(v).split }.flatten.join(PHRASE_MATCH_DELIMITER)
     proximity_match = distance > 0 ? "#{PROXIMITY}#{distance}" : ''
     @value = %("#{value}"#{proximity_match})
     self
@@ -189,10 +278,11 @@ class LSolr
   #
   # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
   #
-  # @param value [String, Integer] a filter value
+  # @param value [String, Integer, Date, Time] a filter value
   #
   # @return [LSolr] self instance
   def greater_than(value)
+    value = format_date(value) if value.is_a?(Date) || value.is_a?(Time)
     @range_first = "#{GREATER_THAN}#{value}"
     self
   end
@@ -201,10 +291,11 @@ class LSolr
   #
   # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
   #
-  # @param value [String, Integer] a filter value
+  # @param value [String, Integer, Date, Time] a filter value
   #
   # @return [LSolr] self instance
   def less_than(value)
+    value = format_date(value) if value.is_a?(Date) || value.is_a?(Time)
     @range_last = "#{value}#{LESS_THAN}"
     self
   end
@@ -213,10 +304,11 @@ class LSolr
   #
   # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
   #
-  # @param value [String, Integer] a filter value
+  # @param value [String, Integer, Date, Time] a filter value
   #
   # @return [LSolr] self instance
   def greater_than_or_equal_to(value)
+    value = format_date(value) if value.is_a?(Date) || value.is_a?(Time)
     @range_first = "#{GREATER_THAN_OR_EQUAL_TO}#{value}"
     self
   end
@@ -225,10 +317,11 @@ class LSolr
   #
   # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
   #
-  # @param value [String, Integer] a filter value
+  # @param value [String, Integer, Date, Time] a filter value
   #
   # @return [LSolr] self instance
   def less_than_or_equal_to(value)
+    value = format_date(value) if value.is_a?(Date) || value.is_a?(Time)
     @range_last = "#{value}#{LESS_THAN_OR_EQUAL_TO}"
     self
   end
@@ -287,4 +380,16 @@ class LSolr
     while !element.prev.nil? && element.prev.present? do element = element.prev end
     element
   end
+
+  def format_date(date)
+    msec_str = case date
+               when Date then date.strftime(FORMAT_MILLISECOND_FOR_DATE_TYPE).gsub(date.strftime(FORMAT_SECOND), '')
+               when Time then date.strftime(FORMAT_MILLISECOND_FOR_TIME_TYPE)
+               else raise ArgumentError, "Unknown type #{date.inspect}"
+               end
+
+    return date.strftime(FORMAT_DATE_TIME) if msec_str == '000'
+
+    "#{date.strftime('%Y-%m-%dT%H:%M:%S')}.#{msec_str}Z"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lsolr
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Taishi Kasuga
@@ -38,7 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A query builder of Apache Solr for Ruby