cmdlet 0.0.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a228cff2db6bbe44396a3ace5b9821d35543741aaf3d747ed4c1558b81b5122a
-  data.tar.gz: 3700618c940d33e2e5521b8fbc3be24cac854fe484dce81a8d2f6331cbfebf73
+  metadata.gz: dc4888cd594af0dd224a836be55e28d9b6cdf153ac89e770807d412b14d11982
+  data.tar.gz: 00b2044a9a53f53afbe109a443aabd7cc38db54782fd1a1eebfbdc563db3de7c
 SHA512:
-  metadata.gz: eaf387c0b489d2ff93d6ff10b6bf158d98d2ac265206d70ff25780fd0bd39c7a16eb54ab843b8844a586c192d52c18e31124afc133ddea403c412d6e0ffb3c3c
-  data.tar.gz: b599968faa50ddfbc1d8b78a7989df7e7816fedb126260b888919c6e8cdb993352b8acaa5abc29e7d3bc782a72c73d862440f3720f9fc142dffecbcf7816861d
+  metadata.gz: f7470c8c5cc637bfc48aa1e5d9a63d73748831e71d323cdf3a09d2cb1b5b0e8e40970300072eafbbe00976334d7021e3e22ce66f5626b4983faa2d02f5e4ca70
+  data.tar.gz: e04137866c533b774510d0964be0a27f98110c23237da9d55b8c560d371f1a32d55e8e2af67799b0f58b3240434b1fb7b46f40915cb1baacf4adcfb5f037a496

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/data/cmdlets/inflection.json

@@ -0,0 +1,129 @@
+{
+  "category_key": "inflection",
+  "cmdlets": [
+    {
+      "name": "ordinal",
+      "description": "The suffix that should be added to a number to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th",
+      "result": "ordinal suffix that would be required for a number",
+      "category": "inflection",
+      "category_description": "Inflection handling routines, eg. pluralize, singular, ordinalize",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "value",
+          "description": "value - numeric value",
+          "splat": null,
+          "default": null,
+          "param_type": "String|Int"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return '' if value.nil?\n\n          value = value.to_i if value.is_a? String\n\n          value.ordinal\n"
+    },
+    {
+      "name": "ordinalize",
+      "description": "Turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.",
+      "result": "number value turned to 1st, 2nd, 3rd, 4th etc.",
+      "category": "inflection",
+      "category_description": "Inflection handling routines, eg. pluralize, singular, ordinalize",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "value",
+          "description": "value - numeric value",
+          "splat": null,
+          "default": null,
+          "param_type": "Int"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return '' if value.nil?\n\n          value = value.to_i if value.is_a? String\n\n          value.ordinalize\n"
+    },
+    {
+      "name": "pluralize",
+      "description": "Returns the plural form of the word in the string",
+      "result": "value in plural form",
+      "category": "inflection",
+      "category_description": "Inflection handling routines, eg. pluralize, singular, ordinalize",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "value",
+          "description": "value - value to pluralize",
+          "splat": null,
+          "default": null,
+          "param_type": "String"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return '' if value.nil?\n\n          value = value.to_s if value.is_a?(Symbol)\n\n          value.pluralize\n"
+    },
+    {
+      "name": "pluralize_by_number",
+      "description": "Returns the plural form of the word based on a count",
+      "result": "value and number are used to calculate plural/singular form",
+      "category": "inflection",
+      "category_description": "Inflection handling routines, eg. pluralize, singular, ordinalize",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "value",
+          "description": "value - value to pluralize",
+          "splat": null,
+          "default": null,
+          "param_type": "String"
+        },
+        {
+          "name": "count",
+          "description": "count used to determine pluralization",
+          "splat": null,
+          "default": null,
+          "param_type": "Int"
+        },
+        {
+          "name": "format",
+          "description": "(Optional) what format should output be. :word, :number_word",
+          "splat": null,
+          "default": null,
+          "param_type": "String"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return '' if value.nil?\n\n          count = count.to_i if count.is_a? String\n          format = :word if format.nil?\n\n          case format.to_sym\n          when :number_word, :number_and_word\n            \"#{count} #{value.pluralize(count)}\"\n          else # aka :word\n            value.pluralize(count)\n          end\n"
+    },
+    {
+      "name": "singularize",
+      "description": "The reverse of #pluralize, returns the singular form of a word in a string",
+      "result": "plural value turned to singular value",
+      "category": "inflection",
+      "category_description": "Inflection handling routines, eg. pluralize, singular, ordinalize",
+      "base_class_require": null,
+      "base_class": null,
+      "parameters": [
+        {
+          "name": "value",
+          "description": "value - value to singularized",
+          "splat": null,
+          "default": null,
+          "param_type": "String"
+        }
+      ],
+      "examples": [
+
+      ],
+      "ruby": "          return '' if value.nil?\n\n          value = value.to_s if value.is_a?(Symbol)\n\n          value.singularize\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