k_util 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c24b82f602689a2bc8c2b88781c49bfb8f7a3fec655259a2fef5dc1a07c19da5
-  data.tar.gz: 1c919acdee3df2c1191fea1285cd7a9aac5167e2a9f87b4393c85e6f884bac48
+  metadata.gz: 88c89c4c9e613a825a162a59b8b4ea546d747f223d4d93ce93f26b3c734d49c2
+  data.tar.gz: 94b16c31d2149012c947e85a677f36b33f559cd914636269f8b5ce9bb9bc56bb
 SHA512:
-  metadata.gz: 12ffdc1399c84b23bfbf30a16e3f1c7a219efe2d73ead337f2c52efb607a73bf1dbba72915a07105e577ca6da1bdf696cf52916b892faca5289631a970422226
-  data.tar.gz: 97c12df77317c8ced436caa47fbf84915641d889ce1653540876b8d978ed6ad56403d628989a7ba77d74e8eadc20a206c7c473845166b63517c4e8cfd65c7912
+  metadata.gz: ca99065afbe8883d234c30a4cef1b56c69d2be2fd48860918158f0f1df8bc40cd77cc23b0a72a459ab765a1bb1c7b944f1ef6bc67b1c85a840a6df8c8a13cf24
+  data.tar.gz: fef92543798f378b9aedb86f1db84619b2a82fb0246f13ac1e99932def8e37a4bd391aa24a5411c3726aaea807b37cb22f33115fc47cc40c0ae404b67d8e4b2b

data/README.md

@@ -26,7 +26,7 @@ gem install k_util
 
 ### Main Story
 
-As a Developer, I need simple utility helpers, to solve cross cutting issues
+As a Developer, I need simple utility helpers, to solve cross cutting issues and simplify common access methods
 
 See all [stories](./STORIES.md)
 
@@ -36,12 +36,101 @@ See all [usage examples](./USAGE.md)
 
 ### Basic Example
 
-#### Basic example
+#### Console Helpers
 
-Description for a basic example to be featured in the main README.MD file
+Generate encoded strings that have meaning in the console
 
 ```ruby
-class SomeRuby; end
+puts KUtil.console.hyperlink('Google', 'https://google.com')
+
+# "Google"
+# (clickable hyperlink to the google website)
+
+puts KUtil.console.file_hyperlink('My File', '/somepath/my-file.txt')
+
+# "My File"
+# (clickable link to the a file in the file system)
+```
+
+#### Data Helpers
+
+Data object helpers such as any object to open struct and any object to hash
+
+```ruby
+ThunderBirds = Struct.new(:action)
+
+virgil =
+  OpenStruct.new(
+    name: 'Virgil Tracy', age: 73, thunder_bird: ThunderBirds.new(:are_grounded)
+  )
+penny =
+  OpenStruct.new(
+    name: 'Lady Penelope', age: 69, thunder_bird: ThunderBirds.new(:are_go)
+  )
+
+data = {
+  key1: 'David',
+  key2: 333,
+  key3: ThunderBirds.new(:are_go),
+  people: [virgil, penny]
+}
+
+data_open = KUtil.data.to_open_struct(data)
+data_hash = KUtil.data.to_hash(data_open)
+
+puts JSON.pretty_generate(data_hash)
+
+# {
+#   "key1": "David",
+#   "key2": 333,
+#   "key3": {
+#     "action": "are_go"
+#   },
+#   "people": [
+#     {
+#       "name": "Virgil Tracy",
+#       "age": 73,
+#       "thunder_bird": {
+#         "action": "are_grounded"
+#       }
+#     },
+#     {
+#       "name": "Lady Penelope",
+#       "age": 69,
+#       "thunder_bird": {
+#         "action": "are_go"
+#       }
+#     }
+#   ]
+# }
+```
+
+#### File Helpers
+
+```ruby
+puts KUtil.file.expand_path('file.rb')
+
+# /current/folder/file.rb
+
+puts KUtil.file.expand_path('/file.rb')
+
+# /file.rb
+
+puts KUtil.file.expand_path('~/file.rb')
+
+# /Users/current-user/file.rb
+
+puts KUtil.file.expand_path('file.rb', '/klue-less/xyz')
+
+# /klue-less/xyz/file.rb
+
+puts KUtil.file.pathname_absolute?('somepath/somefile.rb')
+
+# false
+
+puts KUtil.file.pathname_absolute?('/somepath/somefile.rb')
+
+# true
 ```
 
 ## Development
@@ -68,10 +157,8 @@ Aaa::Bbb::Program.execute()
 To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ```bash
-gem build
-gem push rspec-usecases-?.?.??.gem
-# or push the latest gem
-ls *.gem | sort -r | head -1 | xargs gem push
+rake publish
+rake clean
 ```
 
 ## Contributing

data/STORIES.md

@@ -2,32 +2,27 @@
 
 > KUtil provides simple utility methods
 
-As a Developer, I need simple utility helpers, to solve cross cutting issues
+As a Developer, I need simple utility helpers, to solve cross cutting issues and simplify common access methods
 
 ## Development radar
 
-### Stories next on list
+## Stories and tasks
 
-As a Developer, I can DO_SOMETHING, so that I QUALITY_OF_LIFE
+### Stories - completed
 
-- Subtask
+As a Developer, I need simple utility helpers, to solve cross cutting issues
 
-### Tasks next on list
+- Console helpers
+- Data helpers
+- File helpers
+
+### Tasks - completed
 
 Setup RubyGems and RubyDoc
 
 - Build and deploy gem to [rubygems.org](https://rubygems.org/gems/k_util)
 - Attach documentation to [rubydoc.info](https://rubydoc.info/github/to-do-/k_util/master)
 
-Setup GitHub Action (test and lint)
-
-- Setup Rspec action
-- Setup RuboCop action
-
-## Stories and tasks
-
-### Tasks - completed
-
 Setup project management, requirement and SCRUM documents
 
 - Setup readme file
@@ -35,6 +30,11 @@ Setup project management, requirement and SCRUM documents
 - Setup a project backlog
 - Setup an examples/usage document
 
+Setup GitHub Action (test and lint)
+
+- Setup Rspec action
+- Setup RuboCop action
+
 Setup new Ruby GEM
 
 - Build out a standard GEM structure

data/USAGE.md

@@ -2,18 +2,109 @@
 
 > KUtil provides simple utility methods
 
-As a Developer, I need simple utility helpers, to solve cross cutting issues
+As a Developer, I need simple utility helpers, to solve cross cutting issues and simplify common access methods
 
 ## Usage
 
 ### Sample Classes
 
-#### Simple example
+#### Console Helpers
 
-Description for a simple example that shows up in the USAGE.MD
+Generate encoded strings that have meaning in the console
 
 ```ruby
-class SomeRuby
-  def initialize; end
-end
+puts KUtil.console.hyperlink('Google', 'https://google.com')
+
+# "Google"
+# (clickable hyperlink to the google website)
+
+puts KUtil.console.file_hyperlink('My File', '/somepath/my-file.txt')
+
+# "My File"
+# (clickable link to the a file in the file system)
+```
+
+#### File Helpers
+
+```ruby
+# Expand Path
+
+puts KUtil.file.expand_path('file.rb')
+
+# /current/folder/file.rb
+
+puts KUtil.file.expand_path('/file.rb')
+
+# /file.rb
+
+puts KUtil.file.expand_path('~/file.rb')
+
+# /Users/current-user/file.rb
+
+puts KUtil.file.expand_path('file.rb', '/klue-less/xyz')
+
+# /klue-less/xyz/file.rb
+
+# Absolute path/file name
+
+puts KUtil.file.pathname_absolute?('somepath/somefile.rb')
+
+# false
+
+puts KUtil.file.pathname_absolute?('/somepath/somefile.rb')
+
+# true
+```
+
+#### Data Helpers
+
+Data object helpers such as any object to open struct and any object to hash
+
+```ruby
+ThunderBirds = Struct.new(:action)
+
+virgil =
+  OpenStruct.new(
+    name: 'Virgil Tracy', age: 73, thunder_bird: ThunderBirds.new(:are_grounded)
+  )
+penny =
+  OpenStruct.new(
+    name: 'Lady Penelope', age: 69, thunder_bird: ThunderBirds.new(:are_go)
+  )
+
+data = {
+  key1: 'David',
+  key2: 333,
+  key3: ThunderBirds.new(:are_go),
+  people: [virgil, penny]
+}
+
+data_open = KUtil.data.to_open_struct(data)
+data_hash = KUtil.data.to_hash(data_open)
+
+puts JSON.pretty_generate(data_hash)
+
+# {
+#   "key1": "David",
+#   "key2": 333,
+#   "key3": {
+#     "action": "are_go"
+#   },
+#   "people": [
+#     {
+#       "name": "Virgil Tracy",
+#       "age": 73,
+#       "thunder_bird": {
+#         "action": "are_grounded"
+#       }
+#     },
+#     {
+#       "name": "Lady Penelope",
+#       "age": 69,
+#       "thunder_bird": {
+#         "action": "are_go"
+#       }
+#     }
+#   ]
+# }
 ```

data/k_util.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary                = 'KUtil provides simple utility methods'
   spec.description            = <<-TEXT
-    KUtil provides simple utility methods
+    KUtil provides simple utility methods, such as file helpers, data object helpers and more.
   TEXT
   spec.homepage               = 'http://appydave.com/gems/k-util'
   spec.license                = 'MIT'

data/lib/k_util.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require 'k_util/version'
+require 'k_util/console_helper'
+require 'k_util/data_helper'
+require 'k_util/file_helper'
 
+# Provide various helper functions
 module KUtil
   # raise KUtil::Error, 'Sample message'
-  class Error < StandardError; end
-
-  # Your code goes here...
+  # class Error < StandardError; end
 end

data/lib/k_util/console_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Provide console helper functions
+module KUtil
+  class << self
+    attr_accessor :console
+  end
+
+  # Helper methods attached to the namespace for working with Console
+  class ConsoleHelper
+    # 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)
+      "\u001b]8;;file://#{file}\u0007#{text}\u001b]8;;\u0007"
+    end
+
+    def self.hyperlink(text, link)
+      "\u001b]8;;#{link}\u0007#{text}\u001b]8;;\u0007"
+    end
+  end
+end
+
+KUtil.console = KUtil::ConsoleHelper

data/lib/k_util/data_helper.rb

@@ -1,64 +1,60 @@
 # frozen_string_literal: true
 
-# module KDsl
-#   # File utilities
-#   module Util
-#     class << self
-#       attr_accessor :data
-#     end
-
-#     # Helper methods attached to the namespace for working with Data
-#     class DataHelper
-#       # Convert a hash into a deep OpenStruct or array an array
-#       # of objects into an array of OpenStruct
-#       def self.to_struct(data)
-#         if data.is_a?(Hash)
-#           return OpenStruct.new(data.map { |k,v| [k, to_struct(v)] }.to_h )
-
-#         elsif data.is_a?(Array)
-#           return data.map { |o| to_struct(o) }
-
-#         else
-#           # Some primitave type: String, True/False, Symbol or an ObjectStruct
-#           return data
-#         end
-#       end
-
-#       def self.struct_to_hash(data)
-#         # No test yet
-#         if data.is_a?(Array)
-#           return data.map { |v| v.is_a?(OpenStruct) ? struct_to_hash(v) : v }
-#         end
-
-#         data.each_pair.with_object({}) do |(key, value), hash|
-#           if value.is_a?(OpenStruct)
-#             hash[key] = struct_to_hash(value)
-#           elsif value.is_a?(Array)
-#             # No test yet
-#             values = value.map { |v| v.is_a?(OpenStruct) ? struct_to_hash(v) : v }
-#             hash[key] = values
-#           else
-#             hash[key] = value
-#           end
-#         end
-#       end
-
-#       # Generate hyper link encoded string for the console
-#       def self.console_file_hyperlink(text, file)
-#         "\u001b]8;;file://#{file}\u0007#{text}\u001b]8;;\u0007"
-#       end
-
-#       def self.console_hyperlink(text, link)
-#         "\u001b]8;;#{link}\u0007#{text}\u001b]8;;\u0007"
-#       end
-
-#       def self.clean_symbol(value)
-#         return value if value.nil?
-
-#         value.is_a?(Symbol) ? value.to_s : value
-#       end
-#     end
-#   end
-# end
-
-# KDsl::Util.data = KDsl::Util::DataHelper
+# 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)
+      case data
+      when Hash
+        OpenStruct.new(data.transform_values { |v| to_open_struct(v) })
+
+      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
+    end
+
+    # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity
+    def self.to_hash(data)
+      # No test yet
+      if data.is_a?(Array)
+        return data.map { |v| v.is_a?(OpenStruct) ? to_hash(v) : v }
+      end
+
+      data.each_pair.with_object({}) do |(key, value), hash|
+        case value
+        when OpenStruct
+          hash[key] = to_hash(value)
+        when Array
+          # No test yet
+          values = value.map { |v| v.is_a?(OpenStruct) ? to_hash(v) : v }
+          hash[key] = values
+        else
+          hash[key] = value
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize,  Metrics/CyclomaticComplexity
+
+    def self.clean_symbol(value)
+      return value if value.nil?
+
+      value.is_a?(Symbol) ? value.to_s : value
+    end
+  end
+end
+
+KUtil.data = KUtil::DataHelper

data/lib/k_util/file_helper.rb

@@ -1,29 +1,27 @@
 # frozen_string_literal: true
 
-# module KDsl
-#   # File utilities
-#   module Util
-#     class << self
-#       attr_accessor :file
-#     end
+# 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)
-#         if pathname_absolute?(filename)
-#           filename
-#         elsif filename.start_with?('~/')
-#           File.expand_path(filename)
-#         else
-#           File.expand_path(filename, base_path)
-#         end
-#       end
+  # Helper methods attached to the namespace for working with Files
+  class FileHelper
+    def self.expand_path(filename, base_path = nil)
+      if pathname_absolute?(filename)
+        filename
+      elsif filename.start_with?('~/')
+        File.expand_path(filename)
+      else
+        File.expand_path(filename, base_path)
+      end
+    end
 
-#       def self.pathname_absolute?(pathname)
-#         Pathname.new(pathname).absolute?
-#       end
-#     end
-#   end
-# end
+    def self.pathname_absolute?(pathname)
+      Pathname.new(pathname).absolute?
+    end
+  end
+end
 
-# KDsl::Util.file = KDsl::Util::FileHelper
+KUtil.file = KUtil::FileHelper

data/lib/k_util/version.rb

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

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: k_util
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies: []
-description: "    KUtil provides simple utility methods\n"
+description: "    KUtil provides simple utility methods, such as file helpers, data
+  object helpers and more.\n"
 email:
 - david@ideasmen.com.au
 executables: []
@@ -38,6 +39,7 @@ files:
 - hooks/update-version
 - k_util.gemspec
 - lib/k_util.rb
+- lib/k_util/console_helper.rb
 - lib/k_util/data_helper.rb
 - lib/k_util/file_helper.rb
 - lib/k_util/version.rb