lsolr 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5e5ca288040ec046e3df00c273dcd6c3ccc6bd31e6db172bb652ff377dddaaf4
-  data.tar.gz: d87df9ae56c1aa37c1b92e11c00c82b0a3afb44abdd7e918e48ab88cce69a7e8
+SHA1:
+  metadata.gz: 0de60c66ff9d0bcd24c7caa5c3d86f1bb829c341
+  data.tar.gz: dd3a5e496f35898ff3147860b83b912829f186bc
 SHA512:
-  metadata.gz: 4da503d0ce9a2627630c35848d8e3dc0d1b5fdacbf60839d9973f82a7ac2cd79d29a73a57a4583ed2ebf3a98de9bd14a5488da55f77cc41f24010cb76c091e70
-  data.tar.gz: b0ad4353b239b32cfdaf828cfc201dae3b917f21f861c4c460787b575d0630ec60276ff9cd6a36d3daa8d9ee0cc24730df68206a11ae83ea8d283c83453de95c
+  metadata.gz: daef2067c282dfc6bc0312800a6191cc31931e4fba5c15e13116fe9de9f7100f0da3109ca27941860c5987c97b1d7299dea4428ff22ce17ae56779572456c811
+  data.tar.gz: 16f091cd2ccfd556024ede8c33477ec5a888c175de2d6d1bc3b71d3234a1357cd82796d5b2f07e9ece6ef87a17914a7625ee301844b15a860629f8137430cb00

data/lib/lsolr.rb

@@ -5,47 +5,53 @@ require 'date'
 # A query builder of Apache Solr standard Lucene type query for Ruby.
 #
 # @example How to use. Part 1:
-#   LSolr.build(term1: 'hoge', term2: true).to_s
-#   #=> 'term1:hoge AND term2:true'
+#   LSolr.build(field1: 'hoge', field2: true).to_s
+#   #=> 'field1:hoge AND field2: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)
+#      field01: 'hoge',
+#      field02: :fuga,
+#      field03: 14,
+#      field04: 7.3,
+#      field05: true,
+#      field06: false,
+#      field07: Date.new(7000, 7, 1),
+#      field08: DateTime.new(6000, 5, 31, 6, 31, 43),
+#      field09: Time.new(5000, 6, 30, 12, 59, 3),
+#      field10: LSolr.new(:field10).fuzzy_match('foo'),
+#      field11: [1, 2, 3],
+#      field12: 1..10,
+#      field13: 20...40,
+#      field14: Date.new(3000, 1, 1)..Date.new(4000, 12, 31),
+#      field15: (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]'
+#    #=> 'field01:hoge AND field02:fuga AND field03:14 AND field04:7.3 AND field05:true
+#    #    AND field06:false AND field07:"7000-07-01T00:00:00Z" AND field08:"6000-05-31T06:31:43Z"
+#    #    AND field09:"5000-06-30T12:59:03Z" AND field10:foo~2.0 AND (field11:1 OR field11:2 OR field11:3)
+#    #    AND field12:[1 TO 10] AND field13:[20 TO 40} AND field14:[3000-01-01T00:00:00Z TO 4000-12-31T00:00:00Z]
+#    #    AND field15:[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)
-#   hard = LSolr.new(:mohs_scale).greater_than_or_equal_to(5.0).less_than_or_equal_to(10.0)
+#    bool1 = LSolr.new(:bool_field).match(true)
+#    bool2 = LSolr.new(:bool_field).match(false)
+#    date1 = LSolr.new(:date_field1).greater_than_or_equal_to('*').less_than_or_equal_to(Time.new(2000, 6, 30, 23, 59, 59))
+#    date2 = LSolr.new(:date_field2).greater_than(Time.new(2000, 7, 1, 0, 0, 0)).less_than(Time.new(2001, 1, 1, 0, 0, 0))
 #
-#   phosphophyllite = monoclinic.and(soft).wrap
-#   diamond = cubic.and(hard).wrap
+#    left = bool1.and(date1).and(date2).wrap
+#    right = bool2.and(date1.or(date2).wrap).wrap
 #
-#   phosphophyllite.or(diamond).to_s
-#   #=> '(crystal_system:monoclinic AND mohs_scale:[* TO 5.0}) OR (crystal_system:cubic AND mohs_scale:[5.0 TO 10.0])'
+#    left.or(right).to_s
+#    #=> '(bool_field:true AND date_field1:[* TO 2000-06-30T23:59:59Z] AND date_field2:{2000-07-01T00:00:00Z TO 2001-01-01T00:00:00Z})
+#    #    OR (bool_field:false AND (date_field1:[* TO 2000-06-30T23:59:59Z] OR date_field2:{2000-07-01T00:00:00Z TO 2001-01-01T00:00:00Z}))'
 class LSolr
+  ArgumentError = Class.new(::ArgumentError)
+  RangeError = Class.new(::RangeError)
+  TypeError = Class.new(::TypeError)
+  IncompleteQueryError = Class.new(StandardError)
+
   NOT = 'NOT'
   AND = 'AND'
   OR = 'OR'
@@ -95,7 +101,7 @@ class LSolr
       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}"
+      else raise TypeError, "Could not build solr query. field: #{field}, value: #{value.inspect}"
       end
     end
 
@@ -140,7 +146,7 @@ class LSolr
   # @return [String] a stringified query
   def to_s
     @value = "#{@range_first} #{TO} #{@range_last}" if range_search?
-    raise 'Please specify a search condition.' if blank?
+    raise IncompleteQueryError, 'Please specify a search value.' if blank?
 
     expr = "#{left_parentheses.join}#{@not}#{@field}:#{@value}#{right_parentheses.join}"
     expr = "#{prev} #{operator} #{expr}" if !prev.nil? && prev.present?
@@ -385,7 +391,7 @@ class LSolr
     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}"
+               else raise TypeError, "Could not format dates or times. Given value: #{date.inspect}"
                end
 
     return date.strftime(FORMAT_DATE_TIME) if msec_str == '000'

metadata

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