algoliasearch-jekyll 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c1ea0f7d0eecf20f9cb33f30116df426637a9f4
-  data.tar.gz: 8ec5644ebbd8c08fcead43c3c6cf64c0bbe82db6
+  metadata.gz: 2ebfd20e06b278a2b943b37c75d7b3075779f48d
+  data.tar.gz: 2272b59b28c71753e7b7e15ade27807fcb8feaf4
 SHA512:
-  metadata.gz: 0dd5939456e660845ec71719c47ea296088284907b8d58b3d7ac08e5b070ac6dc688edcd18030e0bb87efe2b62a655c71ffb393f81e674936235cf16a9a46ccb
-  data.tar.gz: d19157c6ba465da2dea75f62e4744d3b55fb170043c7aedd0098f7b37bba2d53bb00b4fc2ade9458a1c716340e103768a16381a44052245400089787a3781853
+  metadata.gz: 324e688e2753917e29d652832162e7feca773f2461681cc7cdcd008a36e735321c5d641448ecd7e497af4e551be66ec032446a2fc9340aa4bde71cfb4936499d
+  data.tar.gz: 90fcc05cc357873eb8b49ba3c8d35c5e2e00aaf796e762726c9b66f9e27e6aae3dd9caa8d42f6b42f5bd3c81ce497716e20a4b0e6f2c41a0063162efc119799d

data/README.md

@@ -12,7 +12,7 @@ Algolia index by simply running `jekyll algolia push`.
 ## Usage
 
 ```shell
-$ jekyll algolia push
+$ bundle exec jekyll algolia push
 ```
 
 This will push the content of your jekyll website to your Algolia index.
@@ -32,7 +32,7 @@ source 'https://rubygems.org'
 gem 'jekyll', '~> 2.5.3'
 
 group :jekyll_plugins do
-  gem 'algoliasearch-jekyll', '~> 0.5.3'
+  gem 'algoliasearch-jekyll', '~> 0.7.0'
 end
 ```
 
@@ -60,6 +60,10 @@ algolia:
   index_name:     'your_index_name'
 ```
 
+You can also define the `ALGOLIA_APPLICATION_ID` and `ALGOLIA_INDEX_NAME`
+environment variables. If present, they will be used instead of the options in
+`_config.yml`.
+
 You write api key will be read from the `ALGOLIA_API_KEY` environment variable.
 You can define it on the same line as your command, allowing you to type
 `ALGOLIA_API_KEY='your_write_api_key' jekyll algolia push`.
@@ -149,11 +153,17 @@ The `AlgoliaSearchRecordExtractor` contains two methods (`custom_hook_each` and
 `custom_hook_all`) that are here so you can overwrite them to add your custom
 logic. They currently simply return the argument they take as input.
 
