nrser-rash 0.2.0

data/lib/nrser/rash/cli/call.rb

@@ -0,0 +1,137 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+module NRSER::Rash::CLI
+  
+  # Call a Rash function.
+  # 
+  # @param [String] name
+  #   Name of the function.
+  # 
+  # @param [Array<String>] argv
+  #   The shell arguments.
+  # 
+  def self.call name, argv
+
+    logger.trace "calling #{ name.inspect }, argv: #{ argv.inspect }"
+    # look for options
+    options = {}
+    args = argv.reject do |arg|
+      # long options of form '--<name>=<value>'
+      if m = arg.match(/\A--([^=]*)(=?)(.*)/)
+        options[m[1].to_sym] = if m[2] == ''
+          true
+        else
+          m[3]
+        end
+        true
+      # short options of form '-<char>'
+      elsif arg.start_with? '-'
+        arg[1..-1].each_char do |char|
+          options[char] = true
+        end
+        true
+      end
+    end
+    logger.debug "options: #{ options.inspect }"
+    # options are the last arg, unless we didn't find any
+    #
+    # NOTE: this causes functions without an optional `options` arg
+    #       on the end to raise an exception when called with any options.
+    #       
+    #       i think this is the correct behavior: the function can't handle
+    #       options, and should error out.
+    args << options unless options.empty?
+
+    NRSER::Rash.load_functions
+    if name.include? '.'
+      namespace, method_name = name.split '.'
+      namespace = namespace.split '::'
+    else
+      namespace = []
+      method_name = name
+    end
+    mod = NRSER::Rash::Functions
+    namespace.each do |submod_name|
+      mod = mod.const_get(submod_name.capitalize)
+    end
+    begin
+      rtn = mod.method(method_name).call *args
+    rescue Exception => error
+      if NRSER::Rash.config( 'PRINT_ERRORS' ).truthy?
+        if NRSER::Rash.config( 'STACKTRACE' ).truthy?
+          raise error
+        else
+          logger.fatal error
+          # this is the error code that ruby seems to exit with when you
+          # don't check the exception
+          exit 1
+        end
+      end
+    end
+    logger.debug "return value: #{ rtn.inspect }"
+    if formatted = format(rtn)
+      puts formatted
+    end
+    exit 0
+  end
+
+  # formats an object to write to `$stdout`.
+  # returns `nil` if there's nothing to write (different than returning '',
+  # indicating the empty string should be written).
+  def self.format(obj)
+    # TODO: should formatter be overridable with a env var?
+    # formatter = begin config('FORMATTER'); rescue NameError => e; nil; end
+    # logger.debug "formatter: #{ formatter.inspect }"
+    if obj.rash_formatter
+      # there is some sort of formatting info
+      # even if the value is a string, we want to follow the instructions
+      # hell, maybe we want to write the string out as json or something :/
+      if obj.rash_formatter.respond_to? :call
+        # the value responds to `call`, so call it to get the value
+        # TODO: should we check that it returns a `String`?
+        obj.rash_formatter.call(obj)
+      # NOTE: `Object.singleton_methods` returns an array of strings in 1.8
+      #       and an array of symbols in 1.9, so use strings to work in
+      #       both.
+      elsif NRSER::Rash::Formatters.
+          singleton_methods.
+          map {|_| _.to_s }.
+          include? obj.rash_formatter.to_s
+        # it's a symbol that identifies on of the {NRSER::Rash::Formatters}
+        # class methods, so call that
+        NRSER::Rash::Formatters.send obj.rash_formatter, obj
+      else
+        # whatever, call the default
+        NRSER::Rash::Formatters.send config('DEFAULT_FORMATTER'), obj
+      end
+    else
+      # there is no formatting info
+      if obj.is_a? String
+        # in the case that a method passed back a `String`, i think we should
+        # consider it formatted and just print it
+        obj
+      elsif obj.nil?
+        # the result is nil and there has been no attempt to format it in
+        # a specific way that some program might need to recongize or
+        # something. at this point, i'm going to say that the function
+        # took some successful action and doesn't have anyhting to say about
+        # it, which i think means we shouldn't print anything
+      else
+        # otherwise, send it to the default formatter
+        NRSER::Rash::Formatters.send config('DEFAULT_FORMATTER'), obj
+      end
+    end
+  end
+  
+end # module NRSER::Rash::CLI

