y_support 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 629249c866bf65956eb005fe95e52760b1a90ca7
-  data.tar.gz: d1fbe32ecfe7ae9c20d406370aa75a4f84b187c6
+  metadata.gz: a6e8e25158487612ee9fd0d9b88dd3cbaa588767
+  data.tar.gz: 8e4a78cde0deb07dda57cd9ff93f5f64c4a991be
 SHA512:
-  metadata.gz: 47fcc146fb66370b5cfec8e20b7dd14c18641b5b62d35215a5a371258b65d517953db5338b75743d5d15cfcff821e6b51c747c72c250ef61b850882138e4b897
-  data.tar.gz: 2467010f8dd198422bef47f38de23403d3446327c633fad3e7cbae55acd3576a57babd68b12b95e447b7d1fb4b233bee0623b9f4216c93ef1681c297d0c14839
+  metadata.gz: e9c8826eab83bf22364655f6559c5c11114162bd35dee5d01e268f971216d35e4131d5f50100faf01f7644a952a95dcd6d00edd8acb688cd671ec354e3d3d487
+  data.tar.gz: 0901936832de50bd38831a31deb565af1eaf8f545dec53de62ba54c8a672dfdd0e37602ed796eb6a1cfc871069c001c3bd545ee7e9f6de875c0350f99c0ee767

data/lib/y_support/local_object.rb

@@ -1,5 +1,4 @@
-#encoding: utf-8
-
+# -*- coding: utf-8 -*-
 require 'y_support'
 
 # Object, whose business is to stay local to methods. Optional signature

data/lib/y_support/name_magic.rb

@@ -1,26 +1,34 @@
 # -*- coding: utf-8 -*-
 require 'y_support'
 
-# A mixin imitating Ruby constant magic, plus automation of :name alias :ɴ
-# named argument. This allows to write:
+# This mixin imitates Ruby constant magic and automates the named argument
+# :name (alias :ɴ). One thus can write:
 #
+# <tt>class Someclass; include NameMagic end</tt>
 # <tt>SomeName = SomeClass.new</tt>
 #
 # and the resulting object will know its #name:
 #
 # <tt>SomeName.name = "SomeName"</tt>
 #
-# This is done by searching the whole Ruby namespace for constants to which
-# the object is assigned. The search is performed by calling #const_magic.
-# This is only done until the name is found - once the object is named, its
-# subsequent assignment to constants is without effect.
+# This is done by searching the whole Ruby namespace for constants, to which
+# the object might have been assigned. The search is performed by the method
+# #const_magic defined by this mixin. Once the object is found to be assigned
+# to a constant, and named accordingly, its subsequent assignments to other
+# constants have no additional effect.
 #
-# Alternatively, a named object can be created by using :name alias :ɴ
+# Alternative way to create a named object is by specifying :name (alias :ɴ)
 # named argument:
 #
-# SomeName.new arg1, arg2, ..., name: "SomeName", named_arg1: val1, ...
+# <tt>SomeClass.new a, b, ..., name: "SomeName", aa: v1, bb: v2 ...</tt>
 #
-# Hook is provided for when the name magic is performed.
+# Lastly, a name can be assigned by #name= accssor, as in
+#
+# <tt>o = SomeClass.new</tt>
+# <tt>o.name = "SomeName"</tt>
+#
+# Hook is provided for when the name magic is performed, as well as when the
+# name is retrieved.
 # 
 module NameMagic
   DEBUG = false
@@ -69,13 +77,18 @@ module NameMagic
     ɴ = self.class.__instances__[ self ]
     if ɴ then
       name_get_closure = self.class.instance_variable_get :@name_get_closure
-      return name_get_closure ? name_get_closure.( ɴ ) : ɴ
-    else
-      return nil
-    end
+      name_get_closure ? name_get_closure.( ɴ ) : ɴ
+    else nil end
   end
   alias ɴ name
 
+  # Retrieves either an instance name (if present), or an object id.
+  # 
+  def name_or_object_id
+    name || object_id
+  end
+  alias ɴ_ name_or_object_id
+
   # Names an instance, cautiously (ie. no overwriting of existing names).
   # 
   def name=( ɴ )
@@ -158,6 +171,10 @@ module NameMagic
     # 
     def instance arg
       const_magic
+      # Reject nil argument. (In @instances hash, nameless instances are given
+      # name nil, so 'nil' cannot be a real name.)
+      fail TypeError, "'nil' is not a valid argument type for " +
+        "NameMagic#instance method!" if arg.nil?
       # if the argument is an actual instance, just return it
       return arg if __instances__.keys.include? arg
       # otherwise, treat it as name

data/lib/y_support/version.rb

@@ -1,3 +1,3 @@
 module YSupport
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: y_support
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - boris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport