rails-middleware-extensions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0d569aadcf19133ea15fb6dcf4cf29edfee4771a48a5b8564a15034d557cf5e
+  data.tar.gz: 7a663b4c4ef8c4ea6d165bce92e13e6c699d6fbd1cd752067cd9d53a75bd2f3f
+SHA512:
+  metadata.gz: 428b513ee007c4dbff6b9c2536ef652b3a52581bb4343224c9922124cd76de7acd6aa8228b00e741985f1d0ad9ab011fe7ec3d77e64656742498b061c1300805
+  data.tar.gz: 1116925495e1dadd85c89e193e66ed440b7ccbeaf0990372695a339d65245b9cffbe5b88281961272fe05448aaef8c966c976412494d9bffec6c217d58c04fe8

data/Gemfile

@@ -0,0 +1,2 @@
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile-rails-4.0.x', __FILE__)
+Bundler.load

data/README.md

@@ -0,0 +1,77 @@
+## rails-middleware-extensions [![Build Status](https://secure.travis-ci.org/camertron/rails-middleware-extensions.png?branch=master)](http://travis-ci.org/camertron/rails-middleware-extensions)
+
+Adds several additional operations useful for customizing your Rails middleware stack.
+
+## Installation
+
+`gem install rails-middleware-extensions`
+
+## Usage
+
+Just add this gem to your gemfile like so:
+
+```ruby
+gem 'rails-middleware-extensions'
+```
+
+## Extensions
+
+Currently two extensions are supported: `move` and `insert_unless_exists`.
+
+### Insert Unless Exists
+
+As the name implies, the given middleware will only be inserted if it has not already been added to the middleware stack. For example, here's how we might insert our custom `MyCustomMiddleware` middleware before `Rails::Logger`:
+
+```ruby
+config.middleware.insert_unless_exists(Rails::Logger, MyCustomMiddleware)
+```
+
+`#insert_unless_exists` supports all the arguments regular 'ol `#insert` supports, meaning you can also pass an index to insert before. Here's how to insert our custom middleware at the very beginning of the stack:
+
+```ruby
+config.middleware.insert_unless_exists(0, MyCustomMiddleware)
+```
+
+Finally, use `#insert_after_unless_exists` to insert a particular middleware _after_ another one. For example, to insert `MyCustomMiddleware` after `Rails::Logger`:
+
+```ruby
+config.middleware.insert_after_unless_exists(Rails::Logger, MyCustomMiddleware)
+```
+
+### Move
+
+As of Rails 5.0, it's not possible to delete a middleware and then re-add it (see [this issue](https://github.com/rails/rails/issues/26303)) because delete operations are always applied last. Instead, consider using `#move`. For example, to move our custom middleware before `Rails::Logger`:
+
+```ruby
+config.middleware.move(Rails::Logger, MyCustomMiddleware)
+```
+
+Consider `#move`'s cousin, `#move_after`, to move a piece of middleware after another:
+
+```ruby
+config.middleware.move_after(Rails::Logger, MyCustomMiddleware)
+```
+
+As with `#insert_unless_exists`, `#move` and `#move_after` also support numeric indices:
+
+```ruby
+config.middleware.move(0, MyCustomMiddleware)
+```
+
+## Running Tests
+
+`bundle exec rspec` should do the trick :) Rails-middleware extensions supports a number of Rails versions, hence all the Gemfiles. There is one Gemfile per supported Rails version. If you'd like to run tests against a particular version, use the `BUNDLE_GEMFILE` environment variable like so:
+
+```bash
+BUNDLE_GEMFILE=Gemfile-rails-4.1.x bundle exec rspec
+```
+
+By default tests will run against Rails 5.2.x.
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,16 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'bundler'
+require 'pry-byebug'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+require 'rails-middleware-extensions'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/lib/rails-middleware-extensions.rb

@@ -0,0 +1,11 @@
+require 'rails/version'
+require 'rails-middleware-extensions/middleware_stack'
+require 'rails-middleware-extensions/middleware_stack_proxy'
+
+module RailsMiddlewareExtensions
+  def rails5?
+    Rails::VERSION::STRING >= '5.0.0'
+  end
+
+  extend self
+end

data/lib/rails-middleware-extensions/middleware_stack.rb

@@ -0,0 +1,33 @@
+module ActionDispatch
+  class MiddlewareStack
+    def insert_unless_exists(target, source, *args, &block)
+      unless middlewares.include?(source)
+        insert_before(target, source, *args, &block)
+      end
+    end
+
+    alias_method :insert_before_unless_exists, :insert_unless_exists
+
+    def insert_after_unless_exists(target, source, *args, &block)
+      unless middlewares.include?(source)
+        insert_after(target, source, *args, &block)
+      end
+    end
+
+    def move(target, source, *args, &block)
+      index = assert_index(source, :before)
+      middlewares.delete_at(index)
+
+      insert(target, source, *args, &block)
+    end
+
+    alias_method :move_before, :move
+
+    def move_after(target, source, *args, &block)
+      index = assert_index(source, :after)
+      middlewares.delete_at(index)
+
+      insert_after(target, source, *args, &block)
+    end
+  end
+end

data/lib/rails-middleware-extensions/middleware_stack_proxy.rb

@@ -0,0 +1,35 @@
+module Rails
+  module Configuration
+    class MiddlewareStackProxy
+      def insert_before_unless_exists(*args, &block)
+        _ops_ << [__method__, args, block]
+      end
+
+      alias_method :insert_unless_exists, :insert_before_unless_exists
+
+      def insert_after_unless_exists(*args, &block)
+        _ops_ << [__method__, args, block]
+      end
+
+      def move_before(*args, &block)
+        _ops_ << [__method__, args, block]
+      end
+
+      alias_method :move, :move_before
+
+      def move_after(*args, &block)
+        _ops_ << [__method__, args, block]
+      end
+
+      private
+
+      def _ops_
+        if RailsMiddlewareExtensions.rails5?
+          @delete_operations
+        else
+          @operations
+        end
+      end
+    end
+  end
+end

data/lib/rails-middleware-extensions/version.rb

@@ -0,0 +1,3 @@
+module RailsMiddlewareExtensions
+  VERSION = '1.0.0'
+end

data/rails-middleware-extensions.gemspec

@@ -0,0 +1,25 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rails-middleware-extensions/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'rails-middleware-extensions'
+  s.version  = ::RailsMiddlewareExtensions::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/camertron/rails-middleware-extensions'
+
+  s.description = s.summary = 'Adds several additional operations useful for customizing your Rails middleware stack.'
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'railties', '>= 4.0'
+  s.add_dependency 'actionpack', '>= 4.0'
+
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+  s.require_path = 'lib'
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'README.md', 'Rakefile', 'rails-middleware-extensions.gemspec']
+end

data/spec/extensions_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe 'middleware extensions' do
+  class TestMiddleware
+    # at least make it _look_ like real middleware ;)
+    def initialize(*); end
+    def call(*); end
+  end
+
+  let(:app) do
+    Class.new(Rails::Application) do
+      config.eager_load = false
+    end
+  end
+
+  before do
+    unless RailsMiddlewareExtensions.rails5?
+      # Rails 4 unfortunately stores a number of things in class variables that survive
+      # creating new application instances. We have to clean things up here by forcibly
+      # resetting them all back to nil or we'll see some test pollution, i.e. middleware
+      # stacks from previous examples will persist into the contexts of other examples.
+
+      (Rails::Railtie::Configuration.class_variables - [:@@options]).each do |cv|
+        Rails::Railtie::Configuration.class_variable_set(cv, nil)
+      end
+
+      # Furthermore, Rails 4.0 raises an error if you try to subclass Rails::Application.
+      # It checks to see if Rails.application non-nil, so we set it to nil here as a
+      # workaround.
+      Rails.application = nil
+    end
+  end
+
+  describe '#insert*_unless_exists' do
+    it 'inserts the middleware' do
+      app.initializer('example') do |app|
+        app.middleware.insert_unless_exists(1, TestMiddleware)
+      end
+
+      app.initialize!
+
+      expect(app.middleware.middlewares.index(TestMiddleware)).to eq(1)
+      expect(app.middleware.middlewares.count { |m| m == TestMiddleware }).to eq(1)
+    end
+
+    it 'inserts the middleware after' do
+      app.initializer('example') do |app|
+        app.middleware.insert_after_unless_exists(1, TestMiddleware)
+      end
+
+      app.initialize!
+
+      expect(app.middleware.middlewares.index(TestMiddleware)).to eq(2)
+      expect(app.middleware.middlewares.count { |m| m == TestMiddleware }).to eq(1)
+    end
+
+    context 'when the middleware already exists' do
+      before do
+        app.initializer('before') do |app|
+          app.middleware.use(TestMiddleware)
+        end
+      end
+
+      it 'only includes the middleware once' do
+        app.initializer('example') do |app|
+          app.middleware.insert_unless_exists(1, TestMiddleware)
+        end
+
+        app.initialize!
+
+        expect(app.middleware.middlewares.count { |m| m == TestMiddleware }).to eq(1)
+      end
+    end
+  end
+
+  describe '#move' do
+    it 'asserts that the middleware is not in the first position when inserted' do
+      app.initializer('example') do |app|
+        app.middleware.insert(5, TestMiddleware)
+      end
+
+      app.initialize!
+
+      expect(app.middleware.middlewares.index(TestMiddleware)).to_not eq(0)
+    end
+
+    it 'moves the middleware to the desired position' do
+      app.initializer('example') do |app|
+        app.middleware.insert(5, TestMiddleware)
+        app.middleware.move(0, TestMiddleware)
+      end
+
+      app.initialize!
+
+      expect(app.middleware.middlewares.index(TestMiddleware)).to eq(0)
+    end
+
+    it 'moves the middleware into the desired position after' do
+      app.initializer('example') do |app|
+        app.middleware.insert(5, TestMiddleware)
+        app.middleware.move_after(0, TestMiddleware)
+      end
+
+      app.initialize!
+
+      expect(app.middleware.middlewares.index(TestMiddleware)).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.push(__dir__)
+
+require 'rails'
+require 'rspec'
+require 'pry-byebug'
+require 'rails-middleware-extensions'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rails-middleware-extensions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds several additional operations useful for customizing your Rails
+  middleware stack.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/rails-middleware-extensions.rb
+- lib/rails-middleware-extensions/middleware_stack.rb
+- lib/rails-middleware-extensions/middleware_stack_proxy.rb
+- lib/rails-middleware-extensions/version.rb
+- rails-middleware-extensions.gemspec
+- spec/extensions_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/camertron/rails-middleware-extensions
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Adds several additional operations useful for customizing your Rails middleware
+  stack.
+test_files: []