nrser 0.3.9 → 0.3.10

data/lib/nrser/types/is.rb

@@ -1,77 +1,84 @@
+# encoding: UTF-8
+# frozen_string_literal: true
 
 # Requirements
 # ========================================================================
 
-# Stdlib
-# ------------------------------------------------------------------------
-
-# Deps
+# Project / Package
 # ------------------------------------------------------------------------
 
-# Need {Module#anonymous?}
-require 'active_support/core_ext/module/anonymous'
+require_relative './type'
 
 
-# Project / Package
-# ------------------------------------------------------------------------
+# Namespace
+# ========================================================================
 
-require_relative './type'
+module  NRSER
+module  Types
 
 
-module NRSER::Types
+# Type satisfied only by it's exact {#value} object (identity comparison
+# via `#equal?`).
+# 
+class Is < Type
   
-  # Type satisfied only by it's exact {#value} object (identity comparison
-  # via `#equal?`).
+  # The exact value for this type.
+  # 
+  # @return [Object]
   # 
-  class Is < NRSER::Types::Type
-    
-    # Attributes
-    # ========================================================================
-    
-    attr_reader :value
-    
-    def initialize value, **options
-      super **options
-      @value = value
-    end
-    
-    def explain
-      case value
-      when Module
-        module_type = if value.is_a?( Class ) then 'Class' else 'Module' end
-        
-        name = if value.anonymous?
-          value.to_s.split( ':' ).last[0...-1]
-        else
-          value.name
-        end
-        
-        "#{ module_type }<#{ name }>"
-      else
-        value.inspect
-      end
-    end
-    
-    def test? value
-      @value.equal? value
-    end
-    
-    def == other
-      equal?(other) ||
-      ( self.class == other.class &&
-        @value == other.value )
-    end
-    
-  end # Is
+  attr_reader :value
   
+  def initialize value, **options
+    super **options
+    @value = value
+  end
   
-  # Satisfied by the exact value only (identity comparison via
-  # `#equal?`).
-  # 
-  # Useful for things like {Module}, {Class}, {Fixnum}, {Symbol}, `true`, etc.
-  # 
-  def_factory :is do |value, **options|
-    Is.new value, **options
+  def explain
+    "Is<#{ value.inspect }>"
+  end
+  
+  def test? value
+    @value.equal? value
   end
   
-end # NRSER::Types
+  def == other
+    equal?(other) ||
+    ( self.class.equal?( other.class ) &&
+      @value.equal?( other.value ) )
+  end
+
+
+  def default_symbolic
+    "{#{ value.inspect }}"
+  end
+  
+end # Is
+
+
+# @!group Identity Equality Type Factories
+# ----------------------------------------------------------------------------
+
+#@!method self.Is **options
+#   Satisfied by the exact value only (identity comparison via `#equal?`).
+#   
+#   Useful for things like {Module}, {Class}, {Fixnum}, {Symbol}, `true`, etc.
+#   
+#   @param [Hash] options
+#     Passed to {Type#initialize}.
+#   
+#   @return [Type]
+#   
+def_type        :Is,
+  parameterize: :value,
+&->( value, **options ) do
+  Is.new value, **options
+end # .Is
+
+# @!endgroup Identity Equality Type Factories # ******************************
+
+
+# /Namespace
+# ========================================================================
+
+end # module Types
+end # module NRSER

data/lib/nrser/types/is_a.rb

@@ -1,98 +1,155 @@
+# frozen_string_literal: true
+# encoding: UTF-8
+
+
+# Requirements
+# ========================================================================
+
+# Project / Package
+# ------------------------------------------------------------------------
+
 require 'nrser/types/type'
 
-module NRSER::Types
-  # Type satisfied by class membership (or mixin presence for modules).
-  # 
-  # Tests via the subject value's `#is_a?` method.
-  # 
-  class IsA < NRSER::Types::Type
-    attr_reader :mod
-    
-    def initialize mod, init_from_data: false, **options
-      unless mod.is_a?( Module )
-        raise ArgumentError,
-          "`mod` argument must be a Module (inc. Class), " \
-          "received #{ mod.inspect }"
-      end
-      
-      super **options
-      
-      @init_from_data = !!init_from_data
-      
-      @mod = mod
-    end
-    
-    
-    def explain
-      mod.safe_name
-    end
-    
-    
-    def test? value
-      value.is_a? mod
-    end
-    
-    
-    
-    # @todo Document init_from_data? method.
-    # 
-    # @param [type] arg_name
-    #   @todo Add name param description.
-    # 
-    # @return [return_type]
-    #   @todo Document return value.
-    # 
-    def init_from_data?
-      @init_from_data
-    end # #init_from_data?
-    
-    
-    
-    # Forwards to `mod.from_data`.
-    # 
-    # @param data (see NRSER::Types::Type#from_data)
-    # @return     (see NRSER::Types::Type#from_data)
-    # @raise      (see NRSER::Types::Type#from_data)
-    # 
-    def custom_from_data data
-      if init_from_data?
-        mod.new data
-      else
-        mod.from_data data
-      end
+
+# Namespace
+# ========================================================================
+
+module  NRSER
+module  Types
+
+
+# Definitions
+# ========================================================================
+
+# Type satisfied by class membership (or mixin presence for modules).
+# 
+# Tests via the subject value's `#is_a?` method is `true` for {#mod}. Works
+# for class instances as will as mixins.
+#
+# @note
+#   Construct {IsA} types using the {.IsA} factory.
+# 
+class IsA < NRSER::Types::Type
+  attr_reader :mod
+  
+  def initialize mod, init_from_data: false, **options
+    unless mod.is_a?( Module )
+      raise ArgumentError,
+        "`mod` argument must be a Module (inc. Class), " \
+        "received #{ mod.inspect }"
     end
     
