middleman-build-reporter 0.0.1

data/fixtures/no-version/source/stylesheets/normalize.css

@@ -0,0 +1,375 @@
+/*! normalize.css v2.0.1 | MIT License | git.io/normalize */
+
+/* ==========================================================================
+   HTML5 display definitions
+   ========================================================================== */
+
+/*
+ * Corrects `block` display not defined in IE 8/9.
+ */
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+nav,
+section,
+summary {
+    display: block;
+}
+
+/*
+ * Corrects `inline-block` display not defined in IE 8/9.
+ */
+
+audio,
+canvas,
+video {
+    display: inline-block;
+}
+
+/*
+ * Prevents modern browsers from displaying `audio` without controls.
+ * Remove excess height in iOS 5 devices.
+ */
+
+audio:not([controls]) {
+    display: none;
+    height: 0;
+}
+
+/*
+ * Addresses styling for `hidden` attribute not present in IE 8/9.
+ */
+
+[hidden] {
+    display: none;
+}
+
+/* ==========================================================================
+   Base
+   ========================================================================== */
+
+/*
+ * 1. Sets default font family to sans-serif.
+ * 2. Prevents iOS text size adjust after orientation change, without disabling
+ *    user zoom.
+ */
+
+html {
+    font-family: sans-serif; /* 1 */
+    -webkit-text-size-adjust: 100%; /* 2 */
+    -ms-text-size-adjust: 100%; /* 2 */
+}
+
+/*
+ * Removes default margin.
+ */
+
+body {
+    margin: 0;
+}
+
+/* ==========================================================================
+   Links
+   ========================================================================== */
+
+/*
+ * Addresses `outline` inconsistency between Chrome and other browsers.
+ */
+
+a:focus {
+    outline: thin dotted;
+}
+
+/*
+ * Improves readability when focused and also mouse hovered in all browsers.
+ */
+
+a:active,
+a:hover {
+    outline: 0;
+}
+
+/* ==========================================================================
+   Typography
+   ========================================================================== */
+
+/*
+ * Addresses `h1` font sizes within `section` and `article` in Firefox 4+,
+ * Safari 5, and Chrome.
+ */
+
+h1 {
+    font-size: 2em;
+}
+
+/*
+ * Addresses styling not present in IE 8/9, Safari 5, and Chrome.
+ */
+
+abbr[title] {
+    border-bottom: 1px dotted;
+}
+
+/*
+ * Addresses style set to `bolder` in Firefox 4+, Safari 5, and Chrome.
+ */
+
+b,
+strong {
+    font-weight: bold;
+}
+
+/*
+ * Addresses styling not present in Safari 5 and Chrome.
+ */
+
+dfn {
+    font-style: italic;
+}
+
+/*
+ * Addresses styling not present in IE 8/9.
+ */
+
+mark {
+    background: #ff0;
+    color: #000;
+}
+
+
+/*
+ * Corrects font family set oddly in Safari 5 and Chrome.
+ */
+
+code,
+kbd,
+pre,
+samp {
+    font-family: monospace, serif;
+    font-size: 1em;
+}
+
+/*
+ * Improves readability of pre-formatted text in all browsers.
+ */
+
+pre {
+    white-space: pre;
+    white-space: pre-wrap;
+    word-wrap: break-word;
+}
+
+/*
+ * Sets consistent quote types.
+ */
+
+q {
+    quotes: "\201C" "\201D" "\2018" "\2019";
+}
+
+/*
+ * Addresses inconsistent and variable font size in all browsers.
+ */
+
+small {
+    font-size: 80%;
+}
+
+/*
+ * Prevents `sub` and `sup` affecting `line-height` in all browsers.
+ */
+
+sub,
+sup {
+    font-size: 75%;
+    line-height: 0;
+    position: relative;
+    vertical-align: baseline;
+}
+
+sup {
+    top: -0.5em;
+}
+
+sub {
+    bottom: -0.25em;
+}
+
+/* ==========================================================================
+   Embedded content
+   ========================================================================== */
+
+/*
+ * Removes border when inside `a` element in IE 8/9.
+ */
+
+img {
+    border: 0;
+}
+
+/*
+ * Corrects overflow displayed oddly in IE 9.
+ */
+
+svg:not(:root) {
+    overflow: hidden;
+}
+
+/* ==========================================================================
+   Figures
+   ========================================================================== */
+
+/*
+ * Addresses margin not present in IE 8/9 and Safari 5.
+ */
+
+figure {
+    margin: 0;
+}
+
+/* ==========================================================================
+   Forms
+   ========================================================================== */
+
+/*
+ * Define consistent border, margin, and padding.
+ */
+
+fieldset {
+    border: 1px solid #c0c0c0;
+    margin: 0 2px;
+    padding: 0.35em 0.625em 0.75em;
+}
+
+/*
+ * 1. Corrects color not being inherited in IE 8/9.
+ * 2. Remove padding so people aren't caught out if they zero out fieldsets.
+ */
+
+legend {
+    border: 0; /* 1 */
+    padding: 0; /* 2 */
+}
+
+/*
+ * 1. Corrects font family not being inherited in all browsers.
+ * 2. Corrects font size not being inherited in all browsers.
+ * 3. Addresses margins set differently in Firefox 4+, Safari 5, and Chrome
+ */
+
+button,
+input,
+select,
+textarea {
+    font-family: inherit; /* 1 */
+    font-size: 100%; /* 2 */
+    margin: 0; /* 3 */
+}
+
+/*
+ * Addresses Firefox 4+ setting `line-height` on `input` using `!important` in
+ * the UA stylesheet.
+ */
+
+button,
+input {
+    line-height: normal;
+}
+
+/*
+ * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
+ *    and `video` controls.
+ * 2. Corrects inability to style clickable `input` types in iOS.
+ * 3. Improves usability and consistency of cursor style between image-type
+ *    `input` and others.
+ */
+
+button,
+html input[type="button"], /* 1 */
+input[type="reset"],
+input[type="submit"] {
+    -webkit-appearance: button; /* 2 */
+    cursor: pointer; /* 3 */
+}
+
+/*
+ * Re-set default cursor for disabled elements.
+ */
+
+button[disabled],
+input[disabled] {
+    cursor: default;
+}
+
+/*
+ * 1. Addresses box sizing set to `content-box` in IE 8/9.
+ * 2. Removes excess padding in IE 8/9.
+ */
+
+input[type="checkbox"],
+input[type="radio"] {
+    box-sizing: border-box; /* 1 */
+    padding: 0; /* 2 */
+}
+
+/*
+ * 1. Addresses `appearance` set to `searchfield` in Safari 5 and Chrome.
+ * 2. Addresses `box-sizing` set to `border-box` in Safari 5 and Chrome
+ *    (include `-moz` to future-proof).
+ */
+
+input[type="search"] {
+    -webkit-appearance: textfield; /* 1 */
+    -moz-box-sizing: content-box;
+    -webkit-box-sizing: content-box; /* 2 */
+    box-sizing: content-box;
+}
+
+/*
+ * Removes inner padding and search cancel button in Safari 5 and Chrome
+ * on OS X.
+ */
+
+input[type="search"]::-webkit-search-cancel-button,
+input[type="search"]::-webkit-search-decoration {
+    -webkit-appearance: none;
+}
+
+/*
+ * Removes inner padding and border in Firefox 4+.
+ */
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+    border: 0;
+    padding: 0;
+}
+
+/*
+ * 1. Removes default vertical scrollbar in IE 8/9.
+ * 2. Improves readability and alignment in all browsers.
+ */
+
+textarea {
+    overflow: auto; /* 1 */
+    vertical-align: top; /* 2 */
+}
+
+/* ==========================================================================
+   Tables
+   ========================================================================== */
+
+/*
+ * Remove most spacing between table cells.
+ */
+
+table {
+    border-collapse: collapse;
+    border-spacing: 0;
+}

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

@@ -0,0 +1,29 @@
+module Middleman
+  class BuildReporterExtension < Extension
+    option :repo_root, nil, 'repo root'
+    option :version, '', 'app version'
+    option :reporter_file, 'build', 'build report file name'
+    option :reporter_file_formats, ['yaml'], 'an array of build report file formats'
+
+    def initialize(app, options_hash = {}, &block)
+      super
+
+      @app = app
+
+      @app.set :repo_root, (options.repo_root ? options.repo_root : app.root)
+      @app.set :version, options.version
+      @app.set :reporter_file, options.reporter_file
+      @app.set :reporter_file_formats, options.reporter_file_formats
+    end
+
+    def after_build(builder)
+      build_report.write do |file|
+        builder.say_status :create, file, :green
+      end
+    end
+
+    def build_report
+      @report ||= Middleman::BuildReporter::Reporter.new(@app)
+    end
+  end
+end

data/lib/middleman-build-reporter/reporter.rb

@@ -0,0 +1,68 @@
+require 'git'
+require 'json'
+require 'yaml'
+
+module Middleman
+  module BuildReporter
+    class Reporter
+      attr_accessor :app
+
+      def initialize(app_instance)
+        @app = app_instance
+
+        @app.set :repo, Git.open(@app.repo_root)
+      end
+
+      def write
+        @app.reporter_file_formats.each do |format|
+          file = "#{reporter_file_path}.#{format}"
+
+          File.write(file, serialize(format))
+
+          yield(file) if block_given?
+        end
+      end
+
+      def reporter_file_path
+        "#{@app.build_dir}/#{@app.reporter_file}"
+      end
+
+      def reporter_extension_file_path
+        "#{@app.root}/.build_reporter.yml"
+      end
+
+      def details
+        {
+          'branch' => repo.current_branch,
+          'revision' => repo.log.first.to_s,
+          'build_time' => build_time.to_s,
+          'version' => @app.version
+        }.merge(details_extension)
+      end
+
+      def details_extension
+        return {} unless details_extension_exist?
+
+        YAML.load(File.read(reporter_extension_file_path))
+      end
+
+      def details_extension_exist?
+        File.exist?(reporter_extension_file_path)
+      end
+
+      def build_time
+        @build_time ||= Time.now
+      end
+
+      def repo
+        @app.repo
+      end
+
+      def serialize(format)
+        method = "to_#{format}".to_sym
+
+        details.send(method)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Middleman
+  module BuildReporter
+    VERSION = '0.0.1'
+  end
+end

