middleman-build-reporter 0.0.1 → 0.0.2

data/fixtures/build-reporter-fingerprint/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

@@ -1,5 +1,5 @@
 module Middleman
-  class BuildReporterExtension < Extension
+  class BuildReporterExtension < Middleman::Extension
     option :repo_root, nil, 'repo root'
     option :version, '', 'app version'
     option :reporter_file, 'build', 'build report file name'
@@ -9,21 +9,27 @@ module Middleman
       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
+      @app.set :repo_root, (options.repo_root ? options.repo_root : @app.root)
+      @app.set :build_report, Middleman::BuildReporter::Reporter.new(@app, options)
     end
 
     def after_build(builder)
-      build_report.write do |file|
+      @app.build_report.write do |file|
         builder.say_status :create, file, :green
       end
     end
 
-    def build_report
-      @report ||= Middleman::BuildReporter::Reporter.new(@app)
+    helpers do
+      class Middleman::Application
+        def build_reporter_fingerprint
+          [
+            '<!--',
+            'FINGERPRINT:',
+            "#{config.build_report.details.to_yaml}",
+            '--!>',
+          ].join("\n")
+        end
+      end
     end
   end
 end

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

@@ -5,16 +5,17 @@ require 'yaml'
 module Middleman
   module BuildReporter
     class Reporter
-      attr_accessor :app
+      attr_accessor :app, :repo
 
-      def initialize(app_instance)
+      def initialize(app_instance, opts = nil)
         @app = app_instance
 
-        @app.set :repo, Git.open(@app.repo_root)
+        @options = opts
+        @repo = Git.open(opts.repo_root)
       end
 
       def write
-        @app.reporter_file_formats.each do |format|
+        @options.reporter_file_formats.each do |format|
           file = "#{reporter_file_path}.#{format}"
 
           File.write(file, serialize(format))
@@ -24,7 +25,7 @@ module Middleman
       end
 
       def reporter_file_path
-        "#{@app.build_dir}/#{@app.reporter_file}"
+        "#{@app.build_dir}/#{@options.reporter_file}"
       end
 
       def reporter_extension_file_path
@@ -33,10 +34,10 @@ module Middleman
 
       def details
         {
-          'branch' => repo.current_branch,
-          'revision' => repo.log.first.to_s,
+          'branch' => @repo.current_branch,
+          'revision' => @repo.log.first.to_s,
           'build_time' => build_time.to_s,
-          'version' => @app.version
+          'version' => @options.version
         }.merge(details_extension)
       end
 
@@ -51,11 +52,7 @@ module Middleman
       end
 
       def build_time
-        @build_time ||= Time.now
-      end
-
-      def repo
-        @app.repo
+        Time.now
       end
 
       def serialize(format)

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

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

data/middleman-build-reporter.gemspec

@@ -19,14 +19,14 @@ Gem::Specification.new do |s|
   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_runtime_dependency 'middleman-core', '>= 3.0.0'
+  s.add_runtime_dependency 'git', '1.2.8'
 
-  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'
+  s.add_development_dependency 'rspec', '3.1.0'
+  s.add_development_dependency 'simplecov', '0.9.0'
+  s.add_development_dependency 'timecop', '0.7.1'
+  s.add_development_dependency 'cucumber', '1.3.17'
+  s.add_development_dependency 'aruba', '0.6.1'
+  s.add_development_dependency 'fivemat', '1.3.1'
+  s.add_development_dependency 'rake', '10.3.2'
 end

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

@@ -62,19 +62,14 @@ describe Middleman::BuildReporterExtension do
     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') }
 
+    let(:build_report) { double('build_report', write: 'fake_write_result') }
+
     it 'writes the build report to a file' do
-      allow(extension.build_report).to receive(:write).and_return 'fake_write_result'
+      allow(app).to receive(:build_report).and_return build_report
 
       expect(extension.after_build(builder)).to eq 'fake_write_result'
     end

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

@@ -6,15 +6,19 @@ describe Middleman::BuildReporter::Reporter do
 
   let(:fake_details) { { 'foo' => 'bar' } }
 
+  let(:options) do
+    double('options', {
+      repo_root: '.',
+      version: '1.2.3',
+      reporter_file: 'reporter_file',
+      reporter_file_formats: ['yaml']
+    })
+  end
+
   let(:app) { middleman_app('basic-app') }
 
   let(:reporter) do
-    app.set :repo_root, '.'
-    app.set :version, '1.2.3'
-    app.set :reporter_file, 'reporter'
-    app.set :reporter_file_formats, ['yaml']
-
-    described_class.new app
+    described_class.new app, options
   end
 
   describe '#new' do
@@ -23,8 +27,8 @@ describe Middleman::BuildReporter::Reporter do
       expect(reporter.app).to eq app
     end
 
-    it 'sets a #repo on the app instance it is passed' do
-      expect(reporter.app.repo.class).to eq Git::Base
+    it 'sets a @repo on the reporter' do
+      expect(reporter.repo.class).to eq Git::Base
     end
   end
 
@@ -32,9 +36,8 @@ describe Middleman::BuildReporter::Reporter do
 
     it 'writes the build details to the proper "build" file' do
       allow(reporter).to receive(:details).and_return fake_details
-      allow(reporter.app).to receive(:reporter_file).and_return 'fake_report_file'
 
-      expect(File).to receive(:write).with('build/fake_report_file.yaml', "---\nfoo: bar\n").and_return 'fake_write_call'
+      expect(File).to receive(:write).with('build/reporter_file.yaml', "---\nfoo: bar\n").and_return 'fake_write_call'
 
       reporter.write
     end
@@ -43,7 +46,7 @@ describe Middleman::BuildReporter::Reporter do
   describe '#reporter_file_path' do
 
     it 'returns the file path to which the build details should be written' do
-      expect(reporter.reporter_file_path).to eq 'build/reporter'
+      expect(reporter.reporter_file_path).to eq 'build/reporter_file'
     end
   end
 
@@ -81,7 +84,7 @@ describe Middleman::BuildReporter::Reporter do
       end
 
       it 'reports the app version' do
-        expect(details['version']).to eq "#{app.version}"
+        expect(details['version']).to eq '1.2.3'
       end
 
       context 'when there is a custom details extension' do
@@ -140,21 +143,6 @@ describe Middleman::BuildReporter::Reporter do
     it 'reports the current time' do
       expect(reporter.build_time.strftime('%Y-%m-%d %H:%M')).to eq Time.now.strftime('%Y-%m-%d %H:%M')
     end
-
-    context 'when build time is already set' do
-      it 'returns the existing value' do
-        reporter.instance_variable_set('@build_time', 'foo')
-
-        expect(reporter.build_time).to eq 'foo'
-      end
-    end
-  end
-
-  describe '#repo' do
-
-    it 'is a shortcut to app#repo' do
-      expect(reporter.repo).to eq app.repo
-    end
   end
 
   describe '#serialize' do