jekyll-algolia 1.0.0 → 1.6.0

data/lib/jekyll/algolia/utils.rb

@@ -6,6 +6,19 @@ module Jekyll
   module Algolia
     # Generic language-wide utils
     module Utils
+      # Public: Allow redefining an instance method on the fly with a new one
+      #
+      # instance - The instance to overwrite
+      # method - The method symbol to overwrite
+      # block - The new block to use for replacing (as a proc)
+      #
+      # Solution found on
+      # https://stackoverflow.com/questions/803020/redefining-a-single-ruby-method-on-a-single-instance-with-a-lambda/16631789
+      def self.monkey_patch(instance, method, block)
+        metaclass = class << instance; self; end
+        metaclass.send(:define_method, method, block)
+      end
+
       # Public: Convert a hash with string keys to a hash with symbol keys
       #
       # hash - The input hash, with string keys
@@ -13,22 +26,36 @@ module Jekyll
         Hash[hash.map { |key, value| [key.to_sym, value] }]
       end
 
+      # Public: Check if a variable is an instance of a specific class
+      #
+      # input - the variable to test
+      # classname - the string representation of the class
+      def self.instance_of?(input, classname)
+        input.instance_of? Object.const_get(classname)
+      rescue StandardError
+        # The class might not even exist
+        false
+      end
+
       # Public: Convert an HTML string to its content only
       #
       # html - String representation of the HTML node
       def self.html_to_text(html)
+        return nil if html.nil?
+
         text = Nokogiri::HTML(html).text
         text.tr("\n", ' ').squeeze(' ').strip
       end
 
-      # Public: Remove all keys with a nil value or an empty array from a hash
+      # Public: Remove all keys with a nil value or an empty string from a hash
       #
       # hash - The input hash
       def self.compact_empty(hash)
         new_hash = {}
         hash.each do |key, value|
           next if value.nil?
-          next if value.respond_to?(:empty?) && value.empty?
+          next if value.is_a?(String) && value.empty?
+
           new_hash[key] = value
         end
         new_hash
@@ -59,10 +86,99 @@ module Jekyll
       # It is basically a wrapper around [].find, handling more edge-cases
       def self.find_by_key(items, key, value)
         return nil if items.nil?
+
         items.find do |item|
           item[key] == value
         end
       end
