k_util 0.0.7 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c89c4c9e613a825a162a59b8b4ea546d747f223d4d93ce93f26b3c734d49c2
-  data.tar.gz: 94b16c31d2149012c947e85a677f36b33f559cd914636269f8b5ce9bb9bc56bb
+  metadata.gz: b521dc46323b33d082574de08feba5ef83f167b0feea433d902217e62c934557
+  data.tar.gz: 6f4f9aca566de81776cdbe6496772034a13f14a973297f738a9a6ecf6856f3eb
 SHA512:
-  metadata.gz: ca99065afbe8883d234c30a4cef1b56c69d2be2fd48860918158f0f1df8bc40cd77cc23b0a72a459ab765a1bb1c7b944f1ef6bc67b1c85a840a6df8c8a13cf24
-  data.tar.gz: fef92543798f378b9aedb86f1db84619b2a82fb0246f13ac1e99932def8e37a4bd391aa24a5411c3726aaea807b37cb22f33115fc47cc40c0ae404b67d8e4b2b
+  metadata.gz: cf2a72c8bcb86ca6ac4d1e3b286150bf175c5e95018eef603d32fecd010b490e3f266944642cbe6ad9f66dbedcccf30d8c7b4824ff6feb661ad35f257969965e
+  data.tar.gz: da68fc44fe300cb6130a4e25a31a57431f47d01152683b76f35d5b16a04d34e121d9d66bcc8971d5e1f70e6fd99d588c20b19f815dc1aa9130b951189a88c8a7

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'
 
@@ -9,4 +10,21 @@ require 'k_util/file_helper'
 module KUtil
   # raise KUtil::Error, 'Sample message'
   # class Error < StandardError; end
+
+  class << self
+    attr_accessor :console
+    attr_accessor :data
+    attr_accessor :file
+  end
+
+  KUtil.console = KUtil::ConsoleHelper.new
+  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/console_helper.rb

@@ -11,14 +11,12 @@ module KUtil
     # Convert a hash into a deep OpenStruct or array an array
     # of objects into an array of OpenStruct
     # Generate hyper link encoded string for the console
-    def self.file_hyperlink(text, file)
+    def file_hyperlink(text, file)
       "\u001b]8;;file://#{file}\u0007#{text}\u001b]8;;\u0007"
     end
 
-    def self.hyperlink(text, link)
+    def hyperlink(text, link)
       "\u001b]8;;#{link}\u0007#{text}\u001b]8;;\u0007"
     end
   end
 end
-
-KUtil.console = KUtil::ConsoleHelper

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

@@ -2,15 +2,11 @@
 
 # Provide data object helper functions
 module KUtil
-  class << self
-    attr_accessor :data
-  end
-
   # Helper methods attached to the namespace for working with Data
   class DataHelper
     # Convert various data types (Hash, Array, Struct) into a deep nested OpenStruct
     # or an array of deep nested OpenStruct
-    def self.to_open_struct(data)
+    def to_open_struct(data)
       case data
       when Hash
         OpenStruct.new(data.transform_values { |v| to_open_struct(v) })
@@ -27,34 +23,56 @@ module KUtil
       end
     end
 
-    # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity
-    def self.to_hash(data)
+    # 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 self.clean_symbol(value)
+    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
-
-KUtil.data = KUtil::DataHelper

data/lib/k_util/file_helper.rb

@@ -2,13 +2,9 @@
 
 # Provide file helper functions
 module KUtil
-  class << self
-    attr_accessor :file
-  end
-
   # Helper methods attached to the namespace for working with Files
   class FileHelper
-    def self.expand_path(filename, base_path = nil)
+    def expand_path(filename, base_path = nil)
       if pathname_absolute?(filename)
         filename
       elsif filename.start_with?('~/')
@@ -18,10 +14,17 @@ module KUtil
       end
     end
 
-    def self.pathname_absolute?(pathname)
+    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
-
-KUtil.file = KUtil::FileHelper

data/lib/k_util/version.rb

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

metadata

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