k_util 0.0.12 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3860a3f695361bef8207528e54cfd32dcd870f1947e5ad8548619ff4fb4225ba
-  data.tar.gz: 37abdfd64ba5001844737429e4786d02c606816803571c44082f133bf44982ca
+  metadata.gz: 615b0deb70283841ac540e1af6a4153dcf7fdb6b1eb85f4710119edd7c662507
+  data.tar.gz: 0cf049101ab9e7ea4e76943c2e19e69a550d4dca78f31b2a70e6e51f6ca13a5c
 SHA512:
-  metadata.gz: 8e293e90a1a83f31ceabdc7ae1c1324859cfa8e20bd186c05a6c78a3b603f2b48b99d74d67408f06d930d751f3eadb6e8cfbb8e7cf1c133faa458523ffb73484
-  data.tar.gz: 2d7f7251ed0c427b47addbd9ef062477abb8a4072eddb3829157e24eb56ad65fe86705046cb28481927a7ae5fcdb387807d474bddbcc3dfabb2b7f95f2972360
+  metadata.gz: 5d85601784381afbea1385b067cd646ddb72675a463638b2b4b611fff3657d1924ca4dba2f0ede9fa1bd17090481c54814a31d24f92190a47dfa735512677615
+  data.tar.gz: 0a15d56a6099b870971367b360fe6a2780c30fcedc1b9b759c6e2cccfe698a4386d2f85af143057c3f4f7df7f3b918ca4b73ba46241f2b6503eeb58756b3e0d8

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'
 
@@ -25,5 +26,5 @@ 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(40)} : #{version.ljust(9)} : #{file_path}"
+  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,46 @@
 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) })
-
-      when Array
-        data.map { |o| to_open_struct(o) }
+      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 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
+      # This nil check is only for the root object
+      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 +53,28 @@ module KUtil
 
       value.is_a?(Symbol) ? value.to_s : value
     end
+
+    # 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)
+      # Nil is a special case, it responds to :to_h but generally
+      # you only want to convert nil to {} in specific scenarios
+      return false if value.nil?
+
+      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,12 +14,17 @@ module KUtil
       end
     end
 
-    def has_home?(path)
+    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.12'
+  VERSION = '0.0.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_util
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.22
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-03 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