data/lib/nrser/rash/cli/help.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+module NRSER::Rash::CLI
+  
+  def self.help
+    # TODO: woefully incomplete
+    puts <<~EOF
+      Usage: rash COMMAND [ARGS...]
+
+      Commands:
+        list      List functions you can call.
+        call      Call a method from NRSER::Rash::Functions.
+        test      Run tests for a method from NRSER::Rash::Functions.
+        help      This message.
+    EOF
+  end
+
+end # module NRSER::Rash::CLI

data/lib/nrser/rash/cli/list.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+
+# Declarations
+# =======================================================================
+
+
+# Definitions
+# =======================================================================
+
+module NRSER::Rash::CLI
+  
+  # List the Rash functions available.
+  def self.list
+    NRSER::Rash.load_functions
+    puts NRSER::Rash.function_names
+  end
+  
+end # module NRSER::Rash

data/lib/nrser/rash/cli/run.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+module NRSER::Rash::CLI
+  
+  # start here.
+  #
+  # this is the entry point for the script when executed. it expects a
+  # command as the first argument and dispatches to the associated method.
+  def self.run
+    SemanticLogger.add_appender io: $stderr, formatter: {
+      color: {
+        ap: {multiline: true},
+      }
+    }
+    SemanticLogger.default_level = NRSER::Rash.config( 'LOG_LEVEL' ).to_sym
+    
+    # the command is the first argument
+    # we won't need or want it after this, so delete it
+    command = ARGV.shift
+    # filter out the command line config options
+    NRSER::Rash.filter_and_set_config ARGV
+    case command
+    when 'call'
+      # we are being asked to call a function. the name of the function is
+      # the second argument (now at index 0 since we deleted the command)
+      # and the rest of the arguments are passed to the function
+      call ARGV[0], ARGV[1..-1]
+    when 'test'
+      NRSER::Rash._test_function ARGV.shift #, ARGV[1, ARGV.length]
+    when 'list'
+      list
+    when 'help', '-h', '--help', nil
+      help
+      # Exit with error so these calls don't work with `&&` in shell
+      exit 1
+    when '--version', 'version', '-v'
+      puts NRSER::Rash::VERSION
+    else
+      call command, ARGV
+    end
+  end
+  
+end # module NRSER::Rash::CLI

data/lib/nrser/rash/cli.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Definitions
+# =======================================================================
+
+# Where the CLI commands live as class methods.
+# 
+module NRSER::Rash::CLI
+  
+  include SemanticLogger::Loggable
+  
+end # module NRSER::Rash::CLI
+
+
+# Post-Processing
+# =======================================================================
+require_relative './cli/call'
+require_relative './cli/help'
+require_relative './cli/list'
+require_relative './cli/run'

data/lib/nrser/rash/config.rb

