rack-dev-mark 0.6.3 → 0.6.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTIwYWU4ODJlNDk4YTRmOWYwNzlmMDU2YjcwN2UwNTEwYzA5YmU2Ng==
+    ZGQ4OTM0MjZiOGJkMDAxYTNhOTNmNGMzYTQwYjVjNGZlOTYzMTMzOQ==
   data.tar.gz: !binary |-
-    YzU3OGZhNTFkNjdjNTdjNGVhZjk4NzNkMjYxODQ2NGI5NzdlMDVkZg==
+    ZTMxN2EyYjhhZDE0YWRhYTkxYjJhNDc3MjlkMzhmMGY0YjM1ODE1YQ==
 SHA512:
   metadata.gz: !binary |-
-    Mjk4NTVkMDk3ZDc4MThkMzNiYjNjMDFlNzliM2U2ZWI0ZDNlZjhmYmQ0NWI3
-    MWQxMjQ0ZWVlZDEwOGVlZGNjMWM0YTY4ZWM3ZTE4NDE1NTNlOGU3ZTFkYmQ4
-    NTM0ZjUxYjg0OGI1ODIwZjlmNmM2MzJiNGE1ZDUyZWYyYzYzMzQ=
+    NjJiMmI5N2M3Nzc1ZjhiNWZjNWY0MDZlOWJkMzkyZGIwMjNmNTU4YmY5MTYz
+    YmUyZmY1ZTY1ZDZmMTFiZTY4ZDMxZjk0MGFhNzUwNzY5YjI1YmRjMWY0YzNk
+    NmU4YWFjZTRmYTA5ODg5NzQ1YTFiOTVjY2E5YTUzZmYxZGU0NjA=
   data.tar.gz: !binary |-
-    YjYxMmEyZjFjMjdlODc0ZmIxNmI3ZWUyMTY3MzcwNDdlNTA0ZTY2MmM5NzAx
-    ODMwNTVjZWNiNGQ1MTJmNmM1MmI3ZDM0YTNhYThhOGM2Y2Y2ZDYzYjA2OWYy
-    YjFjNGU1YmE5OGMwMzZlNjJhN2M1ODk5ZWY3MmFlMDhiMzcyMTU=
+    NjUwOTM0ZThmYmY2ZTQ1ZTUzMGI0OGVlOWFhMjM2YjEyNmU1YThmYzJjMzY4
+    ZTA3ZjA4MjkzMjQzMDM4NGYwYWU3ODI0YjdlMzkwOWI0MzUwODA4YWJkYTFm
+    ZjA5ODQxMjUzYTVlYWQzOTQ5ZDBkYTgzNTRiMjdjNTUzMTc5MDE=

data/COMPATIBILITY.md

@@ -0,0 +1,32 @@
+# Compatibility with Other Middlewares
+
+## Rack::Deflater
+
+Some people ask rack-dev-mark does not work with `Rack::Delfater`. Those who ask this question typically insert `Rack::Deflater` by `config.middleware.use Rack::Deflater`. To deflate all the response including the error pages, you need to put the middleware before `ActionDispatch::ShowExceptions`. So the order of those 3 middlewares including `rack-dev-mark` looks like below.
+
+```ruby
+use Rack::Deflater
+use Rack::DevMark::Middleware
+use ActionDispatch::ShowExceptions
+```
+
+To make the order above, you can have the following settings for `Rack::Deflater`.
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    config.middleware.insert_before ActionDispatch::ShowExceptions, Rack::Deflater
+  end
+end
+```
+
+Of course, you can stick the `config.middleware.use Rack::Deflater` by the following settings for `rack-dev-mark`.
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    config.rack_dev_mark.insert_after Rack::Deflater
+  end
+end
+```
+

data/README.md

@@ -93,6 +93,22 @@ heroku config:set RACK_DEV_MARK_ENV=staging
 
 That's it!
 
