middleman-build-reporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b39877eb52f82b5dd645fa574f290dabbeda31ab
+  data.tar.gz: c4eda5340278dd8a1805c36c73b94cabdbd804be
+SHA512:
+  metadata.gz: 2fd1ef6f55335ae01ada5ec5015463e21c931c7d15a40bd5ed4ff05ba4c389043486a5df21e2db02891b8a6555fc70d9f8d1d6636ca0575ce1029667f6895ec5
+  data.tar.gz: bfb45f439283acac26763344244d6bfba9f530a2ad62ce1e3a1ef47f728194c134fa354483ca53cbef10e95ac7b06be569bc6bad3de3f4f819fdf5c2ac124aa9

data/.gitignore

@@ -0,0 +1,3 @@
+tmp
+Gemfile.lock
+coverage

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - '2.1.2'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,118 @@
+[![Build Status](https://travis-ci.org/mdb/middleman-build-reporter.svg?branch=master)](https://travis-ci.org/mdb/middleman-build-reporter)
+
+# middleman-build-reporter
+
+Fingerprint your [Middleman](http://middlemanapp.com) build with YAML and/or JSON files reporting build-time details.
+
+middleman-build-reporter helps you understand what code has been deployed to an environment.
+
+## Output
+
+middleman-build-reporter can output YAML and/or JSON:
+
+The `build/build.yaml`:
+
+```yaml
+branch: master
+revision: 244921c81c9e21a1973659df5f702937b91cfcd4
+build_time: 2014-09-20 10:50:55 -0400
+version: 1.2.3
+```
+
+The `build/build.json`:
+
+```json
+{
+  "branch": "master",
+  "revision": "244921c81c9e21a1973659df5f702937b91cfcd4",
+  "build_time": "2014-09-20 10:50:55 -0400",
+  "version": "1.2.3"
+}
+```
+
+## Usage
+
+In your `Gemfile`:
+
+```ruby
+gem 'middleman-build-reporter'
+```
+
+Install it:
+
+```bash
+$ bundle install
+```
+
+Activate it within your `config.rb`:
+
+```
+activate :build_reporter
+```
+
+Supported configuration
+
+```ruby
+activate :build_reporter do |build|
+  # optional; the path to your project repository root
+  # this must be absolute or relative from your build directory
+  # defaults to app root
+  build.repo_root = '../../../'
+
+  # optional; the version of your app
+  # defaults to ''
+  build.version = '1.2.3'
+
+  # optional; the build reporter file name
+  # defaults to 'build'
+  build.reporter_file = 'build'
+
+  # optional; an array of desired build reporter file formats
+  # supported formats: yaml, json
+  # defaults to ['yaml']
+  build.reporter_file_formats = ['json', 'json']
+end
+```
+
+## Reporting additional custom build details
+
+Add any additional build details to a `.build_reporter.yml` file in your project's root.
+
+The `.build_reporter.yml` can be produced as part of your app's build process, or manually managed.
+
+### Example - custom extended details:
+
+The `.build_reporter.yml`:
+
+```
+---
+foo: 'bar'
+```
+
+The output `build/build.yaml`:
+
+```
+branch: master
+revision: 244921c81c9e21a1973659df5f702937b91cfcd4
+build_time: 2014-09-20 10:50:55 -0400
+version: 1.2.3
+foo: bar
+```
+
+### Example - using .build_reporter.yml to override built-in middleman-build-reporter details:
+
+The `.build_reporter.yml`:
+
+```
+---
+revision: 'some_revision'
+```
+
+The output `build/build.yaml`:
+
+```
+branch: master
+revision: some_revision
+build_time: 2014-09-20 10:50:55 -0400
+version: 1.2.3
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+require 'rake/clean'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+RSpec::Core::RakeTask.new
+
+task default: [:spec, :cucumber]

data/features/build_reporter.feature

@@ -0,0 +1,21 @@
+Feature: Build reporter
+
+  Scenario: build.yaml should report a branch
+    Given a successfully built app at "basic-app"
+    When I cd to "build"
+    Then the file "build.yaml" should report the current branch
+
+  Scenario: build.yaml should report a revision
+    Given a successfully built app at "basic-app"
+    When I cd to "build"
+    Then the file "build.yaml" should report the current git revision
+
+  Scenario: build.yaml should report a build time
+    Given a successfully built app at "basic-app"
+    When I cd to "build"
+    Then the file "build.yaml" should report the build time
+
+  Scenario: build.yaml should report a version
+    Given a successfully built app at "basic-app"
+    When I cd to "build"
+    Then the file "build.yaml" should contain "version: 1.2.3"

data/features/custom_build_reporter_file_name.feature

@@ -0,0 +1,6 @@
+Feature: Custom build reporter file name declared in config.rb
+
+  Scenario: the build report should be written to the custom file name
+    Given a successfully built app at "custom-reporter-file-name"
+    When I cd to "build"
+    Then a file named "custom.yaml" should exist

data/features/extended_build_reporter.feature

@@ -0,0 +1,12 @@
+Feature: Extended build reporter details
+
+  Scenario: build.yaml should report the custom supplemental details
+    Given a successfully built app at "extended-build-reporter"
+    When I cd to "build"
+    Then the file "build.yaml" should contain "some_key: some value"
+    And the file "build.yaml" should contain "another_key: another value"
+
+  Scenario: build.yaml should override built-in details
+    Given a successfully built app at "extended-build-reporter"
+    When I cd to "build"
+    Then the file "build.yaml" should contain "version: 3.3.3"

data/features/json_build_reporter.feature

@@ -0,0 +1,21 @@
+Feature: JSON build reporter file
+
+  Scenario: build.json should report a branch
+    Given a successfully built app at "json-reporter-file"
+    When I cd to "build"
+    Then the JSON file "build.json" should report the current branch
+
+  Scenario: build.yaml should report a revision
+    Given a successfully built app at "json-reporter-file"
+    When I cd to "build"
+    Then the JSON file "build.json" should report the current git revision
+
+  Scenario: build.json should report a build time
+    Given a successfully built app at "json-reporter-file"
+    When I cd to "build"
+    Then the JSON file "build.json" should report the build time
+
+  Scenario: build.json should report a version
+    Given a successfully built app at "json-reporter-file"
+    When I cd to "build"
+    Then the JSON file "build.json" should report version "1.2.3"

data/features/no_explicit_version.feature

@@ -0,0 +1,6 @@
+Feature: No explicit version declared in the config
+
+  Scenario: build should report an empty version number
+    Given a successfully built app at "no-version"
+    When I cd to "build"
+    Then the file "build.yaml" should report an empty version

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,19 @@
+Then /the file "([^"]*)" should report the current branch/ do |file|
+  branch = Git.open('.').current_branch
+
+  prep_for_fs_check do
+    expect(YAML.load(File.read(file))['branch']).to eq branch
+  end
+end
+
+Then /the file "([^"]*)" should report the current git revision/ do |file|
+  partial_content = "revision: #{Git.open('.').log.first}"
+
+  check_file_content(file, partial_content, true)
+end
+
+Then /the file "([^"]*)" should report the build time/ do |file|
+  partial_content = "build_time: '#{Time.now.strftime('%Y-%m-%d %H:%M')}"
+
+  check_file_content(file, partial_content, true)
+end

data/features/step_definitions/json_reporter_file_steps.rb

@@ -0,0 +1,31 @@
+Then /the JSON file "([^"]*)" should report the current branch/ do |file|
+  prep_for_fs_check do
+    json = JSON.parse(File.open(file).read)
+
+    expect(json['branch']).to eq "#{Git.open(gem_root_relative_to_features).current_branch}"
+  end
+end
+
+Then /the JSON file "([^"]*)" should report the current git revision/ do |file|
+  prep_for_fs_check do
+    json = JSON.parse(File.open(file).read)
+
+    expect(json['revision']).to eq "#{Git.open(gem_root_relative_to_features).log.first}"
+  end
+end
+
+Then /the JSON file "([^"]*)" should report the build time/ do |file|
+  prep_for_fs_check do
+    json = JSON.parse(File.open(file).read)
+
+    expect(json['build_time']).to include "#{Time.now.strftime('%Y-%m-%d %H:%M')}"
+  end
+end
+
+Then /the JSON file "([^"]*)" should report version "([^"]*)"/ do |file, version|
+  prep_for_fs_check do
+    json = JSON.parse(File.open(file).read)
+
+    expect(json['version']).to eq version
+  end
+end

data/features/step_definitions/version_steps.rb

@@ -0,0 +1,5 @@
+Then /the file "([^"]*)" should report an empty version/ do |file|
+  partial_content = /version: ''$/
+
+  check_file_content(file, partial_content, true)
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+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-build-reporter')

data/features/support/helpers.rb

@@ -0,0 +1,7 @@
+module Helpers
+  def gem_root_relative_to_features
+    '../../../../'
+  end
+end
+
+World(Helpers)

data/fixtures/basic-app/config.rb

@@ -0,0 +1,4 @@
+activate :build_reporter do |build|
+  build.repo_root = '../../../'
+  build.version = '1.2.3'
+end

data/fixtures/basic-app/source/index.html.erb

@@ -0,0 +1,10 @@
+---
+title: Welcome to Middleman
+---
+
+<div class="welcome">
+  <h1>Middleman is Watching</h1>
+  <p class="doc">
+    <%= link_to "Read Online Documentation", "http://middlemanapp.com/" %>
+  </p><!-- .doc -->
+</div><!-- .welcome -->

data/fixtures/basic-app/source/javascripts/all.js

@@ -0,0 +1 @@
+//= require_tree .

data/fixtures/basic-app/source/layouts/layout.erb

@@ -0,0 +1,19 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    
+    <!-- Always force latest IE rendering engine or request Chrome Frame -->
+    <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
+    
+    <!-- Use title if it's in the page YAML frontmatter -->
+    <title><%= current_page.data.title || "The Middleman" %></title>
+    
+    <%= stylesheet_link_tag "normalize", "all" %>
+    <%= javascript_include_tag  "all" %>
+  </head>
+  
+  <body class="<%= page_classes %>">
+    <%= yield %>
+  </body>
+</html>

data/fixtures/basic-app/source/stylesheets/all.css

@@ -0,0 +1,55 @@
+@charset "utf-8";
+
+body {
+  background: #d4d4d4 url("../images/background.png");
+  text-align: center;
+  font-family: sans-serif; }
+
+h1 {
+  color: rgba(0, 0, 0, .3);
+  font-weight: bold;
+  font-size: 32px;
+  letter-spacing: -1px;
+  text-transform: uppercase;
+  text-shadow: 0 1px 0 rgba(255, 255, 255, .5);
+  background: url("../images/middleman.png") no-repeat center 100px;
+  padding: 350px 0 10px;
+  margin: 0; }
+
+.doc {
+  font-size: 14px;
+  margin: 0; }
+  .doc:before,
+  .doc:after {
+    opacity: .2;
+    padding: 6px;
+    font-style: normal;
+    position: relative;
+    content: "•"; }
+  .doc a {
+    color: rgba(0, 0, 0, 0.3); }
+    .doc a:hover {
+      color: #666; }
+
+.welcome {
+  -webkit-animation-name: welcome;
+  -webkit-animation-duration: .9s; }
+
+@-webkit-keyframes welcome {
+  from {
+    -webkit-transform: scale(0);
+    opacity: 0;
+  }
+  50% {
+   -webkit-transform: scale(0);
+   opacity: 0;
+  }
+  82.5% {
+    -webkit-transform: scale(1.03);
+    -webkit-animation-timing-function: ease-out;
+    opacity: 1;
+  }
+  to {
+    -webkit-transform: scale(1);
+  }
+}