+    super **options
     
-    # Overrides {NRSER::Types::Type#has_from_data?} to respond `true` when
-    # there is a instance-specific `@from_data` or the {#mod} responds to
-    # `.from_data`.
-    # 
-    # @return [Boolean]
-    # 
-    def has_from_data?
-      @from_data ||
-        init_from_data? ||
-        mod.respond_to?( :from_data )
-    end
-    
+    @init_from_data = !!init_from_data
     
-    def == other
-      equal?( other ) ||
-      ( self.class == other.class &&
-        self.mod == other.mod )
+    @mod = mod
+  end
+  
+  
+  def explain
+    mod.safe_name
+  end
+  
+  
+  def test? value
+    value.is_a? mod
+  end
+  
+  
+  def init_from_data?
+    @init_from_data
+  end # #init_from_data?
+  
+  
+  # Forwards to `mod.from_data`.
+  # 
+  # @param data (see NRSER::Types::Type#from_data)
+  # @return     (see NRSER::Types::Type#from_data)
+  # @raise      (see NRSER::Types::Type#from_data)
+  # 
+  def custom_from_data data
+    if init_from_data?
+      mod.new data
+    else
+      mod.from_data data
     end
-    
-  end # IsA
+  end
   
   
-  # class membership
-  def_factory :is_a do |mod, **options|
-    IsA.new mod, **options
+  # Overrides {NRSER::Types::Type#has_from_data?} to respond `true` when
+  # there is a instance-specific `@from_data` or the {#mod} responds to
+  # `.from_data`.
+  # 
+  # @return [Boolean]
+  # 
+  def has_from_data?
+    @from_data ||
+      init_from_data? ||
+      mod.respond_to?( :from_data )
   end
   
   
-  def_factory :type do |**options|
-    is_a NRSER::Types::Type
+  def == other
+    equal?( other ) ||
+    ( self.class == other.class &&
+      self.mod == other.mod )
   end
   
-end # NRSER::Types
+end # class IsA
+
+
+# @!group Class Instance Type Factories
+# ----------------------------------------------------------------------------
+
+# @!method self.IsA module_, **options
+#   Create a type
+#   
+#       { x : x.is_a?( mod ) == true }
+#   
+#   If `mod` is a {Class}, the returned {Type} will be satisfied by instances
+#   of `mod`.
+#   
+#   If `mod` is a non-Class {Module}, the returned {Type} will be satisfied
+#   by instances of classes that include `mod`.
+#   
+#   @param [Module] module_
+#     The {Class} or {Module} that type members should be.
+#   
+#   @param [Hash] options
+#     Passed to {Type#initialize}.
+#   
+#   @return [Type]
+# 
+def_type        :IsA,
+  parameterize: :mod,
+&->( module_, **options ) do
+  IsA.new module_, **options
+end
+
+
+#@!method self.Type **options
+#   A type whose members are {Type} instances themselves.
+#   
+#   @todo
+#     This is where the methods that load types from data and strings that 
+#     are used by CLI apps to spec params and the like should go!
+#   
+#   @param [Hash] options
+#     Passed to {Type#initialize}.
+#   
+#   @return [IsA]
+#   
+def_type        :Type,
+&->( **options ) do
+  IsA NRSER::Types::Type, **options
+end # .Type
+
+# @!endgroup Class Instance Type Factories # *********************************
+
+
+# /Namespace
+# ========================================================================
+
+end # module Types
+end # module NRSER

data/lib/nrser/types/labels.rb

@@ -1,22 +1,51 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# ========================================================================
+
+# Project / Package
+# ------------------------------------------------------------------------
+
 require_relative './combinators'
 require_relative './strings'
 
+
+# Namespace
+# ========================================================================
+
+module  NRSER
+module  Types
+
+
 # Definitions
 # =======================================================================
 
-module NRSER::Types
-  
-  # A label is a non-empty {String} or {Symbol}.
-  # 
-  # @param [Hash] **options
-  #   Options to pass to {NRSER::Types::Type#initialize}.
-  # 
-  # @return [NRSER::Types::Type]
-  # 
-  def_factory(
-    :label,
-  ) do |name: 'Label', **options|
-    union non_empty_str, non_empty_sym, name: name, **options
-  end # .label
-  
-end # module NRSER::Types
+# @!group Label Type Factories
+# ----------------------------------------------------------------------------
+
+#@!method self.Label **options
+#   A label is a non-empty {String} or {Symbol}.
+#   
+#   @param [Hash] options
+#     Passed to {Type#initialize}.
+#   
+#   @return [Type]
+#   
+def_type        :Label,
+&->( **options ) do
+  self.Union \
+    self.NonEmptyString,
+    self.NonEmptySymbol,
+    **options
+end # .Label
+
+# @!endgroup Label Type Factories # ******************************************
+
+
+# /Namespace
+# ========================================================================
+
+end # module Types
+end # module NRSER
+