cmdlet 0.0.6 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+## [0.1.2](https://github.com/klueless-io/cmdlet/compare/v0.1.1...v0.1.2) (2022-07-10)
+
+
+### Bug Fixes
+
+* add comparison :or ([633633d](https://github.com/klueless-io/cmdlet/commit/633633d2a22b98a0de1acf6257feb3603a2f2c39))
+* add comparison :or, :and, :lt, :lte, :gt, :gte, :ne, :eq, :default ([000cb1a](https://github.com/klueless-io/cmdlet/commit/000cb1a3cbd643abcb5dac6828972ec94c9f53a8))
+
+## [0.1.1](https://github.com/klueless-io/cmdlet/compare/v0.1.0...v0.1.1) (2022-07-10)
+
+
+### Bug Fixes
+
+* add specs ([80f384f](https://github.com/klueless-io/cmdlet/commit/80f384f9f7cd1c1ea67396bb12d3119c433ea139))
+
+# [0.1.0](https://github.com/klueless-io/cmdlet/compare/v0.0.7...v0.1.0) (2022-07-09)
+
+
+### Features
+
+* generate commandlets ([a61948e](https://github.com/klueless-io/cmdlet/commit/a61948e285d488d3aab68a9ef3bd0c136b87170f))
+
+## [0.0.7](https://github.com/klueless-io/cmdlet/compare/v0.0.6...v0.0.7) (2022-07-09)
+
+
+### Bug Fixes
+
+* add category director ([3b72b72](https://github.com/klueless-io/cmdlet/commit/3b72b72d9f739c9a3711f14a640bb6d527e17140))
+* add category director ([cea0f1a](https://github.com/klueless-io/cmdlet/commit/cea0f1ae37bfbb67d634f18cf1d315a80c1f6082))
+
+## [0.0.6](https://github.com/klueless-io/cmdlet/compare/v0.0.5...v0.0.6) (2022-07-08)
+
+
+### Bug Fixes
+
+* add tests for configuration ([59a764f](https://github.com/klueless-io/cmdlet/commit/59a764f99f84dbe1c5b1022e8fdc2386fcced92a))
+
 ## [0.0.5](https://github.com/klueless-io/cmdlet/compare/v0.0.4...v0.0.5) (2022-07-08)
 
 

data/Guardfile

@@ -19,7 +19,7 @@ group :green_pass_then_cop, halt_on_fail: true do
     # Ruby files
     ruby = dsl.ruby
     dsl.watch_spec_files_for(ruby.lib_files)
-    watch(%r{^lib//(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+    watch(%r{^lib//(.+)\.rb$}) { |m| "spec/**/#{m[1]}_spec.rb" }
     watch(%r{^lib//commands/(.+)\.rb$}) { |m| "spec/unit/commands/#{m[1]}_spec.rb" }
   end
 

data/lib/cmdlet/_.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'array/join'
+require_relative 'array/join_post'
+require_relative 'array/join_pre'
+require_relative 'comparison/and'
+require_relative 'comparison/default'
+require_relative 'comparison/eq'
+require_relative 'comparison/gt'
+require_relative 'comparison/gte'
+require_relative 'comparison/lt'
+require_relative 'comparison/lte'
+require_relative 'comparison/ne'
+require_relative 'comparison/or'
+require_relative 'inflection/ordinal'
+require_relative 'inflection/ordinalize'
+require_relative 'inflection/pluralize'
+require_relative 'inflection/pluralize_by_number'
+require_relative 'inflection/singularize'

data/lib/cmdlet/all_commands.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'cmdlet/array/join'

data/lib/cmdlet/array/join.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Array handling routines, eg. join, join_prefix, join_post
+  module Array
+    # Join: join an array of values with separator as a string
+    class Join < Cmdlet::BaseCmdlet
+      #
+      # @param [String|Int] values - array of values to join
+      # @param [String] separator - separator between values, defaults to comma
+      # @return [String] new String formed by joining the array elements with seperator
+      def call(values, separator = ',')
+        return false if values.nil? || values.length.zero?
+
+        values = values.reject(&:blank?)
+        return '' if values.length.zero?
+
+        values.join(separator)
+      end
+    end
+  end
+end

data/lib/cmdlet/array/join_post.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Array handling routines, eg. join, join_prefix, join_post
+  module Array
+    # JoinPost: join an array of values with separator as a string and using the separator at the end of string
+    class JoinPost < Cmdlet::BaseCmdlet
+      #
+      # @param [String|Int] values - array of values to join
+      # @param [String] separator - separator between values, defaults to comma
+      # @return [String]
+      def call(values, separator = ',')
+        return '' if values.nil? || !values.is_a?(::Array)
+
+        values = values.reject(&:blank?)
+        return '' if values.length.zero?
+
+        "#{values.join(separator)}#{separator}"
+      end
+    end
+  end
+end

data/lib/cmdlet/array/join_pre.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Array handling routines, eg. join, join_prefix, join_post
+  module Array
+    # JoinPre: join an array of values with separator as a string and using the separator at the beginning of string
+    class JoinPre < Cmdlet::BaseCmdlet
+      #
+      # @param [String|Int] values - array of values to join
+      # @param [String] separator - separator between values, defaults to comma
+      # @return [String]
+      def call(values, separator = ',')
+        return '' if values.nil? || !values.is_a?(::Array)
+
+        values = values.reject(&:blank?)
+        return '' if values.length.zero?
+
+        "#{separator}#{values.join(separator)}"
+      end
+    end
+  end
+end

data/lib/cmdlet/base_cmdlet.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # base cmdlet provides an interface for cmdlets
+  class BaseCmdlet
+    def call(value)
+      value
+    end
+
+    # String tokenizer will clean up a string so that
+    # all sorts of case formatted strings can be
+    # represented in a consistent fashion
+    def tokenizer
+      @_tokenizer ||= Funcky.configuration.tokenizer
+    end
+  end
+end

data/lib/cmdlet/comparison/and.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # And: Return true if **all of** the given values are truthy.
+    class And < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] values - list of values (via *splat) to be checked via AND condition
+      # @return [String] return true when every value is truthy
+      def call(*values)
+        values.all? { |value| value }
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/default.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Default: Return true if **all of** the given values are truthy.
+    class Default < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] values - one or more paramaters that may or may not contain nil
+      # @return [String] return true when every value is truthy
+      def call(*values)
+        default_value = values[-1]
+
+        find_value = values[0..-2].find { |value| !value.nil? }
+
+        find_value || default_value
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/eq.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Eq: Return true if two values are equal
+    class Eq < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] lhs - lhs - left hand side value
+      # @param [Object] rhs - rhs - right hand side value
+      # @return [String] return truthy value if left hand side equals right hand side
+      def call(lhs, rhs)
+        lhs = lhs.to_s if lhs.is_a?(Symbol)
+        rhs = rhs.to_s if rhs.is_a?(Symbol)
+
+        lhs == rhs
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/gt.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Gt: Return true if left hand side GREATER THAN right hand side
+    class Gt < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] lhs - lhs - left hand side value
+      # @param [Object] rhs - rhs - right hand side value
+      # @return [String] truthy value if left hand side GREATER THAN right hand side
+      def call(lhs, rhs)
+        lhs > rhs
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/gte.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Gte: Return true if left hand side GREATER THAN or EQUAL TO right hand side
+    class Gte < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] lhs - lhs - left hand side value
+      # @param [Object] rhs - rhs - right hand side value
+      # @return [String] truthy value if left hand side GREATER THAN or EQUAL TO  right hand side
+      def call(lhs, rhs)
+        lhs >= rhs
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/lt.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Lt: Return true if left hand side LESS THAN right hand side
+    class Lt < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] lhs - lhs - left hand side value
+      # @param [Object] rhs - rhs - right hand side value
+      # @return [String] truthy value if left hand side LESS THAN right hand side
+      def call(lhs, rhs)
+        lhs < rhs
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/lte.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Lte: Return true if left hand side LESS THAN or EQUAL TO right hand side
+    class Lte < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] lhs - lhs - left hand side value
+      # @param [Object] rhs - rhs - right hand side value
+      # @return [String] truthy value if left hand side LESS THAN or EQUAL TO  right hand side
+      def call(lhs, rhs)
+        lhs <= rhs
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/ne.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Ne: Return true if left hand side is NOT equal to right hand side
+    class Ne < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] lhs - lhs - left hand side value
+      # @param [Object] rhs - rhs - right hand side value
+      # @return [String] truthy value if left hand side is NOT equal to right hand side
+      def call(lhs, rhs)
+        lhs = lhs.to_s if lhs.is_a?(Symbol)
+        rhs = rhs.to_s if rhs.is_a?(Symbol)
+
+        lhs != rhs
+      end
+    end
+  end
+end

data/lib/cmdlet/comparison/or.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.
+  module Comparison
+    # Or: Return true if any value is truthy.
+    class Or < Cmdlet::BaseCmdlet
+      #
+      # @param [Object] values - list of values (via *splat) to be checked via AND condition
+      # @return [String] return true when first value is truthy
+      def call(*values)
+        values.any? { |value| value }
+      end
+    end
+  end
+end

data/lib/cmdlet/inflection/ordinal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Inflection handling routines, eg. pluralize, singular, ordinalize
+  module Inflection
+    # Ordinal: The suffix that should be added to a number to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th
+    class Ordinal < Cmdlet::BaseCmdlet
+      #
+      # @param [String|Int] value - value - numeric value
+      # @return [String] ordinal suffix that would be required for a number
+      def call(value)
+        return '' if value.nil?
+
+        value = value.to_i if value.is_a? String
+
+        value.ordinal
+      end
+    end
+  end
+end

data/lib/cmdlet/inflection/ordinalize.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Inflection handling routines, eg. pluralize, singular, ordinalize
+  module Inflection
+    # Ordinalize: Turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
+    class Ordinalize < Cmdlet::BaseCmdlet
+      #
+      # @param [Int] value - value - numeric value
+      # @return [String] number value turned to 1st, 2nd, 3rd, 4th etc.
+      def call(value)
+        return '' if value.nil?
+
+        value = value.to_i if value.is_a? String
+
+        value.ordinalize
+      end
+    end
+  end
+end

data/lib/cmdlet/inflection/pluralize.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Inflection handling routines, eg. pluralize, singular, ordinalize
+  module Inflection
+    # Pluralize: Returns the plural form of the word in the string
+    class Pluralize < Cmdlet::BaseCmdlet
+      #
+      # @param [String] value - value - value to pluralize
+      # @return [String] value in plural form
+      def call(value)
+        return '' if value.nil?
+
+        value = value.to_s if value.is_a?(Symbol)
+
+        value.pluralize
+      end
+    end
+  end
+end

data/lib/cmdlet/inflection/pluralize_by_number.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Inflection handling routines, eg. pluralize, singular, ordinalize
+  module Inflection
+    # PluralizeByNumber: Returns the plural form of the word based on a count
+    class PluralizeByNumber < Cmdlet::BaseCmdlet
+      #
+      # @param [String] value - value - value to pluralize
+      # @param [Int] count - count used to determine pluralization
+      # @param [String] format - (Optional) what format should output be. :word, :number_word
+      # @return [String] value and number are used to calculate plural/singular form
+      def call(value, count, format)
+        return '' if value.nil?
+
+        count = count.to_i if count.is_a? String
+        format = :word if format.nil?
+
+        case format.to_sym
+        when :number_word, :number_and_word
+          "#{count} #{value.pluralize(count)}"
+        else # aka :word
+          value.pluralize(count)
+        end
+      end
+    end
+  end
+end

data/lib/cmdlet/inflection/singularize.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cmdlet
+  # Inflection handling routines, eg. pluralize, singular, ordinalize
+  module Inflection
+    # Singularize: The reverse of #pluralize, returns the singular form of a word in a string
+    class Singularize < Cmdlet::BaseCmdlet
+      #
+      # @param [String] value - value - value to singularized
+      # @return [String] plural value turned to singular value
+      def call(value)
+        return '' if value.nil?
+
+        value = value.to_s if value.is_a?(Symbol)
+
+        value.singularize
+      end
+    end
+  end
+end

data/lib/cmdlet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cmdlet
-  VERSION = '0.0.6'
+  VERSION = '0.2.0'
 end

data/lib/cmdlet.rb

@@ -2,10 +2,15 @@
 
 # require 'k_log'
 require 'k_config'
+require 'active_support/core_ext/integer/inflections'
+
 require_relative 'cmdlet/version'
 require_relative 'cmdlet/configuration'
+require_relative 'cmdlet/base_cmdlet'
 require_relative 'cmdlet/string_tokenizer'
 
+require_relative 'cmdlet/_'
+
 module Cmdlet
   # raise Cmdlet::Error, 'Sample message'
   Error = Class.new(StandardError)

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "cmdlet",
-  "version": "0.0.6",
+  "version": "0.2.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "cmdlet",
-      "version": "0.0.6",
+      "version": "0.2.0",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.1",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cmdlet",
-  "version": "0.0.6",
+  "version": "0.2.0",
   "description": "Cmdlet provides a set of functions (wrapped in the command pattern) that perform simple actions",
   "scripts": {
     "release": "semantic-release"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmdlet
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.2.0
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -46,15 +46,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".builders/.templates/FUNCTIONS.MD"
+- ".builders/.templates/cmdlet.rb"
+- ".builders/.templates/cmdlet_spec.rb"
+- ".builders/.templates/require_all_cmdlets.rb"
 - ".builders/_.rb"
 - ".builders/boot.rb"
-- ".builders/documents/_.rb"
-- ".builders/documents/categories.rb"
+- ".builders/data/categories.json"
+- ".builders/data/cmdlets/array.json"
+- ".builders/data/cmdlets/comparison.json"
+- ".builders/data/cmdlets/inflection.json"
+- ".builders/director/category_builder.rb"
+- ".builders/director/category_dao.rb"
+- ".builders/director/category_director.rb"
+- ".builders/director/cmdlet_builder.rb"
+- ".builders/director/cmdlet_child.rb"
+- ".builders/director/cmdlet_dao.rb"
+- ".builders/director/cmdlet_director.rb"
+- ".builders/director/dao.rb"
 - ".builders/documents/commands.rb"
-- ".builders/documents/functions.rb"
 - ".builders/documents/use_cases.rb"
 - ".builders/documents/x_functions.rb"
 - ".builders/generators/01-bootstrap.rb"
+- ".builders/generators/20-categories.rb"
+- ".builders/generators/30-commands-bak.rb"
+- ".builders/generators/cmdlets/array.rb"
+- ".builders/generators/cmdlets/comparison.rb"
+- ".builders/generators/cmdlets/inflection.rb"
 - ".releaserc.json"
 - ".rspec"
 - ".rubocop.yml"
@@ -68,7 +86,27 @@ files:
 - bin/console
 - bin/setup
 - lib/cmdlet.rb
+- lib/cmdlet/_.rb
+- lib/cmdlet/all_commands.rb
+- lib/cmdlet/array/join.rb
+- lib/cmdlet/array/join_post.rb
+- lib/cmdlet/array/join_pre.rb
+- lib/cmdlet/base_cmdlet.rb
+- lib/cmdlet/comparison/and.rb
+- lib/cmdlet/comparison/default.rb
+- lib/cmdlet/comparison/eq.rb
+- lib/cmdlet/comparison/gt.rb
+- lib/cmdlet/comparison/gte.rb
+- lib/cmdlet/comparison/lt.rb
+- lib/cmdlet/comparison/lte.rb
+- lib/cmdlet/comparison/ne.rb
+- lib/cmdlet/comparison/or.rb
 - lib/cmdlet/configuration.rb
+- lib/cmdlet/inflection/ordinal.rb
+- lib/cmdlet/inflection/ordinalize.rb
+- lib/cmdlet/inflection/pluralize.rb
+- lib/cmdlet/inflection/pluralize_by_number.rb
+- lib/cmdlet/inflection/singularize.rb
 - lib/cmdlet/string_tokenizer.rb
 - lib/cmdlet/version.rb
 - package-lock.json
@@ -78,6 +116,9 @@ homepage: http://appydave.com/gems/cmdlet
 licenses:
 - MIT
 metadata:
+  homepage_uri: http://appydave.com/gems/cmdlet
+  source_code_uri: https://github.com/klueless-io/cmdlet
+  changelog_uri: https://github.com/klueless-io/cmdlet/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []

data/.builders/documents/_.rb

@@ -1,4 +0,0 @@
-require_relative './categories'
-require_relative './functions'
-require_relative './use_cases'
-require_relative './commands'

data/.builders/documents/categories.rb

@@ -1,24 +0,0 @@
-def categories
-  return @categories unless @categories.nil?
-
-  
-  result = KDoc.model :document do
-    table :rows do
-      fields :name, :description
-
-      row :case               , "Tokenize and apply case and/or separator"
-      row :comparison         , "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc."
-      row :inflection         , "Inflection handling routines, eg. pluralize, singular, ordinalize"
-      row :string             , "String handling helpers"
-
-      row :a_array            , "Array handling routines, eg. join, join_prefix, join_post"
-      row :a_transform        , "Tokenize and apply case and/or separator"
-      row :a_comparison       , "Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc."
-      row :a_inflection       , "Inflection handling routines, eg. pluralize, singular, ordinalize"
-    end
-  end
-  
-  @categories = result.raw_data_struct.rows
-end
-@categories = nil
-