rack-dev-mark 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29e79da8e2e497e598c546a19d5fdbd559d08122
-  data.tar.gz: 9c48bd678f7a011150b951ad15846ba5a655d52b
+  metadata.gz: df36ab5b5e659caeee87e9392be1626d6bc60834
+  data.tar.gz: f152c7f27e311c166858de3403a0dd56e074910c
 SHA512:
-  metadata.gz: a1b8813d5f99f420f4408878cfa5dbefc316b0fcd28e53fb0b44198f35c8a68f7fa3045573e963748ceb8e24a928598cd996500ca8c08f4b5177ae3f4cf0e9e8
-  data.tar.gz: a5e49e6bccc0cf1e0530acfef251f4b1db3ebce2979ce0075a27e69be85a13d1b7a9fbdd2c777be9f1b63918cde3b47f4a0922f159ec12be643dbf00f3f252ed
+  metadata.gz: 3287bb471bdf78d02ed55bb92a365f90042041a773db600ce2a429a656fb5e6a8bb462ca53a0a356a8976bb6009d40251537134c0ecf1751d8cc3e752ced7276
+  data.tar.gz: 8618e72dfd9a95ed37ccae14038ab616e80673187c40cd8a6d24043492230163685638ee0e6844a22a6a417ba6503cedf868adb076a666a2425f67241ee4c431

data/README.md

@@ -26,7 +26,7 @@ And run `bundle install`.
 
 ### For your Rack app
 
-```ruby:config.ru
+```ruby
 require 'rack/dev-mark'
 use Rack::DevMark::Middleware
 run MyApp
@@ -34,7 +34,17 @@ run MyApp
 
 ### For your Rails app
 
-This gem inserts rack middleware for all the environment except production automatically.
+In `config/application.rb`
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    if !%w(production).include?(Rails.env)
+      config.middleware.insert_before ActionDispatch::ShowExceptions, Rack::DevMark::Middleware
+    end
+  end
+end
+```
 
 ## Custom Theme
 
@@ -44,7 +54,7 @@ Define a sub class of `Rack::DevMark::Theme::Base` somewhere in your app.
 require 'rack/dev-mark/theme/base'
 
 class NewTheme < Rack::DevMark::Theme::Base
-  def insert_into(html, env)
+  def insert_into(html, env, revision)
     # Do something for your theme
     html
   end
@@ -56,27 +66,23 @@ Then, insert it in your app.
 ### For your Rack app
 
 ```ruby
-use Rack::DevMark::Middleware, Rack::DevMark::Theme::NewTheme.new
+use Rack::DevMark::Middleware, NewTheme.new
 ```
 
 ### For your Rails app
 
-```ruby:application.rb
-Rack::DevMark.theme = NewTheme.new
-```
-
-## Production Environment
+In `config/application.rb`
 
-You can change production environment name.
-
-### For your Rails app
-
-```ruby:application.rb
-Rack::DevMark.production_env = [:demo, :production]
+```ruby
+module MyApp
+  class Application < Rails::Application
+    if !%w(production).include?(Rails.env)
+      config.middleware.insert_before ActionDispatch::ShowExceptions, Rack::DevMark::Middleware, NewTheme.new
+    end
+  end
+end
 ```
 
-Then the mark won't show up on demo and production environments.
-
 ## Contributing
 
 1. Fork it

data/gemfiles/rack.1.1.x.gemfile

@@ -2,5 +2,3 @@ source "http://rubygems.org"
 
 gem 'rack', '~> 1.1.0'
 gemspec :path => '../'
-
-dependencies.delete_if { |dep| dep.name == 'rails' }

data/gemfiles/rack.1.2.x.gemfile

@@ -2,5 +2,3 @@ source "http://rubygems.org"
 
 gem 'rack', '~> 1.2.0'
 gemspec :path => '../'
-
-dependencies.delete_if { |dep| dep.name == 'rails' }

data/gemfiles/rack.1.3.x.gemfile

@@ -2,5 +2,3 @@ source "http://rubygems.org"
 
 gem 'rack', '~> 1.3.0'
 gemspec :path => '../'
-
-dependencies.delete_if { |dep| dep.name == 'rails' }

data/lib/rack/dev-mark.rb

@@ -4,29 +4,16 @@ require 'rack/dev-mark/utils'
 require 'rack/dev-mark/title'
 require 'rack/dev-mark/theme'
 require 'rack/dev-mark/middleware'
-require 'rack/dev-mark/railtie' if defined?(Rails)
 require 'rack/dev-mark/version'
 
 module Rack
   module DevMark
     def self.env
-      ENV['RAILS_ENV'] || ENV['RACK_ENV']
+      @env ||= ENV['RAILS_ENV'] || ENV['RACK_ENV']
     end
 
-    def self.production_env
-      @production_env ||= ['production']
-    end
-
-    def self.production_env=(*production_env)
-      @production_env = production_env.flatten.map(&:to_s)
-    end
-
-    def self.theme
-      @theme ||= :github_fork_ribbon
-    end
-
-    def self.theme=(theme)
-      @theme = theme
+    def self.revision
+      @revision ||= (::File.open('REVISION') { |f| f.read.strip } rescue nil)
     end
   end
 end

data/lib/rack/dev-mark/middleware.rb

@@ -33,8 +33,8 @@ module Rack
         response.each do |r|
           body.concat r.to_s
         end
-        body = @title.insert_into(body, Rack::DevMark.env)
-        body = @theme.insert_into(body, Rack::DevMark.env)
+        body = @title.insert_into(body, Rack::DevMark.env, Rack::DevMark.revision)
+        body = @theme.insert_into(body, Rack::DevMark.env, Rack::DevMark.revision)
         [body]
       end
     end

data/lib/rack/dev-mark/theme/base.rb

@@ -6,7 +6,7 @@ module Rack
           raise RuntimeError, 'Abstract class can not be instantiated' if self.class == Rack::DevMark::Theme::Base
         end
 
-        def insert_into(html, env)
+        def insert_into(html, env, revision)
 
         end
 

data/lib/rack/dev-mark/theme/github_fork_ribbon.rb

@@ -5,13 +5,13 @@ module Rack
   module DevMark
     module Theme
       class GithubForkRibbon < Base
-        def insert_into(html, env)
+        def insert_into(html, env, revision)
           s = <<-EOS
 #{stylesheet_link_tag "github-fork-ribbon-css/gh-fork-ribbon.css"}
 <!--[if lt IE 9]>
 #{stylesheet_link_tag "github-fork-ribbon-css/gh-fork-ribbon.ie.css"}
 <![endif]-->
-<div class="github-fork-ribbon-wrapper left" onClick="this.style.display='none'"><div class="github-fork-ribbon"><span class="github-fork-ribbon-text">#{env}</span></div></div>
+<div class="github-fork-ribbon-wrapper left" onClick="this.style.display='none'" title="#{revision}"><div class="github-fork-ribbon"><span class="github-fork-ribbon-text">#{env}</span></div></div>
           EOS
           html.sub %r{(<body[^>]*>)}i, "\\1#{s.strip}"
         end

data/lib/rack/dev-mark/title.rb

@@ -1,7 +1,7 @@
 module Rack
   module DevMark
     class Title
-      def insert_into(html, env)
+      def insert_into(html, env, revision)
         html.sub %r{(<title[^>]*>)}i, "\\1(#{env}) "
       end
     end

data/lib/rack/dev-mark/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module DevMark
-    VERSION = '0.0.5'
+    VERSION = '0.1.0'
   end
 end

data/rack-dev-mark.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rack", ">= 1.1"
 
-  gem.add_development_dependency "rails", ">= 3.1"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "coveralls"

data/spec/rack/dev-mark/middleware_spec.rb

@@ -5,11 +5,12 @@ describe Rack::DevMark::Middleware do
   subject { Rack::DevMark::Middleware.new(app) }
   before do
     allow(Rack::DevMark).to receive(:env).and_return('test')
+    allow(Rack::DevMark).to receive(:revision).and_return('rev')
   end
 
   it "inserts planbcd tag" do
-    expect_any_instance_of(Rack::DevMark::Title).to receive(:insert_into).with('response', 'test').once.and_return('response')
-    expect_any_instance_of(Rack::DevMark::Theme::GithubForkRibbon).to receive(:insert_into).with('response', 'test').once.and_return('response')
+    expect_any_instance_of(Rack::DevMark::Title).to receive(:insert_into).with('response', 'test', 'rev').once.and_return('response')
+    expect_any_instance_of(Rack::DevMark::Theme::GithubForkRibbon).to receive(:insert_into).with('response', 'test', 'rev').once.and_return('response')
     status, headers, body = subject.call({})
     expect(status).to eq(200)
     expect(headers).to eq({'Content-Type' => 'text/html; charset=utf-8'})

data/spec/rack/dev-mark/theme/github_fork_ribbon_spec.rb

@@ -8,7 +8,7 @@ describe Rack::DevMark::Theme::GithubForkRibbon do
 <!--[if lt IE 9]>
 <style>#{read_stylesheet "github-fork-ribbon-css/gh-fork-ribbon.ie.css"}</style>
 <![endif]-->
-<div class="github-fork-ribbon-wrapper left" onClick="this.style.display='none'"><div class="github-fork-ribbon"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
+<div class="github-fork-ribbon-wrapper left" onClick="this.style.display='none'" title="rev"><div class="github-fork-ribbon"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
       EOS
       s.strip
     end

data/spec/rack/dev-mark/title_spec.rb

@@ -9,7 +9,7 @@ describe Rack::DevMark::Title do
     let (:src) { %Q~<html><head>head</head><body>body</body></html>~ }
     let (:out) { %Q~<html><head>head</head><body>body</body></html>~ }
     it "does not insert anything" do
-      expect(subject.insert_into(src, 'env')).to eq(src)
+      expect(subject.insert_into(src, 'env', 'rev')).to eq(src)
     end
   end
 end

data/spec/rack/dev-mark_spec.rb

@@ -5,43 +5,42 @@ describe Rack::DevMark do
   before do
     @rack_env = ENV['RACK_ENV']
     @rails_env = ENV['RAILS_ENV']
-    Rack::DevMark.production_env = 'production'
   end
   after do
     ENV['RACK_ENV'] = @rack_env
     ENV['RAILS_ENV'] = @rails_env
-  end
-  it "returns nil" do
-    ENV['RAILS_ENV'] = nil
-    ENV['RACK_ENV'] = nil
-    expect(subject.env).to eq(nil)
-  end
-  it "returns rack_env" do
-    ENV['RAILS_ENV'] = nil
-    ENV['RACK_ENV'] = 'abc'
-    expect(subject.env).to eq('abc')
-  end
-  it "returns rails_env instead of rack_env" do
-    ENV['RACK_ENV'] = 'abc'
-    ENV['RAILS_ENV'] = 'def'
-    expect(subject.env).to eq('def')
-  end
-  it 'has default production_env' do
-    expect(subject.production_env).to eq(['production'])
-  end
-  it 'sets production_env' do
-    Rack::DevMark.production_env = 'abc'
-    expect(subject.production_env).to eq(['abc'])
-  end
-  it 'sets production_env by array' do
-    Rack::DevMark.production_env = ['abc', 'def']
-    expect(subject.production_env).to eq(['abc', 'def'])
-  end
-  it 'has default theme' do
-    expect(subject.theme).to eq(:github_fork_ribbon)
-  end
-  it 'sets production_env' do
-    Rack::DevMark.theme = :abc
-    expect(subject.theme).to eq(:abc)
+    subject.instance_variable_set("@env", nil)
+  end
+  describe "::env" do 
+    it "returns nil" do
+      ENV['RAILS_ENV'] = nil
+      ENV['RACK_ENV'] = nil
+      expect(subject.env).to eq(nil)
+    end
+    it "returns rack_env" do
+      ENV['RAILS_ENV'] = nil
+      ENV['RACK_ENV'] = 'abc'
+      expect(subject.env).to eq('abc')
+    end
+    it "returns rails_env instead of rack_env" do
+      ENV['RACK_ENV'] = 'abc'
+      ENV['RAILS_ENV'] = 'def'
+      expect(subject.env).to eq('def')
+    end
+  end
+  describe "::revision" do
+    after do
+      ::File.delete('REVISION') if ::File.exists?('REVISION')
+      subject.instance_variable_set("@revision", nil)
+    end
+    it "returns revision" do
+      ::File.open('REVISION', 'w') do |f|
+        f.write('abcde')
+      end
+      expect(subject.revision).to eq('abcde')
+    end
+    it "returns nil if REVISION does not exist" do
+      expect(subject.revision).to eq(nil)
+    end
   end
 end

data/spec/support/theme_helper.rb

@@ -5,6 +5,6 @@ RSpec.shared_examples "theme" do
 
   let (:src) { %Q~<html><head>head<title>title</title></head><body>body</body></html>~ }
   it "insert env mark" do
-    expect(subject.insert_into(src, 'env')).to eq(out)
+    expect(subject.insert_into(src, 'env', 'rev')).to eq(out)
   end
 end

metadata

@@ -1,83 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rack-dev-mark
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-01 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Differentiate development environemt from production
@@ -87,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -102,7 +88,6 @@ files:
 - lib/rack/dev-mark.rb
 - lib/rack/dev-mark/error.rb
 - lib/rack/dev-mark/middleware.rb
-- lib/rack/dev-mark/railtie.rb
 - lib/rack/dev-mark/theme.rb
 - lib/rack/dev-mark/theme/base.rb
 - lib/rack/dev-mark/theme/github_fork_ribbon.rb
@@ -113,7 +98,6 @@ files:
 - screenshot-development.png
 - screenshot-production.png
 - spec/rack/dev-mark/middleware_spec.rb
-- spec/rack/dev-mark/railtie_spec.rb
 - spec/rack/dev-mark/theme/base_spec.rb
 - spec/rack/dev-mark/theme/github_fork_ribbon_spec.rb
 - spec/rack/dev-mark/title_spec.rb
@@ -132,26 +116,26 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Differentiate development environemt from production
 test_files:
 - spec/rack/dev-mark/middleware_spec.rb
-- spec/rack/dev-mark/railtie_spec.rb
 - spec/rack/dev-mark/theme/base_spec.rb
 - spec/rack/dev-mark/theme/github_fork_ribbon_spec.rb
 - spec/rack/dev-mark/title_spec.rb
 - spec/rack/dev-mark_spec.rb
 - spec/spec_helper.rb
 - spec/support/theme_helper.rb
+has_rdoc: 

data/lib/rack/dev-mark/railtie.rb

@@ -1,14 +0,0 @@
-require 'rack/dev-mark/middleware'
-
-module Rack
-  module DevMark
-    class Railtie < ::Rails::Railtie
-      initializer 'rack-dev-mark' do |app|
-        app.middleware.delete Rack::DevMark::Middleware
-        unless Rack::DevMark.production_env.include? Rack::DevMark.env.to_s
-          app.middleware.use Rack::DevMark::Middleware, Rack::DevMark.theme
-        end
-      end
-    end
-  end
-end

data/spec/rack/dev-mark/railtie_spec.rb

@@ -1,48 +0,0 @@
-require 'spec_helper'
-
-if !!Gem.loaded_specs["rails"]
-
-require 'rails'
-require 'rack/dev-mark/railtie'
-
-describe Rack::DevMark::Railtie do
-  let(:env) { 'test' }
-  let(:production_env) { :production }
-  let(:app) { Class.new(Rails::Application) }
-  before do
-    @env = ENV['RAILS_ENV']
-    ENV['RAILS_ENV'] = env
-    Rack::DevMark.production_env = production_env
-    app.initialize!
-  end
-  after do
-    ENV['RAILS_ENV'] = @env
-    Rails.application = nil
-  end
-
-  context "development env" do
-    it "adds rack middleware" do
-      expect(app.middleware.middlewares).to include(Rack::DevMark::Middleware)
-    end
-    context "production_env has test" do
-      let(:production_env) { 'test' }
-      it "does not add rack middleware" do
-        expect(app.middleware.middlewares).not_to include(Rack::DevMark::Middleware)
-      end
-    end
-  end
-  context "production env" do
-    let(:env) { 'production' }
-    it "does not add rack middleware" do
-      expect(app.middleware.middlewares).not_to include(Rack::DevMark::Middleware)
-    end
-    context "production_env has abc" do
-      let(:production_env) { :abc }
-      it "does not add rack middleware" do
-        expect(app.middleware.middlewares).to include(Rack::DevMark::Middleware)
-      end
-    end
-  end
-end
-
-end