instance 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cee2d02baf52220acdc856e29882e4f010ba2738
-  data.tar.gz: 431b52894e0f05ed07f01a659a32dfee9afd46d5
+  metadata.gz: 50ea7131aae9fc777b3fbb1627ad12921c8f030a
+  data.tar.gz: 333c9c0a0c3b5621826573b6cbd8f79a1f12c93c
 SHA512:
-  metadata.gz: 6db8dc0db1016e250ef002411b651027c934e627baf1feb292e1846c412897b35b975cad3de8a993a7f7c8b746dfa132d45d5e409c1e267e525851f02c86c35e
-  data.tar.gz: 36957724377899c20c5e5e604444b8e3da459522fea4c9154ec1781c89174354912e653a9a8848d3e464431c899e841b6b8ba188c284796cbae199ca3f379a49
+  metadata.gz: 1656a2cacca66158e402d560a522e0e1ecf39cc37f749955637584eb9dd10b4a398755219535551732dcc77c358534cd023ec843eccf5f121030c73b27c0938c
+  data.tar.gz: 1aa585e6ae04ea595d0525a7750b6765e9b792a081c26811ffe65cf3dc54a5cd3f24e09d79210e0808e9592b315b68c7f6b8f9e77ecf281225d2a41fc34266b3

data/.index

@@ -58,5 +58,5 @@ created: '2014-01-31'
 description: |-
   Instance is a spin-off of Ruby Facets. It provides a simple convenient API
   for accessing an object's state.
-version: 0.1.0
-date: '2014-02-01'
+version: 0.2.0
+date: '2014-02-02'

data/HISTORY.md

@@ -1,5 +1,15 @@
 # RELEASE HISTORY
 
+## 0.2.0 | 2014-02-02
+
+This release adds an extra set of methods for modules and classes.
+
+Changes:
+
+* Add `method_definition` if object is a module or class.
+* Add `method_definitions` if object is a module or class.
+
+
 ## 0.1.0 | 2014-02-01
 
 This is the initial release of Instance, a class spun-off from

data/README.md

@@ -24,28 +24,33 @@ Let's use a very simple example class with which to demonstrate usage.
 ```ruby
     class Song
       attr_accessor :title
-      attr_accessor :author
+      attr_accessor :artist
       attr_accessor :length
 
-      def initialize(title, author, length)
+      def initialize(title, artist, length)
         @title  = title
-        @author = author
-        @length = length
+        @artist = artist
+        @year   = year
       end
     end
 ```
 
+Now we can create an instance of Song and work with it's state.
+
 ```ruby
     song = Song.new("Paranoid", "Black Sabbath", 1970)
 
-    song.instance.variables   #=> [:@author, :@title, :@length]
+    song.instance.variables    #=> [:@title, :@artist, :@year]
+
+    song.instance.get(:title)  #=> "Parinoid"
 
-    song.instance.get(:name)  #=> "Black Sabbath"
+    song.instance[:artist]     #=> "Black Sabbath"
 
-    song.instance[:name]      #=> "Black Sabbath"
+    song.instance.to_h        
+    #=> {:name => "Paranoid", :author => "Black Sabbath", :year => 1970)
 ```
 
-For more a more complete set of usage examples see the QED documentation.
+For a more complete set of usage examples see the QED documentation.
 
 
 ## Copyrights

data/demo/instance.md

@@ -18,23 +18,32 @@ And now demonstrate the available API.
 
 ## Instance#variables
 
-    f1 = Friend.new("John", 30, "555-1212")
-    f1.instance.variables.assert == [:@name, :@age, :@phone]
+A list of instance variables can be had via the `#variables` method.
+
+    f = Friend.new("John", 30, "555-1212")
+    f.instance.variables.assert == [:@name, :@age, :@phone]
 
 ## Instance#names
 
-    f1 = Friend.new("John", 30, "555-1212")
-    f1.instance.names.assert == ["name", "age", "phone"]
+To get a list of variables names as strings and without the `@` prefix,
+use the `#names` method.
+
+    f = Friend.new("John", 30, "555-1212")
+    f.instance.names.assert == ["name", "age", "phone"]
 
 ## Instance#keys
 
-    f1 = Friend.new("John", 30, "555-1212")
-    f1.instance.keys.assert == [:name, :age, :phone]
+Likewise, to get symbols instead of strings, use the `#keys` method.
+
+    f = Friend.new("John", 30, "555-1212")
+    f.instance.keys.assert == [:name, :age, :phone]
 
 ## Instance#values
 
-    f1 = Friend.new("John", 30, "555-1212")
-    f1.instance.values.assert == ["John", 30, "555-1212"]
+The values of the instance variables alone can be had via the `#values` method.
+
+    f = Friend.new("John", 30, "555-1212")
+    f.instance.values.assert == ["John", 30, "555-1212"]
 
 ## Instance#size
 
@@ -53,14 +62,21 @@ This method is primarily of use to the Enumerable mixin.
 
 ## Instance#update and #assign
 
-    f1 = Friend.new("John", 30, "555-1212")
-    f1.name.assert == 'John'
+The `#update` method can be used to change instance variables in mass via
+method options.
 
-    f1.instance.update(:name=>'Jerry')
-    f1.name.assert == 'Jerry'
+    f = Friend.new("John", 30, "555-1212")
+    f.name.assert == 'John'
+    f.instance.update(:name=>'Jerry')
+    f.name.assert == 'Jerry'
 
-    f1.instance.assign(:name=>'John')
-    f1.name.assert == 'John'
+## Instance#assign
+
+The `#assign` method is simply an alias for `#update`.
+
+    f = Friend.new("John", 30, "555-1212")
+    f.instance.assign(:name=>'Joe')
+    f.name.assert == 'Joe'
 
 ## Instance#to_h
 
@@ -78,11 +94,17 @@ want the `@` to stay simply pass `true` to the `#to_h` method.
 
 ## Instance#class
 
+To know the class of an object use the `#class` method.
+
     f = Friend.new("John", 30, "555-1212")
     f.instance.class.assert == ::Friend
 
+Note that to get the class of Instance itself, you must use `#object_class`. 
+
 ## Instance#id
 
+To know the id of an object use the `#id` method.
+
     f = Friend.new("John", 30, "555-1212")
     f.instance.id == f.object_id
 
@@ -91,15 +113,32 @@ want the `@` to stay simply pass `true` to the `#to_h` method.
     f = Friend.new("John", 30, "555-1212")
     f.instance.assert.of?(::Friend)
 
-## Instance#get and #set
+## Instance#get
+
+To get the value of a specific instance variable use the `#get` or `#[]`
+methods.
 
     f = Friend.new("John", 30, "555-1212")
     f.instance.get(:name).assert == "John"
+    f.instance[:name].assert == "John"
+
+## Instance#set
+
+To set the value of a specific instance variable use the `#set` or `#[]=`
+methods.
+
+    f = Friend.new("John", 30, "555-1212")
+
     f.instance.set(:name, "Bill")
     f.name.assert == "Bill"
 
+    f.instance[:name] = "Billy"
+    f.name.assert == "Billy"
+
 ## Instance#remove
 
+To remove an instance variable from an object use the `#remove` method.
+
     f = Friend.new("John", 30, "555-1212")
     f.instance.remove(:name)
     f.instance.refute.variable_defined?(:@name)
@@ -120,6 +159,8 @@ The actual *instance method* is the object's method.
 
 ## Instance#methods
 
+We can also get a whole list of an object's methods via the `#methods` method.
+
     f = Friend.new("John", 30, "555-1212")
     f.instance.methods
     f.instance.methods(:private)
@@ -127,10 +168,18 @@ The actual *instance method* is the object's method.
     f.instance.methods(:public)
     f.instance.methods(:public, :private)
 
-## Instance#eval and #exec
+## Instance#eval
+
+To evaluate code in the context to the object's instance use the `#eval` method.
 
     f = Friend.new("John", 30, "555-1212")
     f.instance.eval("@name").assert == "John"
+
+## Instance#exec
+
+Likewise the `#exec` method can also be used.
+
+    f = Friend.new("John", 30, "555-1212")
     f.instance.exec{ @name }.assert == "John"
 
 ## Instance#send
@@ -144,6 +193,9 @@ Hence it makes sense for it to be done via the `instance` interface.
 
 ## Instance#delegate
 
+To get at the delegated object of an Instance, use the `#delegate` method.
+
     f = Friend.new("John", 30, "555-1212")
     f.instance.delegate.assert == f
 
+

data/demo/module.md

@@ -0,0 +1,34 @@
+# Instance for Modules/Classes
+
+Modules and Classes have additional features not shared by other 
+types of objects.
+
+## Instance#method_definition
+
+    um = String.instance.method_definition(:to_s)
+    um.class.assert == UnboundMethod
+
+## Instance#definition
+
+The `#definition` method is just an alias for `#method_definition`.
+
+    um = String.instance.definition(:to_s)
+    um.class.assert == UnboundMethod
+
+## Instance#method_definitions
+
+    list = String.instance.method_definitions
+
+Method definitions can be selected use support symbol selectors.
+
+    list = String.instance.method_definitions(:public)
+    list = String.instance.method_definitions(:protected)
+    list = String.instance.method_definitions(:private)
+    list = String.instance.method_definitions(:private, :protected)
+
+## Instance#definitions
+
+The `#definitions` method is likewise an alias for `#method_definitions`.
+
+    list = String.instance.definitions
+

data/lib/instance.rb

@@ -64,9 +64,13 @@ class Instance
     @cache[delegate] ||= Instance.new(delegate)
   end
 
-  # Initialize new Instance instance.
+  # Initialize new Instance instance. If the delegate is a type of 
+  # Module or Class then the instance will be extended with the
+  # {ModuleExtensions} mixin.
+  # 
   def initialize(delegate)
     @delegate = delegate
+    extend ModuleExtensions if Module === delegate
   end
 
   # The delegated object.
@@ -236,11 +240,11 @@ class Instance
 
     selection.each do |s|
       case s
-      when :public
+      when :public, :all
         list.concat METHODS[:public_methods].bind(@delegate).call
-      when :protected
+      when :protected, :all
         list.concat METHODS[:protected_methods].bind(@delegate).call
-      when :private
+      when :private, :all
         list.concat METHODS[:private_methods].bind(@delegate).call
       end
     end
@@ -271,6 +275,9 @@ class Instance
     METHODS[:object_id].bind(@delegate).call
   end
 
+  # Fallback to get the real class of the Instance delegate itself.
+  alias :object_class :class
+
   # Get object's instance id.
   #
   # Returns [Class]
@@ -290,6 +297,71 @@ private
     name.to_s !~ /^@/ ? "@#{name}" : name
   end
 
+  ##
+  # ModuleExtensions provides some additional methods for Module and Class
+  # objects.
+  #
+  # TODO: Are there any other module/class methods that need to be provided?
+  #
+  module ModuleExtensions
+		# Store Object methods so they cannot be overriden by the delegate class.
+		METHODS = {}
+
+		def self.freeze_method(name)
+		  METHODS[name.to_sym] = Module.instance_method(name)
+		end
+
+		freeze_method :instance_method
+		freeze_method :instance_methods
+		freeze_method :public_instance_methods
+		freeze_method :protected_instance_methods
+		freeze_method :private_instance_methods
+
+    # List of method definitions in a module or class.
+    #
+    # selection - Any of `:public`, `:protected` or `:private` which
+    #             is used to select specific subsets of methods.
+    #
+    # Returns [Array<Symbol>]
+    def method_definitions(*selection)
+		  list = []
+
+		  if selection.empty?
+		    list.concat METHODS[:instance_methods].bind(@delegate).call
+		  end
+
+		  selection.each do |s|
+		    case s
+		    when :public, :all
+		      list.concat METHODS[:public_instance_methods].bind(@delegate).call
+		    when :protected, :all
+		      list.concat METHODS[:protected_instance_methods].bind(@delegate).call
+		    when :private, :all
+		      list.concat METHODS[:private_instance_methods].bind(@delegate).call
+		    end
+		  end
+
+		  return list
+    end
+
+    # Shorter alias for #method_definitions.
+    alias :definitions :method_definitions
+
+    # Get a first-class method definition object.
+    #
+    # Returns an unbound method object. [UnboundMethod] 
+    def method_definition(name)
+		  METHODS[:instance_method].bind(@delegate).call(name)
+    end
+
+    alias :definition :method_definition
+  end
+
+  #
+  #module ClassExtensions
+  #
+  #end
+
 end
 
 

data/lib/instance.yml

@@ -58,5 +58,5 @@ created: '2014-01-31'
 description: |-
   Instance is a spin-off of Ruby Facets. It provides a simple convenient API
   for accessing an object's state.
-version: 0.1.0
-date: '2014-02-01'
+version: 0.2.0
+date: '2014-02-02'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qed
@@ -70,6 +70,7 @@ files:
 - lib/instance.yml
 - demo/applique/env.rb
 - demo/instance.md
+- demo/module.md
 - README.md
 - HISTORY.md
 - LICENSE.txt