jekyll_search 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0272796b99e85011ccd3b24088e8d5af7ca1bda1
+  data.tar.gz: 7de7bfb19915e80aa22c8010b30a9c68acfae2a3
+SHA512:
+  metadata.gz: e63c744a1a09fbe448b8cd5be7a07cbf86b50343d90ef89ae28b5c08038fc7704a3d8c44df995dd4d9a1d0a6d447ce3c66df073ff546c74c58f38280b60d86ea
+  data.tar.gz: 17ba283c261386c92ead77570830f6ca8d44540f48dc801a0b19e004967b7ed09b3ec3bba7b1797e1e9d2eb84ece7be4a9813ce70988ff1604144e48438e4a66

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in my_ruby_gem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christian Hoffmeister
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# JekyllSearch
+
+[![build](https://img.shields.io/travis/choffmeister/jekyll_search/develop.svg)](https://travis-ci.org/choffmeister/jekyll_search)
+[![gem](https://img.shields.io/gem/v/jekyll_search.svg)](https://rubygems.org/gems/jekyll_search)
+[![license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](http://opensource.org/licenses/MIT)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+source 'https://rubygems.org'
+
+group :jekyll_plugins do
+  gem 'jekyll_search'
+end
+```
+
+or for bleeding edge:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_search', :git => 'https://github.com/choffmeister/jekyll_search.git', :branch => 'develop'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+First you need a machine with [Elasticsearch][elasticsearch] installed. Then configure the search plugin by adding
+the following entries into your Jekyll `_config.yml` (replace the `host` entry if needed):
+
+```yaml
+# Search index settings
+search:
+  host: localhost:9200
+```
+
+Now run `jekyll index` to iterate over all pages and index them with Elasticsearch. With `jekyll search my query`
+you can throw some test searches against your freshly created search index.
+
+If you want to customize how Elasticsearch creates the search index, then provide an additional `index` property
+in your `_config.yml` (see [here][elasticsearch-createindex]:
+
+```yaml
+# Search index settings
+search:
+  host: localhost:9200
+  index:
+    mappings:
+      page:
+        properties:
+          url:
+            type: string
+            analyzer: keyword
+          title:
+            type: string
+            analyzer: english
+          content:
+            type: string
+            analyzer: english
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/choffmeister/jekyll_search/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[elasticsearch]: http://www.elasticsearch.org/
+[elasticsearch-createindex]: http://www.rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Indices/Actions#create-instance_method

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+multitask :default => [:test]
+task :spec => :test
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:test)

data/jekyll_search.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll_search"
+  spec.version       = JekyllSearch::VERSION
+  spec.authors       = ["Christian Hoffmeister"]
+  spec.email         = ["mail@choffmeister.de"]
+  spec.summary       = "An Elasticsearch full text search index generator for Jekyll."
+  spec.description   = ""
+  spec.homepage      = "https://github.com/choffmeister/jekyll_search"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+
+  spec.add_dependency "jekyll", ">= 2.5.0"
+  spec.add_dependency "elasticsearch", "~> 1.0.6"
+  spec.add_dependency "loofah", "~> 2.0.1"
+end

data/lib/jekyll_search/version.rb

@@ -0,0 +1,3 @@
+module JekyllSearch
+  VERSION = "0.0.1"
+end

data/lib/jekyll_search.rb

@@ -0,0 +1,107 @@
+require 'jekyll'
+require 'elasticsearch'
+require 'loofah'
+require 'loofah/helpers'
+
+module Jekyll
+  module Commands
+    class Index < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:index) do |c|
+            c.syntax "index"
+            c.description 'Creates a search index in Elasticsearch.'
+
+            c.action do |args, options|
+              options["serving"] = false
+              Index.process(options)
+            end
+          end
+        end
+
+        def process(options)
+          options = configuration_from_options(options)
+          destination = options['destination']
+
+          site = Jekyll::Site.new(options)
+          site.process
+          settings = site.config['search']
+
+          client = Elasticsearch::Client.new host: settings['host'], log: false
+          create_index(client, settings)
+
+          pages = site.pages.
+              select { |p| p.url =~ /\.html$/ }.
+              select { |p| p.data['searchable'].nil? or p.data['searchable'] != false }
+
+          for page in pages
+            body = {
+              url: site.baseurl + page.url,
+              title: page.data['title'],
+              content: clean_content(page.content)
+            }
+
+            client.index index: 'documentation', type: 'page', body: body
+          end
+        end
+
+        def clean_content(dirty)
+          strip_pre = Loofah::Scrubber.new do |node|
+            if node.name == 'pre'
+              node.remove
+              Loofah::Scrubber::STOP
+            end
+          end
+
+          Loofah.fragment(dirty).
+              scrub!(:prune).
+              scrub!(strip_pre).
+              to_text.
+              gsub(/([\r\n\t\s]+)/, ' ').strip
+        end
+
+        def create_index(client, settings)
+          if client.indices.exists index: 'documentation'
+            client.indices.delete index: 'documentation'
+          end
+
+          client.indices.create index: 'documentation', body: (settings['index'] or {})
+        end
+      end
+    end
+
+    class Search < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:search) do |c|
+            c.syntax "search query"
+            c.description 'Searches a search index in Elasticsearch.'
+
+            c.action do |args, options|
+              query = args.join(' ').strip
+              options["serving"] = false
+              Search.process(options, query)
+            end
+          end
+        end
+
+        def process(options, query)
+          options = configuration_from_options(options)
+          site = Jekyll::Site.new(options)
+          settings = site.config['search']
+
+          client = Elasticsearch::Client.new host: settings['host'], log: false
+          result = client.search index: 'documentation', body: { query: { match: { content: query } }, highlight: { fields: { content: {} }} }
+
+          puts "Query: #{query}"
+          puts "Total: #{result['hits']['total']}"
+          puts "Max score: #{result['hits']['max_score']}"
+          for hit in result['hits']['hits']
+            puts "Hit at #{hit['_source']['url']} (#{hit['_score']})"
+            hit['highlight']['content'].each { |c| puts '- ' + c }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/jekyll_search_spec.rb

@@ -0,0 +1,5 @@
+require 'jekyll_search'
+
+RSpec.describe Jekyll::Commands::Index do
+  it 'works'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Hoffmeister
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+- !ruby/object:Gem::Dependency
+  name: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: ''
+email:
+- mail@choffmeister.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_search.gemspec
+- lib/jekyll_search.rb
+- lib/jekyll_search/version.rb
+- spec/lib/jekyll_search_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/choffmeister/jekyll_search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: An Elasticsearch full text search index generator for Jekyll.
+test_files:
+- spec/lib/jekyll_search_spec.rb
+- spec/spec_helper.rb