barkeep 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 PatientsLikeMe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,92 @@
+= Barkeep
+
+Barkeep is an extensible developer's status bar to track your current deployed
+commit and more.  Barkeep sits at the bottom of your app and shows information
+you deem useful.
+
+Here's an example of Barkeep running with some default panes:
+
+http://i.imgur.com/0TTHX.png
+
+== Install
+
+* Install and require gem (add it to your Gemfile or your environment.rb file).
+* include Barkeep in your ApplicationHelper, i.e.
+
+    module ApplicationHelper
+      include Barkeep
+      ...
+    end
+
+* add the barkeep styles in your layout header, i.e
+
+    <%= barkeep_styles unless %W(test production).include?(Rails.env) %>
+
+* call render_barkeep from your layout or footer, i.e.
+
+    <%= render_barkeep unless %W(test production).include?(Rails.env) %>
+
+* Create a config file in config/barkeep.json (see example below)
+
+== Config
+
+Configuration is specified in a config/barkeep.json
+
+You want to specify some panes and a github url.  Here is a config with all the
+default panes:
+
+  {
+    "panes" : [
+      "branch_info",
+      "commit_sha_info",
+      "commit_author_info",
+      "commit_date_info",
+      "rpm_request_info"
+    ],
+    "github_url" : "https://github.com/USER_OR_ORGANIZATION/PROJECT_NAME"
+  }
+
+Panes are rendered in the order specified in the array.  You can specify as
+many panes as you wish.
+
+Panes are assumed to either be methods accessible in the context of your
+ApplicationHelper.  Alternatively, you can specify a partial as a pane using
+the format "partial path/to/your/partial"
+
+== Custom Styling
+
+Barkeep comes with some basic styling that has worked well for us.  You are
+encouraged to modify it to suit your needs.  The easiest way to do this is to
+call barkeep_styles as normal, view source, and extract the css (search for
+barkeep).  You can then pull it in to your main stylesheet or Sass-ify it, etc.
+
+Once you've setup your own styles, you probably won't want to call
+barkeep_styles anymore.
+
+== Included panes
+
+* branch_info: shows the current branch and links to the branch on github
+* commit_sha_info: shows the current commit sha and links to the commit on
+  github (useful when testing on stage for knowing what is depolyed)
+* commit_author_info: show the author of the current commit
+* commit_date_info: show the date of the current commit (hover for full
+  timestamp)
+* rpm_request_info: if you're using the newrelic gem in development mode, this
+  provides a link to the development newerelic index and a link to the current
+  request profiled in newrelic
+
+== Contributing to Barkeep
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 PatientsLikeMe. See LICENSE.txt for
+further details.
+

data/lib/barkeep.rb

@@ -0,0 +1,91 @@
+require 'json'
+require 'grit_wrapper'
+
+module Barkeep
+  def barkeep_styles
+    content_tag(:style, File.read(File.expand_path(File.dirname(__FILE__) + "/default.css")))
+  end
+
+  def render_barkeep
+    return unless grit_info.repository?
+
+    content_tag(:dl, :id => 'barkeep') do
+      barkeep_config['panes'].map do |name|
+        if name =~ /^(p|partial) (.*)/
+          render :partial => $2
+        else
+          send(name)
+        end
+      end <<
+      content_tag(:dd, :class => 'close') do
+        content_tag(:a, "&times;", :href => '#', :onclick => "c = document.getElementById('barkeep'); c.parentNode.removeChild(c); return false", :title => 'Close me!')
+      end
+    end
+  end
+
+  def barkeep_config
+    @@barkeep_config ||= JSON.parse(File.read("#{Rails.root}/config/barkeep.json"))
+  end
+
+  def branch_info
+    content_tag(:dt, 'Branch:') +
+      content_tag(:dd, content_tag(:a, grit_info[:branch], branch_link_attributes))
+  end
+
+  def commit_sha_info
+    content_tag(:dt, 'Commit:') +
+      content_tag(:dd, content_tag(:a, grit_info[:commit].try(:slice, 0,8), commit_link_attributes))
+  end
+
+  def commit_author_info
+    content_tag(:dt, 'Who:') + content_tag(:dd, grit_info[:last_author])
+  end
+
+  def commit_date_info
+    content_tag(:dt, 'When:') + content_tag(:dd, grit_info[:date].try(:to_s, :short), :title => grit_info[:date].to_s)
+  end
+
+  def rpm_request_info
+    if rpm_enabled?
+      content_tag(:dt, link_to('RPM', '/newrelic', :target => 'blank') + ':') <<
+        content_tag(:dd, link_to('request', rpm_url, :target => 'blank'))
+    end
+  end
+
+  def github_url
+    barkeep_config['github_url']
+  end
+
+  def grit_info
+    GritWrapper.instance
+  end
+
+  def branch_link_attributes
+    {
+      :href => "#{github_url}/tree/#{grit_info[:branch]}",
+      :title => grit_info[:message]
+    }
+  end
+
+  def commit_link_attributes
+    {
+      :href => "#{github_url}/commit/#{grit_info[:commit]}",
+      :title => "committed #{grit_info[:date]}"
+    }
+  end
+
+  def rpm_enabled?
+    if defined?(NewRelic)
+      if defined?(NewRelic::Control)
+        !NewRelic::Control.instance['skip_developer_route']
+      else
+        !NewRelic::Config.instance['skip_developer_route']
+      end
+    end
+  end
+
+  def rpm_url
+    rpm_id = NewRelic::Agent.instance.transaction_sampler.current_sample_id
+    "/newrelic/show_sample_detail/#{rpm_id}"
+  end
+end

