solr_lite 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c666a78bdf04147350b03ee3f430fdafe36cabfc5d5869538dbbf1e7a963d9
-  data.tar.gz: cee4e1f082d4a9cbae8ee9e6fb136efd4a20562648a324d62cc7d040d38b672b
+  metadata.gz: c12cae699f561e5b32fd44b2969b7ab8756b5bf49b25f0a97c0ec3b67dc574ee
+  data.tar.gz: a642e417596a331ad88c7f5a9fcd436fe63167eabe415535ef0e36967901474e
 SHA512:
-  metadata.gz: 23b83c4f7e1f495631f9f01f4f939828a0dbfe78f06397fd2873e99fa2e7b722bf960c7412da0a89be914976b9eaed4a51cf6c9133e66dc674414a6e29d2b7c2
-  data.tar.gz: 62cbe1329b68a5529c1e0b6c916261d1da9a56fcc9a44981a748a0a1dc34fc44db1713b2e2a50f5601631418fc64698844c508c85d5e91f7e3d3f0f1a5510602
+  metadata.gz: 57ba843c385af774dfa08294e1befb38ef0015ef716059b91448343627d55be0a99767208e644bf8786fa6db225fd1906eaf9bbe43b277e0cb31b9261e247f07
+  data.tar.gz: 9f0e1d4aa2bf17df4ba54df5e6440d1e93ad7fb4043c9a40a7457e7f971166fab62a053eee7ebd15c65f0ba90d2690e67f77748712ce7b2b0b214c034c33c618

data/lib/response.rb

@@ -60,6 +60,17 @@ module SolrLite
       0
     end
 
+    # Total number of groups found in Solr
+    # for a grouped request.
+    def groups_found
+      if @solr_response["grouped"] != nil && @params.group_count != nil
+        return @solr_response["facets"][@params.group_count]
+      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)

data/lib/search_params.rb

@@ -33,15 +33,19 @@ module SolrLite
     # [Bool] True to request Solr to use spellchecking (defaults to false).
     attr_accessor :spellcheck
 
-    #  [Bool] Set to true to request hit highlighting information from Solr.
+    # [Bool] Set to true to request hit highlighting information from Solr.
     attr_accessor :hl
 
-    #  [String] Sets the highlight fields (hl.fl) to request from Solr.
+    # [String] Sets the highlight fields (hl.fl) to request from Solr.
     attr_accessor :hl_fl
 
-    #  [Integer] Sets the number of hit highlights to request from Solr.
+    # [Integer] Sets the number of hit highlights to request from Solr.
     attr_accessor :hl_snippets
 
+    # [String] The name of the value in the response to hold the number of groups found
+    # in a grouped request. Defaults to "group_count", set to nil to omit.
+    attr_accessor :group_count
+
     DEFAULT_PAGE_SIZE = 20
 
     # Creates an instance of the SearchParams class.
@@ -64,6 +68,7 @@ module SolrLite
       @hl = false
       @hl_fl = nil
       @hl_snippets = 1
+      @group_count = "group_count"
     end
 
     # Returns facet information about a given field.

data/lib/solr.rb

@@ -182,6 +182,16 @@ module SolrLite
           # 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}"
+
+          if params.group_count != nil
+            # Adds an extra calculated facet to get the total number of groups. This is required
+            # because Solr does not return this value in the response, instead Solr
+            # returns the total number of documents found across all groups, but not
+            # the total number of groups found.
+            # See https://lucene.apache.org/solr/guide/7_7/json-facet-api.html#metrics-example
+            #     and https://stackoverflow.com/a/56138991/446681
+            query_string += '&json.facet={"' + params.group_count + '":"unique(' + group_field + ')"}'
+          end
         end
 
         if @def_type != nil

metadata

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