thread_hazardous 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32481830314be733321546098794f0d6a486faf3
+  data.tar.gz: 21cad240c23a412d93c88e4c608556bb994ea671
+SHA512:
+  metadata.gz: ae5005d936c819ec9ed80fe81f995842ff6d7eb4917929c3d68bc9af9770425b7d1e2b98c8cf7d7fdbd180fbf01013abcb10afb17b8b6c9542f611d38ea0814d
+  data.tar.gz: b398cc4c8d6105afa08b66374bb5381f2f0139c724be335056e3ce6debd1a1e70ce9fffe95ca13718a6a5ef97654bf92bb8b743c966e007821beed60455bc0b7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thread_hazardous.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jean Boussier
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,61 @@
+# ThreadHazardous
+
+Monkey patch thread_safe to make it faster in non thread safe applications
+
+_CAUTION: Use this gem at your own risk._**_
+
+If you use gems that depends on the `thread_safe` gem,
+e.g. Rails, but your application is not doing any threading, then `thread_hazardous` can bring you a few performance
+improvements at the cost of making these dependencies non thread safe.
+
+## Explanation
+
+`ThreadSafe::Cache` on MRI to provide thread safety wrap all it's method in a mutex.
+Also to ensure the cache won't be modified during an iteration, it clones the instance. So each iteration allocate an extra object.
+
+
+These operations themselves are not that costly, but they are often used in heavy hotspots, especially in Rails, so in the end it adds up.
+Here's a profiling real life application under real life load:
+
+```
+==================================
+  Mode: wall(1000)
+  Samples: 15836 (0.35% miss rate)
+  GC: 696 (4.40%)
+==================================
+TOTAL (pct)   SAMPLES (pct)   FRAME
+419   (2.6%)    419   (2.6%)  ThreadSafe::NonConcurrentCacheBackend#[]
+208   (1.3%)    208   (1.3%)  ThreadSafe::NonConcurrentCacheBackend#dupped_backend
+ 75   (0.5%)     75   (0.5%)  block in ThreadSafe::Cache#values
+```
+
+
+`thread_hazardous` simply monkey patch `ThreadSafe::Cache` to remove the mutex and not clone the instance on iteration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thread_hazardous'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thread_hazardous
+
+## Usage
+
+Nothing more to do, it's all automatic.
+
+## Contributing
+
+1. Fork it ( https://github.com/byroot/thread_hazardous/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*.rb']
+end
+
+task default: :test
+

data/lib/thread_hazardous.rb

@@ -0,0 +1,7 @@
+require 'thread_hazardous/version'
+
+if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby'
+  require 'thread_hazardous/mri_cache_backend'
+else
+  STDERR.puts('thread_hazardous is a noop when not running on MRI')
+end

data/lib/thread_hazardous/mri_cache_backend.rb

@@ -0,0 +1,17 @@
+require 'thread_safe/cache'
+
+# All MriCacheBackend methods are just synchronizing a mutex before calling the parent implementation
+# In a non thread safe environment it is simply a waste of time.
+ThreadSafe::MriCacheBackend.public_instance_methods(false).each do |method|
+  ThreadSafe::MriCacheBackend.send(:define_method, method, ThreadSafe::NonConcurrentCacheBackend.instance_method(method))
+end
+
+class ThreadSafe::MriCacheBackend
+  # The original implementation duplicate the `@backend` Hash so it do not have to lock during the full iteration
+  def each_pair
+    @backend.each_pair do |k, v|
+      yield k, v
+    end
+    self
+  end
+end

data/lib/thread_hazardous/version.rb

@@ -0,0 +1,3 @@
+module ThreadHazardous
+  VERSION = '0.0.1'
+end

data/test/test_cache.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+run_thread_safe_gem_tests('test_cache', except: %i(
+  test_compute_if_absent_atomicity
+  test_each_pair_allows_modification
+))

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'thread_safe'
+
+cache_path = ThreadSafe::Cache.instance_method(:initialize).source_location.first
+THREAD_SAFE_PATH = File.expand_path('../..', File.dirname(cache_path))
+
+require 'thread_hazardous'
+
+def run_thread_safe_gem_tests(suite, except: [])
+  require "#{THREAD_SAFE_PATH}/test/#{suite}.rb"
+
+  unless except.empty?
+    class_name = suite.sub(/^[a-z\d]*/) { $&.capitalize }.gsub(/(?:_|(\/))([a-z\d]*)/i) { $2.capitalize }
+    test_class = Object.const_get(class_name)
+    except.each do |method|
+      test_class.send(:define_method, method) { skip("#{method} is not relevant in a non-threaded environment") }
+    end
+  end
+end

data/thread_hazardous.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thread_hazardous/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'thread_hazardous'
+  spec.version       = ThreadHazardous::VERSION
+  spec.authors       = ['Jean Boussier']
+  spec.email         = ['jean.boussier@gmail.com']
+  spec.summary       = %q{Monkey patch thread_safe to make it faster in non thread safe applications}
+  spec.description   = %Q{CAUTION: Use this gem at your own risk. If you use gems that depends on the thread_safe gem,
+e.g. Rails, but your application is not doing any threading, then thread_hazardous can bring you a few performance
+improvements at the cost of making these dependencies non thread safe.}
+  spec.homepage      = 'https://github.com/byroot/thread_hazardous'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thread_safe', '~> 0.3.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '>= 4'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: thread_hazardous
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jean Boussier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: |-
+  CAUTION: Use this gem at your own risk. If you use gems that depends on the thread_safe gem,
+  e.g. Rails, but your application is not doing any threading, then thread_hazardous can bring you a few performance
+  improvements at the cost of making these dependencies non thread safe.
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/thread_hazardous.rb
+- lib/thread_hazardous/mri_cache_backend.rb
+- lib/thread_hazardous/version.rb
+- test/test_cache.rb
+- test/test_helper.rb
+- thread_hazardous.gemspec
+homepage: https://github.com/byroot/thread_hazardous
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Monkey patch thread_safe to make it faster in non thread safe applications
+test_files:
+- test/test_cache.rb
+- test/test_helper.rb