rack-dev-mark 0.4.6 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWFhYjIwOWI1NzI3MzQ0YWZiYjFiNTJiMTgyMzdlNGM3ODU2YTMxYw==
+    MjgxZGYyYmNiNzI4ZDFhODBmZWZhOGU5ZjJiZTZiNzhiN2JmYTc5OA==
   data.tar.gz: !binary |-
-    NzFhZjU3YzE5Zjg4ZGM1MGYzNzAzNDBiZWQ4ZmY0OTEwNDZjMzhjNA==
+    Y2VkNzU1ZTA0OTVmNmRjYWFkMGVhNTlhYjIxZGQ1ODQ5YzJhODliNg==
 SHA512:
   metadata.gz: !binary |-
-    MTdlYzU3OWNkMjE3ZDYxMTJkMjIzYjAzZWJjYjZjZDNhOWI4MTdhZmMwYWE1
-    MmM5MWFmYjE1ZDUzNzA5MzkzMjdiZjBkMzQ4MmJkODAzY2ZjOTdmZjI0NjUw
-    ZTQ5ZjVlOTM4ODlhNTE4NGRlN2RiZjQ3Y2NlODhkNTI0NTJlNzc=
+    NTFmNzFiNDA0MzExYTU5ZGRkZDE3ZjBmMDI4NmYwNWMxYWI3MmNjNWM3YmM2
+    YzYwNWE5YTUwNmNiN2QwZTA5OWNmYTc2NWY5NTgyMTNhMzM4ZjUyNjI5NjVk
+    NjljYjBhOTgwZjFhMzhhM2VjZGNjZGE3MWIwMGUzOTRlMzFmNDQ=
   data.tar.gz: !binary |-
-    NTk2ZmFkZjgwNmNlYmE3YTE4ZjUzNTJjNDNhOTg0ZmMwNWY4ZGVlYzZjNzM5
-    MjdhMjYwMTdmYzdkYjhlY2I1YzNmOTYwNjBiYTNmNWExZmNkZDYzZGRlMWNh
-    NGI0ZDkwNDYyOTA0NTgyNTBlMmRhMzU1ZmQwNTUwMmM3MDZkMmY=
+    YmRmMjNmNGY3YmY1Nzk0ZDAwMDU1ZWZhNGViMDc2MGViNTc5NTU1MzdlMjMy
+    MDQ4OGYxYmUyM2Y0ZDMwOTNjOTEyODQ0OWQ5NmVkYzRiMTAxMjFmMzdhODVj
+    MDJlNzZiYjBkZTYwYTk4M2JjY2MwNmMyZmEyMGM0YzQyOTk4NDQ=

data/README.md

@@ -100,7 +100,7 @@ heroku config:set RACK_DEV_MARK=staging
 
 ## Custom Theme
 
-Create your own theme class inheriting `Rack::DevMark::Theme::Base`.
+Although the default themes are `title` and `github_fork_ribbon`, you can create your own themes inheriting `Rack::DevMark::Theme::Base`.
 
 ```ruby
 require 'rack/dev-mark/theme/base'

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

@@ -26,7 +26,7 @@ module Rack
             begin
               new_body << insert_dev_marks(b)
             rescue => e
-              $stderr.write "Failed to insert dev marks: #{e.message}\n"
+              $stderr.write %Q|Failed to insert dev marks: #{e.message}\n  #{e.backtrace.join("  \n")}|
             end
           end
           response.close if response.respond_to?(:close)

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

@@ -20,14 +20,34 @@ module MyApp
 end
 ```
 
+## tag
+
+Insert the environment string into tags or attributes.
+
+e.g.
+
+`<div data-title="foo">foo</div>` can be `<div data-title="(env) foo">foo</div>`
+
+### options
+
+`type`: `prefix` (default) or `postfix`
+
+`upcase`: `true` or `false` (default)
+
+`name`: the name of tag to insert env
+
+`attribute`: the name of attribute to insert env
+
 ## title
 
-Just add the environment into the page title.
+Just add the environment string into the page title.
 
 e.g.
 
 `My Homepage` on development env will be `(development) My Homepage`
 
+options are the same as tag theme.
+
 ### options
 
 `type`: `prefix` (default) or `postfix`

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

@@ -17,9 +17,30 @@ module Rack
 
         end
 
+        private
+
         def stylesheet_link_tag(path)
           %Q~<style>#{::File.open(::File.join(::File.dirname(__FILE__), '../../../../vendor/assets/stylesheets', path)).read}</style>~
         end