data/lib/default.css

@@ -0,0 +1,11 @@
+#barkeep { margin: 0; padding: 0; background: #ffffcc; border: 1px solid #cccccc; bottom: 0; font-size: 11px; left: 0; position: fixed; -moz-opacity: 0.7; -khtml-opacity: 0.7; -o-opacity: 0.7; -webkit-opacity: 0.7; opacity: 0.7; *filter: alpha(opacity=70); width: 100%; z-index: 5000; }
+* html #barkeep { postion: absolute; width: 99%; }
+#barkeep dt, #barkeep dd { display: inline-block; list-style-type: none; margin: 0; font-size: 100%; font-family: Helvetica, Monaco, "Gill Sans", monospace; line-height: 2; padding: 0 0.5em 0 0.5em; }
+* html #barkeep dt, * html #barkeep dd { zoom: 1; display: inline; }
+html[lang~=en] #barkeep dt, html[lang~=en] #barkeep dd { display: inline; }
+html[lang~=EN] #barkeep dt, html[lang~=EN] #barkeep dd { display: -moz-inline-box; display: inline-block; }
+#barkeep dt { border-left: 1px solid #cccccc; }
+#barkeep dd { color: black; }
+#barkeep dd.close { position: absolute; right: 0; top: 0; }
+#barkeep form { margin: 0; }
+#barkeep select { font-family: Helvetica, Monaco, "Gill Sans", monospace; }

data/lib/grit_wrapper.rb

@@ -0,0 +1,51 @@
+require 'grit'
+
+# A singleton refreshes on every request in development but
+# caches in environments where class caching is enabled.
+require 'singleton'
+
+class GritWrapper
+  include Singleton
+
+  def repository
+    @repository ||= Grit::Repo.new(Rails.root)
+  rescue Grit::InvalidGitRepositoryError
+    # not in a directory that contains .git
+    @repository = :invalid
+  end
+
+  def repository?
+    !repository.nil? && repository != :invalid
+  end
+
+  def head
+    @head ||= repository.head
+  end
+
+  def last_commit_hash
+    @last_commit_hash ||= head.commit.to_s
+  end
+
+  def last_commit
+    @last_commit ||= repository.commit(last_commit_hash)
+  end
+
+  def to_hash
+    return {
+      :branch => 'Not currently on a branch.',
+      :commit => (File.read(Rails.root + "/REVISION").strip rescue nil)
+    } if head.nil?
+
+    @hash ||= {
+      :branch => head.name,
+      :commit => last_commit_hash,
+      :last_author => last_commit.try(:author),
+      :message => last_commit.try(:message),
+      :date => last_commit.try(:authored_date)
+    }
+  end
+
+  def [](key)
+    to_hash[key]
+  end
+end

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'active_support'
+require 'action_pack'
+require 'action_view'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'barkeep'
+
+class Test::Unit::TestCase
+end

data/test/test_barkeep.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestBarkeep < Test::Unit::TestCase
+  include ActionView::Helpers
+  include Barkeep
+
+  attr_accessor :output_buffer
+
+  should "render a style tag filled with css" do
+    css = File.read(File.expand_path(File.dirname(__FILE__) + "/../lib/default.css"))
+    assert_equal "<style>#{css}</style>", barkeep_styles
+  end
+
+  should "render the barkeep bar" do
+    stubs(:barkeep_config => {'github_url' => 'http://github.com/project_name', 'panes' => ['branch_info', 'commit_sha_info']})
+    GritWrapper.instance.stubs(:repository? => true, :to_hash => {:branch => 'new_branch', :commit => 'abcdef'})
+    expected = %(
+      <dl id="barkeep">
+        <dt>Branch:</dt>
+        <dd><a href="http://github.com/project_name/tree/new_branch">new_branch</a></dd>
+        <dt>Commit:</dt>
+        <dd><a href="http://github.com/project_name/commit/abcdef" title="committed ">abcdef</a></dd>
+        <dd class="close"><a href="#" onclick="c = document.getElementById('barkeep'); c.parentNode.removeChild(c); return false" title="Close me!">&times;</a></dd>
+      </dl>
+    )
+    assert_equal expected.gsub(/\n\s+/, ''), render_barkeep
+  end
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification 
+name: barkeep
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- PatientsLikeMe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 3
+        - 11
+        version: 2.3.11
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: an extensible developer's status bar to track your current deployed commit & more
+email: open_source@patientslikeme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/barkeep.rb
+- lib/default.css
+- lib/grit_wrapper.rb
+- LICENSE.txt
+- README.rdoc
+- test/helper.rb
+- test/test_barkeep.rb
+has_rdoc: true
+homepage: https://github.com/patientslikeme/barkeep
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: an extensible developer's status bar to track your current deployed commit & more
+test_files: 
+- test/helper.rb
+- test/test_barkeep.rb