skn_utils 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6626371d3c94b3bc3907c2076960641a49019628
-  data.tar.gz: 51fc2a420168d5d9d760cccc4dae8a2d7dbd4d13
+  metadata.gz: 5b812d7904cab21c79e37afec4bf5c9eb2f67336
+  data.tar.gz: 966367ddcb978a3bb2eb6eeea71a89c93b3ee347
 SHA512:
-  metadata.gz: 5eee749ed9ad4ccc4f4fd7c5c9d464fd459650d197b3c30acbbeace7799b88ebff4e1774e3a75ad8ed24e3f0a0fdfd9f0f3ea213eca6b67ed0797610f4caac73
-  data.tar.gz: dda45c33fa7e7d6509f6369fb84504fb0f146baa698fffe3b5c42c95bb73b02d9d168509f0b380d259d5118dd5cacd3424715556d6f09b195e4c3663daa38885
+  metadata.gz: 595bf74de49521fe61e6ec10dee7f1c56b97798096ff540e03e1bdc92e92c82e7b805018150bfb0495bca45b74c1c76ac6c9bc38aee19b774a8a081f2b6aa327
+  data.tar.gz: 1b57076cadc213712426727bcaac68a546f99f0cab187b15618b8799d106b8019d056742aa87ef092af9f271e7cf6a704bc43990ab6dd7d84fcdeb7ea7bd06d2

data/README.md

