nrser 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20a9f5822833e3797ebf2ec2ba0b6e430ad7346e
-  data.tar.gz: 0dc5e6c87d30f0d9ed99692b33da84a4f2584db9
+  metadata.gz: 8924f7337f324ced68cc42837909ecd01e31cbed
+  data.tar.gz: 9967780c03770b6f18214d6800107046db3ba3ae
 SHA512:
-  metadata.gz: 374129784c79fe2897c078beed6e4d7c168e9b2e79027bf293df15403eac73a505176db6238f2c9b14ba8d2ecbda399e61c5f2a57cce4b8ec79a0c7a12ec031e
-  data.tar.gz: ae5a9bb34f77b6d35976fbed02fa85b8267a34b9cfb0a0ec0b4db6b39bae1d38ed08c3c994f27439f437580ebc9023c6d23c19ef827b58691a5aca0969f4e17a
+  metadata.gz: e8bc8cfb3460f2c1bba1aeec16f5e9f7f56d431a5caddd01fea73422ddafb1dbe11503664a91103be82be48c51e7620794e11a052f414656baff4726bd271f3e
+  data.tar.gz: 5c48ccefb961b1308c8adf7b11aa225ce7a932ddc663c99d62e425ae7dacda93f572187fdacc86795b990950e7caff23b8e208a10b5b5484b3de4b03abcb7624

data/lib/nrser/core_ext/string.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'active_support/core_ext/string/filters'
 require 'active_support/core_ext/string/inflections'
+require 'nrser/sys/env'
 
 # Extension methods for {String}
 # 
@@ -133,5 +134,21 @@ class String
   end
   
   # @!endgroup Unicode Stylization
+
+
+  # @!group Inflection Instance Methods
+  # ==========================================================================
+  
+  # Attempt to convert `self` into an ENV var name.
+  # 
+  # @see NRSER::Sys::Env.varize
+  # 
+  # @return (see NRSER::Sys::Env.varize)
+  # 
+  def env_varize
+    NRSER::Sys::Env.varize self
+  end
+
+  # @!endgroup Inflection Instance Methods # *********************************
   
 end # class String

data/lib/nrser/labs/lots/consumer.rb

@@ -0,0 +1,104 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+class Consumer
+  def initialize
+    @consumed = []
+  end
+end
+
+
+class ArgConsumer < Consumer
+
+  def can_consume? tokens
+    return 0 unless consumed.empty?
+
+    if tokens[0][0] == '-'
+      0
+    else
+      1
+    end
+  end
+  
+end # class ArgConsumer
+
+
+class OptionalArgConsumer
+  
+end
+
+
+class OptConsumer < Consumer
+
+  def initialize name:, aliases: []
+    @name = name
+    @aliases = aliases.dup
+  end
+
+  def names
+    @names ||= [name, *aliases]
+  end
+
+  def long_names
+    @long_names ||= @names.select { |name| name.length > 1 }
+  end
+
+  def can_consume? tokens
+    return 0 unless consumed.empty?
+
+    first = tokens[0]
+
+    return 1 if long_names.any? { |name|
+      /\-\-#{ name }\=.*/ =~ first
+    }
+
+    if  tokens.length > 1 &&
+        names.any? { |name|
+          if name.length == 1
+            first == "-#{ name }"
+          else
+            first == "--#{ name }"
+          end
+        }
+      return 2
+    end
+
+    return 0
+  end
+
+  def satisfied?
+    if consumed.empty?
+      type.test?( nil )
+    else
+      true
+    end
+  end
+
+end # class OptConsumer
+
+
+class BoolOptConsumer < Consumer
+
+  def switch_tokens
+    @switches ||= names.each_with_object( Set.new ) do |name, set|
+      if name.length == 1
+        set << "-#{ name }"
+      else
+        set << "--#{ name }"
+        set << "--no-#{ name }"
+      end
+    end
+  end
+
+  def can_consume? tokens
+    return 0 unless consumed.empty?
+
+    first = tokens[0]
+
+    return 1 if self.switch_tokens.include?( tokens[0] )
+
+    return 0
+  end
+
+end # class BoolOptConsumer
+

data/lib/nrser/labs/lots/parser.rb

@@ -0,0 +1,10 @@
+
+
+class Parser
+  def initialize consumers:, tokens:
+    @consumers = consumers
+    @tokens = tokens
+  end
+
+  
+end

data/lib/nrser/log.rb

@@ -101,11 +101,9 @@ module NRSER::Log
   singleton_class.send :alias_method, :[], :logger_for
   
   
-  
   # @!group Utility Class Methods
   # ------------------------------------------------------------------------
   
-  
   # @todo Document logger_name_and_type method.
   # 
   # @param [type] arg_name
@@ -244,9 +242,82 @@ module NRSER::Log
   def self.level= level
     SemanticLogger.default_level = level_sym_for level
   end
+
+
+  # Get the current ENV var prefix to use looking for config (when values
+  # are not explictly provided).
+  # 
+  # @return [nil]
+  #   A prefix has not been sucessfully set, and we couldn't figure one out
+  #   from {.application}.
+  # 
+  # @return [false]
+  #   Looking for config in ENV has been explicitly disabled.
+  # 
+  # @return [String]
+  #   The ENV var name prefix we'll use looking for logging config.
+  #   
+  def self.env_var_prefix
+    return @env_var_prefix unless @env_var_prefix.nil?
+
+    return application.to_s.env_varize unless application.nil?
+    
+    return nil
+  end
+
+
+  # Set the {.env_var_prefix}.
+  # 
+  # @param [String | false] prefix
+  #   Value to set the prefix to. `false` disables looking up config in the
+  #   ENV.
+  #   
+  #   If anything other than `false` or a {String} that satisfies 
+  #   {NRSER::Sys::Env.var_name?} is passed a warning will be logged,
+  #   the value will be ignored, and `nil` will be returned.
+  #   
+  # @return [nil]
+  #   `prefix` was a bad value and the internal variable was not set. A
+  #   warning was also logged.
+  # 
+  # @return [String | false]
+  #   The value was set to `prefix`.
+  # 
+  def self.env_var_prefix= prefix
+    unless prefix == false || NRSER::Sys::Env.var_name?( prefix )
+      logger.warn \
+        "Bad NRSER::Log.env_var_prefix; must `false` or a String matching" +
+        "#{ NRSER::Sys::Env::VAR_NAME_RE }. Ignoring...",
+        value: prefix
+      
+      return nil
+    end
+
+    @env_var_prefix = prefix
+  end
   
   
-  def self.level_from_ENV prefix:
+  # Try to find a log level in the ENV.
+  # 
+  # @param [String | false | nil] prefix:
+  #   The prefix to look under.
+  # 
+  # @return [nil]
+  #   We either didn't look or we didn't find.
+  # 
+  # @return [Symbol]
+  #   One of {SemanticLogger::LEVELS}, returned because we found a
+  #   {NRSER.truthy?} `<prefix>_DEBUG` or `<prefix>_TRACE`.
+  # 
+  # @return [String]
+  #   Value found at `<prefix>_LOG_LEVEL`. **Note that this may not be
+  #   a valid level - this method does NOT check!**.
+  # 
+  def self.level_from_env prefix: self.env_var_prefix
+    # Bail with a `nil` if we can't figure out a prefix (it's `nil`) or
+    # looking in the ENV has been disabled (it's `false`).
+    return nil unless prefix
+
     if NRSER.truthy? ENV["#{ prefix }_TRACE"]
       return :trace
     elsif NRSER.truthy? ENV["#{ prefix }_DEBUG"]
@@ -270,8 +341,14 @@ module NRSER::Log
   
   # Setup logging.
   # 
-  # @param [type] arg_name
-  #   @todo Add name param description.
+  # @param [String | false | nil] env_var_prefix:
+  #   Prefix to ENV var names to look for logging setup config under,
+  #   like `<prefix>_LOG_LEVEL`, `<prefix>_DEBUG` and `<prefix>_TRACE`.
+  #   
+  #   If `nil` (the default), we'll try to use `application` to guess a
+  #   prefix.
+  #   
+  #   You can disable any ENV lookups by passing `false`.
   # 
   # @return [nil]
   # 
@@ -295,27 +372,28 @@ module NRSER::Log
     
     # Wrap around everything to make sure we release the mutex
     begin
-      # Setup main appender if needed
+      # Setup main appender if needed so that any logging *in here* hopefully
+      # has somewhere to go
       setup_appender! dest
+
+      # Set the application, which we may use for the ENV var prefix
+      self.application = application unless application.nil?
+
+      # Set the ENV var prefix, if we received one
+      self.env_var_prefix = env_var_prefix unless env_var_prefix.nil?
       
       # Set sync/async processor state
       setup_sync! sync
       
       # If we didn't receive a level, check the ENV
       if level.nil?
-        if env_var_prefix.nil? && !application.nil?
-          env_var_prefix = application.gsub( /[^a-zA-Z0-0_]+/, '_' ).upcase
-        end
-        
-        level = level_from_ENV prefix: env_var_prefix
+        level = level_from_env
       end
       
       # If we ended up with a level, try to set it (will only log a warning
       # if it fails, not raise, which could crash things on boot)
       setup_level! level unless level.nil?
       
-      self.application = application unless application.nil?
-      
       # Setup formatter header and body tokens, if needed
       setup_formatter_tokens! :header, header
       setup_formatter_tokens! :body, body
