nrser 0.2.2 → 0.3.0

data/lib/nrser/types/trees.rb

@@ -1,12 +1,6 @@
 # Requirements
 # =======================================================================
 
-# Stdlib
-# -----------------------------------------------------------------------
-
-# Deps
-# -----------------------------------------------------------------------
-
 # Project / Package
 # -----------------------------------------------------------------------
 require_relative './combinators'
@@ -14,81 +8,35 @@ require_relative './responds'
 require_relative './is_a'
 
 
-# Refinements
-# =======================================================================
-
-require 'nrser/refinements'
-using NRSER
-
-
 # Definitions
 # =======================================================================
 
 module NRSER::Types
   
-  # @todo Document array_like method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
-  def self.array_like **options
-    if options.empty?
-      ARRAY_LIKE
-    else
-      intersection \
-        is_a( Enumerable ),
-        respond_to( :each_index ),
-        **options
-    end
+  def_factory :array_like do |name: 'ArrayLike', **options|
+    intersection \
+      is_a( Enumerable ),
+      respond_to( :each_index ),
+      name: name,
+      **options
   end # .array_like
   
-  ARRAY_LIKE = array_like( name: 'ArrayLikeType' ).freeze
-  
   
-  # @todo Document hash_like method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
-  def self.hash_like **options
-    if options.empty?
-      HASH_LIKE
-    else
-      intersection \
-        is_a( Enumerable ),
-        respond_to( :each_pair ),
-        **options
-    end
+  def_factory :hash_like do |name: 'HashLike', **options|
+    intersection \
+      is_a( Enumerable ),
+      respond_to( :each_pair ),
+      name: name,
+      **options
   end # .hash_like
   
-  HASH_LIKE = hash_like( name: 'HashLikeType' ).freeze
   
-  
-  # @todo Document tree method.
-  # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
-  # 
-  # @return [return_type]
-  #   @todo Document return value.
-  # 
-  def self.tree **options
-    if options.empty?
-      TREE
-    else
-      union \
-        array_like,
-        hash_like,
-        **options
-    end
+  def_factory :tree do |name: 'Tree', **options|
+    union \
+      array_like,
+      hash_like,
+      name: name,
+      **options
   end # .tree
   
-  TREE = tree( name: 'TreeType' ).freeze
-  
 end # module NRSER::Types

data/lib/nrser/types/tuples.rb

@@ -1,21 +1,9 @@
 # Requirements
 # =======================================================================
 
-# Stdlib
-# -----------------------------------------------------------------------
-
-# Deps
-# -----------------------------------------------------------------------
-
 # Project / Package
 # -----------------------------------------------------------------------
-
-
-# Refinements
-# =======================================================================
-
-require 'nrser/refinements'
-using NRSER
+require_relative './arrays'
 
 
 # Definitions
@@ -24,49 +12,58 @@ using NRSER
 module NRSER::Types
   
   # Tuple type - array of fixed length and types (though those could be
-  # {NRSER::Types::ANY}).
+  # {NRSER::Types.any}).
   # 
   class TupleType < NRSER::Types::ArrayType
     
-    # Constants
-    # ======================================================================
-    
-    
-    # Class Methods
-    # ======================================================================
-    
-    
     # Attributes
     # ======================================================================
     
+    # The types of each of the tuple indexes.
+    # 
+    # @return [Array<NRSER::Types::Type>]
+    #     
+    attr_reader :types
+    
     
     # Constructor
     # ======================================================================
     
     # Instantiate a new `TupleType`.
+    # 
+    # @param [Array] *types
+    #   Tuple value types by their index in the tuples.
+    #   
+    #   Entries are passed through {NRSER::Types.make} to create the type
+    #   if needed.
+    # 
+    # @param [Hash<Symbol, *>] **options
+    #   Type options; see {NRSER::Types::Type#initialize}.
+    # 
     def initialize *types, **options
       super **options
-      @types = types.map &NRSER::Types.method(:make)
+      @types = types.map( &NRSER::Types.method(:make) ).freeze
     end # #initialize
     
     
-    def default_name
-      '[' + @types.map( &:name ).join( ', ' ) + ']'
+    # @return [String]
+    #   See {NRSER::Types::Type#explain}
+    # 
+    def explain
+      'Array<(' + @types.map( &:explain ).join( ', ' ) + ')>'
     end
     
     
     # Instance Methods
     # ======================================================================
     
-    # @todo Document test method.
-    # 
-    # @param [type] arg_name
-    #   @todo Add name param description.
+    # Test value for membership.
     # 
-    # @return [return_type]
-    #   @todo Document return value.
+    # @param  (see NRSER::Types::Type#test?)
+    # @return (see NRSER::Types::Type#test?)
+    # @raise  (see NRSER::Types::Type#test?)
     # 
-    def test value
+    def test? value
       # Test the super class first
       return false unless super( value )
       
@@ -77,7 +74,7 @@ module NRSER::Types
       @types.each_with_index.all? { |type, index|
         type.test value[index]
       }
-    end # #test
+    end # #test?
     
     
     # @return [Boolean]
@@ -85,7 +82,7 @@ module NRSER::Types
     #   *all* it's types can load values from strings.
     # 
     def has_from_s?
-      @types.all? &:has_from_s?
+      @from_s || @types.all?( &:has_from_s? )
     end # #has_from_s?
     
     
@@ -106,15 +103,14 @@ module NRSER::Types
   end # class TupleType
   
 
-  # @todo Document tuple method.
+  # Get a tuple type.
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
+  # @param *types (see TupleType#initialize)
+  # @param **options (see TupleType#initialize)
   # 
-  # @return [return_type]
-  #   @todo Document return value.
+  # @return [NRSER::Types::Type]
   # 
-  def self.tuple *types, **options
+  def_factory :tuple do |*types, **options|
     TupleType.new *types, **options
   end # .tuple