lsolr 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e49132ead477dd5f50d86d46cec871e47a7b33db
-  data.tar.gz: 9ce3049d5577571cea8a650635f0af9d3517285b
+SHA256:
+  metadata.gz: 20924e50e137b0ecacfbc21f0b12ac52db3904195c4b3cf42090cefe20cab911
+  data.tar.gz: fbfe0c7c327d9205cab1a566db724ec8779f71b20df5a3a05364247978cc1e8f
 SHA512:
-  metadata.gz: 2a1db34ed53ab514e0c80f92897bdb74187d3e157a63486eae973dae95429530ec279490aee62f2f5aaabf87e94b78bbfa0715046b9f2dfacd6da41c6b33a16c
-  data.tar.gz: 2587c78f6de1121226ed98b026e2afa1b0611750037caae7d0c5a9a2acf51250a5bf7810c13462f1dc675bbc7e61faaf1087d10d3716c03b2b0cb43e8ba7d5d6
+  metadata.gz: 62cf4176711e853c9468afb0d18c7d8bdec1c3122973caa26d7634696b71485c38feae5619cb81bc55f75d5f84801503a0a0e2611d706fcf69c9d49aa134a801
+  data.tar.gz: 6dc375254e095659cbd5af6b5b4523419c5ea83cedfd96e6bac046d6610c6d170c9c4b166a47d4d1a9d49954447b02c0406ab278a7c6e0a39b25642d933b4852

data/lib/lsolr.rb

@@ -28,11 +28,21 @@ require 'date'
 #    }
 #
 #    LSolr.build(params).to_s
-#    #=> '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 2 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]'
+#    #=> '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 2 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:
 #    bool1 = LSolr.new(:bool_field).match(true)
@@ -48,8 +58,12 @@ require 'date'
 #    #    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}))'
 #
 # @example How to use. Part 4:
-#    LSolr.build('field:value').to_s
-#    #=> 'field:value'
+#    %w[a b c].map { |v| LSolr.new(:field).prefix_match("#{v}*") }.reduce { |a, e| a.or(e) }.wrap.not.to_s
+#    #=> 'NOT (field:a* OR field:b* OR field:c*)'
+#
+# @example How to use. Part 5:
+#    LSolr.build('a:1').and(LSolr.build(b: 2)).to_s
+#    #=> 'a:1 AND b:2'
 class LSolr
   ArgumentError = Class.new(::ArgumentError)
   RangeError = Class.new(::RangeError)
@@ -69,6 +83,7 @@ class LSolr
   WILD_CARD = '*'
   PROXIMITY = '~'
   BOOST = '^'
+  CONSTANT_SCORE = '^='
   PHRASE_MATCH_DELIMITER = ' '
   MULTI_VALUE_MATCH_DELIMITER = ' '
   FUZZY_MATCH_DISTANCE_RANGE = (0.0..2.0).freeze
@@ -96,7 +111,7 @@ class LSolr
       case params
       when Hash then params.map { |f, v| build_query(f, v) }.reduce { |a, e| a.and(e) }
       when String then new.raw(params)
-      else raise TypeError, 'Could not build solr query. Please specify a Hash or String value.'
+      else raise TypeError, "Could not build solr query. Please specify a Hash or String value. #{params.inspect} given."
       end
     end
 
@@ -110,7 +125,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 TypeError, "Could not build solr query. field: #{field}, value: #{value.inspect}"
+      else raise TypeError, "Could not build solr query. field: #{field.inspect}, value: #{value.inspect} given."
       end
     end
 
@@ -137,25 +152,25 @@ class LSolr
 
   # Create a new query builder instance.
   #
-  # @param field [String, Symbol] a field name
+  # @param field_name [String, Symbol] a field name
   # @return [LSolr] a instance
-  def initialize(field = '')
-    @expr_not = ''
-    @field = field.to_s
-    @value = ''
-    @range_first = ''
-    @range_last = ''
-    @boost = ''
+  def initialize(field_name = nil)
+    if field_name.nil?
+      @field = ''
+    else
+      field(field_name)
+    end
+
+    @expr_not = @value = @range_first = @range_last = @boost = @constant_score = @raw = ''
     @left_parentheses = []
     @right_parentheses = []
