rack-freeze 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee544065c394af39bb0593a17193538594a7c34
-  data.tar.gz: d82a8b27bc3277c9e030adddb4ac32ef5ff4f210
+  metadata.gz: 3bc56dafbfc276a4b560e73d0043a29a42197022
+  data.tar.gz: 7c17bb6e88b2b6cf4183b278a9d5e46bef0fb429
 SHA512:
-  metadata.gz: d6998afca2847208bb4280501c9ac17dd8130704b9a4b3403595350ab03d1946387eca7ca8e62afe82d8a041b0fb566c45181b82556cc0ec629b1ec4727f6cab
-  data.tar.gz: 0d4f2e3f8223bf34cc90f9bf8c28ec428fda2d28a5ce259f27bdfaa00ac33603d32733e048be1371ae396a8843a73afa08c337774a2ef6d70f286df87fb369ba
+  metadata.gz: c42c134837c30103be30583c162d96e9ee70d6815aa09dfd8452a8d968aab7039b86c158854a6b607c4e461d9a2c54e8004cbd9aaa7707f4cadf4f82c95ae585
+  data.tar.gz: ef9492576931fabef0b648e6cb441c537de7fdcca8eefdda294b1f31cd861054ca634319a01f309885ea16d4ff15d6847df290793b7ed3bd57cef081ca03a48b

data/README.md

@@ -32,7 +32,7 @@ Now all your middleware will be frozen by default.
 
 ### What bugs does this fix?
 
-It guarantees, within the limits of the freeze API, that middleware won't mutate during a request.
+It guarantees as much as is possible, that middleware won't mutate during a request.
 
 ```ruby
 # This modifies `Rack::Builder#use` and `Rack::Builder#to_app` to generate a frozen stack of middleware.
@@ -54,7 +54,39 @@ end
 use NonThreadSafeMiddleware
 ```
 
-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.
+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. [5 out of 4 dentists agree that multi-threaded programming is hard to get right](http://www.rubyinside.com/does-the-gil-make-your-ruby-code-thread-safe-6051.html).
+
+### How to write thread-safe middleware?
+
+There are two options: Don't mutate state, or if you need to for the purposes of performance, implement `#freeze` and use data-structures from [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby).
+
+```ruby
+require 'concurrent/map'
+
+# Cache every request based on the path. Don't do this in production :)
+class CacheEverythingForever
+	def initialize(app)
+		@app = app
+		@cache_all_the_things = Concurrent::Map.new
+	end
+	
+	# Because you supply your own implementation of #freeze, Rack::Freeze won't touch this middleware.
+	def freeze
+		return self if frozen?
+		
+		@app.freeze
+		
+		super
+	end
+	
+	def call(env)
+		# Use the thread-safe `Concurrent::Map` to fetch the value or store it if it doesn't exist already.
+		@cache_all_the_things.fetch_or_store(env[Rack::PATH_INFO]) do
+			@app.call(env)
+		end
+	end
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,12 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec) do |task|
-	begin
-		require('simplecov/version')
-		task.rspec_opts = %w{--require simplecov} if ENV['COVERAGE']
-	rescue LoadError
-	end
-end
+RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec

data/lib/rack/freeze.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'freeze/version'
-
-require_relative 'freeze/freezer'
 require_relative 'freeze/builder'
+
+# Enforce the policy globally.
+Rack::Builder.prepend(Rack::Freeze::Builder)

data/lib/rack/freeze/builder.rb

@@ -25,7 +25,11 @@ module Rack
 	module Freeze
 		module Builder
 			def use(klass, *args, &block)
-				super(Freeze[klass], *args, &block)
+				super Freezer.new(klass), *args, &block
+			end
+			
+			def run(app)
+				super app.freeze
 			end
 			
 			def to_app
@@ -33,6 +37,4 @@ module Rack
 			end
 		end
 	end
-	
-	Builder.prepend(Freeze::Builder)
 end

data/lib/rack/freeze/freezer.rb

@@ -20,28 +20,18 @@
 
 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)
+		class Freezer
+			def initialize(klass)
+				@klass = klass
+			end
 			
-			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
+			def to_s
+				"#{self.class}<#{@klass}>"
 			end
 			
-			return subclass
+			def new(*args, &block)
+				@klass.new(*args, &block).freeze
+			end
 		end
 	end
 end

data/lib/rack/freeze/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-freeze
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -75,7 +75,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".simplecov"
 - ".travis.yml"
 - Gemfile
 - README.md

data/.simplecov

@@ -1,9 +0,0 @@
-
-SimpleCov.start do
-	add_filter "/spec/"
-end
-
-if ENV['TRAVIS']
-	require 'coveralls'
-	Coveralls.wear!
-end