algoliasearch-jekyll 0.2.3 → 0.3.0

data/spec/push_spec.rb

@@ -10,26 +10,23 @@ describe(AlgoliaSearchJekyllPush) do
   let(:static_file) { site.file_by_name('ring.png') }
   let(:document_file) { site.file_by_name('collection-item.md') }
   let(:html_document_file) { site.file_by_name('collection-item.html') }
-  let(:options) do
-    {
-      'drafts' => true
-    }
-  end
-  let(:config) do
-    {
-      'source' => File.expand_path('./spec/fixtures'),
-      'markdown_ext' => 'md,mkd',
-      'algolia' => {
-        'application_id' => 'APPID',
-        'index_name' => 'INDEXNAME'
-      }
-    }
+  let(:pagination_page) { site.file_by_name('page2/index.html') }
+  let(:items) do
+    [{
+      name: 'foo',
+      url: '/foo'
+    }, {
+      name: 'bar',
+      url: '/bar'
+    }]
   end
 
   describe 'init_options' do
     it 'sets options and config' do
       # Given
       args = nil
+      options = { 'foo' => 'bar' }
+      config = { 'bar' => 'foo' }
 
       # When
       push.init_options(args, options, config)
@@ -38,24 +35,9 @@ describe(AlgoliaSearchJekyllPush) do
       expect(push.options).to include(options)
       expect(push.config).to include(config)
     end
-
-    it 'sets indexname from the commandline' do
-      # Given
-      args = ['newindex']
-
-      # When
-      push.init_options(args, options, config)
-
-      # Then
-      expect(push.config['algolia']['index_name']).to eq 'newindex'
-    end
   end
 
   describe 'indexable?' do
-    before(:each) do
-      push.init_options(nil, options, config)
-    end
-
     it 'exclude StaticFiles' do
       expect(push.indexable?(static_file)).to eq false
     end
@@ -77,144 +59,183 @@ describe(AlgoliaSearchJekyllPush) do
     end
 
     it 'exclude file specified in config' do
-      # Given
-      config['algolia']['excluded_files'] = [
-        'excluded.html'
-      ]
-      push.init_options(nil, options, config)
-
-      # Then
       expect(push.indexable?(excluded_page_file)).to eq false
     end
+
+    it 'does not index pagination pages' do
+      expect(push.indexable?(pagination_page)).to eq false
+    end
   end
 
-  describe 'api_key' do
-    it 'returns nil if no key found' do
+  describe 'excluded_files?' do
+    before(:each) do
+      push.init_options(nil, {}, site.config)
+    end
+
+    it 'should alway exclude pagination pages' do
+      expect(push.excluded_file?('page3/index.html')).to eq true
+    end
+
+    it 'should exclude user specified strings' do
+      expect(push.excluded_file?('excluded.html')).to eq true
+    end
+  end
+
+  describe 'configure_index' do
+    it 'sets some sane defaults' do
       # Given
-      push.init_options(nil, options, config)
+      push.init_options(nil, {}, {})
+      index = double
+
+      # Then
+      expected = {
+        attributeForDistinct: 'title',
+        distinct: true,
+        customRanking: ['desc(posted_at)', 'desc(weight)']
+      }
+      expect(index).to receive(:set_settings).with(hash_including(expected))
 
       # When
-      expect(push.api_key).to be_nil
+      push.configure_index(index)
     end
 
-    it 'reads from ENV var if set' do
+    it 'allow user to override all settings' do
       # Given
-      push.init_options(nil, options, config)
-      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
+      settings = {
+        distinct: false,
+        customSetting: 'foo',
+        customRanking: ['asc(foo)', 'desc(bar)']
+      }
+      config = {
+        'algolia' => {
+          'settings' => settings
+        }
+      }
+      push.init_options(nil, {}, config)
+      index = double
+
+      # Then
+      expect(index).to receive(:set_settings).with(hash_including(settings))
 
       # When
-      actual = push.api_key
+      push.configure_index(index)
+    end
+  end
+
+  describe 'jekyll_new' do
+    it 'should return a patched version of site with a custom write' do
+      # Given
+      normal_site = Jekyll::Site.new(Jekyll.configuration)
+      normal_method = normal_site.method(:write).source_location
+
+      patched_site = get_site({}, mock_write_method: false, process: false)
+      patched_method = patched_site.method(:write).source_location
 
+      # When
       # Then
-      expect(actual).to eq 'APIKEY_FROM_ENV'
+      expect(patched_method).not_to eq normal_method
     end
+  end
 
-    it 'reads from _algolia_api_key in source if set' do
+  describe 'process' do
+    it 'should call the site write method' do
       # Given
-      config['source'] = File.join(config['source'], 'api_key_dir')
-      push.init_options(nil, options, config)
+      site = get_site({}, process: false)
 
       # When
-      actual = push.api_key
+      site.process
 
       # Then
-      expect(actual).to eq 'APIKEY_FROM_FILE'
+      expect(site).to have_received(:write)
     end
 
-    it 'reads from ENV before from file' do
+    it 'should push items to Algolia' do
       # Given
-      config['source'] = File.join(config['source'], 'api_key_dir')
-      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
-      push.init_options(nil, options, config)
+      site = get_site({}, mock_write_method: false, process: false)
+      # Keep only page_file
+      allow(AlgoliaSearchJekyllPush).to receive(:indexable?) do |file|
+        file.path == page_file.path
+      end
+      allow(AlgoliaSearchJekyllPush).to receive(:push)
 
       # When
-      actual = push.api_key
+      site.process
 
       # Then
-      expect(actual).to eq 'APIKEY_FROM_ENV'
+      expect(AlgoliaSearchJekyllPush).to have_received(:push) do |arg|
+        expect(arg.size).to eq 6
+      end
     end
   end
 
-  describe 'check_credentials' do
-    it 'should display error if no api key' do
-      # Given
-      config['algolia'] = {
-        'application_id' => 'APP_ID',
-        'index_name' => 'INDEX_NAME'
+  describe 'push' do
+    let(:index_double) { double('Algolia Index').as_null_object }
+    let(:config) do
+      {
+        'algolia' => {
+          'index_name' => 'INDEXNAME'
+        }
       }
-      push.init_options(nil, options, config)
+    end
 
-      # Then
-      expect(Jekyll.logger).to receive(:error).with(/api key/i)
-      expect(Jekyll.logger).to receive(:warn).at_least(:once)
-      expect(-> { push.check_credentials }).to raise_error SystemExit
+    before(:each) do
+      push.init_options(nil, {}, config)
+      # Mock all calls to not send anything
+      allow_any_instance_of(AlgoliaSearchCredentialChecker)
+        .to receive(:assert_valid)
+      allow(Algolia).to receive(:init)
+      allow(Algolia).to receive(:move_index)
+      allow(Algolia::Index).to receive(:new).and_return(index_double)
+      allow(Jekyll.logger).to receive(:info)
     end
 
-    it 'should display error if no application id' do
+    it 'should create a temporary index' do
       # Given
-      config['algolia'] = {
-        'application_id' => nil,
-        'index_name' => 'INDEX_NAME'
-      }
-      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
-      push.init_options(nil, options, config)
+
+      # When
+      push.push(items)
 
       # Then
-      expect(Jekyll.logger).to receive(:error).with(/application id/i)
-      expect(Jekyll.logger).to receive(:warn).at_least(:once)
-      expect(-> { push.check_credentials }).to raise_error SystemExit
+      expect(Algolia::Index).to have_received(:new).with('INDEXNAME_tmp')
     end
 
-    it 'should display error if no index name' do
+    it 'should add elements to the temporary index' do
       # Given
-      config['algolia'] = {
-        'application_id' => 'APPLICATION_ID',
-        'index_name' => nil
-      }
-      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
-      push.init_options(nil, options, config)
+
+      # When
+      push.push(items)
 
       # Then
-      expect(Jekyll.logger).to receive(:error).with(/index name/i)
-      expect(Jekyll.logger).to receive(:warn).at_least(:once)
-      expect(-> { push.check_credentials }).to raise_error SystemExit
+      expect(index_double).to have_received(:add_objects!)
     end
-  end
 
-  describe 'configure_index' do
-    it 'sets some sane defaults' do
+    it 'should move the temporary index as the main one' do
       # Given
-      push.init_options(nil, options, config)
-      index = double
-
-      # Then
-      expected = {
-        attributeForDistinct: 'title',
-        distinct: true,
-        customRanking: ['desc(posted_at)', 'desc(weight)']
-      }
-      expect(index).to receive(:set_settings).with(hash_including(expected))
 
       # When
-      push.configure_index(index)
+      push.push(items)
+
+      # Then
+      expect(Algolia).to have_received(:move_index)
+                         .with('INDEXNAME_tmp', 'INDEXNAME')
     end
 
-    it 'allow user to override all settings' do
+    it 'should display the number of elements indexed' do
       # Given
-      settings = {
-        distinct: false,
-        customSetting: 'foo',
-        customRanking: ['asc(foo)', 'desc(bar)']
-      }
-      config['algolia']['settings'] = settings
-      push.init_options(nil, options, config)
-      index = double
+
+      # When
+      push.push(items)
 
       # Then
-      expect(index).to receive(:set_settings).with(hash_including(settings))
+      expect(Jekyll.logger).to have_received(:info).with(/of 2 items/i)
+    end
 
-      # When
-      push.configure_index(index)
+    it 'should display an error if `add_objects!` failed' do
+      # Given
+      allow(index_double).to receive(:add_objects!).and_raise
+
+      expect(Jekyll.logger).to receive(:error)
+      expect(-> { push.push(items) }).to raise_error SystemExit
     end
   end
 end

data/spec/record_extractor_spec.rb

@@ -36,6 +36,16 @@ describe(AlgoliaSearchRecordExtractor) do
       expect(actual[:custom]).to eq 'Foo'
     end
 
+    it 'gets posted_at timestamp based on the configured timezone' do
+      # Given
+      site = get_site(timezone: 'America/New_York')
+      post_file =  extractor.new(site.file_by_name('test-post.md'))
+      actual = post_file.metadata
+
+      # Then
+      expect(actual[:posted_at]).to eq 1_435_809_600
+    end
+
     it 'gets metadata from document' do
       # Given
       actual = document_file.metadata

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
 require 'awesome_print'
 require_relative './spec_helper_jekyll.rb'
 require_relative './spec_helper_simplecov.rb'
@@ -7,27 +12,32 @@ RSpec.configure do |config|
   config.filter_run(focus: true)
   config.run_all_when_everything_filtered = true
 
-  # Build a jekyll site, creating access to @__files used internally
-  def get_site(config = {})
+  # Create a Jekyll::Site instance, patched with a `file_by_name` method
+  def get_site(config = {}, options = {})
+    default_options = {
+      mock_write_method: true,
+      process: true
+    }
+    options = default_options.merge(options)
+
     config = config.merge(
       source: File.expand_path('./spec/fixtures')
     )
     config = Jekyll.configuration(config)
-    site = Jekyll::Site.new(config)
 
-    # Keep a list of all files
-    def site.write
-      @__files = {}
+    site = AlgoliaSearchJekyllPush.init_options({}, options, config)
+                           .jekyll_new(config)
+
+    def site.file_by_name(file_name)
       each_site_file do |file|
-        @__files[file.path] = file
+        return file if file.path =~ /#{file_name}$/
       end
+      nil
     end
 
-    def site.file_by_name(file_name)
-      @__files.find { |path, _| path =~ /#{file_name}$/ }[1]
-    end
+    allow(site).to receive(:write) if options[:mock_write_method]
 
-    site.process
+    site.process if options[:process]
     site
   end
 end

data/spec/spec_helper_simplecov.rb

@@ -1,7 +1,7 @@
 require 'simplecov'
 
 SimpleCov.configure do
-  load_adapter 'test_frameworks'
+  load_profile 'test_frameworks'
 end
 
 ENV['COVERAGE'] && SimpleCov.start do

data/txt/api_key_missing

@@ -0,0 +1,4 @@
+Algolia Error: No API key defined
+  You have two ways to configure your API key:
+    - The ALGOLIA_API_KEY environment variable
+    - A file named _algolia_api_key in your source folder

data/txt/application_id_missing

@@ -0,0 +1,8 @@
+Algolia Error: No application ID defined
+  Please set your application id in the _config.yml file, like so:
+
+  algolia:         
+    application_id: {your_application_id}
+
+  Your application ID can be found in your algolia dashboard:
+    https://www.algolia.com/licensing

data/txt/index_name_missing

@@ -0,0 +1,9 @@
+Algolia Error: No index name defined
+  Please set your index name in the _config.yml file, like so:
+
+  algolia:         
+    index_name: {your_index_name}
+
+  You can edit your indices in your dashboard:
+    https://www.algolia.com/explorer
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -159,37 +201,59 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- ".coveralls.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
+- algoliasearch-jekyll.gemspec
 - lib/algoliasearch-jekyll.rb
+- lib/credential_checker.rb
 - lib/push.rb
 - lib/record_extractor.rb
+- scripts/check_flay
+- scripts/check_flog
 - scripts/git_hooks/pre-commit
 - scripts/git_hooks/pre-push
-- scripts/run_tests
-- scripts/update_gem
+- spec/credential_checker_spec.rb
 - spec/fixtures/_config.yml
+- spec/fixtures/_layouts/default.html
 - spec/fixtures/_my-collection/collection-item.html
 - spec/fixtures/_my-collection/collection-item.md
 - spec/fixtures/_posts/2015-07-02-test-post.md
+- spec/fixtures/_posts/2015-07-03-test-post-again.md
+- spec/fixtures/_site/2015/07/02/test-post.html
+- spec/fixtures/_site/2015/07/03/test-post-again.html
+- spec/fixtures/_site/about.html
+- spec/fixtures/_site/assets/ring.png
+- spec/fixtures/_site/authors.html
+- spec/fixtures/_site/excluded.html
+- spec/fixtures/_site/hierarchy.html
+- spec/fixtures/_site/index.html
+- spec/fixtures/_site/my-collection/collection-item.html
+- spec/fixtures/_site/page2/index.html
+- spec/fixtures/_site/weight.html
 - spec/fixtures/about.md
 - spec/fixtures/api_key_dir/_algolia_api_key
 - spec/fixtures/assets/ring.png
 - spec/fixtures/authors.html
 - spec/fixtures/excluded.html
 - spec/fixtures/hierarchy.md
+- spec/fixtures/index.html
 - spec/fixtures/weight.md
 - spec/push_spec.rb
 - spec/record_extractor_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_jekyll.rb
 - spec/spec_helper_simplecov.rb
+- txt/api_key_missing
+- txt/application_id_missing
+- txt/index_name_missing
 homepage: https://github.com/algolia/algoliasearch-jekyll
 licenses:
 - MIT
@@ -210,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch for Jekyll