+
+      # Public: Convert an object into an object that can easily be converted to
+      # JSON, to be stored as a record
+      #
+      # item - The object to convert
+      #
+      # It will keep any string, number, boolean,boolean,array or nested object,
+      # but will try to stringify other objects, excluding the one that contain
+      # a unique identifier once serialized.
+      def self.jsonify(item)
+        simple_types = [
+          NilClass,
+          TrueClass, FalseClass,
+          Integer, Float,
+          String
+        ]
+        # Integer arrived in Ruby 2.4. Before that it was Fixnum and Bignum
+        if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4.0')
+          # rubocop:disable Lint/UnifiedInteger
+          simple_types += [Fixnum, Bignum]
+          # rubocop:enable Lint/UnifiedInteger
+        end
+        return item if simple_types.member?(item.class)
+
+        # Recursive types
+        return item.map { |value| jsonify(value) } if item.is_a?(Array)
+        if item.is_a?(Hash)
+          return item.map { |key, value| [key, jsonify(value)] }.to_h
+        end
+
+        # Can't be stringified, discard it
+        return nil unless item.respond_to?(:to_s)
+
+        # Discard also if is a serialized version with unique identifier
+        stringified = item.to_s
+        return nil if match?(stringified, /#<[^ ].*@[0-9]* .*>/)
+
+        stringified
+      end
+
+      # Public: Get a hash representing the difference between two hashes
+      #
+      # It only checks that all keys of alpha are also in beta, with the same
+      # value. If not, it remember what was the value of beta and return it in
+      # the output
+      def self.diff_keys(alpha, beta)
+        diff = {}
+        alpha.each do |key, value|
+          diff[key] = beta[key] if beta[key] != value
+        end
+
+        return nil if diff.empty?
+
+        diff
+      end
+
+      # Public: Split a long text into lines of specific length
+      #
+      # It takes care to not cut words
+      def self.split_lines(input, max_length)
+        # Force splitting on actual new lines first
+        if input.include?("\n")
+          output = []
+          input.split("\n").each do |line|
+            output += split_lines(line, max_length)
+          end
+          return output
+        end
+
+        output = []
+        words = input.split(' ')
+        current_line = words.shift || ''
+        test_line = '' # must be defined outside of the loop
+
+        words.each do |word|
+          test_line = "#{current_line} #{word}"
+          if test_line.length > max_length
+            output << current_line
+            current_line = word
+            next
+          end
+          current_line = test_line
+        end
+        output << current_line
+
+        # Making sure all lines are the same length
+        output.map { |line| line.ljust(max_length, ' ') }
+      end
     end
   end
 end

data/lib/jekyll/algolia/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Algolia
-    VERSION = '1.0.0'
+    VERSION = '1.6.0'
   end
 end

data/lib/jekyll/commands/algolia.rb

@@ -14,20 +14,6 @@ module Jekyll
                            '--config CONFIG_FILE[,CONFIG_FILE2,...]',
                            Array,
                            'Custom configuration file'
-            command.option 'future',
-                           '--future',
-                           'Index posts with a future date'
-            command.option 'limit_posts',
-                           '--limit_posts MAX_POSTS',
-                           Integer,
-                           'Limits the number of posts to parse and index'
-            command.option 'show_drafts',
-                           '-D',
-                           '--drafts',
-                           'Index posts in the _drafts folder'
-            command.option 'unpublished',
-                           '--unpublished',
-                           'Index posts that were marked as unpublished'
             command.option 'dry_run',
                            '--dry-run',
                            '-n',
@@ -35,6 +21,9 @@ module Jekyll
             command.option 'verbose',
                            '--verbose',
                            'Display more information on what is indexed'
+            command.option 'force_settings',
+                           '--force-settings',
+                           'Force updating of the index settings'
 
             command.action do |_, options|
               configuration = configuration_from_options(options)

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-algolia
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Tim Carry
+- Sylvain Utard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: algolia_html_extractor
@@ -16,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: algoliasearch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.26'
 - !ruby/object:Gem::Dependency
   name: filesize
   requirement: !ruby/object:Gem::Requirement
@@ -56,58 +57,64 @@ dependencies:
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: jekyll-paginate
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: verbal_expressions
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +129,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +185,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -249,23 +284,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.10'
 description: Index all your content into Algolia by running `jekyll algolia`
-email: tim@pixelastic.com
+email: support@algolia.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CONTRIBUTING.md
 - README.md
-- errors/invalid_credentials.txt
-- errors/invalid_credentials_for_tmp_index.txt
-- errors/invalid_index_name.txt
-- errors/missing_api_key.txt
-- errors/missing_application_id.txt
-- errors/missing_index_name.txt
-- errors/no_records_found.txt
-- errors/record_too_big.txt
-- errors/unknown_application_id.txt
-- errors/unknown_settings.txt
+- lib/errors/invalid_credentials.txt
+- lib/errors/invalid_index_name.txt
+- lib/errors/missing_api_key.txt
+- lib/errors/missing_application_id.txt
+- lib/errors/missing_index_name.txt
+- lib/errors/no_records_found.txt
+- lib/errors/record_too_big.txt
+- lib/errors/record_too_big_api.txt
+- lib/errors/settings_manually_edited.txt
+- lib/errors/too_many_records.txt
+- lib/errors/unknown_application_id.txt
+- lib/errors/unknown_settings.txt
 - lib/jekyll-algolia.rb
 - lib/jekyll/algolia/configurator.rb
 - lib/jekyll/algolia/error_handler.rb
@@ -274,6 +311,13 @@ files:
 - lib/jekyll/algolia/hooks.rb
 - lib/jekyll/algolia/indexer.rb
 - lib/jekyll/algolia/logger.rb
+- lib/jekyll/algolia/overwrites/githubpages-configuration.rb
+- lib/jekyll/algolia/overwrites/jekyll-algolia-site.rb
+- lib/jekyll/algolia/overwrites/jekyll-document.rb
+- lib/jekyll/algolia/overwrites/jekyll-paginate-pager.rb
+- lib/jekyll/algolia/overwrites/jekyll-tags-link.rb
+- lib/jekyll/algolia/progress_bar.rb
+- lib/jekyll/algolia/shrinker.rb
 - lib/jekyll/algolia/utils.rb
 - lib/jekyll/algolia/version.rb
 - lib/jekyll/commands/algolia.rb
@@ -297,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Index your Jekyll content into Algolia

data/errors/invalid_credentials.txt

@@ -1,10 +0,0 @@
-E: [✗ Error] Invalid credentials
-E:
-E: The jekyll-algolia plugin could not connect to your application ID using the 
-E: API key your provided.
-W:
-W: Make sure your API key has access to your {application_id} application.
-I:
-I: You can find your API key in your Algolia dashboard here:
-I:    https://www.algolia.com/licensing
-I:

data/errors/invalid_credentials_for_tmp_index.txt

@@ -1,17 +0,0 @@
-E: [✗ Error] Invalid credentials for temporary index
-E:
-E: The jekyll-algolia plugin could not access your index with the API key you
-E: provided.
-W:
-W: When using the `atomic` indexing mode, we will push all your content to a 
-W: temporary index, then overwrite the actual index with it. The API key you
-W: defined should have access rights on both.
-I: 
-I: Make sure your API key has access:
-I: - {index_name}
-I: - {index_name_tmp}
-I:
-I: You can configure API keys from your dashboard:
-I:    https://www.algolia.com/apps/{application_id}/api-keys/restricted
-I:
-I: