k_util 0.0.10 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1396ed8f2f544608b8847ea993a8273c133d0e27dc14f236f01f5363f101cc9
-  data.tar.gz: a4f2a01bf25867ffa3e66dc30c2b5fe73165c57a7af80f400c4a7b6865541d9a
+  metadata.gz: f49e3c0ac1db1cfaf2c310205d474b0e2c24c322fad152a172bed137f7f31d2f
+  data.tar.gz: 2029369204a126de193b01e0219e4b37dc3e0e1745b45cdde01cdc2a159a58cf
 SHA512:
-  metadata.gz: d1fb0d9537b8bffea7b55787e1f575bb03c1c0954f263c54a8eb1259a26e9f2efa04be13d2ebf2ea4fd5c9ffd7e1ab46f8e095dc836e3d35b18e3a4f8151d7f3
-  data.tar.gz: 74681084346b45a0e67b88fca8a68779108e7cff25ef5d2bfa18eb680b59a686ad9b876dd1f2fb023e0766fa9a04af7865da9c958a0754d7cfa34f6526340fef
+  metadata.gz: 3f0d2550416e6bd606a107b353cc7e2226f59cf22375fac03afac4f59306a2a40622af2a27d0ea0f5fe31577318cd6c39a671b26bd8503d5c8f1c31fe5622fe2
+  data.tar.gz: 63a7cef3672ed4b80a38547272cce5564b68ae795b38d1972ba4d9f2d82ccb16006c96ee58f1ccdf5626f56608e3c45a78609953add05ae32747ba11d7ae3fde

data/Gemfile

@@ -23,3 +23,7 @@ group :development, :test do
   gem 'rubocop-rake', require: false
   gem 'rubocop-rspec', require: false
 end
+
+group :test do
+  gem 'dry-struct', '~> 1'
+end

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'
 
@@ -21,4 +22,9 @@ module KUtil
   KUtil.file = KUtil::FileHelper.new
 end
 
-puts "KUtil::Version: #{KUtil::VERSION}" if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+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,47 +4,45 @@
 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
-      when Hash
-        OpenStruct.new(data.transform_values { |v| to_open_struct(v) })
+      return OpenStruct.new(data.transform_values { |v| to_open_struct(v) })  if data.is_a?(Hash)
+      return data.map { |o| to_open_struct(o) }                               if data.is_a?(Array)
+      return to_open_struct(data.to_h)                                        if hash_convertible?(data)
 
-      when Array
-        data.map { |o| to_open_struct(o) }
-
-      when Struct, OpenStruct
-        to_open_struct(data.to_h)
-
-      else
-        # Some primitave type: String, True/False or an ObjectStruct
-        data
-      end
+      # Some primitave type: String, True/False or an ObjectStruct
+      data
     end
 
     # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    # Convert data to hash and deal with mixed data types such as Struct and OpenStruct
     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 {} if data.nil?
+
+      return data.map { |value| hash_convertible?(value) ? to_hash(value) : value } if data.is_a?(Array)
 
       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, Struct, Hash
-          hash[key] = to_hash(value)
-        when Array
-          # No test yet
-          values = value.map do |v|
-            v.is_a?(OpenStruct) || v.is_a?(Struct) || v.is_a?(Hash) ? struct_to_hash(v) : v
-          end
-          hash[key] = values
-        else
-          hash[key] = value
-        end
+        hash[key] = hash_convertible?(value) ? to_hash(value) : value
       end
     end
     # rubocop:enable Metrics/AbcSize,  Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -54,5 +52,25 @@ module KUtil
 
       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.10'
+  VERSION = '0.0.19'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_util
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.19
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-07-16 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