RubyGems - middleman-build-reporter - Versions diffs - 0.0.1 → 0.0.2 - Mend

middleman-build-reporter 0.0.1 → 0.0.2

Files changed (26) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b39877eb52f82b5dd645fa574f290dabbeda31ab
-  data.tar.gz: c4eda5340278dd8a1805c36c73b94cabdbd804be
+  metadata.gz: 7582879cb653cc74131e0ef87e4f1598aada2ab9
+  data.tar.gz: 10a658adb6abe171a25b7b5304476792d50156f9
 SHA512:
-  metadata.gz: 2fd1ef6f55335ae01ada5ec5015463e21c931c7d15a40bd5ed4ff05ba4c389043486a5df21e2db02891b8a6555fc70d9f8d1d6636ca0575ce1029667f6895ec5
-  data.tar.gz: bfb45f439283acac26763344244d6bfba9f530a2ad62ce1e3a1ef47f728194c134fa354483ca53cbef10e95ac7b06be569bc6bad3de3f4f819fdf5c2ac124aa9
+  metadata.gz: 7effe01a14c4a2d786a9876a9152f17999bd18e3f08d695a792bc6cdec68158d69918b54ec43410058f008501d0579a5d2d13730dc7682b359912cd5ca20425e
+  data.tar.gz: 2af823834b00d8b6b5955a4d3bb7b4001ec07b784f94cb48403dcbf0bbceca0691ed4b1050a9de14e3a13dac454fd026b787811dd5b1083bf6a7f313cd7ef5d7

data/.gitignore CHANGED Viewed

@@ -1,3 +1,4 @@
+pkg
 tmp
 Gemfile.lock
 coverage

data/README.md CHANGED Viewed

@@ -2,9 +2,12 @@
 # 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, and whether you're viewing cached or stale build artifacts.
-middleman-build-reporter helps you understand what code has been deployed to an environment.
+Features:
+1. Generate YAML and/or JSON files reporting build-time/version details for your [Middleman](http://middlemanapp.com) app.
+2. Fingerprint each Middleman HTML template with a `<!-- FINGERPRINT -->` comment surfacing build-time/version details.
 ## Output
@@ -30,6 +33,19 @@ The `build/build.json`:
 }
 ```
+middleman-build-reporter also offers a `build_reporter_fingerprint` helper to fingerprint HTML templates:
+```html
+<!--
+FINGERPRINT:
+---
+branch: master
+revision: c786c0addcde128a0823c40ebb4a3ab453411f10
+build_time: '2014-10-21 07:27:51 -0400'
+version: 1.2.3
+--!>
+```
 ## Usage
 In your `Gemfile`:
@@ -70,10 +86,41 @@ activate :build_reporter do |build|
   # optional; an array of desired build reporter file formats
   # supported formats: yaml, json
   # defaults to ['yaml']
-  build.reporter_file_formats = ['json', 'json']
+  build.reporter_file_formats = ['yaml', 'json']
 end
 ```
+## Fingerprinting you HTML templates
+Use the `build_reporter_fingerprint` to fingerprint your HTML templates with build/version details:
+Example usage in `layouts/layout.erb`:
+```html
+<body>
+  <h1>Some Site</h1>
+</body>
+<%= build_reporter_fingerprint %>
+```
+Example fingerprint HTML comment:
+```html
+<body>
+  <h1>Some Site</h1>
+</body>
+<!--
+FINGERPRINT:
+---
+branch: master
+revision: c786c0addcde128a0823c40ebb4a3ab453411f10
+build_time: '2014-10-21 07:27:51 -0400'
+version: 1.2.3
+--!>
+```
 ## Reporting additional custom build details
 Add any additional build details to a `.build_reporter.yml` file in your project's root.
@@ -87,6 +134,7 @@ The `.build_reporter.yml`:
 ```
 ---
 foo: 'bar'
+baz: 'bim'
 ```
 The output `build/build.yaml`:
@@ -97,15 +145,19 @@ revision: 244921c81c9e21a1973659df5f702937b91cfcd4
 build_time: 2014-09-20 10:50:55 -0400
 version: 1.2.3
 foo: bar
+baz: bim
 ```
 ### Example - using .build_reporter.yml to override built-in middleman-build-reporter details:
+The `.build_reporter.yml` file can also override the values set by `Middleman::BuildReporter::Reporter`.
 The `.build_reporter.yml`:
 ```
 ---
 revision: 'some_revision'
+build_time: 'some_other_time'
 ```
 The output `build/build.yaml`:
@@ -113,6 +165,6 @@ The output `build/build.yaml`:
 ```
 branch: master
 revision: some_revision
-build_time: 2014-09-20 10:50:55 -0400
+build_time: some_other_time
 version: 1.2.3
 ```

data/features/build_reporter.feature CHANGED Viewed

@@ -1,7 +1,8 @@
 Feature: Build reporter
   Scenario: build.yaml should report a branch
-    Given a successfully built app at "basic-app"
+    Given a fixture app "basic-app"
+    And a successfully built app at "basic-app"
     When I cd to "build"
     Then the file "build.yaml" should report the current branch

data/features/build_reporter_fingerprint_helper.feature ADDED Viewed

@@ -0,0 +1,6 @@
+Feature: Build reporter fingerprint helper
+  Scenario: the build reporter fingerprint should be written to the template
+    Given a successfully built app at "build-reporter-fingerprint"
+    When I cd to "build"
+    Then the file "index.html" should report the build fingerprint

data/features/step_definitions/build_reporter_fingerprint_steps.rb ADDED Viewed

@@ -0,0 +1,8 @@
+Then /the file "([^"]*)" should report the build fingerprint/ do |file|
+  prep_for_fs_check do
+    html = File.open(file).read
+    expect(html.include?("<!--\nFINGERPRINT:\n---\nbranch:")).to eq true
+  end
+end

data/fixtures/build-reporter-fingerprint/build/images/background.png ADDED Viewed

Binary file

data/fixtures/build-reporter-fingerprint/build/images/middleman.png ADDED Viewed

Binary file

data/fixtures/build-reporter-fingerprint/build/javascripts/all.js ADDED Viewed

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

data/fixtures/build-reporter-fingerprint/build/stylesheets/all.css ADDED Viewed

@@ -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);
+  }
+}

data/fixtures/build-reporter-fingerprint/build/stylesheets/normalize.css ADDED Viewed

@@ -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/fixtures/build-reporter-fingerprint/config.rb ADDED Viewed

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

data/fixtures/build-reporter-fingerprint/source/images/background.png ADDED Viewed

Binary file

data/fixtures/build-reporter-fingerprint/source/images/middleman.png ADDED Viewed

Binary file

data/fixtures/build-reporter-fingerprint/source/index.html.erb ADDED Viewed

@@ -0,0 +1,11 @@
+---
+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 -->
+  <%= build_reporter_fingerprint %>
+</div><!-- .welcome -->

data/fixtures/build-reporter-fingerprint/source/javascripts/all.js ADDED Viewed

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

data/fixtures/build-reporter-fingerprint/source/layouts/layout.erb ADDED Viewed

@@ -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/build-reporter-fingerprint/source/stylesheets/all.css ADDED Viewed

@@ -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);
+  }
+}