rack-dev-mark 0.7.1 → 0.7.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWVmMmU1NGIxYWQ3NGM5OTQ1ODE3NzE4NmUzMGE2MDliY2E3NjczNA==
-  data.tar.gz: !binary |-
-    OTkwYThlNzUzODY2MzQzYjFhY2MzMzc0MTBlNGQxZDQwZGVmY2IyYw==
+SHA1:
+  metadata.gz: e536e84497366fccf4c91419da55af604cce73e8
+  data.tar.gz: 99358d2e3e4cf7723501ec7040199f8be07bdbe0
 SHA512:
-  metadata.gz: !binary |-
-    NGQ1OTBkYjQ1Mjg3ODk5NTMyYWExYjE0YzlkYmVlMmYxOTVmNWZhYWUzODg5
-    NTkyMGM4ZjEzODE4ZjNkNDE1NGE1NmJkNTVkMGM4YjNiMTM1OGY5ODg4MmQ4
-    OTM2M2MwY2E3NjJiOTMzN2MzNDBiY2IwM2JlOGM0YTJmNDJhMjY=
-  data.tar.gz: !binary |-
-    YzVlZDgwOTVkMzBjNDY0ZGNmOGJhNzEyMzZjMDE0MmZjOTM3ZGVkNzkxYjNk
-    MjMwNWU1MGQxNWI5NDAxMzlmODg2NWZlNzYxODE4MzAyOTA1ODJhMGRiNjFl
-    MjZmNTBlZjU0NjI2MThjOTYwY2FkMDYzMzNiNDk5MTMyN2M2NDk=
+  metadata.gz: 82eb7b6a40748a4a7accceb112e790d272542ecb476131f70d5a1c4b79a11da7c9d4dc58fd37180e44311d4f507dcafc6279ec7612bd4e00f833679125cedd6e
+  data.tar.gz: 93ab4550f6eb4b7233ecfc6d382cbb547cdd3335c2d98d6f6eb720cb701cf48fa472e84e02b107341bef156892b33d294544e277f67bd43ecf29a089383b7afd

data/README.md

@@ -8,7 +8,11 @@
 
 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/).
+[The running sample](http://rack-dev-mark.dtaniwaki.com/) is available.
+
+You can also try this gem on Heroku.
+
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/dtaniwaki/rack-dev-mark-sample-app)
 
 ## Screenshot
 
@@ -120,6 +124,27 @@ module MyApp
     config.rack_dev_mark.env = 'foo'
   end
 end
+```
+
+#### Temporarily disable the dev mark
+
+`skip_rack_dev_mark` controller helper works like `around_filter`.
+
+```ruby
+class FooController < ApplicationController
+  skip_rack_dev_mark except: [:iframe]
+
+  def index
+    # Do something
+  end
+
+  def iframe
+    # Do something
+  end
+end
+```
+
+In this case, only `index` action will insert the dev mark.
 
 ## I18n Support
 

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.7.3

data/lib/rack/dev-mark.rb

@@ -32,6 +32,14 @@ module Rack
         @timestamp = timestamp.is_a?(Time) ? timestamp : Time.parse(timestamp)
       end
 
+      def tmp_disabled
+        @tmp_disabled ||= false
+      end
+
+      def tmp_disabled=(v)
+        @tmp_disabled = !!v
+      end
+
       def rack_dev_mark_env
         s = ENV['RACK_DEV_MARK_ENV']
         s.to_s == '' ? nil : s

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

@@ -0,0 +1,25 @@
+module Rack
+  module DevMark
+    module ActionControllerHelpers
+      module ClassMethods
+        def skip_rack_dev_mark(options = {})
+          before_filter options do
+            disable_rack_dev_mark
+          end
+        end
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      def disable_rack_dev_mark
+        Rack::DevMark.tmp_disabled = true
+      end
+
+      def enable_rack_dev_mark
+        Rack::DevMark.tmp_disabled = false
+      end
+    end
+  end
+end

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

@@ -14,13 +14,15 @@ module Rack
       end
       
       def call(env)
+        Rack::DevMark.tmp_disabled = false
+
         status, headers, response = @app.call(env)
 
         headers = HeaderHash.new(headers)
 
         headers['X-Rack-Dev-Mark-Env'] = CGI.escape Rack::DevMark.env
 
-        if headers['Content-Type'].to_s =~ %r{\btext/html\b}i
+        if !Rack::DevMark.tmp_disabled && headers['Content-Type'].to_s =~ %r{\btext/html\b}i
           new_body = ''
           response.each do |b|
             begin

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

@@ -1,5 +1,6 @@
 require 'rails'
 require_relative 'rails_options'
+require_relative 'action_controller_helpers'
 
 module Rack
   module DevMark
@@ -28,6 +29,12 @@ module Rack
           Rack::DevMark.env = app.config.rack_dev_mark.env
         end
       end
+
+      initializer "rack-dev-mark.load_controller_helpers", after: "rack-dev-mark.insert_middleware" do |app|
+        ActiveSupport.on_load :action_controller do
+          include Rack::DevMark::ActionControllerHelpers
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+if defined?(::Rails)
+require 'action_controller'
+describe Rack::DevMark::ActionControllerHelpers do
+  let(:controller_klass) do
+    Class.new(ActionController::Base) do
+      skip_rack_dev_mark
+
+      def disabled_action
+        puts 'test'
+        render inline: '<html><head></head><body></body></html>'
+      end
+
+      def enabled_action
+        render inline: '<html><head></head><body></body></html>'
+      end
+    end
+  end
+  let(:controller) { controller_klass.new }
+
+  include_context 'forked spec'
+
+  before do
+    @app = Class.new(::Rails::Application)
+    @app.config.active_support.deprecation = :stderr
+    @app.config.eager_load = false
+    @app.config.rack_dev_mark.enable = true
+    @app.initialize!
+  end
+
+  describe "#disable_rack_dev_mark" do
+    it "sets Rack::DevMark.tmp_disabled true" do
+      expect(Rack::DevMark).to receive(:tmp_disabled=).with(true)
+      controller.disable_rack_dev_mark
+    end
+  end
+  describe "#enable_rack_dev_mark" do
+    it "sets Rack::DevMark.tmp_disabled false" do
+      expect(Rack::DevMark).to receive(:tmp_disabled=).with(false)
+      controller.enable_rack_dev_mark
+    end
+  end
+
+  describe "::skip_rack_dev_mark" do
+    it "does not add dev mark" do
+      skip "need a spec test"
+    end
+  end
+end
+end

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

@@ -80,4 +80,15 @@ describe Rack::DevMark::Middleware do
       subject.call({})
     end
   end
+  context "tmp_disabled flag" do
+    before do
+      allow(Rack::DevMark).to receive(:tmp_disabled).and_return(true)
+    end
+    it "does not raise an exception but write it down in $stderr" do
+      status, headers, body = subject.call({})
+      expect(status).to eq(200)
+      expect(headers).to include('Content-Type' => 'text/html; charset=utf-8')
+      expect(body).to eq(["response"])
+    end
+  end
 end

data/spec/rack/dev-mark_spec.rb

@@ -77,6 +77,22 @@ describe Rack::DevMark do
       expect(subject.timestamp).to eq(Time.new(2014, 4, 1))
     end
   end
+  describe "::tmp_disabled" do
+    it "returns false as default" do
+      expect(subject.tmp_disabled).to be false
+    end
+  end
+  describe "::tmp_disabled=" do
+    it "sets true" do
+      subject.tmp_disabled = true
+      expect(subject.tmp_disabled).to be true
+    end
+
+    it "sets other value as true" do
+      subject.tmp_disabled = 1
+      expect(subject.tmp_disabled).to be true
+    end
+  end
   describe "::rack_dev_mark_env" do
     it "returns nil" do
       ENV['RACK_DEV_MARK_ENV'] = nil

data/spec/spec_helper.rb

@@ -46,6 +46,7 @@ RSpec.configure do |config|
     ENV['RACK_ENV'] = @rack_env
     ENV['RAILS_ENV'] = @rails_env
     Rack::DevMark.env = nil
+    Rack::DevMark.tmp_disabled = nil
   end
 end
 

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rack-dev-mark
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-21 00:00:00.000000000 Z
+date: 2014-08-16 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: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         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 environment from production
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - COMPATIBILITY.md
 - Gemfile
 - LICENSE
@@ -85,6 +85,7 @@ files:
 - lib/generators/rack/dev-mark/install_generator.rb
 - lib/rack-dev-mark.rb
 - lib/rack/dev-mark.rb
+- lib/rack/dev-mark/action_controller_helpers.rb
 - lib/rack/dev-mark/error.rb
 - lib/rack/dev-mark/i18n_helper.rb
 - lib/rack/dev-mark/middleware.rb
@@ -105,6 +106,7 @@ files:
 - misc/theme/title.png
 - rack-dev-mark.gemspec
 - spec/generators/rack/dev-mark/install_generator_spec.rb
+- spec/rack/dev-mark/action_controller_helpers_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
@@ -130,12 +132,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: []
@@ -146,6 +148,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/action_controller_helpers_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