RubyGems - statusz - Versions diffs - 0.0.3 → 0.0.4 - Mend

statusz 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

data/README.md CHANGED Viewed

@@ -46,8 +46,15 @@ If you want statusz to write a plain text file or json instead of an html file,
 Statusz.write_file("statusz.txt", :format => :text)
 ```
+If you're deploying a commit other than HEAD of the current branch, you can give statusz a treeish
+identifying it (sha or symbolic ref):
+``` ruby
+Statusz.write_file("statusz.html", :commit => "HEAD~3")
+```
 If you want statusz to only write some of the fields (skip `commit_search` to save space -- this field
-contains every sha in your repo, so it can be kind of large):
+contains the sha of every ancestor of the latest commit in your repo, so it can be kind of large):
 ``` ruby
 Statusz.write_file("statusz.html", :fields => ["latest commit", "date", "git user info"])
@@ -57,11 +64,11 @@ Here are the possible fields -- by default, statusz will write them all:
 * `"git directory"` -- The name of the directory at the git root
 * `"latest commit"` -- The sha of the latest commit
-* `"current branch"` -- The name of the branch, if any, from which the deploy is being run
+* `"containing branches"` -- The name of the branches, if any, that contain the latest commit
 * `"date"` -- Timestamp
 * `"current user on deploy host"` -- The output of `whoami`
 * `"git user info"` -- The user name and email in git
-* `"all commits"` -- A list of all commits. In the html version, it's a search box.
+* `"all commits"` -- A list of all ancestors of the latest commit. In the html version, it's a search box.
 Finally, statusz can write out extra arbitrary fields if you want. Just attach a hash of objects that have
 meaningful `to_s` representations:
@@ -77,7 +84,7 @@ The only method provided by statusz is `Statusz.write_file(filename = "./statusz
 full list of possible `options`:
 * `:format` -- one of `:html`, `:text`, `:json` (defaults to `:html`).
-* `:fields` -- an array; some subset of `["git directory", "latest commit", "current branch", "date", "current
+* `:fields` -- an array; some subset of `["git directory", "latest commit", "containing branches", "date", "current
   user on deploy host", "git user info", "all commits"]` (defaults to the whole thing).
 * `:extra_fields` -- a hash of arbitrary keys and values that will be stringified. You can override values in
   `:fields` if you wish.

data/lib/statusz/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Statusz
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/statusz.erb CHANGED Viewed

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js" type="text/javascript"></script>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js" type="text/javascript"></script>
     <title>statusz</title>
     <style type="text/css">

data/lib/statusz.rb CHANGED Viewed

@@ -5,21 +5,21 @@ require "json"
 module Statusz
   FIELD_TO_SCRAPING_PROC = {
-    "git directory" => Proc.new { `git rev-parse --show-toplevel`.strip.rpartition("/").last },
-    "latest commit" => Proc.new { `git log --pretty=%H -n 1`.strip },
-    "current branch" => Proc.new do
-      branch = `git symbolic-ref HEAD 2> /dev/null`.strip.sub(%r{^refs/heads/}, "")
-      $?.to_i.zero? ? branch : "<no branch>"
+    "git directory" => Proc.new { |commit| `git rev-parse --show-toplevel`.strip.rpartition("/").last },
+    "latest commit" => Proc.new { |commit| `git log --pretty=%H #{commit} -n 1`.strip },
+    "containing branches" => Proc.new do |commit|
+      `git branch --contains #{commit}`.strip.gsub("* ", "").gsub("\n", ", ")
     end,
-    "date" => Proc.new { Time.now.strftime("%Y-%m-%d %H:%M:%S %z") },
-    "current user on deploy host" => Proc.new { `whoami`.strip },
-    "git user info" => Proc.new do
+    "date" => Proc.new { |commit| Time.now.strftime("%Y-%m-%d %H:%M:%S %z") },
+    "current user on deploy host" => Proc.new { |commit| `whoami`.strip },
+    "git user info" => Proc.new do |commit|
       "#{`git config --get user.name`.strip} <#{`git config --get user.email`.strip}>"
     end,
-    "all commits" => Proc.new { `git log --pretty=%H`.strip }
+    "all commits" => Proc.new { |commit| `git log --pretty=%H #{commit}`.strip }
   }
   def self.write_file(filename = "./statusz.html", options = {})
+    options[:commit] ||= "HEAD"
     options[:format] ||= :html
     raise "Bad format: #{options[:format]}" unless [:html, :text, :json].include? options[:format]
     options[:fields] ||= FIELD_TO_SCRAPING_PROC.keys
@@ -32,7 +32,7 @@ module Statusz
     results = {}
     options[:fields].each do |field|
-      results[field] = FIELD_TO_SCRAPING_PROC[field].call
+      results[field] = FIELD_TO_SCRAPING_PROC[field].call(options[:commit])
     end
     extra_fields.each { |field, value| results[field.to_s] = value.to_s }

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statusz
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000Z
+date: 2012-08-23 00:00:00.000000000Z
 dependencies: []
 description: statusz is a gem that writes out git metadata at deploy time.
 email:
@@ -52,3 +52,4 @@ signing_key:
 specification_version: 3
 summary: statusz is a gem that writes out git metadata at deploy time.
 test_files: []
+has_rdoc: