whereuat 0.0.10 → 0.0.11

data/{README.rdoc → README.md}

@@ -1,48 +1,54 @@
-= whereuat
+# whereuat
 
 Adds a slide out panel to your rails app that directs clients to test stories that have been marked as 'delivered' in Pivotal Tracker.
 
-== Installing
+![whereuat demo](http://img.skitch.com/20100806-gug4f5uapk6ixh64sk16qenf9s.jpg)
+
+## Installing
 
 Add whereuat to your Gemfile:
 
-  gem 'whereuat'
+    gem 'whereuat'
 
 Create an initializer to add the Whereuat::RackApp to your middleware stack and configure your pivotal tracker api token and project id:
 
-  require 'whereuat'
-  Rails.configuration.middleware.use(Whereuat::RackApp)
+    require 'whereuat'
 
-  Whereuat.configure do |config|
-    config.pivotal_tracker_token   = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-    config.pivotal_tracker_project = 123456
-  end
+    Whereuat.configure do |config|
+      config.pivotal_tracker_token   = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+      config.pivotal_tracker_project = 123456
+    end
 
 Use the following helper somewhere in your application layout (we recommend at the end of the body):
 
-  = whereuat
+    = whereuat
+
+If you're using Rails 3, tell it the HTML is safe
+
+    = whereuat.html_safe
+
+The helper will insert a smidgeon of javascript that will add a tiny tab on the LHS of each page.
 
-The helper will insert a smidgeon of javascript (jquery & jquery.ui are assumed to be available) that will add a tiny tab on the LHS 
-of each page.
+**Please note** that whereuat requires `jQuery` to be included in your layout or templates already.
 
 Reload a page from your app and give it a whirl.
 
-== Note on Patches/Pull Requests
+## Note on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Contributors
+## Contributors
 
 * Ben Askins
 * Lachie Cox
 * Ben Webster
+* Daniel Neighman
 
-== Copyright
+## Copyright
 
 Copyright (c) 2010 Plus2. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/whereuat.rb

@@ -1,8 +1,7 @@
 require 'whereuat/configuration'
 require 'whereuat/rack_app'
 require 'whereuat/helpers'
-
-ActionView::Base.send :include, Whereuat::Helpers
+require 'whereuat/rails' if defined?(Rails)
 
 module Whereuat
   class << self

data/lib/whereuat/rack_app.rb

@@ -10,12 +10,12 @@ module Whereuat
 
     def initialize(app)
       @app             = app
-      PT::Client.token = config.pivotal_tracker_token 
+      PT::Client.token = config.pivotal_tracker_token
     end
 
     def call(env)
       req = Rack::Request.new(env)
-      
+
       if env?('development') && dev_rsp = dev_mode(req)
         return dev_rsp
       end
@@ -40,10 +40,10 @@ module Whereuat
       case req.path
       when %r{^/whereuat/whereuat.css$}
         [200, {"Content-Type" => "text/css"}, [ (root + 'lib/whereuat/stylesheets/whereuat.css').read ]]
-        
+
       when %r{^/whereuat/whereuat.js$}
         [200, {"Content-Type" => "text/javascript"}, [ (root + 'lib/whereuat/javascript/whereuat.js').read ]]
-        
+
       end
     end
 
@@ -53,16 +53,16 @@ module Whereuat
     end
 
     def accept(pivotal_story_id)
-      story = project.stories.find(pivotal_story_id.to_i)  
+      story = project.stories.find(pivotal_story_id.to_i)
       story.update(:current_state => 'accepted')
-      render "Accepted" 
+      render "Accepted"
     end
 
     def reject(pivotal_story_id, reason=nil)
-      story = project.stories.find(pivotal_story_id.to_i)  
+      story = project.stories.find(pivotal_story_id.to_i)
       story.update(:current_state => 'rejected')
       story.notes.create(:text => "[rejected] #{reason}")
-      render "Rejected" 
+      render "Rejected"
     end
 
     def project

data/lib/whereuat/rails.rb

@@ -0,0 +1,7 @@
+ActionView::Base.send :include, Whereuat::Helpers
+
+if defined?(Rails::Railtie)
+  require 'whereuat/railtie'
+else
+  Rails.configuration.middleware.use(Whereuat::RackApp)
+end

data/lib/whereuat/railtie.rb

@@ -0,0 +1,7 @@
+module Whereuat
+  class Railtie < Rails::Railtie
+    initializer 'whereuat.middleware' do |app|
+      app.config.middleware.insert_after(ActionDispatch::Static, Whereuat::RackApp)
+    end
+  end
+end

data/whereuat.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whereuat}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Askins", "Lachie Cox", "Ben Webster"]
-  s.date = %q{2010-07-28}
+  s.date = %q{2010-08-09}
   s.description = %q{Adds a toolbar to your rails app that directs your clients to test stories that have been marked as 'delivered' in Pivotal Tracker }
   s.email = %q{ben.askins@plus2.com.au}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "lib/whereuat.rb",
@@ -28,6 +28,8 @@ Gem::Specification.new do |s|
      "lib/whereuat/helpers.rb",
      "lib/whereuat/javascript/whereuat.js",
      "lib/whereuat/rack_app.rb",
+     "lib/whereuat/rails.rb",
+     "lib/whereuat/railtie.rb",
      "lib/whereuat/stylesheets/bg-uat.gif",
      "lib/whereuat/stylesheets/spinner.gif",
      "lib/whereuat/stylesheets/uat-bg.png",
@@ -41,14 +43,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/plus2/whereuat}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Direct your clients to test delivered features}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<pivotal-tracker>, [">= 0.1.3"])
       s.add_runtime_dependency(%q<haml>, [">= 2.2.0"])
       s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: whereuat
 version: !ruby/object:Gem::Version 
-  hash: 11
   prerelease: false
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Ben Askins
@@ -17,18 +16,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 +10:00
+date: 2010-08-09 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: pivotal-tracker
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
         segments: 
         - 0
         - 1
@@ -40,11 +37,9 @@ dependencies:
   name: haml
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 2
         - 2
@@ -56,11 +51,9 @@ dependencies:
   name: rack
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
@@ -76,12 +69,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/whereuat.rb
@@ -89,6 +82,8 @@ files:
 - lib/whereuat/helpers.rb
 - lib/whereuat/javascript/whereuat.js
 - lib/whereuat/rack_app.rb
+- lib/whereuat/rails.rb
+- lib/whereuat/railtie.rb
 - lib/whereuat/stylesheets/bg-uat.gif
 - lib/whereuat/stylesheets/spinner.gif
 - lib/whereuat/stylesheets/uat-bg.png
@@ -108,27 +103,23 @@ 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.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Direct your clients to test delivered features