rubyverse 0.0.1 → 1.0.0

data/HISTORY.txt

@@ -1,3 +1,13 @@
+2014-04-25 Version 1.0.0
+
+	Parallel object maps are now stored in the Rubyverse instead
+	of the original object so that they can go away when the Rubyverse
+	does. Object#in_rubyverse now calls Rubyverse#rubyversed (which is
+	now responsible for invoking Rubyverse#rubyverse_new to create the
+	new object).
+
+	Accordingly, Object#rubyverse_map is now Rubyverse#rubyverse_map.
+
 2014-04-13 Version 0.0.1
 
 	First release.

data/lib/rubyverse.rb

@@ -19,6 +19,7 @@
 #    end
 #    
 #    class Assisted
+#        include Rubyverse
 #        def rubyverse_new (object)
 #            case object
 #            when Numeric then Number_Assistant.new(object)
@@ -26,27 +27,33 @@
 #            else self
 #            end
 #        end
-#    
 #        def my_method; "Default assistant"; end
 #    end
 #    
-#    object = Assisted.new # An object implementing #rubyverse_new
+#    object = Assisted.new
+#
+#    object.rubyversed(10).my_method      # "Number assistant for 10"
 #    10.in_rubyverse(object).my_method    # "Number assistant for 10"
+#
+#    object.rubyversed("hi").my_method    # "String assistant for hi"
 #    "hi".in_rubyverse(object).my_method  # "String assistant for hi"
+#
+#    object.rubyversed(nil).my_method     # "Default assistant"
 #    nil.in_rubyverse(object).my_method   # "Default assistant"
 #
-# The Rubyverse module is only for documentation purposes.
+# The Rubyverse module provides a reference implementation that may be
+# used to extend objects that will be Rubyverses.
 # The Object class is extended with supporting methods.
 #
-# A Rubyverse object is responsible for allocating appropriate parallel
-# objects for its Rubyverse.
+# A Rubyverse object is responsible for allocating and maintaining a
+# map of appropriate parallel objects for its Rubyverse.
 #
 # @author Brian Katzung (briank@kappacs.com), Kappa Computer Solutions, LLC
 # @license Public Domain
-# @version 0.0.1
+# @version 1.0.0
 module Rubyverse
 
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
 
     # Return a parallel object in this Rubyverse corresponding to the
     # given original object.
@@ -59,23 +66,35 @@ module Rubyverse
     # return it.
     #
     # @param original The original object.
-    def rubyverse_new (original); original; end
-
-end
+    # @abstract You MUST supply your own implementation.
+    def rubyverse_new (original); end
+    remove_method :rubyverse_new # API doc only
 
-# Extends the Object class to support Rubyverses.
-class Object
-
-    # Return the map of Rubyverses to parallel objects.
+    # Return the map of original-to-#rubyversed objects.
     #
-    # @param create [Boolean] Whether to create the map if it doesn't exist.
+    # @param create [Boolean] Whether to create the map if it doesn't
+    #  exist yet.
     # @return [Hash]
     def rubyverse_map (create = true)
-	if create then @rubyverse_map ||= {}
+	if create then @rubyverse_map ||= {}.compare_by_identity
 	else @rubyverse_map
 	end
     end
 
+    # Return an object's parallel object in this Rubyverse.
+    #
+    # Required by {Object#in_rubyverse}.
+    #
+    # @param object The original object.
+    def rubyversed (object)
+	self.rubyverse_map[object] ||= rubyverse_new object
+    end
+
+end
+
+# Extends the Object class to support Rubyverses.
+class Object
+
     # Return ourselves, the original Rubyverse object.
     #
     # Parallel object classes should override this method.
@@ -83,10 +102,17 @@ class Object
 
     # Return this object's parallel object in another Rubyverse.
     #
+    # This is a helper method to obtain the {Rubyverse#rubyversed}
+    # object for an intermediate result in a method call chain.
+    #
+    #  # Three ways to invoke #something on "other" in Rubyverse "rubyverse"
+    #  # and then invoke #another on the result in Rubyverse "rubyverse":
+    #  rubyverse.rubyversed(other).something.in_rubyverse(rubyverse).another
+    #  other.in_rubyverse(rubyverse).something.in_rubyverse(rubyverse).another
+    #  rubyverse.rubyversed(rubyverse.rubyversed(other).something).another
+    #
     # @param rubyverse [Rubyverse] The desired Rubyverse.
-    def in_rubyverse (rubyverse)
-	rubyverse_map[rubyverse] ||= rubyverse.rubyverse_new self
-    end
+    def in_rubyverse (rubyverse); rubyverse.rubyversed self; end
 
 end
 

data/rubyverse.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name         = "rubyverse"
-  s.version      = "0.0.1"
-  s.date         = "2014-04-13"
+  s.version      = "1.0.0"
+  s.date         = "2014-04-25"
   s.authors      = ["Brian Katzung"]
   s.email        = ["briank@kappacs.com"]
   s.homepage     = "http://rubygems.org/gems/rubyverse"

metadata

@@ -3,10 +3,10 @@ name: rubyverse
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Brian Katzung
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-04-13 00:00:00 -05:00
+date: 2014-04-25 00:00:00 -05:00
 default_executable: 
 dependencies: []