rack-freeze 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cdf04b44d618902787c84714c6cef7dded167a5
-  data.tar.gz: d92e028054cdd5720b964b30af568e3e25ffc63b
+  metadata.gz: aee544065c394af39bb0593a17193538594a7c34
+  data.tar.gz: d82a8b27bc3277c9e030adddb4ac32ef5ff4f210
 SHA512:
-  metadata.gz: 9e438394bf1cb5aa17b999cc38c6f770e1e1a2f2234c7fd038e572d2da34baa074e394ddea5ffdfa1c1844c1ef835eec8d81fb5cac3487b45677d7b2e4bf3ec4
-  data.tar.gz: 074e09463194272f78e95d0ca47ab9a97bcd7862296837c632334b472832268e809c7898a3f679b22b60e74a797eb1d3b0cd96065d010caf5bb8c4014c16ba55
+  metadata.gz: d6998afca2847208bb4280501c9ac17dd8130704b9a4b3403595350ab03d1946387eca7ca8e62afe82d8a041b0fb566c45181b82556cc0ec629b1ec4727f6cab
+  data.tar.gz: 0d4f2e3f8223bf34cc90f9bf8c28ec428fda2d28a5ce259f27bdfaa00ac33603d32733e048be1371ae396a8843a73afa08c337774a2ef6d70f286df87fb369ba

data/.rspec

@@ -1,2 +1,4 @@
 --format documentation
 --color
+--require spec_helper
+--warnings

data/README.md

@@ -20,52 +20,41 @@ Add this line to your application's Gemfile:
 gem 'rack-freeze'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rack-freeze
-
 ## Usage
 
-For existing rack middleware, simply wrap it:
+Add this to your config.ru:
 
 ```ruby
-use Rack::Freeze[Rack::Logger]
+require 'rack/freeze'
 ```
 
-This will make a subclass of `Rack::Logger` if required with a working implementation of `#freeze`.
-
-In your `config.ru`, you prepare your app using the `#warmup method`;
-
-```ruby
-warmup do |app|
-	# Recursively freeze all the middleware so that mutation bugs are detected.
-	app.freeze
-end
-```
+Now all your middleware will be frozen by default.
 
 ### What bugs does this fix?
 
-So, instead of writing
+It guarantees, within the limits of the freeze API, that middleware won't mutate during a request.
 
 ```ruby
-use External::Middleware
-```
-
-you write
+# This modifies `Rack::Builder#use` and `Rack::Builder#to_app` to generate a frozen stack of middleware.
+require 'rack/freeze'
+
+class NonThreadSafeMiddleware
+	def initialize(app)
+		@app = app
+		@state = 0
+	end
+	
+	def call(env)
+		@state += 1
+		
+		return @app.call(env)
+	end
+end
 
-```ruby
-use Rack::Freeze[External::Middleware]
+use NonThreadSafeMiddleware
 ```
 
-That ensures that `External::Middleware` will correctly freeze itself and all subsequent apps. Additionally, if `External::Middleware` mutates it's state, it will throw an exception. In a multi-threaded web-server, unprotected mutation of internal state will lead to undefined behavior.
-
-### Thar be the Monkeys
-
-Some Rack middleware is not easy to patch in a generic way, e.g. `Rack::URLMap`. As these are identified, they will be monkey patched by this gem automatically. Going forward, I hope to bring attention to this issue and ideally integrate these changes directly into Rack.
+As `NonThreadSafeMiddleware` mutates it's state `@state += 1`, it will raise a `RuntimeError`. In a multi-threaded web-server, unprotected mutation of internal state will lead to undefined behavior.
 
 ## Contributing
 

data/lib/rack/freeze.rb

@@ -20,34 +20,5 @@
 
 require_relative 'freeze/version'
 
