nub 0.0.21 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102f1cf06e8b45889dd60b7372e5111f492a97fdf8ed8caafd30b3dac5690dd3
-  data.tar.gz: e921565b8a4ab7ef8644a1e0993d7187105840f38d73d21c6145cb420d7d8952
+  metadata.gz: 2d1f52ad1711edbf971ab19153089cc15697b097e89dc4c81e56ff04342d5037
+  data.tar.gz: c35dc79b738286eb79a40d4f0ae183799f729640b2127739f51f3fec4c4227a2
 SHA512:
-  metadata.gz: 27f89bc3db8382e91415a3009d2cc76136734cf4f25685a5f40797b0cfdebabfc3fd5ff808eb4f84366c949bea3a5eebf38e8d333fcda2d58242f6716eb868f2
-  data.tar.gz: 5110db336085570bb0ec25497f4f61edc0f5d063de501e6edbbd01401846eb9c52a667d14b124f8363a7f853d94e0f8f71843b7be4e8653e832f5520ac127357
+  metadata.gz: 15d57c7911a96b7a3292bc802e5eea5755d6096c9bb770154d7c32c6aa1c84af7f53e710295cba5bc96f1a4253929d158b45cbaa406b3c430eda6816f40c09e2
+  data.tar.gz: ba00b64e92031dbb0d9633e7d55ea3fdc1cad627cdb610b65200ac5d2587dee8ac41244eb17a20a1c7baee62ce9869b41534cf561575bd520f0f82df8b3fce39

data/lib/nub.rb

@@ -20,6 +20,7 @@
 #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #SOFTWARE.
 
+# Nub is the top level module useful for requiring all sub-modules at once.
 module Nub
   require 'nub/cmds'
   require 'nub/config'

data/lib/nub/config.rb

@@ -32,8 +32,8 @@ end
 require_relative 'user'
 require_relative 'log'
 
-# Simple YAML configuration for an application
-# uses singleton pattern for single source of truth
+# Simple YAML configuration for an application.
+# Uses singleton pattern for single source of truth
 module Config
 
   # Private properties

data/lib/nub/log.rb

@@ -51,13 +51,11 @@ LogLevel = OpenStruct.new({
   debug: 3
 })
 
-# Singleton logger for use with both console and gtk+ apps
-# logs to both a file and the console/queue for shell/UI apps
-# uses Mutex.synchronize where required to provide thread safty
+# Singleton logger for use with both console and gtk+ apps.
+# Logs to both a file and the console/queue for shell/UI apps.
+# Uses Mutex.synchronize where required to provide thread safety.
 module Log
   extend self
-
-  # Private properties
   @@_level = 3
   @@_queue = nil
   @@_stdout = true
@@ -68,8 +66,7 @@ module Log
     attr_reader(:id, :path)
   end
 
-  # Singleton new alternate initialize
-  # Can be called multiple times to reset
+  # Singleton's init method can be called multiple times to reset.
   # @param path [String] path to log file
   # @param queue [Bool] use a queue as well
   # @param stdout [Bool] turn on or off stdout

data/lib/nub/net.rb

@@ -21,6 +21,7 @@
 #SOFTWARE.
 require 'ostruct'
 
+# Collection of simply network related helpers
 module Net 
   @@_proxy = nil
   @@_agents = OpenStruct.new({

data/lib/nub/string.rb

@@ -21,6 +21,8 @@
 
 # Monkey patch string with some useful methods
 class String
+
+  # Convert the string to ascii, stripping out or converting all non-ascii characters
   def to_ascii
     options = {
       :invalid => :replace,

data/lib/nub/sys.rb

@@ -0,0 +1,39 @@
+#MIT License
+#Copyright (c) 2018 phR0ze
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+require 'io/console'
+
+class Sys
+
+  # Wait for any key to be pressed  
+  def any_key?
+    begin
+      state = `stty -g`
+      `stty raw -echo -icanon isig`
+      STDIN.getc.chr
+    ensure
+      `stty #{state}`
+    end
+
+  end
+end
+
+# vim: ft=ruby:ts=2:sw=2:sts=2

data/lib/nub/user.rb

@@ -20,6 +20,7 @@
 #OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 #SOFTWARE.
 
+# Some user related helper methods
 module User
 
   # Check if the current user has root privileges

metadata

@@ -1,16 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: nub
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.23
 platform: ruby
 authors:
 - Patrick Crummett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
-dependencies: []
-description: Collection of useful utilities
+date: 2018-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
 email: 
 executables: []
 extensions: []
@@ -22,6 +92,7 @@ files:
 - lib/nub/log.rb
 - lib/nub/net.rb
 - lib/nub/string.rb
+- lib/nub/sys.rb
 - lib/nub/thread_comm.rb
 - lib/nub/user.rb
 homepage: https://github.com/phR0ze/ruby-nub
@@ -44,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Collection of useful utilities