oslg 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a72f075eb3b3eb995fe06471af5b8e2bfd56326cc6dd944fd1ee7711d8d14c9
-  data.tar.gz: bb2f2143fb8a93f34b5e5b28dc7729d591a0869a05490b77b1165a5dacc23d99
+  metadata.gz: 06f0805c49f693fad81b68a22ea45477b786e96e0b2894fc32359eb7821eab81
+  data.tar.gz: e07cf0a2d48399d7768e4fa0ba87897950f130a593721e5699f7e704735bc06d
 SHA512:
-  metadata.gz: 5d982229010b326f43b64324eb40811431140a000493f732b773a0736a63d0ffa661455eb2d77fc751beee2a7c05cf411f8bdcd218ccd75a3a9e527e6f29d0cd
-  data.tar.gz: aaaf89b502bf30d4091c8eb91e4003a79b6c4b84392611454ee23d3399dc6d4dca680f43afc86128146bff7fba21096147d06dfeca34fcb371bbb7907a2537e3
+  metadata.gz: f103e01be3e08c21952659297316eaac6faccc8e925805d3f32e3a2f6be4c53d40cf804b6f09c0b6866d8e67756b9f162ca99d398299b00bcd62d2b5a5df5c2b
+  data.tar.gz: 74e202302c1bd8eaf0d2ac78519b3bb189d8b274b9c2cce55fa668ca2f43a40ec3741c08e97a08ad025698bf1a250c3173f238946de75efa6aee8fcb680dcaaa

data/README.md

@@ -166,7 +166,7 @@ return M.hashkey("faces", faces, :area, "sum") unless faces.key?(:area)
 If the _Hash_ `faces` does not hold `:area` as one of its keys, then __hashkey__ would generate the following DEBUG log message (before returning _nil_):
 
 ```
-"'faces' Hash: no key 'area' (sum)"
+"Missing 'area' key in 'faces' Hash (sum)"
 ```
 
 Similar to __mismatch__, the method __hashkey__ requires 4x arguments (a _Hash_ ID, a valid Ruby _Hash_, the missing _key_, and the calling method ID). There are also 2x optional _terminal_ arguments, e.g. `M::ERROR, false)`.
@@ -198,8 +198,8 @@ M.zero("area", "sum", M::FATAL, false) if area.abs < TOL
 ... generating the following FATAL log message (before returning _false_):
 
 ```
-"'area' ~zero (sum)"
-"'area' ~zero (sum)"
+"Zero 'area' (sum)"
+"Zero 'area' (sum)"
 ```
 
 And again, the first 2x arguments are required; the last 2x are optional.
@@ -214,7 +214,7 @@ M.negative("area", "sum", M::FATAL, false) if area < 0
 ... generating this FATAL log message (before returning _false_):
 
 ```
-"'area' negative (sum)"
+"Negative 'area' (sum)"
 ```
 
 You guessed it: the first 2x arguments are required; the last 2x as optionals.

data/lib/oslg/oslog.rb

@@ -169,14 +169,14 @@ module OSlg
   ##
   # Log template 'invalid object' message and return user-set object.
   #
-  # @param id [String] empty object identifier
+  # @param id [String] invalid object identifier
   # @param mth [String] calling method identifier
   # @param ord [String] calling method argument order number of obj (optional)
   # @param lvl [Integer] DEBUG, INFO, WARN, ERROR or FATAL (optional)
   # @param res [Object] what to return (optional)
   #
-  # @return [Object] res if specified by user
-  # @return [Nil] nil if return object is invalid
+  # @return [Object] return object if specified by user
+  # @return [Nil] nil if return object missing or invalid
   def invalid(id = "", mth = "", ord = 0, lvl = DEBUG, res = nil)
     return nil unless defined?(res)
     return res unless defined?(id ) && id
@@ -200,15 +200,15 @@ module OSlg
   ##
   # Log template 'instance/class mismatch' message and return user-set object.
   #
-  # @param id [String] empty object identifier
+  # @param id [String] mismatched object identifier
   # @param obj [Object] object to validate
   # @param cl [Class] target class
   # @param mth [String] calling method identifier
   # @param lvl [Integer] DEBUG, INFO, WARN, ERROR or FATAL (optional)
   # @param res [Object] what to return (optional)
   #
-  # @return [Object] res if specified by user
-  # @return [Nil] nil if return object is invalid
+  # @return [Object] return object if specified by user
+  # @return [Nil] nil if return object missing or invalid
   def mismatch(id = "", obj = nil, cl = nil, mth = "", lvl = DEBUG, res = nil)
     return nil unless defined?(res)
     return res unless defined?(id ) && id