@@ -30,8 +30,8 @@ Ruby's Hash object is already extremely flexible, even more so with the addition
 1. Command registries used to dispatch command requests to proper command handler. see example app [SknBase](https://github.com/skoona/skn_base/blob/master/strategy/services/content/command_handler.rb)
 ```ruby
     SknSettings.registry = {
-                            Services::Content::Commands::RetrieveAvailableResources  => method(:resources_metadata_service),
-                            Services::Content::Commands::RetrieveResourceContent  => method(:resource_content_service)
+                            Commands::RetrieveAvailableResources  => method(:resources_metadata_service),
+                            Commands::RetrieveResourceContent  => method(:resource_content_service)
                            }
     ...
     SknSettings.registry[ cmd.class ].call( cmd )
@@ -60,6 +60,12 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
 
 ## History
+    11/09/2018 V5.3.0
+    Added two utils to SknUtils class: 
+        #catch_exceptions(&blk)  #=> catch all exceptions and retry block x times 
+        #as_human_size(12345)    #=> 12 KB
+    - See related RSpecs
+
     10/17/2018 V5.1.3
     Enhanced SknUtils::Configurable to include a #registry method/value at its root, like Clas.registry or Class.root
     - Right now these are Class methods only, will update them to survive #new later.
@@ -153,8 +159,9 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
     SknContainer/SknRegistry         # Basic Key/Value container which #registers and #resolves procs, classes, and/or object
 
-    SknSuccess                       # Three attribute value containers for return codes   -- #success, #message, #value
-    SknFailure                       # Three attribute value containers for return codes   -- #success, #message, #value
+    SknSuccess                       # Three attribute value containers for return codes   -- #value, #message, #success
+                                       - Extra #payload method returns value as NestResult if value is_a Hash 
+    SknFailure                       # Three attribute value containers for return codes   -- #value, #message, #success
 
 
 ## Public Methods: SknUtils::Configurable module

data/docs/.gitkeep

@@ -0,0 +1 @@
+keep

data/lib/skn_failure.rb

@@ -1,7 +1,7 @@
 # ##
 # Bad Result
 #
-# Syntax: SknFailure.call(payload, message=nil, bool_code=false)
+# Syntax: SknFailure.call(value, message=nil, bool_code=false)
 #
 
 class SknFailure
@@ -16,12 +16,15 @@ class SknFailure
     @value = val || "Failure"
     @message = msg || ''
     @success = rc.nil? ? false : rc
-    @_payload = val.kind_of?(Hash) ? SknUtils::DottedHash.new(val) : nil
-    # puts "#{self.class.name} => val:#{val}, rc:#{rc}, msg:#{msg}, args:#{args}"
-    # puts "#{self.class.name} => @val:#{@value}, @rc:#{@success}, @msg:#{@message}"
   end
 
   def payload
-    @_payload || @value
+    if defined?(@_payload)
+      @_payload
+    elsif value.kind_of?(Hash)
+      @_payload = SknUtils::DottedHash.new(value)
+    else
+      value
+    end
   end
 end

data/lib/skn_success.rb

@@ -1,7 +1,7 @@
 # ##
 # Good Result
 #
-# Syntax: SknSuccess.call(payload, message=nil, bool_code=true)
+# Syntax: SknSuccess.call(value, message=nil, bool_code=true)
 #
 
 class SknSuccess
@@ -16,12 +16,15 @@ class SknSuccess
     @value = val || "Success"
     @message = msg || ''
     @success = rc.nil? ? true : rc
-    @_payload = val.kind_of?(Hash) ? SknUtils::DottedHash.new(val) : nil
-    # puts "#{self.class.name} => val:#{val}, rc:#{rc}, msg:#{msg}, args:#{args}"
-    # puts "#{self.class.name} => @val:#{@value}, @rc:#{@success}, @msg:#{@message}"
   end
 
   def payload
-    @_payload || @value
+    if defined?(@_payload)
+      @_payload
+    elsif value.kind_of?(Hash)
+      @_payload = SknUtils::DottedHash.new(value.to_h)
+    else
+      value
+    end
   end
 end

data/lib/skn_utils.rb

@@ -6,7 +6,6 @@ require 'erb'
 require 'date'
 require 'time'
 require 'concurrent'
-require 'colorize'
 unless defined?(Rails)
   begin
     require 'deep_merge'
@@ -38,6 +37,7 @@ module SknUtils
 
   # Random Utils
   # Retries block up to :retries times with a :pause_between, and returns Success/Failure object
+  # -- return SknSuccess | SknFailure response object
   #
   def self.catch_exceptions(retries=3, pause_between=3, &block)
     retry_count ||= 1
@@ -46,8 +46,8 @@ module SknUtils
 
       SknSuccess.( yield )
 
-    rescue StandardError => error
-      Kernel.puts "#{retry_count} - #{error.class.name}:#{error.message}".light_blue.italic
+    rescue StandardError, ScriptError => error
+      puts "#{retry_count} - #{error.class.name}:#{error.message}"
       if retry_count <= attempts
         retry_count+= 1
         sleep(pause_between)
@@ -58,4 +58,24 @@ module SknUtils
     end
   end # end method
 
+
+  # ##
+  # SknUtils.as_human_size(12345) #=> 12 KB
+  #
+  def self.as_human_size(number)
+    units = %W(Bytes KB MB GB TB PB EB)
+    num = number.to_f
+    if number < 1001
+      num = number
+      exp = 0
+    else
+      max_exp  = units.size - 1
+      exp = ( Math.log( num ) / Math.log( 1024 ) ).round
+      exp = max_exp  if exp > max_exp
+      num /= 1024 ** exp
+    end
+    ((num > 9 || num.modulo(1) < 0.1) ? '%d %s' : '%.1f %s') % [num, units[exp]]
+  end
+
+
 end

data/lib/skn_utils/version.rb

@@ -2,7 +2,7 @@
 module SknUtils
   class Version
     MAJOR = 5
-    MINOR = 2
+    MINOR = 3
     PATCH = 0
 
     def self.to_s

data/skn_utils.gemspec

@@ -33,7 +33,6 @@ EOF
   spec.add_runtime_dependency 'deep_merge', '~> 1'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1'
   spec.add_runtime_dependency 'thor', '~> 0'
-  spec.add_runtime_dependency  'colorize', '~> 0'
 
   spec.add_development_dependency "bundler",   "~> 1"
   spec.add_development_dependency "rake",      "~> 10"

data/spec/lib/skn_utils/as_human_size_spec.rb

@@ -0,0 +1,35 @@
+##
+# spec/lib/skn_utils/as_human_size_spec.rb
+#
+
+
+describe SknUtils, 'Number to Human Readable value' do
+
+  context "#as_human_size" do
+    it '#as_human_size(123)              123 Bytes' do
+      expect(described_class.as_human_size(123)).to eq "123 Bytes"
+    end
+    it '#as_human_size(358400)           0.3 MB' do
+      expect(described_class.as_human_size(358400)).to eq "0.3 MB"
+    end
+    it '#as_human_size(1234)             1.2 KB' do
+      expect(described_class.as_human_size(1234)).to eq "1.2 KB"
+    end
+    it '#as_human_size(12345)             12 KB' do
+      expect(described_class.as_human_size(12345)).to eq "12 KB"
+    end
+    it '#as_human_size(1234567890)       1.1 GB' do
+      expect(described_class.as_human_size(1234567890)).to eq "1.1 GB"
+    end
+    it '#as_human_size(1234567890123)    1.1 TB' do
+      expect(described_class.as_human_size(1234567890123)).to eq "1.1 TB"
+    end
+    it '#as_human_size(1234567)          1.2 MB' do
+      expect(described_class.as_human_size(1234567)).to eq "1.2 MB"
+    end
+    it '#as_human_size(483989)           0.5 MB' do
+      expect(described_class.as_human_size(483989 )).to eq "0.5 MB"
+    end
+  end
+
+end

data/spec/lib/skn_utils/catch_exceptions_spec.rb

@@ -0,0 +1,27 @@
+##
+# spec/lib/skn_utils/catch_exceptions_spec.rb
+#
+
+
+describe SknUtils, 'Catch exceptions and retry block. ' do
+
+  context "#catch_exceptions" do
+    it '#catch_exceptions -- good block ' do
+      expect(
+          described_class.catch_exceptions do
+            "good"
+          end.value
+      ).to eq "good"
+    end
+
+    it '#catch_exceptions -- exception block ' do
+      expect(
+          described_class.catch_exceptions do
+            raise NotImplementedError, "Simulate Failures"
+          end.value
+      ).to include "Simulate Failures"
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +164,7 @@ files:
 - bin/configs/settings/test.yml
 - bin/console
 - bin/install
+- docs/.gitkeep
 - lib/skn_container.rb
 - lib/skn_failure.rb
 - lib/skn_hash.rb
@@ -206,6 +193,8 @@ files:
 - spec/factories/settings/test.local.yml
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb
+- spec/lib/skn_utils/as_human_size_spec.rb
+- spec/lib/skn_utils/catch_exceptions_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
 - spec/lib/skn_utils/container_spec.rb
 - spec/lib/skn_utils/nested_result_spec.rb
@@ -252,6 +241,8 @@ test_files:
 - spec/factories/settings/test.local.yml
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb
+- spec/lib/skn_utils/as_human_size_spec.rb
+- spec/lib/skn_utils/catch_exceptions_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
 - spec/lib/skn_utils/container_spec.rb
 - spec/lib/skn_utils/nested_result_spec.rb