+#### Custom Rack Middleware Order
+
+`rack-dev-mark` should be inserted before `ActionDispatch::ShowExceptions` becase we want to show the dev mark on the error pages as well. However, it does not work well if it's inserted by incorrect order with some other rack middlewares. So, it provides the setting of inserted place.
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    config.rack_dev_mark.insert_before SomeOtherMiddleware
+  end
+end
+```
+
+`config.rack_dev_mark.insert_after` is also available to insert `rack-dev-mark` after a middleware.
+
+[Here](COMPATIBILITY.md) is the compatibility list which many people often ask.
+
 ## Custom Theme
 
 Although the default themes are `title` and `github_fork_ribbon`, you can create your own themes inheriting `Rack::DevMark::Theme::Base`.

data/VERSION

@@ -1 +1 @@
-0.6.3
+0.6.4

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

@@ -13,6 +13,10 @@ module Rack
     config.rack_dev_mark.enable = !Rails.env.production?
     # 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
+    # config.rack_dev_mark.insert_after SomeOtherMiddleware
 
         EOS
         end

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

@@ -0,0 +1,21 @@
+module Rack
+  module DevMark
+    class RailsOptions
+      attr_accessor :enable, :theme
+
+      alias_method :custom_theme, :theme
+      alias_method :custom_theme=, :theme=
+
+      %w(before after).each do |type|
+        method_name = "insert_#{type}"
+        define_method method_name do |middleware|
+          @insert_type = [method_name, middleware]
+        end
+      end
+
+      def insert_type
+        @insert_type ||= []
+      end
+    end
+  end
+end

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

@@ -1,17 +1,25 @@
 require 'rails'
+require_relative 'rails_options'
 
 module Rack
   module DevMark
     class Railtie < Rails::Railtie
-      config.rack_dev_mark = ActiveSupport::OrderedOptions.new
+      config.rack_dev_mark = RailsOptions.new
 
       initializer "rack-dev-mark.configure_rails_initialization" do |app|
         if app.config.rack_dev_mark.enable || Rack::DevMark.rack_dev_mark_env
-          racks = [ActionDispatch::ShowExceptions, Rack::DevMark::Middleware]
+          racks = []
+
+          insert_type = app.config.rack_dev_mark.insert_type
+          insert_method = insert_type[0] || 'insert_before'
+          racks << (insert_type[1] || ActionDispatch::ShowExceptions)
+
+          racks << Rack::DevMark::Middleware
           if theme = app.config.rack_dev_mark.theme || app.config.rack_dev_mark.custom_theme
             racks << theme
           end
-          app.config.app_middleware.insert_before *racks
+
+          app.config.app_middleware.send(insert_method, *racks)
         end
       end
     end

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

@@ -34,6 +34,10 @@ module MyApp
     config.rack_dev_mark.enable = !Rails.env.production?
     # 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
+    # config.rack_dev_mark.insert_after SomeOtherMiddleware
 
     # ...
   end
@@ -41,5 +45,12 @@ end
       EOS
     end
   end
+
+  describe "#target_path (private)" do
+    subject { Rack::DevMark::InstallGenerator.new }
+    it "returns 'config/application.rb'" do
+      expect(subject.__send__(:target_path)).to eq('config/application.rb')
+    end
+  end
 end
 end

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

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+if defined?(::Rails)
+describe Rack::DevMark::RailsOptions do
+  subject { Rack::DevMark::RailsOptions.new }
+  it do
+    is_expected.to respond_to(:enable)
+    is_expected.to respond_to(:enable=)
+    is_expected.to respond_to(:theme)
+    is_expected.to respond_to(:theme=)
+    is_expected.to respond_to(:insert_type)
+    is_expected.not_to respond_to(:insert_type=)
+  end
+  it "has aliases of theme methods" do
+    expect(subject.method(:theme)).to eq(subject.method(:custom_theme))
+    expect(subject.method(:theme=)).to eq(subject.method(:custom_theme=))
+  end
+  describe "#insert_before" do
+    it "has the implicit setter of insert_type" do
+      subject.insert_before 'something'
+      expect(subject.insert_type).to eq(['insert_before', 'something'])
+    end
+  end
+  describe "#insert_after" do
+    it "has the implicit setter of insert_type" do
+      subject.insert_after 'something'
+      expect(subject.insert_type).to eq(['insert_after', 'something'])
+    end
+  end
+end
+end

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

@@ -15,7 +15,9 @@ describe Rack::DevMark::Railtie do
     end
     it 'inserts the middleware' do
       @app.initialize!
-      expect(@app.middleware.middlewares).to include(Rack::DevMark::Middleware)
+      middlewares = @app.middleware.middlewares
+      expect(middlewares).to include(Rack::DevMark::Middleware)
+      expect(middlewares.index(Rack::DevMark::Middleware)).to eq(middlewares.index(ActionDispatch::ShowExceptions) - 1)
     end
   end
   context "rack_dev_mark disable" do
@@ -58,5 +60,35 @@ describe Rack::DevMark::Railtie do
       expect(theme).to receive(:setup)
     end
   end
+  context "rack_dev_mark insert_before" do
+    let(:dummy_middleware) { Class.new{ define_method(:initialize) { |_| }; define_method(:to_s) { 'Dummy' } } }
+    before do
+      @app.config.middleware.use dummy_middleware
+      @app.config.rack_dev_mark.enable = true
+      @app.config.rack_dev_mark.insert_before dummy_middleware
+    end
+    it 'inserts the middleware before the other middleware' do
+      @app.initialize!
+      middlewares = @app.middleware.middlewares
+      expect(middlewares).to include(Rack::DevMark::Middleware)
+      expect(middlewares).to include(dummy_middleware)
+      expect(middlewares.index(Rack::DevMark::Middleware)).to eq(middlewares.index(dummy_middleware) - 1)
+    end
+  end
+  context "rack_dev_mark insert_after" do
+    let(:dummy_middleware) { Class.new{ define_method(:initialize) { |_| }; define_method(:to_s) { 'Dummy' } } }
+    before do
+      @app.config.middleware.use dummy_middleware
+      @app.config.rack_dev_mark.enable = true
+      @app.config.rack_dev_mark.insert_after dummy_middleware
+    end
+    it 'inserts the middleware before the other middleware' do
+      @app.initialize!
+      middlewares = @app.middleware.middlewares
+      expect(middlewares).to include(Rack::DevMark::Middleware)
+      expect(middlewares).to include(dummy_middleware)
+      expect(middlewares.index(Rack::DevMark::Middleware)).to eq(middlewares.index(dummy_middleware) + 1)
+    end
+  end
 end
 end

data/spec/support/fork_helper.rb

@@ -10,7 +10,7 @@ shared_context 'forked spec' do
     end
     Process.waitpid2 pid
     res = Marshal.load(read)
-    example.example.send :set_exception, res if res && !res.empty?
+    example.example.send :set_exception, res if res && res.to_s != ''
     read.close
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-dev-mark
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Daisuke Taniwaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- COMPATIBILITY.md
 - Gemfile
 - LICENSE
 - README.md
@@ -86,6 +87,7 @@ files:
 - lib/rack/dev-mark.rb
 - lib/rack/dev-mark/error.rb
 - lib/rack/dev-mark/middleware.rb
+- lib/rack/dev-mark/rails_options.rb
 - lib/rack/dev-mark/railtie.rb
 - lib/rack/dev-mark/theme.rb
 - lib/rack/dev-mark/theme/base.rb
@@ -103,6 +105,7 @@ files:
 - rack-dev-mark.gemspec
 - spec/generators/rack/dev-mark/install_generator_spec.rb
 - spec/rack/dev-mark/middleware_spec.rb
+- spec/rack/dev-mark/rails_options_spec.rb
 - 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
@@ -142,6 +145,7 @@ summary: Differentiate development environment from production
 test_files:
 - spec/generators/rack/dev-mark/install_generator_spec.rb
 - spec/rack/dev-mark/middleware_spec.rb
+- spec/rack/dev-mark/rails_options_spec.rb
 - 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