@@ -233,15 +233,15 @@ module OSlg
   ##
   # Log template 'missing hash key' message and return user-set object.
   #
-  # @param id [String] empty object identifier
+  # @param id [String] Hash identifier
   # @param hsh [Hash] hash to validate
-  # @param key [Object] target key
+  # @param key [Object] missing key
   # @param mth [String] calling method identifier
   # @param lvl [Integer] DEBUG, INFO, WARN, ERROR or FATAL (optional)
   # @param res [Object] what to return (optional)
   #
-  # @return [Object] res if specified by user
-  # @return [Nil] nil if not specified by user (or invalid)
+  # @return [Object] return object if specified by user
+  # @return [Nil] nil if return object missing or invalid
   def hashkey(id = "", hsh = {}, key = "", mth = "", lvl = DEBUG, res = nil)
     return nil unless defined?(res)
     return res unless defined?(id ) && id
@@ -257,7 +257,7 @@ module OSlg
     return res if id.empty?
     return mismatch(id, hsh, Hash, mth, lvl, res) unless hsh.is_a?(Hash)
     return res if hsh.key?(key)
-    msg  = "'#{id}' Hash: no key '#{key}' (#{mth})"
+    msg  = "Missing '#{key}' key in '#{id}' Hash (#{mth})"
     lvl = lvl.to_i unless lvl.is_a?(Integer)
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
     res
@@ -271,8 +271,8 @@ module OSlg
   # @param lvl [Integer] DEBUG, INFO, WARN, ERROR or FATAL (optional)
   # @param res [Object] what to return (optional)
   #
-  # @return [Object] res if specified by user
-  # @return [Nil] nil if return object is invalid
+  # @return [Object] return object if specified by user
+  # @return [Nil] nil if return object missing or invalid
   def empty(id = "", mth = "", lvl = DEBUG, res = nil)
     return nil unless defined?(res)
     return res unless defined?(id ) && id
@@ -293,13 +293,13 @@ module OSlg
   ##
   # Log template 'near zero' message and return user-set object.
   #
-  # @param id [String] empty object identifier
+  # @param id [String] zero object identifier
   # @param mth [String] calling method identifier
   # @param lvl [Integer] DEBUG, INFO, WARN, ERROR or FATAL (optional)
   # @param res [Object] what to return (optional)
   #
-  # @return [Object] res if specified by user
-  # @return [Nil] nil if return object is invalid
+  # @return [Object] return object if specified by user
+  # @return [Nil] nil if return object missing or invalid
   def zero(id = "", mth = "", lvl = DEBUG, res = nil)
     return nil unless defined?(res)
     return res unless defined?(id ) && id
@@ -311,7 +311,7 @@ module OSlg
     id = id.to_s.strip
     id = id[0...60] + " ..." if id.length > 60
     return res if id.empty?
-    msg  = "'#{id}' ~zero (#{mth})"
+    msg  = "Zero '#{id}' (#{mth})"
     lvl = lvl.to_i unless lvl.is_a?(Integer)
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
     res
@@ -320,13 +320,13 @@ module OSlg
   ##
   # Log template 'negative' message and return user-set object.
   #
-  # @param id [String] empty object identifier
+  # @param id [String] negative object identifier
   # @param mth [String] calling method identifier
   # @param lvl [Integer] DEBUG, INFO, WARN, ERROR or FATAL (optional)
   # @param res [Object] what to return (optional)
   #
-  # @return [Object] res if specified by user
-  # @return [Nil] nil if return object is invalid
+  # @return [Object] return object if specified by user
+  # @return [Nil] nil if return object missing or invalid
   def negative(id = "", mth = "", lvl = DEBUG, res = nil)
     return nil unless defined?(res)
     return res unless defined?(id ) && id
@@ -338,7 +338,7 @@ module OSlg
     id = id.to_s.strip
     id = id[0...60] + " ..." if id.length > 60
     return res if id.empty?
-    msg  = "'#{id}' negative (#{mth})"
+    msg  = "Negative '#{id}' (#{mth})"
     lvl = lvl.to_i unless lvl.is_a?(Integer)
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
     res

data/lib/oslg/version.rb

@@ -29,5 +29,5 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module OSlg
-  VERSION = "0.2.3".freeze
+  VERSION = "0.2.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oslg
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Denis Bourgeois
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,7 +76,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/rd2/oslg
-  source_code_uri: https://github.com/rd2/oslg/tree/v0.2.3
+  source_code_uri: https://github.com/rd2/oslg/tree/v0.2.4
   bug_tracker_uri: https://github.com/rd2/oslg/issues
 post_install_message:
 rdoc_options: []