middleman-vcs-time 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8419316a8a532e9570bbdbe24ce377b32deb9f73
+  data.tar.gz: 4a9351146191c762c070723d114b0cf7e4697f9d
+SHA512:
+  metadata.gz: 40cf40fe1966d1ec79b31f4df85fee42d4ad5a87a735e57568c531aa37ecf81bf48de2b19093e53a3494f79d553eeb4320c665c67965fcbf686b26538de17dba
+  data.tar.gz: db3ef3a2d71e357479f37aeecdcb01e58c4460b548d987d85455ce511365363e379465bdb6a6ac5ff5bb8d9701ef8684fe0d91818ae94a619c6699849a2de23f

data/.gitignore

@@ -0,0 +1,6 @@
+# Bundler
+/Gemfile.lock
+
+# Packaging
+/pkg
+/tmp

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'middleman', github: 'middleman/middleman', branch: 'v3-stable'
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'aruba'
+  gem 'cucumber'
+  gem 'fivemat'
+  gem 'rspec'
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Andrew Kvalheim
+
+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,35 @@
+# middleman-vcs-time
+
+Provides means to look up the last-modified times of [Middleman][] sitemap
+resources according to a version control system.
+
+Supported version control systems:
+
+  - Git
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'middleman-vcs-time'
+```
+
+and run `bundle install`.
+
+## Usage
+
+Activate the extension in `config.rb`:
+
+```ruby
+activate :vcs_time
+```
+
+Get the modification time of the current page:
+
+```ruby
+current_page.mtime # => 2014-01-20 17:31:50 -0800
+```
+
+
+  [middleman]: http://middlemanapp.com/

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+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}"
+end
+
+require 'rake/clean'
+
+task :test => ['cucumber']
+
+task :default => :test

data/features/fallback.feature

@@ -0,0 +1,11 @@
+Feature: Fallback
+
+  Scenario: Use the current time when there is no source file
+    Given the Server is running at "no-vcs-app"
+    When I go to "/show-mtime_generated.html"
+    Then I should see the current time
+
+  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"

data/features/git-support.feature

@@ -0,0 +1,21 @@
+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"
+
+  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"
+
+  Scenario: Use the author time of the most recent commit
+    Given the Server is running under Git at "git-app"
+    When I go to "/show-mtime.html"
+    Then I should see "1386989477"
+
+  Scenario: Ignore commits that are only copies and moves
+    Given the Server is running under Git at "git-app"
+    When I go to "/show-mtime_moved.html"
+    Then I should see "1386989477"

data/features/steps/git_steps.rb

@@ -0,0 +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}"}
+
+  set_env 'GIT_DIR', File.join(current_dir, 'dotgit')
+  set_env 'GIT_WORK_TREE', current_dir
+
+  step %Q{the Server is running}
+end

data/features/steps/time_steps.rb

@@ -0,0 +1,17 @@
+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.include?(digits.to_i)
+  end
+
+  expect(has_current_time).to be_true
+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}"}
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+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
+end

data/fixtures/git-app/config.rb

@@ -0,0 +1 @@
+activate :vcs_time

data/fixtures/git-app/dotgit/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

data/fixtures/git-app/dotgit/ORIG_HEAD

@@ -0,0 +1 @@
+9d6f47ee5196b182f8f347c18d4ad23b1672815b

data/fixtures/git-app/dotgit/config

@@ -0,0 +1,5 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true

data/fixtures/git-app/dotgit/description

@@ -0,0 +1 @@
+Middleman app

data/fixtures/git-app/dotgit/info/refs

@@ -0,0 +1 @@
+2d08e7bcbfe03aa0773b8cbc377b4f036cd274e0	refs/heads/master

data/fixtures/git-app/dotgit/logs/HEAD

@@ -0,0 +1,8 @@
+0000000000000000000000000000000000000000 0f0de932c27c487f6d7492740897c6daf4de3d78 Andrew Kvalheim <Andrew@Kvalhe.im> 1386987868 -0800	commit (initial): Add page that displays its own modification time.
+0f0de932c27c487f6d7492740897c6daf4de3d78 072121012ff66f72e1d3a3139b5c78c0afe8a045 Andrew Kvalheim <Andrew@Kvalhe.im> 1386989417 -0800	commit: Modify the page.
+1456b4021730fb7048579e4e248bacff2284714e ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb Andrew Kvalheim <Andrew@Kvalhe.im> 1387247862 -0800	commit: Modify the page.
+ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb b1a194a19998a5db861743191341bd9d8cfd29c4 Andrew Kvalheim <Andrew@Kvalhe.im> 1391558446 -0800	commit: Add file to be moved.
+b1a194a19998a5db861743191341bd9d8cfd29c4 9d6f47ee5196b182f8f347c18d4ad23b1672815b Andrew Kvalheim <Andrew@Kvalhe.im> 1391558504 -0800	commit: Move file.
+9d6f47ee5196b182f8f347c18d4ad23b1672815b ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb Andrew Kvalheim <Andrew@Kvalhe.im> 1391559482 -0800	reset: moving to ef6ed5e
+ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb 25cf5d93274a096d33d048f40dd2a52d6ed3b6c8 Andrew Kvalheim <Andrew@Kvalhe.im> 1391559566 -0800	commit: Make a copy of the page.
+25cf5d93274a096d33d048f40dd2a52d6ed3b6c8 2d08e7bcbfe03aa0773b8cbc377b4f036cd274e0 Andrew Kvalheim <Andrew@Kvalhe.im> 1391559609 -0800	commit: Move the copy.

data/fixtures/git-app/dotgit/logs/refs/heads/master

@@ -0,0 +1,8 @@
+0000000000000000000000000000000000000000 0f0de932c27c487f6d7492740897c6daf4de3d78 Andrew Kvalheim <Andrew@Kvalhe.im> 1386987868 -0800	commit (initial): Add page that displays its own modification time.
+0f0de932c27c487f6d7492740897c6daf4de3d78 072121012ff66f72e1d3a3139b5c78c0afe8a045 Andrew Kvalheim <Andrew@Kvalhe.im> 1386989417 -0800	commit: Modify the page.
+1456b4021730fb7048579e4e248bacff2284714e ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb Andrew Kvalheim <Andrew@Kvalhe.im> 1387247862 -0800	commit: Modify the page.
+ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb b1a194a19998a5db861743191341bd9d8cfd29c4 Andrew Kvalheim <Andrew@Kvalhe.im> 1391558446 -0800	commit: Add file to be moved.
+b1a194a19998a5db861743191341bd9d8cfd29c4 9d6f47ee5196b182f8f347c18d4ad23b1672815b Andrew Kvalheim <Andrew@Kvalhe.im> 1391558504 -0800	commit: Move file.
+9d6f47ee5196b182f8f347c18d4ad23b1672815b ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb Andrew Kvalheim <Andrew@Kvalhe.im> 1391559482 -0800	reset: moving to ef6ed5e
+ef6ed5e8acbe69c75c7093a5eb44c92df5fbdbdb 25cf5d93274a096d33d048f40dd2a52d6ed3b6c8 Andrew Kvalheim <Andrew@Kvalhe.im> 1391559566 -0800	commit: Make a copy of the page.
+25cf5d93274a096d33d048f40dd2a52d6ed3b6c8 2d08e7bcbfe03aa0773b8cbc377b4f036cd274e0 Andrew Kvalheim <Andrew@Kvalhe.im> 1391559609 -0800	commit: Move the copy.

data/fixtures/git-app/dotgit/objects/info/packs

@@ -0,0 +1,2 @@
+P pack-bc8ae5eaa7a0c137a3db0e68dc4f537bab66f10e.pack
+

data/fixtures/git-app/dotgit/packed-refs

@@ -0,0 +1,2 @@
+# pack-refs with: peeled fully-peeled 
+2d08e7bcbfe03aa0773b8cbc377b4f036cd274e0 refs/heads/master

data/fixtures/git-app/source/show-mtime.html.erb

@@ -0,0 +1 @@
+This page was last modified at <%= current_page.mtime.strftime('%s') %>.

data/fixtures/git-app/source/show-mtime_moved.html.erb

@@ -0,0 +1 @@
+This page was last modified at <%= current_page.mtime.strftime('%s') %>.

data/fixtures/git-app/source/show-mtime_untracked.html.erb

@@ -0,0 +1 @@
+This page was last modified at <%= current_page.mtime.strftime('%s') %>.

data/fixtures/git-app/source/show-mtime_working.html.erb

@@ -0,0 +1 @@
+This page was last modified at <%= current_page.mtime.strftime('%s') %>.

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

@@ -0,0 +1,4 @@
+require 'lib/generated-resources'
+
+activate :generated_resources
+activate :vcs_time

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

@@ -0,0 +1,33 @@
+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

data/fixtures/no-vcs-app/source/show-mtime.html.erb

@@ -0,0 +1 @@
+This page was last modified at <%= current_page.mtime.strftime('%s') %>.

data/lib/middleman-vcs-time.rb

@@ -0,0 +1,3 @@
+require 'middleman-vcs-time/extension'
+
+Middleman::VCSTime::Extension.register :vcs_time

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

@@ -0,0 +1,20 @@
+require 'middleman-core'
+
+module Middleman
+  module VCSTime
+    class Extension < ::Middleman::Extension
+      def initialize(app, **options_hash, &block)
+        super
+
+        require 'middleman-vcs-time/systems/fallback'
+        require 'middleman-vcs-time/systems/git'
+      end
+
+      def after_configuration
+        systems = [Git, Fallback]
+
+        systems.detect(&:load)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Middleman
+  module VCSTime
+    class Fallback
+      module ResourceIncludes
+        def mtime
+          if File.exists?(source_file)
+            File.mtime(source_file)
+          else
+            Time.now
+          end
+        end
+      end
+
+      def self.load
+        Middleman::Sitemap::Resource.include ResourceIncludes
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'pathname'
+
+module Middleman
+  module VCSTime
+    class Git < Fallback
+      module ResourceIncludes
+        def mtime
+          @_mtime ||= if git_clean?
+            git_author_time
+          else
+            super
+          end
+        end
+
+        private
+
+        def git_author_time
+          command = %w{git log --follow --numstat --format=%at --}
+
+          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?
+            end
+          end
+
+          Time.at(result.first.to_i) if result
+        end
+
+        def git_clean?
+          command = %w{git status --porcelain --}
+
+          IO.popen(command + [source_file]) { |output| output.read.empty? }
+        end
+      end
+
+      def self.load
+        if available?
+          super
+          Middleman::Sitemap::Resource.include ResourceIncludes
+        end
+      end
+
+      private
+
+      def self.available?
+        system(*%w{git rev-parse}, err: File::NULL)
+      end
+    end
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-vcs-time'

data/middleman-vcs-time.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name     = 'middleman-vcs-time'
+  gem.version  = '0.0.1'
+  gem.platform = Gem::Platform::RUBY
+  gem.required_ruby_version = '~> 2.0'
+  gem.license  = 'MIT'
+  gem.authors  = ['Andrew Kvalheim']
+  gem.email    = ['Andrew@Kvalhe.im']
+  gem.homepage = 'https://github.com/AndrewKvalheim/middleman-vcs-time'
+  gem.summary  = %q{Use version control to determine last-modified times of Middleman resources.}
+
+  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.0']
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: middleman-vcs-time
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kvalheim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: 
+email:
+- Andrew@Kvalhe.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- features/fallback.feature
+- features/git-support.feature
+- features/steps/git_steps.rb
+- features/steps/time_steps.rb
+- features/support/env.rb
+- fixtures/git-app/config.rb
+- fixtures/git-app/dotgit/HEAD
+- fixtures/git-app/dotgit/ORIG_HEAD
+- fixtures/git-app/dotgit/config
+- fixtures/git-app/dotgit/description
+- fixtures/git-app/dotgit/index
+- fixtures/git-app/dotgit/info/exclude
+- fixtures/git-app/dotgit/info/refs
+- fixtures/git-app/dotgit/logs/HEAD
+- fixtures/git-app/dotgit/logs/refs/heads/master
+- fixtures/git-app/dotgit/objects/info/packs
+- fixtures/git-app/dotgit/objects/pack/pack-bc8ae5eaa7a0c137a3db0e68dc4f537bab66f10e.idx
+- fixtures/git-app/dotgit/objects/pack/pack-bc8ae5eaa7a0c137a3db0e68dc4f537bab66f10e.pack
+- fixtures/git-app/dotgit/packed-refs
+- fixtures/git-app/source/show-mtime.html.erb
+- fixtures/git-app/source/show-mtime_moved.html.erb
+- 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/source/show-mtime.html.erb
+- lib/middleman-vcs-time.rb
+- lib/middleman-vcs-time/extension.rb
+- lib/middleman-vcs-time/systems/fallback.rb
+- lib/middleman-vcs-time/systems/git.rb
+- lib/middleman_extension.rb
+- middleman-vcs-time.gemspec
+homepage: https://github.com/AndrewKvalheim/middleman-vcs-time
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Use version control to determine last-modified times of Middleman resources.
+test_files:
+- features/fallback.feature
+- features/git-support.feature
+- features/steps/git_steps.rb
+- features/steps/time_steps.rb
+- features/support/env.rb
+- fixtures/git-app/config.rb
+- fixtures/git-app/dotgit/HEAD
+- fixtures/git-app/dotgit/ORIG_HEAD
+- fixtures/git-app/dotgit/config
+- fixtures/git-app/dotgit/description
+- fixtures/git-app/dotgit/index
+- fixtures/git-app/dotgit/info/exclude
+- fixtures/git-app/dotgit/info/refs
+- fixtures/git-app/dotgit/logs/HEAD
+- fixtures/git-app/dotgit/logs/refs/heads/master
+- fixtures/git-app/dotgit/objects/info/packs
+- fixtures/git-app/dotgit/objects/pack/pack-bc8ae5eaa7a0c137a3db0e68dc4f537bab66f10e.idx
+- fixtures/git-app/dotgit/objects/pack/pack-bc8ae5eaa7a0c137a3db0e68dc4f537bab66f10e.pack
+- fixtures/git-app/dotgit/packed-refs
+- fixtures/git-app/source/show-mtime.html.erb
+- fixtures/git-app/source/show-mtime_moved.html.erb
+- 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/source/show-mtime.html.erb
+has_rdoc: