solr_lite 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3b829f8f239974df1f4e84eff2803d00210c7ee60561cd353b7a9174ff6dd96
-  data.tar.gz: 35fcb552f2ad0384b4ae9312287791f4fc46850aa130852efe19a5adfdea6a69
+  metadata.gz: 72f7691a991ab4b1e073a57a357586676ba2406b2d237bb0645daa4a3afb4a29
+  data.tar.gz: 262d3a594d470b3968a9197bf7e4f7d806c39930562f906f2e067c492041678e
 SHA512:
-  metadata.gz: 4eacb399b8c0afadf285d706b736612684a82d06acae08929688d87cbf95c5035cc3dfc7bcab3fe9157960f68e5ee7477b4f57c3fa3324cdc212a805342ba5e2
-  data.tar.gz: 61a6fba302260f1d992346196e5cf0ea9f5651dd890f2ec4583cbdbbbdbf2daff30df7f14931824a9e1ed5cd80499a56631bf4576570771a2f036d5e5d9f202c
+  metadata.gz: 3bc6667f32f3ca2bb0adf22c73e90ec99b37189236ba0c72156d361dcf96423208809907c121679de3e5042ead3a6280fe4956bcbef7644bf125aed376e49b29
+  data.tar.gz: '02904a6967e638370c1218fe4c2621c6e61e11a64169c55dd2ff8fb30c2443f440246382b19f22e594169b699da90954d6b234061547c33607be5ae72c63c4eb'

data/lib/facet_field.rb

@@ -2,30 +2,51 @@ module SolrLite
   class FacetField
 
     class FacetValue
-      attr_accessor :text, :count, :remove_url, :add_url
+      attr_accessor :text, :count, :remove_url, :add_url, :range_start, :range_end
       def initialize(text = "", count = 0, remove_url = nil)
         @text = text
         @count = count
         @remove_url = remove_url
         @add_url = nil
+        @range_start = nil
+        @range_end = nil
       end
     end
 
-    attr_accessor :name, :title, :values
+    attr_accessor :name, :title, :values,
+      :range, :range_start, :range_end, :range_gap
+
     def initialize(name, display_value)
       @name = name # field name in Solr
       @title = display_value
       @values = []
+      @ranges = []
+      @range = false
+      @range_start = nil
+      @range_end = nil
+      @range_gap = nil
     end
 
     def to_qs(text)
       "#{@name}|#{CGI.escape(text)}"
     end
 
+    def to_qs_range(range_start, range_end)
+      "#{@name}^#{range_start},#{range_end}"
+    end
+
     def add_value(text, count)
       @values << FacetValue.new(text, count)
     end
 
+    def add_range(range_start, range_end, count)
+      text = "#{range_start} - #{range_end}"
+      value = FacetValue.new(text, count)
+      value.range_start = range_start
+      value.range_end = range_end
+      @values << value
+    end
+
     def value_count(text)
       v = @values.find {|v| v.text == text}
       return 0 if v == nil

data/lib/filter_query.rb

@@ -8,22 +8,19 @@ module SolrLite
     attr_accessor :field, :value, :solr_value, :qs_value, :form_value
     attr_accessor :title, :remove_url
 
-    def initialize(field, values)
-      @field = field
-      @value = values.join("|")
-      @solr_value = to_solr_fq_value(field, values)
-      @qs_value = "#{field}"
-      values.each do |v|
-        @qs_value += "|#{CGI.escape(v)}"    # URL friendly (no : or quotes)
+    def initialize(field, values, is_range = false)
+      if is_range
+        init_from_range(field, values.first)
+      else
+        init_from_values(field, values)
       end
-      @form_value = "#{field}|#{@value}"    # HTML Form friendly (no encoding, the form auto-encodes on POST)
-      @title = field                        # default to field name
-      @remove_url = nil
     end
 
     # qs is assumed to be the value taken from the query string
     # in the form `field|value` or `field|value1|valueN`.
     #
+    # For range values the format is: `field^start,end`
+    #
     # Sometimes(*) the string comes URL encoded, for example:
     #     `field|hello`
     #     `field|hello%20world`
@@ -32,9 +29,19 @@ module SolrLite
     # (*) Values coming from HTML forms submitted via HTTP POST tend
     # to be encoded slighly different than value submitted via
     # HTTP GET requests.
+    #
+    # TODO: Should I remove support for multi-values
+    #     (e.g. `field|value1|valueN`) since we are
+    #     not using them? It will make the code here
+    #     and in init_from_values() cleaner.
     def self.from_query_string(qs)
+      is_range = false
       tokens = CGI.unescape(qs).split("|")
-      return nil if tokens.count < 2
+      if tokens.count < 2
+        tokens = CGI.unescape(qs).split("^")
+        return nil if tokens.count != 2
+        is_range = true
+      end
       field = ""
       values = []
       tokens.each_with_index do |token, i|
@@ -44,7 +51,7 @@ module SolrLite
           values << token
         end
       end
-      FilterQuery.new(field, values)
+      FilterQuery.new(field, values, is_range)
     end
 
     private
@@ -52,6 +59,8 @@ module SolrLite
       # an array of values. Handles single and multi-value gracefully.
       # For single-value it returns "(field:value)". For multi-value
       # it returns "(field:value1) OR (field:value2)"
+      #
+      # TODO: Should multivalue use an AND instead of an OR?
       def to_solr_fq_value(field, values)
         solr_value = ""
         values.each_with_index do |v, i|
@@ -64,5 +73,39 @@ module SolrLite
         # Very important to escape the : otherwise URL.parse throws an error in Linux
         CGI.escape(solr_value)
       end
+
+      def to_solr_fq_value_range(field, range_start, range_end)
+        solr_value = '(' + field + ':[' + range_start + ' TO ' + range_end + '])'
+        # Very important to escape the : otherwise URL.parse throws an error in Linux
+        CGI.escape(solr_value)
+      end
+
+      # range_string is expected in the form "start,end"
+      def init_from_range(field, range_string)
+        @field = field
+        tokens = (range_string || "").split(",")
+        return nil if tokens.count != 2
+        range_start = tokens[0]
+        range_end = tokens[1]
+        @value = "#{range_start} - #{range_end}"
+        @solr_value = to_solr_fq_value_range(field, range_start, range_end)
+        @qs_value = "#{field}^#{range_string}"
+        @form_value = "#{field}^#{range_string}"  # HTML Form friendly (no encoding, the form auto-encodes on POST)
+        @title = field                            # default to field name
+        @remove_url = nil
+      end
+
+      def init_from_values(field, values)
+        @field = field
+        @value = values.join("|")
+        @solr_value = to_solr_fq_value(field, values)
+        @qs_value = "#{field}"
+        values.each do |v|
+          @qs_value += "|#{CGI.escape(v)}"        # URL friendly (no : or quotes)
+        end
+        @form_value = "#{field}|#{@value}"        # HTML Form friendly (no encoding, the form auto-encodes on POST)
+        @title = field                            # default to field name
+        @remove_url = nil
+      end
   end # class
 end # module

data/lib/response.rb

@@ -135,6 +135,7 @@ module SolrLite
 
     def set_facet_values()
       return if @solr_response["facet_counts"] == nil
+      solr_ranges = @solr_response["facet_counts"]["facet_ranges"] || {}
       solr_facets = @solr_response["facet_counts"]["facet_fields"]
       solr_facets.each do |solr_facet|
         # solr_facet is an array with two elements, e.g.
@@ -144,16 +145,33 @@ module SolrLite
         # the second element is an array with of value/count pairs (PEOPLE/32, ORG/4)
         field_name = solr_facet[0]
         facet_field = @params.facet_for_field(field_name)
-        values = solr_facet[1]
-        pairs = values.count/2
-        for pair in (1..pairs)
-          index = (pair-1) * 2
-          text = values[index]
-          count = values[index+1]
-          facet_field.add_value(text, count)
+        if facet_field.range
+          # Use the range values as the facet values.
+          #
+          # Notice that we are overloading the "values" field and therefore
+          # we lose (i.e. don't store) the actual facet values and their counts.
+          # We might want to rethink this and keep them both.
+          values = solr_ranges[facet_field.name]["counts"] || []
+          pairs_count = values.count/2
+          for pair in (1..pairs_count)
+            index = (pair-1) * 2
+            start_range = values[index].to_i
+            end_range = start_range + facet_field.range_gap - 1
+            count = values[index+1]
+            facet_field.add_range(start_range, end_range, count)
+          end
+        else
+          # Regular facet values
+          values = solr_facet[1]
+          pairs = values.count/2
+          for pair in (1..pairs)
+            index = (pair-1) * 2
+            text = values[index]
+            count = values[index+1]
+            facet_field.add_value(text, count)
+          end
         end
       end
-      # TODO: make sure we sort the FacetField.VALUES descending by count
     end
 
     def explainer()

data/lib/search_params.rb

@@ -1,3 +1,4 @@
+
 require "filter_query.rb"
 require "facet_field.rb"
 module SolrLite
@@ -158,21 +159,27 @@ module SolrLite
       if @q != ""
         qs += "&q=#{@q}"
       end
+
+      # Filter query
       @fq.each do |filter|
         qs += "&fq=#{filter.solr_value}"
       end
+
       extra_fqs.each do |filter|
         qs += "&fq=#{filter.solr_value}"
       end
+
       qs += "&rows=#{@page_size}"
       qs += "&start=#{start_row()}"
       if sort != ""
         qs += "&sort=#{CGI.escape(@sort)}"
       end
+
       if @spellcheck
         qs += "&spellcheck=on"
       end
-      # hit highlighting parameters
+
+      # Hit highlighting parameters
       if @hl
         qs += "&hl=true"
         if @hl_fl != nil
@@ -182,16 +189,31 @@ module SolrLite
           qs += "&hl.snippets=#{@hl_snippets}"
         end
       end
+
+      # Facets
       if @facets.count > 0
         qs += "&facet=on"
+
+        facet_ranges = @facets.select {|f| f.range == true }.map { |f| f.name }
+        facet_ranges.each do |field_name|
+          qs += "&facet.range=#{field_name}"
+        end
+
         @facets.each do |f|
           qs += "&facet.field=#{f.name}"
           qs += "&f.#{f.name}.facet.mincount=1"
           if @facet_limit != nil
             qs += "&f.#{f.name}.facet.limit=#{@facet_limit}"
           end
+
+          if f.range
+            qs += "&f.#{f.name}.facet.range.start=#{f.range_start}"
+            qs += "&f.#{f.name}.facet.range.end=#{f.range_end}"
+            qs += "&f.#{f.name}.facet.range.gap=#{f.range_gap}"
+          end
         end
       end
+
       qs
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_lite
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Hector Correa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies: []
 description: A lightweight gem to connect to Solr and run queries. Requires no extra
   dependencies.