slate_algolia 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7501fd269fa65aa278b4e78674e7fcb2236ac63
-  data.tar.gz: b181aa3c1968582c0a5b817cd5ee9c99bb042b57
+  metadata.gz: 9e693364fa66ed8b1e5e8caa61a3c79e57f59074
+  data.tar.gz: d2890cdd992f6431d2181d9086a4a334f4b637b8
 SHA512:
-  metadata.gz: d05ec3b8c68eec7f1ec8bf1c1fb22665374bbcafaa364feaa93fd9a2e5da07af5dd304a936faf92317bad3c1f1e393b934c6880811138a8dde3b0ef99d48b20f
-  data.tar.gz: b79afe1e0dbf732f73fdb56c307317170b3bb3c00619ae2acaddc2bc3ab0cf714d930346d3474086199c9931be21c655a29e95bd259930ebab983dea92565e43
+  metadata.gz: be41497f30abeb8a40633d7f7b8071e2345efad566e58a15b4a92aade85c403a32b4c57de76ea3b41699af3da365ac3744aedee03b317c5a4d70506dd07c3244
+  data.tar.gz: ddd4a293de3822fc42399e4a93c1314efbb00e62f28e967afaddc8d8dbd789a265c33066c4790555eeee3c7b22c03f0237020068780f4ee2686f6ee9a5eb04eb

data/README.md

@@ -87,6 +87,22 @@ activate :slate_algolia do |options|
 end
 ```
 
+## Filtering Deletes
+
+`slate_algolia` has automatic cleanup built in - meaning that after indexing new content, it will look through Algolia for any content that exists there but **does not** exist in the current content. It will remove those items, assuming they have been removed from the active content. However, you may not want to delete all of your unmatched records - perhaps they serve as a good synonym, or perhaps you index more than just slate docs in that Algolia index. There is a hook option you can use the filter out records from being deleted.
+
+```ruby
+activate :slate_algolia do |options|
+  options.filter_deletes = proc { |record|
+    if record['category'] == 'API Docs'
+      true # Truthy values will be deleted
+    else
+      false # Non-Truthy values will be ignored
+    end
+  }
+end
+```
+
 
 ## Custom Tag Parser
 

data/lib/slate_algolia/extension.rb

@@ -12,6 +12,7 @@ module Middleman
       option :index_name, 'API Docs', 'Name for the Algolia Index'
       option :api_key, '', 'Algolia API Key'
       option :before_index, nil, 'A block to run on each record before it is sent to the index'
+      option :filter_deletes, nil, 'A block to run on each record before it is deleted from the index'
 
       def initialize(app, options_hash = {}, &block)
         super
@@ -30,7 +31,8 @@ module Middleman
           api_key: options.api_key,
           name: options.index_name,
           dry_run: options.dry_run,
-          before_index: options.before_index
+          before_index: options.before_index,
+          filter_deletes: options.filter_deletes
         )
       end
 

data/lib/slate_algolia/index.rb

@@ -24,7 +24,11 @@ module Middleman
 
       def clean_index
         old_content = @index.browse['hits'].reject do |hit|
-          @published.any? { |entry| entry[:id] == hit['id'] }
+          @published.any? { |entry| entry[:id] == hit['objectID'] }
+        end
+
+        if @options[:filter_deletes].instance_of?(Proc)
+          old_content = run_filter_delete(old_content)
         end
 
         if @publish
@@ -49,6 +53,10 @@ module Middleman
         @queue.flatten!
       end
 
+      def run_filter_delete(all_records)
+        return all_records.select(&@options[:filter_deletes])
+      end
+
       def flush_queue
         run_before_index
 

data/slate_algolia.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'slate_algolia'
-  s.version     = '1.0.0'
+  s.version     = '1.1.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Joe Wegner']
   s.email       = ['joe@wegnerdesign.com']
@@ -16,5 +16,5 @@ Gem::Specification.new do |s|
   # The version of middleman-core your extension depends on
   s.add_runtime_dependency('middleman-core', ['~> 3.3', '>= 3.3.12'])
   s.add_runtime_dependency('oga', ['~> 1.3', '>= 1.3.1'])
-  s.add_runtime_dependency('algoliasearch', ['~> 1.6', '>= 1.6.1'])
+  s.add_runtime_dependency('algoliasearch', ['~> 1.12', '>= 1.12.5'])
 end

data/spec/extension_spec.rb

@@ -7,7 +7,8 @@ describe Middleman::SlateAlgolia::Extension do
     :dry_run,
     :index_name,
     :parsers,
-    :before_index
+    :before_index,
+    :filter_deletes
   )
 
   default_options = ConfigOptions.new('', '', false, 'API Docs', {}, nil)

data/spec/index_spec.rb

@@ -128,4 +128,36 @@ describe Middleman::SlateAlgolia::Index do
       index.flush_queue
     end
   end
+
+  describe 'clean_index' do
+    it 'selects records using the :filter_deletes hook' do
+      index = Middleman::SlateAlgolia::Index.new(
+        application_id: '',
+        api_key: '',
+        dry_run: false,
+        filter_deletes: proc do |record|
+          record['objectID'] == "1"
+        end
+      )
+
+      instance_index = index.instance_variable_get('@index')
+
+      expect(instance_index).to receive(:delete_objects)
+        .with(['1'])
+      allow(instance_index).to receive(:browse) {
+        {
+          'hits' => [
+            {
+              'objectID' => '1'
+            },
+            {
+              'objectID' => '2'
+            }
+          ]
+        }
+      }
+        
+      index.clean_index
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slate_algolia
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Joe Wegner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -56,20 +56,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.12.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.12.5
 description: 
 email:
 - joe@wegnerdesign.com