nub 0.0.42 → 0.0.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 289eea77b83026e03f76830c0ef68782f44fdb34237b4077e4a747e44a18e11b
-  data.tar.gz: f3605f50a0555a2cd8f5f452739a863fd421c07ecffa8bcfedd8548975eaaad6
+  metadata.gz: 18e9121a0f51826a76f7c76172ad12a543fdc1ed177e2faafd226c4748ee1c55
+  data.tar.gz: b2d67cc335778e825742b6d9778026e47c07a166243b0a0909b6c5318f740812
 SHA512:
-  metadata.gz: 0d003170c0aa05f00626d9587b666c0b66923ff4ad20401db1d39d18f7dc0f143bfbd438433f71890485e8b44ccabe3bb497cfcdd74d383fa6cb6853cc842b87
-  data.tar.gz: 41a27d08399b97a8af5da53acfd63f1b62f7137d143c46cdd783a2947126dbc37d48060ff01b5a4aade8b97c82b3d72b9534b58bd68123fff4134f60ed6cb6e3
+  metadata.gz: 1cc75cd89bf288b25b600f4a1f922dd4e8af61cc12c77c61ae798bfb0d20ca2dccc6712cb7ba6d3ca70cea4fd8685519e254f539ef177d893c12a1c3350ae6e0
+  data.tar.gz: b910fb8b96b7475db9d7d1b691eb118ee27220f78a0647cecea89c221ba3b29c92630f3058cf435abc70a586e6fc472aef73866890f643af9598533fda6f39b1

data/lib/nub/commander.rb

@@ -21,6 +21,7 @@
 
 require 'colorize'
 require_relative 'sys'
+require_relative 'string'
 
 # Command option encapsulation
 class Option
@@ -160,7 +161,7 @@ class Commander
   def help
     help = @app.nil? ? "" : "#{banner}\n"
     if !@examples.nil? && !@examples.empty?
-      newline = Sys.strip_colorize(@examples)[-1] != "\n" ? "\n" : ""
+      newline = @examples.strip_color[-1] != "\n" ? "\n" : ""
       help += "Examples:\n#{@examples}\n#{newline}"
     end
     app = @app || @app_default

data/lib/nub/config.rb

@@ -28,8 +28,7 @@ require_relative 'log'
 # Simple YAML configuration for an application.
 # Uses singleton pattern for single source of truth
 module Config
-
-  # Private properties
+  extend self
   @@_yml = nil
 
   # Public properties
@@ -39,7 +38,7 @@ module Config
 
   # Singleton new alternate
   # @param config [String] name or path of the config file
-  def self.init(config)
+  def init(config)
 
     # Determine caller's file path to look for sidecar config
     caller_path = caller_locations(1, 1).first.path
@@ -52,29 +51,29 @@ module Config
     begin
       @@_yml = File.exists?(@path) ? YAML.load_file(@path) : {}
     rescue Exception => e
-      Log.puts("Error: #{e}".colorize(:red)) and exit
+      Log.die(e)
     end
 
     return nil
   end
 
   # Simple bool whether the config exists or not on disk
-  def self.exists?
+  def exists?
       return File.exists?(@path)
   end
 
   # Hash like getter
-  def self.[](key)
+  def [](key)
     return @@_yml[key]
   end
 
   # Hash like setter
-  def self.[]=(key, val)
+  def []=(key, val)
     return @@_yml[key] = val
   end
 
   # Save the config file
-  def self.save
+  def save
     File.write(@path, @@_yml.to_yaml) if @@_yml
   end
 end

data/lib/nub/log.rb

@@ -24,6 +24,7 @@ require 'monitor'
 require 'ostruct'
 require 'colorize'
 require_relative 'sys'
