types 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/types.rb

@@ -3,12 +3,25 @@
 
 require "multitype-introspection"
 
+##
+# Root library module.
+#
+
 module Types
+
+    ##
+    # Type defining class.
+    # @abstract
+    #
+    
     class Type
     
         ##
         # Returns classes which are part of this type.
         #
+        # @return [Array] array of class objects
+        # @abstract
+        #
         
         def type_classes
             raise Exception::new("Class is abstract.")
@@ -16,6 +29,7 @@ module Types
         
         ##
         # Returns types which are part of this type.
+        # @return [Array] array of types objects
         # 
         
         def type_types
@@ -25,6 +39,9 @@ module Types
         ##
         # Matches object is of this type.
         #
+        # @param [Object] object object for type matching
+        # @return [Boolean] 'true' if match, 'false' in otherwise
+        #
         
         def match_type?(object)
             result = object.kind_of_any? self.type_classes
@@ -37,12 +54,19 @@ module Types
         
     end
     
+    ##
+    # Defines generic boolean type.
+    # @abstract
+    # 
+    
     class Boolean < Type
 
         ##
         # Returns classes which are part of this type.
         # In case of boolean <tt>TrueClass</tt> and <tt>FalseClass</tt>.
         #
+        # @return [Array] array of types objects
+        #
         
         def type_classes
             [TrueClass, FalseClass]
@@ -51,11 +75,18 @@ module Types
     end
 end
 
+##
+# Extension of built-in Object class.
+#
+
 class Object
 
     ##
     # Indicates object is type of some class.
-    # If class isn't Type, matches against kind_of?.
+    # If class isn't Type, matches against #kind_of?.
+    #
+    # @param [Types::Type, Class] cls  some type or class specification
+    # @return [Boolean] 'true' if it is, 'false' in otherwise
     #
     
     def type_of?(cls)
@@ -67,10 +98,12 @@ class Object
         end
     end
 
-
     ##
     # Indicates object is type of some class in the list.
-    # If class isn't Type, matches against kind_of?.
+    # If class isn't Type, matches against #kind_of?.
+    #
+    # @param [Array] classes array of Type or Class objects
+    # @return [Boolean] 'true' if it is, 'false' in otherwise
     #
         
     def type_of_any?(classes)
@@ -88,5 +121,10 @@ class Object
     end
 end
 
+##
+# Redefines generic boolean type in main namespace.
+# @abstract
+# 
+
 class Boolean < Types::Boolean
 end

data/types.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{types}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Kozák"]
-  s.date = %q{2011-01-12}
+  s.date = %q{2011-01-19}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +01:00
+date: 2011-01-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2336525954248439529
+      hash: -4017891773010528090
       segments: 
       - 0
       version: "0"