barkeep 0.1.0 → 0.1.1

data/README.rdoc

@@ -11,20 +11,26 @@ 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.
+* in Rails, include Barkeep in your ApplicationHelper, i.e.
 
     module ApplicationHelper
       include Barkeep
       ...
     end
 
+* in Sinatra, include Barkeep as a helper in your main app file, i.e.
+
+    helpers Barkeep
+
 * add the barkeep styles in your layout header, i.e
 
-    <%= barkeep_styles unless %W(test production).include?(Rails.env) %>
+    <%= barkeep_styles %>
 
 * call render_barkeep from your layout or footer, i.e.
 
-    <%= render_barkeep unless %W(test production).include?(Rails.env) %>
+    <%= render_barkeep %>
+
+* These two methods will return an empty string unless the app is running under one of the environments specified in your config file
 
 * Create a config file in config/barkeep.json (see example below)
 
@@ -32,8 +38,8 @@ http://i.imgur.com/0TTHX.png
 
 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:
+You want to specify some panes, a github url, and the environments in which you
+want to render Barkeep.  Here is a config with all the default panes:
 
   {
     "panes" : [
@@ -43,7 +49,8 @@ default panes:
       "commit_date_info",
       "rpm_request_info"
     ],
-    "github_url" : "https://github.com/USER_OR_ORGANIZATION/PROJECT_NAME"
+    "github_url" : "https://github.com/USER_OR_ORGANIZATION/PROJECT_NAME",
+    "environments" : ["development", "stage"]
   }
 
 Panes are rendered in the order specified in the array.  You can specify as

data/lib/barkeep.rb

@@ -2,53 +2,65 @@ require 'json'
 require 'grit_wrapper'
 
 module Barkeep
+  def load_barkeep?
+    if defined?(Rails)
+      this_env = Rails.env
+    elsif defined?(Sinatra)
+      this_env = Sinatra::Application.settings.environment
+    end
+    barkeep_config['environments'].include?(this_env.to_s)
+  end
+
   def barkeep_styles
-    content_tag(:style, File.read(File.expand_path(File.dirname(__FILE__) + "/default.css")))
+    return unless load_barkeep?
+    %(<style>#{File.read(File.expand_path(File.dirname(__FILE__) + "/default.css"))}</style>)
   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
+    return unless load_barkeep? && grit_info.repository?
+
+    %(
+      <dl id="barkeep">
+      #{
+        barkeep_config['panes'].map do |name|
+          if name =~ /^(p|partial) (.*)/
+            render :partial => $2
+          else
+            send(name)
+          end
+        end.join('')
+      }
+      <dd class="close">
+        <a href="#" onclick="c = document.getElementById('barkeep'); c.parentNode.removeChild(c); return false" title="Close me!">&times;</a>
+      </dd>
+      </dl>
+    )
   end
 
   def barkeep_config
-    @@barkeep_config ||= JSON.parse(File.read("#{Rails.root}/config/barkeep.json"))
+    @@barkeep_config ||= JSON.parse(File.read("config/barkeep.json"))
   end
 
   def branch_info
-    content_tag(:dt, 'Branch:') +
-      content_tag(:dd, content_tag(:a, grit_info[:branch], branch_link_attributes))
+    %(<dt>Branch:</dt><dd><a href="#{branch_link_attributes[:href]}">#{grit_info[:branch]}</a></dd>)
   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))
+    %(<dt>Commit:</dt><dd><a href="#{commit_link_attributes[:href]}" title="#{commit_link_attributes[:title]}">#{(grit_info[:commit] || "").slice(0,8)}</a></dd>)
   end
 
   def commit_author_info
-    content_tag(:dt, 'Who:') + content_tag(:dd, grit_info[:last_author])
+    %(<dt>Who:</dt><dd>#{grit_info[:last_author]}</dd>)
   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)
+    short_date = (grit_info[:date].respond_to?(:strftime) ? grit_info[:date].strftime("%d %B, %H:%M") : short_date.to_s)
+    %(<dt>When:</dt><dd title="#{grit_info[:date].to_s}">#{short_date}</dd>)
   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'))
+      %(<dt><a href="/newrelic">RPM:</a></dt><dd><a href="#{rpm_url}">request</a></dd>)
     end
   end
 
@@ -84,8 +96,11 @@ module Barkeep
     end
   end
 
+  def rpm_sample_id
+    NewRelic::Agent.instance.transaction_sampler.current_sample_id
+  end
+
   def rpm_url
-    rpm_id = NewRelic::Agent.instance.transaction_sampler.current_sample_id
-    "/newrelic/show_sample_detail/#{rpm_id}"
+    "/newrelic/show_sample_detail/#{rpm_sample_id}"
   end
 end

data/lib/grit_wrapper.rb

@@ -3,12 +3,13 @@ require 'grit'
 # A singleton refreshes on every request in development but
 # caches in environments where class caching is enabled.
 require 'singleton'
+require 'ostruct'
 
 class GritWrapper
   include Singleton
 
   def repository
-    @repository ||= Grit::Repo.new(Rails.root)
+    @repository ||= Grit::Repo.new('.')
   rescue Grit::InvalidGitRepositoryError
     # not in a directory that contains .git
     @repository = :invalid
@@ -27,21 +28,21 @@ class GritWrapper
   end
 
   def last_commit
-    @last_commit ||= repository.commit(last_commit_hash)
+    @last_commit ||= repository.commit(last_commit_hash) || OpenStruct.new
   end
 
   def to_hash
     return {
       :branch => 'Not currently on a branch.',
-      :commit => (File.read(Rails.root + "/REVISION").strip rescue nil)
+      :commit => (File.read("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)
+      :last_author => last_commit.author,
+      :message => last_commit.message,
+      :date => last_commit.authored_date
     }
   end
 

data/test/helper.rb

@@ -10,9 +10,6 @@ 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__))

data/test/test_barkeep.rb

@@ -1,18 +1,21 @@
 require 'helper'
 
 class TestBarkeep < Test::Unit::TestCase
-  include ActionView::Helpers
   include Barkeep
 
   attr_accessor :output_buffer
 
+  def setup
+    stubs(:load_barkeep? => true)
+  end
+
   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']})
+    stubs(:barkeep_config => {'github_url' => 'http://github.com/project_name', 'panes' => ['branch_info', 'commit_sha_info'], 'environments' => ['development']})
     GritWrapper.instance.stubs(:repository? => true, :to_hash => {:branch => 'new_branch', :commit => 'abcdef'})
     expected = %(
       <dl id="barkeep">
@@ -23,6 +26,6 @@ class TestBarkeep < Test::Unit::TestCase
         <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
+    assert_equal expected.gsub(/\s+/, ''), render_barkeep.gsub(/\s+/, '')
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: barkeep
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - PatientsLikeMe
@@ -15,13 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-20 00:00:00 -04:00
+date: 2011-10-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: grit
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,11 +31,11 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id001
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,43 +45,11 @@ dependencies:
         - 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
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -93,11 +61,11 @@ dependencies:
         - 12
         version: 0.9.12
   type: :development
-  version_requirements: *id005
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -107,11 +75,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -123,11 +91,11 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
-  version_requirements: *id007
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   name: jeweler
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -139,11 +107,11 @@ dependencies:
         - 2
         version: 1.5.2
   type: :development
-  version_requirements: *id008
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -153,7 +121,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id009
+  requirement: *id007
 description: an extensible developer's status bar to track your current deployed commit & more
 email: open_source@patientslikeme.com
 executables: []