toolrack 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91dc7e7717dc84f13f1cf0e7f3da03a68b6ed891d3900bd1b23abd5e8148734c
-  data.tar.gz: ff6f780710d0f7d7e21583e4a0c24e9e4508d02f089ca19d5f92f99e61773b7d
+  metadata.gz: 3b5c17ec1e90be20f1ec19300d51804183a44223b5b761bdb00475ed7d930063
+  data.tar.gz: b7776ecbd1cbad8a7541f32085d3db57a24867ef6ed2d0f9b98f5ad724e3d1a4
 SHA512:
-  metadata.gz: c5ff196e18d97bdd54096490b5ab9450dd074ae31a6e59c15030772e16953e2e7f5b345bdd61a9caf51e7617b1727773edb244fa97cff1341c355644360b2769
-  data.tar.gz: 3358f972376beff09830a084019b9b4cb5fe8ef2adb3e7f29c376d5097e858c9ab137496b41a6ea1a4316ffdcad4eebb4c10edfb90358a713e98616a3d63bfc8
+  metadata.gz: 835aa468defaf9c46aae59586c1ae1315c9112b5e116846be4f5f63661faff5d2cf1977082c313768434b6af2a8b82429db8b438a44aaf100e386dbfa2628e1b
+  data.tar.gz: 70ab89133d5088f7a04fd167a2dd9e402368323fc29bbbbeb55266bcf1d5abb84fc847bbd8ab470a0ec56afe6c83281fab174d4a2d0c98151d61c8ce0822fb8f

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/README.md

@@ -20,48 +20,63 @@ Or install it yourself as:
 
 ## Usage
 
-Toolrack is meant to be utilities hence it is prefixed with an entity.
-Therefore the two utilities are both packaged in namespace:
+The utilities are those commonly being used that I think should be group together to save some effort in my other projects.
 
 ```ruby
-module Antrapol::MyToolRack::ConditionUtils
+module ToolRack::ConditionUtils
 end
 ```
 
 ```ruby
-module Antrapol::MyToolRack::ExceptionUtils
+module ToolRack::ExceptionUtils
 end
 ```
  
-Besides, all the utilities so far is a module by itself, which means it is meant to be included/extended into application classes.
+All the utilities so far is a module by itself, which means it is meant to be included/extended into application classes.
 
 For example:
 ```ruby
 class EditController
-  include Antrapol::MyToolRack::ConditionUtils
-  include Antrapol::MyToolRack::ExceptionUtils
+  # enable instance method to access those uitilities
+  include ToolRack::ConditionUtils
+  include ToolRack::ExceptionUtils
 end
 ```
 
 Currently it has 3 modules:
 * Condition Utilities
-  * is_empty?(obj) - I find rather effort intensive to call if not (obj.nil? or obj.empty?) for items that I want to check for validity before process. Hence this method shall test for .nil?. If the object also respond to :empty? it shall be called again. For example integer type does not support .empty?
-  * not_empty?(obj) - Reverse of the is\_empty?(obj) above
+  * is\_empty?(obj) - I found that I've type the condition if not (x.nil? and x.empty?) too frequent that I think this is very best to turn this into a function. The empty test shall take the following test in sequence:
+    * First test is x.nil?. If it is return true
+    * Then test if x respond\_to? :empty?. If it is call it.
+    * Then test if x respond\_to? :length. If it is call it to see if the value is it 0 and return its comparison result
+    * Then test if x respond\_to? :size. If it is call it to see if the value is it 0 and return its comparison result
+    Once any of the test is successful, it will not proceed to test the subseqent tests and return its' result.
+  * not\_empty?(obj) - Reverse of the is\_empty?(obj) above
+  * is\_boolean?(obj) - Test given value is it a boolean value. Note this does not test if the obj is a string of 'true' or 'false'. Those shall return false by this API. If you want to test for string, use is\_string\_boolean?(str) or is\_str\_bool?(str) 
+  * is\_bool?(obj) - Shorcut to is\_boolean?()
+  * is\_string\_boolean?(str) - Test given string is it "true" or "false". Note the comparison is case insensitive. Note that both "true" and "false" shall return with value true from this API. This API does not convert the string value it to boolean. Just a test if the string carry the boolean value. Refers data conversion section if you want to convert string to boolean
+
+
+* Data Conversion Utilities
+  This is meant to convert data from a format to another format
+  * to\_b64(bin) - convert given binary to typical RFC 2045 Base64 output which includes line break in specific position
+  * to\_b64\_strict(bin) - Convert binary to RFC 4648 Base64 format, means there is no line break in between.
+  * from\_b64(str) - Convert given Base64 input into binary back. Tested this with both RFC2045 and RFC4648 Base64 output seems no issue.
+  * from\_b64\_strict(str) - Although seems the from\_b64 able to cater the RFC4648 output, prepare this in case...
+  * to\_hex(bin) - Convert binary into hex output. Note this function also convert integer into hex.
+  * from\_hex(str) - Convert hex string into binary
+  * hex\_to\_int(str) - Convert given hex string into integer. Alias method: hex\_to\_num, hex\_to\_integer, hex\_to\_number 
+  * string\_to\_boolean(str) - Convert the string into appropriate boolean true/false. Note if the given string is not "true" or "false", nil shall be returned and can test it with is\_empty? 
+
 
 * Exception Utilities
-  * raise_if_empty(obj, message, error) - Extension from the is_empty?() above, usually if it is empty, an exception shall be raised. It is just combined the conditions with raise of exception. 
-    * obj is the object to test for is_empty
+  * raise\_if\_empty(obj, message, error) - Extension from the is\_empty?() above, usually if it is empty, an exception shall be raised. It is just combined the conditions with raise of exception. 
+    * obj is the object to test for is\_empty?()
     * message is the one that shall be thrown with the exception. 
     * error is the exception type 
-  * raise_if_false(obj, message, error) - As the name implied
-  * raise_if_true(obj, message, error) -  As the name implied
-
-* Process Utilities
-  * exec(command, options = { ), &block) - Passing in the command into the method and result is returned to caller. If options is not given shall go to basic execution which is the backtick (\`). If block empty, result of the command is returned to caller. If block is given, result (true or false of the execution of command and any result from STDOUT is call to block provider(e.g. block.call($?, result)
-
-# Note on Process Utilities
+  * raise\_if\_false(obj, message, error) - As the name implied
+  * raise\_if\_true(obj, message, error) -  As the name implied
 
-The command is passed as it is to the operating system which includes fatal operation such as "rm -rf". Library at current stage made no filtering on system harmful command hence the caller of the library has to take extra precaution on what command is being passed into the library
 
  
 

data/lib/toolrack.rb

@@ -10,6 +10,7 @@ require_relative 'toolrack/exception_utils'
 require_relative 'toolrack/condition_utils'
 require_relative 'toolrack/process_utils'
 require_relative 'toolrack/runtime_utils'
+require_relative 'toolrack/data_conversion_utils'
 
 module Antrapol
   module ToolRack
@@ -20,5 +21,6 @@ module Antrapol
 end
 
 ToolRack = Antrapol::ToolRack
+ToolRack::DataConv = Antrapol::ToolRack::DataConversionUtils
 
 

data/lib/toolrack/condition_utils.rb

@@ -15,6 +15,10 @@ module Antrapol
           else
             obj.empty?
           end
+        elsif obj.respond_to?(:length)
+          obj.length == 0
+        elsif obj.respond_to?(:size)
+          obj.size == 0
         else
           false
         end
@@ -29,6 +33,21 @@ module Antrapol
       end
       alias_method :is_bool?, :is_boolean?
 
+      def is_string_boolean?(str)
+        if not_empty?(str)
+          s = str.to_s.strip.downcase
+          case s
+          when "true", "false"
+            true
+          else
+            false
+          end
+        else
+          false
+        end
+      end
+      alias_method :is_str_bool?, :is_string_boolean?
+
     end # ConditionUtils
   end # MyToolRack
 end # Antrapol

data/lib/toolrack/data_conversion_utils.rb

@@ -0,0 +1,96 @@
+
+require 'base64'
+
+module Antrapol
+  module ToolRack
+    module DataConversionUtils
+      include ConditionUtils
+      
+      def from_b64(str)
+        if not_empty?(str)
+          # decode operation supports both strict or non strict output
+          Base64.decode64(str)
+        else
+          str
+        end
+      end
+
+      def to_b64(bin)
+        if not_empty?(bin)
+          # Base64 standard output which has new line in the middle of the output
+          Base64.encode64(bin)
+        else
+          bin
+        end
+      end
+
+      def to_b64_strict(bin)
+        if not_empty?(bin)
+          # strict base64 shall have NO new line in the middle of the output
+          Base64.strict_encode64(bin)
+        else
+          bin
+        end
+      end
+
+      def from_b64_strict(str)
+        if not_empty?(str)
+          Base64.strict_decode64(str)
+        else
+          str
+        end
+      end
+
+      def from_hex(str)
+        if not_empty?(str)
+          str.scan(/../).map { |x| x.hex.chr }.join
+        else
+          str
+        end
+      end
+      alias_method :from_hex_string, :from_hex
+
+      def hex_to_number(str)
+        if not_empty?(str)
+          str.to_i(16)
+        else
+          str
+        end
+      end
+      alias_method :hex_to_num, :hex_to_number
+      alias_method :hex_to_int, :hex_to_number
+
+      def to_hex(bin)
+        if not_empty?(bin) 
+          case bin
+          when String
+            bin.each_byte.map { |b| b.to_s(16).rjust(2,'0') }.join
+          when Integer
+            bin.to_s(16)
+          else
+            bin
+          end
+        else
+          bin
+        end
+      end
+
+      def string_to_bool(str)
+        if not_empty?(str) and is_str_bool?(str)
+          s = str.to_s.strip.downcase
+          case s
+          when "true"
+            true
+          when "false"
+            false
+          else
+            nil
+          end
+        else
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/toolrack/version.rb

@@ -1,6 +1,6 @@
 module Antrapol
   module ToolRack
-    VERSION = "0.6.2"
+    VERSION = "0.7.0"
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toolrack
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Chris
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -55,6 +56,7 @@ files:
 - bin/setup
 - lib/toolrack.rb
 - lib/toolrack/condition_utils.rb
+- lib/toolrack/data_conversion_utils.rb
 - lib/toolrack/exception_utils.rb
 - lib/toolrack/global.rb
 - lib/toolrack/process_utils.rb