+The best way to override them is to create a `./_plugins/search.rb` file, with
+the following content:
+
 ```ruby
 class AlgoliaSearchRecordExtractor
   # Hook to modify a record after extracting
-  # `node` refers to the Nokogiri HTML node of the element
   def custom_hook_each(item, node)
+    # `node` is a Nokogiri HTML node, so you can access its type through `node.name`
+    # or its classname through `node.attr('class')` for example
+
+    # Just return `nil` instead of `item` if you want to discard this record
     item
   end
 
@@ -210,8 +220,8 @@ version of the popular [Hyde theme][8].
 ## GitHub Pages
 
 GitHub does not allow custom plugins to be run on GitHub Pages. This means that
-you'll either have to run `jekyll algolia push` manually, or configure TravisCI
-to do it for you.
+you'll either have to run `bundle exec jekyll algolia push` manually, or
+configure TravisCI to do it for you.
 
 [Travis CI][9] is an hosted continuous integration
 service, and it's free for open-source projects. Properly configured, it can

data/algoliasearch-jekyll.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: algoliasearch-jekyll 0.7.0 ruby lib
+# stub: algoliasearch-jekyll 0.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-jekyll"
-  s.version = "0.7.0"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Tim Carry"]
-  s.date = "2016-03-08"
+  s.date = "2016-07-13"
   s.description = "Index all your pages and posts to an Algolia index with `jekyll algolia push`"
   s.email = "tim@pixelastic.com"
   s.extra_rdoc_files = [

data/lib/credential_checker.rb

@@ -26,6 +26,29 @@ class AlgoliaSearchCredentialChecker
     nil
   end
 
+  # Read key either from ENV or _config.yml
+  def get_key(env_name, config_key)
+    # First read in ENV
+    return ENV[env_name] if ENV[env_name]
+
+    # Otherwise read from _config.yml
+    if @config['algolia'] && @config['algolia'][config_key]
+      return @config['algolia'][config_key]
+    end
+
+    nil
+  end
+
+  # Read the application id either from the config file or from ENV
+  def application_id
+    get_key('ALGOLIA_APPLICATION_ID', 'application_id')
+  end
+
+  # Read the index name either from the config file or from ENV
+  def index_name
+    get_key('ALGOLIA_INDEX_NAME', 'index_name')
+  end
+
   # Check that the API key is available
   def check_api_key
     return if api_key
@@ -35,14 +58,14 @@ class AlgoliaSearchCredentialChecker
 
   # Check that the application id is defined
   def check_application_id
-    return if @config['algolia'] && @config['algolia']['application_id']
+    return if application_id
     @logger.display('application_id_missing')
     exit 1
   end
 
   # Check that the index name is defined
   def check_index_name
-    return if @config['algolia'] && @config['algolia']['index_name']
+    return if index_name
     @logger.display('index_name_missing')
     exit 1
   end
@@ -55,7 +78,7 @@ class AlgoliaSearchCredentialChecker
     check_index_name
 
     Algolia.init(
-      application_id: @config['algolia']['application_id'],
+      application_id: application_id,
       api_key: api_key
     )
 

data/lib/push.rb

@@ -176,12 +176,13 @@ class AlgoliaSearchJekyllPush < Jekyll::Command
     end
 
     def push(items)
-      AlgoliaSearchCredentialChecker.new(@config).assert_valid
+      checker = AlgoliaSearchCredentialChecker.new(@config)
+      checker.assert_valid
 
       Jekyll.logger.info '=== DRY RUN ===' if @is_dry_run
 
       # Add items to a temp index, then rename it
-      index_name = @config['algolia']['index_name']
+      index_name = checker.index_name
       index_name_tmp = "#{index_name}_tmp"
       batch_add_items(items, create_index(index_name_tmp))
       Algolia.move_index(index_name_tmp, index_name) unless @is_dry_run

data/lib/version.rb

@@ -1,6 +1,6 @@
 # Expose gem version
 class AlgoliaSearchJekyllVersion
   def self.to_s
-    '0.7.0'
+    '0.8.0'
   end
 end

data/spec/credential_checker_spec.rb

@@ -59,6 +59,130 @@ describe(AlgoliaSearchCredentialChecker) do
     end
   end
 
+  describe 'check_api_key' do
+    it 'should exit with error if no API key' do
+      # Given
+      allow(checker).to receive(:api_key).and_return(nil)
+      allow(checker.logger).to receive(:display)
+
+      # When / Then
+      expect(-> { checker.check_api_key }).to raise_error SystemExit
+    end
+
+    it 'should do nothing when an API key is found' do
+      # Given
+      allow(checker).to receive(:api_key).and_return('APIKEY')
+
+      # When / Then
+      expect(-> { checker.check_api_key }).not_to raise_error
+    end
+  end
+
+  describe 'application_id' do
+    it 'reads value from the _config.yml file' do
+      # Given
+
+      # When
+      actual = checker.application_id
+
+      # Then
+      expect(actual).to eq 'APPID'
+    end
+
+    it 'reads from ENV var if set' do
+      # Given
+      stub_const('ENV', 'ALGOLIA_APPLICATION_ID' => 'APPLICATION_ID_FROM_ENV')
+
+      # When
+      actual = checker.application_id
+
+      # Then
+      expect(actual).to eq 'APPLICATION_ID_FROM_ENV'
+    end
+
+    it 'returns nil if no key found' do
+      # Given
+      config['algolia']['application_id'] = nil
+
+      # When
+      actual = checker.application_id
+
+      # Then
+      expect(actual).to be_nil
+    end
+  end
+
+  describe 'check_application_id' do
+    it 'should exit with error if no application ID' do
+      # Given
+      allow(checker).to receive(:application_id).and_return(nil)
+      allow(checker.logger).to receive(:display)
+
+      # When / Then
+      expect(-> { checker.check_application_id }).to raise_error SystemExit
+    end
+
+    it 'should do nothing when an application ID is found' do
+      # Given
+      allow(checker).to receive(:application_id).and_return('APPLICATIONID')
+
+      # When / Then
+      expect(-> { checker.check_application_id }).not_to raise_error
+    end
+  end
+
+  describe 'index_name' do
+    it 'reads value from the _config.yml file' do
+      # Given
+
+      # When
+      actual = checker.index_name
+
+      # Then
+      expect(actual).to eq 'INDEXNAME'
+    end
+
+    it 'reads from ENV var if set' do
+      # Given
+      stub_const('ENV', 'ALGOLIA_INDEX_NAME' => 'INDEX_NAME_FROM_ENV')
+
+      # When
+      actual = checker.index_name
+
+      # Then
+      expect(actual).to eq 'INDEX_NAME_FROM_ENV'
+    end
+
+    it 'returns nil if no key found' do
+      # Given
+      config['algolia']['index_name'] = nil
+
+      # When
+      actual = checker.index_name
+
+      # Then
+      expect(actual).to be_nil
+    end
+  end
+  describe 'check_index_name' do
+    it 'should exit with error if no index name' do
+      # Given
+      allow(checker).to receive(:index_name).and_return(nil)
+      allow(checker.logger).to receive(:display)
+
+      # When / Then
+      expect(-> { checker.check_index_name }).to raise_error SystemExit
+    end
+
+    it 'should do nothing when an index name is found' do
+      # Given
+      allow(checker).to receive(:index_name).and_return('INDEXNAME')
+
+      # When / Then
+      expect(-> { checker.check_index_name }).not_to raise_error
+    end
+  end
+
   describe 'assert_valid' do
     before(:each) do
       allow(checker.logger).to receive(:display)
@@ -104,7 +228,8 @@ describe(AlgoliaSearchCredentialChecker) do
 
     it 'should init the Algolia client' do
       # Given
-      stub_const('ENV', 'ALGOLIA_API_KEY' => 'APIKEY_FROM_ENV')
+      allow(checker).to receive(:application_id).and_return('FOO')
+      allow(checker).to receive(:api_key).and_return('BAR')
       allow(Algolia).to receive(:init)
 
       # When
@@ -112,8 +237,8 @@ describe(AlgoliaSearchCredentialChecker) do
 
       # Then
       expect(Algolia).to have_received(:init).with(
-        application_id: 'APPID',
-        api_key: 'APIKEY_FROM_ENV'
+        application_id: 'FOO',
+        api_key: 'BAR'
       )
     end
   end

data/spec/spec_helper.rb

@@ -26,7 +26,7 @@ def get_site(config = {}, options = {})
   options = default_options.merge(options)
 
   config = config.merge(
-    source: fixture_path
+    'source' => fixture_path
   )
   config = Jekyll.configuration(config)
 

data/txt/application_id_missing

@@ -4,5 +4,7 @@ Algolia Error: No application ID defined
   algolia:         
     application_id: {your_application_id}
 
+  You can also define the ALGOLIA_APPLICATION_ID environment variable.
+
   Your application ID can be found in your algolia dashboard:
     https://www.algolia.com/licensing

data/txt/index_name_missing

@@ -4,6 +4,8 @@ Algolia Error: No index name defined
   algolia:         
     index_name: {your_index_name}
 
+  You can also define the ALGOLIA_INDEX_NAME environment variable.
+
   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.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Tim Carry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algoliasearch