+require_relative 'string'
 
 LogLevel = OpenStruct.new({
   error: 0,
@@ -73,7 +74,7 @@ module Log
     @@_monitor.synchronize{
 
       # Skip first 3 on stack (i.e. 0 = block in call_details, 1 = synchronize, 2 = call_detail) 
-      stack = caller_locations(3, 10)
+      stack = caller_locations(3, 20)
 
       # Skip past any calls in 'log.rb' or 'monitor.rb'
       i = -1
@@ -114,7 +115,7 @@ module Log
       type = (opts && opts.key?(:type)) ? opts[:type] : ""
       stamp = (opts && opts.key?(:stamp)) ? opts[:stamp] : true
       if stamp or loc
-        timestamp, location = call_details
+        timestamp, location = self.call_details
         location = loc ? location : ""
         type = ":#{type}" if !type.empty?
         str = "#{timestamp}#{location}#{type}:: #{str}"
@@ -122,7 +123,7 @@ module Log
 
       # Handle output
       if !str.empty?
-        @file << Sys.strip_colorize(str) if @path
+        @file << str.strip_color if @path
         @@_queue << str if @@_queue
         $stdout.print(str) if @@_stdout
       end
@@ -145,14 +146,14 @@ module Log
       str = str.colorize(:light_yellow) if type == 'W'
 
       if stamp or loc
-        timestamp, location = call_details
+        timestamp, location = self.call_details
         location = loc ? location : ""
         type = ":#{type}" if !type.empty?
         str = "#{timestamp}#{location}#{type}:: #{str}"
       end
 
       # Handle output
-      @file.puts(Sys.strip_colorize(str)) if @path
+      @file.puts(str.strip_color) if @path
       @@_queue << "#{str}\n" if @@_queue
       $stdout.puts(str) if @@_stdout
 
@@ -165,7 +166,7 @@ module Log
     opts[:loc] = true and opts[:type] = 'E' if opts
     args << {:loc => true, :type => 'E'} if !opts
 
-    return puts(*args)
+    return self.puts(*args)
   end
 
   def warn(*args)
@@ -173,7 +174,7 @@ module Log
       opts = args.find{|x| x.is_a?(Hash)}
       opts[:type] = 'W' if opts
       args << {:type => 'W'} if !opts
-      return puts(*args)
+      return self.puts(*args)
     end
     return true
   end
@@ -183,7 +184,7 @@ module Log
       opts = args.find{|x| x.is_a?(Hash)}
       opts[:type] = 'I' if opts
       args << {:type => 'I'} if !opts
-      return puts(*args)
+      return self.puts(*args)
     end
     return true
   end
@@ -193,7 +194,7 @@ module Log
       opts = args.find{|x| x.is_a?(Hash)}
       opts[:type] = 'D' if opts
       args << {:type => 'D'} if !opts
-      return puts(*args)
+      return self.puts(*args)
     end
     return true
   end
@@ -201,7 +202,7 @@ module Log
   # Log the given message in red and exit
   # @param msg [String] message to log
   def die(msg)
-    puts("Error: #{msg}".colorize(:red), stamp: false) and exit
+    self.puts("Error: #{msg}".colorize(:red), stamp: false) and exit
   end
 
   # Remove an item from the queue, block until one exists

data/lib/nub/string.rb

@@ -19,6 +19,19 @@
 #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #SOFTWARE.
 
+ColorPair = Struct.new(:str, :color_code, :color_name)
+ColorMap = {
+  30 => "black",
+  31 => "red",
+  32 => "green",
+  33 => "yellow",
+  34 => "blue",
+  35 => "magenta",
+  36 => "cyan",
+  37 => "white",
+  39 => "gray88"   # default
+}
+
 # Monkey patch string with some useful methods
 class String
 
@@ -32,6 +45,53 @@ class String
     }
     return self.encode(Encoding.find('ASCII'), options)
   end
+
+  # Strip the ansi color codes from the given string
+  # @returns [String] string without any ansi codes
+  def strip_color
+    return self.gsub(/\e\[0;[39]\d;49m/, '').gsub(/\e\[0m/, '')
+  end
+
+  # Tokenize the given colorized string
+  # @returns [Array] array of Token
+  def tokenize_color
+    tokens = []
+    matches = self.to_enum(:scan, /\e\[0;[39]\d;49m(.*?[\s]*)\e\[0m/).map{Regexp.last_match}
+
+    i, istart, iend = 0, 0, 0
+    match = matches[i]
+    while istart < self.size
+      color = "39"
+      iend = self.size
+      token = self[istart..iend]
+
+      # Current token is not a match
+      if match && match.begin(0) != istart
+        iend = match.begin(0)-1
+        token = self[istart..iend]
+        istart = iend + 1
+
+      # Current token is a match
+      elsif match && match.begin(0) == istart
+        iend = match.end(0)
+        token = match.captures.first
+        color = match.to_s[/\e\[0;(\d+);49m.*/, 1]
+        i += 1; match = matches[i]
+        istart = iend
+
+      # Ending
+      else
+        istart = iend
+      end
+
+      # Create token and advance
+      tokens << ColorPair.new(token, color.to_i, ColorMap[color.to_i])
+    end
+
+    return tokens
+  end
+
+
 end
 
 # vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/sys.rb

@@ -22,24 +22,22 @@
 require 'io/console'
 require 'ostruct'
 require 'stringio'
-
-ColorPair = Struct.new(:str, :color_code, :color_name)
-ColorMap = {
-  30 => "black",
-  31 => "red",
-  32 => "green",
-  33 => "yellow",
-  34 => "blue",
-  35 => "magenta",
-  36 => "cyan",
-  37 => "white",
-  39 => "gray88"   # default
-}
+require_relative 'log'
 
 module Sys
+  extend self
+
+  # Get the given environment variable by nam
+  # @param var [String] name of the environment var
+  # @param required [Bool] require that the variable exists by default
+  def env(var, required:true)
+    value = ENV[var]
+    Log.die("#{var} env variable is required!") if required && !value
+    return value
+  end
 
   # Wait for any key to be pressed  
-  def self.any_key?
+  def any_key?
     begin
       state = `stty -g`
       `stty raw -echo -icanon isig`
@@ -52,14 +50,14 @@ module Sys
   # Get the caller's filename for the caller of the function this call is nested in
   # not the function this call is called in
   # @returns [String] the caller's filename
-  def self.caller_filename
+  def caller_filename
     path = caller_locations(2, 1).first.path
     return File.basename(path)
   end
 
   # Capture STDOUT to a string
   # @returns [String] the redirected output
-  def self.capture(&block)
+  def capture(&block)
     stdout, stderr = StringIO.new, StringIO.new
     $stdout, $stderr = stdout, stderr
 
@@ -69,54 +67,6 @@ module Sys
 
     return OpenStruct.new(result: result, stdout: stdout.string, stderr: stderr.string)
   end
-
-  # Strip the ansi color codes from the given string
-  # @param str [String] string with ansi color codes
-  # @returns [String] string without any ansi codes
-  def self.strip_colorize(str)
-    return str.gsub(/\e\[0;[39]\d;49m/, '').gsub(/\e\[0m/, '')
-  end
-
-  # Tokenize the given colorized string
-  # @param str [String] string with ansi color codes
-  # @returns [Array] array of Token
-  def self.tokenize_colorize(str)
-    tokens = []
-    matches = str.to_enum(:scan, /\e\[0;[39]\d;49m(.*?[\s]*)\e\[0m/).map{Regexp.last_match}
-
-    i, istart, iend = 0, 0, 0
-    match = matches[i]
-    while istart < str.size
-      color = "39"
-      iend = str.size
-      token = str[istart..iend]
-
-      # Current token is not a match
-      if match && match.begin(0) != istart
-        iend = match.begin(0)-1
-        token = str[istart..iend]
-        istart = iend + 1
-
-      # Current token is a match
-      elsif match && match.begin(0) == istart
-        iend = match.end(0)
-        token = match.captures.first
-        color = match.to_s[/\e\[0;(\d+);49m.*/, 1]
-        i += 1; match = matches[i]
-        istart = iend
-
-      # Ending
-      else
-        istart = iend
-      end
-
-      # Create token and advance
-      tokens << ColorPair.new(token, color.to_i, ColorMap[color.to_i])
-    end
-
-    return tokens
-  end
-
 end
 
 # vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/user.rb

@@ -24,14 +24,15 @@ require 'etc'
 
 # Some user related helper methods
 module User
+  extend self
 
   # Check if the current user has root privileges
-  def self.root?
+  def root?
     return Process.uid.zero?
   end
 
   # Get the current user taking into account sudo priviledges
-  def self.name
+  def name
     return Process.uid.zero? ? Etc.getpwuid(ENV['SUDO_UID'].to_i).name : ENV['USER']
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nub
 version: !ruby/object:Gem::Version
-  version: 0.0.42
+  version: 0.0.43
 platform: ruby
 authors:
 - Patrick Crummett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize