slate_algolia 0.0.1 → 1.0.0

data/spec/index_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe Middleman::SlateAlgolia::Index do
+  before :each do
+    stub_request(:any, %r{.*\.algolia(net\.com|\.net)\/*})
+      .to_return(body: '{"hits":[]}')
+  end
+
+  after :each do
+    WebMock.reset!
+  end
+
+  describe 'initialize' do
+    it 'creates an Algolia Index with the specified name' do
+      expect(Algolia::Index).to receive(:new).with('test')
+
+      Middleman::SlateAlgolia::Index.new(
+        application_id: '',
+        api_key: '',
+        name: 'test'
+      )
+    end
+
+    it 'uses the defined API keys for the Algolia Index' do
+      expect(Algolia).to receive(:init).with(application_id: 'id', api_key: 'key').and_call_original
+
+      Middleman::SlateAlgolia::Index.new(
+        application_id: 'id',
+        api_key: 'key',
+        name: ''
+      )
+    end
+  end
+
+  describe 'flush_queue' do
+    it 'calls before_index for each record' do
+      dbl = double
+      index = Middleman::SlateAlgolia::Index.new(
+        application_id: '',
+        api_key: '',
+        dry_run: false,
+        before_index: proc do |record|
+          # Verify is not a real method. Just a fake thing on a double
+          dbl.verify(record)
+        end
+      )
+
+      index.queue_object(objectID: 1)
+      index.queue_object(objectID: 2)
+
+      expect(dbl).to receive(:verify).with(objectID: 1)
+      expect(dbl).to receive(:verify).with(objectID: 2)
+
+      index.flush_queue
+    end
+
+    it 'replaces records via the before_index hook' do
+      index = Middleman::SlateAlgolia::Index.new(
+        application_id: '',
+        api_key: '',
+        dry_run: false,
+        before_index: proc do |record|
+          { objectID: record[:objectID] * 2 }
+        end
+      )
+
+      index.queue_object(objectID: 1)
+      index.queue_object(objectID: 2)
+
+      expect(index.instance_variable_get('@index')).to receive(:add_objects)
+        .with(
+          [
+            { objectID: 2 },
+            { objectID: 4 }
+          ]
+        )
+
+      index.flush_queue
+    end
+
+    it 'creates new records if before_index returns an array' do
+      index = Middleman::SlateAlgolia::Index.new(
+        application_id: '',
+        api_key: '',
+        dry_run: false,
+        before_index: proc do |record|
+          [record, { objectID: record[:objectID] * 4 }]
+        end
+      )
+
+      index.queue_object(objectID: 1)
+      index.queue_object(objectID: 2)
+
+      expect(index.instance_variable_get('@index')).to receive(:add_objects)
+        .with(
+          [
+            { objectID: 1 },
+            { objectID: 4 },
+            { objectID: 2 },
+            { objectID: 8 }
+          ]
+        )
+
+      index.flush_queue
+    end
+
+    it 'reuses the existing record if the before_index hook has no return' do
+      index = Middleman::SlateAlgolia::Index.new(
+        application_id: '',
+        api_key: '',
+        dry_run: false,
+        before_index: proc do |record|
+          # Wassup!
+        end
+      )
+
+      index.queue_object(objectID: 1)
+      index.queue_object(objectID: 2)
+
+      expect(index.instance_variable_get('@index')).to receive(:add_objects)
+        .with(
+          [
+            { objectID: 1 },
+            { objectID: 2 }
+          ]
+        )
+
+      index.flush_queue
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'middleman'
+require 'slate_algolia'
+require 'webmock/rspec'
+
+require_relative 'support/given'
+require_relative 'support/fixture'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/fixture.rb

@@ -0,0 +1,17 @@
+module Middleman
+  module Fixture
+    class << self
+      def app(&block)
+        ENV['MM_ROOT'] = Given::TMP
+
+        if Middleman::Application.respond_to?(:server)
+          app = Middleman::Application.server.inst do
+            instance_eval(&block) if block
+          end
+        end
+
+        app
+      end
+    end
+  end
+end

data/spec/support/given.rb

@@ -0,0 +1,26 @@
+module Given
+  ROOT = File.expand_path('../..', __dir__)
+  TMP  = File.join(ROOT, 'tmp')
+
+  class << self
+    def fixture(fixture)
+      cleanup!
+
+      `rsync -av ./spec/fixtures/#{fixture}/ #{TMP}/`
+      Dir.chdir(TMP)
+    end
+
+    def file(name, content)
+      file_path = File.join(TMP, name)
+      FileUtils.mkdir_p(File.dirname(file_path))
+      File.open(file_path, 'w') do |file|
+        file.write(content)
+      end
+    end
+
+    def cleanup!
+      Dir.chdir(ROOT)
+      `rm -rf #{TMP}`
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slate_algolia
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Joe Wegner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -77,19 +77,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
+- ".rubocop.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- features/support/env.rb
 - lib/middleman_extension.rb
 - lib/slate_algolia.rb
 - lib/slate_algolia/extension.rb
 - lib/slate_algolia/index.rb
 - lib/slate_algolia/parser.rb
 - slate_algolia.gemspec
+- spec/extension_spec.rb
+- spec/fixtures/base/build/index.html
+- spec/fixtures/base/config.rb
+- spec/fixtures/base/source/includes/_errors.md
+- spec/fixtures/base/source/index.html.md
+- spec/fixtures/base/source/layouts/layout.html.erb
+- spec/index_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture.rb
+- spec/support/given.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -114,4 +125,13 @@ signing_key:
 specification_version: 4
 summary: Quickly and easily index Slate Docs in Algolia
 test_files:
-- features/support/env.rb
+- spec/extension_spec.rb
+- spec/fixtures/base/build/index.html
+- spec/fixtures/base/config.rb
+- spec/fixtures/base/source/includes/_errors.md
+- spec/fixtures/base/source/index.html.md
+- spec/fixtures/base/source/layouts/layout.html.erb
+- spec/index_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture.rb
+- spec/support/given.rb

data/features/support/env.rb

@@ -1,4 +0,0 @@
-PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
-require 'middleman-core'
-require 'middleman-core/step_definitions'
-require File.join(PROJECT_ROOT_PATH, 'lib', 'slate_algolia')