rack-dev-mark 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 42a5ffd6f42ef7be54a8f771995e8f25b83eba55
-  data.tar.gz: 182572ef0e6b865632f8c9fbe3242609a89fd5fd
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWYzMTgzODMzODRiNGNiNGFjM2NkYWE2OWZkZjcxZDJhYzhkNTM4NA==
+  data.tar.gz: !binary |-
+    YjViMzZiYzlkYmZlNjkzNmYwOGMwYjMyYzRlYTdjNzY3OWZiZmFjYw==
 SHA512:
-  metadata.gz: 2e542980f53aa02e8941498ead409fbef42498dba8b28eb0014dda01bfef1f88491685e8370c506f51cd93cb5f77e4499fa4fb93dd73b4925cf77c8c903a100a
-  data.tar.gz: fb53da781a35607a3e10ea7b4af7d5c5cbe9d230ae839015081700cd09e2216b052500650d816a18fdcdeb309ff8d07a7d69191793f1d10cf6fcf6a72e16d2ba
+  metadata.gz: !binary |-
+    Y2ZjNjQ5MTEwYzA3ZTAyOGM3Mzc3Y2E4ODY3M2UzNjllNjhmZjNiMWNlNTY4
+    NGUwNGVmNzI2Njg4MTBlOTYyYWRmNjU5NmQ2MWVkMTYyMDc2MTgzOWNjN2I1
+    ZDI1OWFjNDAwMjlkZDU3MGJlMjdkMGQ4N2I1MmI5MWUzMjI4OGY=
+  data.tar.gz: !binary |-
+    N2IwMTg3MWE4Yjg5ODViZWFjYWQ1OTNmMjUyNWE1ZjkxMDc4ZDRhNzVkYzQz
+    MWRkMmQyM2Y2YzFhMjRmYzVkOGExZmRjYTdjZDEzMDg1YzliNWRkNDYzMmY0
+    MmZjMWI1YTk1YTU3ZjgwNTkyNDA5NDVlNGY5NjM1M2IzOThkNjU=

data/README.md

