rack-dev-mark 0.5.1 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDI0NDVjZGE2NGU1YzViZTZiM2IxM2U0NzEwNmFiMGNmYzVjN2UzNg==
+    MzFjOWI5ZjJlNDdiODE0ZWY3NDM3NzE2NjdkODk2OGI3MWNiZDBiOQ==
   data.tar.gz: !binary |-
-    YTEyOTVhMWEzZDg1ZGE2OWM1ZGUxMDk3MGJiMTIyMzM3NzVlY2NmOA==
+    YmZkNjY3MjZlMmRiZTk3NTU4N2Q5YzMyYWNlNWIwM2U4ZTg1MzQ1NQ==
 SHA512:
   metadata.gz: !binary |-
-    NjVhODM5ZThiOGUzMjE2MjYzZWY4NjgzMGFmYWY5YjEyODcxZDRhODdjYzJk
-    NTBjMTdlMDU4MmViNThiZTU4NGIxZWE2NDdjY2IxYmE1NTdmMWUyM2U4N2Qw
-    Njk2YWQxOGQzZDJjYjEyYTNlMmRmMjYzMmQxYTZhNTk4YTQwOTQ=
+    YjM4ZDUzM2Y1N2FmMDJlYjBkNzQ3MjkyY2U3NzVlZDZiOWJiZTQzOTU1ZjIy
+    ZTgwNjgxNmVkYmU2ZTI3ZTZhMmZhY2FjYzE0ZWM1Nzc2M2NiYTlmZjUyNTI1
+    NDE4OTVhZWQwMDdhOWY3YWJhZGQ3ODE5MmU5NzYyZDNhNGRmMTc=
   data.tar.gz: !binary |-
-    ZmRiMjhlMDVmOGQ5MzM0N2ZjMTQ5YjAzNjM3MTY2M2NkNGMyMTc1OTdlYjFj
-    YWY3MzczNjAwNDAxOWZkOWRhODgxOTUwNTJmMjUyZTNmNWZiMzllNzU2MWNl
-    OTRkOGYwMDcxYjE1ZTM5ZmY5ZTgyMzVlZmQxOTc2NmZlYzFmYmQ=
+    ZWI3Mzc0NTk3M2VlNzhjNmM1MDJjNTA5NzJhZjEzYzI2ZDBkNjYzMzkyMzI2
+    NDg2MjlkZDNmMzY3NzYyMWM3YjEzYjcwOGRjZTZlNDEzNzU4YTk2ZmVjYzU4
+    MjhlNTg2YTc2NGM2YzYzMTgyMjM3MDg0YjNhODNkMmM4MTgxYjA=

data/README.md

@@ -1,9 +1,13 @@
 # rack-dev-mark
 
