jekyll-algolia 0.0.0

data/lib/jekyll/algolia/logger.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Algolia
+    # Display helpful error messages
+    module Logger
+      # Public: Displays a log line
+      #
+      # line - Line to display. Expected to be of the following format:
+      #   "X:Your content"
+      # Where X is either I, W or E for marking respectively an info, warning or
+      # error display
+      def self.log(line)
+        type, content = /^(I|W|E):(.*)/.match(line).captures
+        logger_mapping = {
+          'E' => :error,
+          'I' => :info,
+          'W' => :warn
+        }
+
+        # Jekyll logger tries to center log lines, so we force a consistent
+        # width of 80 chars
+        content = content.ljust(80, ' ')
+        Jekyll.logger.send(logger_mapping[type], content)
+      end
+
+      # Public: Only display a log line if verbose mode is enabled
+      #
+      # line - The line to display, following the same format as .log
+      def self.verbose(line)
+        return unless Configurator.verbose?
+        log(line)
+      end
+
+      # Public: Displays a helpful error message for one of the knows errors
+      #
+      # message_id: A string identifying a know message
+      # metadata: Hash of variables that can be used in the final text
+      #
+      # It will read files in ./errors/*.txt with the matching error and
+      # display them using Jekyll internal logger.
+      def self.known_message(message_id, metadata = {})
+        file = File.expand_path(
+          File.join(
+            __dir__, '../../..', 'errors', "#{message_id}.txt"
+          )
+        )
+
+        # Convert all variables
+        content = File.open(file).read
+        metadata.each do |key, value|
+          content = content.gsub("{#{key}}", value)
+        end
+
+        # Display each line differently
+        lines = content.each_line.map(&:chomp)
+        lines.each do |line|
+          log(line)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/algolia/utils.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Jekyll
+  module Algolia
+    # Generic language-wide utils
+    module Utils
+      # Public: Convert a hash with string keys to a hash with symbol keys
+      #
+      # hash - The input hash, with string keys
+      def self.keys_to_symbols(hash)
+        Hash[hash.map { |key, value| [key.to_sym, value] }]
+      end
+
+      # Public: Convert an HTML string to its content only
+      #
+      # html - String representation of the HTML node
+      def self.html_to_text(html)
+        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
+      #
+      # 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?
+          new_hash[key] = value
+        end
+        new_hash
+      end
+
+      # Public: Check if a string matches a regex
+      #
+      # string - The string to test
+      # regex - The regex to match against
+      #
+      # Newer versions of Ruby have easy ways to test this, but a wrapper is
+      # needed for older versions.
+      def self.match?(string, regex)
+        # Ruby 2.4 introduces .match?
+        return regex.match?(string) if regex.respond_to?(:match?)
+
+        # Older versions of Ruby have to deal with =~ returning nil if no match
+        # is found
+        !(string =~ regex).nil?
+      end
+
+      # Public: Find an item from an array based on the value of one of its key
+      #
+      # items - The array of hashes to search
+      # key - The key to search for
+      # value - The value of the key to filter
+      #
+      # 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
+    end
+  end
+end

data/lib/jekyll/algolia/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Algolia
+    VERSION = '0.0.0'
+  end
+end

data/lib/jekyll/commands/algolia.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Commands
+    # Registering the `jekyll algolia` command
+    class Algolia < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:algolia) do |command|
+            command.syntax 'algolia [options]'
+            command.description 'Push your content to an Algolia index'
+            # Document the options that can be passed from the CLI
+            command.option 'config',
+                           '--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',
+                           'Do a dry run, do not push records'
+            command.option 'verbose',
+                           '--verbose',
+                           'Display more information on what is indexed'
+
+            command.action do |_, options|
+              configuration = configuration_from_options(options)
+
+              Jekyll::Algolia.init(configuration).run
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,304 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-algolia
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tim Carry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: algolia_html_extractor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: algoliasearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: verbal_expressions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec-focused
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Index all your content into Algolia by running `jekyll algolia`
+email: tim@pixelastic.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/jekyll-algolia.rb
+- lib/jekyll/algolia/configurator.rb
+- lib/jekyll/algolia/error_handler.rb
+- lib/jekyll/algolia/extractor.rb
+- lib/jekyll/algolia/file_browser.rb
+- lib/jekyll/algolia/hooks.rb
+- lib/jekyll/algolia/indexer.rb
+- lib/jekyll/algolia/logger.rb
+- lib/jekyll/algolia/utils.rb
+- lib/jekyll/algolia/version.rb
+- lib/jekyll/commands/algolia.rb
+homepage: https://github.com/algolia/jekyll-algolia
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Index your Jekyll content into Algolia
+test_files: []