solr_lite 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0738db58daf210f9b9276aae993df65c21c5862e94b3d035d8bc8874c1cd4d1
-  data.tar.gz: '09558a463f427517492b3a675a58e6c96554e559237b04c9b8f631df9e636c48'
+  metadata.gz: e3b829f8f239974df1f4e84eff2803d00210c7ee60561cd353b7a9174ff6dd96
+  data.tar.gz: 35fcb552f2ad0384b4ae9312287791f4fc46850aa130852efe19a5adfdea6a69
 SHA512:
-  metadata.gz: c98fb051ed4d770b78938844f8d47384e9441f5c9a7b4bcbc7a619635e0ca09f6fee2b9a58b4f6db7634dadd1929998669f8a516f976eb66738472b18a4ba5fa
-  data.tar.gz: dc8938e34ba18b27ec7a3747124f2c52369a7ee4045029480f53c4efd5963b8f2e0cccfc1215723c8cdb01f9b3efd39c64a068d2a27ce2858fde63100e6262c0
+  metadata.gz: 4eacb399b8c0afadf285d706b736612684a82d06acae08929688d87cbf95c5035cc3dfc7bcab3fe9157960f68e5ee7477b4f57c3fa3324cdc212a805342ba5e2
+  data.tar.gz: 61a6fba302260f1d992346196e5cf0ea9f5651dd890f2ec4583cbdbbbdbf2daff30df7f14931824a9e1ed5cd80499a56631bf4576570771a2f036d5e5d9f202c

data/lib/response.rb

@@ -15,7 +15,8 @@ module SolrLite
       set_facet_values()
 
       # This value can be set by the client if we want to use a custom
-      # representation of solr_docs
+      # representation of solr_docs while preserving the entire Response
+      # object.
       @items = []
     end
 
@@ -39,7 +40,33 @@ module SolrLite
     # Total number documents found in solr
     # usually larger than solr_docs.count
     def num_found
-      @solr_response["response"]["numFound"]
+
+      if @solr_response["response"] != nil
+        # Normal Solr query
+        return @solr_response["response"]["numFound"]
+      end
+
+      if @solr_response["grouped"] != nil
+        # Grouped Solr query.
+        total = 0
+        @solr_response["grouped"].keys.each do |key|
+          total += @solr_response["grouped"][key]["matches"]
+        end
+        return total
+      end
+
+      return 0
+    rescue
+      0
+    end
+
+    # Total number documents found in Solr
+    # for a given group field/value/
+    def num_found_for_group(group_field, group_value)
+      group = @solr_response["grouped"][group_field]["groups"]
+      docs_for_value = group.find {|x| x["groupValue"] == group_value }
+      return 0 if docs_for_value == nil
+      docs_for_value["doclist"]["numFound"]
     rescue
       0
     end
@@ -59,7 +86,16 @@ module SolrLite
 
     # Start position for retrieval (used for pagination)
     def start
-      @solr_response["response"]["start"].to_i
+      if @solr_response["response"] != nil
+        @solr_response["response"]["start"].to_i
+      else
+        # For grouped responses
+        # (I believe we could use this value for grouped and not-grouped
+        # responses, but for backwards compatibility and since I have not
+        # tested it for non-grouped responses, for now we only use it for
+        # grouped responses.)
+        @solr_response["responseHeader"]["params"]["start"].to_i
+      end
     rescue
       0
     end
@@ -78,6 +114,21 @@ module SolrLite
       @solr_response["response"]["docs"]
     end
 
+    # Groups in the solr_docs (see Solr.search_group())
+    def solr_groups(group_field)
+      return [] if @solr_response["grouped"] == nil
+      @solr_response["grouped"][group_field]["groups"].map {|x| x["groupValue"]}
+    end
+
+    # Documents for a given group field and value (see Solr.search_group())
+    def solr_docs_for_group(group_field, group_value)
+      group = @solr_response["grouped"][group_field]["groups"]
+      docs_for_value = group.find {|x| x["groupValue"] == group_value }
+      return [] if docs_for_value == nil
+      docs = docs_for_value["doclist"]["docs"]
+      docs
+    end
+
     def facets
       @params.facets
     end

data/lib/solr.rb

@@ -71,34 +71,13 @@ module SolrLite
     # @return [SolrLite::Response] The result of the search.
     #
     def search(params, extra_fqs = [], qf = nil, mm = nil, debug = false)
-      if params.fl != nil
-        query_string = "fl=#{params.fl.join(",")}"
-      else
-        query_string = "" # use Solr defaults
-      end
-
-      query_string += "&wt=json&indent=on"
-      query_string += "&" + params.to_solr_query_string(extra_fqs)
-      query_string += "&q.op=AND"
-
-      if qf != nil
-        query_string += "&qf=#{CGI.escape(qf)}"
-      end
-
-      if mm != nil
-        query_string += "&mm=#{CGI.escape(mm)}"
-      end
-
-      if debug
-        query_string += "&debugQuery=true"
-      end
-
-      if @def_type != nil
-        query_string += "&defType=#{@def_type}"
-      end
+      http_response = search_core(params, extra_fqs, qf, mm, debug, nil, 0)
+      response = Response.new(http_response, params)
+      response
+    end
 
-      url = "#{@solr_url}/select?#{query_string}"
-      http_response = http_get(url)
+    def search_group(params, extra_fqs = [], qf = nil, mm = nil, debug = false, group_field, group_limit)
+      http_response = search_core(params, extra_fqs, qf, mm, debug, group_field, group_limit)
       response = Response.new(http_response, params)
       response
     end
@@ -176,6 +155,43 @@ module SolrLite
     end
 
     private
+      def search_core(params, extra_fqs, qf, mm, debug, group_field, group_limit)
+        if params.fl != nil
+          query_string = "fl=#{params.fl.join(",")}"
+        else
+          query_string = "" # use Solr defaults
+        end
+
+        query_string += "&wt=json&indent=on"
+        query_string += "&" + params.to_solr_query_string(extra_fqs)
+        query_string += "&q.op=AND"
+
+        if qf != nil
+          query_string += "&qf=#{CGI.escape(qf)}"
+        end
+
+        if mm != nil
+          query_string += "&mm=#{CGI.escape(mm)}"
+        end
+
+        if debug
+          query_string += "&debugQuery=true"
+        end
+
+        if group_field != nil
+          # See https://lucene.apache.org/solr/guide/7_0/result-grouping.html
+          #     and https://wiki.apache.org/solr/FieldCollapsing
+          query_string += "&group=true&group.field=#{group_field}&group.limit=#{group_limit}"
+        end
+
+        if @def_type != nil
+          query_string += "&defType=#{@def_type}"
+        end
+
+        url = "#{@solr_url}/select?#{query_string}"
+        http_response = http_get(url)
+      end
+
       def http_post_json(url, payload)
         content_type = "application/json"
         http_response = http_post(url, payload, content_type)

metadata

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