rack-showme 0.0.1 → 0.0.2.1

data/.gitignore

@@ -0,0 +1,4 @@
+rack-showme-*.gem
+*.swp
+.DS_Store
+

data/Gemfile

@@ -1,4 +1,6 @@
 source "http://rubygems.org"
 
+gem 'rake', :group => :development
+
 # Specify your gem's dependencies in rack-showme.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    rack-showme (0.0.2.pre)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rake (10.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-showme!
+  rake

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Omar Vargas.
+
+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.markdown

@@ -1,7 +1,11 @@
-# Rack-Showme 
+# Rack::Showme
 
 Rack middleware that injects a message into HTML responses.
 
+> By _message_ I mean a <div> element
+
+This give us the ability to, for example, add a message indicating that the server is staging or any other QA environment without have to modify our code base
+
 ## Using with Rails
 
 Add the following line to your Gemfile
@@ -10,11 +14,54 @@ Add the following line to your Gemfile
 	gem "rack-showme"
 ```
 
-Then add the following lines to your application.rb file
+And run `bundle install`
+
+Then add the following lines to an enviroment file e.g. `config/environments/development.rb`
 
 ```ruby
   require "rack/showme
+
   config.middleware.use "Rack::Showme"
   Rack::Showme::Options.message = "Development"
 ```
 
+## Options
+
+You can select between three colorschemes `yellow`, `green` and `red`
+
+```ruby
+  Rack::Showme::Options.colorscheme= "yellow"
+  Rack::Showme::Options.colorscheme= "green"
+  Rack::Showme::Options.colorscheme= "red"
+```
+
+This is useful to easily distinguish between diferent enviroments e.g. development and staging
+
+## Information
+
+### Bugs repors
+
+If you discover a problem with **Rack::Showme**, please, open a Issue and include the more info you can.
+
+### Contributing
+
+Do you have an idea about how do **Rack::Showme** better, don't hesitate in fork the project and send a pull request
+
+## ScreenShots
+
+Simple rails app without **Rack::Showme**
+
+![Screenshot](doc/images/normal.png)
+
+Default colorscheme (yellow)
+
+![Screenshot](doc/images/default.png)
+
+Green colorscheme
+
+![Screenshot](doc/images/green.png)
+
+Red colorscheme
+
+![Screenshot](doc/images/red.png)
+

data/Rakefile

@@ -1,2 +1,12 @@
 require 'bundler'
+require 'rake'
+require 'rake/testtask'
+
 Bundler::GemHelper.install_tasks
+
+# Minitest
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test'
+end
+

data/lib/rack/showme/message_box.rb

@@ -0,0 +1,32 @@
+module Rack
+  class Showme
+    class MessageBox
+      def initialize(options)
+        @message = options.message
+        @colorscheme = options.colorscheme
+      end
+
+      def html
+        "<div id=\"rack-show-me-message-box\" class=\"#{colorscheme_class}\">#{message}</div>"
+      end
+
+      def message
+        @message
+      end
+
+      def colorscheme_class
+        case @colorscheme
+        when "yellow"
+          "rack-show-me-colorscheme-yellow"
+        when "red"
+          "rack-show-me-colorscheme-red"
+        when "green"
+          "rack-show-me-colorscheme-green"
+        else
+          "rack-show-me-colorscheme-yellow"
+        end
+      end 
+    end
+  end
+end
+

data/lib/rack/showme/options.rb

@@ -2,6 +2,7 @@ module Rack
   class Showme 
     module Options
       @@message = "[Add a Message]"
+      @@colorscheme = "yellow"
 
       class << self
         def message
@@ -11,6 +12,14 @@ module Rack
         def message=(value)
           @@message= value
         end
+
+        def colorscheme
+          @@colorscheme
+        end
+
+        def colorscheme=(value)
+          @@colorscheme= value
+        end
       end      
     end
   end

data/lib/rack/showme/public/showme.css

@@ -1,12 +1,26 @@
-#show-me-message {
+/* ribbon */
+#rack-show-me-message-box {
 	border-bottom: 1px solid #999;
 	border-right: 1px solid #999;
   position: fixed;
   top: 0;
   left: 0;
 	padding: 4px 7px;
-	background-color: #FFF8C6;
-	color: #333;
 	cursor: pointer;
 	z-index: 2147483640;
 }
+
+.rack-show-me-colorscheme-yellow {
+	background-color: #FFF8C6;
+	color: #333333;
+}
+
+.rack-show-me-colorscheme-red {
+	background-color: #FD0006;
+	color: #000000;
+}
+
+.rack-show-me-colorscheme-green {
+	background-color: #42e73A;
+	color: #333333;
+}

data/lib/rack/showme/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class Showme 
-    VERSION = "0.0.1"
+    VERSION = "0.0.2.1"
   end
 end

data/lib/rack/showme.rb

@@ -1,4 +1,5 @@
 require "rack/showme/options"
+require "rack/showme/message_box"
 
 module Rack
   class Showme 
@@ -30,11 +31,11 @@ module Rack
 
     def inject_html
       css_line = %Q{<style type="text/css">#{read_public_file("showme.css")}</style>\n}
-      code = "<div id=\"show-me-message\"> #{Options.message}</div>"
+      message_box = MessageBox.new(Options).html 
 
       body = @response.body
-      body.gsub!("<body>", "<body>#{code}")
       body.gsub!("</body>", "#{css_line}</body>")
+      body.gsub!("<body>", "<body>#{message_box}")
       @response.body = body
 
       @headers["Content-Length"] = @response.body.bytesize.to_s

data/test/test_helper.rb

@@ -1 +1 @@
-ENV["RAILS_ENV"] = "test"
+require 'minitest/autorun'

data/test/unit/showme/message_box/colorschema_class_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+class TestMessageBox < MiniTest::Unit::TestCase
+  def test_yellow_colorscheme
+    Rack::Showme::Options.colorscheme= "yellow"
+    @message_box = Rack::Showme::MessageBox.new(Rack::Showme::Options)
+
+    assert_equal(@message_box.colorscheme_class, "rack-show-me-colorscheme-yellow")
+  end
+
+  def test_red_colorscheme
+    Rack::Showme::Options.colorscheme= "red"
+    @message_box = Rack::Showme::MessageBox.new(Rack::Showme::Options)
+
+    assert_equal(@message_box.colorscheme_class, "rack-show-me-colorscheme-red")
+  end
+
+  def test_green_colorscheme
+    Rack::Showme::Options.colorscheme= "green"
+    @message_box = Rack::Showme::MessageBox.new(Rack::Showme::Options)
+
+    assert_equal(@message_box.colorscheme_class, "rack-show-me-colorscheme-green")
+  end
+  def test_invalid_colorscheme
+    Rack::Showme::Options.colorscheme= "apple"
+    @message_box = Rack::Showme::MessageBox.new(Rack::Showme::Options)
+
+    # Yellow is the default colorscheme
+    assert_equal(@message_box.colorscheme_class, "rack-show-me-colorscheme-yellow")
+  end
+end

data/test/unit/showme/message_box/html_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class TestMessageBox < MiniTest::Unit::TestCase
+  def setup
+    @message_box = Rack::Showme::MessageBox.new(Rack::Showme::Options)
+  end
+
+  def test_html_include_showme_id
+    assert_match @message_box.html, /id=\"rack-show-me-message-box\"/
+  end
+  
+  def test_html_include_colorscheme_class
+    assert_match @message_box.html, /class=\"rack-show-me-colorscheme/
+  end
+end

data/test/unit/showme/message_box/message_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class TestMessageBox < MiniTest::Unit::TestCase
+  def setup
+    Rack::Showme::Options.message = "Hello morros"
+    @message_box = Rack::Showme::MessageBox.new(Rack::Showme::Options)
+  end
+
+  def test_message
+    assert_equal(@message_box.message, "Hello morros")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-showme
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware that injects a message into HTML responses.
 email:
@@ -18,15 +18,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
+- Gemfile.lock
+- MIT-LICENSE
 - README.markdown
 - Rakefile
+- doc/images/default.png
+- doc/images/green.png
+- doc/images/normal.png
+- doc/images/red.png
 - lib/rack/showme.rb
+- lib/rack/showme/message_box.rb
 - lib/rack/showme/options.rb
 - lib/rack/showme/public/showme.css
 - lib/rack/showme/version.rb
 - rack-showme.gemspec
 - test/test_helper.rb
+- test/unit/showme/message_box/colorschema_class_test.rb
+- test/unit/showme/message_box/html_test.rb
+- test/unit/showme/message_box/message_box_helper.rb
+- test/unit/showme/message_box/message_test.rb
 homepage: https://github.com/ovargas27/rack-showme
 licenses: []
 post_install_message: