jekyll-google_cse 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06f08f9143b0d96c94a8414850209ead5f552328
+  data.tar.gz: 79ce43d735f3159b7b613cb8e5d4c15364bd69d3
+SHA512:
+  metadata.gz: 0795c44d097287462c6375809e284f908a90d6f6b866d14e70cd4718dc128751028768dce786819373cbe81429c98e2520fd4c71238e612e6eb7725513808638
+  data.tar.gz: 4e38fac703ab2bc13df77293f9b0f99f21c5dbc740543fb34b5ba5fc50b19ddf54071e3b16a580e3346ae83196704128089e5df9ffc1dbae7e697c706c599f12

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Style/ClassAndModuleChildren:
+  Exclude:
+    - test/jekyll/google_cse_test.rb
+Style/RedundantReturn:
+  Exclude:
+    - test/jekyll/google_cse_test.rb
+Style/FileName:
+  Exclude:
+    - lib/jekyll-google_cse.rb

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at brint.ohearn@rackspace.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brint O'Hearn
+
+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,77 @@
+# Jekyll::GoogleCse
+[![Build Status](https://travis-ci.org/brint/jekyll-google_cse.svg?branch=master)][travis]
+
+[travis]: https://travis-ci.org/brint/jekyll-google_cse
+
+Add [Google Custom Search Engine](https://cse.google.com/) to your Jekyll site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-google_cse'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-google_cse
+
+## Usage
+
+Add the necessary configuration to to `_config.yml`. Start by adding `jekyll-google_cse` to the list of gems for Jekyll to install:
+
+```yaml
+gems:
+  - jekyll-google_cse
+```
+
+Next configure your site to use your "Search engine ID", which will be on the "Basics" page when you are configuring your custom search engine. In your Jekyll `_config.yml`, add your search engine ID:
+
+```yaml
+google_cse_id: "000000000000000000000:fffffffffff" # Use your search engine ID
+```
+
+Then add the following tag after the following line where you'd like the Google Custom Search Engine to be show:
+
+```liquid
+{% google_cse %}
+```
+
+ If you're not sure where to place the search engine, I'd recommend putting it in `_layouts/default.html` inside the `page-content` block:
+
+```html
+<div class="page-content">
+  <div class="wrapper">
+    {% google_cse %}
+    {{ content }}
+  </div>
+</div>
+```
+
+Doing this will make the search engine appear at the top of every page.
+
+If you have multiple environments, you may only want to have the Google Custom Search Engine appear in a specific environment. Here's an example of how to only use the Google Custom Search Engine in your `production` environment:
+
+```liquid
+{% if jekyll.environment == "production" %}{% google_cse %}{% endif %}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brint/jekyll-google_cse. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :ci do
+  Rake::Task['rubocop'].invoke
+  Rake::Task['test'].invoke
+end
+
+task default: :ci

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jekyll/google_cse'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-google_cse.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-google_cse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-google_cse'
+  spec.version       = Jekyll::GoogleCse::VERSION
+  spec.authors       = ["Brint O'Hearn"]
+  spec.email         = ['brintly@gmail.com']
+
+  spec.summary       = 'Add Google CSE to your Jekyll site'
+  spec.homepage      = 'https://github.com/brint/jekyll-google_cse'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f|
+    f.match(%r{^(test|spec|features)/})
+  }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this
+  # section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public pushes.'
+  end
+
+  spec.add_dependency 'jekyll', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.40'
+end

data/lib/jekyll-google_cse.rb

@@ -0,0 +1,43 @@
+require 'jekyll-google_cse/version'
+require 'jekyll'
+
+module Jekyll
+  class GoogleCse < Liquid::Tag # :nodoc:
+    InvalidGoogleCseConfig = Class.new(Jekyll::Errors::FatalException)
+
+    TEMPLATE = <<-TEMPLATE.freeze
+<script>
+  (function() {
+    var cx = '%s';
+    var gcse = document.createElement('script');
+    gcse.type = 'text/javascript';
+    gcse.async = true;
+    gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+        '//cse.google.com/cse.js?cx=' + cx;
+    var s = document.getElementsByTagName('script')[0];
+    s.parentNode.insertBefore(gcse, s);
+  })();
+</script>
+<gcse:search></gcse:search>
+    TEMPLATE
+
+    def render(context)
+      google_cse_config = fetch_google_cse_config(context)
+      format(TEMPLATE, google_cse_config)
+    end
+
+    def fetch_google_cse_config(context)
+      cse_config = context.registers[:site].config['google_cse_id']
+      case cse_config
+      when String
+        return cse_config
+      end
+      raise InvalidGoogleCseConfig,
+            'Invalid jekyll-google_cse configuration. See '\
+            'https://github.com/brint/jekyll-google_cse#usage for more '\
+            'details on usage and configuration.'
+    end
+  end
+end
+
+Liquid::Template.register_tag('google_cse', Jekyll::GoogleCse)

data/lib/jekyll-google_cse/version.rb

@@ -0,0 +1,8 @@
+# Prevent bundler errors
+module Liquid; class Tag; end; end
+
+module Jekyll
+  class GoogleCse < Liquid::Tag
+    VERSION = '1.0.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-google_cse
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brint O'Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-21 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+description: 
+email:
+- brintly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-google_cse.gemspec
+- lib/jekyll-google_cse.rb
+- lib/jekyll-google_cse/version.rb
+homepage: https://github.com/brint/jekyll-google_cse
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add Google CSE to your Jekyll site
+test_files: []