reloadable_middleware 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0281e16f5f7150ffe47f3e5925013d3e4abdc9f2b98d3935f1a91a2c338647f
+  data.tar.gz: 6a26b27aa61dd2c294295a488d8cd4c862498381cfdfe33adba6663a9ef04bda
+SHA512:
+  metadata.gz: f282832e0fc9d22624e5f0db462318d1eb174fd6a5722632f7842b0d2a6cf2a5393b01165c0807b662be3c13e701a1862aeb9dfd33c502bd68d000b1cc845da6
+  data.tar.gz: 7961961f2f5d2b0db76180a99663c2bad75af91f3b5831214fc2ee62623f4cd963eaa1c0a06ac3440fadb34bef386959986a5091538abf9ca784049147952bbb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Bundler lock
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in reloadable_middleware.gemspec
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# reloadable_midleware
+
+Makes any Rack middleware reloadable. Or, rather - wraps a given piece of Rack middleware with a
+special module, which will call `.new` on your middleware at `call()` time, not at instantiation
+time. This means that the Rack application stack is not going to contain an object reference and
+will be able to reload during constant teardown/setup.
+
+## Usage
+
+Replace your standard middleware initialization block:
+
+```ruby
+use CustomAuthentication, option: 'bar'
+```
+
+with this alteration:
+
+```ruby
+use ReloadableMiddleware.wrap(CustomAuthentication), option: 'bar'
+```
+
+This will make your middleware reloadable. In Rails, use
+
+```ruby
+Rails.application.config.middleware.use ReloadableMiddleware.wrap(MyMiddleware)
+```
+
+## Performance in production modes
+
+If you are running with `RACK_ENV` set to `production` or with `Rails.env.production? == true`
+the reloading will be disabled and you will have one instance of your middleware as usual. This
+reduces object churn, since Rack assumes that your entire app stack is going to be built once
+and then cached between requests - which helps performance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reloadable_middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reloadable_middleware
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julik/reloadable_middleware.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reloadable_middleware"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/reloadable_middleware.rb

@@ -0,0 +1,53 @@
+require_relative "reloadable_middleware/version"
+require_relative 'reloadable_middleware/railtie' if defined?(Rails)
+
+module ReloadableMiddleware
+  # Base class for the reloadable middleware. We need to save
+  # the middleware name somewhere, so this class will be
+  # subclassed dynamically and preconfigured with the
+  # correct middleware name, to be used by its `.to_s` return value
+  class Lazy
+    # Saves the app and the arguments for configuring the middleware and applies them
+    # when `call()` gets called.
+    def initialize(app, *args_for_middleware_new, &block_for_middleware_new)
+      @app = app
+      @args_for_middleware_new = args_for_middleware_new
+      @block_for_middleware_new = block_for_middleware_new.to_proc if block_for_middleware_new
+    end
+
+    # Instantiate the given middleware by name, on the spot, and call() it immediately
+    def call(env)
+      middleware_module = lookup_middleware_module
+      app_wrapped_with_middleware = middleware_module.new(@app, *@args_for_middleware_new, &@block_for_middleware_new)
+      app_wrapped_with_middleware.call(env) 
+    end
+
+    # This is needed since Rails, for instance, calls "to_s" on the middleware
+    # class when showing its middleware list. The output also is valid Ruby code,
+    # so we need to print something that can be pasted into code again. 
+    def self.to_s
+      "ReloadableMiddleware.wrap(#{@middleware_name})"
+    end
+
+    private
+
+    def lookup_middleware_module
+      middleware_module_name = self.class.instance_variable_get('@middleware_name')
+      # Rails constantize() on the cheap
+      middleware_module_name.split('::').reject(&:empty?).inject(Kernel) {|namespace, const_name| namespace.const_get(const_name) }
+    end
+  end
+
+  def self.wrap(middleware_class_or_name)
+    # Specific case: if the middleware is being _defined_ in production (Rails or bare Rack)
+    # instead of making it reloadable return the object itself, since we otherwise churn
+    # one instance of the middleware we wrap per request.
+    if ENV['RACK_ENV'] == 'production' || defined?(Rails.env) && Rails.env.production?
+      return middleware_class_or_name
+    else
+      middleware_module_name = middleware_class_or_name.to_s
+      Class.new(Lazy) { @middleware_name = middleware_module_name }
+    end
+  end
+end
+

data/lib/reloadable_middleware/version.rb

@@ -0,0 +1,3 @@
+module ReloadableMiddleware
+  VERSION = "1.0.0"
+end

data/reloadable_middleware.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "reloadable_middleware/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "reloadable_middleware"
+  spec.version       = ReloadableMiddleware::VERSION
+  spec.authors       = ["Julik Tarkhanov"]
+  spec.email         = ["me@julik.nl"]
+
+  spec.summary       = %q{ Wraps any Rack middleware with lazy resolve at call() }
+  spec.description   = %q{ Wraps any Rack middleware with lazy resolve at call() }
+  spec.homepage      = "https://github.com/julik/reloadable_middleware"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/julik/reloadable_middleware"
+    spec.metadata["changelog_uri"] = "https://github.com/julik/reloadable_middleware/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0")
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/reloadable_middleware_spec.rb

@@ -0,0 +1,69 @@
+RSpec.describe ReloadableMiddleware do
+  it "has a version number" do
+    expect(ReloadableMiddleware::VERSION).not_to be nil
+  end
+
+  it "wraps a given module with a reloading class, giving it a sensible to_s return value" do
+    class MiddlewareWithArguments
+      def initialize(app, frobnicate:)
+        @app = app
+        @frobnicate = frobnicate
+      end
+
+      def call(env)
+        raise "Should not call the same middleware object for the second time" if @got_called
+        @got_called = :yes
+
+        env['did_pass_middleware1'] = true
+        env['frobnicate'] = @frobnicate
+        @app.call(env)
+      end
+    end
+
+    class MiddlewareWithoutArguments
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        raise "Should not call the same middleware object for the second time" if @got_called
+        @got_called = :yes
+
+        env['did_pass_middleware2'] = true
+        @app.call(env)
+      end
+    end
+
+    reloadable_class = ReloadableMiddleware.wrap(MiddlewareWithArguments)
+    expect(reloadable_class.to_s).to include('MiddlewareWithArguments')
+
+    rack_app = ->(env) {
+      expect(env['did_pass_middleware1']).to eq(true)
+      expect(env['did_pass_middleware2']).to eq(true)
+      expect(env['frobnicate']).to eq('totally')
+    }
+    expect(rack_app).to receive(:call).twice.and_call_original
+
+    reloadable_class2 = ReloadableMiddleware.wrap(MiddlewareWithoutArguments)
+
+    # Build out a tiny Rack app stack
+    mounted_middleware = reloadable_class2.new(reloadable_class.new(rack_app, frobnicate: 'totally'))
+
+    # ...and call into it, twice. If our middleware objects were retained (as they are with standard
+    # Rack wrapping process) we will get an exception, since these particular middleware objects
+    # will only tolerate being called once.
+    mounted_middleware.call({})
+    mounted_middleware.call({})
+  end
+
+  it 'turns wrap() into a no-op if RACK_ENV is set to "production"' do
+    class SomeMiddleware
+    end
+
+    ENV['RACK_ENV'] = 'production'
+    wrapped = ReloadableMiddleware.wrap(SomeMiddleware)
+    expect(wrapped).to eq(SomeMiddleware)
+
+    ENV.delete('RACK_ENV')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "reloadable_middleware"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: reloadable_middleware
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: " Wraps any Rack middleware with lazy resolve at call() "
+email:
+- me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reloadable_middleware.rb
+- lib/reloadable_middleware/version.rb
+- reloadable_middleware.gemspec
+- spec/reloadable_middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/julik/reloadable_middleware
+licenses: []
+metadata:
+  homepage_uri: https://github.com/julik/reloadable_middleware
+  source_code_uri: https://github.com/julik/reloadable_middleware
+  changelog_uri: https://github.com/julik/reloadable_middleware/blob/master/CHANGELOG.md
+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: Wraps any Rack middleware with lazy resolve at call()
+test_files: []