@@ -0,0 +1,172 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# @todo document NRSER::Rash module.
+module NRSER::Rash
+
+  COMMAND_LINE_CONFIG = {}
+  
+  
+  # Get a config value by name. First looks for an env var defined with
+  # an added `'RASH_'` prefix, then for a const in the {NRSER::Rash}
+  # module with the provided name.
+  # 
+  # @todo   This example is out of date...
+  #
+  # Easiest to explain by example:
+  # 
+  #     NRSER::Rash::config('BLAH')
+  # 
+  # will first see if there is an env var named
+  # 
+  #     'RASH_BLAH'
+  # 
+  # defined, and return it's value if so.
+  # 
+  # Otherwise, it will try and return
+  # 
+  #   NRSER::RASH::Config::BLAH
+  # 
+  # raising an exception if it's not found.
+  # 
+  # Defined here so it can be used when defining the
+  # `NRSER::Rash::Config::<name>` consts.
+  # 
+  def self.config name, *default
+    if default.length > 1
+      raise ArgumentError,
+        "wrong number of arguments" \
+        "(given #{ 1 + default.length }, expected 1-2)"
+    end
+    
+    # command line config options take precedent (those that start with
+    # '--RASH_', which are never passed to the function)
+    if COMMAND_LINE_CONFIG.key? name
+      COMMAND_LINE_CONFIG[name]
+    elsif ENV.key? "RASH_#{ name }"
+      ENV["RASH_#{ name }"]
+    else
+      begin
+        Config.const_get(name)
+      rescue NameError => e
+        if default.empty?
+          raise
+        else
+          default[0]
+        end
+      end
+    end
+  end
+  
+  
+  # Where the default config options are set.
+  # 
+  # These are overridden by:
+  #
+  # 1.  By command line options of the form
+  #     
+  #         --RASH_<name>
+  #     
+  #     where `<name>` corresponds to the `NRSER::Rash::Config::<name>`
+  #     constant.
+  #     
+  # 2.  By environment variables of the form
+  #     
+  #         RASH_<name>
+  #     
+  #     where `<name>` corresponds to the `NRSER::Rash::Config.<name>`
+  #     constant.
+  # 
+  # Don't access these directly, use {NRSER::Rash.config} to access in
+  # proper precedence.
+  # 
+  module Config
+    # Where to look for Rash files
+    HOME                = ENV['HOME']
+
+    # Where to look for the Rash profile file
+    PROFILE             = "#{ NRSER::Rash.config('HOME') }/profile.rb"
+
+    # Where to look for the Rash functions file
+    FUNCTIONS           = "#{ NRSER::Rash.config('HOME') }/functions.rb"
+
+    # The default {NRSER::Rash::Formatter} to use
+    DEFAULT_FORMATTER   = 'pp'
+
+    # Logging level
+    LOG_LEVEL           = :info
+
+    # Print stacktrace on top-level function error
+    STACKTRACE          = 'false'
+
+    # Don't print errors
+    PRINT_ERRORS         = 'true'
+
+    # Stub function namespace separator
+    STUB_NAMESPACE_SEPERATOR = '__'
+  end
+
+  # Rash's project dir
+  ROOT_DIR            = File.expand_path(File.dirname(__FILE__) + '/..')
+
+  # Executable
+  EXECUTABLE          = ROOT_DIR + '/bin/rash'
+  
+  # Proxy to {NRSER.truthy?}
+  # 
+  def self.truthy? string
+    NRSER.truthy? string
+  end
+  
+  # Old name without `?`
+  singleton_class.send :alias_method, :truthy, :truthy?
+  
+  
+  # Proxy to {NRSER.falsy?}
+  # 
+  def self.falsy? string
+    return string.falsy?
+  end
+  
+  # Old name
+  singleton_class.send :alias_method, :falsey, :falsy?
+  
+
+  def self.filter_and_set_config(args)
+    args.reject! do |arg|
+      # long options of form '--<name>=<value>'
+      if m = arg.match(/\A--RASH_([^=]*)(=?)(.*)/)
+        COMMAND_LINE_CONFIG[m[1]] = if m[2] == ''
+          true
+        else
+          m[3]
+        end
+        true
+      end
+    end
+  end
+  
+end # module NRSER::Rash

data/lib/nrser/rash/core_ext/object.rb

@@ -0,0 +1,55 @@
+class Object
+  # Monkey-patch to add an instance variable named `rash_formatter`
+  # to `Object` to control how that object is formatted for printing if
+  # it's the final value returned to {NRSER::Rash::CLI.call}.
+  #
+  # The value should either be a symbol identifying a method on
+  # {NRSER::Rash::Formatters} to call or a callable that takes the object
+  # as it's only argument and returns a formatted `String`.
+  # 
+  attr_accessor :rash_formatter
+
+  # shortcut method to set the `rash_formatter` and return the object.
+  # this method is hacked up a bit to support the following syntax:
+  # 
+  #     {:x => 1, :y => 2}.rash_formatter_tap :json
+  #     
+  #     {:x => 1, :y => 2}.rash_formatter_tap do |obj|
+  #       "here's the object: #{ obj.inspect }"
+  #     end
+  #
+  # which returns the object itself, allowing it to easily be tacked on to
+  # the last statement in a method. it's equivalent to:
+  #
+  #     {:x => 1, :y => 2}.tap {|obj| obj.rash_formatter = :json}
+  #     
+  #     {:x => 1, :y => 2}.tap do |obj|
+  #       obj.rash_formatter = Proc.new do |obj|
+  #         "here's the object: #{ obj.inpsect }"
+  #       end
+  #     end
+  #
+  def rash_formatter_tap(formatter = (default = true; nil), &block)
+    if default
+      if block.nil?
+        # neither the `formatter` arg or a block were supplied, so
+        # the method is acting as an attribute reader, return the
+        # value
+        raise ArgumentError.new "must provide an argument or block."
+      else
+        # only a block was supplied, set it as the formatter and
+        # return the object
+        @rash_formatter = block
+        self
+      end
+    else
+      if block
+        raise ArgumentError.new "can't provide an argument and block."
+      else
+        # only `formatter` arg was supplied, set it and return the object
+        @rash_formatter = formatter
+        self
+      end
+    end
+  end
+end # class Object

data/lib/nrser/rash/formatters.rb

@@ -0,0 +1,105 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# these are functions mapping an `Object` to a `String` for printing.
+# their names can be used as values for `Object.rash_formatter` to indicate
+# Rash should use that function to print the object.
+#
+module NRSER::Rash::Formatters
+  def self.yaml(obj)
+    require 'yaml'
+    YAML.dump(obj)
+  end
+
+  # print a white-space formatted key/value table given a hash.
+  # keys and values are printed cast to strings, and nested
+  # hashes are treated as sub-keys:
+  #
+  #     NRSER::Rash::Formatters.kv({
+  #       :scheme     => "https",
+  #       :host       => "www.google.com",
+  #       :port       => 443,
+  #       :params => {
+  #         :q        => "blah",
+  #         :oq       => "blah",
+  #         :aqs      => "chrome.0.57j60l4j59.468",
+  #         :sourceid => "chrome",
+  #         :ie       => "UTF-8"
+  #       },
+  #       :fragment   => nil
+  #     })
+  #     
+  #     scheme:      https
+  #     host:        www.google.com
+  #     port:        443
+  #     params:
+  #       q:         blah
+  #       oq:        blah
+  #       aqs:       chrome.0.57j60l4j59.468
+  #       sourceid:  chrome
+  #       ie:        UTF-8
+  #     fragment:
+  # 
+  def self.kv(hash)
+    find_width = lambda do |hash, indent|
+      width = 0
+      hash.each do |key, value|
+        this_width = if value.is_a? Hash
+          find_width.call(value, indent + 2)
+        else
+          key.to_s.length + indent
+        end
+        if this_width > width
+          width = this_width
+        end
+      end
+      width
+    end
+    width = find_width.call(hash, 0)
+    out = ''
+    write_out = lambda do |hash, indent|
+      hash.each do |key, value|
+        out << ' ' * indent \
+            << "#{ key }:  " \
+            << ' ' * (width - key.to_s.length - indent)
+        if value.is_a? Hash
+          out << "\n"
+          write_out.call(value, indent + 2)
+        else
+          out << "#{ value }\n"
+        end
+      end
+    end
+    write_out.call(hash, 0)
+    out
+  end
+
+  def self.json(obj)
+    require 'json'
+    JSON.dump(obj)
+  end
+
+  def self.json_pp(obj)
+    require 'json'
+    JSON.pretty_generate(obj)
+  end
+
+  def self.pp(obj)
+    require 'pp'
+    require 'stringio'
+    sio = StringIO.new
+    PP.pp(obj, sio)
+    sio.string
+  end
+  
+end # module NRSER::Rash::Formatters