jekyll_version_plugin 0.9.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f212e4809aacf80791ca5e85082bd1000486bfa
+  data.tar.gz: 970b3ada7a49bb24e61836b10f48a15bf22bd3e6
+SHA512:
+  metadata.gz: 4f18dfa10f299464dbe19c352fe72eb9459a6bf4d258af186be8f2a06ea8750d3f3d0eb66a9124263a824baba99adcf21120112ccad93b02a138c45a6ce46aad
+  data.tar.gz: b95383a0fe0b2e878f5d357da3ea13d31edc2b013fe9c20ad4c44acd3ba5d23f807118d91984ef001b8fed4ddea2dabe8016bbc3ab48b2ac96cc18e866d0d058

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+script: 'bundle exec rake'

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Robert Murray
+
+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,92 @@
+## jekyll-version-plugin
+
+[![Build Status](https://travis-ci.org/rob-murray/jekyll-version-plugin.svg)](https://travis-ci.org/rob-murray/jekyll-version-plugin)
+[![Gem Version](https://badge.fury.io/rb/jekyll-version-plugin.svg)](http://badge.fury.io/rb/jekyll-version-plugin)
+
+### Description
+
+A Liquid tag plugin for [Jekyll](http://jekyllrb.com/) that renders a version identifier for your Jekyll site sourced from the `git` repository containing your code. Great if you want to display the version of your project on your site dynamically each time your site is built.
+
+Identify and highlight the build of your project by calling the tag from your Jekyll project.
+
+```html
+<p>Build: 3.0.0-5-ga189420</p>
+```
+
+```ruby
+<p>Build: {% project_version %}</p>
+```
+
+### Features
+
+Stand back, hold onto your hats... the **jekyll-version-plugin** has 1x feature.
+
+* Render a version of your project via `git`.
+
+### Requirements
+
+* Your project is version controlled in `git`.
+
+### Usage
+
+As mentioned by [Jekyll's documentation](http://jekyllrb.com/docs/plugins/#installing-a-plugin) you have two options; manually import the source file or require the plugin as a `gem`.
+
+#### Require gem
+
+Add the `jekyll-version-plugin` to your site `_config.yml` file for Jekyll to import the plugin as a gem.
+
+```ruby
+gems: [jekyll-version-plugin]
+```
+
+#### Manual import
+
+Just download the source file into your `_plugins` directory, e.g.
+
+```bash
+# Create the _plugins dir if needed and download project_version_tag plugin
+$ mkdir -p _plugins && cd _plugins
+$ wget https://raw.githubusercontent.com/rob-murray/jekyll-version-plugin/master/lib/project_version_tag.rb
+```
+
+#### Plugin tag usage
+
+Wherever you want to display the version, just add the snippet below in your content and the version will be rendered when the Jekyll project is built.
+
+```ruby
+{% project_version %}
+```
+
+This will simply output the version number, you can then apply your own styling as necessary. Or just `html` comment it out if you don't want it visible.
+
+### Output
+
+Happy path is a `git` repo with releases that are tagged, if this is the case then the output will be something like this;
+
+`3.0.0-5-ga189420`
+
+If the repository does not have any `tags` then it will grab the short sha of the last commit, for example;
+
+`a189420`
+
+If for any reason this fails then the output will just be a *sorry* message. Sorry about that.
+
+`Sorry, could not read project version at the moment`
+
+
+### Technical wizardry
+
+The plugin just calls `git describe` - For more information see [git documentation](http://git-scm.com/docs/git-describe).
+
+```bash
+$ git describe --tags --long
+```
+
+### Contributions
+
+Please use the GitHub pull-request mechanism to submit contributions.
+
+### License
+
+This project is available for use under the MIT software license.
+See LICENSE

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)

data/jekyll_version_plugin.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_version_plugin'
+  spec.version       = '0.9.9'
+  spec.authors       = ['Rob Murray']
+  spec.email         = ['robmurray17@gmail.com']
+  spec.summary       = %q{A Liquid tag plugin for Jekyll that renders a version identifier for your Jekyll site, sourced from the git repository.}
+  spec.homepage      = 'https://github.com/rob-murray/jekyll-version-plugin'
+  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.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/project_version_tag.rb

@@ -0,0 +1,51 @@
+module Jekyll
+  class ProjectVersionTag < Liquid::Tag
+    NO_GIT_MESSAGE = 'Oops, are you sure this is a git project?'
+    UNABLE_TO_PARSE_MESSAGE = 'Sorry, could not read project version at the moment'
+
+    def render(context)
+      if git_repo?
+        current_version.chomp
+      else
+        NO_GIT_MESSAGE
+      end
+    end
+
+    private
+
+    def current_version
+      @_current_version ||= begin
+        # attempt to find the latest tag, falling back to last commit
+        version = git_describe || parse_head
+
+        version || UNABLE_TO_PARSE_MESSAGE
+      end
+    end
+
+    def git_describe
+      tagged_version = %x{ git describe --tags }
+
+      if command_succeeded?
+        tagged_version
+      end
+    end
+
+    def parse_head
+      head_commitish = %x{ git rev-parse --short HEAD }
+
+      if command_succeeded?
+        head_commitish
+      end
+    end
+
+    def command_succeeded?
+      !$?.nil? && $?.success?
+    end
+
+    def git_repo?
+      system('git rev-parse')
+    end
+  end
+end
+
+Liquid::Template.register_tag('project_version', Jekyll::ProjectVersionTag)

data/spec/project_version_tag_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Jekyll::ProjectVersionTag do
+  let(:git_test_command) { 'git rev-parse' }
+  let(:git_tag_command) { ' git describe --tags ' }
+  let(:git_last_commit_command) { ' git rev-parse --short HEAD ' }
+  let(:context) { nil }
+
+  subject { Jekyll::ProjectVersionTag.new }
+
+  before do
+    allow(subject).to receive(:system).and_return(true)
+  end
+
+  context 'given no git repository' do
+    before do
+      allow(subject).to receive(:system).with(git_test_command).and_return(nil)
+    end
+
+    it 'returns an error message' do
+      expect(subject.render(context)).to match(/Oops/)
+    end
+  end
+
+  context 'given a git repository with no commits' do
+    before do
+      allow(subject).to receive(:`).with(git_last_commit_command).and_return(nil)
+      allow(subject).to receive(:`).with(git_tag_command).and_return(nil)
+      allow(subject).to receive(:command_succeeded?).and_return(true) # argh
+    end
+
+    it 'returns an unable to read project message' do
+      expect(subject.render(context)).to match(/could not read project version/)
+    end
+  end
+
+  context 'given a git repository with a commit and no tag' do
+    before do
+      allow(subject).to receive(:`).with(git_last_commit_command).and_return('abcdefg')
+      allow(subject).to receive(:`).with(git_tag_command).and_return(nil)
+      allow(subject).to receive(:command_succeeded?).and_return(true) # argh
+    end
+
+    it 'returns the last commit sha' do
+      expect(subject.render(context)).to eq('abcdefg')
+    end
+  end
+
+  context 'given a git repository with a commit and a tag' do
+    before do
+      allow(subject).to receive(:`).with(git_tag_command).and_return('v1.0.0')
+      allow(subject).to receive(:command_succeeded?).and_return(true) # argh
+    end
+
+    it 'returns the last commit sha' do
+      expect(subject.render(context)).to eq('v1.0.0')
+    end
+
+    it 'removes line ending from parsed value' do
+      allow(subject).to receive(:`).with(git_tag_command).and_return("v1.0.0\n")
+
+      expect(subject.render(context)).to eq('v1.0.0')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,75 @@
+# Hack er stub Liquid classes and methods used in plugin
+module Liquid
+  class Tag
+  end
+  class Template
+    def self.register_tag(foo, bar)
+    end
+  end
+end
+
+project_root = File.dirname(File.absolute_path(__FILE__))
+Dir.glob(project_root + '/../lib/*') { |file| require file }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # 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
+
+  # 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
+
+  # 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|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  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|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_version_plugin
+version: !ruby/object:Gem::Version
+  version: 0.9.9
+platform: ruby
+authors:
+- Rob Murray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: 
+email:
+- robmurray17@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll_version_plugin.gemspec
+- lib/project_version_tag.rb
+- spec/project_version_tag_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rob-murray/jekyll-version-plugin
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Liquid tag plugin for Jekyll that renders a version identifier for your
+  Jekyll site, sourced from the git repository.
+test_files:
+- spec/project_version_tag_spec.rb
+- spec/spec_helper.rb