+
+        def gsub_tag_content(html, name, &block)
+          String.new(html).gsub(%r{(<#{name}\s*[^>]*>)([^<]*)(</#{name}>)}i) do
+            "#{$1}#{block.call($2)}#{$3}"
+          end
+        end
+
+        def gsub_tag_attribute(html, name, attr, &block)
+          String.new(html).gsub %r{(<#{name}\s*)([^>]*)(>)}i do
+            s1, s2, s3 = $1, $2, $3
+            s2.gsub! %r{(#{attr}=')([^']*)(')} do
+              "#{$1}#{block.call($2)}#{$3}"
+            end
+            s2.gsub! %r{(#{attr}=")([^"]*)(")} do
+              "#{$1}#{block.call($2)}#{$3}"
+            end
+            "#{s1}#{s2}#{s3}"
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,46 @@
+require 'rack/dev-mark/theme/base'
+
+module Rack
+  module DevMark
+    module Theme
+      class Tag < Base
+        def initialize(options = {})
+          @options = options
+        end
+
+        def insert_into(html)
+          name = @options[:name]
+
+          if name
+            html = gsub_tag_content html, name do |value|
+              env_with(value)
+            end
+          end
+
+          if attribute = @options[:attribute]
+            Array(attribute).each do |attr|
+              html = gsub_tag_attribute html, name, attr do |value|
+                env_with(value)
+              end
+            end
+          end
+
+          html
+        end
+
+        private
+
+        def env_with(org)
+          s = env.to_s
+          s = s.upcase if @options[:upcase]
+
+          if @options[:type].to_s == 'postfix'
+            "#{org} (#{s})"
+          else
+            "(#{s}) #{org}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,21 +1,11 @@
-require 'rack/dev-mark/theme/base'
+require 'rack/dev-mark/theme/tag'
 
 module Rack
   module DevMark
     module Theme
-      class Title < Base
+      class Title < Tag
         def initialize(options = {})
-          @options = options
-        end
-
-        def insert_into(html)
-          s = env.to_s
-          s = s.upcase if @options[:upcase]
-          if @options[:type].to_s == 'postfix'
-            html.sub %r{(</title[^>]*>)}i, " (#{s})\\1"
-          else
-            html.sub %r{(<title[^>]*>)}i, "\\1(#{s}) "
-          end
+          super options.merge(name: 'title', attribute: nil)
         end
       end
     end

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

@@ -1,5 +1,5 @@
 module Rack
   module DevMark
-    VERSION = '0.4.6'
+    VERSION = '0.5.0'
   end
 end

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

@@ -13,5 +13,54 @@ describe Rack::DevMark::Theme::Base do
       expect(subject.env).to eq('env')
       expect(subject.revision).to eq('rev')
     end
+    describe "#gsub_tag_content" do
+      let(:input) { %Q|<body><h1>head</h1><a href="something">x</a><span></span>y</div>| }
+      let(:output) { %Q|<body><h1>head</h1><a href="something">replaced</a><span></span>y</div>| }
+      it "replaces a string" do
+        expect(subject.send(:gsub_tag_content, input, 'a', &lambda{ |v| 'replaced' })).to eq(output)
+      end
+      context "for multiple tags" do
+        let(:input) { %Q|<body><h1>head</h1><a href="something">x</a><a href="anything">y</a></div>| }
+        let(:output) { %Q|<body><h1>head</h1><a href="something">replaced</a><a href="anything">replaced</a></div>| }
+        it "replaces 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>| }
+      let(:output) { %Q|<body><h1>head</h1><a href="something" data-title="replaced" data-body="x">x</a><span data-title="y">y</span></div>| }
+      it "replaces a string" do
+        expect(subject.send(:gsub_tag_attribute, input, 'a', 'data-title', &lambda{ |v| 'replaced' })).to eq(output)
+      end
+      context "for multiple tags" do
+        let(:input) { %Q|<body><h1>head</h1><a href="something" data-title="x" data-body="x">x</a><a href="anything" data-title="y">y</a></div>| }
+        let(:output) { %Q|<body><h1>head</h1><a href="something" data-title="replaced" data-body="x">x</a><a href="anything" data-title="replaced">y</a></div>| }
+        it "replaces a string" do
+          expect(subject.send(:gsub_tag_attribute, input, 'a', 'data-title', &lambda{ |v| 'replaced' })).to eq(output)
+        end
+      end
+      context "for single tag" do
+        let(:input) { %Q|<body><h1>head</h1><a href="something" data-title="x" data-body="x">x</a><span href="anything" data-title="y">y</span><img data-title="i"></div>| }
+        let(:output) { %Q|<body><h1>head</h1><a href="something" data-title="x" data-body="x">x</a><span href="anything" data-title="y">y</span><img data-title="replaced"></div>| }
+        it "replaces a string" do
+          expect(subject.send(:gsub_tag_attribute, input, 'img', 'data-title', &lambda{ |v| 'replaced' })).to eq(output)
+        end
+      end
+      context "for any tags" do
+        let(:input) { %Q|<body><h1>head</h1><a href="something" data-title="x" data-body="x">x</a><span href="anything" data-title="y">y</span></div>| }
+        let(:output) { %Q|<body><h1>head</h1><a href="something" data-title="replaced" data-body="x">x</a><span href="anything" data-title="replaced">y</span></div>| }
+        it "replaces a string" do
+          expect(subject.send(:gsub_tag_attribute, input, nil, 'data-title', &lambda{ |v| 'replaced' })).to eq(output)
+        end
+      end
+      context "with single quotations" 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>| }
+        let(:output) { %Q|<body><h1>head</h1><a href='something' data-title='replaced' data-body='x'>x</a><span data-title='y'>y</span></div>| }
+        it "replaces a string" do
+          expect(subject.send(:gsub_tag_attribute, input, 'a', 'data-title', &lambda{ |v| 'replaced' })).to eq(output)
+        end
+      end
+    end
   end
 end

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

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Rack::DevMark::Theme::Tag do
+  include_context "theme context"
+
+  let(:options) { {} }
+  subject { Rack::DevMark::Theme::Tag.new(options) }
+
+  it_behaves_like "theme" do
+    # No insert
+  end
+
+  describe "#env_with" do
+    context "upcase is true" do
+      let(:options) { {upcase: true} }
+      it "replace a string" do
+        expect(subject.send(:env_with, 'foo')).to eq('(ENV) foo')
+      end
+    end
+    context "upcase is false" do
+      let(:options) { {upcase: false} }
+      it "replace a string" do
+        expect(subject.send(:env_with, 'foo')).to eq('(env) foo')
+      end
+    end
+    context "type is prefix" do
+      let(:options) { {type: 'prefix'} }
+      it "replace a string" do
+        expect(subject.send(:env_with, 'foo')).to eq('(env) foo')
+      end
+    end
+    context "type is postfix" do
+      let(:options) { {type: 'postfix'} }
+      it "replace a string" do
+        expect(subject.send(:env_with, 'foo')).to eq('foo (env)')
+      end
+    end
+  end
+
+  context "with name option" do
+    let(:options) { {name: 'div'} }
+    context "with one match" do
+      it_behaves_like "theme" do
+        let(:src) { %Q~<html><head>head<title></title></head><body>body<div>foo</div><span>bar</span></body></html>~ }
+        let(:out) { %Q~<html><head>head<title></title></head><body>body<div>(env) foo</div><span>bar</span></body></html>~ }
+      end
+    end
+    context "with multiple matches" do
+      it_behaves_like "theme" do
+        let(:src) { %Q~<html><head>head<title></title></head><body>body<div>foo</div><div>bar</div></body></html>~ }
+        let(:out) { %Q~<html><head>head<title></title></head><body>body<div>(env) foo</div><div>(env) bar</div></body></html>~ }
+      end
+    end
+    context "no match" do
+      it_behaves_like "theme" do
+        let(:src) { %Q~<html><head>head<title></title></head><body>body<span>foo</span><span>bar</span></body></html>~ }
+        let(:out) { %Q~<html><head>head<title></title></head><body>body<span>foo</span><span>bar</span></body></html>~ }
+      end
+    end
+  end
+
+  context "with attribute option" do
+    context "one specified attribute" do
+      let(:options) { {attribute: 'data-title1' } }
+      context "with one match" do
+        it_behaves_like "theme" do
+          let(:src) { %Q~<html><head>head<title></title></head><body>body<div data-title1="foo">foo</div><div>bar</div></body></html>~ }
+          let(:out) { %Q~<html><head>head<title></title></head><body>body<div data-title1="(env) foo">foo</div><div>bar</div></body></html>~ }
+        end
+      end
+      context "with multiple matches" do
+        it_behaves_like "theme" do
+          let(:src) { %Q~<html><head>head<title></title></head><body>body<div data-title1="foo">foo</div><div data-title1="bar">bar</div></body></html>~ }
+          let(:out) { %Q~<html><head>head<title></title></head><body>body<div data-title1="(env) foo">foo</div><div data-title1="(env) bar">bar</div></body></html>~ }
+        end
+      end
+      context "no match" do
+        it_behaves_like "theme" do
+          let(:src) { %Q~<html><head>head<title></title></head><body>body<div>foo</div><div>bar</div></body></html>~ }
+          let(:out) { %Q~<html><head>head<title></title></head><body>body<div>foo</div><div>bar</div></body></html>~ }
+        end
+      end
+    end
+    context "multiple specified attributes" do
+      let(:options) { {attribute: ['data-title1', 'data-title2'] } }
+      context "with one match" do
+        it_behaves_like "theme" do
+          let(:src) { %Q~<html><head>head<title></title></head><body>body<div data-title1="foo" data-title2="abc">foo</div><div>bar</div></body></html>~ }
+          let(:out) { %Q~<html><head>head<title></title></head><body>body<div data-title1="(env) foo" data-title2="(env) abc">foo</div><div>bar</div></body></html>~ }
+        end
+      end
+      context "with multiple matches" do
+        it_behaves_like "theme" do
+          let(:src) { %Q~<html><head>head<title></title></head><body>body<div data-title1="foo" data-title2="abc">foo</div><div data-title1="bar" data-title2="xyz">bar</div></body></html>~ }
+          let(:out) { %Q~<html><head>head<title></title></head><body>body<div data-title1="(env) foo" data-title2="(env) abc">foo</div><div data-title1="(env) bar" data-title2="(env) xyz">bar</div></body></html>~ }
+        end
+      end
+      context "no match" do
+        it_behaves_like "theme" do
+          let(:src) { %Q~<html><head>head<title></title></head><body>body<div>foo</div><div>bar</div></body></html>~ }
+          let(:out) { %Q~<html><head>head<title></title></head><body>body<div>foo</div><div>bar</div></body></html>~ }
+        end
+      end
+    end
+  end
+end

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

@@ -2,35 +2,12 @@ require 'spec_helper'
 
 describe Rack::DevMark::Theme::Title do
   include_context "theme context"
+
+  let(:options) { {} }
+  subject { Rack::DevMark::Theme::Title.new(options) }
+
   it_behaves_like "theme" do
+    let (:src) { %Q~<html><head>head<title>title</title></head><body>body</body></html>~ }
     let (:out) { %Q~<html><head>head<title>(env) title</title></head><body>body</body></html>~ }
-    subject { Rack::DevMark::Theme::Title.new }
-  end
-  context "upcase is true" do
-    let (:out) { %Q~<html><head>head<title>(ENV) title</title></head><body>body</body></html>~ }
-    subject { Rack::DevMark::Theme::Title.new(upcase: true) }
-    it_behaves_like "theme"
-  end
-  context "upcase is true" do
-    let (:out) { %Q~<html><head>head<title>(env) title</title></head><body>body</body></html>~ }
-    subject { Rack::DevMark::Theme::Title.new(upcase: false) }
-    it_behaves_like "theme"
-  end
-  context "type is prefix" do
-    let (:out) { %Q~<html><head>head<title>(env) title</title></head><body>body</body></html>~ }
-    subject { Rack::DevMark::Theme::Title.new(type: 'prefix') }
-    it_behaves_like "theme"
-  end
-  context "type is postfix" do
-    let (:out) { %Q~<html><head>head<title>title (env)</title></head><body>body</body></html>~ }
-    subject { Rack::DevMark::Theme::Title.new(type: 'postfix') }
-    it_behaves_like "theme"
-  end
-  context "no title tag" 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)).to eq(src)
-    end
   end
 end

data/spec/rack/dev-mark_spec.rb

@@ -30,8 +30,8 @@ describe Rack::DevMark do
   end
   describe "::env=" do
     it "sets custom env" do
-      Rack::DevMark.env = 'custom'
-      expect(Rack::DevMark.env).to eq('custom')
+      subject.env = 'custom'
+      expect(subject.env).to eq('custom')
     end
   end
   describe "::revision" do
@@ -51,8 +51,8 @@ describe Rack::DevMark do
   end
   describe "::revision=" do
     it "sets custom revision" do
-      Rack::DevMark.revision = 'custom'
-      expect(Rack::DevMark.revision).to eq('custom')
+      subject.revision = 'custom'
+      expect(subject.revision).to eq('custom')
     end
   end
 end

data/spec/support/theme_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-dev-mark
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -98,6 +98,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/theme/tag.rb
 - lib/rack/dev-mark/theme/title.rb
 - lib/rack/dev-mark/utils.rb
 - lib/rack/dev-mark/version.rb
@@ -110,6 +111,7 @@ files:
 - 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/theme/tag_spec.rb
 - spec/rack/dev-mark/theme/title_spec.rb
 - spec/rack/dev-mark/utils_spec.rb
 - spec/rack/dev-mark_spec.rb
@@ -148,6 +150,7 @@ test_files:
 - 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/theme/tag_spec.rb
 - spec/rack/dev-mark/theme/title_spec.rb
 - spec/rack/dev-mark/utils_spec.rb
 - spec/rack/dev-mark_spec.rb