@@ -370,18 +448,38 @@ module NRSER::Log
   # Call {.setup!} with some default keywords that are nice for interactive
   # session (console/REPL) usage.
   # 
-  # @param  (see .setup!)
+  # @param [Boolean] add_main_logger:
+  #   Define a `logger` method at the top level (global) that gets a logger
+  #   for the main object.
+  # 
+  # @param application: (see .setup!)
+  # @param dest: (see .setup!)
+  # @param header: (see .setup!)
+  # @param sync: (see .setup!)
+  # 
   # @return (see .setup!)
   # 
-  def self.setup_for_console! dest: $stderr,
-                              sync: true,
+  def self.setup_for_console! add_main_logger: true,
+                              application: $0,
+                              dest: $stderr,
                               header: { delete: :process_info },
+                              sync: true,
                               **kwds
     setup! \
       dest: dest,
       sync: sync,
       header: header,
+      application: application,
       **kwds
+    
+    if add_main_logger
+      TOPLEVEL_BINDING.eval <<~END
+        def logger
+          NRSER::Log[self]
+        end
+      END
+    end
+
   end # .setup_for_console!
   
   
@@ -697,18 +795,32 @@ module NRSER::Log
     when false
       # Used to remove the appender and set {.appender} to `nil`.
       nil
-    when SemanticLogger::Subscriber, Hash
+
+    when SemanticLogger::Subscriber
       # Can be handled directly
       SemanticLogger.add_appender dest
+    
+    when Hash
+      # Override color formatter with our own implementation
+      if dest[:formatter] == :color
+        dest = dest.merge formatter: NRSER::Log::Formatters::Color.new
+      end
+
+      SemanticLogger.add_appender dest
       
     when String, Pathname
       # Assume these are file paths
       SemanticLogger.add_appender file_name: dest.to_s
       
-    else
+    when IO
       SemanticLogger.add_appender \
         io: dest,
         formatter: NRSER::Log::Formatters::Color.new
+      
+    else
+      # I guess just try and add it...?
+      SemanticLogger.add_appender dest
+
     end
     
     # Remove the old appender (if there was one). This is done after adding

data/lib/nrser/rspex/example_group/describe_case.rb

@@ -14,6 +14,8 @@ module NRSER::RSpex::ExampleGroup
       metadata: metadata,
       &body
   end # #describe_case
+
+  alias_method :use_case, :describe_case
   
   # Older name
   alias_method :describe_use_case, :describe_case

data/lib/nrser/rspex/example_group/describe_when.rb

@@ -25,8 +25,11 @@ module NRSER::RSpex::ExampleGroup
   end
   
   # Old name (used to be different method)
-  
   alias_method :context_where, :describe_when
+
+  # Short names (need `_` pre 'cause of `when` Ruby keyword, and suffix fucks
+  # up auto-indent in Atom/VSCode)
+  alias_method :_when, :describe_when
   
   
 end # module NRSER::RSpex::ExampleGroup

data/lib/nrser/sys/env.rb

@@ -1,13 +1,205 @@
+# encoding: UTF-8
 # frozen_string_literal: true
 
-# Declarations
+
+# Requirements
+# ========================================================================
+
+# Stdlib
+# ------------------------------------------------------------------------
+
+# Need {Set}
+require 'set'
+
+# Deps
+# ----------------------------------------------------------------------------
+
+# Need {String#underscore}
+require 'active_support/core_ext/string/inflections'
+
+
+# Namespace
+# =======================================================================
+
+module  NRSER
+module  Sys
+
+
+# Definitions
 # =======================================================================
 