data/lib/middleman-build-reporter.rb

@@ -0,0 +1,9 @@
+require 'middleman-core'
+require 'middleman-build-reporter/version'
+require 'middleman-build-reporter/reporter'
+
+::Middleman::Extensions.register(:build_reporter) do
+  require 'middleman-build-reporter/extension'
+
+  ::Middleman::BuildReporterExtension
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-build-reporter"

data/middleman-build-reporter.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-build-reporter/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'middleman-build-reporter'
+  s.version       = Middleman::BuildReporter::VERSION
+  s.platform      = Gem::Platform::RUBY
+
+  s.authors       = ['Mike Ball']
+  s.email         = ['mikedball@gmail.com']
+  s.homepage      = 'https://github.com/mdb/middleman-build-reporter'
+  s.summary       = %q{Report build time details within your Middleman build}
+  s.description   = %q{Report build time details within your Middleman build}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'middleman-core'
+  s.add_runtime_dependency 'git'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'fivemat'
+  s.add_development_dependency 'rake'
+end

data/spec/middleman-build-reporter/extension_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Middleman::BuildReporterExtension do
+  let(:app) { middleman_app('basic-app') }
+
+  let(:extension) { described_class.new(app) }
+
+  context 'its default options' do
+
+    let(:settings) { extension.options.instance_variable_get('@settings') }
+
+    context 'its default repo_root' do
+
+      let(:repo_root) { settings[:repo_root] }
+
+      it 'is nil' do
+        expect(repo_root.default).to be_nil
+      end
+
+      it 'has the correct description' do
+        expect(repo_root.description).to eq 'repo root'
+      end
+    end
+
+    context 'its default version' do
+
+      let(:version) { settings[:version] }
+
+      it 'is an empty string' do
+        expect(version.default).to eq ''
+      end
+
+      it 'has the correct description' do
+        expect(version.description).to eq 'app version'
+      end
+    end
+
+    context 'its default reporter file' do
+
+      let(:reporter_file) { settings[:reporter_file] }
+
+      it 'is "build"' do
+        expect(reporter_file.default).to eq 'build'
+      end
+
+      it 'has the correct description' do
+        expect(reporter_file.description).to eq 'build report file name'
+      end
+    end
+
+    context 'its default reporter file formats' do
+
+      let(:reporter_file_formats) { settings[:reporter_file_formats] }
+
+      it 'they are json and yaml' do
+        expect(reporter_file_formats.default).to eq ['yaml']
+      end
+
+      it 'has the correct description' do
+        expect(reporter_file_formats.description).to eq 'an array of build report file formats'
+      end
+    end
+  end
+
+  describe '#build_report' do
+
+    it 'returns a Middleman::BuildReporter::Reporter instance' do
+      expect(extension.build_report.class).to eq Middleman::BuildReporter::Reporter
+    end
+  end
+
+  describe '#after_build' do
+
+    let(:builder) { double('builder', say_status: 'fake status') }
+
+    it 'writes the build report to a file' do
+      allow(extension.build_report).to receive(:write).and_return 'fake_write_result'
+
+      expect(extension.after_build(builder)).to eq 'fake_write_result'
+    end
+  end
+end