middleman-build-info 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54f8f1bc504aeda5b8adb6a5e35f9e79f7bce90e
+  data.tar.gz: ff95c2e46a6709e966ece79c6da8a13194c63d9d
+SHA512:
+  metadata.gz: 92656c17807b835913650bff48e62d04a64b606223bec213cb56507971c1525dd0d785ce306532bef6d87bce334ea72b247e7ed7ee793c6de884ed9f3c0a97a4
+  data.tar.gz: e272dd34a2047424c676ed567925eea8887b6c8b57b65715c6e05e1559283f397d5b80b9aa89d9d9372b78aa04170455581a72ef28979fea408621bafa572b3e

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+0.0.1
+=====
+* Initial release

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mariano Cavallo
+
+MIT License
+
+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,53 @@
+# Middleman Build Info
+
+`middleman-build-info` is an extension for the [Middleman] static site generator that mantains an incremental build number and date on a JSON file inside your project.
+
+Once the extension is activated It will run and update the build file every time you build your project.
+
+![IMAGE]
+
+## Dependencies
+
+* middleman-core (3.3+)
+
+## Installation
+Add to your `Gemfile` and then run `bundle install`:
+
+```ruby
+gem "middleman-build-info", :git => 'https://github.com/mcavallo/middleman-build-info.git'
+```
+
+Then activate the extension in your `config.rb` file:
+
+```ruby
+activate :build_info
+```
+
+## Configuration
+
+There are a couple of settings you can override from your `config.rb` file:
+
+```ruby
+activate :build_info do |option|
+  # Name of the build info file (default: 'build.json')
+    option.filename = 'build.json'
+    
+    # Relative path to build file from MM root (default: '')
+    option.relative_path = ''
+end
+```
+
+## Upcoming Features
+
+I'm thinking about adding some Git information to the file as well like last commit hash, branch and committer at the time of the build. But I'm open to suggestions and pull requests.
+
+[CHANGELOG]
+
+## License
+
+Copyright (c) 2014 Mariano Cavallo. MIT Licensed, see [LICENSE] for details.
+
+[middleman]: http://middlemanapp.com
+[IMAGE]: https://raw.githubusercontent.com/mcavallo/middleman-build-info/master/middleman-build-info.png
+[CHANGELOG]: https://github.com/mcavallo/middleman-build-info/blob/master/CHANGELOG.md
+[LICENSE]: https://github.com/mcavallo/middleman-build-info/blob/master/LICENSE.md

data/lib/middleman-build-info.rb

@@ -0,0 +1,7 @@
+require "middleman-core"
+require "middleman-build-info/version"
+
+::Middleman::Extensions.register(:build_info) do
+  require "middleman-build-info/extension"
+  ::Middleman::BuildInfoExtension
+end

data/lib/middleman-build-info/extension.rb

@@ -0,0 +1,27 @@
+require 'middleman-build-info/updater'
+
+module Middleman
+  class BuildInfoExtension < Extension
+
+    option :filename, 'build.json', 'Build filename.'
+    option :relative_path, 'source', 'Relative path to build file from MM root.'
+    option :debug, true, ''
+
+    def initialize(app, options_hash={}, &block)
+      super
+    end
+
+    def after_configuration
+      @updater = BuildInfo::Updater.new(@app, options)
+    end
+
+    def before_build(builder)
+      @updater.update_build_info(builder)      
+    end
+
+    def after_build
+      @updater.wrap_up
+    end
+
+  end
+end

data/lib/middleman-build-info/monkey.rb

@@ -0,0 +1,5 @@
+class String
+  def without_leading_slash
+    self.gsub(/^\//,'')
+  end
+end

data/lib/middleman-build-info/updater.rb

@@ -0,0 +1,66 @@
+require 'middleman-build-info/monkey'
+require 'json'
+
+module Middleman
+  module BuildInfo
+    class Updater
+
+      def initialize(app, options)
+        @app            = app
+        @options        = options
+        @file           = File.join(@app.root_path, @options[:relative_path], @options[:filename])
+        @file_relative  = File.join(@options[:relative_path], @options[:filename]).without_leading_slash
+      end
+
+      def update_build_info(builder)
+        @builder  = builder
+        @backup   = read_info_file
+        @new_info  = get_updated_info(@backup)
+        write_info_file(@new_info) do
+          @builder.say_status('update', @file_relative, :yellow)
+        end
+      end
+
+      def wrap_up
+        return print_build_info(@new_info) unless @builder.had_errors
+        write_info_file(@backup) do
+          @builder.say_status('rollback', @file_relative, :yellow)
+        end
+      end
+
+      private
+
+      def write_info_file(info, &block)
+        json = "// Hands off!\n" + JSON.pretty_generate(info)
+        File.open(@file, "w") { |f| f.write(json) }
+        yield block
+      rescue
+        @builder.say_status('failed', @file_relative, :red)
+      end
+
+      def read_info_file
+        JSON.parse(File.read(@file))
+      rescue Errno::ENOENT, JSON::ParserError
+        default_template
+      end
+
+      def get_updated_info(info)
+        info["number"] = info["number"].to_i + 1
+        info["date"]   = Time.now.utc.to_s
+        info
+      end
+
+      def default_template
+        { number: 0, date: '' }
+      end
+
+      def print_build_info(info)
+        @builder.say("\n   Build Info:")
+        info.each_pair do |name, value|
+          @builder.say_status(name, value, :green)
+        end
+      end
+
+    end
+  end
+end

data/lib/middleman-build-info/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module BuildInfo
+    VERSION = "0.0.1"
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-build-info.rb"

data/middleman-build-info.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'middleman-build-info/version'
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-build-info"
+  s.version     = Middleman::BuildInfo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mariano Cavallo"]
+  s.email       = ["mariano.cavallo@gmail.com"]
+  s.homepage    = "https://github.com/mcavallo/middleman-build-info"
+  s.summary     = %q{Incremental build information for Middleman}
+  s.description = %q{Incremental build information for Middleman}
+  s.license     = "MIT"
+
+  s.rubyforge_project     = "middleman-build-info"
+  s.files                 = `git ls-files -z`.split("\0")
+  s.require_paths         = ["lib"]
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency("middleman-core", ["~> 3.3"])
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: middleman-build-info
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mariano Cavallo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-24 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.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Incremental build information for Middleman
+email:
+- mariano.cavallo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/middleman-build-info.rb
+- lib/middleman-build-info/extension.rb
+- lib/middleman-build-info/monkey.rb
+- lib/middleman-build-info/updater.rb
+- lib/middleman-build-info/version.rb
+- lib/middleman_extension.rb
+- middleman-build-info.gemspec
+- middleman-build-info.png
+homepage: https://github.com/mcavallo/middleman-build-info
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: middleman-build-info
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Incremental build information for Middleman
+test_files: []