nrser 0.2.2 → 0.3.0

data/lib/nrser/types/paths.rb

@@ -1,158 +1,137 @@
 # Requirements
 # =======================================================================
 
-# stdlib
-require 'pathname'
+# Stdlib
+# -----------------------------------------------------------------------
 
-# gems
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+require 'nrser/core_ext/pathname'
 
-# package
 require_relative './is_a'
 require_relative './where'
 require_relative './combinators'
 
 
-# Refinements
-# =======================================================================
-
-require 'nrser/refinements'
-using NRSER
-
-
-# Declarations
-# =======================================================================
-
-module NRSER; end
-
-
 # Definitions
 # =======================================================================
 
 module NRSER::Types
   
-  # A {Pathname} type that provides a `from_s`
-  PATHNAME = is_a \
-    Pathname,
-    name: 'PathnameType',
-    from_s: ->(string) { Pathname.new string },
-    to_data: :to_s
+  # @!group Type Factory Functions
+  
+  def_factory :pathname do |to_data: :to_s, **options|
+    is_a \
+      Pathname,
+      from_s: ->( string ) { Pathname.new string },
+      to_data: to_data,
+      **options
+  end
   
   
   # A type satisfied by a {Pathname} instance that's not empty (meaning it's
   # string representation is not empty).
-  NON_EMPTY_PATHNAME = intersection \
-    PATHNAME,
-    where { |value| value.to_s.length > 0 },
-    name: 'NonEmptyPathnameType'
+  def_factory :non_empty_pathname do |name: 'NonEmptyPathname', **options|
+    all_of \
+      pathname,
+      attrs( to_s: non_empty_str ),
+      name: name,
+      **options
+  end
+  
+  
+  # A path is a non-empty {String} or {Pathname}.
+  # 
+  # @param **options see NRSER::Types::Type#initialize
+  # 
+  # @return [NRSER::Types::Type]
+  # 
+  def_factory :path do |name: 'Path', **options|
+    one_of \
+      non_empty_str,
+      non_empty_pathname,
+      name: name,
+      **options
+  end # #path
+  
   
-  PATH = union non_empty_str, NON_EMPTY_PATHNAME, name: 'Path'
+  def_factory :posix_path_segment,
+              aliases: [:path_segment, :path_seg] \
+  do |name: 'POSIXPathSegment', **options|
+    all_of \
+      non_empty_str,
+      respond( to: [:include?, '/'], with: false ),
+      name: name,
+      **options
+  end
   
   
-  # Eigenclass (Singleton Class)
-  # ========================================================================
+  # An absolute {#path}.
+  # 
+  # @param **options see NRSER::Types::Type#initialize
+  # 
+  def_factory :abs_path do |name: 'AbsPath', **options|
+    intersection \
+      path,
+      # Weirdly, there is no {File.absolute?}..
+      attrs( to_pn: attrs( absolute?: true ) ),
+      name: name,
+      from_s: ->( s ) { File.expand_path s },
+      **options
+  end
+  
+  
+  # A {NRSER::Types.path} that is a directory.
+  # 
+  # @param [Hash] **options
+  #   Construction options passed to {NRSER::Types::Type#initialize}.
+  # 
+  # @return [NRSER::Types::Type]
+  # 
+  def_factory :dir_path do |name: 'DirPath', **options|
+    intersection \
+      path,
+      # TODO  How to change this from {.where}?
+      where { |path| File.directory? path },
+      name: name,
+      **options
+  end # #dir_path
+  
+  
+  # Absolute {.path} to a directory (both an {.abs_path} and an {.dir_path}).
+  # 
+  # @param name: (see NRSER::Types::Type#initialize)
+  # 
+  # @param **options
+  #   See {NRSER::Types::Type#initialize}
+  # 
+  def_factory :abs_dir_path do |name: 'AbsDirPath', **options|
+    intersection \
+      abs_path,
+      dir_path,
+      name: name,
+      **options
+  end # .abs_dir_path
+  
+  
+  # A {.path} that is a file (using {File.file?} to test).
+  # 
+  # @param name: (see NRSER::Types::Type#initialize)
+  # 
+  # @param **options
+  #   See {NRSER::Types::Type#initialize}
   # 
-  class << self
-    # @!group Type Factory Functions
-    
-    def pathname to_data: :to_s, **options
-      if options.empty? && to_data == :to_s
-        PATHNAME
-      else
-        is_a \
-          Pathname,
-          name: 'PathnameType',
-          from_s: ->(string) { Pathname.new string },
-          to_data: to_data,
-          **options
-      end
-    end
-    
-    # A path is a non-empty {String} or {Pathname}.
-    # 
-    # @param **options see NRSER::Types::Type#initialize
-    # 
-    # @return [NRSER::Types::Type]
-    # 
-    def path **options
-      if options.empty?
-        PATH
-      else
-        union non_empty_str, NON_EMPTY_PATHNAME, **options
-      end
-    end # #path
-    
-    
-    def path_segment **options
-      if options.empty?
-        POSIX_PATH_SEGMENT
-      else
-        intersection  non_empty_str,
-                      where { |string| ! string.include?( '/' ) },
-                      name: 'POSIXPathSegment'
-      end
-    end
-    
-    alias_method :path_seg, :path_segment
-    
-    
-    # An absolute {#path}.
-    # 
-    # @param **options see NRSER::Types::Type#initialize
-    # 
-    def abs_path name: 'AbsPath', **options
-      intersection \
-        path,
-        where { |path| path.to_pn.absolute? },
-        name: name,
-        from_s: ->( s ) { File.expand_path s },
-        **options
-    end
-    
-    
-    # A {NRSER::Types.path} that is a directory.
-    # 
-    # @param [Hash] **options
-    #   Construction options passed to {NRSER::Types::Type#initialize}.
-    # 
-    # @return [NRSER::Types::Type]
-    # 
-    def dir_path name: 'DirPath', **options
-      intersection \
-        path,
-        where { |path| File.directory? path },
-        name: name,
-        **options
-    end # #dir_path
-    
-    
-    # Absolute {.path} to a directory (both an {.abs_path} and an {.dir_path}).
-    # 
-    # @param [type] name:
-    #   @todo Add name param description.
-    # 
-    # @return [return_type]
-    #   @todo Document return value.
-    # 
-    def abs_dir_path name: 'AbsDirPath', **options
-      intersection \
-        abs_path,
-        dir_path,
-        name: name,
-        **options
-    end # #abs_dir_path
-    
-    
-    
-    def file_path name: 'FilePath', **options
-      intersection \
-        path,
-        where { |path| File.file? path },
-        name: name,
-        **options
-    end
-    
-  end # class << self (Eigenclass)
-  
-  POSIX_PATH_SEGMENT = path_segment name: 'POSIXPathSegment'
+  def_factory :file_path do |name: 'FilePath', **options|
+    intersection \
+      path,
+      # TODO  How to change this from {.where}?
+      where { |path| File.file? path },
+      name: name,
+      **options
+  end
   
 end # module NRSER::Types

data/lib/nrser/types/responds.rb

@@ -1,110 +1,100 @@
+require 'nrser/message'
 require_relative './booleans'
 
 module NRSER::Types
   
-  # Type that encodes messages mapped to result types that member values must
-  # satisfy.
-  class Responds < NRSER::Types::Type
+  # Type holding an {NRSER::Message} and response type. Satisfied by objects
+  # that respond with a value that satisfies the respond type when sent the
+  # message.
+  # 
+  class Respond < NRSER::Types::Type
     
-    # Constants
+    # Attributes
     # ======================================================================
     
+    # Message that will be sent to tested values.
+    # 
+    # @return [NRSER::Message]
+    #     
+    attr_reader :message
     
-    # Class Methods
-    # ======================================================================
+    
+    # Type tested values must respond with when sent the message.
+    # 
+    # @return [NRSER::Types::Type]
+    #     
+    attr_reader :response
     
     
-    # Attributes
-    # ======================================================================
+    
+    # TODO document `publicly` attribute.
+    # 
+    # @return [Boolean]
+    #     
+    attr_reader :publicly
+    
     
     
     # Constructor
     # ======================================================================
     
-    # Instantiate a new `Responds`.
-    def initialize  map,
-                    public: true,
+    # Instantiate a new `Respond`.
+    def initialize  to:,
+                    with:,
+                    publicly: true,
                     **options
-      @map = NRSER.map_values(map) { |args, type|
-        NRSER::Types.make type
-      }
+      @message = NRSER::Message.from *to
+      @publicly = publicly
+      @response = NRSER::Types.make with
+      
+      super **options
     end # #initialize
     
     
     # Instance Methods
     # ======================================================================
     
-    
-    def default_name
-      attrs_str = @map.map { |args, type|
-        args_str = args[1..-1].map(&:inspect).join ', '
-        "#{ args[0] }(#{ args_str })=#{ type.name }"
-      }.join(', ')
+    # See {NRSER::Types::Type#explain}.
+    # 
+    # @param  (see NRSER::Types::Type#explain)
+    # @return (see NRSER::Types::Type#explain)
+    # @raise  (see NRSER::Types::Type#explain)
+    # 
+    def explain
+      args_str = message.args.map( &:inspect ).join ', '
+      
+      if message.block
+        args_str += ', ' + message.block.to_s
+      end
       
-      "#{ self.class.short_name } #{ attrs_str }"
+      "##{ message.symbol }(#{ args_str })#{ RESPONDS_WITH }#{ response.explain }"
     end
     
     
-    # @todo Document test method.
+    # Test value for membership.
     # 
-    # @param [type] arg_name
-    #   @todo Add name param description.
+    # @param  (see NRSER::Types::Type#test?)
+    # @return (see NRSER::Types::Type#test?)
+    # @raise  (see NRSER::Types::Type#test?)
     # 
-    # @return [return_type]
-    #   @todo Document return value.
-    # 
-    def test value
-      @map.all? { |args, type|
-        response = if @public
-          value.public_send *args
-        else
-          value.send *args
-        end
-        
-        type.test response
-      }
+    def test? value
+      response.test message.send_to( value, publicly: publicly )
     end # #test
     
-    
   end # class Responds
   
+
+  def_factory(
+    :respond,
+  ) do |*args|
+    Respond.new *args
+  end # #responds
   
-  # Eigenclass (Singleton Class)
-  # ========================================================================
-  # 
-  class << self
-    
-    
-    # @todo Document responds method.
-    # 
-    # @param [type] arg_name
-    #   @todo Add name param description.
-    # 
-    # @return [return_type]
-    #   @todo Document return value.
-    # 
-    def responds *args
-      Responds.new *args
-    end # #responds
-    
-    
-    # @todo Document respond_to Responds.
-    # 
-    # @param [type] arg_name
-    #   @todo Add name param description.
-    # 
-    # @return [return_type]
-    #   @todo Document return value.
-    # 
-    def respond_to name, **options
-      responds(
-        {[:respond_to?, name] => NRSER::Types::TRUE},
-        **options
-      )
-    end # #respond_to
-    
-    
-  end # class << self (Eigenclass)
   
+  def_factory(
+    :respond_to
+  ) do |method_name, **options|
+    respond to: [:respond_to?, method_name], with: NRSER::Types.true
+  end # #respond_to
   
 end # module NRSER::Types

data/lib/nrser/types/shape.rb

@@ -1,24 +1,5 @@
 # frozen_string_literal: true
-
-# Requirements
-# =======================================================================
-
-# Stdlib
-# -----------------------------------------------------------------------
-
-# Deps
-# -----------------------------------------------------------------------
-
-# Project / Package
-# -----------------------------------------------------------------------
-
-
-# Refinements
-# =======================================================================
-
-
-# Declarations
-# =======================================================================
+# encoding: UTF-8
 
 
 # Definitions
@@ -28,6 +9,17 @@ module NRSER::Types
   
   class Shape < Type
     
+    
+    # Attributes
+    # ========================================================================
+    
+    # TODO document `pairs` attribute.
+    # 
+    # @return [Hash]
+    #     
+    attr_reader :pairs
+    
+    
     # Constructor
     # ======================================================================
     
@@ -36,14 +28,14 @@ module NRSER::Types
       super **options
       @pairs = pairs.map { |k, v|
         [k, NRSER::Types.make( v )]
-      }.to_h
+      }.to_h.freeze
     end # #initialize
     
     
     # Instance Methods
     # ======================================================================
     
-    def test value
+    def test? value
       begin
         @pairs.all? { |k, v|
           v === value[k]
@@ -53,7 +45,7 @@ module NRSER::Types
       end
     end
     
-    def default_name
+    def explain
       inner = @pairs.map { |k, v|
         "[#{ k.inspect }]→#{ v.name }"
       }.join( ", " )
@@ -65,10 +57,23 @@ module NRSER::Types
       end
     end
     
+    def has_from_data?
+      pairs.values.all? { |type| type.has_from_data? }
+    end
+    
+    
+    def custom_from_data data
+      pairs.map { |key, type|
+        [ key, type.from_data( data[key] ) ]
+      }.to_h
+    end
+    
   end # class Shape
   
   
-  def self.shape pairs, **options
+  def_factory(
+    :shape,
+  ) do |pairs, **options|
     Shape.new pairs, **options
   end
   

data/lib/nrser/types/strings.rb

@@ -1,18 +1,19 @@
-require 'nrser/refinements'
-require 'nrser/types/is'
-require 'nrser/types/is_a'
-require 'nrser/types/attrs'
-require 'nrser/types/not'
+require_relative './is'
+require_relative './is_a'
+require_relative './attrs'
+require_relative './not'
 
-using NRSER
   
 module NRSER::Types
   
   # @!group Type Factory Functions
   
-  def self.str length: nil, encoding: nil, **options
+  def_factory(
+    :String,
+    aliases: [ :str, :string ],
+  ) do |length: nil, encoding: nil, **options|
     if [length, encoding].all?( &:nil? )
-      IsA.new String, from_s: ->(s) { s }, **options
+      IsA.new ::String, from_s: ->(s) { s }, **options
       
     else
       types = [str]
@@ -21,27 +22,34 @@ module NRSER::Types
       
       intersection *types, **options
     end
-  end # string
-  
-  singleton_class.send :alias_method, :string, :str
+  end # String
   
   
   # Get a {Type} only satisfied by empty strings.
   # 
   # @param [String] name: (default 'EmptyString')
   # 
- def_factory :empty_str do |name: 'EmptyString', **options|
+ def_factory(
+   :EmptyString,
+   aliases: [ :empty_str, :empty_string ],
+  ) do |name: 'EmptyString', **options|
     str length: 0, name: name, **options
   end
   
   
- def_factory :non_empty_str do |**options|
-    str length: {min: 1}, **options
+ def_factory(
+   :NonEmptyString,
+   aliases: [ :non_empty_str, :non_empty_string ],
+  ) do |name: 'NonEmptyString', **options|
+    str length: {min: 1}, name: name, **options
   end
   
   
- def_factory :char do |**options|
-    str length: 1, name: "Character", **options
+ def_factory(
+   :Character,
+   aliases: [ :char, :character ],
+  ) do |name: 'Character', **options|
+    str length: 1, name: name, **options
   end
   
   
@@ -49,7 +57,7 @@ module NRSER::Types
   # 
   # @param [String] name: (default 'UTF8String')
   # 
- def_factory :uft_8, aliases: [:utf8] do |name: 'UTF8String', **options|
+  def_factory :uft_8, aliases: [:utf8] do |name: 'UTF8String', **options|
     str encoding: Encoding::UTF_8, name: name, **options
   end
   

data/lib/nrser/types/symbols.rb

@@ -1,33 +1,35 @@
-require 'nrser/refinements'
-require 'nrser/types/is'
-require 'nrser/types/is_a'
+require_relative './is'
+require_relative './is_a'
 
-require 'nrser/refinements'
-using NRSER
-  
 module NRSER::Types
 
-  def self.sym **options
-    IsA.new(
-      Symbol,
-      from_s: :to_sym.to_proc,
+  def_factory(
+    :Symbol,
+    aliases: [ :sym, :symbol ],
+  ) do |from_s: :to_sym.to_proc, **options|
+    is_a \
+      ::Symbol,
+      from_s: from_s,
       **options
-    )
   end # sym
   
-  singleton_class.send :alias_method, :symbol, :sym
-  
   
-  def self.empty_sym **options
-    is :'', name: 'EmptySymbol', **options
+  def_factory(
+    :EmptySymbol,
+    aliases: [ :empty_sym, :empty_symbol ],
+  ) do |name: 'EmptySymbol', **options|
+    is :'', name: name, **options
   end
   
   
-  def self.non_empty_sym **options
+  def_factory(
+    :NonEmptySymbol,
+    aliases: [ :non_empty_sym, :non_empty_symbol ],
+  ) do |name: 'NonEmptySymbol', **options|
     intersection \
       sym,
       self.not( empty_sym ),
-      name: 'NonEmptySymbol',
+      name: name,
       **options
   end