middleman-vcs-time 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 365f56104ba7f707ba587d1bb48fa6f3a1950c1b
-  data.tar.gz: 4a836554e2f209050cc51b834326b80c579c9971
+  metadata.gz: 7968930fda9cd6d292ee50dc5dca313e7db31f40
+  data.tar.gz: 2bd471546abc65091f441d91effe27df624da306
 SHA512:
-  metadata.gz: 904f9674e4b1847340c9ecafbdc99d4e18a06afa0bca1bb1937b03a6ad4afddde997b71575cb6dd4ca13309cc24d97b25a58835b558271f96b88d730faab33c1
-  data.tar.gz: 412c360e0baf237f00fa48923705fc7d9ffdad115afcab30b3ba48702d0a1d9393e2fb52eb614a8b39578b3752c5b15d3e6dfef5a2332bf93694c3b78e478df0
+  metadata.gz: 6eebe78f242967f2cf77516227719e745955ace6c1a16adad3bfcdb31e80baf4d7c1f178a11c77028004a4d1264002422301d5a21c3eaea52ae36e92d4228ffe
+  data.tar.gz: 7b125ad296c92396659e7750a91a51d116fb7a630be7e7dd09b9312d88aeb82d7197e9e4031308e54aa6a5790b340a561b2cd1a7dc243d1d535974ee0811e04a

data/.gitignore

@@ -1,6 +1,11 @@
+# Appraisal
+/gemfiles/*.gemfile.lock
+
+# Aruba
+/tmp
+
 # Bundler
 /Gemfile.lock
 
-# Packaging
+# RubyGems
 /pkg
-/tmp

data/.travis.yml

@@ -2,6 +2,13 @@ env:
   - CUCUMBER_FORMAT=pretty
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.2
+  - 2.2.5
+  - 2.3.1
+gemfile:
+  - gemfiles/middleman_4.0.gemfile
+  - gemfiles/middleman_4.1.gemfile
+  - gemfiles/middleman_unreleased.gemfile
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/middleman_unreleased.gemfile
 script: bundle exec rake test

data/Appraisals

@@ -0,0 +1,5 @@
+unreleased = { github: 'middleman/middleman', branch: 'master' }
+
+appraise('middleman_4.0')        { gem 'middleman-core', '~> 4.0.0' }
+appraise('middleman_4.1')        { gem 'middleman-core', '~> 4.1.0' }
+appraise('middleman_unreleased') { gem 'middleman-core', unreleased }

data/Gemfile

@@ -2,18 +2,12 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :development do
-  gem 'middleman', github: 'middleman/middleman', branch: 'v3-stable'
-  gem 'rake'
-  gem 'rdoc'
-  gem 'travis'
-  gem 'websocket-native'
-  gem 'yard'
-end
+gem 'middleman-core', github: 'middleman/middleman', branch: 'master'
 
 group :test do
-  gem 'aruba'
-  gem 'cucumber'
-  gem 'fivemat'
+  gem 'appraisal', '~> 2.0'
+  gem 'aruba', '~> 0.14'
+  gem 'capybara', '~> 2.4'
+  gem 'cucumber', '~> 2.0'
   gem 'rspec', '~> 3.0'
 end

data/README.md

@@ -4,11 +4,8 @@
 [![Build Status][build-status-badge]][build-status]
 
 Provides means to look up the last-modified times of [Middleman][] sitemap
-resources according to a version control system.
-
-Supported version control systems:
-
-  - Git
+resources according to version control. Supports Git with a fallback to
+filesystem metadata.
 
 ## Installation
 
@@ -28,7 +25,7 @@ Activate the extension in `config.rb`:
 activate :vcs_time
 ```
 
-Get the modification time of the current page:
+Get the modification time of e.g. the current page:
 
 ```ruby
 current_page.mtime # => 2014-01-20 17:31:50 -0800
@@ -36,7 +33,7 @@ current_page.mtime # => 2014-01-20 17:31:50 -0800
 
 
   [build-status]: https://travis-ci.org/AndrewKvalheim/middleman-vcs-time
-  [build-status-badge]: https://travis-ci.org/AndrewKvalheim/middleman-vcs-time.png?branch=master
+  [build-status-badge]: https://travis-ci.org/AndrewKvalheim/middleman-vcs-time.svg?branch=master
   [gem-version]: https://badge.fury.io/rb/middleman-vcs-time
-  [gem-version-badge]: https://badge.fury.io/rb/middleman-vcs-time.png
+  [gem-version-badge]: https://badge.fury.io/rb/middleman-vcs-time.svg
   [middleman]: http://middlemanapp.com/

data/Rakefile

@@ -4,12 +4,11 @@ Bundler::GemHelper.install_tasks
 require 'cucumber/rake/task'
 
 Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
-  format = ENV['CUCUMBER_FORMAT'] || 'Fivemat'
-  t.cucumber_opts = "--color --tags ~@wip --strict --format #{format}"
+  t.cucumber_opts = '--color --tags ~@wip --strict'
 end
 
 require 'rake/clean'
 
-task :test => ['cucumber']
+task test: ['cucumber']
 
-task :default => :test
+task default: :test

data/features/fallback.feature

@@ -8,4 +8,4 @@ Feature: Fallback
   Scenario: Use the file modification time when there is no version control system
     Given the Server is running at "no-vcs-app"
     When I go to "/show-mtime.html"
-    Then I should see the modification time for a file named "source/show-mtime.html.erb"
+    Then I should see the file modification time of "source/show-mtime.html.erb"

data/features/git-support.feature

@@ -3,12 +3,12 @@ Feature: Git support
   Scenario: Use the file modification time when the source file is untracked
     Given the Server is running under Git at "git-app"
     When I go to "/show-mtime_untracked.html"
-    Then I should see the modification time for a file named "source/show-mtime_untracked.html.erb"
+    Then I should see the file modification time of "source/show-mtime_untracked.html.erb"
 
   Scenario: Use the file modification time when there are working changes to the source file
     Given the Server is running under Git at "git-app"
     When I go to "/show-mtime_working.html"
-    Then I should see the modification time for a file named "source/show-mtime_working.html.erb"
+    Then I should see the file modification time of "source/show-mtime_working.html.erb"
 
   Scenario: Use the author time of the most recent commit
     Given the Server is running under Git at "git-app"

data/features/steps/git_steps.rb

@@ -1,10 +1,10 @@
 # Use a non-standard Git directory in fixtures so as not to conflict with the
 # parent repository
 Given /^the Server is running under Git at "([^\"]*)"$/ do |app_path|
-  step %Q{a fixture app "#{app_path}"}
+  step %(a fixture app "#{app_path}")
 
-  set_env 'GIT_DIR', File.join(current_dir, 'dotgit')
-  set_env 'GIT_WORK_TREE', current_dir
+  ENV['GIT_DIR'] = expand_path('dotgit')
+  ENV['GIT_WORK_TREE'] = expand_path('.')
 
-  step %Q{the Server is running}
+  step %(the Server is running)
 end

data/features/steps/time_steps.rb

@@ -3,15 +3,15 @@ TOLERANCE = 5
 Then /^I should see the current time$/ do
   now = Time.now.to_i
 
-  window = (now - TOLERANCE .. now + TOLERANCE)
-  has_current_time = @browser.last_response.body.scan(/\d+/).any? do |digits|
+  window = ((now - TOLERANCE)..(now + TOLERANCE))
+  has_current_time = page.body.scan(/\d+/).any? do |digits|
     window.include?(digits.to_i)
   end
 
   expect(has_current_time).to be_truthy
 end
 
-Then /^I should see the modification time for a file named "([^\"]*)"$/ do |file|
-  target = File.join(current_dir, file)
-  step %Q{I should see "#{File.mtime(target).to_i}"}
+Then /^I should see the file modification time of "([^\"]*)"$/ do |file|
+  target = expand_path(file)
+  step %(I should see "#{File.mtime(target).to_i}")
 end

data/features/support/env.rb

@@ -5,5 +5,5 @@ require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-vcs-time')
 
 # Prevent fixtures from detecting the parent repository
 Before do
-  set_env 'GIT_DIR', File::NULL
+  ENV['GIT_DIR'] = File::NULL
 end

data/fixtures/no-vcs-app/config.rb

@@ -1,4 +1,8 @@
-require 'lib/generated-resources'
+require 'lib/generated_resources'
 
 activate :generated_resources
 activate :vcs_time
+
+generate 'show-mtime_generated.html' do |resource|
+  "This page was last modified at #{resource.mtime.strftime('%s')}."
+end

data/fixtures/no-vcs-app/lib/generated_resources.rb

@@ -0,0 +1,36 @@
+module GeneratedResources
+  # Resource with a configurable renderer
+  class GeneratedResource < ::Middleman::Sitemap::Resource
+    attr_accessor :renderer
+
+    def render(options = {}, locals = {})
+      @renderer.call(self, options, locals)
+    end
+  end
+
+  # Sitemap manipulator
+  class Extension < ::Middleman::Extension
+    expose_to_config :generate
+
+    def initialize(app, options_hash = {})
+      super
+
+      @renderers = {}
+    end
+
+    def generate(path, &renderer)
+      @renderers[path] = renderer
+    end
+
+    def manipulate_resource_list(resources)
+      resources + @renderers.map do |path, renderer|
+        GeneratedResource.new(app.sitemap, path, nil).tap do |resource|
+          resource.renderer = renderer
+        end
+      end
+    end
+  end
+end
+
+extension = GeneratedResources::Extension
+::Middleman::Extensions.register :generated_resources, extension

data/gemfiles/middleman_4.0.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "middleman-core", "~> 4.0.0"
+
+group :test do
+  gem "appraisal", "~> 2.0"
+  gem "aruba", "~> 0.14"
+  gem "capybara", "~> 2.4"
+  gem "cucumber", "~> 2.0"
+  gem "rspec", "~> 3.0"
+end
+
+gemspec :path => "../"

data/gemfiles/middleman_4.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "middleman-core", "~> 4.1.0"
+
+group :test do
+  gem "appraisal", "~> 2.0"
+  gem "aruba", "~> 0.14"
+  gem "capybara", "~> 2.4"
+  gem "cucumber", "~> 2.0"
+  gem "rspec", "~> 3.0"
+end
+
+gemspec :path => "../"

data/gemfiles/middleman_unreleased.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "middleman-core", :github => "middleman/middleman", :branch => "master"
+
+group :test do
+  gem "appraisal", "~> 2.0"
+  gem "aruba", "~> 0.14"
+  gem "capybara", "~> 2.4"
+  gem "cucumber", "~> 2.0"
+  gem "rspec", "~> 3.0"
+end
+
+gemspec :path => "../"

data/lib/middleman-vcs-time.rb

@@ -1,3 +1,7 @@
-require 'middleman-vcs-time/extension'
+require 'middleman-core'
 
-Middleman::VCSTime::Extension.register :vcs_time
+::Middleman::Extensions.register :vcs_time do
+  require 'middleman-vcs-time/extension'
+
+  Middleman::VCSTime::Extension
+end

data/lib/middleman-vcs-time/extension.rb

@@ -1,7 +1,6 @@
-require 'middleman-core'
-
 module Middleman
   module VCSTime
+    # Middleman extension
     class Extension < ::Middleman::Extension
       def initialize(app, **options_hash, &block)
         super
@@ -11,9 +10,9 @@ module Middleman
       end
 
       def after_configuration
-        systems = [Git, Fallback]
+        vcs = [Git, Fallback].find(&:available?)
 
-        systems.detect(&:load)
+        Middleman::Sitemap::Resource.prepend vcs::ResourceIncludes
       end
     end
   end

data/lib/middleman-vcs-time/systems/fallback.rb

@@ -1,20 +1,16 @@
 module Middleman
   module VCSTime
+    # Interface to filesystem metadata
     class Fallback
+      # Extensions to sitemap resources
       module ResourceIncludes
         def mtime
-          if File.exists?(source_file)
-            File.mtime(source_file)
-          else
-            Time.now
-          end
+          source_file ? File.mtime(source_file) : Time.now
         end
       end
 
-      def self.load
-        Middleman::Sitemap::Resource.class_eval do
-          include ResourceIncludes
-        end
+      def self.available?
+        true
       end
     end
   end

data/lib/middleman-vcs-time/systems/git.rb

@@ -2,51 +2,59 @@ require 'pathname'
 
 module Middleman
   module VCSTime
+    # Interface to Git metadata
     class Git < Fallback
+      # Extensions to sitemap resources
       module ResourceIncludes
         def mtime
-          @_mtime ||= if git_clean?
-            git_author_time
-          else
-            super
-          end
+          @_mtime ||= git_clean? ? git_author_time : super
         end
 
         private
 
-        def git_author_time
-          command = %w{git log --follow --numstat --format=%at --}
+        # Parsed numstat log
+        class Numstats
+          include Enumerable
+
+          GIT_NUMSTAT = %w(git log --follow --numstat --format=%at --).freeze
+
+          # Parsed commit entry
+          class Commit
+            attr_reader :time
 
-          result = IO.popen(command + [source_file]) do |output|
-            output.each_line.each_slice(3).find do |result|
-              result.last.split("\t").take(2).map(&:to_i).reduce(&:+).nonzero?
+            def initialize(raw)
+              @insertions, @deletions = raw.last.split("\t").take(2).map(&:to_i)
+              @time = Time.at(raw.first.to_i)
             end
-          end
 
-          Time.at(result.first.to_i) if result
-        end
+            def changed?
+              @deletions.nonzero? || @insertions.nonzero?
+            end
+          end
 
-        def git_clean?
-          command = %w{git status --porcelain --}
+          def initialize(path)
+            @raw = IO.popen(GIT_NUMSTAT + [path])
+          end
 
-          IO.popen(command + [source_file]) { |output| output.read.empty? }
+          def each
+            @raw.each_line.each_slice(3) { |entry| yield Commit.new(entry) }
+          end
         end
-      end
 
-      def self.load
-        if available?
-          super
+        def git_author_time
+          change = Numstats.new(source_file).find(&:changed?)
+          change.time if change
+        end
 
-          Middleman::Sitemap::Resource.class_eval do
-            include ResourceIncludes
+        def git_clean?
+          IO.popen(%w(git status --porcelain --) + [source_file]) do |output|
+            output.read.empty?
           end
         end
       end
 
-      private
-
       def self.available?
-        system(*%w{git rev-parse}, err: File::NULL)
+        system(*%w(git rev-parse), err: File::NULL)
       end
     end
   end

data/middleman-vcs-time.gemspec

@@ -1,20 +1,34 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
+  # Identity
   gem.name     = 'middleman-vcs-time'
-  gem.version  = '0.0.3'
-  gem.platform = Gem::Platform::RUBY
-  gem.required_ruby_version = '~> 2.0'
-  gem.license  = 'MIT'
-  gem.authors  = ['Andrew Kvalheim']
-  gem.email    = ['Andrew@Kvalhe.im']
+  gem.version  = '0.0.4'
   gem.homepage = 'https://github.com/AndrewKvalheim/middleman-vcs-time'
-  gem.summary  = %q{Use version control to determine last-modified times of Middleman resources.}
+  gem.summary  = 'Use version control to determine last-modified times of ' \
+                 'Middleman resources.'
 
+  # License
+  gem.license = 'MIT'
+
+  # Authorship
+  gem.authors = ['Andrew Kvalheim']
+  gem.email   = ['Andrew@Kvalhe.im']
+
+  # Content
   gem.files         = `git ls-files -z`.split("\0")
   gem.test_files    = gem.files.grep(%r{^(features|fixtures)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'middleman-core', ['~> 3.2']
+  # Dependencies
+  gem.platform              = Gem::Platform::RUBY
+  gem.required_ruby_version = '~> 2.2'
+  gem.add_runtime_dependency 'middleman-core', '~> 4.0'
+
+  # Development dependencies
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'travis'
+  gem.add_development_dependency 'websocket-native'
+  gem.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-vcs-time
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrew Kvalheim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -16,14 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.0'
+- !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: rdoc
+  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: travis
+  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: websocket-native
+  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: yard
+  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'
 description: 
 email:
 - Andrew@Kvalhe.im
@@ -33,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.md
 - README.md
@@ -64,8 +135,11 @@ files:
 - fixtures/git-app/source/show-mtime_untracked.html.erb
 - fixtures/git-app/source/show-mtime_working.html.erb
 - fixtures/no-vcs-app/config.rb
-- fixtures/no-vcs-app/lib/generated-resources.rb
+- fixtures/no-vcs-app/lib/generated_resources.rb
 - fixtures/no-vcs-app/source/show-mtime.html.erb
+- gemfiles/middleman_4.0.gemfile
+- gemfiles/middleman_4.1.gemfile
+- gemfiles/middleman_unreleased.gemfile
 - lib/middleman-vcs-time.rb
 - lib/middleman-vcs-time/extension.rb
 - lib/middleman-vcs-time/systems/fallback.rb
@@ -84,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Use version control to determine last-modified times of Middleman resources.
@@ -124,6 +198,6 @@ test_files:
 - fixtures/git-app/source/show-mtime_untracked.html.erb
 - fixtures/git-app/source/show-mtime_working.html.erb
 - fixtures/no-vcs-app/config.rb
-- fixtures/no-vcs-app/lib/generated-resources.rb
+- fixtures/no-vcs-app/lib/generated_resources.rb
 - fixtures/no-vcs-app/source/show-mtime.html.erb
 has_rdoc: 

data/fixtures/no-vcs-app/lib/generated-resources.rb

@@ -1,33 +0,0 @@
-module Middleman
-  module GeneratedResources
-    class GeneratedResource < Middleman::Sitemap::Resource
-      def binary?
-        false
-      end
-
-      def render
-        raise NotImplementedError
-      end
-
-      def source_file
-        ''
-      end
-    end
-
-    class Extension < Middleman::Extension
-      def manipulate_resource_list(resources)
-        resource = GeneratedResource.new(app.sitemap, 'show-mtime_generated.html')
-
-        class << resource
-          def render
-            "This page was last modified at #{mtime.strftime('%s')}."
-          end
-        end
-
-        resources << resource
-      end
-    end
-  end
-end
-
-Middleman::GeneratedResources::Extension.register :generated_resources