-    @raw = ''
   end
 
   # Returns Apache Solr standard lucene type query string.
   #
   # @return [String] a stringified query
   def to_s
-    raise IncompleteQueryError, 'Please specify search field and value.' if blank?
+    raise IncompleteQueryError, 'Please specify a term of search.' if blank?
 
     decorate_term_expr_if_needed(build_term_expr)
   end
@@ -179,11 +194,13 @@ class LSolr
 
   # Sets a field name.
   #
-  # @param f [String, Symbol] a field name
+  # @param name [String, Symbol] a field name
   #
   # @return [LSolr] self instance
-  def field(f)
-    @field = f.to_s
+  def field(name)
+    raise ArgumentError, "The field name must be a not empty string value. #{name.inspect} given." unless present_string?(name)
+
+    @field = name.to_s
     self
   end
 
@@ -193,6 +210,8 @@ class LSolr
   #
   # @return [LSolr] self instance
   def raw(q)
+    raise ArgumentError, "The raw query must be a not empty string value. #{q.inspect} given." unless present_string?(q)
+
     @raw = q.to_s
     self
   end
@@ -228,11 +247,26 @@ class LSolr
   #
   # @return [LSolr] self instance
   def boost(factor)
-    raise ArgumentError, "The boost factor number must be positive. #{factor} given." if factor <= 0
+    raise ArgumentError, "The boost factor must be a positive number. #{factor.inspect} given." unless valid_boost_factor?(factor)
+
     @boost = "#{BOOST}#{factor}"
     self
   end
 
+  # Specifies scoring result in expression.
+  #
+  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#constant-score-with Constant Score with "^="
+  #
+  # @param score [Float] a constant score
+  #
+  # @return [LSolr] self instance
+  def constant_score(score)
+    raise ArgumentError, "The constant score must be a number. #{score.inspect} given." unless valid_score?(score)
+
+    @constant_score = "#{CONSTANT_SCORE}#{score}"
+    self
+  end
+
   # Builds a normal query expression.
   #
   # @param value [String, Integer, true, false] a search word or a filter value
@@ -255,7 +289,7 @@ class LSolr
   #
   # @return [LSolr] self instance
   def match_in(values)
-    raise ArgumentError, "#{values.inspect} given. Must be a not empty array." if values.nil? || !values.is_a?(Array) || values.empty?
+    raise ArgumentError, "#{values.inspect} given. It must be a not empty array." unless present_array?(values)
 
     values = values.map { |v| clean(v) }
     @value = "(#{values.join(MULTI_VALUE_MATCH_DELIMITER)})"
@@ -414,6 +448,22 @@ class LSolr
     !@raw.empty?
   end
 
+  def present_string?(v)
+    !v.nil? && (v.is_a?(String) || v.is_a?(Symbol)) && !v.empty?
+  end
+
+  def present_array?(v)
+    !v.nil? && v.is_a?(Array) && !v.compact.empty? && v.map(&:to_s).map(&:empty?).none?
+  end
+
+  def valid_boost_factor?(v)
+    (v.is_a?(Float) || v.is_a?(Integer)) && v > 0
+  end
+
+  def valid_score?(v)
+    v.is_a?(Float) || v.is_a?(Integer)
+  end
+
   def clean(value, symbols: RESERVED_SYMBOLS)
     value.to_s
          .tr(symbols.join, REPLACEMENT_CHAR)
@@ -463,6 +513,7 @@ class LSolr
   def decorate_term_expr_if_needed(expr)
     expr = "#{expr_not}#{left_parentheses.join}#{expr}#{right_parentheses.join}"
     expr = "#{prev} #{operator} #{expr}" if !prev.nil? && prev.present?
-    "#{expr}#{@boost}"
+    scoring = present_string?(@constant_score) ? @constant_score : @boost
+    "#{expr}#{scoring}"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lsolr
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-02-17 00:00:00.000000000 Z
 dependencies: []
 description: LSolr is a query builder of Apache Solr standard Lucene type query for
   Ruby.
@@ -38,7 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A query builder of Apache Solr for Ruby