-module NRSER::Sys; end
-module NRSER::Sys::Env; end
+# Tools for dealing with the system (POSIX-like) environment.
+module Env
+
+  # Constants
+  # ========================================================================
+  
+  # Common and/or important ENV var names that we don't really want to end
+  # up auto-generating.
+  # 
+  # @see http://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html
+  # @see https://archive.is/fmBRH
+  # 
+  # @return [Set<String>]
+  # 
+  COMMON_EXPORT_NAMES = Set[
+    "ARFLAGS",
+    "CC",
+    "CDPATH",
+    "CFLAGS",
+    "CHARSET",
+    "COLUMNS",
+    "DATEMSK",
+    "DEAD",
+    "EDITOR",
+    "ENV",
+    "EXINIT",
+    "FC",
+    "FCEDIT",
+    "FFLAGS",
+    "GET",
+    "GFLAGS",
+    "HISTFILE",
+    "HISTORY",
+    "HISTSIZE",
+    "HOME",
+    "IFS",
+    "LANG",
+    "LC_ALL",
+    "LC_COLLATE",
+    "LC_CTYPE",
+    "LC_MESSAGES",
+    "LC_MONETARY",
+    "LC_NUMERIC",
+    "LC_TIME",
+    "LDFLAGS",
+    "LEX",
+    "LFLAGS",
+    "LINENO",
+    "LINES",
+    "LISTER",
+    "LOGNAME",
+    "LPDEST",
+    "MAIL",
+    "MAILCHECK",
+    "MAILER",
+    "MAILPATH",
+    "MAILRC",
+    "MAKEFLAGS",
+    "MAKESHELL",
+    "MANPATH",
+    "MBOX",
+    "MORE",
+    "MSGVERB",
+    "NLSPATH",
+    "NPROC",
+    "OLDPWD",
+    "OPTARG",
+    "OPTERR",
+    "OPTIND",
+    "PAGER",
+    "PATH",
+    "PPID",
+    "PRINTER",
+    "PROCLANG",
+    "PROJECTDIR",
+    "PS1",
+    "PS2",
+    "PS3",
+    "PS4",
+    "PWD",
+    "RANDOM",
+    "SECONDS",
+    "SHELL",
+    "TERM",
+    "TERMCAP",
+    "TERMINFO",
+    "TMPDIR",
+    "TZ",
+    "USER",
+    "VISUAL",
+    "YACC",
+    "YFLAGS",
+  ].freeze
+
+
+  # Regular expression mathcing strict and portable ENV var name rules:
+  # only `A-Z`, `0-9` and `_`; can not start with digit.
+  # 
+  # @return [RegExp]
+  # 
+  VAR_NAME_RE = /\A[A-Z_][A-Z0-9_]+\z/
+
+
+  # Class Methods
+  # ========================================================================
+
+  # Is ENV var name?
+  # 
+  # Must be {String} and match {VAR_NAME_RE}.
+  # 
+  # @param [Object] name
+  #   The name. No chance of `true` unless it's a {String}.
+  # 
+  # @return [Boolean]
+  #   `true` if it passes our mustard.
+  # 
+  def self.var_name? name
+    String === name && VAR_NAME_RE =~ name
+  end # .var_name?
+
+
+  # Attempt to munge any string into a decent-looking and legal ENV var name.
+  # 
+  # We follow a strict, very portable (should be find in `sh`) guideline:
+  # 
+  # > Environment variable names [...] consist solely of uppercase letters, 
+  # > digits, and the '_' (underscore) [...] and do not begin with a digit.
+  # 
+  # @see http://pubs.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap08.html
+  # @see https://archive.is/fmBRH
+  # 
+  # @param [String] string
+  #   Take a guess.
+  # 
+  # @return [nil]
+  #   If we didn't end up with a legal ENV var name.
+  # 
+  # @return [String]
+  #   If we were able to munge a legal ENV var name.
+  # 
+  def self.varize string, prohibit_common_exports: false
+    candidate = string.
+      # 1.  Use {ActiveSupport}'s {String#underscore} to produce a nicely
+      #     underscore-separated name for common strings like class names.
+      underscore.
+      # 2.  Convert lower-case letters to upper case.
+      upcase.
+      # 3.  Smush all contiguous runs of anything not `A-Z0-9` into a `_`.
+      gsub( /[^A-Z0-9]+/, '_' ).
+      # 4.  Bite off any leading digits.
+      sub( /\A\d+/, '' ).
+      # 5.  Chomp off any trailing `_`. Just for good looks :)
+      chomp( '_' )
+    
+    # Return `nil` if we didn't get a legal ENV var name
+    return nil unless var_name?( candidate )
+
+    # If `prohibit_common_exports` is `true` and the name we made is in 
+    # that list then return `nil`.
+    if prohibit_common_exports && COMMON_EXPORT_NAMES.include?( candidate )
+      return nil
+    end
+
+    # If we got here, we're good!
+    return candidate
+  end # .varize
+
+end # module Env
 
 
-# Post-Processing
+# /Namespace
 # =======================================================================
 
-require_relative './env/path'
+end # module Sys
+end # module NRSER

data/lib/nrser/version.rb

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

data/spec/lib/nrser/sys/env/path/insert_spec.rb

@@ -1,4 +1,4 @@
-require 'nrser/sys/env'
+require 'nrser/sys/env/path'
 
 describe_spec_file(
   spec_path:        __FILE__,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nrser
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hamster
@@ -328,6 +328,8 @@ files:
 - lib/nrser/labs/globlin.rb
 - lib/nrser/labs/i8.rb
 - lib/nrser/labs/index.rb
+- lib/nrser/labs/lots/consumer.rb
+- lib/nrser/labs/lots/parser.rb
 - lib/nrser/labs/stash.rb
 - lib/nrser/log.rb
 - lib/nrser/log/appender.rb