tool 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 957f199ec72715506547dd26a5d290743e92b6de
-  data.tar.gz: 2d398cd3454dffa91ff9d7d2a80f44405be6c197
-SHA512:
-  metadata.gz: cfecff9484e4eda3240e1b99395e00683c583c09f0b1e9dc5c533347e422d37204aa3113204c4d804f4d8fa78cc6c5f19756a8e12dca4f7cb59aed047794c38a
-  data.tar.gz: 077654427a1d76b1a889641125aac6b4b6aeb9338fe1cb215f30d8d8ec077b3e07912d7d0570f09482539ad5247e38018584030eac8f3b872387e99175ceaa98
+--- 
+SHA1: 
+  metadata.gz: 91786fb78ed736327ffe723e946be2fd67267a73
+  data.tar.gz: 22ebe6e6931dab1c0c2d6ace6030875f71512622
+SHA512: 
+  metadata.gz: ae28a3fc4f351498e3f776c931405caa0b69edcadcd7a87fce4c0a0c7284192f18ca27d9bbb172b821b8b0a0f2d17342baa890ca280fe494f3111c31bb97d378
+  data.tar.gz: e6f9b32b4ff5564f99346817ff4ca298ce557c171c55cdc4c0a18dddcd78898b927ba2ea695171b6c3e3b964bc3d9e4a3594205ab79f3849486ad20e4650b867

data/.travis.yml

@@ -1,2 +1,6 @@
-rvm: [2.0.0, 2.1.0]
-script: bundle exec rspec
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - rbx-2.3.0

data/README.md

@@ -1,10 +1,93 @@
 *Make sure you view the correct docs: [latest release](http://rubydoc.info/gems/tool/frames), [master](http://rubydoc.info/github/rkh/tool/master/frames).*
 
-General purpose Ruby library used by Sinatra 2.0, Mustermann and related projects.
+Welcome to [Tool](http://www.youtube.com/watch?v=mYKLvYGqaC0), the general purpose Ruby library used by Sinatra 2.0, Mustermann and related projects.
 
-Included:
+## Tool::Decoration
 
-* **Decoration** - Mixin for easy method decorations.
-* **EqualityMap** - Weak reference caching based on key equality.
-* **ThreadLocal** - True thread locals that are properly garbage collected.
-* **WarningFilter** - Enable Ruby's warnings, but filter out those caused by third party gems.
+Mixin for easy method decorations.
+
+``` ruby
+class Frank
+  extend Tool::Decoration
+  def self.get(path, &block)
+    decorate(block) do |method|
+      puts "mapping GET #{path} to #{method}"
+    end
+  end
+end
+
+class MyApp < Frank
+  get '/hi' do
+    "Hello World"
+  end
+
+  get '/'; get '/index.php'
+  def index
+    "This is the index page."
+  end
+end
+```
+
+## Tool::EqualityMap
+
+Weak reference caching based on key equality.
+Used for caching.
+
+``` ruby
+class ExpensiveComputation
+  @map = Tool::EqualityMap.new
+
+  def self.new(*args)
+    @map.fetch(*args) { super }
+  end
+end
+```
+
+Note that `fetch` is not guaranteed to return the object, even if it has not been
+garbage collected yet, especially when used concurrently. Therefore, the block passed to `fetch` has to
+be idempotent.
+
+## Tool::ThreadLocal
+
+Have thread local values without them actually being thread global.
+
+Advantages:
+
+* Values for all threads are garbage collected when ThreadLocal instance is.
+* Values for specific thread are garbage collected when thread is.
+* No hidden global state.
+* Supports other data types besides hashes.
+
+``` ruby
+local = Tool::ThreadLocal.new
+local[:key] = "value"
+
+Thread.new do
+  local[:key] = "other value"
+  puts local[:key] # other value
+end.join
+
+puts local[:key] # value
+```
+
+Usage with a pre-filled array:
+
+``` ruby
+local = Tool::ThreadLocal.new([:foo])
+local << :bar
+
+Thread.new { p local }.join # [:foo]
+p local # [:foo, :bar]
+```
+
+## Tool::WarningFilter
+
+Enables Ruby's built-in warnings (-w) but filters out those caused by third-party gems.
+Does not invlove any manual set up.
+
+``` ruby
+require 'tool/warning_filter'
+
+Foo = 10
+Foo = 20
+```

data/Rakefile

@@ -0,0 +1,4 @@
+desc "Run specs"
+task(:spec) { ruby '-S rspec spec -c -w' }
+task(:test => :spec)
+task(:default => :spec)

data/lib/tool/equality_map.rb

@@ -17,6 +17,10 @@ module Tool
   class EqualityMap
     attr_reader :map
 
+    def self.new
+      defined?(ObjectSpace::WeakMap) ? super : {}
+    end
+
     def initialize
       @keys = {}
       @map  = ObjectSpace::WeakMap.new

data/lib/tool/version.rb

@@ -1,3 +1,3 @@
 module Tool
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/spec/equality_map_spec.rb

@@ -5,13 +5,16 @@ describe Tool::EqualityMap do
   after { GC.enable }
 
   describe :fetch do
+    subject { Tool::EqualityMap.new }
     specify 'with existing entry' do
+      next if subject.is_a? Hash
       subject.fetch("foo") { "foo" }
       result = subject.fetch("foo") { "bar" }
       expect(result).to be == "foo"
     end
 
     specify 'with GC-removed entry' do
+      next if subject.is_a? Hash
       subject.fetch("foo") { "foo" }
       expect(subject.map).to receive(:[]).and_return(nil)
       result = subject.fetch("foo") { "bar" }

data/spec/thread_local_spec.rb

@@ -2,6 +2,8 @@ require 'tool/thread_local'
 
 describe Tool::ThreadLocal do
   describe :__getobj__ do
+    subject { Tool::ThreadLocal.new }
+
     specify 'normal access' do
       subject[:foo] = 'bar'
       expect(subject[:foo]).to be == 'bar'
@@ -41,6 +43,8 @@ describe Tool::ThreadLocal do
   end
 
   describe :__size__ do
+    subject { Tool::ThreadLocal.new }
+
     specify 'with one thread' do
       subject[:a] = 'A'
       expect(subject.__size__).to be == 1
@@ -55,6 +59,7 @@ describe Tool::ThreadLocal do
     end
 
     specify 'with dead threads' do
+      next if defined? RUBY_ENGINE and RUBY_ENGINE == 'rbx'
       subject[:a] = 'A'
 
       Thread.new do

data/tool.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.0.0.beta'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'coveralls'
+  s.add_development_dependency "rake"
 end

metadata

@@ -1,71 +1,69 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: tool
-version: !ruby/object:Gem::Version
-  version: 0.2.2
+version: !ruby/object:Gem::Version 
+  version: 0.2.3
 platform: ruby
-authors:
+authors: 
 - Konstantin Haase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-11-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0.beta
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 3.0.0.beta
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: simplecov
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: general purpose Ruby library used by Sinatra 2.0, Mustermann and related
-  projects
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
+  type: :development
+  version_requirements: *id005
+description: general purpose Ruby library used by Sinatra 2.0, Mustermann and related projects
 email: konstantin.mailinglists@googlemail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.md
-files:
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - examples/frank.rb
 - lib/tool/decoration.rb
 - lib/tool/equality_map.rb
@@ -78,30 +76,31 @@ files:
 - spec/thread_local_spec.rb
 - tool.gemspec
 homepage: https://github.com/rkh/tool
-licenses:
+licenses: 
 - MIT
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
       version: 2.0.0
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: general purpose library
-test_files:
+test_files: 
 - spec/decoration_spec.rb
 - spec/equality_map_spec.rb
 - spec/support/coverage.rb