lsolr 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f14beb4eb4ea605689087f9ac1d6a3e27454918c377d4f3f096a06490502b67b
-  data.tar.gz: c49281b312fab6f80817df5d183ed90f0f635b90e3a4acb34051ff0660dd9675
+  metadata.gz: e4274e0bfec1e74ca2120624580aad73461057f1d5912d83ae0dba8ff82b52a5
+  data.tar.gz: a5cb76c8d965d86d6d6b541604fc1a8a23b6a73ba68ae566953677f68b1d95da
 SHA512:
-  metadata.gz: 06ec0a49a25893f4febf32b175167159d8b18d7cad19aa7876fbe678905058aec45a1d34cf9544830c11cb9b42c95f881c2ef66e96de65fd97526382154a8d57
-  data.tar.gz: 1953e59728553443cd41289392d1364f94276e4e0c9556c70822ca9ab9225237d76002e8b6477814ba2f0db6407420984703ce5b4ac0b422501d59d0dab6d77b
+  metadata.gz: dcd93b2d0e788cac40d2f942dd67a4245b6bd20d5dcb89d296c5d8fe29379975e8e220399f77201c3e416a9d308044f55a4f9720d5c74022df5b0aeb12adb893
+  data.tar.gz: 83e1c44d830e10fedf551c0fc77baf77adcc191a4da69defbfd8792a8deca754958e3c0751e7afacae73f6d7197bc02ab4942663a5636fd685152db64e8b3aae

data/lib/lsolr.rb

@@ -87,10 +87,11 @@ class LSolr
   PHRASE_MATCH_DELIMITER = ' '
   MULTI_VALUE_MATCH_DELIMITER = ' '
   FUZZY_MATCH_DISTANCE_RANGE = (0.0..2.0).freeze
-  FORMAT_DATE_TIME = '%Y-%m-%dT%H:%M:%SZ'
+  FORMAT_DATE_TIME = '%Y-%m-%dT%H:%M:%SZ' # rubocop:disable Style/FormatStringToken
   FORMAT_MILLISECOND_FOR_DATE_TYPE = '%Q'
   FORMAT_MILLISECOND_FOR_TIME_TYPE = '%L'
-  FORMAT_SECOND = '%s'
+  FORMAT_SECOND = '%s' # rubocop:disable Style/FormatStringToken
+  FORMAT_INSPECT = '#<%<class>s:%<object>#018x `%<query>s`>'
 
   PARENTHESIS_LEFT = '('
   PARENTHESIS_RIGHT = ')'
@@ -107,6 +108,8 @@ class LSolr
     # @param params [Hash{Symbol => String, Symbol, Integer, Float, true, false, Range, Date, Time, Array<String, Symbol, Integer>}, String] query terms or a raw query
     #
     # @return [LSolr] a instance
+    #
+    # @raise [LSolr::ArgumentError] if specified parameters have a not supported type value
     def build(params)
       case params
       when Hash then params.map { |f, v| build_query(f, v) }.reduce { |a, e| a.and(e) }
@@ -175,6 +178,8 @@ class LSolr
   # Returns Apache Solr standard lucene type query string.
   #
   # @return [String] a stringified query
+  #
+  # @raise [LSolr::IncompleteQueryError] if the query is incompletely
   def to_s
     raise IncompleteQueryError, 'Please specify a term of search.' if blank?
 
@@ -183,6 +188,15 @@ class LSolr
 
   alias to_str to_s
 
+  # Returns instance information.
+  #
+  # @return [String] instance information
+  def inspect
+    format(FORMAT_INSPECT, class: self.class.name,
+                           object: object_id << 1,
+                           query: present? ? to_s : '')
+  end
+
   # A query is blank if term is incomplete in expression.
   #
   # @return [true, false]
@@ -203,6 +217,8 @@ class LSolr
   # @param name [String, Symbol] a field name
   #
   # @return [LSolr] self instance
+  #
+  # @raise [LSolr::ArgumentError] if specified field name is empty
   def field(name)
     raise ArgumentError, "The field name must be a not empty string value. #{name.inspect} given." unless present_string?(name)
 
@@ -215,6 +231,8 @@ class LSolr
   # @param query [String] a raw query string
   #
   # @return [LSolr] self instance
+  #
+  # @raise [LSolr::ArgumentError] if specified raw query string is empty
   def raw(query)
     raise ArgumentError, "The raw query must be a not empty string value. #{query.inspect} given." unless present_string?(query)
 
@@ -252,6 +270,8 @@ class LSolr
   # @param factor [Float] a boost factor number
   #
   # @return [LSolr] self instance
+  #
+  # @raise [LSolr::ArgumentError] if specified boost factor is invalid
   def boost(factor)
     raise ArgumentError, "The boost factor must be a positive number. #{factor.inspect} given." unless valid_boost_factor?(factor)
 
@@ -266,6 +286,8 @@ class LSolr
   # @param score [Float] a constant score
   #
   # @return [LSolr] self instance
+  #
+  # @raise [LSolr::ArgumentError] if specified score number is invalid
   def constant_score(score)
     raise ArgumentError, "The constant score must be a number. #{score.inspect} given." unless valid_score?(score)
 
@@ -294,6 +316,8 @@ class LSolr
   # @param value [Array<String, Symbol, Integer>] a search words or a filter values
   #
   # @return [LSolr] self instance
+  #
+  # @raise [LSolr::ArgumentError] if specified value is a empty array or not array
   def match_in(values)
     raise ArgumentError, "#{values.inspect} given. It must be a not empty array." unless present_array?(values)
 
@@ -351,6 +375,8 @@ class LSolr
   # @param distance [Float] a proximity distance
   #
   # @return [LSolr] self instance
+  #
+  # @raise [LSolr::RangeError] if specified distance is out of range
   def fuzzy_match(value, distance: 2.0)
     raise RangeError, "Out of #{FUZZY_MATCH_DISTANCE_RANGE}. #{distance} given." unless FUZZY_MATCH_DISTANCE_RANGE.member?(distance)
     @value = "#{clean(value).split.join}#{PROXIMITY}#{distance}"
@@ -497,7 +523,7 @@ class LSolr
 
     return date.strftime(FORMAT_DATE_TIME) if msec_str == '000'
 
-    "#{date.strftime('%Y-%m-%dT%H:%M:%S')}.#{msec_str}Z"
+    "#{date.strftime('%Y-%m-%dT%H:%M:%S')}.#{msec_str}Z" # rubocop:disable Style/FormatStringToken
   end
 
   def link(another, operator)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lsolr
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-17 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies: []
 description: LSolr is a query builder of Apache Solr standard Lucene type query for
   Ruby.