middleman-build-reporter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1d0cb47f7eb75379745a61569987fb21d197e31
-  data.tar.gz: db005e812ee235648d5c61f749a85453387172cc
+  metadata.gz: 3bb42f011103c8c6c64bcf3534350ed860241d63
+  data.tar.gz: 4160f15697c31a10132bba24e5905b4342097895
 SHA512:
-  metadata.gz: cc7fb3d5f8877b3a17d356268b5b6d7995c482f9982a9bb176013c5bd684d12195edd1f20780114214ac5709ea7306d91db5b3ae6fda8db952b2ca170bf3cfe8
-  data.tar.gz: eeeec727c5801ed6cddbafefbb8f8c9fbebdf5140671d9958d99560a10163d28652c1b6a66245322ad267f2b0605de57b78e0ec4ef178ef59a5c68bac8ae7906
+  metadata.gz: 2a25df05bb57bf745d080b9d7ee280fd1917dd23cead224b7bbe760d5c28efe897c10ee56b6f50ff32713cfed7b5c86b0159fea4e429583b5f97dfac0dd9d391
+  data.tar.gz: a3e5d2203343f4550c3286523898446ea249053c7dbac4a604b13f44b1f35d5d763ed6b15dc06c7d7f8b9deb243fbce680a3a49198d529b37cd479a9b525dd79

data/README.md

@@ -1,8 +1,14 @@
 [![Build Status](https://travis-ci.org/mdb/middleman-build-reporter.svg?branch=master)](https://travis-ci.org/mdb/middleman-build-reporter)
+[![Code Climate](https://codeclimate.com/github/mdb/middleman-build-reporter/badges/gpa.svg)](https://codeclimate.com/github/mdb/middleman-build-reporter)
 
 # middleman-build-reporter
 
-middleman-build-reporter is a [Middleman](http://middlemanapp.com) to help you understand what code has been deployed to an environment, and whether you're viewing cached or stale build artifacts.
+> Which branch/version/configuration/build has been
+> deployed to which data center/server/environment?
+
+middleman-build-reporter is a [Middleman](http://middlemanapp.com) extension
+to help you understand what code has been deployed to an environment, and
+whether you're viewing cached or stale build artifacts.
 
 Features:
 
@@ -35,7 +41,7 @@ The `build/build.json`:
 
 middleman-build-reporter also offers a `build_reporter_fingerprint` helper to fingerprint HTML templates:
 
-```html
+```
 <!--
 FINGERPRINT:
 ---
@@ -43,7 +49,7 @@ branch: master
 revision: c786c0addcde128a0823c40ebb4a3ab453411f10
 build_time: '2014-10-21 07:27:51 -0400'
 version: 1.2.3
---!>
+-->
 ```
 
 ## Usage
@@ -118,7 +124,7 @@ branch: master
 revision: c786c0addcde128a0823c40ebb4a3ab453411f10
 build_time: '2014-10-21 07:27:51 -0400'
 version: 1.2.3
---!>
+-->
 ```
 
 ## Reporting additional custom build details

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

@@ -25,7 +25,7 @@ module Middleman
             '<!--',
             'FINGERPRINT:',
             "#{config.build_report.details.to_yaml}",
-            '--!>',
+            '-->',
           ].join("\n")
         end
       end

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

@@ -5,7 +5,7 @@ require 'yaml'
 module Middleman
   module BuildReporter
     class Reporter
-      attr_accessor :app, :repo
+      attr_reader :app, :options, :repo
 
       def initialize(app_instance, opts = nil)
         @app = app_instance
@@ -25,19 +25,19 @@ module Middleman
       end
 
       def reporter_file_path
-        "#{@app.build_dir}/#{@options.reporter_file}"
+        "#{app.build_dir}/#{options.reporter_file}"
       end
 
       def reporter_extension_file_path
-        "#{@app.root}/.build_reporter.yml"
+        "#{app.root}/.build_reporter.yml"
       end
 
       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' => @options.version
+          'version' => options.version
         }.merge(details_extension)
       end
 

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

@@ -1,5 +1,5 @@
 module Middleman
   module BuildReporter
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

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

@@ -1,9 +1,10 @@
 require 'spec_helper'
 
 describe Middleman::BuildReporterExtension do
-  let(:app) { middleman_app('basic-app') }
 
-  let(:extension) { described_class.new(app) }
+  subject(:extension) { described_class.new(app) }
+
+  let(:app) { middleman_app('basic-app') }
 
   context 'its default options' do
 

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

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 describe Middleman::BuildReporter::Reporter do
 
+  subject(:reporter) do
+    described_class.new app, options
+  end
+
   let(:git_repo) { Git.open('.') }
 
   let(:fake_details) { { 'foo' => 'bar' } }
@@ -17,18 +21,24 @@ describe Middleman::BuildReporter::Reporter do
 
   let(:app) { middleman_app('basic-app') }
 
-  let(:reporter) do
-    described_class.new app, options
-  end
-
   describe '#new' do
 
     it 'sets an attr_accessor\'d @app instance variable to the value of the app it is passed' do
       expect(reporter.app).to eq app
     end
 
-    it 'sets a @repo on the reporter' do
-      expect(reporter.repo.class).to eq Git::Base
+    it 'sets the repo root' do
+      expect(reporter.repo.dir.path).to eq(Dir.pwd)
+    end
+
+    context 'when a repo root is not specified' do
+      let(:options) do
+        double('options', { repo_root: nil })
+      end
+
+      it 'sets the repo root to the app root' do
+        expect(reporter.repo.dir.path).to eq(app.root)
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'bundler/setup'
-require 'git'
 
 Bundler.require(:development)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-build-reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Mike Ball
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -262,4 +262,3 @@ test_files:
 - spec/middleman-build-reporter/extension_spec.rb
 - spec/middleman-build-reporter/reporter_spec.rb
 - spec/spec_helper.rb
-has_rdoc: