k_util 0.0.8 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8615e74388467bff65c418f4367b9a6946ad9f1ed9dc7aaee45ccd81774a437
-  data.tar.gz: 8c752c2c0210b4aea25afeb5a6d41847a138d11a2af5e16bcad0d8ea35499b5d
+  metadata.gz: b57165e4a0192dcffbfd3655e45b326bcc00db6ce32d1b72116516d32d8a5c07
+  data.tar.gz: 79ee2191737f976495009f303fb7db18f0ae9e52b6b344eb642dab5ae2884b6c
 SHA512:
-  metadata.gz: ac0a9551cc6a4c8c463e0bdc8b4b209695d5d8a1fcfd7c633cdc33488725d81f9479f91e54ea3393d66312543135149a9838dce70eeb46943e1b868be564aa31
-  data.tar.gz: 6512cfa298e0bf08f3b29776326dd8e8be3ebe8a0c3162c2be8764cf791748d5421ee4efd14606c65b8192351e3163a8249a610abd9481258744dae95e045d33
+  metadata.gz: 21de731f6f1d53e8d1a28df7e1f5d80058955a517d774960f0d7362c778062cac0e9445c5d6d2cde6a88a9ce1619810dce9d5103b8a5b62d83707fce34aaabc3
+  data.tar.gz: 6d062276df66896e21ffa92e07dd25d38f7951da46fcaba6ab5ced669cedd7decd669df11a7902b251589e2f17dda4bb2d7aaf61911f5c08277e20a208b6a314

data/lib/k_util.rb

@@ -2,6 +2,7 @@
 
 require 'k_util/version'
 require 'k_util/console_helper'
+require 'k_util/data/instance_variables_to_h'
 require 'k_util/data_helper'
 require 'k_util/file_helper'
 
@@ -20,3 +21,10 @@ module KUtil
   KUtil.data = KUtil::DataHelper.new
   KUtil.file = KUtil::FileHelper.new
 end
+
+if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+  namespace = 'KUtil::Version'
+  file_path = $LOADED_FEATURES.find { |f| f.include?('k_util/version') }
+  version   = KUtil::VERSION.ljust(9)
+  puts "#{namespace.ljust(35)} : #{version.ljust(9)} : #{file_path}"
+end

data/lib/k_util/data/instance_variables_to_h.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Provide data object helper functions
+module KUtil
+  module Data
+    # Helper methods attached to the namespace for working with Data
+    module InstanceVariablesToH
+      def to_h
+        hash = {}
+        instance_variables.each do |var|
+          value = instance_variable_get(var)
+
+          value = KUtil.data.to_hash(value) if KUtil.data.hash_convertible?(value)
+
+          hash[var.to_s.delete('@')] = value
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/k_util/data_helper.rb

@@ -4,7 +4,24 @@
 module KUtil
   # Helper methods attached to the namespace for working with Data
   class DataHelper
+    # Convert JSON string into to_open_struct but designed to work with a JSON string
+    #
+    # https://docs.ruby-lang.org/en/master/JSON.html
+    # rubocop:disable Naming/MethodParameterName
+    def json_parse(json, as: :hash)
+      case as
+      when :hash
+        JSON.parse(json)
+      when :hash_symbolized
+        JSON.parse(json, symbolize_names: true)
+      when :open_struct
+        JSON.parse(json, object_class: OpenStruct)
+      end
+    end
+    # rubocop:enable Naming/MethodParameterName
+
     # Convert various data types (Hash, Array, Struct) into a deep nested OpenStruct
+    #
     # or an array of deep nested OpenStruct
     def to_open_struct(data)
       case data
@@ -23,32 +40,56 @@ module KUtil
       end
     end
 
-    # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def to_hash(data)
       # No test yet
       if data.is_a?(Array)
         return data.map { |v| v.is_a?(OpenStruct) ? to_hash(v) : v }
       end
 
+      return to_hash(data.to_h) if !data.is_a?(Hash) && data.respond_to?(:to_h)
+
       data.each_pair.with_object({}) do |(key, value), hash|
         case value
-        when OpenStruct
+        when OpenStruct, Struct, Hash
           hash[key] = to_hash(value)
         when Array
           # No test yet
-          values = value.map { |v| v.is_a?(OpenStruct) ? to_hash(v) : v }
+          values = value.map do |v|
+            v.is_a?(OpenStruct) || v.is_a?(Struct) || v.is_a?(Hash) ? to_hash(v) : v
+          end
           hash[key] = values
         else
           hash[key] = value
         end
       end
     end
-    # rubocop:enable Metrics/AbcSize,  Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/AbcSize,  Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def clean_symbol(value)
       return value if value.nil?
 
       value.is_a?(Symbol) ? value.to_s : value
     end
+
+    # Add if needed
+    # # Is the value a basic (aka primitive) type
+    # def basic_type?(value)
+    #   value.is_a?(String) ||
+    #     value.is_a?(Symbol) ||
+    #     value.is_a?(FalseClass) ||
+    #     value.is_a?(TrueClass) ||
+    #     value.is_a?(Integer) ||
+    #     value.is_a?(Float)
+    # end
+
+    # Is the value a complex container type, but not a regular class.
+    def hash_convertible?(value)
+      value.is_a?(Array) ||
+        value.is_a?(Hash) ||
+        value.is_a?(Struct) ||
+        value.is_a?(OpenStruct) ||
+        value.respond_to?(:to_h)
+    end
   end
 end

data/lib/k_util/file_helper.rb

@@ -14,8 +14,17 @@ module KUtil
       end
     end
 
+    def home?(path)
+      path.start_with?('~/')
+    end
+
     def pathname_absolute?(pathname)
       Pathname.new(pathname).absolute?
     end
+    alias absolute? pathname_absolute?
+
+    def home_or_absolute?(path)
+      home?(path) || absolute?(path)
+    end
   end
 end

data/lib/k_util/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KUtil
-  VERSION = '0.0.8'
+  VERSION = '0.0.17'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_util
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.17
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies: []
 description: "    KUtil provides simple utility methods, such as file helpers, data
   object helpers and more.\n"
@@ -40,6 +40,7 @@ files:
 - k_util.gemspec
 - lib/k_util.rb
 - lib/k_util/console_helper.rb
+- lib/k_util/data/instance_variables_to_h.rb
 - lib/k_util/data_helper.rb
 - lib/k_util/file_helper.rb
 - lib/k_util/version.rb