typesensual 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea8c4aeb857be069ae139f07adf94182acb7cf65e4fc3d21efdaca0522227a8
-  data.tar.gz: de66e132cc8b81b58201fc517847e4b5c0bf3644abb1c79eafa56bc696fbb7ce
+  metadata.gz: 16c9d2bb0a45de749680a833abf874d3f42da4190ea66b88e5d1f19a8f2d902c
+  data.tar.gz: d4f9dc200a97e182929b8cdc6fbb48edc1da69e6444137e2f7f670197742fa2a
 SHA512:
-  metadata.gz: a29f224543a07478a3fc61e23edd3c9d3bb52995740c266f43400dd33dcf96b7e6d0a9ee54f59e7d6500c1ce3a33be1d0cd4ef590e5f716a6ade44bc22eb6c66
-  data.tar.gz: e05a23f4d02ecc1242ba7b2ffdae7aca2a2f8c537a838186532e18b87a97b22c76385fe05a7b6c917d291f02461487abb378ab2f649c99cf0cd2c7587d0f6f7c
+  metadata.gz: 7d3130f6ac4d1b5d2722c4a6020fab73dc6ce1b91b7095e0f91de2d50723a60c5edb5434f651f874182c868a22e4015b12aa0eed097270562bc2bd291640a2af
+  data.tar.gz: c1fc489fab6f2c1fc29f57a0662883115b37b1790a02eab0db6193be53fbf4174de8e464b937f42b54ee2c3098d57abc8dc529f5d081728cb63861c75b302242

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typesensual (0.2.0)
+    typesensual (0.3.0)
       activesupport (>= 6.1.5)
       paint (>= 2.0.0)
       typesense (>= 0.13.0)
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.6)
+    activesupport (7.0.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -26,7 +26,7 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     minitest (5.19.0)
-    oj (3.15.1)
+    oj (3.16.0)
     paint (2.3.0)
     parallel (1.23.0)
     parser (3.2.2.1)
@@ -79,7 +79,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    typesense (0.14.1)
+    typesense (0.15.0)
       oj (~> 3.11)
       typhoeus (~> 1.4)
     typhoeus (1.4.0)

data/lib/tasks/typesensual.rake

@@ -5,7 +5,7 @@ require 'typesensual/rake_helper'
 namespace :typesensual do
   desc 'List typesensual indices and their collections'
   task list: :environment do
-    Typesensual::RakeHelper.list_collections
+    Typesensual::RakeHelper.list
   end
 
   desc 'Update the alias for an index'

data/lib/typesensual/collection.rb

@@ -181,9 +181,22 @@ class Typesensual
       typesense_collection.documents[id.to_s].delete
     end
 
+    # Remove multiple documents from typesense based on a filter
+    #
+    # @param filter_by [String] the filter to use to remove documents
+    # @return [void]
+    def remove_many!(filter_by:)
+      typesense_collection.documents.delete(filter_by: filter_by)
+    end
+
+    # Search for documents in typesense
+    #
+    # @param query [String] the query to search for
+    # @param query_by [String] the fields to search by
+    # @return [Search] the search object
     def search(query:, query_by:)
       Search.new(
-        collection: typesense_collection,
+        collection: self,
         query: query,
         query_by: query_by
       )

data/lib/typesensual/index.rb

@@ -21,6 +21,10 @@ class Typesensual
   class Index
     include StateHelpers
 
+    class << self
+      delegate :search, to: :collection
+    end
+
     def self.inherited(subclass)
       super
       # Copy the schema from the parent class to the subclass

data/lib/typesensual/search/grouped_hit.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Typesensual
+  class Search
+    class GroupedHit
+      # {
+      #   "group_key": [
+      #     "420",
+      #     "69"
+      #   ],
+      #   "hits": {
+      #     ...
+      #   },
+      #   "found": 3
+      # }
+      # @param group [Hash] the Typesense hit hash
+      #   * `group_key` [Array<any>] the grouping keys
+      #   * `hits` [Hash] the Hits for the group
+      #   * `found` [Integer] the number of hits in the group
+      def initialize(group)
+        @group = group
+      end
+
+      def count
+        @group['found']
+      end
+
+      def hits
+        @group['hits'].map { |hit| Hit.new(hit) }
+      end
+
+      def group_key
+        @group['group_key']
+      end
+    end
+  end
+end

data/lib/typesensual/search/hit.rb

@@ -19,7 +19,7 @@ class Typesensual
       #   },
       #   "text_match": 130916
       # }
-      # @param collection [Hash] the Typesense hit hash
+      # @param hit [Hash] the Typesense hit hash
       #   * `highlights` [Array<Hash>] the highlights for the hit
       #   * `document` [Hash] the matching document
       #   * `text_match` [Integer] the text matching score

data/lib/typesensual/search/results.rb

@@ -11,6 +11,10 @@ class Typesensual
         @results['hits'].map { |hit| Hit.new(hit) }
       end
 
+      def grouped_hits
+        @results['grouped_hits'].map { |hit| GroupedHit.new(hit) }
+      end
+
       def count
         @results['found']
       end

data/lib/typesensual/search.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'typesensual/search/hit'
+require 'typesensual/search/grouped_hit'
 require 'typesensual/search/results'
 
 class Typesensual
@@ -22,6 +23,7 @@ class Typesensual
       @facet_query = []
       @include_fields = []
       @exclude_fields = []
+      @group_by = []
       @params = {}
 
       @collection = collection
@@ -108,6 +110,11 @@ class Typesensual
       self
     end
 
+    def group_by(*fields)
+      @group_by += fields.map(&:to_s)
+      self
+    end
+
     # Set additional parameters to pass to the search
     # @param values [Hash] the parameters to set
     def set(values)
@@ -128,7 +135,8 @@ class Typesensual
         facet_by: @facet_by&.join(','),
         facet_query: @facet_query&.join(','),
         include_fields: @include_fields&.join(','),
-        exclude_fields: @exclude_fields&.join(',')
+        exclude_fields: @exclude_fields&.join(','),
+        group_by: @group_by&.join(',')
       }.merge(@params).reject { |_, v| v.blank? }
     end
 

data/lib/typesensual/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Typesensual
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesensual
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Emma Lejeck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-06 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,7 @@ files:
 - lib/typesensual/rake_helper.rb
 - lib/typesensual/schema.rb
 - lib/typesensual/search.rb
+- lib/typesensual/search/grouped_hit.rb
 - lib/typesensual/search/hit.rb
 - lib/typesensual/search/results.rb
 - lib/typesensual/state_helpers.rb