lsolr 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20924e50e137b0ecacfbc21f0b12ac52db3904195c4b3cf42090cefe20cab911
-  data.tar.gz: fbfe0c7c327d9205cab1a566db724ec8779f71b20df5a3a05364247978cc1e8f
+  metadata.gz: e10967d4b5a602672070691c144b7471cd2b085ae08737a457101333540d82e2
+  data.tar.gz: d58e9b7d1975f3d6b5d799bb26985974ab134f3edb4794354cbb52ba2f7625f2
 SHA512:
-  metadata.gz: 62cf4176711e853c9468afb0d18c7d8bdec1c3122973caa26d7634696b71485c38feae5619cb81bc55f75d5f84801503a0a0e2611d706fcf69c9d49aa134a801
-  data.tar.gz: 6dc375254e095659cbd5af6b5b4523419c5ea83cedfd96e6bac046d6610c6d170c9c4b166a47d4d1a9d49954447b02c0406ab278a7c6e0a39b25642d933b4852
+  metadata.gz: 722047aaeded40aeafeac2f614c8eb7f2add58a8a51963a3a7ef9d2f32a4c0a3643daf7f2f7f42283a041cec18d58cdf1e5b6d7a5c66d071bf9ac2a602d590ff
+  data.tar.gz: 2cc6913b18142b476cf1edc47fbf7dc8ce15dcc674c838ea07045c93cbc2b13d8dab7f37ec2c5277878f64620c5352fc6311d1010f0535e8c12b956af50c2e2f

data/lib/lsolr.rb

@@ -62,7 +62,7 @@ require 'date'
 #    #=> '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
+#    LSolr.build('a:1').and(b: 2).to_s
 #    #=> 'a:1 AND b:2'
 class LSolr
   ArgumentError = Class.new(::ArgumentError)
@@ -110,7 +110,7 @@ class LSolr
     def build(params)
       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)
+      when String then build_raw_query(params)
       else raise TypeError, "Could not build solr query. Please specify a Hash or String value. #{params.inspect} given."
       end
     end
@@ -148,6 +148,10 @@ class LSolr
       values.each { |v| last = v }
       new(field).greater_than_or_equal_to(values.first).less_than_or_equal_to(last)
     end
+
+    def build_raw_query(query)
+      query.empty? ? new : new.raw(query)
+    end
   end
 
   # Create a new query builder instance.
@@ -172,7 +176,7 @@ class LSolr
   def to_s
     raise IncompleteQueryError, 'Please specify a term of search.' if blank?
 
-    decorate_term_expr_if_needed(build_term_expr)
+    decorate_linked_expressions_if_needed(build_expression)
   end
 
   alias to_str to_s
@@ -206,19 +210,19 @@ class LSolr
 
   # Sets a raw query.
   #
-  # @param q [String] raw query
+  # @param query [String] a raw query string
   #
   # @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)
+  def raw(query)
+    raise ArgumentError, "The raw query must be a not empty string value. #{query.inspect} given." unless present_string?(query)
 
-    @raw = q.to_s
+    @raw = query.to_s
     self
   end
 
   # Adds parentheses to query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#grouping-terms-to-form-sub-queries Grouping Terms to Form Sub-Queries
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#grouping-terms-to-form-sub-queries Grouping Terms to Form Sub-Queries
   #
   # @return [LSolr] copied self instance
   def wrap
@@ -230,7 +234,7 @@ class LSolr
 
   # Adds the boolean operator `NOT` to query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#the-boolean-operator-not The Boolean Operator NOT ("!")
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#the-boolean-operator-not The Boolean Operator NOT ("!")
   #
   # @return [LSolr] self instance
   def not
@@ -241,7 +245,7 @@ class LSolr
 
   # Boosts a query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#boosting-a-term-with Boosting a Term with "^"
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#boosting-a-term-with Boosting a Term with "^"
   #
   # @param factor [Float] a boost factor number
   #
@@ -255,7 +259,7 @@ class LSolr
 
   # 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 "^="
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#constant-score-with Constant Score with "^="
   #
   # @param score [Float] a constant score
   #
@@ -298,7 +302,7 @@ class LSolr
 
   # Builds a normal query expression with dates and times.
   #
-  # @see https://lucene.apache.org/solr/guide/6_6/working-with-dates.html Working with Dates
+  # @see https://lucene.apache.org/solr/guide/7_2/working-with-dates.html Working with Dates
   #
   # @param value [String, Date, Time] a filter value
   #
@@ -311,7 +315,7 @@ class LSolr
 
   # Builds a prefix search query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#wildcard-searches Wildcard Searches
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#wildcard-searches Wildcard Searches
   #
   # @param value [String] a search word
   #
