jekyll_version_plugin 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc5371b539ad99125d29732e6269b33d26a4b927
-  data.tar.gz: ec641e5218d09f6e121778a610fd0f353ae00aca
+  metadata.gz: 68d8e97550c3b0f425535b32e072407663d37083
+  data.tar.gz: c9e3d192583b5832dbf5157c82cd561efb95ca0e
 SHA512:
-  metadata.gz: d124e1673754cff8223959f88c58d1c0760f9b8bda923286c3fc114e6e2e6b2d31fbe3fe8678cf77e051b17eb46b6fc2492111aea92df68d1525d2758fc005e9
-  data.tar.gz: ebac6aed07690cf48de721245c4fcdc75451908ed4f872003fbbf5b97d7ba6ee82f0975fcce0f711943651f81f8ab5baf6e0f686cfa2f7f7e66e9a1b9d700e92
+  metadata.gz: c3e7189e48cc678756333a86085dcd7fe9b7dd0b304f73468a7a0597fba596af056b8637137f05b1bea5ec253d5710e7c068dbe5255cb36422b134180afd66c8
+  data.tar.gz: 083a696156c02dd05fc1da7b5712241cb6f9dae531633f68c544580aab974e0bd1b8477faeb880f55d1c3a34e4b793192c6bfa825c80d91fef72f2201f4e6e84

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
 cache: bundler
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.2.0
+  - 2.3.0
   - ruby-head
 script: 'bundle exec rake'

data/Gemfile

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

data/README.md

@@ -5,35 +5,44 @@
 
 ### 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.
+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 automatically each time your site is built.
 
 Identify and highlight the build of your project by calling the tag from your Jekyll project.
 
+##### This Jekyll view code will generate ...
+
+Given a `git` repo with the latest tag of *3.0.0* and *5* commits since tagged, the commit `ga189420` being the latest.
+
 ```ruby
-# this Jekyll view code will generate ...
 <p>Build: {% project_version %}</p>
 ```
 
+##### This html
+
 ```html
-<!-- this html -->
 <p>Build: 3.0.0-5-ga189420</p>
 ```
 
 
 ### Features
 
-Stand back, hold onto your hats... the **jekyll-version-plugin** has 1x feature.
+The **jekyll-version-plugin** has 1x feature with a few options;
 
 * Render a version of your project via `git`.
+  * Use the `git-describe` command with *long* or *short* option
+  * Use the `git rev-parse` on **HEAD** with *long* or *short* option
+
 
 ### 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.
@@ -42,6 +51,7 @@ Add the `jekyll_version_plugin` to your site `_config.yml` file for Jekyll to im
 gems: ['jekyll_version_plugin']
 ```
 
+
 #### Manual import
 
 Just download the source file into your `_plugins` directory, e.g.
@@ -49,29 +59,57 @@ 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
+$ wget https://raw.githubusercontent.com/rob-murray/jekyll-version-plugin/master/lib/jekyll_version_plugin.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.
+The plugin can be called anywhere in your template with or without parameters;
+
+```ruby
+{% project_version *params %}
+{% project_version type format %}
+```
+
+* **type** is what to use for versioning, either `tag` or `commit` - defaults to `tag`
+* **format** is the format of the output, `short` or `long` - defaults to `short`
+
+Wherever you want to display the version, just add one of the snippets below in your content and the version will be rendered when the Jekyll project is built.
+
 
 ```ruby
-{% project_version %}
+# Default options of `tag short`
+{% project_version %} # => will run `git describe --tags --always`
+
+# To render a short tag description like `3.0.0`
+{% project_version tag short %} # => will run `git describe --tags --always`
+
+# To render a more details tag description like `3.0.0-5-ga189420`
+{% project_version tag long %} # => will run `git describe --tags --always --long`
+
+# To render a short commitish like `151ebce`
+{% project_version commit short %} # => will run `git rev-parse --short HEAD`
+
+# To render a longer commitsh like `151ebce149c5886bcf2923db18d73742901eb976`
+{% project_version commit long %} # => will run `git rev-parse HEAD`
 ```
 
 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` or `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;
+If you select the *commit* option then the output will be something like this;
 
 `a189420`
 
+If you have selected the *tags* option and the repository does not have any `tags` then it will grab the short sha of the last commit, see above;
+
 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`
@@ -79,16 +117,19 @@ If for any reason this fails then the output will just be a *sorry* message. Sor
 
 ### Technical wizardry
 
