weak_observable 1.0.0 → 1.0.1

data/.travis.yml

@@ -0,0 +1,7 @@
+bundler_args: --without non_essentials
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode

data/CHANGELOG

@@ -1,5 +1,11 @@
+# [v1.0.1][]
+
+- Updated README to fix faulty example.
+- Fix Hub throwing warnings when adding an observer.
+
 # [v1.0.0][]
 
 Initial release. WeakObservable and Hub!
 
+[v1.0.1]: https://github.com/Burgestrand/weak_observable/compare/v1.0.0...v1.0.1
 [v1.0.0]: https://github.com/Burgestrand/weak_observable/tree/v1.0.0

data/Gemfile

@@ -1,3 +1,9 @@
 source :rubygems
 gemspec
-gem 'yard'
+
+gem 'rake'
+gem 'ref', :github => 'Burgestrand/ref', :branch => 'fix_ref_mock_gc'
+
+group :non_essentials do
+  gem 'yard'
+end

data/README.md

@@ -1,4 +1,4 @@
-# WeakObservable
+# WeakObservable [![Build Status](https://secure.travis-ci.org/Burgestrand/weak_observable.png)](http://travis-ci.org/Burgestrand/weak_observable)
 
 WeakObservable is very similar to Observable from ruby’ standard library, but
 with the very important difference in that it allows it’s subscribers to be
@@ -31,8 +31,7 @@ end
 observer = Observer.new
 
 playlist = Playlist.new
-playlist.observers << observer
-playlist.observers.count # => 1
+playlist.observers.add(observer)
 
 # Notify all observers. Any arguments and given block goes out to them all.
 playlist.observers.notify(:ping)
@@ -42,10 +41,61 @@ playlist.observers.notify(:ping)
 observer = nil
 
 # Some time passes, ruby garbage collection eventually kicks in, and now…
-playlist.observers.count # => 0
 playlist.observers.notify(:ping) # nothing happens, we have no observers.
 ```
 
+There is also the Hub, which is a mix between a WeakObservable and a Hash.
+You add observers by associating them with a key. A key can have multiple
+observers. When you notify observers, you supply the key, and observers on
+that key will be notified, but not any other observers.
+
+```ruby
+require 'weak_observable'
+
+hub = WeakObservable::Hub.new
+
+class Ninja
+  def update(event, *args)
+    puts "Ninjas: #{event}"
+  end
+end
+
+class Pirate
+  def update(event, *args)
+    puts "Pirates: #{event}"
+  end
+end
+
+ninja_a = Ninja.new
+ninja_b = Ninja.new
+
+pirate_a = Pirate.new
+pirate_b = Pirate.new
+
+hub.add(Ninja, ninja_a)
+hub.add(Ninja, ninja_b)
+hub.add(Pirate, pirate_a)
+hub.add(Pirate, pirate_b)
+
+hub.notify(Pirate, "Ninjarrrs arrr attacking!")
+# ^ notifies all the pirates that ninjas are attacking.
+
+hub.notify(Ninja, "All pirates are down.")
+# ^ notifies all ninjas the pirates are all dead.
+```
+
+When all objects of a given key has been garbage collected, that key will
+also be garbage collected. Because of this property Hubs can be extremely
+useful interfacing with asynchronous C libraries and their callbacks.
+
+## Supported platforms
+
+- CRuby 1.9.2, 1.9.3
+- JRuby 1.9-mode
+- Rubinius 1.9-mode
+
+I will not be supporting Ruby 1.8.
+
 ## Contributing
 
 Please fork the repository and clone it. To get started with development you’ll

data/Rakefile

@@ -7,9 +7,12 @@ begin
   require 'yard'
   require 'yard/rake/yardoc_task'
   YARD::Rake::YardocTask.new
+rescue LoadError
 end
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new do |task|
+  task.ruby_opts = '-W'
+end
 
 task :default => :spec

data/lib/weak_observable/hub.rb

@@ -82,11 +82,12 @@ class WeakObservable
     # when all observers are gone, the observables for the address
     # they are registered to is also eligible for garbage collection.
     def backrefs_of(object)
-      # The object may be attached to several hubs, so make sure
-      # we don’t fuck up by mapping our own object_id first.
-      ivar = '@__observable__hubs__'
-      back_hash = object.instance_variable_get(ivar)
-      back_hash ||= Hash.new
+      ivar = :@__observable__hubs__
+      back_hash = if object.instance_variable_defined?(ivar)
+        object.instance_variable_get(ivar)
+      else
+        Hash.new
+      end
       object.instance_variable_set(ivar, back_hash)
 
       # An object may also be attached to several addresses within

data/lib/weak_observable/version.rb

@@ -1,3 +1,3 @@
 class WeakObservable
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/weak_observable/hub_spec.rb

@@ -127,51 +127,28 @@ describe WeakObservable::Hub do
   end
 
   specify "observers can be garbage collected" do
-    counter   = 0
-    finalizer = lambda { |_| counter += 1 }
+    Ref::Mock.use do
+      observer1 = double
+      observer2 = double
 
-    threshold = 5
-    stretches = 5
+      observer1.should_not_receive(:update)
+      observer2.should_receive(:update)
 
-    threshold.times do
-      # stub with return value for method cannot be garbage collected.
-      observer = OpenStruct.new(:update => nil)
-      observable.add(key, observer)
-      ObjectSpace.define_finalizer(observer, finalizer)
-    end
+      observable.add(key, observer1)
+      observable.add(key, observer2)
 
-    (threshold * stretches).times do
-      GC.start
-      sleep 0.001
-    end
+      Ref::Mock.gc(observer1)
 
-    # if one is garbage collected, we can expect all to eventually be
-    # as well
-    counter.should be > 1
+      observable.notify(key)
+    end
   end
 
   specify "entire keys can be garbage collected" do
-    counter   = 0
-    finalizer = lambda { |_| counter += 1 }
+    mapping = lambda { |key| observable.instance_eval { @mapping }[key] }
 
-    threshold = 5
-    stretches = 5
-
-    threshold.times do |i|
-      # stub with return value for method cannot be garbage collected.
-      observer = OpenStruct.new(:update => nil)
-      observable.add(key + i, observer)
-      ObjectSpace.define_finalizer(observer, finalizer)
-    end
-
-    (threshold * stretches).times do
-      GC.start
-      sleep 0.001
-    end
-
-    # some very intimate introspection here
-    observable.instance_eval do
-      @mapping.to_a.length.should < threshold
+    Ref::Mock.use do
+      observable.add(key, observer)
+      expect { Ref::Mock.gc }.to change { mapping[key] }.to(nil)
     end
   end
 end

data/spec/weak_observable/weak_observable_spec.rb

@@ -85,26 +85,19 @@ describe WeakObservable do
   end
 
   specify "observers can be garbage collected" do
-    counter   = 0
-    finalizer = lambda { |_| counter += 1 }
+    Ref::Mock.use do
+      observer1 = double
+      observer2 = double
 
-    threshold = 5
-    stretches = 5
+      observer1.should_not_receive(:update)
+      observer2.should_receive(:update)
 
-    threshold.times do
-      # stub with return value for method cannot be garbage collected.
-      observer = OpenStruct.new(:update => nil)
-      observable.add(observer)
-      ObjectSpace.define_finalizer(observer, finalizer)
-    end
+      observable.add(observer1)
+      observable.add(observer2)
 
-    (threshold * stretches).times do
-      GC.start
-      sleep 0.001
-    end
+      Ref::Mock.gc(observer1)
 
-    # if one is garbage collected, we can expect all to eventually be
-    # as well
-    counter.should be > 1
+      observable.notify
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weak_observable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-28 00:00:00.000000000 Z
+date: 2012-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ref
@@ -59,6 +59,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -85,12 +86,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 269781825206150069
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 269781825206150069
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24