cmdlet 0.0.5 → 0.1.2

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/configuration.rb

@@ -21,7 +21,7 @@ module Cmdlet
     attr_accessor :padr_char
 
     def initialize
-      # @tokenizer = Funcky::StringTokenizer.new
+      @tokenizer = Cmdlet::StringTokenizer.new
       @padr_count = 30
       @padr_char = ' '
       @padl_count = 30

data/lib/cmdlet/version.rb

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

data/lib/cmdlet.rb

@@ -4,8 +4,11 @@
 require 'k_config'
 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.5",
+  "version": "0.1.2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "cmdlet",
-      "version": "0.0.5",
+      "version": "0.1.2",
       "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.5",
+  "version": "0.1.2",
   "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.5
+  version: 0.1.2
 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,31 @@ 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/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"
 - ".releaserc.json"
 - ".rspec"
 - ".rubocop.yml"
@@ -68,6 +84,21 @@ 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/string_tokenizer.rb
 - lib/cmdlet/version.rb
@@ -78,6 +109,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
-

data/.builders/documents/functions.rb

@@ -1,226 +0,0 @@
-def functions
-  return @functions unless @functions.nil?
-  
-  result = KDoc.model :document do
-    table :rows do
-      fields :category, :name, :alias, :description, :ruby # , f(name: :params, default: [:value])
-
-      # context 'when array of string' do
-      #   let(:value) { %w[the quick fox] }
-
-      #   it { is_expected.to eq('the,quick,fox') }
-      # end
-
-      # context 'when array of numbers' do
-      #   let(:value) { [1, 2, 3] }
-
-      #   it { is_expected.to eq('1,2,3') }
-      # end
-
-      # context 'when array of symbol' do
-      #   let(:value) { %i[the quick fox] }
-
-      #   it { is_expected.to eq('the,quick,fox') }
-      # end
-
-      row :a_array                , :join            , []    , "join an array of values with separator as a string", <<-'RUBY'
-        return '' if value.nil? || !value.is_a?(Array)
-        values = value.reject(&:blank?)
-        return '' if value.length.zero?
-
-        separator = ','
-        value.join(separator)
-      RUBY
-
-      row :a_array                , :join_pre        , []    , "join an array of values with separator as a string and using the separator at the beginning of string", <<-'RUBY'
-        return '' if value.nil? || !value.is_a?(Array)
-        values = value.reject(&:blank?)
-        return '' if value.length.zero?
-
-        separator = ','
-        "#{separator}#{value.join(separator)}"
-      RUBY
-
-      row :a_array                , :join_post       , []    , "join an array of values with separator as a string and using the separator at the end of string", <<-'RUBY'
-        return '' if value.nil? || !value.is_a?(Array)
-        values = value.reject(&:blank?)
-        return '' if value.length.zero?
-
-        separator = ','
-        "#{value.join(separator)}#{separator}"
-      RUBY
-
-      row :a_transform            , :backslash            , [:back_slash]                    , "convert to back slash notation", <<-'RUBY'
-        tokenizer.parse(value, preserve_case: true, separator: '\\')
-      RUBY
-
-      row :a_transform            , :camel                , [:upper_camel, :pascal]          , "convert to camel notation", <<-'RUBY'
-        tokenizer.parse(value).underscore.camelize
-      RUBY
-
-      row :a_transform            , :constant             , [:constantize]                   , "", <<-'RUBY'
-        tokenizer.parse(value, separator: '_').upcase      
-      RUBY
-
-      row :a_transform            , :dash                 , [:dasherize]                     , "convert to dash notation", <<-'RUBY'
-        tokenizer.parse(value)
-      RUBY
-
-      row :a_transform            , :dot                  , [:dotirize]                      , "", <<-'RUBY'
-        tokenizer.parse(value, separator: '.')
-      RUBY
-
-      row :a_transform            , :double_colon         , []                               , "", <<-'RUBY'
-        tokenizer.parse(value, preserve_case: true, separator: '::')
-      RUBY
-
-      row :a_transform            , :lower                , [:lowercase, :downcase]          , "", <<-'RUBY'
-        return '' if value.nil?
-
-        value.downcase
-      RUBY
-
-      # row :a_transform            , :format_as            , []                               , "", <<-'RUBY'
-      
-      # RUBY
-
-      row :a_transform            , :proper            , []                               , "Proper case capitalizes the first letter of ALL words in a string", <<-'RUBY'
-      tokenizer.parse(value,
-              separator: ' ',
-              preserve_case: true,
-              compress_prefix_numerals: false,
-              compress_suffix_numerals: false)
-        .titleize
-      RUBY
-
-      row :a_transform            , :sentence             , [:human, :humanize]              , "Upper case for first letter only.  Numbers will maintain their spacing", <<-'RUBY'
-        tokenizer.parse(value,
-                        separator: ' ',
-                        preserve_case: true,
-                        compress_prefix_numerals: false,
-                        compress_suffix_numerals: false)
-                  .humanize
-      RUBY
-
-      row :a_transform            , :lamel                , [:lower_camel]                   , "", <<-'RUBY'
-        tokenizer.parse(value, separator: '_').camelize(:lower)
-      RUBY
-
-      row :a_transform            , :slash                , [:forwardslash, :forward_slash]  , "", <<-'RUBY'
-        tokenizer.parse(value, preserve_case: true, separator: '/')
-      RUBY
-
-      row :a_transform            , :snake                , [:snake]                         , "", <<-'RUBY'
-        tokenizer.parse(value, separator: '_', forced_separator: true)
-      RUBY
-
-      row :a_transform            , :title                , [:titleize]                      , "", <<-'RUBY'
-        tokenizer.parse(value,
-                        separator: ' ',
-                        preserve_case: true,
-                        compress_prefix_numerals: false,
-                        compress_suffix_numerals: false)
-                 .titleize
-      RUBY
-
-      row :a_transform            , :upper                , [:upper_case, :upcase]           , "", <<-'RUBY'
-        return '' if value.nil?
-
-        value.upcase
-      RUBY
-
-  
-      row :a_comparison         , :and                  , [:all] , "", <<-'RUBY'
-        values.all? { |value| value }
-      RUBY
-
-      # DEFAULT does not make sense in comparison
-      row :a_comparison         , :default              , [:fallback] , "", <<-'RUBY'
-        default_value = values[-1]
-
-        find_value = values[0..-2].find { |value| !value.nil? }
-
-        find_value || default_value
-      RUBY
-
-      row :a_comparison         , :eq                   , [:equal] , "", <<-'RUBY'
-        lhs = lhs.to_s if lhs.is_a?(Symbol)
-        rhs = rhs.to_s if rhs.is_a?(Symbol)
-
-        lhs == rhs
-      RUBY
-
-      row :a_comparison         , :gt                   , [] , "", <<-'RUBY'
-        lhs > rhs
-      RUBY
-
-      row :a_comparison         , :gte                  , [] , "", <<-'RUBY'
-        lhs >= rhs
-      RUBY
-
-      row :a_comparison         , :lt                   , [:less_than] , "# Lt: (less than) Block helper that renders a block if `a` is **less than** `b`. If an inverse block is specified it will be rendered when falsy.", <<-'RUBY'
-        lhs < rhs
-      RUBY
-
-      row :a_comparison         , :lte                  , [:less_than_or_equal_to] , "# Lte: (less than or equal to) Block helper that renders a block if `a` is **less than or equal to** `b`. If an inverse block is specified it will be rendered when falsy.", <<-'RUBY'
-        lhs <= rhs
-      RUBY
-
-      row :a_comparison         , :ne                   , [:not_equal] , "# Ne: (not equal) Block helper that renders a block if `a` is **not equal to** `b`. If an inverse block is specified it will be rendered when falsy.", <<-'RUBY'
-        lhs = lhs.to_s if lhs.is_a?(Symbol)
-        rhs = rhs.to_s if rhs.is_a?(Symbol)
-
-        lhs != rhs
-      RUBY
-
-      row :a_comparison         , :or                   , [:any] , "", <<-'RUBY'
-        values.any? { |value| value }
-      RUBY
-
-
-
-      row :a_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", <<-RUBY
-        return '' if value.nil?
-
-        value = value.to_i if value.is_a? String
-
-        value.ordinal
-      RUBY
-
-      row :a_inflection         , :ordinalize           , [] , "Turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.", <<-RUBY
-        return '' if value.nil?
-
-        value = value.to_i if value.is_a? String
-
-        value.ordinalize
-      RUBY
-
-      row :a_inflection         , :pluralize            , [] , "Returns the plural form of the word in the string", <<-RUBY
-        return '' if value.nil?
-
-        value = value.to_s if value.is_a?(Symbol)
-
-        value.pluralize
-      RUBY
-
-      row :a_inflection         , :pluralize_by_number  , [] , "Uses both a word and number to decide if the plural or singular form should be used.", <<-'RUBY'
-        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
-      RUBY
-      
-      # row :a_inflection         , :singularize          , [] , ""
-    end
-  end
-  
-  @functions = result.raw_data_struct.rows
-end
-@functions = nil