nrser 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbe345fdd17d3661a6ab8424078866fca405486c
-  data.tar.gz: 011ea7b181ad4f101ce83a1edc9a44ea5a4728fb
+  metadata.gz: 1c1aebae949432774359be83991d38a1f2401011
+  data.tar.gz: 4c30490c2fd5fdab98b488e20a1fbc3a1b7b6273
 SHA512:
-  metadata.gz: cef54bd329af2caee3fb30220f39a57510d4a110836f86dfa7f2af744b24df8592e09f04ca27f27cbe548bb2229532e36afa2c668e2fc431ad564c4fd07b5194
-  data.tar.gz: 3b4f1a99cf7397b170559177ceca023b3e7b22f5bfe632a0c77f26c62c815ef488fea667b781035025ae2283258a57c391185272fbe077ecefd84a51317e02be
+  metadata.gz: 4d57b3ce6c67e7bc25834d9109c290a86c64a56798c47ed23b3f01ca2ce3011ea90263cf3785fa6f76a3db00d14c2c9d04595e7fa1f35006f87cbaffebad823c
+  data.tar.gz: fbd33e894a99dadbe17b8dbc7569607871e829c161518e20f0f6eb7bcea537856a1a3a9d85edcd7b7a004be01ec1928b098bfac4f332913332cd059b329c7904

data/lib/nrser/core_ext/string.rb

@@ -21,12 +21,14 @@ class String
   end
   
   
-  # See {NRSER.constantize}
-  def constantize
-    NRSER.constantize self
+  def to_const
+    safe_constantize
   end
   
-  alias_method :to_const, :constantize
+  
+  def to_const!
+    constantize
+  end
   
   
   # @return [Pathname]

data/lib/nrser/errors/conflict_error.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+require_relative './nicer_error'
+
+
+# Definitions
+# =======================================================================
+
+# General error for raising when something conflicts with something else -
+# it's not the type or an argument, but something about the data or
+# configuration just isn't ok.
+# 
+module NRSER
+class ConflictError < ::StandardError
+  include NRSER::NicerError
+end; end # class NRSER::ConflictError

data/lib/nrser/errors.rb

@@ -16,15 +16,11 @@ require_relative './errors/count_error'
 require_relative './errors/argument_error'
 require_relative './errors/type_error'
 require_relative './errors/abstract_method_error'
+require_relative './errors/conflict_error'
 
 
 module NRSER
   
-  # Indicates some piece of application state is in conflict with the attempted
-  # operation.
-  class ConflictError < StandardError; end
-  
-  
   # A wrapper error around a list of other errors.
   # 
   class MultipleErrors < StandardError

data/lib/nrser/functions/string.rb

@@ -233,59 +233,6 @@ module NRSER
     
   end # .smart_ellipsis
   
-  
-  # Get the constant identified by a string.
-  # 
-  # @pure Return value depends only on parameters.
-  # 
-  # @example
-  #   
-  #   SomeClass == NRSER.constantize(SomeClass.name)
-  # 
-  # Lifted from ActiveSupport.
-  # 
-  # @param [String] camel_cased_word
-  #   The constant's camel-cased, double-colon-separated "name",
-  #   like "NRSER::Types::Array".
-  # 
-  # @return [Object]
-  # 
-  # @raise [NameError]
-  #   When the name is not in CamelCase or is not initialized.
-  # 
-  def self.constantize(camel_cased_word)
-    names = camel_cased_word.split('::')
-
-    # Trigger a built-in NameError exception including the ill-formed constant in the message.
-    Object.const_get(camel_cased_word) if names.empty?
-
-    # Remove the first blank element in case of '::ClassName' notation.
-    names.shift if names.size > 1 && names.first.empty?
-
-    names.inject(Object) do |constant, name|
-      if constant == Object
-        constant.const_get(name)
-      else
-        candidate = constant.const_get(name)
-        next candidate if constant.const_defined?(name, false)
-        next candidate unless Object.const_defined?(name)
-
-        # Go down the ancestors to check if it is owned directly. The check
-        # stops when we reach Object or the end of ancestors tree.
-        constant = constant.ancestors.inject do |const, ancestor|
-          break const    if ancestor == Object
-          break ancestor if ancestor.const_defined?(name, false)
-          const
-        end
-
-        # owner is in Object, so raise
-        constant.const_get(name, false)
-      end
-    end
-  end # .constantize
-  
-  singleton_class.send :alias_method, :to_const, :constantize
-  
   # @!endgroup String Functions
   
 end # module NRSER

data/lib/nrser/log/formatters/color.rb

@@ -98,7 +98,7 @@ class NRSER::Log::Formatters::Color < ::SemanticLogger::Formatters::Color
   # ======================================================================
   
   # Instantiate a new `ColorFormatter`.
-  def initialize  ap: {multiline: true, raw: true},
+  def initialize  ap: {multiline: true }, # raw: true},
                   color_map: self.class.default_color_map,
                   time_format: ::SemanticLogger::Formatters::Base::TIME_FORMAT,
                   log_host: false,

data/lib/nrser/log/mixin.rb

@@ -16,15 +16,26 @@ module NRSER::Log::Mixin
   # Methods to mix into the including class.
   # 
   module ClassMethods
+    
+    protected
+    # ========================================================================
+      
+      def create_logger
+        NRSER::Log[self]
+      end
+      
+    public # end protected ***************************************************
+    
     # Returns [SemanticLogger::Logger] class level logger
     def logger
-      @semantic_logger ||= NRSER::Log[ self ]
+      @semantic_logger ||= create_logger
     end
 
     # Replace instance class level logger
     def logger= logger
       @semantic_logger = logger
     end
+    
   end
   
   
@@ -42,9 +53,52 @@ module NRSER::Log::Mixin
   # Instance Methods
   # ========================================================================
   
-  # Returns [SemanticLogger::Logger] instance level logger
+  # Gets the {NRSER::Log:Logger} for use in the instance. This will be the
+  # class logger from {ClassMethods#logger} unless the instance has a
+  # `#create_logger` method.
+  # 
+  # The `#create_logger` method is expected to return a {NRSER::Log::Logger}
+  # instance, which will be saved in the `@semantic_logger` instance variable
+  # for future use.
+  # 
+  # That method does not need to return a different logger for every instance
+  # - if you just want to have a different logger for *all* instance with a
+  # different level or formatter or whatever, you can save it somewhere else
+  # and always return that same instance.
+  # 
+  # If you are dealing with frozen instances make sure to call `#logger` before
+  # you freeze (likely in the constructor). If you don't want to save the
+  # logger at all, just override this method itself.
+  # 
+  # This is a departure from {SemanticLogger::Loggable} that started because
+  # if the instance is frozen then attempting to set `@semantic_logger` will
+  # raise an error.
+  # 
+  # I also started ending up with classes that wanted to individually
+  # configure their loggers, so it seemed like we could take out two birds
+  # with this stone.
+  # 
+  # @return [SemanticLogger::Logger]
+  #   Instance level logger, if {ClassMethods.instance_logger?},
+  #   otherwise the class level logger from {ClassMethods#logger}.
+  # 
   def logger
-    @semantic_logger ||= self.class.logger
+    return @semantic_logger if @semantic_logger
+    
+    if respond_to?( :create_logger, true )
+      @semantic_logger = begin
+        create_logger
+      rescue Exception => error
+        self.class.logger.warn \
+          "Error creating instance logger",
+          { instance: self.inspect },
+          error
+        
+        self.class.logger
+      end
+    else
+      self.class.logger
+    end
   end
   
   

data/lib/nrser/log.rb

@@ -88,7 +88,7 @@ module NRSER::Log
   # Class Methods
   # ========================================================================
   
-  def self.[] subject
+  def self.logger_for subject
     # key = logger_type_and_name_from subject
     # 
     # if @__loggers__.key? key
@@ -100,6 +100,9 @@ module NRSER::Log
     instance = NRSER::Log::Logger.new subject
   end
   
+  singleton_class.send :alias_method, :[], :logger_for
+  
+  
   
   # @!group Utility Class Methods
   # ------------------------------------------------------------------------
@@ -560,9 +563,16 @@ module NRSER::Log
     end
     
     if will_say_hi
+      loggable_dest = case dest
+      when Hash
+        dest.map { |k, v| [ k, v.to_s.truncate( 42 ) ] }.to_h
+      else
+        dest.to_s.truncate 42
+      end
+      
       logger.info "Hi! Logging is setup",
         level: self.level,
-        dest: dest,
+        dest: loggable_dest,
         sync: sync
     end
     

data/lib/nrser/props/class_methods.rb

@@ -62,6 +62,15 @@ module NRSER::Props::ClassMethods
   end
   
   
+  def prop_for name_or_alias, *props_args
+    sym = name_or_alias.to_sym
+    
+    props( *props_args ).each_value.find { |prop|
+      prop.name == sym || prop.aliases.include?( sym )
+    }
+  end
+  
+  
   def invariants *args, &block
     metadata.invariants *args, &block
   end
@@ -89,7 +98,6 @@ module NRSER::Props::ClassMethods
   # 
   def from_data data
     values = {}
-    props = self.props
     
     unless data.respond_to? :each_pair
       raise NRSER::ArgumentError.new \
@@ -107,7 +115,7 @@ module NRSER::Props::ClassMethods
       end
       
       if  prop_key &&
-          (prop = props[prop_key])
+          (prop = prop_for( prop_key, only_primary: true ))
         values[prop_key] = prop.value_from_data data_value
       end
     end
@@ -115,4 +123,23 @@ module NRSER::Props::ClassMethods
     self.new values
   end # #from_data
   
+  
+  # Get an instance from a source.
+  # 
+  # @experimental
+  # 
+  # @param [self | String | Hash] source
+  # @return [self]
+  # 
+  def self.from source
+    return source if source.is_a?( self )
+    return from_s( source ) if source.is_a?( String )
+    return from_data( source ) if source.respond_to?( :each_pair )
+    return from_data( source.to_h ) if source.respond_to?( :to_h )
+    
+    raise NRSER::ArgumentError.new \
+      "Unable to load #{ self } from source",
+      source: source
+  end # .from
+  
 end # module NRSER::Props::ClassMethods

data/lib/nrser/props/immutable/hash.rb

@@ -95,9 +95,10 @@ module NRSER::Props::Immutable::Hash
       
       super_values = {}
       
-      self.class.metadata.each_primary_prop_value_from( values ) { |prop, value|
-        super_values[prop.name] = value
-      }
+      self.class.metadata.
+        each_primary_prop_value_from( values ) { |prop, value|
+          super_values[prop.name] = value
+        }
       
       super super_values
       

data/lib/nrser/props/metadata.rb

@@ -38,6 +38,12 @@ class NRSER::Props::Metadata
   VARIABLE_NAME = :@__NRSER_metadata__
   
   
+  # Mixins
+  # ========================================================================
+  
+  include NRSER::Log::Mixin
+  
+  
   # Class Methods
   # ======================================================================
   
@@ -217,6 +223,24 @@ class NRSER::Props::Metadata
   def each_primary_prop_value_from values, &block
     primary_props = props only_primary: true
     
+    props_by_names_and_aliases = {}
+    primary_props.each_value do |prop|
+      [prop.name, *prop.aliases].each do |sym|
+        if props_by_names_and_aliases.key? sym
+          other_prop = props_by_names_and_aliases[sym]
+          
+          prop_sym_is = sym == prop.name ? 'name' : 'alias'
+          other_prop_sym_is = sym == other_prop.name ? 'name' : 'alias'
+          
+          raise NRSER::ConflictError.new \
+            "Prop",  prop.to_desc, prop_sym_is, sym.inspect,
+            "conflicts with", other_prop.to_desc, "of", other_prop_sym_is
+        end
+        
+        props_by_names_and_aliases[sym] = prop
+      end
+    end
+    
     # Normalize values to a `Hash<Symbol, VALUE>` so everything can deal with
     # one form. Default values will be set here as they're resolved and made
     # available to subsequent {Prop#default} calls.