-[![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)](http://travis-ci.org/dtaniwaki/rack-dev-mark) [![Coverage Status](https://coveralls.io/repos/dtaniwaki/rack-dev-mark/badge.png)](https://coveralls.io/r/dtaniwaki/rack-dev-mark) [![Code Climate](https://codeclimate.com/github/dtaniwaki/rack-dev-mark.png)](https://codeclimate.com/github/dtaniwaki/rack-dev-mark)
+[![Gem Version][gem-image]][gem-link]
+[![Dependency Status][deps-image]][deps-link]
+[![Build Status][build-image]][build-link]
+[![Coverage Status][cov-image]][cov-link]
+[![Code Climate][gpa-image]][gpa-link]
 
 Differentiate development environment from production.
-You can choose [themes](lib/rack/dev-mark/theme/README.md) to differentiate the page.
+You can choose [themes](THEME.md) to differentiate the page.
 
 ## Screenshot
 
@@ -140,7 +144,7 @@ module MyApp
 end
 ```
 
-You can add any combination of themes. See more about [themes](lib/rack/dev-mark/theme/README.md).
+You can add any combination of themes. See more about [themes](THEME.md).
 
 ## Contributing
 
@@ -153,3 +157,18 @@ You can add any combination of themes. See more about [themes](lib/rack/dev-mark
 ## Copyright
 
 Copyright (c) 2014 Daisuke Taniwaki. See [LICENSE](LICENSE) for details.
+
+
+
+
+[gem-image]:   https://badge.fury.io/rb/rack-dev-mark.svg
+[gem-link]:    http://badge.fury.io/rb/rack-dev-mark
+[build-image]: https://secure.travis-ci.org/dtaniwaki/rack-dev-mark.png
+[build-link]:  http://travis-ci.org/dtaniwaki/rack-dev-mark
+[deps-image]:  https://gemnasium.com/dtaniwaki/rack-dev-mark.svg
+[deps-link]:   https://gemnasium.com/dtaniwaki/rack-dev-mark
+[cov-image]:   https://coveralls.io/repos/dtaniwaki/rack-dev-mark/badge.png
+[cov-link]:    https://coveralls.io/r/dtaniwaki/rack-dev-mark
+[gpa-image]:   https://codeclimate.com/github/dtaniwaki/rack-dev-mark.png
+[gpa-link]:    https://codeclimate.com/github/dtaniwaki/rack-dev-mark
+

data/{lib/rack/dev-mark/theme/README.md → THEME.md}

@@ -24,9 +24,19 @@ end
 
 Insert the environment string into tags or attributes.
 
-e.g.
+### e.g.
 
-`<div data-title="foo">foo</div>` can be `<div data-title="(env) foo">foo</div>`
+#### by tag name
+
+`Rack::DevMark::Theme::Tag.new(attribute: 'data-title')`
+
+`<div data-title="foo">foo</div>` will be `<div data-title="(env) foo">foo</div>`
+
+#### by attribute
+
+`Rack::DevMark::Theme::Tag.new(name: 'h1')`
+
+`<h1>foo</h1>` will be `<h1="foo">(env) foo</h1>`
 
 ### options
 
@@ -40,13 +50,11 @@ e.g.
 
 ## title
 
-Just add the environment string into the page title.
-
-e.g.
+Subclass of tag theme specifically made for title tag. It just adds the environment string into the page title.
 
 `My Homepage` on development env will be `(development) My Homepage`
 
-options are the same as tag theme.
+![title](misc/theme/title.png)
 
 ### options
 
@@ -58,7 +66,15 @@ options are the same as tag theme.
 
 ["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)
+It shows a banner of the environment on the ribbon.
+
+![github_fork_ribbon](misc/theme/github_fork_ribbon.png)
+
+It also shows deployment revision and timestamp on the tooltip if available.
+
+![github_fork_ribbon tooltip](misc/theme/github_fork_ribbon_tooltip.png)
+
+Click the banner to remove it temporarily.
 
 ### options
 

data/lib/rack/dev-mark.rb

@@ -22,6 +22,14 @@ module Rack
     def self.revision=(revision)
       @revision = revision
     end
+
+    def self.timestamp
+      @timestamp ||= (::File.open('REVISION') { |f| f.ctime } rescue nil)
+    end
+
+    def self.timestamp=(timestamp)
+      @timestamp = timestamp
+    end
   end
 end
 

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

@@ -8,7 +8,7 @@ module Rack
         @app = app
         @themes = [themes].flatten.map do |theme|
           theme = theme.is_a?(Symbol) ? Rack::DevMark::Theme.const_get(camelize(theme.to_s)).new : theme
-          theme.setup Rack::DevMark.env, Rack::DevMark.revision
+          theme.setup Rack::DevMark.env, Rack::DevMark.revision, Rack::DevMark.timestamp
           theme
         end
       end

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

@@ -2,15 +2,16 @@ module Rack
   module DevMark
     module Theme
       class Base
-        attr_reader :env, :revision
+        attr_reader :env, :revision, :timestamp
 
         def initialize(*args)
           raise RuntimeError, 'Abstract class can not be instantiated' if self.class == Rack::DevMark::Theme::Base
         end
 
-        def setup(env, revision)
+        def setup(env, revision, timestamp)
           @env = env
           @revision = revision
+          @timestamp = timestamp
         end
 
         def insert_into(html)

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

@@ -7,18 +7,23 @@ module Rack
       class GithubForkRibbon < Base
         def initialize(options = {})
           @options = options
+          super
         end
 
         def insert_into(html)
           position = @options[:position] || 'left'
           color = @options[:color] || 'red'
           fixed = @options[:fixed] ? ' fixed' : ''
+          title = []
+          title << revision if revision.to_s != ''
+          title << timestamp if timestamp.to_s != ''
+          title = title.join("&#10;")
           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 #{position}#{fixed}" onClick="this.style.display='none'" title="#{revision}"><div class="github-fork-ribbon #{color}"><span class="github-fork-ribbon-text">#{env}</span></div></div>
+<div class="github-fork-ribbon-wrapper #{position}#{fixed}" onClick="this.style.display='none'" title="#{title}"><div class="github-fork-ribbon #{color}"><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/theme/tag.rb

@@ -6,6 +6,7 @@ module Rack
       class Tag < Base
         def initialize(options = {})
           @options = options
+          super
         end
 
         def insert_into(html)

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

@@ -1,5 +1,5 @@
 module Rack
   module DevMark
-    VERSION = '0.5.1'
+    VERSION = '0.6.0'
   end
 end

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

@@ -9,7 +9,7 @@ describe Rack::DevMark::Theme::Base do
   describe "subclass" do
     subject { Class.new(Rack::DevMark::Theme::Base).new }
     it "sets up" do
-      subject.setup 'env', 'rev'
+      subject.setup 'env', 'rev', 'time'
       expect(subject.env).to eq('env')
       expect(subject.revision).to eq('rev')
     end
@@ -26,6 +26,13 @@ describe Rack::DevMark::Theme::Base do
           expect(subject.send(:gsub_tag_content, input, 'a', &lambda{ |v| 'replaced' })).to eq(output)
         end
       end
+      context "for nested tags" do
+        let(:input) { %Q|<body><h1>head</h1><a href="something"><span>x</span></a><span>y</span></div>| }
+        let(:output) { %Q|<body><h1>head</h1><a href="something"><span>x</span></a><span>y</span></div>| }
+        it "does not replace a string" do
+          expect(subject.send(:gsub_tag_content, input, 'a', &lambda{ |v| 'replaced' })).to eq(output)
+        end
+      end
     end
     describe "#gsub_tag_attribute" do
       let(:input) { %Q|<body><h1>head</h1><a href="something" data-title="x" data-body="x">x</a><span data-title="y">y</span></div>| }

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

@@ -9,7 +9,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'" title="rev"><div class="github-fork-ribbon red"><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&#10;time"><div class="github-fork-ribbon red"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
       EOS
       s.strip
     end
@@ -24,7 +24,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 right" onClick="this.style.display='none'" title="rev"><div class="github-fork-ribbon red"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
+<div class="github-fork-ribbon-wrapper right" onClick="this.style.display='none'" title="rev&#10;time"><div class="github-fork-ribbon red"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
         EOS
         s.strip
       end
@@ -40,7 +40,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'" title="rev"><div class="github-fork-ribbon orange"><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&#10;time"><div class="github-fork-ribbon orange"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
         EOS
         s.strip
       end
@@ -56,7 +56,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 fixed" onClick="this.style.display='none'" title="rev"><div class="github-fork-ribbon red"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
+<div class="github-fork-ribbon-wrapper left fixed" onClick="this.style.display='none'" title="rev&#10;time"><div class="github-fork-ribbon red"><span class="github-fork-ribbon-text">env</span></div></div>body</body></html>
         EOS
         s.strip
       end

data/spec/support/theme_helper.rb

@@ -4,7 +4,7 @@ RSpec.shared_context "theme context" do
   end
 
   before do
-    subject.setup 'env', 'rev'
+    subject.setup 'env', 'rev', 'time'
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-dev-mark
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -79,6 +79,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- THEME.md
 - gemfiles/gemfile
 - gemfiles/rack.1.1.x.gemfile
 - gemfiles/rack.1.2.x.gemfile
@@ -94,10 +95,8 @@ files:
 - lib/rack/dev-mark/middleware.rb
 - lib/rack/dev-mark/railtie.rb
 - lib/rack/dev-mark/theme.rb
-- lib/rack/dev-mark/theme/README.md
 - 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/theme/tag.rb
 - lib/rack/dev-mark/theme/title.rb
 - lib/rack/dev-mark/utils.rb
@@ -105,6 +104,9 @@ files:
 - misc/screenshot-development.png
 - misc/screenshot-production.png
 - misc/screenshot.gif
+- misc/theme/github_fork_ribbon.png
+- misc/theme/github_fork_ribbon_tooltip.png
+- misc/theme/title.png
 - rack-dev-mark.gemspec
 - spec/generators/rack/dev-mark/install_generator_spec.rb
 - spec/rack/dev-mark/middleware_spec.rb