statusz 0.0.2 → 0.0.3

data/README.md

@@ -27,7 +27,7 @@ Usage
 ``` ruby
 # Somewhere in your deploy scripts, probably where you stage the files before you rsync them:
 require "statusz"
-Statusz.write_git_metadata("#{your_staging_root}/statusz.html")
+Statusz.write_file("#{your_staging_root}/statusz.html")
 ```
 
 Now you can serve up the file from your webserver however you like. If you have a public folder, you can drop
@@ -40,28 +40,47 @@ get "/statusz" do
 end
 ```
 
-If you want statusz to write a plain text file instead of an html file, you can do that:
+If you want statusz to write a plain text file or json instead of an html file, you can do that:
 
 ``` ruby
-Statusz.write_git_metadata("statusz.txt", :format => :text)
+Statusz.write_file("statusz.txt", :format => :text)
 ```
 
 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):
 
 ``` ruby
-Statusz.write_git_metadata("statusz.html", :fields => ["latest_sha", "date", "username"])
+Statusz.write_file("statusz.html", :fields => ["latest commit", "date", "git user info"])
 ```
 
 Here are the possible fields -- by default, statusz will write them all:
 
-* `git_directory` -- The name of the directory at the git root
-* `latest_sha` -- The sha of the latest commit
-* `current_branch` -- The name of the branch, if any, from which the deploy is being run
-* `date` -- Timestamp
-* `username` -- The output of `whoami`
-* `git_user_info` -- The user name and email in git
-* `commit_search` -- A list of all commits. In the html version, it's a search box.
+* `"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
+* `"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.
+
+Finally, statusz can write out extra arbitrary fields if you want. Just attach a hash of objects that have
+meaningful `to_s` representations:
+
+``` ruby
+Statusz.write_file("statusz.html", :extra_fields => { "database host" => "dbslave3.example.com" })
+```
+
+Options
+-------
+
+The only method provided by statusz is `Statusz.write_file(filename = "./statusz.html", options)`. Here is a
+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
+  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.
 
 Screenshot
 ----------
@@ -72,4 +91,3 @@ TODO
 ----
 
 * Call via command-line script? Useful if doing a non-ruby deploy.
-* Other formats? (JSON?)

data/lib/statusz/version.rb

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

data/lib/statusz.erb

@@ -129,22 +129,24 @@
         <% end %>
       </table>
 
-      <script type="text/javascript">
-        allCommits = [<%= html_values["all commits"].map { |sha| %Q{"#{sha}"} }.join(",") %>]
-      </script>
+      <% if html_values["all commits"] %>
+        <script type="text/javascript">
+          allCommits = [<%= html_values["all commits"].map { |sha| %Q{"#{sha}"} }.join(",") %>]
+        </script>
 
-      <table id="commit_search">
-        <tr>
-          <td>search for a commit:</td>
-          <td>
-            <input name="sha" onkeyup="commitSearch(this, event);" size="40" type="text" value="" />
-          </td>
-        </tr>
-        <tr>
-          <td>matches:</td>
-          <td id="search_results"></td>
-        </tr>
-      </table>
+        <table id="commit_search">
+          <tr>
+            <td>search for a commit:</td>
+            <td>
+              <input name="sha" onkeyup="commitSearch(this, event);" size="40" type="text" value="" />
+            </td>
+          </tr>
+          <tr>
+            <td>matches:</td>
+            <td id="search_results"></td>
+          </tr>
+        </table>
+      <% end %>
     </div>
   </body>
 </html>

data/lib/statusz.rb

@@ -1,58 +1,50 @@
 require "cgi"
 require "erb"
 require "time"
+require "json"
 
 module Statusz
-  ALL_FIELDS = %w(git_directory latest_sha current_branch date username git_user_info commit_search)
-
   FIELD_TO_SCRAPING_PROC = {
-    "git_directory" => Proc.new { `git rev-parse --show-toplevel`.strip.rpartition("/").last },
-    "latest_sha" => Proc.new { `git log --pretty=%H -n 1`.strip },
-    "current_branch" => Proc.new do
+    "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>"
     end,
     "date" => Proc.new { Time.now.strftime("%Y-%m-%d %H:%M:%S %z") },
-    "username" => Proc.new { `whoami`.strip },
-    "git_user_info" => Proc.new do
+    "current user on deploy host" => Proc.new { `whoami`.strip },
+    "git user info" => Proc.new do
       "#{`git config --get user.name`.strip} <#{`git config --get user.email`.strip}>"
     end,
-    "commit_search" => Proc.new { `git log --pretty=%H`.strip }
-  }
-
-  FIELD_TO_HEADER_NAME = {
-    "git_directory" => "git directory",
-    "latest_sha" => "latest commit",
-    "current_branch" => "current branch",
-    "date" => "date",
-    "username" => "current user on deploy host",
-    "git_user_info" => "git user info",
-    "commit_search" => "all commits"
+    "all commits" => Proc.new { `git log --pretty=%H`.strip }
   }
 
-  def self.write_git_metadata(filename = "./statusz.html", options = {})
+  def self.write_file(filename = "./statusz.html", options = {})
     options[:format] ||= :html
-    raise "Bad format: #{options[:format]}" unless [:html, :text].include? options[:format]
-    options[:fields] ||= ALL_FIELDS
-    bad_options = options[:fields] - ALL_FIELDS
+    raise "Bad format: #{options[:format]}" unless [:html, :text, :json].include? options[:format]
+    options[:fields] ||= FIELD_TO_SCRAPING_PROC.keys
+    bad_options = options[:fields] - FIELD_TO_SCRAPING_PROC.keys
     raise "Bad options: #{bad_options.inspect}" unless bad_options.empty?
+    extra_fields = options[:extra_fields] || {}
+    unless extra_fields.is_a? Hash
+      raise "Extra fields should be a hash, but #{extra_fields.inspect} (#{extra_fields.class}) was given."
+    end
 
     results = {}
-    options[:fields].each { |field| results[field] = FIELD_TO_SCRAPING_PROC[field].call }
+    options[:fields].each do |field|
+      results[field] = FIELD_TO_SCRAPING_PROC[field].call
+    end
+    extra_fields.each { |field, value| results[field.to_s] = value.to_s }
 
     case options[:format]
     when :text
-      sections = options[:fields].map do |field|
-        "#{FIELD_TO_HEADER_NAME[field]}:\n#{results[field]}"
-      end
-      output = sections.join("\n\n")
+      output = results.map { |name, value| "#{name}:\n#{value}" }.join("\n\n")
+    when :json
+      output = results.to_json
     when :html
-      html_values = options[:fields].reduce({}) do |hash, field|
-        if field == "commit_search"
-          pair = { FIELD_TO_HEADER_NAME[field] => FIELD_TO_SCRAPING_PROC[field].call.split("\n") }
-        else
-          pair = { FIELD_TO_HEADER_NAME[field] => CGI.escapeHTML(FIELD_TO_SCRAPING_PROC[field].call) }
-        end
+      html_values = results.reduce({}) do |hash, field_and_value|
+        field, value = field_and_value
+        pair = (field == "all commits") ? { field => value.split("\n") } : { field => CGI.escapeHTML(value) }
         hash.merge pair
       end
       output = ERB.new(File.read(File.join(File.dirname(__FILE__), "statusz.erb"))).result(binding)

data/statusz.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["cespare@gmail.com"]
   gem.description   = "statusz is a gem that writes out git metadata at deploy time."
   gem.summary       = "statusz is a gem that writes out git metadata at deploy time."
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/ooyala/statusz"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statusz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -27,7 +27,7 @@ files:
 - lib/statusz.rb
 - lib/statusz/version.rb
 - statusz.gemspec
-homepage: ''
+homepage: https://github.com/ooyala/statusz
 licenses: []
 post_install_message: 
 rdoc_options: []