cmdlet 0.0.5 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae44ce26b73b2f24d493ad916c12328b2814e5e670cf8828079e4e7e32cc9f4a
-  data.tar.gz: a9efa32929e26af9cdda7d207834d025039c049dd365ae79abacd1d7da33c5b0
+  metadata.gz: 4aaf22abcff261a22b71b4c4adeaf77dd8d629836936eabb1b20b2d8a61b3a28
+  data.tar.gz: 4d249fee0dd48b4774881e16bcc92b303f788e45b22c54c14a321a70468bcabf
 SHA512:
-  metadata.gz: c79358c0e425a5dbe5f5441c69afc489eb86034c52122c14a217a2fa0eeb3b19249c578bc002118852a635c1404db62f905f1245813f66edf91db39909d6a18b
-  data.tar.gz: 795edc645cc8747e9551ac5f8027b738c4d579ca6943b20ec82072d383172e3af7e39e1f6f4788205d80abeb8ba2749c23e1b553b56bef92c6fe04cece21d726
+  metadata.gz: ab39c705f59887093ecbf3a8ad2ec66f133bf14048f544b142b3de324fdb25006dfa19bb66efdf5e281d0167bac8b4bd2958769cff3ad8879515f833f24fa5d5
+  data.tar.gz: e78c0098b63350dfcc77bb7c6c50d902b8da963a9fc8531639a5c6835df4fdae3158b8518f2efd2f87a2fda9dfd9fb3a573f774159c04fad451dca50da09ac43

data/.builders/.templates/FUNCTIONS.MD

@@ -0,0 +1,19 @@
+# Funcky Functions
+
+> Funcky provides a set of functions (wrapped in the command pattern) that perform simple actions
+
+## List of categories
+
+| Name | Description |
+|-|-|
+{{#each categories}}
+| {{titleize name}} | {{description}} |
+{{/each}}
+
+## List of functions
+
+| Category | Name | Alias | Description |
+|-|-|-|-|
+{{#each functions}}
+| {{titleize category}} | `{{name}}` | {{#each alias}}{{surround . '`' '` '}}{{/each}} | {{description}} |
+{{/each}}

data/.builders/.templates/cmdlet.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # {{cmdlet.category_description}}
+  module {{camel cmdlet.category}}
+    # {{camel cmdlet.name}}: {{cmdlet.description}}
+    class {{camel cmdlet.name}} < Cmdlet::BaseCmdlet
+      {{#each cmdlet.usecases}}
+      # @example
+      #
+      #   puts {{camel ./function}}.new.call({{{nice_inputs}}})
+      #
+      #   {{expected_output}}
+      #
+      {{/each}}
+      #
+      {{#each cmdlet.parameters}}
+      # @param [{{./param_type}}] {{./name}} - {{./description}}
+      {{/each}}
+      # @return [String] {{cmdlet.result}}
+      def call({{#each cmdlet.parameters}}{{#if ./splat}}{{./splat}}{{/if}}{{./name}}{{#if ./default}} = {{{./default}}}{{/if}}{{#if @last}}{{^}}, {{/if}}{{/each}})
+{{{cmdlet.ruby}}}
+      end
+    end
+  end
+end

data/.builders/.templates/cmdlet_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# {{camel cmdlet.name}}: {{cmdlet.description}}
+RSpec.describe Cmdlet::{{camel cmdlet.category}}::{{camel cmdlet.name}} do
+  let(:instance) { described_class.new }
+  
+  describe 'initialize' do
+    subject { instance }
+  
+    it { is_expected.not_to be_nil }
+  end
+
+  describe '#call' do
+    subject { instance.call(value) }
+
+    let(:value) { nil }
+
+    context 'safely handle nil' do
+      it { is_expected.to eq('') }
+    end
+  end
+end

data/.builders/.templates/require_all_cmdlets.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+{{#each cmdlets}}
+require_relative '{{category}}/{{name}}'
+{{/each}}

data/.builders/_.rb

@@ -1 +1,11 @@
-require_relative './documents/_'
+# frozen_string_literal: true
+
+require_relative './director/category_dao'
+require_relative './director/cmdlet_dao'
+require_relative './director/dao'
+
+require_relative './director/category_builder'
+require_relative './director/category_director'
+require_relative './director/cmdlet_builder'
+require_relative './director/cmdlet_director'
+require_relative './director/cmdlet_child'

data/.builders/boot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Boot Sequence
 
 include KLog::Logging
@@ -49,10 +51,10 @@ KConfig.configure(CONFIG_KEY) do |config|
   config.template_folders.add(:template           , File.expand_path('.templates', Dir.pwd))
 
   config.target_folders.add(:app                  , base_folder)
-  config.target_folders.add(:lib                  , :app, 'lib/funcky')
-  config.target_folders.add(:spec                 , :app, 'spec/funcky')
+  config.target_folders.add(:lib                  , :app, 'lib/cmdlet')
+  config.target_folders.add(:spec                 , :app, 'spec/cmdlet')
   config.target_folders.add(:builder              , builder_folder)
-
+  config.target_folders.add(:builder_data         , :builder, 'data')
 end
 
 KConfig.configuration(CONFIG_KEY).debug
@@ -62,6 +64,7 @@ resource_manager = area.resource_manager
 resource_manager
   .fileset
   .glob('*.rb', exclude: ['boot.rb'])
+  .glob('documents/**/*.rb')
   .glob('generators/**/*.rb')
 resource_manager.add_resources
 

data/.builders/data/categories.json

@@ -0,0 +1,28 @@
+{
+  "categories": [
+    {
+      "name": "case",
+      "description": "Tokenize and apply case and/or separator"
+    },
+    {
+      "name": "comparison",
+      "description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc."
+    },
+    {
+      "name": "inflection",
+      "description": "Inflection handling routines, eg. pluralize, singular, ordinalize"
+    },
+    {
+      "name": "string",
+      "description": "String handling helpers"
+    },
+    {
+      "name": "array",
+      "description": "Array handling routines, eg. join, join_prefix, join_post"
+    },
+    {
+      "name": "transform",
+      "description": "Tokenize and apply case and/or separator"
+    }
+  ]
+}

data/.builders/data/cmdlets/array.json

@@ -0,0 +1,121 @@
+{
+  "category_key": "array",
+  "cmdlets": [
+    {
+      "name": "join",
+      "description": "join an array of values with separator as a string",
+      "result": "new String formed by joining the array elements with seperator",
+      "category": "array",
+      "category_description": "Array handling routines, eg. join, join_prefix, join_post",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "values",
+          "description": "array of values to join",
+          "splat": null,
+          "default": null,
+          "param_type": "String|Int"
+        },
+        {
+          "name": "separator",
+          "description": "separator between values, defaults to comma",
+          "splat": null,
+          "default": "','",
+          "param_type": "String"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return false if values.nil? || values.length == 0\n          values = values.reject(&:blank?)\n          return '' if values.length.zero?\n\n          values.join(separator)\n"
+    },
+    {
+      "name": "join_pre",
+      "description": "join an array of values with separator as a string and using the separator at the beginning of string",
+      "result": null,
+      "category": "array",
+      "category_description": "Array handling routines, eg. join, join_prefix, join_post",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "values",
+          "description": "array of values to join",
+          "splat": null,
+          "default": null,
+          "param_type": "String|Int"
+        },
+        {
+          "name": "separator",
+          "description": "separator between values, defaults to comma",
+          "splat": null,
+          "default": "','",
+          "param_type": "String"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return '' if values.nil? || !values.is_a?(::Array)\n          values = values.reject(&:blank?)\n          return '' if values.length.zero?\n\n          \"#{separator}#{values.join(separator)}\"\n"
+    },
+    {
+      "name": "join_pre",
+      "description": "join an array of values with separator as a string and using the separator at the beginning of string",
+      "result": null,
+      "category": "array",
+      "category_description": "Array handling routines, eg. join, join_prefix, join_post",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "values",
+          "description": "array of values to join",
+          "splat": null,
+          "default": null,
+          "param_type": "String|Int"
+        },
+        {
+          "name": "separator",
+          "description": "separator between values, defaults to comma",
+          "splat": null,
+          "default": "','",
+          "param_type": "String"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return '' if values.nil? || !values.is_a?(::Array)\n          values = values.reject(&:blank?)\n          return '' if values.length.zero?\n\n          \"#{separator}#{values.join(separator)}\"\n"
+    },
+    {
+      "name": "join_post",
+      "description": "join an array of values with separator as a string and using the separator at the end of string",
+      "result": null,
+      "category": "array",
+      "category_description": "Array handling routines, eg. join, join_prefix, join_post",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "values",
+          "description": "array of values to join",
+          "splat": null,
+          "default": null,
+          "param_type": "String|Int"
+        },
+        {
+          "name": "separator",
+          "description": "separator between values, defaults to comma",
+          "splat": null,
+          "default": "','",
+          "param_type": "String"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "            return '' if values.nil? || !values.is_a?(::Array)\n            values = values.reject(&:blank?)\n            return '' if values.length.zero?\n\n            \"#{values.join(separator)}#{separator}\"\n"
+    }
+  ]
+}

data/.builders/data/cmdlets/comparison.json

@@ -0,0 +1,245 @@
+{
+  "category_key": "comparison",
+  "cmdlets": [
+    {
+      "name": "and",
+      "description": "Return true if **all of** the given values are truthy.",
+      "result": "return true when every value is truthy",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "values",
+          "description": "list of values (via *splat) to be checked via AND condition",
+          "splat": "*",
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          values.all? { |value| value }\n"
+    },
+    {
+      "name": "default",
+      "description": "Return true if **all of** the given values are truthy.",
+      "result": "return true when every value is truthy",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "values",
+          "description": "one or more paramaters that may or may not contain nil",
+          "splat": "*",
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          default_value = values[-1]\n\n          find_value = values[0..-2].find { |value| !value.nil? }\n\n          find_value || default_value\n"
+    },
+    {
+      "name": "eq",
+      "description": "Return true if two values are equal",
+      "result": "return truthy value if left hand side equals right hand side",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "lhs",
+          "description": "lhs - left hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        },
+        {
+          "name": "rhs",
+          "description": "rhs - right hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          lhs = lhs.to_s if lhs.is_a?(Symbol)\n          rhs = rhs.to_s if rhs.is_a?(Symbol)\n\n          lhs == rhs\n"
+    },
+    {
+      "name": "gt",
+      "description": "Return true if left hand side GREATER THAN right hand side",
+      "result": "truthy value if left hand side GREATER THAN right hand side",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "lhs",
+          "description": "lhs - left hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        },
+        {
+          "name": "rhs",
+          "description": "rhs - right hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          lhs > rhs\n"
+    },
+    {
+      "name": "gte",
+      "description": "Return true if left hand side GREATER THAN or EQUAL TO right hand side",
+      "result": "truthy value if left hand side GREATER THAN or EQUAL TO  right hand side",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "lhs",
+          "description": "lhs - left hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        },
+        {
+          "name": "rhs",
+          "description": "rhs - right hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          lhs >= rhs\n"
+    },
+    {
+      "name": "lt",
+      "description": "Return true if left hand side LESS THAN right hand side",
+      "result": "truthy value if left hand side LESS THAN right hand side",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "lhs",
+          "description": "lhs - left hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        },
+        {
+          "name": "rhs",
+          "description": "rhs - right hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          lhs < rhs\n"
+    },
+    {
+      "name": "lte",
+      "description": "Return true if left hand side LESS THAN or EQUAL TO right hand side",
+      "result": "truthy value if left hand side LESS THAN or EQUAL TO  right hand side",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "lhs",
+          "description": "lhs - left hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        },
+        {
+          "name": "rhs",
+          "description": "rhs - right hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          lhs <= rhs\n"
+    },
+    {
+      "name": "ne",
+      "description": "Return true if left hand side is NOT equal to right hand side",
+      "result": "truthy value if left hand side is NOT equal to right hand side",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "lhs",
+          "description": "lhs - left hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        },
+        {
+          "name": "rhs",
+          "description": "rhs - right hand side value",
+          "splat": null,
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          lhs = lhs.to_s if lhs.is_a?(Symbol)\n          rhs = rhs.to_s if rhs.is_a?(Symbol)\n\n          lhs != rhs\n"
+    },
+    {
+      "name": "or",
+      "description": "Return true if any value is truthy.",
+      "result": "return true when first value is truthy",
+      "category": "comparison",
+      "category_description": "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "values",
+          "description": "list of values (via *splat) to be checked via AND condition",
+          "splat": "*",
+          "default": null,
+          "param_type": "Object"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          values.any? { |value| value }\n"
+    }
+  ]
+}

data/.builders/director/category_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class CategoryBuilder < KDirector::Builders::ActionsBuilder
+  def category(name, description)
+    value = {
+      name: name,
+      description: description
+    }
+
+    add(:categories, value: value)
+
+    self
+  end
+
+  def save_categories(**opts)
+    k_builder
+      .cd(:builder_data)
+      .add('categories.json', content: to_json, **opts)
+
+    self
+  end
+
+  def osave_categories(**opts)
+    save_categories(**{ open: true }.merge(opts))
+  end
+end

data/.builders/director/category_dao.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class CategoryDao
+  attr_reader :k_builder
+  attr_reader :load_time
+  attr_reader :data
+
+  def initialize(k_builder)
+    @k_builder = k_builder
+    @load_time = nil
+    @data = nil
+  end
+
+  def file_name
+    k_builder.target_folders.join(:builder_data, 'categories.json')
+  end
+
+  def reload?
+    @load_time.nil? || @load_time < File.mtime(file_name)
+  end
+
+  def find_category(name)
+    result = categories.find { |category| category[:name] == name.to_s }
+
+    raise "Category #{name} not found" if result.nil?
+
+    result
+  end
+
+  def categories
+    if reload?
+      @data = JSON.parse(File.read(file_name), symbolize_names: true)
+      @categories = data[:categories]
+      @load_time = File.mtime(file_name)
+    end
+    @categories
+  end
+end

data/.builders/director/category_director.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class CategoryDirector < KDirector::Directors::BaseDirector
+  defaults(builder_type: CategoryBuilder, on_exist: :write, on_action: :execute)
+
+  def category(name, description)
+    builder.category(name, description)
+
+    self
+  end
+
+  def generate
+    generate_require_all_cmdlets
+
+    self
+  end
+
+  def save_categories(**opts)
+    cd(:builder_data)
+    add('categories.json', content: builder.to_json, **opts)
+
+    self
+  end
+
+  def osave_categories(**opts)
+    save_categories(**{ open: true }.merge(opts))
+  end
+
+  private
+
+  def generate_require_all_cmdlets
+    cd(:lib)
+    add('_.rb',
+      template_file: 'require_all_cmdlets.rb',
+      cmdlets: data_access.cmdlet.all_cmdlets)
+
+  end
+  
+end