-require_relative 'freeze/sendfile'
-require_relative 'freeze/show_exceptions'
-require_relative 'freeze/urlmap'
-
-module Rack
-	module Freeze
-		# Check if the given klass overrides `Kernel#freeze`.
-		def self.implements_freeze?(klass)
-			klass.instance_method(:freeze).owner != Kernel
-		end
-		
-		# Generate a subclass with a generic #freeze method to freeze all instance variables.
-		def self.[] klass
-			# Check if the class already has a custom implementation of #freeze.. which we assume works correctly.
-			return klass if implements_freeze?(klass)
-			
-			subclass = Class.new(klass) do
-				def freeze
-					# This ensures that all class variables are frozen.
-					self.instance_variables.each do |name|
-						self.instance_variable_get(name).freeze
-					end
-					
-					super
-				end
-			end
-			
-			return subclass
-		end
-	end
-end
+require_relative 'freeze/freezer'
+require_relative 'freeze/builder'

data/lib/rack/freeze/{urlmap.rb → builder.rb}

@@ -18,15 +18,21 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rack/builder'
+require_relative 'freezer'
+
 module Rack
-	class URLMap
-		def freeze
-			@map.each do |location, app|
-				location.freeze
-				app.freeze
+	module Freeze
+		module Builder
+			def use(klass, *args, &block)
+				super(Freeze[klass], *args, &block)
 			end
 			
-			super
+			def to_app
+				super.freeze
+			end
 		end
 	end
+	
+	Builder.prepend(Freeze::Builder)
 end

data/lib/rack/freeze/{sendfile.rb → freezer.rb}

@@ -19,13 +19,29 @@
 # THE SOFTWARE.
 
 module Rack
-	class Sendfile
-		def freeze
-			@app.freeze
-			@variation.freeze
-			@mappings.freeze
+	module Freeze
+		# Check if the given klass overrides `Kernel#freeze`.
+		def self.implements_freeze?(klass)
+			klass.instance_method(:freeze).owner != Kernel
+		end
+		
+		# Generate a subclass with a generic #freeze method to freeze all instance variables.
+		def self.[] klass
+			# Check if the class already has a custom implementation of #freeze.. which we assume works correctly.
+			return klass if implements_freeze?(klass)
+			
+			subclass = Class.new(klass) do
+				def freeze
+					# This ensures that all class variables are frozen.
+					self.instance_variables.each do |name|
+						self.instance_variable_get(name).freeze
+					end
+					
+					super
+				end
+			end
 			
-			super
+			return subclass
 		end
 	end
 end

data/lib/rack/freeze/version.rb

@@ -20,6 +20,6 @@
 
 module Rack
 	module Freeze
-		VERSION = "1.0.0"
+		VERSION = "1.1.0"
 	end
 end

data/rack-freeze.gemspec

@@ -2,20 +2,22 @@
 require_relative 'lib/rack/freeze/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rack-freeze"
-  spec.version       = Rack::Freeze::VERSION
-  spec.authors       = ["Samuel Williams"]
-  spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.name          = "rack-freeze"
+	spec.version       = Rack::Freeze::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 
-  spec.summary       = "Provides a policy for frozen rack middleware."
-  spec.homepage      = "https://github.com/ioquatix/rack-freeze"
+	spec.summary       = "Provides a policy for frozen rack middleware."
+	spec.homepage      = "https://github.com/ioquatix/rack-freeze"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency "rack", "~> 2.0"
+  
+	spec.add_development_dependency "bundler", "~> 1.14"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-freeze
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,9 +81,8 @@ files:
 - README.md
 - Rakefile
 - lib/rack/freeze.rb
-- lib/rack/freeze/sendfile.rb
-- lib/rack/freeze/show_exceptions.rb
-- lib/rack/freeze/urlmap.rb
+- lib/rack/freeze/builder.rb
+- lib/rack/freeze/freezer.rb
 - lib/rack/freeze/version.rb
 - rack-freeze.gemspec
 homepage: https://github.com/ioquatix/rack-freeze

data/lib/rack/freeze/show_exceptions.rb

@@ -1,29 +0,0 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-module Rack
-	class ShowExceptions
-		def freeze
-			@app.freeze
-			
-			super
-		end
-	end
-end