@@ -323,8 +327,8 @@ class LSolr
 
   # Builds a phrase or proximity search query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#grouping-clauses-within-a-field Grouping Clauses within a Field
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#proximity-searches Proximity Searches
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#grouping-clauses-within-a-field Grouping Clauses within a Field
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#proximity-searches Proximity Searches
   #
   # @param values [Array<String>] search words
   # @param distance [Integer] proximity distance
@@ -339,7 +343,7 @@ class LSolr
 
   # Builds a fuzzy search query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#fuzzy-searches Fuzzy Searches
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#fuzzy-searches Fuzzy Searches
   #
   # @param value [String] a search word
   # @param distance [Float] a proximity distance
@@ -353,7 +357,7 @@ class LSolr
 
   # Builds a range search query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#range-searches Range Searches
   #
   # @param value [String, Integer, Date, Time] a filter value
   #
@@ -365,7 +369,7 @@ class LSolr
 
   # Builds a range search query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#range-searches Range Searches
   #
   # @param value [String, Integer, Date, Time] a filter value
   #
@@ -377,7 +381,7 @@ class LSolr
 
   # Builds a range search query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#range-searches Range Searches
   #
   # @param value [String, Integer, Date, Time] a filter value
   #
@@ -389,7 +393,7 @@ class LSolr
 
   # Builds a range search query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#range-searches Range Searches
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#range-searches Range Searches
   #
   # @param value [String, Integer, Date, Time] a filter value
   #
@@ -401,9 +405,9 @@ class LSolr
 
   # Builds a composite query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#the-boolean-operator-and The Boolean Operator AND ("&&")
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#the-boolean-operator-and The Boolean Operator AND ("&&")
   #
-  # @param another [LSolr] another query builder instance
+  # @param another [LSolr, Hash, String] another query builder instance or query params or raw query string
   #
   # @return [LSolr] copied another query builder instance
   def and(another)
@@ -412,9 +416,9 @@ class LSolr
 
   # Builds a composite query expression.
   #
-  # @see https://lucene.apache.org/solr/guide/7_1/the-standard-query-parser.html#boolean-operators-supported-by-the-standard-query-parser Boolean Operators Supported by the Standard Query Parser
+  # @see https://lucene.apache.org/solr/guide/7_2/the-standard-query-parser.html#boolean-operators-supported-by-the-standard-query-parser Boolean Operators Supported by the Standard Query Parser
   #
-  # @param another [LSolr] another query builder instance
+  # @param another [LSolr, Hash, String] another query builder instance or query params or raw query string
   #
   # @return [LSolr] copied another query builder instance
   def or(another)
@@ -425,7 +429,7 @@ class LSolr
   #
   # @return [LSolr] a first term of query.
   def head
-    if !prev.nil? && prev.present?
+    if present_query?(prev)
       prev.head
     else
       self
@@ -435,7 +439,7 @@ class LSolr
   private
 
   def initialize_copy(obj)
-    obj.prev = obj.prev.dup if !obj.prev.nil? && obj.prev.present?
+    obj.prev = obj.prev.dup if present_query?(obj.prev)
     obj.left_parentheses = obj.left_parentheses.dup
     obj.right_parentheses = obj.right_parentheses.dup
   end
@@ -456,6 +460,10 @@ class LSolr
     !v.nil? && v.is_a?(Array) && !v.compact.empty? && v.map(&:to_s).map(&:empty?).none?
   end
 
+  def present_query?(v)
+    !v.nil? && v.present?
+  end
+
   def valid_boost_factor?(v)
     (v.is_a?(Float) || v.is_a?(Integer)) && v > 0
   end
@@ -491,7 +499,8 @@ class LSolr
   end
 
   def link(another, operator)
-    return self if another.nil? || another.blank?
+    another = build_instance_if_needed(another)
+    return self unless present_query?(another)
 
     another = another.dup
     head = another.head
@@ -500,7 +509,14 @@ class LSolr
     another
   end
 
-  def build_term_expr
+  def build_instance_if_needed(another)
+    case another
+    when self.class then another
+    when Hash, String then self.class.build(another)
+    end
+  end
+
+  def build_expression
     if raw?
       @raw
     elsif range_search?
@@ -510,9 +526,9 @@ class LSolr
     end
   end
 
-  def decorate_term_expr_if_needed(expr)
+  def decorate_linked_expressions_if_needed(expr)
     expr = "#{expr_not}#{left_parentheses.join}#{expr}#{right_parentheses.join}"
-    expr = "#{prev} #{operator} #{expr}" if !prev.nil? && prev.present?
+    expr = "#{prev} #{operator} #{expr}" if present_query?(prev)
     scoring = present_string?(@constant_score) ? @constant_score : @boost
     "#{expr}#{scoring}"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lsolr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Taishi Kasuga