toolrack 0.9.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 571e36485e6a124ee83052bd40d53b1612973e3f7636bf8432ae5d4d4f641f35
-  data.tar.gz: 7042d576dec084cc3eccbbb49e74c2ff8e7175d4e69c3ddb2fe9027b7a65d0cd
+  metadata.gz: fc054121dfe0f58514fbb1144367c1de27e117feda1d888efd1aaa3063d6dea5
+  data.tar.gz: c8cda5ca33e463fb6aeae51e9e41e13cdd8aaf13b61c650bcd503d91739ae0dc
 SHA512:
-  metadata.gz: 32a5ebec97858317a3a500db4e2bd315a80e67bee888b302fc45ff0aacd46749b77c25b9485d3faf6588fe0efbb1a72041a731366809dd8471fe73c1aa16437e
-  data.tar.gz: e76ec4875a11dbf84634e527a665492ec9665f55747ba6aaf5007b28cb92bd1ba682072c3186b218b87a8954f4623d64908ce0b4a406573b521fb62f36128b25
+  metadata.gz: 9c410161466247551ac55f1b27e86b03e9a3416940158afc0fc59e3e7fbead8b0e6d0524f36aa9d2b5cc0a24b60a537b45642c438c488cd7f5f04ec719d38fe0
+  data.tar.gz: 0d7acf5ed32ef580fa73833ccb05f6de4c0b691544a8596e019126058344608222c7eb9bf9df7a89b4ce3fc720ab62d3e803e3423c50e603074e20ceca823725

data/README.md

@@ -1,6 +1,6 @@
 # Toolrack
 
-Toolrack just the collection of utilities that helps in my code clarity
+Toolrack just the collection of utilities that helps in my code clarity and assistance since those utils too small to be a gem on its own.
 
 ## Installation
 
@@ -40,10 +40,21 @@ class EditController
   # enable instance method to access those uitilities
   include ToolRack::ConditionUtils
   include ToolRack::ExceptionUtils
+  include ToolRack::PasswordUtils
+  include ToolRack::RuntimeUtils
+  include ToolRack::DataConversionUtils
+
+  # there is also shortcut since I write it so often
+  include TR::CondUtils
+  include TR::ExpUtils
+  include TR::PassUtils
+  include TR::RTUtils
+  include TR::DataConvUtils
 end
 ```
 
-Currently it has 3 modules:
+Currently it has 5 modules:
+
 * Condition Utilities
   * 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
@@ -77,6 +88,45 @@ Currently it has 3 modules:
   * raise\_if\_false(obj, message, error) - As the name implied
   * raise\_if\_true(obj, message, error) -  As the name implied
 
-
- 
+* Runtime utils - Tired rewriting this in other project. Detect if the running system is on which operating system / runtime. The function is pretty self descriptive
+  * RuntimeUtils.on\_windows?
+  * RuntimeUtils.on\_mac?
+  * RuntimeUtils.on\_linux?
+  * RuntimeUtils.on\_ruby?
+  * RuntimeUtils.on\_jruby?
+
+* Password utils - Generate random password with designated complexity
+  * generate\_random\_password(length, options = { complexity: \<value\>, enforce\_quality: \<true/false\> })
+    * length - length of the required generated password
+    * options[:complexity]:
+      * 1 - lowercase alphabet
+      * 2 - lower + upper case alphabet [alpha]
+      * 3 - lower + upper + number [alpha numeric]
+      * 4 - lower + upper + number + symbol
+    * options[:enforce\_quality]
+      * true - generated password is guaranteed to contain the required complexity. E.g. if complexity 4 is required, the password MUST contain lower, upper, number and symbol as its output or a new password that comply to the complexity shall be regenerated. This process is repeated until the required complexity is achieved
+      * false - The rules of the complexity is relexed. E.g. if complexity 4 is requested, the output might not have symbol in it.
+  * gen\_rand\_pass(length, options = { }) & gen\_pass(length, options = { })
+    * Alias for method generate\_random\_password
+
+  * all\_lowercase\_alpha?(str)
+  * all\_uppercase\_alpha?(str)
+  * all\_alpha?(str)
+  * all\_number?(str)
+  * all\_symbol?(str)
+  * all\_alpha\_numeric?(str)
+  * all\_alpha\_numeric\_and\_symbol?(str)
+    * All methods above starts with all_\* is to check for strict compliance to the required output. E.g. if all\_alpha?(str) is used, the input str MUST be all alpha to get a true status
+
+  * has\_lowercase\_alpha?(str)
+  * has\_uppercase\_alpha?(str)
+  * has\_alpha?(str)
+  * has\_number?(str)
+  * has\_symbol?(str)
+  * has\_alpha\_numeric?(str)
+  * has\_alpha\_numeric\_or\_symbol?(str)
+    * All methods above start with has_\* is just to check if the given str contains the required specification. E.g string 'abcdE' will still get true status if pass to has\_lowercase\_alpha?(str). But value 1234 or '1234' or '$%^&' pass to has\_lowercase\_alpha?(str) shall return false.
+
+
+Check out the rspec folder for usage
 

data/lib/toolrack/password_utils.rb

@@ -1,18 +1,3 @@
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#                    Version 2, December 2004
-#
-# Copyright (C) 2021 Chris Liaw <chrisliaw@antrapol.com>
-# Author: Chris Liaw <chrisliaw@antrapol.com>
-#
-# Everyone is permitted to copy and distribute verbatim or modified
-# copies of this license document, and changing it is allowed as long
-# as the name is changed.
-#
-#            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-#   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-#
-#  0. You just DO WHAT THE FUCK YOU WANT TO.
-
 
 require 'securerandom'
 
@@ -20,6 +5,8 @@ module Antrapol
   module ToolRack
     module PasswordUtils
       include Antrapol::ToolRack::ConditionUtils
+      
+      class PasswordUtilsError < StandardError; end
 
       # complexity
       # 1 : lowercase alphabet
@@ -27,7 +14,8 @@ module Antrapol
       # 3 : lower + upper + number
       # 4 : lower + upper + number + symbol
       def generate_random_password(length = 12, opts = { complexity: 4, enforce_quality: true })
-        
+       
+
         length = 12 if is_empty?(length)
         length = length.to_i
         length = 12 if length <= 0
@@ -36,6 +24,9 @@ module Antrapol
 
         if not_empty?(opts)
           complexity = opts[:complexity] || 4
+          
+          raise PasswordUtilsError, "Password length too short but complexity too high. Not able generate the password with required complexity." if length <= complexity
+          
           enforce_quality = opts[:enforce_quality] || true
         end
 
@@ -125,7 +116,7 @@ module Antrapol
         s = str.split("")
         lalpha = ('a'..'z').to_a
       
-        (s.difference(lalpha).length == 0)
+        (s-lalpha).length == 0
       end
 
       def has_lowercase_alpha?(str)
@@ -143,7 +134,7 @@ module Antrapol
         s = str.split("")
         ualpha = ('A'..'Z').to_a
 
-        s.difference(ualpha).length == 0
+        (s-ualpha).length == 0
       end
 
       def has_uppercase_alpha?(str)
@@ -166,8 +157,8 @@ module Antrapol
         
         alpha = [lalpha, ualpha].flatten
 
-        t1 = (alpha.difference(s).length == 0)
-        t2 = (alpha.difference(s).length == 0)
+        t1 = (alpha-s).length == 0
+        t2 = (alpha-s).length == 0
 
         t3 = (s & num).length > 0
         t4 = (s & sym).length > 0
@@ -206,7 +197,7 @@ module Antrapol
         s = str.split("")
         num = ('0'..'9').to_a
 
-        !(s.difference(num).length > 0)
+        !((s-num).length > 0)
         
       end
 
@@ -215,7 +206,7 @@ module Antrapol
 
         s = str.split("")
         sym = ('!'..'?').to_a
-        !(s.difference(sym).length > 0)
+        !((s-sym).length > 0)
         
       end
 
@@ -238,7 +229,7 @@ module Antrapol
         ualpha = ('A'..'Z').to_a
         num = ('0'..'9').to_a
         sym = ('!'..'?').to_a
-        sym = sym.difference(num)
+        sym = sym-num
 
         t1 = ((s & lalpha).length > 0)
         t2 = ((s & ualpha).length > 0)
@@ -270,7 +261,7 @@ module Antrapol
         ualpha = ('A'..'Z').to_a
         num = ('0'..'9').to_a
         sym = ('!'..'?').to_a
-        sym = sym.difference(num)
+        sym = sym-num
 
         t1 = ((s & lalpha).length > 0)
         t2 = ((s & ualpha).length > 0)
@@ -288,7 +279,7 @@ module Antrapol
         ualpha = ('A'..'Z').to_a
         num = ('0'..'9').to_a
         sym = ('!'..'?').to_a
-        sym = sym.difference(num)
+        sym = sym-num
 
         t1 = ((s & lalpha).length > 0)
         t2 = ((s & ualpha).length > 0)

data/lib/toolrack/version.rb

@@ -1,6 +1,6 @@
 module Antrapol
   module ToolRack
-    VERSION = "0.9.1"
+    VERSION = "0.11.0"
   end
 end
 

data/lib/toolrack.rb

@@ -17,13 +17,30 @@ module Antrapol
   module ToolRack
     class Error < StandardError; end
     # Your code goes here...
- 
   end
 end
 
+# try to get rid of constant redefined warning
+module TR
+  Antrapol::ToolRack
+end
+
 ToolRack = Antrapol::ToolRack
-ToolRack::DataConv = Antrapol::ToolRack::DataConversionUtils
+#TR = ToolRack
+
+ToolRack::DataConvUtils = Antrapol::ToolRack::DataConversionUtils
+TR::DataConvUtils = ToolRack::DataConvUtils
+
 ToolRack::CondUtils = ToolRack::ConditionUtils
+TR::CondUtils = ToolRack::ConditionUtils
+
 ToolRack::PassUtils = ToolRack::PasswordUtils
+TR::PassUtils = ToolRack::PasswordUtils
+
+ToolRack::ExpUtils = ToolRack::ExceptionUtils
+TR::ExpUtils = ToolRack::ExpUtils
+
+ToolRack::RTUtils = ToolRack::RuntimeUtils
+TR::RTUtils = ToolRack::RTUtils
 
 

data/toolrack.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "base58"
 
   spec.add_development_dependency "devops_helper", "~> 0.1.0"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toolrack
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Chris
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tlogger
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Just collections of utilities
 email:
 - chrisliaw@antrapol.com
@@ -88,7 +102,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/chrisliaw/toolrack
   source_code_uri: https://github.com/chrisliaw/toolrack
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Collection of simple utilities but I find it increase clarity
 test_files: []