rack-dev-mark 0.6.4 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGQ4OTM0MjZiOGJkMDAxYTNhOTNmNGMzYTQwYjVjNGZlOTYzMTMzOQ==
+    YjFlYzc0MDk5MDA0ZGU1NDNmZTA3N2QwZWYzNTg5ZDhhNmIxMTM2YQ==
   data.tar.gz: !binary |-
-    ZTMxN2EyYjhhZDE0YWRhYTkxYjJhNDc3MjlkMzhmMGY0YjM1ODE1YQ==
+    ZmU2ZTgxODMzZmY0N2ZjYjE1NDc5MmU0MmM2YzJmM2FiYjU3MjYyZQ==
 SHA512:
   metadata.gz: !binary |-
-    NjJiMmI5N2M3Nzc1ZjhiNWZjNWY0MDZlOWJkMzkyZGIwMjNmNTU4YmY5MTYz
-    YmUyZmY1ZTY1ZDZmMTFiZTY4ZDMxZjk0MGFhNzUwNzY5YjI1YmRjMWY0YzNk
-    NmU4YWFjZTRmYTA5ODg5NzQ1YTFiOTVjY2E5YTUzZmYxZGU0NjA=
+    OTc1MTVkYjllODI0YTBmMDc5MDBhZmFkZjM1ZWE5MmUzMWE2N2VjYzIyOGRh
+    MWQ3ZjVhZWQ1M2NjYmM5ZGM3YzVmYTk4ZjY0Y2JjZjRlYzA0ZmI2NmI1MjQw
+    OTIwZWYxZmZiOGUwYzQ3YTkyMTdkOTYzNTQ5NDZkZDk1M2I4NDg=
   data.tar.gz: !binary |-
-    NjUwOTM0ZThmYmY2ZTQ1ZTUzMGI0OGVlOWFhMjM2YjEyNmU1YThmYzJjMzY4
-    ZTA3ZjA4MjkzMjQzMDM4NGYwYWU3ODI0YjdlMzkwOWI0MzUwODA4YWJkYTFm
-    ZjA5ODQxMjUzYTVlYWQzOTQ5ZDBkYTgzNTRiMjdjNTUzMTc5MDE=
+    MjU5MDkzN2M2NzQ1NGM3OGFjNTAwZWJjMjkwYzk3OWIwN2FiNjFjYTAzMDYz
+    NWVmNjcyMDdhM2U3YmU5MWJjYWJhYmJjZTA0NzY2YjJhNWEyYjk3ZTU3NDc0
+    YTFkNmYwYzQ3YzE0NDIzNTYzMjg5YWEyYTRiNzU4ZmY3OTA3NjA=

data/.travis.yml

@@ -14,6 +14,7 @@ env:
   - RAILS_VERSION=3.2.0
   - RAILS_VERSION=4.0.0
   - RAILS_VERSION=4.1.0
+  - I18N_VERSION=0.6.0
 
 script: "bundle exec rake spec"
 

data/Gemfile

@@ -2,5 +2,6 @@ source 'https://rubygems.org'
 
 gem "rack", "~> #{ENV['RACK_VERSION']}" if ENV['RACK_VERSION'].to_s != ''
 gem "rails", "~> #{ENV['RAILS_VERSION']}" if ENV['RAILS_VERSION'].to_s != ''
+gem "i18n", "~> #{ENV['I18N_VERSION']}" if ENV['I18N_VERSION'].to_s != ''
 
 gemspec

data/README.md

@@ -6,8 +6,9 @@
 [![Coverage Status][cov-image]][cov-link]
 [![Code Climate][gpa-image]][gpa-link]
 
-Differentiate development environment from production.
-You can choose [themes](THEME.md) to differentiate the page.
+Differentiate development environment from production. You can choose [themes](THEME.md) to differentiate the page.
+
+The running sample is available [here](http://rack-dev-mark.dtaniwaki.com/).
 
 ## Screenshot
 
@@ -109,6 +110,32 @@ end
 
 [Here](COMPATIBILITY.md) is the compatibility list which many people often ask.
 
+#### Custom env string
+
+Set the custom env string maually.
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    config.rack_dev_mark.env = 'foo'
+  end
+end
+
+## I18n Support
+
+Get i18n string with rack_dev_mark locale strings.
+
+e.g. In `config/locale/rack_dev_mark.ja.yml`
+
+```
+ja:
+  rack_dev_mark:
+    development: '開発中'
+    staging: 'ステージング'
+```
+
+Then, you will get translated string on the pages!
+
 ## Custom Theme
 
 Although the default themes are `title` and `github_fork_ribbon`, you can create your own themes inheriting `Rack::DevMark::Theme::Base`.
@@ -117,14 +144,14 @@ Although the default themes are `title` and `github_fork_ribbon`, you can create
 require 'rack/dev-mark/theme/base'
 
 class NewTheme < Rack::DevMark::Theme::Base
-  def insert_into(html)
+  def insert_into(html, env, params = {})
     # Do something for your theme
     html
   end
 end
 
 class AnotherTheme < Rack::DevMark::Theme::Base
-  def insert_into(html)
+  def insert_into(html, env, params = {})
     # Do something for your theme
     html
   end

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.7.0

data/lib/generators/rack/dev-mark/install_generator.rb

@@ -11,8 +11,13 @@ module Rack
         insert_into_file target_path, after: "< Rails::Application\n" do <<-EOS
     # Enable rack-dev-mark
     config.rack_dev_mark.enable = !Rails.env.production?
+    #
+    # Customize the env string (default Rails.env)
+    # config.rack_dev_mark.env = 'foo'
+    #
     # Customize themes if you want to do so
     # config.rack_dev_mark.theme = [:title, :github_fork_ribbon]
+    #
     # Customize inserted place of the middleware if necessary.
     # You can use either `insert_before` or `insert_after`
     # config.rack_dev_mark.insert_before SomeOtherMiddleware

data/lib/rack/dev-mark.rb

@@ -37,6 +37,11 @@ module Rack
         s.to_s == '' ? nil : s
       end
     end
+
+    if defined?(::I18n)
+      require 'rack/dev-mark/i18n_helper'
+      include I18nHelper
+    end
   end
 end
 

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

@@ -0,0 +1,18 @@
+require 'i18n'
+
+module Rack
+  module DevMark
+    module I18nHelper
+      def self.included(base)
+        class << base
+          def env_with_i18n
+            s = env_without_i18n
+            ::I18n.translate(s, scope: 'rack_dev_mark', default: s)
+          end
+          alias_method :env_without_i18n, :env
+          alias_method :env, :env_with_i18n
+        end
+      end
+    end
+  end
+end

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

@@ -7,10 +7,10 @@ module Rack
       def initialize(app, themes = [:title, :github_fork_ribbon])
         @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, Rack::DevMark.timestamp
-          theme
+          theme.is_a?(Symbol) ? Rack::DevMark::Theme.const_get(camelize(theme.to_s)).new : theme
         end
+        @revision = Rack::DevMark.revision
+        @timestamp = Rack::DevMark.timestamp
       end
       
       def call(env)
@@ -41,7 +41,7 @@ module Rack
 
       def insert_dev_marks(body)
         @themes.each do |theme|
-          body = theme.insert_into(body)
+          body = theme.insert_into(body, Rack::DevMark.env, revision: @revision, timestamp: @timestamp)
         end
         body
       end

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

@@ -1,7 +1,7 @@
 module Rack
   module DevMark
     class RailsOptions
-      attr_accessor :enable, :theme
+      attr_accessor :env, :enable, :theme
 
       alias_method :custom_theme, :theme
       alias_method :custom_theme=, :theme=

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

@@ -6,7 +6,7 @@ module Rack
     class Railtie < Rails::Railtie
       config.rack_dev_mark = RailsOptions.new
 
-      initializer "rack-dev-mark.configure_rails_initialization" do |app|
+      initializer "rack-dev-mark.insert_middleware" do |app|
         if app.config.rack_dev_mark.enable || Rack::DevMark.rack_dev_mark_env
           racks = []
 
@@ -22,6 +22,12 @@ module Rack
           app.config.app_middleware.send(insert_method, *racks)
         end
       end
+
+      initializer "rack-dev-mark.set_env", after: "rack-dev-mark.insert_middleware" do |app|
+        if app.config.rack_dev_mark.enable || Rack::DevMark.rack_dev_mark_env
+          Rack::DevMark.env = app.config.rack_dev_mark.env
+        end
+      end
     end
   end
 end

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

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

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

@@ -5,12 +5,10 @@ module Rack
   module DevMark
     module Theme
       class GithubForkRibbon < Base
-        def initialize(options = {})
-          @options = options
-          super
-        end
+        def insert_into(html, env, params = {})
+          revision = params[:revision]
+          timestamp = params[:timestamp]
 
-        def insert_into(html)
           position = @options[:position] || 'left'
           color = @options[:color] || 'red'
           fixed = @options[:fixed] ? ' fixed' : ''
@@ -18,6 +16,7 @@ module Rack
           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]>
@@ -25,6 +24,7 @@ module Rack
 <![endif]-->
 <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
       end

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

@@ -4,24 +4,19 @@ module Rack
   module DevMark
     module Theme
       class Tag < Base
-        def initialize(options = {})
-          @options = options
-          super
-        end
-
-        def insert_into(html)
+        def insert_into(html, env, params = {})
           name = @options[:name]
 
           if name
             html = gsub_tag_content html, name do |value|
-              env_with(value)
+              env_with_value(env, value)
             end
           end
 
           if attribute = @options[:attribute]
             Array(attribute).each do |attr|
               html = gsub_tag_attribute html, name, attr do |value|
-                env_with(value)
+                env_with_value(env, value)
               end
             end
           end
@@ -31,7 +26,7 @@ module Rack
 
         private
 
-        def env_with(org)
+        def env_with_value(env, org)
           s = env.to_s
           s = s.upcase if @options[:upcase]
 

data/spec/generators/rack/dev-mark/install_generator_spec.rb

@@ -32,8 +32,13 @@ module MyApp
   class Application < Rails::Application
     # Enable rack-dev-mark
     config.rack_dev_mark.enable = !Rails.env.production?
+    #
+    # Customize the env string (default Rails.env)
+    # config.rack_dev_mark.env = 'foo'
+    #
     # Customize themes if you want to do so
     # config.rack_dev_mark.theme = [:title, :github_fork_ribbon]
+    #
     # Customize inserted place of the middleware if necessary.
     # You can use either `insert_before` or `insert_after`
     # config.rack_dev_mark.insert_before SomeOtherMiddleware

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

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'spec_helper'
+
+if defined?(::I18n)
+describe Rack::DevMark::I18nHelper do
+  let(:translations) {
+    {
+      ja: {
+        rack_dev_mark: {
+          test: 'テスト'
+        }
+      }
+    }
+  }
+  before do
+    ::I18n.locale = :ja
+    ::I18n.backend.store_translations(:ja, translations[:ja])
+  end
+  after do
+    ::I18n.backend.store_translations(:ja, {})
+    ::I18n.locale = :en
+  end
+  it "returns i18n string" do
+    Rack::DevMark.env = 'test'
+    expect(Rack::DevMark.env).to eq('テスト')
+  end
+  context "without matched key" do
+    it "returns original string" do
+      Rack::DevMark.env = 'foo'
+      expect(Rack::DevMark.env).to eq('foo')
+    end
+  end
+end
+end

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

@@ -6,6 +6,8 @@ describe Rack::DevMark::RailsOptions do
   it do
     is_expected.to respond_to(:enable)
     is_expected.to respond_to(:enable=)
+    is_expected.to respond_to(:env)
+    is_expected.to respond_to(:env=)
     is_expected.to respond_to(:theme)
     is_expected.to respond_to(:theme=)
     is_expected.to respond_to(:insert_type)

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

@@ -39,7 +39,7 @@ describe Rack::DevMark::Railtie do
     end
   end
   context "rack_dev_mark theme" do
-    let(:theme) { d = double setup: nil; allow(d).to receive(:insert_into){ |b| "#{b} dev-mark" }; d }
+    let(:theme) { d = double setup: nil; allow(d).to receive(:insert_into){ |b, _, _| "#{b} dev-mark" }; d }
     before do
       @app.config.rack_dev_mark.enable = true
       @app.config.rack_dev_mark.theme = [theme]
@@ -50,7 +50,7 @@ describe Rack::DevMark::Railtie do
     end
   end
   context "rack_dev_mark custom_theme alias" do
-    let(:theme) { d = double setup: nil; allow(d).to receive(:insert_into){ |b| "#{b} dev-mark" }; d }
+    let(:theme) { d = double setup: nil; allow(d).to receive(:insert_into){ |b, _, _| "#{b} dev-mark" }; d }
     before do
       @app.config.rack_dev_mark.enable = true
       @app.config.rack_dev_mark.custom_theme = [theme]
@@ -90,5 +90,15 @@ describe Rack::DevMark::Railtie do
       expect(middlewares.index(Rack::DevMark::Middleware)).to eq(middlewares.index(dummy_middleware) + 1)
     end
   end
+  context "rack_dev_mark env" do
+    before do
+      @app.config.rack_dev_mark.enable = true
+      @app.config.rack_dev_mark.env = 'something'
+    end
+    it 'sets the env string' do
+      @app.initialize!
+      expect(Rack::DevMark.env).to eq('something')
+    end
+  end
 end
 end

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

@@ -8,11 +8,6 @@ describe Rack::DevMark::Theme::Base do
   end
   describe "subclass" do
     subject { Class.new(Rack::DevMark::Theme::Base).new }
-    it "sets up" do
-      subject.setup 'env', 'rev', 'time'
-      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>| }

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

@@ -10,29 +10,29 @@ describe Rack::DevMark::Theme::Tag do
     # No insert
   end
 
-  describe "#env_with" do
+  describe "#env_with_value" 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')
+        expect(subject.send(:env_with_value, 'env', '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')
+        expect(subject.send(:env_with_value, 'env', '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')
+        expect(subject.send(:env_with_value, 'env', '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)')
+        expect(subject.send(:env_with_value, 'env', 'foo')).to eq('foo (env)')
       end
     end
   end

data/spec/rack/dev-mark_spec.rb

@@ -2,15 +2,6 @@ require 'spec_helper'
 
 describe Rack::DevMark do
   subject { Rack::DevMark }
-  before do
-    @rack_env = ENV['RACK_ENV']
-    @rails_env = ENV['RAILS_ENV']
-  end
-  after do
-    ENV['RACK_ENV'] = @rack_env
-    ENV['RAILS_ENV'] = @rails_env
-    subject.instance_variable_set("@env", nil)
-  end
   describe "::env" do
     it "returns development as default" do
       ENV['RAILS_ENV'] = nil

data/spec/spec_helper.rb

@@ -26,10 +26,26 @@ begin
   $stdout.write "* Rails has been loaded.\n"
 rescue LoadError
 end
+begin
+  require 'i18n'
+  $stdout.write "* I18n has been loaded.\n"
+  I18n.enforce_available_locales = true
+  I18n.available_locales = [:ja, :en]
+rescue LoadError
+end
 require 'rack-dev-mark'
 
 Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f }
 
 RSpec.configure do |config|
+  config.before :each do
+    @rack_env = ENV['RACK_ENV']
+    @rails_env = ENV['RAILS_ENV']
+  end
+  config.after :each do
+    ENV['RACK_ENV'] = @rack_env
+    ENV['RAILS_ENV'] = @rails_env
+    Rack::DevMark.env = nil
+  end
 end
 

data/spec/support/theme_helper.rb

@@ -2,16 +2,12 @@ RSpec.shared_context "theme context" do
   def read_stylesheet(path)
     ::File.open(::File.join(::File.dirname(__FILE__), '../../vendor/assets/stylesheets', path)).read
   end
-
-  before do
-    subject.setup 'env', 'rev', 'time'
-  end
 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)
+    expect(subject.insert_into(src, 'env', revision: 'rev', timestamp: 'time')).to eq(out)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-dev-mark
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -86,6 +86,7 @@ files:
 - lib/rack-dev-mark.rb
 - lib/rack/dev-mark.rb
 - lib/rack/dev-mark/error.rb
+- lib/rack/dev-mark/i18n_helper.rb
 - lib/rack/dev-mark/middleware.rb
 - lib/rack/dev-mark/rails_options.rb
 - lib/rack/dev-mark/railtie.rb
@@ -104,6 +105,7 @@ files:
 - misc/theme/title.png
 - rack-dev-mark.gemspec
 - spec/generators/rack/dev-mark/install_generator_spec.rb
+- spec/rack/dev-mark/i18n_helper_spec.rb
 - spec/rack/dev-mark/middleware_spec.rb
 - spec/rack/dev-mark/rails_options_spec.rb
 - spec/rack/dev-mark/railtie_spec.rb
@@ -144,6 +146,7 @@ specification_version: 4
 summary: Differentiate development environment from production
 test_files:
 - spec/generators/rack/dev-mark/install_generator_spec.rb
+- spec/rack/dev-mark/i18n_helper_spec.rb
 - spec/rack/dev-mark/middleware_spec.rb
 - spec/rack/dev-mark/rails_options_spec.rb
 - spec/rack/dev-mark/railtie_spec.rb