-The plugin just calls `git describe` - For more information see [git documentation](http://git-scm.com/docs/git-describe).
+The plugin just calls `git describe` or `git rev-parse HEAD` - For more information see [git-describe](http://git-scm.com/docs/git-describe) and [git rev-parse](https://git-scm.com/docs/git-rev-parse).
 
 ```bash
 $ git describe --tags --long
+$ git rev-parse --short HEAD
 ```
 
+
 ### Contributions
 
 Please use the GitHub pull-request mechanism to submit contributions.
 
+
 ### License
 
 This project is available for use under the MIT software license.

data/Rakefile

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

data/jekyll_version_plugin.gemspec

@@ -1,22 +1,24 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+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       = '1.0.2'
-  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.name                   = "jekyll_version_plugin"
+  spec.version                = "2.0.0"
+  spec.authors                = ["Rob Murray"]
+  spec.email                  = ["robmurray17@gmail.com"]
+  spec.summary                = "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.required_ruby_version  = ">= 1.9.3"
 
   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.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.5"
 end

data/lib/jekyll_version_plugin.rb

@@ -1,2 +1,104 @@
-# Want to use a different name for the tag class than the gem name :)
-require 'project_version_tag'
+# frozen_string_literal: true
+module Jekyll
+  module VersionPlugin
+    # A Jekyll Tag type that renders a version identifier for your Jekyll site
+    # sourced from the `git` repository containing your code.
+    #
+    class Tag < Liquid::Tag
+      NO_GIT_MESSAGE          = "Oops, are you sure this is a git project?".freeze
+      UNABLE_TO_PARSE_MESSAGE = "Sorry, could not read the project version at the moment".freeze
+      OPTION_NOT_SPECIFIED    = nil
+      PARAMS                  = [:type, :format].freeze
+
+      attr_writer :system_wrapper # for testing
+
+      # A wrapper around system calls; mock/stub this in testing
+      class SystemWrapper
+        def run(command)
+          `#{command}`
+        end
+
+        def command_succeeded?
+          !$?.nil? && $?.success?
+        end
+
+        def git_repo?
+          system("git rev-parse")
+        end
+      end
+
+      def initialize(_name, params, _tokens)
+        super
+        args    = params.split(/\s+/).map(&:strip)
+        # TODO: When min Ruby version is >=2.1 just use `to_h`
+        @params = Hash[PARAMS.zip(args)]
+      end
+
+      def render(_context)
+        if git_repo?
+          current_version.chomp
+        else
+          NO_GIT_MESSAGE
+        end
+      end
+
+      private
+
+      attr_reader :params
+
+      # for testing
+      def system_wrapper
+        @system_wrapper ||= SystemWrapper.new
+      end
+
+      def current_version
+        @_current_version ||= begin
+          version = case params.fetch(:type, "tag")
+                    when "tag", OPTION_NOT_SPECIFIED
+                      git_describe || parse_head
+                    when "commit"
+                      parse_head
+                    end
+
+          version || UNABLE_TO_PARSE_MESSAGE
+        end
+      end
+
+      def git_describe
+        tagged_version = case params.fetch(:format, "short")
+                         when "short", OPTION_NOT_SPECIFIED
+                           run("git describe --tags --always")
+                         when "long"
+                           run("git describe --tags --always --long")
+                         end
+
+        tagged_version if command_succeeded?
+      end
+
+      def parse_head
+        head_commitish = case params.fetch(:format, "short")
+                         when "short", OPTION_NOT_SPECIFIED
+                           run("git rev-parse --short HEAD")
+                         when "long"
+                           run("git rev-parse HEAD")
+                         end
+
+        head_commitish if command_succeeded?
+      end
+
+      def run(command)
+        system_wrapper.run(command)
+      end
+
+      def git_repo?
+        system_wrapper.git_repo?
+      end
+
+      def command_succeeded?
+        system_wrapper.command_succeeded?
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("project_version", Jekyll::VersionPlugin::Tag)

data/spec/integration_test.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+# Basic integration example - run code against a dummy repo
+#
+# * Requires git configured on the machine.
+#
+# Create a tmp dir and create a dummy git repo, run code at various stages,
+# eg no commits, a commit, a tag, etc.
+#
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require_relative "./support/jekyll_template"
+require "jekyll_version_plugin"
+require "tmpdir"
+
+RUN_OPTIONS = [
+  "",
+  "tag short",
+  "tag long",
+  "commit short",
+  "commit long"
+].freeze
+
+def run_code_with_options(message)
+  say_with_colour message, :green
+
+  RUN_OPTIONS.each do |options|
+    say_with_colour "Running with options: '#{options}'", :blue
+    tag = Jekyll::VersionPlugin::Tag.new(nil, options, nil)
+    say_with_colour tag.render(nil), :yellow
+  end
+end
+
+COLOUR_MAP = {
+  red: 31,
+  green: 32,
+  yellow: 33,
+  blue: 34
+}.freeze
+
+def say_with_colour(text, colour_name)
+  colour_code = COLOUR_MAP.fetch(colour_name)
+  puts "\e[#{colour_code}m#{text}\e[0m"
+end
+
+def run_commands(message)
+  say_with_colour message, :red
+  yield
+end
+
+def main
+  Dir.mktmpdir("jekyll_version_plugin_test") do |dir|
+    say_with_colour "Created temp dir: #{dir}", :red
+    Dir.chdir(dir) do
+      run_code_with_options ">> Without git repo"
+
+      run_commands("** Creating git repo") { `git init .` }
+
+      run_code_with_options ">> With git repo"
+
+      run_commands("** Adding file") do
+        File.open("test-file.txt", "w") do |f|
+          f.write("this is some text\n")
+        end
+        `git add -A`
+        `git commit -m"first commit"`
+      end
+
+      run_code_with_options ">> With a commit"
+
+      run_commands("** Creating tag") { `git tag -a v1 -m"first tag"` }
+
+      run_code_with_options ">> With tag"
+
+      run_commands("** Updating file") do
+        File.open("test-file.txt", "w") do |f|
+          f.write("this is some more text\n")
+        end
+        `git add -A`
+        `git commit -m"another commit"`
+      end
+
+      run_code_with_options ">> With a commit after the tag"
+
+      run_commands("** Creating tag again") { `git tag -a v2 -m"second tag"` }
+
+      run_code_with_options ">> With a commit after the tag"
+    end
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  say_with_colour "Running integration tests...", :red
+  main
+end

data/spec/jekyll_version_plugin_tag_spec.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+RSpec.describe Jekyll::VersionPlugin::Tag do
+  GIT_LAST_COMMIT_COMMAND = "git rev-parse --short HEAD"
+
+  GIT_DEFAULT_COMMAND     = "git describe --tags --always"
+
+  GIT_TAG_LONG_COMMAND    = "git describe --tags --always --long"
+  GIT_TAG_SHORT_COMMAND   = "git describe --tags --always"
+  GIT_COMMIT_LONG_COMMAND   = "git rev-parse HEAD"
+  GIT_COMMIT_SHORT_COMMAND  = "git rev-parse --short HEAD"
+  let(:context) { double.as_null_object }
+
+  subject { described_class.new(nil, options, nil) }
+  let(:system_double) { double }
+  let(:options) { "" }
+
+  before do
+    subject.system_wrapper = system_double
+  end
+
+  describe "Parsing options" do
+    before do
+      with_git_repo
+    end
+
+    context "with no options" do
+      let(:options) { "" }
+
+      it "use default command" do
+        allow_call_to_succeed do
+          expect(system_double).to receive(:run).with(GIT_DEFAULT_COMMAND).and_return("hash")
+        end
+
+        subject.render(context)
+      end
+    end
+
+    context "with tag type" do
+      context "with no format" do
+        let(:options) { "tag" }
+
+        it "use default command" do
+          allow_call_to_succeed do
+            expect(system_double).to receive(:run).with(GIT_DEFAULT_COMMAND).and_return("hash")
+          end
+
+          subject.render(context)
+        end
+      end
+
+      context "with long format" do
+        let(:options) { "tag long" }
+
+        it "use correct command" do
+          allow_call_to_succeed do
+            expect(system_double).to receive(:run).with(GIT_TAG_LONG_COMMAND).and_return("hash")
+          end
+
+          subject.render(context)
+        end
+      end
+
+      context "with short format" do
+        let(:options) { "tag short" }
+
+        it "use correct command" do
+          allow_call_to_succeed do
+            expect(system_double).to receive(:run).with(GIT_TAG_SHORT_COMMAND).and_return("hash")
+          end
+
+          subject.render(context)
+        end
+      end
+
+      context "with no tag" do
+        let(:options) { "tag short" }
+
+        it "falls back to head command" do
+          do_not_allow_call_to_succeed do
+            allow(system_double).to receive(:run).with(GIT_TAG_SHORT_COMMAND)
+          end
+
+          allow_call_to_succeed do
+            allow(system_double).to receive(:run).with(GIT_COMMIT_SHORT_COMMAND).and_return("hash")
+          end
+
+          subject.render(context)
+        end
+      end
+    end
+
+    context "with commit type" do
+      context "with no format" do
+        let(:options) { "commit" }
+
+        it "use default command" do
+          allow_call_to_succeed do
+            expect(system_double).to receive(:run).with(GIT_COMMIT_SHORT_COMMAND).and_return("hash")
+          end
+
+          subject.render(context)
+        end
+      end
+
+      context "with long format" do
+        let(:options) { "commit short" }
+
+        it "use correct command" do
+          allow_call_to_succeed do
+            expect(system_double).to receive(:run).with(GIT_COMMIT_SHORT_COMMAND).and_return("hash")
+          end
+
+          subject.render(context)
+        end
+      end
+
+      context "with short format" do
+        let(:options) { "commit long" }
+
+        it "use correct command" do
+          allow_call_to_succeed do
+            expect(system_double).to receive(:run).with(GIT_COMMIT_LONG_COMMAND).and_return("hash")
+          end
+
+          subject.render(context)
+        end
+      end
+    end
+  end
+
+  describe "return message" do
+    context "no git repository" do
+      before do
+        allow(system_double).to receive(:git_repo?).and_return(false)
+      end
+
+      it "returns an error message" do
+        expect(subject.render(context)).to match(/Oops/)
+      end
+    end
+
+    context "a git repository with no commits" do
+      before do
+        with_git_repo
+        do_not_allow_call_to_succeed do
+          allow(system_double).to receive(:run).with(GIT_DEFAULT_COMMAND).and_return(false)
+        end
+
+        do_not_allow_call_to_succeed do
+          allow(system_double).to receive(:run).with(GIT_LAST_COMMIT_COMMAND).and_return(false)
+        end
+      end
+
+      it "returns an unable to read project message" do
+        expect(subject.render(context)).to match(/could not read the project version/)
+      end
+    end
+
+    context "with tag type" do
+      before do
+        with_git_repo
+      end
+      let(:options) { "tag" }
+
+      it "returns response" do
+        allow_call_to_succeed do
+          allow(system_double).to receive(:run).with(GIT_DEFAULT_COMMAND).and_return("tag-hash")
+        end
+
+        expect(subject.render(context)).to eq "tag-hash"
+      end
+    end
+
+    context "with commit type" do
+      before do
+        with_git_repo
+      end
+      let(:options) { "commit" }
+
+      it "returns response" do
+        allow_call_to_succeed do
+          allow(system_double).to receive(:run).with(GIT_COMMIT_SHORT_COMMAND).and_return("commit-hash")
+        end
+
+        expect(subject.render(context)).to eq "commit-hash"
+      end
+    end
+
+    it "removes line ending from parsed value" do
+      with_git_repo
+      allow_call_to_succeed do
+        allow(system_double).to receive(:run).with(GIT_DEFAULT_COMMAND).and_return("tag-hash\n")
+      end
+
+      expect(subject.render(context)).to eq "tag-hash"
+    end
+  end
+
+  private
+
+  def with_git_repo
+    allow(system_double).to receive(:git_repo?).and_return(true)
+  end
+
+  def allow_call_to_succeed
+    yield
+    allow(system_double).to receive(:command_succeeded?).and_return(true)
+  end
+
+  def do_not_allow_call_to_succeed
+    yield
+    allow(system_double).to receive(:command_succeeded?).and_return(false)
+  end
+end

data/spec/spec_helper.rb

@@ -1,75 +1,22 @@
-# 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 }
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "support/jekyll_template"
+require "jekyll_version_plugin"
 
 # 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
+    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|
-    # 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
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.default_formatter = "doc" if config.files_to_run.one?
+  config.order = :random
+  Kernel.srand config.seed
 end

data/spec/support/jekyll_template.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# Hack ...or stub Liquid classes and methods used in plugin
+module Liquid
+  class Tag
+    def initialize(*_); end
+  end
+
+  class Template
+    def self.register_tag(*_); end
+  end
+end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_version_plugin
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Rob Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2016-08-28 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'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 description: 
 email:
 - robmurray17@gmail.com
@@ -59,18 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - jekyll_version_plugin.gemspec
 - lib/jekyll_version_plugin.rb
-- lib/project_version_tag.rb
-- spec/project_version_tag_spec.rb
+- spec/integration_test.rb
+- spec/jekyll_version_plugin_tag_spec.rb
 - spec/spec_helper.rb
+- spec/support/jekyll_template.rb
 homepage: https://github.com/rob-murray/jekyll-version-plugin
 licenses:
 - MIT
@@ -81,21 +82,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.0.14.1
 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/integration_test.rb
+- spec/jekyll_version_plugin_tag_spec.rb
 - spec/spec_helper.rb
+- spec/support/jekyll_template.rb

data/lib/project_version_tag.rb

@@ -1,51 +0,0 @@
-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 --always }
-
-      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

@@ -1,65 +0,0 @@
-require 'spec_helper'
-
-describe Jekyll::ProjectVersionTag do
-  let(:git_test_command) { 'git rev-parse' }
-  let(:git_tag_command) { ' git describe --tags --always ' }
-  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)
-    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)
-    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)
-    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