barkeep 0.1.1 → 0.2.1

data/README.rdoc

@@ -10,7 +10,12 @@ http://i.imgur.com/0TTHX.png
 
 == Install
 
+=== Gem Installation
+
 * Install and require gem (add it to your Gemfile or your environment.rb file).
+
+=== Application Setup
+
 * in Rails, include Barkeep in your ApplicationHelper, i.e.
 
     module ApplicationHelper
@@ -22,18 +27,24 @@ http://i.imgur.com/0TTHX.png
 
     helpers Barkeep
 
-* add the barkeep styles in your layout header, i.e
+* add the barkeep styles in your layout header. This bypasses the assets pipeline. But that is OK,
+because you don't want this in your pipeline in production.
 
-    <%= barkeep_styles %>
+    <%= barkeep.styles %>
 
-* call render_barkeep from your layout or footer, i.e.
+* call barkeep.render from your layout or footer, i.e.
 
-    <%= render_barkeep %>
+    <%= barkeep.render %>
 
 * 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)
 
+=== Rails 2
+
+If you are stuck in Rails 2, version 0.1.1 of Barkeep should work for you. Note that some of the installation options are
+different in Rails 2. Check the README in that version for more details.
+
 == Config
 
 Configuration is specified in a config/barkeep.json
@@ -64,11 +75,11 @@ the format "partial path/to/your/partial"
 
 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
+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.
+barkeep.styles anymore.
 
 == Included panes
 

data/lib/barkeep.rb

@@ -2,27 +2,40 @@ require 'json'
 require 'grit_wrapper'
 
 module Barkeep
-  def load_barkeep?
+
+  def barkeep
+    @@barkeep ||= Barkeeper.new
+  end
+
+end
+
+class Barkeeper
+
+  def config
+    @config ||= JSON.parse(File.read("config/barkeep.json"))
+  end
+
+  def load?
     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)
+    config['environments'].include?(this_env.to_s)
   end
 
-  def barkeep_styles
-    return unless load_barkeep?
+  def styles
+    return unless load?
     %(<style>#{File.read(File.expand_path(File.dirname(__FILE__) + "/default.css"))}</style>)
   end
 
-  def render_barkeep
-    return unless load_barkeep? && grit_info.repository?
+  def render
+    return unless load? && grit_info.repository?
 
     %(
       <dl id="barkeep">
       #{
-        barkeep_config['panes'].map do |name|
+        config['panes'].map do |name|
           if name =~ /^(p|partial) (.*)/
             render :partial => $2
           else
@@ -34,11 +47,7 @@ module Barkeep
         <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("config/barkeep.json"))
+    ).html_safe
   end
 
   def branch_info
@@ -65,7 +74,7 @@ module Barkeep
   end
 
   def github_url
-    barkeep_config['github_url']
+    config['github_url']
   end
 
   def grit_info
@@ -82,7 +91,7 @@ module Barkeep
   def commit_link_attributes
     {
       :href => "#{github_url}/commit/#{grit_info[:commit]}",
-      :title => "committed #{grit_info[:date]}"
+      :title => "committed #{grit_info[:date]} by #{grit_info[:last_author]}"
     }
   end
 

data/test/test_barkeep.rb

@@ -6,26 +6,37 @@ class TestBarkeep < Test::Unit::TestCase
   attr_accessor :output_buffer
 
   def setup
-    stubs(:load_barkeep? => true)
+    @barkeep = barkeep
+    @barkeep.stubs({
+      :config => {'github_url' => 'http://github.com/project_name', 'panes' => ['branch_info', 'commit_sha_info'], 'environments' => ['development']},
+      :load? => 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
+    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'], 'environments' => ['development']})
-    GritWrapper.instance.stubs(:repository? => true, :to_hash => {:branch => 'new_branch', :commit => 'abcdef'})
+    GritWrapper.instance.stubs(:repository? => true, :to_hash => {:branch => 'new_branch', :commit => 'abcdef', :last_author => 'Johnny', :date => '2/11/2012'})
     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><a href="http://github.com/project_name/commit/abcdef" title="committed 2/11/2012 by Johnny">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(/\s+/, ''), render_barkeep.gsub(/\s+/, '')
+    assert_equal expected.gsub(/\s+/, ''), barkeep.render.gsub(/\s+/, '')
   end
 end
+
+# Stub out html_safe, we don't need to test that here.
+class String
+  def html_safe
+    self
+  end
+end
+

metadata

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