motion-memorymanagement 0.0.1 → 0.1.0

data/README.md

@@ -10,24 +10,52 @@ This gem provides weak references and autorelease pools for your ruby code!
 require 'motion-memorymanagement'
 ```
 
-### Available API demos
+## Usage
+
+Motion::MemoryManagement is effectively a stripped version of [https://github.com/mikeash/MAZeroingWeakRef](MAZeroingWeakRef), all the appropriate classes are available in RubyMotion.
+
+It also provides two helper methods to simplify usage for weak references and weak proxy objects.
+
+Finally, it provides a way to wrap some ruby code in ```@autorelease { ... }``` block (I expect you know what you're doing!).
+
+### MAZeroingWeakRef
+
+```MAZeroingWeakRef``` is the primary interface to use.
 
 ```ruby
-class Test
-  def method
-    "hello"
-  end
-end
+# make reference
+obj = self.some_data
+weak_ref = obj.to_weakref # same as MAZeroingWeakRef.refWithTarget(obj)
+
+# use reference
+weak_ref.target # will become nil automagically as soon as obj is "garbage-collected"
+```
+
+### MAZeroingWeakProxy
 
-t = Test.new
-wt = t.weak!
+```MAZeroingWeakProxy``` is effectively a proxy class around your object. This may or may
+not be what you want, because the message dispatch goes right through Objective-C runtime.
+If unsure, use ```MAZeroingWeakRef```.
 
-wt.method # => "hello"
+```ruby
+# make reference
+obj = self.some_data
+weak_ref = obj.to_weakproxy # same as MAZeroingWeakProxy.proxyWithTarget(obj)
 
-t = nil
-wt.method # => nil
+# use reference
+weak_ref.method_of_obj # if 'obj' is gone, it will be same as calling method on nil,
+                       # that is, it will do nothing and return nil
 ```
 
+### MAWeakArray and MAWeakDictionary
+
+That are mutalbe array and dictionary with added feature that the stored objects are
+weak-referenced (i.e. objects on array or keypairs in dictionary may be zeroed out).
+
 ### Notes
 
-Lots of thanks to Mike Ash for his MAZeroingWeakRef!
+By default, all objects created in ruby scope are put into nearest local autorelease pool.
+Effectively meaning that no object would go away until current method ends returning control
+to the event loop.
+
+Lots of thanks to Mike Ash for his MAZeroingWeakRef!

data/demoapp/spec/main_spec.rb

@@ -2,7 +2,7 @@ describe "Memory management" do
   it "keeps zero weak refs zeroed if referenced objects are gone" do
     zwr = MMAutoreleased -> {
       obj = "hello"
-      zwr = MAZeroingWeakRef.refWithTarget(obj).retain # that what happens if you neer to be smarter than runtime!
+      zwr = obj.to_weakref.retain # that what happens if you neer to be smarter than runtime!
       obj = nil
       zwr
     }
@@ -12,7 +12,7 @@ describe "Memory management" do
 
   it "keeps zero weak refs alive if referenced objects are alive" do
     obj = "hello"
-    zwr = obj.weak!
+    zwr = obj.to_weakproxy
     zwr.length.should == 5
   end
 
@@ -24,9 +24,9 @@ describe "Memory management" do
     end
 
     t = MMAutoreleased -> {
-      t = Test.alloc.init.retain
+      Test.alloc.init.retain
     }
-    wt = t.weak!
+    wt = t.to_weakproxy
 
     wt.method.should == "hello"
 

data/lib/motion-memorymanagement/runtime_helpers.rb

@@ -1,5 +1,9 @@
 class Object
-  def weak!
+  def to_weakref
+    MAZeroingWeakRef.refWithTarget(self)
+  end
+
+  def to_weakproxy
     MAZeroingWeakProxy.proxyWithTarget(self)
   end
 end

data/lib/motion-memorymanagement/version.rb

@@ -1,5 +1,5 @@
 module Motion
   module MemoryManagement
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: motion-memorymanagement
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Vladimir Pouzanov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-23 00:00:00 +00:00
-default_executable: 
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies: []
-
 description: Memory management (weak references and autorelease pools) for RubyMotion
-email: 
+email:
 - farcaller@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -56,35 +46,29 @@ files:
 - lib/motion-memorymanagement/runtime_helpers.rb
 - lib/motion-memorymanagement/version.rb
 - motion-memorymanagement.gemspec
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Memory management for RubyMotion
 test_files: []
-
+has_rdoc: