k_util 0.0.23 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc4532082b846b6644fab95de5f16943585311d07b7dab25247418e62960e93
-  data.tar.gz: 59025e0e712857e698aa30242be084d0a85ab3020cea20a6f7fd49c153a2537e
+  metadata.gz: c613a872941e5e87f4e7de5f4d8572ab1347da1e107c34b26438c7691e1aca43
+  data.tar.gz: f1c0a56ffb60871e82b0fe4dbe9d7ae7c1d370c6f9b7e8b0dcc463d70bf4eec2
 SHA512:
-  metadata.gz: 90e2cdc37229d364f87dcb196a6366d1cf86e62e30634b1fff4fcc6ee5dac941396a145a052337c2b1d56a85180640c69b84c18f80c932ec667047163106cc3a
-  data.tar.gz: e839e60ad5abb4b00e0e46f66172255fb20976e4de99b44d80fc7d64d53fa798b5c73d82de9d6d6c9228173c19d43408c2ac81dfda91d6f471d597c67c9d30b6
+  metadata.gz: 01d75ddf3b0b7d500d3fbd3e0c3f9c6ee7421b058560cdfaff2144e2f07ab43f9f9e01dc92f68aff6001a555b6fd70f3166b26230452c5d1856faaef52fd8b98
+  data.tar.gz: abeb63578932c2e8330c672c3ddd62b5d2ca0661d2e038d9b9f20ec49fbea478b49b2d592750adcc7e4b882fa19d2b377fb2d7ec320b749e6860ac9bd313a1b2

data/lib/k_util/data/instance_variables_to_h.rb

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

data/lib/k_util/data_helper.rb

@@ -6,6 +6,7 @@ module KUtil
   class DataHelper
     # Convert JSON string into to_open_struct but designed to work with a JSON string
     #
+    # KUtil.data.parse_json(json, as: :symbolize_keys)
     # https://docs.ruby-lang.org/en/master/JSON.html
     # rubocop:disable Naming/MethodParameterName
     def parse_json(json, as: :hash)
@@ -14,7 +15,7 @@ module KUtil
       case as
       when :hash
         JSON.parse(json)
-      when :hash_symbolized
+      when :hash_symbolized, :symbolize_names, :symbolize_keys
         JSON.parse(json, symbolize_names: true)
       when :open_struct
         JSON.parse(json, object_class: OpenStruct)
@@ -25,6 +26,7 @@ module KUtil
 
     # Convert various data types (Hash, Array, Struct) into a deep nested OpenStruct
     #
+    # KUtil.data.to_open_struct(data)
     # or an array of deep nested OpenStruct
     def to_open_struct(data)
       return OpenStruct.new(data.transform_values { |v| to_open_struct(v) })  if data.is_a?(Hash)
@@ -37,6 +39,7 @@ module KUtil
 
     # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     # Convert data to hash and deal with mixed data types such as Struct and OpenStruct
+    # KUtil.data.to_hash(data)
     def to_hash(data)
       # This nil check is only for the root object
       return {} if data.nil?
@@ -57,10 +60,24 @@ module KUtil
       value.is_a?(Symbol) ? value.to_s : value
     end
 
-    def symbolize_names(hash)
-      hash.transform_keys(&:to_sym)
+    def deep_symbolize_keys(input)
+      return input if input.nil?
+
+      return input unless input.is_a?(Hash)
+
+      input.each_with_object({}) do |key_value, new_hash|
+        key, value = key_value
+        value = deep_symbolize_keys(value)                  if value.is_a?(Hash)
+        value = value.map { |v| deep_symbolize_keys(v) }    if value.is_a?(Array)
+        new_hash[key.to_sym] = value
+      end
     end
-    alias symbolize_keys symbolize_names
+
+    # def deep_symbolize_keys(hash)
+    #   return hash if hash.nil?
+
+    #   hash.transform_keys(&:to_sym)
+    # end
 
     # Is the value a basic (aka primitive) type
     def basic_type?(value)

data/lib/k_util/file_helper.rb

@@ -26,5 +26,12 @@ module KUtil
     def home_or_absolute?(path)
       home?(path) || absolute?(path)
     end
+
+    def parse_uri(uri)
+      return uri if uri.is_a?(URI)
+      return URI.parse(uri) if uri =~ URI::ABS_URI # https://stackoverflow.com/questions/1805761/how-to-check-if-a-url-is-valid
+
+      URI.join('file:///', uri)
+    end
   end
 end

data/lib/k_util/open3_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Provide file helper functions
+module KUtil
+  # Helper methods attached to the namespace to run Open3 commands
+  class Open3Helper
+    def capture2(cmd, **opts)
+      output, status = Open3.capture2(cmd, **opts)
+
+      unless status.success?
+        puts "failed to run command: #{cmd}"
+        # bxxxinding.pry
+      end
+
+      raise Open3Error unless status.success?
+
+      output
+    end
+  end
+end

data/lib/k_util/version.rb

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

data/lib/k_util.rb

@@ -1,25 +1,30 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 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'
+require 'k_util/open3_helper'
 
 # Provide various helper functions
 module KUtil
-  # raise KUtil::Error, 'Sample message'
-  # class Error < StandardError; end
+  # raise KUtil::Open3Error, 'Sample message'
+  Open3Error = Class.new(StandardError)
 
   class << self
     attr_accessor :console
     attr_accessor :data
     attr_accessor :file
+    attr_accessor :open3
   end
 
   KUtil.console = KUtil::ConsoleHelper.new
   KUtil.data = KUtil::DataHelper.new
   KUtil.file = KUtil::FileHelper.new
+  KUtil.open3 = KUtil::Open3Helper.new
 end
 
 if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_util
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.27
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies: []
 description: "    KUtil provides simple utility methods, such as file helpers, data
   object helpers and more.\n"
@@ -43,6 +43,7 @@ files:
 - lib/k_util/data/instance_variables_to_h.rb
 - lib/k_util/data_helper.rb
 - lib/k_util/file_helper.rb
+- lib/k_util/open3_helper.rb
 - lib/k_util/version.rb
 homepage: http://appydave.com/gems/k-util
 licenses:
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: KUtil provides simple utility methods