@@ -237,9 +261,9 @@ class NRSER::Props::Metadata
         # If the `name` corresponds to a primary prop set it in the values by
         # name
         # 
-        # TODO  Should check that the name is not already set?
-        # 
-        values_by_name[name] = value if primary_props.key? name
+        if props_by_names_and_aliases.key? name
+          values_by_name[ props_by_names_and_aliases[name].name ] = value
+        end
       }
     elsif values.respond_to? :each_index
       indexed = []
@@ -263,6 +287,14 @@ class NRSER::Props::Metadata
       END
     end
     
+    # Way to noisy, even for trace
+    # logger.trace "Ready to start loading values",
+    #   values: values,
+    #   values_by_name: values_by_name,
+    #   props_by_names_and_aliases: props_by_names_and_aliases.map { |k, v|
+    #     [ k, v.to_desc ]
+    #   }.to_h
+    
     # Topological sort the primary props by their default dependencies.
     # 
     NRSER::Graph::TSorter.new(

data/lib/nrser/props/prop.rb

@@ -18,11 +18,11 @@ require 'nrser/refinements/types'
 using NRSER::Types
 
 
-# Declarations
+# Namespace
 # =======================================================================
 
-module NRSER; end
-module NRSER::Props; end
+module NRSER
+module Props
 
 
 # Definitions
@@ -33,10 +33,17 @@ module NRSER::Props; end
 # 
 # Props are immutable by design.
 # 
-class NRSER::Props::Prop
+class Prop
+  
+  # Mixins
+  # ========================================================================
   
   include NRSER::Log::Mixin
   
+  
+  # Attributes
+  # ========================================================================
+  
   # The class the prop was defined in.
   # 
   # @return [Class]
@@ -154,8 +161,17 @@ class NRSER::Props::Prop
     @to_data = to_data
     @from_data = from_data
     
-    @reader = t.bool?.check! reader
-    @writer = t.bool?.check! writer
+    @reader, @writer = [ reader, writer ].map do |value|
+      t.match value,
+        t.bool?,
+          value,
+          
+        t.hash_( keys: t.sym, values: t.bool ),
+          :freeze.to_proc,
+          
+        t.hash_( keys: t.label, values: t.bool ),
+          ->( hash ) { hash.map { |k, v| [ k.to_sym, v ] }.to_h.freeze }
+    end
     
     @aliases = t.array( t.sym ).check! aliases
     
@@ -201,7 +217,7 @@ class NRSER::Props::Prop
           defaults don't make any sense.
           
           Attempted to construct prop <%= name.inspect %> for class
-          {<%= defined_in.name %>} with:
+          {<%= defined_in_name %>} with:
           
           default:
           
@@ -267,7 +283,7 @@ class NRSER::Props::Prop
               <%= default.pretty_inspect %>
           
           when constructing prop <%= name.inspect %>
-          for class <%= defined_in.name %>
+          for class <%= defined_in_name %>
         END
       end
         
@@ -290,12 +306,27 @@ class NRSER::Props::Prop
   # Used by the {NRSER::Props::Props::ClassMethods.prop} "macro" method to
   # determine if it should create a reader method on the propertied class.
   # 
+  # @param [Symbol] name
+  #   The prop name or alias in question.
+  # 
   # @return [Boolean]
   #   `true` if a reader method should be created for the prop value.
   # 
   def create_reader? name
-    # If the options was explicitly provided then return that
-    return @reader unless @reader.nil?
+    t.sym.check! name
+    
+    # If the options was explicitly provided then use that
+    case @reader
+    when nil
+      # Fall through
+    when Hash
+      return @reader[name] if @reader.key? name
+      # else fall through
+    when true, false
+      return @reader
+    end
+        
+    # return @reader unless @reader.nil?
     
     # Always create readers for primary props
     return true if primary?
@@ -321,7 +352,16 @@ class NRSER::Props::Prop
   #   Always `false` for the moment.
   # 
   def create_writer? name
-    return @writer unless @writer.nil?
+    # If the options was explicitly provided then use that
+    case @writer
+    when nil
+      # Fall through
+    when Hash
+      return @writer[name] if @writer.key? name
+      # else fall through
+    when true, false
+      return @writer
+    end
     
     storage_immutable = defined_in.metadata.storage.try( :immutable? )
     
@@ -331,6 +371,12 @@ class NRSER::Props::Prop
   end # #create_writer?
   
   
+  def defined_in_name
+    return defined_in.safe_name if defined_in.respond_to?( :safe_name )
+    defined_in.to_s
+  end
+  
+  
   # Full name with class prop was defined in.
   # 
   # @example
@@ -340,7 +386,7 @@ class NRSER::Props::Prop
   # @return [String]
   # 
   def full_name
-    "#{ defined_in.name }##{ name }"
+    "#{ defined_in_name }##{ name }"
   end # #full_name
   
   
@@ -616,7 +662,9 @@ class NRSER::Props::Prop
       # This {Prop} does not have any custom `from_data` instructions, which
       # means we must rely on the {#type} to covert *data* to a *value*.
       # 
-      if type.has_from_data?
+      if data.is_a?( String ) && type.has_from_s?
+        type.from_s data
+      elsif type.has_from_data?
         type.from_data data
       else
         data
@@ -660,11 +708,23 @@ class NRSER::Props::Prop
   end # #value_from_data
   
   
+  def to_desc
+    "#{ full_name }:#{ type }"
+  end
+  
+  
   # @return [String]
   #   a short string describing the instance.
   # 
   def to_s
-    "#<#{ self.class.safe_name } #{ full_name }:#{ type }>"
+    "#<#{ self.class.safe_name } #{ to_desc }>"
   end # #to_s
   
-end # class NRSER::Props::Prop
+end # class Prop
+
+
+# /Namespace
+# =======================================================================
+
+end # module Props
+end # module NRSER

data/lib/nrser/refinements/types.rb

@@ -4,6 +4,10 @@ module NRSER
       def t
         NRSER::Types
       end
+      
+      def to_type
+        NRSER::Types.make self
+      end
     end
   end # module Types
 end # module NRSER

data/lib/nrser/types/arrays.rb

@@ -151,6 +151,9 @@ module NRSER::Types
   # 
   # @return [NRSER::Types::Type]
   # 
+  # @todo
+  #   Make `list` into it's own looser interface for "array-like" object API.
+  # 
   def_factory(
     :array,
     aliases: [:list],

data/lib/nrser/types/hashes.rb

@@ -191,9 +191,12 @@ module NRSER::Types
   # @return [NRSER::Types::Type]
   #   Newly constructed hash type from `args`.
   # 
+  # @todo
+  #   Make `map` into it's own looser interface for "hash-like" object API.
+  # 
   def_factory(
     :hash_type,
-    aliases: [ :dict, :hash_ ]
+    aliases: [ :dict, :hash_, :map ]
   ) do |**kwds|
     if kwds.key?( :keys ) || kwds.key?( :values )
       HashOfType.new **kwds

data/lib/nrser/types/paths.rb

@@ -85,6 +85,21 @@ module NRSER::Types
   end
   
   
+  # A relative path.
+  # 
+  # @todo
+  #   Quick addition, not sure if it's totally right with regard to tilde
+  #   paths and such.
+  # 
+  def_factory :rel_path do |name: 'RelPath', **options|
+    intersection \
+      path,
+      ~abs_path,
+      name: name,
+      **options
+  end
+  
+  
   # A {NRSER::Types.path} that is a directory.
   # 
   # @param [Hash] **options

data/lib/nrser/version.rb

@@ -18,7 +18,7 @@ module NRSER
   # 
   # @return [String]
   # 
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
   
   
   module Version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nrser
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -256,6 +256,7 @@ files:
 - lib/nrser/errors/abstract_method_error.rb
 - lib/nrser/errors/argument_error.rb
 - lib/nrser/errors/attr_error.rb
+- lib/nrser/errors/conflict_error.rb
 - lib/nrser/errors/count_error.rb
 - lib/nrser/errors/nicer_error.rb
 - lib/nrser/errors/type_error.rb