nrser 0.0.30 → 0.1.0

data/lib/nrser/{tree → functions/tree}/transform.rb

@@ -1,13 +1,3 @@
-# Requirements
-# =======================================================================
-
-# Project / Package
-# -----------------------------------------------------------------------
-require_relative './map_tree'
-
-# Definitions
-# =======================================================================
-
 module NRSER
   
   # @todo Document transform method.

data/lib/nrser/logger.rb

@@ -1,13 +1,12 @@
-require 'logger'
-require 'yaml'
-require 'pp'
-require 'json'
-
-require 'nrser'
-require 'nrser/refinements'
+# Refinements
+# =======================================================================
 
 using NRSER
 
+
+# Definitions
+# =======================================================================
+
 module NRSER
   
   # @todo doc class
@@ -61,10 +60,10 @@ module NRSER
     # format a debug message with optional key / values to print
     #
     # @param name [String] logger name.
-    # @param level [String, Symbol, Fixnum] the level in string, symbol or 
+    # @param level [String, Symbol, Fixnum] the level in string, symbol or
     #     integer form.
     # @param msg [String] message to print.
-    # @param dump [Hash] optional hash of keys and vaues to dump.    
+    # @param dump [Hash] optional hash of keys and vaues to dump.
     def self.format name, level, msg, dump = {}
       data = {
         'logger' => name,
@@ -84,7 +83,7 @@ module NRSER
     #   msg
     # end
     
-    def self.dump_value value      
+    def self.dump_value value
       case value
       when String, Fixnum, Float, TrueClass, FalseClass
         value

data/lib/nrser/message.rb

@@ -1,9 +1,6 @@
-# Definitions
-# =======================================================================
-
 module NRSER
   
-  # Container for a message (method call) to be sent to a receiver via 
+  # Container for a message (method call) to be sent to a receiver via
   # {Object#send} (or {Object#public_send}).
   # 
   # Encapsulates the method symbol as well as any arguments and block to send.
@@ -16,7 +13,7 @@ module NRSER
   # 
   #     msg.send_to obj
   # 
-  # Useful for clearly describing and recognizing data that is meant to be 
+  # Useful for clearly describing and recognizing data that is meant to be
   # sent to an object as a method call, especially in testing.
   # 
   class Message
@@ -26,7 +23,7 @@ module NRSER
     # Instantiate a message from the arguments, unless they already are one.
     # 
     # @overload from symbol, *args, &block
-    #   Create a new instance from the arguments by passing them to 
+    #   Create a new instance from the arguments by passing them to
     #   {NRSER::Message.new}.
     # 
     #   @param [NRSER::Message] message
@@ -155,4 +152,3 @@ module NRSER
   end # class Message
   
 end # module NRSER
-

data/lib/nrser/meta.rb

@@ -1,2 +1,4 @@
+module NRSER::Meta; end
+
 require_relative './meta/class_attrs'
 require_relative './meta/props'

data/lib/nrser/meta/class_attrs.rb

@@ -1,11 +1,8 @@
-module NRSER 
-module Meta
-  
 # Mixin to provide methods to define and access class attributes - variables
 # that act like instance variables with regards to inheritance but for the
 # class itself.
 # 
-# The motivation is to create a easy-to-use class instance variables that 
+# The motivation is to create a easy-to-use class instance variables that
 # resolve like regular instance variables by looking up the inheritance
 # hierarchy - meaning that:
 # 
@@ -23,7 +20,7 @@ module Meta
 # The tests in `spec/nrser/class_attrs_spec.rb` provide detailed walk-through
 # of usage and differences from other approaches.
 # 
-module ClassAttrs 
+module NRSER::Meta::ClassAttrs
   
   # Class methods to extend the receiver with when {NRSER::Meta::ClassAttrs}
   # is included.
@@ -120,7 +117,4 @@ module ClassAttrs
     base.extend ClassMethods
   end
   
-end # module ClassAttrs
-
-end # module Meta
-end # module NRSER
+end # module NRSER::Meta::ClassAttrs

data/lib/nrser/meta/props.rb

@@ -1,15 +1,14 @@
-require 'pp'
-
-require 'nrser/refinements'
-require 'nrser/refinements/types'
+# Refinements
+# =======================================================================
 
 using NRSER
 using NRSER::Types
 
-module NRSER 
-module Meta
 
-module Props
+# Definitions
+# =======================================================================
+
+module NRSER::Meta::Props
   DEFAULT_CLASS_KEY = '__class__';
   
   PROPS_VARIABLE_NAME = :@__NRSER_props
@@ -19,7 +18,7 @@ module Props
   # Module Methods (Utilities)
   # =====================================================================
   # 
-  # These are *NOT* mixed in to including classes, and must be accessed 
+  # These are *NOT* mixed in to including classes, and must be accessed
   # via `NRSER::Meta::Props.<method_name>`.
   # 
   # They're utilities that should only really need to be used internally.
@@ -48,13 +47,13 @@ module Props
   # 
   # **WARNING**
   # 
-  # I'm sure this is all-sorts of unsafe. Please don't ever think this is 
+  # I'm sure this is all-sorts of unsafe. Please don't ever think this is
   # reasonable to use on untrusted data.
   # 
   # @param [Hash<String, Object>] data
   #   Data hash to load from.
   # 
-  # @param 
+  # @param
   # 
   # @return [NRSER::Meta::Props]
   #   Instance of a propertied class.
@@ -64,7 +63,7 @@ module Props
     
     unless data.key?( class_key )
       raise ArgumentError.new binding.erb <<-ERB
-        Data is missing <%= class_key %> key - no idea what class to 
+        Data is missing <%= class_key %> key - no idea what class to
         instantiate.
         
         Data:
@@ -122,7 +121,7 @@ module Props
   
   
   # Mixed-In Class Methods
-  # ===================================================================== 
+  # =====================================================================
   
   # Methods added to the including *class* via `extend`.
   # 
@@ -171,7 +170,7 @@ module Props
     #   Constructor options for {NRSER::Meta::Props::Prop}.
     # 
     # @return [NRSER::Meta::Props::Prop]
-    #   The newly created prop, thought you probably don't need it (it's 
+    #   The newly created prop, thought you probably don't need it (it's
     #   already all bound up on the class at this point), but why not?
     # 
     def prop name, **opts
@@ -284,13 +283,13 @@ module Props
   # Create a "data" representation suitable for transport, storage, etc.
   # 
   # The result is meant to consist of only basic data types and structures -
-  # strings, numbers, arrays, hashes, datetimes, etc... though it depends on 
-  # any custom objects it encounters correctly responding to `#to_data` for 
+  # strings, numbers, arrays, hashes, datetimes, etc... though it depends on
+  # any custom objects it encounters correctly responding to `#to_data` for
   # this to happen (as is implemented from classes that mix in Props here).
   # 
   # Prop names are converted to strings (from symbols) since though YAML
   # supports symbol values, they have poor portability across languages,
-  # and they mean the same thing in this situation. 
+  # and they mean the same thing in this situation.
   # 
   # @param [type] arg_name
   #   @todo Add name param description.
@@ -344,8 +343,9 @@ module Props
   
 end # module Props
 
-end # module Meta
-end # module NRSER
+
+# Post-Processing
+# =======================================================================
 
 require_relative './props/prop'
-require_relative './props/base'
+require_relative './props/base'

data/lib/nrser/meta/props/base.rb

@@ -1,15 +1,13 @@
 # Refinements
 # =======================================================================
 
-require 'nrser/refinements'
 using NRSER
 
 
-module NRSER
-module Meta 
-module Props 
+# Definitions
+# =======================================================================
 
-class Base
+class NRSER::Meta::Props::Base
   include NRSER::Meta::Props
   
   def initialize **values
@@ -30,8 +28,4 @@ class Base
       #<#{ self.class.name } #{ props_str }>
     END
   end # #to_s
-end # class Base
-
-end # module Props
-end # module Meta
-end # module NRSER
+end # class NRSER::Meta::Props::Base

data/lib/nrser/meta/props/prop.rb

@@ -1,23 +1,7 @@
-# Requirements
-# =======================================================================
-
-# Stdlib
-# -----------------------------------------------------------------------
-
-# Deps
-# -----------------------------------------------------------------------
-
-# Project / Package
-# -----------------------------------------------------------------------
-
-
 # Refinements
 # =======================================================================
 
-require 'nrser/refinements'
 using NRSER
-
-require 'nrser/refinements/types'
 using NRSER::Types
 
 
@@ -65,7 +49,7 @@ class NRSER::Meta::Props::Prop
   # method (method that takes no arguments) that provides the property's
   # value.
   # 
-  # Props that have a source are considered *derived*, those that don't are 
+  # Props that have a source are considered *derived*, those that don't are
   # called *primary*.
   # 
   # @return [Symbol | String]
@@ -104,7 +88,7 @@ class NRSER::Meta::Props::Prop
     
     @source = source # TODO fix this: t.maybe( t.label ).check source
     
-    # Detect if the source 
+    # Detect if the source
     if source.nil?
       @instance_variable_source = false
     else
@@ -119,7 +103,7 @@ class NRSER::Meta::Props::Prop
     # Can't provide both default and default_from
     unless default.nil? || default_from.nil?
       raise NRSER::ConflictError.new binding.erb <<-ERB
-        Both `default:` and `default_from:` keyword args provided when 
+        Both `default:` and `default_from:` keyword args provided when
         constructing <%= self %>. At least one must be `nil`.
         
         default:
@@ -144,7 +128,7 @@ class NRSER::Meta::Props::Prop
         @has_default = if source.nil?
           @type.test default
         else
-          # NOTE  This is up for debate... does a derived property have a 
+          # NOTE  This is up for debate... does a derived property have a
           #       default? What does that even mean?
           true # false ?
         end
@@ -164,7 +148,7 @@ class NRSER::Meta::Props::Prop
         # If we passed the check we know the value is valid
         @has_default = true
         
-        # Set the default value to `default`, freezing it since it will be 
+        # Set the default value to `default`, freezing it since it will be
         # set on instances without any attempt at duplication, which seems like
         # it *might be ok* since a lot of prop'd classes are being used
         # immutably.
@@ -201,7 +185,7 @@ class NRSER::Meta::Props::Prop
   end # #full_name
   
   
-  # Test if this prop is configured to provide default values - 
+  # Test if this prop is configured to provide default values -
   # 
   # @param [type] arg_name
   #   @todo Add name param description.
@@ -309,7 +293,7 @@ class NRSER::Meta::Props::Prop
   def set instance, value
     type.check( value ) do
       binding.erb <<-END
-        Value of type <%= value.class.name %> for prop <%= self.full_name %> 
+        Value of type <%= value.class.name %> for prop <%= self.full_name %>
         failed type check.
         
         Must satisfy type:
@@ -348,7 +332,7 @@ class NRSER::Meta::Props::Prop
         set instance, default
       else
         raise TypeError.new binding.erb <<-ERB
-          Prop <#= full_name %> has no default value and no value was provided 
+          Prop <#= full_name %> has no default value and no value was provided
           in values:
           
               <%= values.pretty_inspect %>
@@ -367,14 +351,14 @@ class NRSER::Meta::Props::Prop
   # declaration:
   # 
   # 1.  {nil} *default*
-  #     -   If the property value responds to `#to_data`, the result of 
+  #     -   If the property value responds to `#to_data`, the result of
   #         invoking that method will be returned.
   #         
   #         **WARNING**
   #         
   #         This can cause infinite recursion if an instance has
   #         a property value that is also an instance of the same class (as
-  #         as other more complicated scenarios that boil down to the same 
+  #         as other more complicated scenarios that boil down to the same
   #         problem), but, really, what else would it do in this situation?
   #         
   #         This problem can be avoided by by providing a `to_data:` keyword
@@ -400,7 +384,7 @@ class NRSER::Meta::Props::Prop
   #   is returned if we don't have any better options, see above).
   # 
   # @raise [TypeError]
-  #   If {@to_data} (provided via the `to_data:` keyword at property 
+  #   If {@to_data} (provided via the `to_data:` keyword at property
   #   declaration) is anything other than {nil}, {String}, {Symbol} or {Proc}.
   # 
   def to_data instance
@@ -491,7 +475,7 @@ class NRSER::Meta::Props::Prop
   # 
   def to_s
     "#<#{ self.class.name } #{ full_name }:#{ type }>"
-  end # #to_s  
+  end # #to_s
   
   
   private

data/lib/nrser/no_arg.rb

@@ -1,7 +1,5 @@
-require 'singleton'
-
 module NRSER
-  # A singleton class who's instance is used to denote the lack of value 
+  # A singleton class who's instance is used to denote the lack of value
   # for an argument when used as the default.
   # 
   # For situations where an argument is optional and `nil` is a legitimate

data/lib/nrser/refinements.rb

@@ -1,3 +1,7 @@
+# Declare the module
+module NRSER::Refinements; end
+
+# Require all refinements
 require_relative './refinements/object'
 require_relative './refinements/string'
 require_relative './refinements/array'
@@ -9,3 +13,4 @@ require_relative './refinements/set'
 require_relative './refinements/open_struct'
 require_relative './refinements/enumerator'
 require_relative './refinements/symbol'
+require_relative './refinements/types'

data/lib/nrser/refinements/array.rb

@@ -1,23 +1,11 @@
-# Requirements
-# =======================================================================
-
-# Project / Package
-# -----------------------------------------------------------------------
-require_relative './enumerable'
-require_relative './tree'
-
-
-# Definitions
-# =======================================================================
-
 module NRSER
   refine ::Array do
-    include NRSER::Refinements::Enumerable
-    include NRSER::Refinements::Tree
+    include NRSER::Ext::Enumerable
+    include NRSER::Ext::Tree
     
     
     # @return [Array]
-    #   new array consisting of all elements after the first (which may be 
+    #   new array consisting of all elements after the first (which may be
     #   none, resulting in an empty array).
     # 
     def rest
@@ -124,7 +112,7 @@ module NRSER
     #   anything, especially something as core as `#to_proc` and `Array`.
     # 
     # @return [Proc]
-    #   Lambda proc that accepts a single argument and calls `#dig` with this 
+    #   Lambda proc that accepts a single argument and calls `#dig` with this
     #   array's contents as the `#dig` arguments.
     # 
     def to_digger
@@ -136,4 +124,4 @@ module NRSER
     
     
   end # refine ::Array
-end # NRSER
+end # NRSER