@@ -2,7 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/rack-dev-mark.svg)](http://badge.fury.io/rb/rack-dev-mark) [![Build Status](https://secure.travis-ci.org/dtaniwaki/rack-dev-mark.png?branch=master)](http://travis-ci.org/dtaniwaki/rack-dev-mark) [![Coverage Status](https://coveralls.io/repos/dtaniwaki/rack-dev-mark/badge.png?branch=master)](https://coveralls.io/r/dtaniwaki/rack-dev-mark?branch=master)
 
-Differentiate development environment from production. You can choose [themes](lib/rack/dev-mark/theme/README.md)
+Differentiate development environment from production.
+You can choose [themes](lib/rack/dev-mark/theme/README.md) to differentiate the page.
 
 ## Screenshot
 
@@ -39,7 +40,25 @@ In `config/application.rb`
 ```ruby
 module MyApp
   class Application < Rails::Application
-    if !%w(production).include?(Rails.env)
+    if Rails.env != 'production'
+      config.middleware.insert_before ActionDispatch::ShowExceptions, Rack::DevMark::Middleware
+    end
+  end
+end
+```
+
+The middleware sets [title](lib/rack/dev-mark/theme/title.rb) and [github_fork_ribbon](lib/rack/dev-mark/theme/github_fork_ribbon.rb) themes as default.
+
+#### Exclude Multiple Environments in Rails
+
+Show the dev mark except env1, env2, env3.
+
+In `config/application.rb`
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    if !%w(env1 env2 env3).include?(Rails.env)
       config.middleware.insert_before ActionDispatch::ShowExceptions, Rack::DevMark::Middleware
     end
   end
@@ -59,6 +78,13 @@ class NewTheme < Rack::DevMark::Theme::Base
     html
   end
 end
+
+class AnotherTheme < Rack::DevMark::Theme::Base
+  def insert_into(html, env, revision)
+    # Do something for your theme
+    html
+  end
+end
 ```
 
 Then, insert it in your app.
@@ -66,7 +92,7 @@ Then, insert it in your app.
 ### For your Rack app
 
 ```ruby
-use Rack::DevMark::Middleware, NewTheme.new
+use Rack::DevMark::Middleware, [NewTheme.new, AnotherTheme.new]
 ```
 
 ### For your Rails app
@@ -76,13 +102,15 @@ 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, NewTheme.new
+    if Rails.env != 'production'
+      config.middleware.insert_before ActionDispatch::ShowExceptions, Rack::DevMark::Middleware, [NewTheme.new, AnotherTheme.new]
     end
   end
 end
 ```
 
+You can add any combination of themes.
+
 ## Contributing
 
 1. Fork it

data/lib/rack/dev-mark.rb

@@ -1,7 +1,6 @@
 require 'rack'
 require 'rack/dev-mark/error'
 require 'rack/dev-mark/utils'
-require 'rack/dev-mark/title'
 require 'rack/dev-mark/theme'
 require 'rack/dev-mark/middleware'
 require 'rack/dev-mark/version'

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

@@ -4,10 +4,11 @@ module Rack
       include Rack::Utils
       include Rack::DevMark::Utils
 
-      def initialize(app, theme = :github_fork_ribbon)
+      def initialize(app, themes = [:title, :github_fork_ribbon])
         @app = app
-        @title = Rack::DevMark::Title.new
-        @theme = theme.is_a?(Symbol) ? Rack::DevMark::Theme.const_get(camelize(theme.to_s)).new : theme
+        @themes = [themes].flatten.map do |theme|
+          theme.is_a?(Symbol) ? Rack::DevMark::Theme.const_get(camelize(theme.to_s)).new : theme
+        end
       end
       
       def call(env)
@@ -15,6 +16,8 @@ module Rack
 
         headers = HeaderHash.new(headers)
 
+        headers['X-Rack-Dev-Mark-Env'] = Rack::DevMark.env
+
         if headers['Content-Type'].to_s =~ %r{^text/html;}i
           new_body = ''
           response.each do |b|
@@ -35,8 +38,9 @@ module Rack
       private
 
       def insert_dev_marks(body)
-        body = @title.insert_into(body, Rack::DevMark.env, Rack::DevMark.revision)
-        body = @theme.insert_into(body, Rack::DevMark.env, Rack::DevMark.revision)
+        @themes.each do |theme|
+          body = theme.insert_into(body, Rack::DevMark.env, Rack::DevMark.revision)
+        end
         body
       end
     end

data/lib/rack/dev-mark/theme/README.md

@@ -1,10 +1,16 @@
 # Theme
 
-## github-fork-ribbon
+## title
+
+Just add the environment into the page title.
+
+e.g.
 
-"Fork Me on GitHub" like ribbon
+`My Homepage` on development env will be `(development) My Homepage`
+
+## github-fork-ribbon
 
-https://github.com/simonwhitaker/github-fork-ribbon-css
+["Fork Me on GitHub" like ribbon](https://github.com/simonwhitaker/github-fork-ribbon-css) originally created by [simonwhitaker](https://github.com/simonwhitaker)
 
 ![github-fork-ribbon](screenshots/github_fork_ribbon.png)
 

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

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

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

@@ -1,5 +1,5 @@
 module Rack
   module DevMark
-    VERSION = '0.1.5'
+    VERSION = '0.2.0'
   end
 end

data/rack-dev-mark.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency "rack", ">= 1.1"
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec", ">= 3.0"
   gem.add_development_dependency "coveralls"
 end

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

@@ -1,29 +1,52 @@
 require 'spec_helper'
 
 describe Rack::DevMark::Middleware do
-  let(:app) { double call: [200, {'Content-Type' => 'text/html; charset=utf-8'}, ['response']] }
-  subject { Rack::DevMark::Middleware.new(app) }
+  let(:headers) { {'Content-Type' => 'text/html; charset=utf-8'} }
+  let(:body) { ['response'] }
+  let(:theme) { d = double; allow(d).to receive(:insert_into){ |b, _, _| "#{b} dev-mark" }; d }
+  let(:app) { double call: [200, headers, body] }
+  subject { Rack::DevMark::Middleware.new(app, theme) }
   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', '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')
+  it "inserts dev mark" do
     status, headers, body = subject.call({})
     expect(status).to eq(200)
-    expect(headers).to eq({'Content-Type' => 'text/html; charset=utf-8'})
-    expect(body).to eq(['response'])
+    expect(headers).to include('Content-Type' => 'text/html; charset=utf-8')
+    expect(body).to eq(["response dev-mark"])
+  end
+  it "adds http headers" do
+    _, headers, _ = subject.call({})
+    expect(headers).to include('X-Rack-Dev-Mark-Env' => 'test')
+  end
+  context "multiple themes" do
+    let(:_theme) { d = double; allow(d).to receive(:insert_into){ |b, _, _| "#{b} dev-mark" }; d }
+    let(:theme) { [_theme] * 3 }
+    it "uses title and github_fork_ribbon" do
+      theme.each_with_index do |theme, idx|
+        expect(theme).to receive(:insert_into).once.and_return('')
+      end
+      subject.call({})
+    end
+  end
+  context "default themes" do
+    subject { Rack::DevMark::Middleware.new(app) }
+    it "uses title and github_fork_ribbon" do
+      expect_any_instance_of(Rack::DevMark::Theme::Title).to receive(:insert_into).once.and_return('')
+      expect_any_instance_of(Rack::DevMark::Theme::GithubForkRibbon).to receive(:insert_into).once.and_return('')
+      subject.call({})
+    end
   end
   context "not html request" do
-    let(:app) { double call: [200, {'Content-Type' => 'application/json;'}, ['{}']] }
+    let(:headers) { {'Content-Type' => 'application/json;'} }
+    let(:body) { ['{}'] }
     it "does not insert planbcd tag if the body does not have head tag" do
-      expect_any_instance_of(Rack::DevMark::Title).not_to receive(:insert_into)
-      expect_any_instance_of(Rack::DevMark::Theme::GithubForkRibbon).not_to receive(:insert_into)
+      expect(theme).not_to receive(:insert_to)
       status, headers, body = subject.call({})
       expect(status).to eq(200)
-      expect(headers).to eq({'Content-Type' => 'application/json;'})
+      expect(headers).to include('Content-Type' => 'application/json;')
       expect(body).to eq(['{}'])
     end
   end

data/spec/rack/dev-mark/{title_spec.rb → theme/title_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe Rack::DevMark::Title do
+describe Rack::DevMark::Theme::Title do
   it_behaves_like "theme" do
     let (:out) { %Q~<html><head>head<title>(env) title</title></head><body>body</body></html>~ }
-    subject { Rack::DevMark::Title.new }
+    subject { Rack::DevMark::Theme::Title.new }
   end
   context "no title tag" do
     let (:src) { %Q~<html><head>head</head><body>body</body></html>~ }

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rack-dev-mark
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-06-14 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: 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'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.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
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -93,7 +93,7 @@ files:
 - lib/rack/dev-mark/theme/base.rb
 - lib/rack/dev-mark/theme/github_fork_ribbon.rb
 - lib/rack/dev-mark/theme/screenshots/github_fork_ribbon.png
-- lib/rack/dev-mark/title.rb
+- lib/rack/dev-mark/theme/title.rb
 - lib/rack/dev-mark/utils.rb
 - lib/rack/dev-mark/version.rb
 - rack-dev-mark.gemspec
@@ -102,7 +102,7 @@ files:
 - spec/rack/dev-mark/middleware_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/theme/title_spec.rb
 - spec/rack/dev-mark_spec.rb
 - spec/spec_helper.rb
 - spec/support/theme_helper.rb
@@ -118,12 +118,12 @@ 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: []
@@ -136,8 +136,7 @@ test_files:
 - spec/rack/dev-mark/middleware_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/theme/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/title.rb

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