cmdlet 0.0.6 → 0.2.0

data/.builders/documents/x_functions.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 
 def category_blueprint
-
   fn_builder
     .init
     .category(:array      , active: 0 , title: 'Array'       , description: 'Functions for working with Array')
@@ -24,11 +24,9 @@ def category_blueprint
     .category(:regex      , active: 0 , title: 'Regex'       , description: 'Functions for working with Regex')
     .category(:string     , active: 0 , title: 'String'      , description: 'Functions for working with String')
     .category(:url        , active: 0 , title: 'Url'         , description: 'Functions for working with Url')
-
 end
 
 def function_blueprint
-
   fn_builder
     .init
     .for_category(:array)
@@ -41,11 +39,11 @@ def function_blueprint
     .for_category(:html)
     .for_category(:i18n)
     .for_category(:inflection)
-      .function(:ordinal)
-      .function(:ordinalize)
-      .function(:pluralize_by_number)
-      .function(:pluralize)
-      .function(:singularize)
+    .function(:ordinal)
+    .function(:ordinalize)
+    .function(:pluralize_by_number)
+    .function(:pluralize)
+    .function(:singularize)
     .for_category(:logging)
     .for_category(:markdown)
     .for_category(:match)
@@ -57,10 +55,9 @@ def function_blueprint
     .for_category(:regex)
     .for_category(:string)
     .for_category(:url)
-
 end
 
 # {{arrayify}}
 # Cast the given value to an array.
 # {{before}}
-# Return all of the items in the collection before the specified count. Opposite of after.
+# Return all of the items in the collection before the specified count. Opposite of after.

data/.builders/generators/01-bootstrap.rb

@@ -1,121 +1,121 @@
+# frozen_string_literal: true
+
 KManager.action :bootstrap do
   action do
     application_name = :cmdlet
 
     # Ruby Gem Bootstrap
     director = KDirector::Dsls::RubyGemDsl
-      .init(k_builder,
-        on_exist:                   :skip,                      # %i[skip write compare]
-        on_action:                  :queue                      # %i[queue execute]
-      )
-      .data(
-        ruby_version:               '2.7',
-        application:                application_name,
-        application_description:    'Cmdlet provides a set of functions (wrapped in the command pattern) that perform simple actions',
-        application_lib_path:       application_name.to_s,
-        application_lib_namespace:  'Cmdlet',
-        namespaces:                 ['Cmdlet'],
-        author:                     'David Cruwys',
-        author_email:               'david@ideasmen.com.au',
-        initial_semver:             '0.0.1',
-        main_story:                 'As a Developer, I want to use simple categorized functions so that I can easily add commonplace functionality to my application',
-        copyright_date:             '2022',
-        website:                    'http://appydave.com/gems/cmdlet'
-      )
-      .github(
-        active: false,
-        repo_name: application_name
-      ) do
-        create_repository
-        # delete_repository
-        # list_repositories
-        open_repository
-        # run_command('git init')
-      end
-      .blueprint(
-        active: false,
-        name: :bin_hook,
-        description: 'initialize repository',
-        on_exist: :write) do
-
-        cd(:app)
-
-        run_template_script('bin/runonce/git-setup.sh', dom: dom)
-
-        add('.githooks/commit-msg').run_command('chmod +x .githooks/commit-msg')
-        add('.githooks/pre-commit').run_command('chmod +x .githooks/pre-commit')
-
-        add('.gitignore')
-
-        run_command('git config core.hooksPath .githooks') # enable sharable githooks (developer needs to turn this on before editing rep)
-
-        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
-        run_command("gh repo edit -d \"#{dom[:application_description]}\"")
-      end
-      .package_json(
-        active: false,
-        name: :package_json,
-        description: 'Set up the package.json file for semantic versioning'
-      ) do
-        self
-          .add('package.json', dom: dom)
-          .play_actions
-
-        self
-          .add_script('release', 'semantic-release')
-          .sort
-          .development
-          .npm_add_group('semver-ruby')
-
-        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
-      end
-      .blueprint(
-        active: false,
-        name: :opinionated,
-        description: 'opinionated GEM files',
-        on_exist: :write) do
-
-        cd(:app)
-
-        add('bin/setup')
-        add('bin/console')
-
-        add("lib/#{typed_dom.application}.rb"             , template_file: 'lib/applet_name.rb'         , dom: dom)
-        add("lib/#{typed_dom.application}/version.rb"     , template_file: 'lib/applet_name/version.rb' , dom: dom)
-    
-        add('spec/spec_helper.rb')
-        add("spec/#{typed_dom.application}_spec.rb"       , template_file: 'spec/applet_name_spec.rb', dom: dom)
-
-        add("#{typed_dom.application}.gemspec"            , template_file: 'applet_name.gemspec', dom: dom)
-        add('Gemfile', dom: dom)
-        add('Guardfile', dom: dom)
-        add('Rakefile', dom: dom)
-        add('.rspec', dom: dom)
-        add('.rubocop.yml', dom: dom)
-        add('README.md', dom: dom)
-        add('CODE_OF_CONDUCT.md', dom: dom)
-        add('LICENSE.txt', dom: dom)
-
-        run_command("rubocop -a")
-      
-        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
-      end
-      .blueprint(
-        active: true,
-        name: :ci_cd,
-        description: 'github actions (CI/CD)',
-        on_exist: :write) do
-
-        cd(:app)
-
-        run_command("gh secret set SLACK_WEBHOOK --body \"$SLACK_REPO_WEBHOOK\"")
-        run_command("gh secret set GEM_HOST_API_KEY --body \"$GEM_HOST_API_KEY\"")
-
-        add('.github/workflows/main.yml')
-        add('.releaserc.json')
-
-        run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
-      end
+               .init(k_builder,
+                     on_exist: :skip, # %i[skip write compare]
+                     on_action: :queue # %i[queue execute]
+                    )
+               .data(
+                 ruby_version: '2.7',
+                 application: application_name,
+                 application_description: 'Cmdlet provides a set of functions (wrapped in the command pattern) that perform simple actions',
+                 application_lib_path: application_name.to_s,
+                 application_lib_namespace: 'Cmdlet',
+                 namespaces: ['Cmdlet'],
+                 author: 'David Cruwys',
+                 author_email: 'david@ideasmen.com.au',
+                 initial_semver: '0.0.1',
+                 main_story: 'As a Developer, I want to use simple categorized functions so that I can easily add commonplace functionality to my application',
+                 copyright_date: '2022',
+                 website: 'http://appydave.com/gems/cmdlet'
+               )
+               .github(
+                 active: false,
+                 repo_name: application_name
+               ) do
+                 create_repository
+                 # delete_repository
+                 # list_repositories
+                 open_repository
+                 # run_command('git init')
+               end
+               .blueprint(
+                 active: false,
+                 name: :bin_hook,
+                 description: 'initialize repository',
+                 on_exist: :write
+               ) do
+                 cd(:app)
+
+                 run_template_script('bin/runonce/git-setup.sh', dom: dom)
+
+                 add('.githooks/commit-msg').run_command('chmod +x .githooks/commit-msg')
+                 add('.githooks/pre-commit').run_command('chmod +x .githooks/pre-commit')
+
+                 add('.gitignore')
+
+                 run_command('git config core.hooksPath .githooks') # enable sharable githooks (developer needs to turn this on before editing rep)
+
+                 run_command("git add .; git commit -m 'chore: #{options.description.downcase}'; git push")
+                 run_command("gh repo edit -d \"#{dom[:application_description]}\"")
+               end
+               .package_json(
+                 active: false,
+                 name: :package_json,
+                 description: 'Set up the package.json file for semantic versioning'
+               ) do
+                 add('package.json', dom: dom)
+                   .play_actions
+
+                 add_script('release', 'semantic-release')
+                   .sort
+                   .development
+                   .npm_add_group('semver-ruby')
+
+                 run_command("git add .; git commit -m 'chore: #{options.description.downcase}'; git push")
+               end
+               .blueprint(
+                 active: false,
+                 name: :opinionated,
+                 description: 'opinionated GEM files',
+                 on_exist: :write
+               ) do
+                 cd(:app)
+
+                 add('bin/setup')
+                 add('bin/console')
+
+                 add("lib/#{typed_dom.application}.rb"             , template_file: 'lib/applet_name.rb'         , dom: dom)
+                 add("lib/#{typed_dom.application}/version.rb"     , template_file: 'lib/applet_name/version.rb' , dom: dom)
+
+                 add('spec/spec_helper.rb')
+                 add("spec/#{typed_dom.application}_spec.rb"       , template_file: 'spec/applet_name_spec.rb', dom: dom)
+
+                 add("#{typed_dom.application}.gemspec"            , template_file: 'applet_name.gemspec', dom: dom)
+                 add('Gemfile', dom: dom)
+                 add('Guardfile', dom: dom)
+                 add('Rakefile', dom: dom)
+                 add('.rspec', dom: dom)
+                 add('.rubocop.yml', dom: dom)
+                 add('README.md', dom: dom)
+                 add('CODE_OF_CONDUCT.md', dom: dom)
+                 add('LICENSE.txt', dom: dom)
+
+                 run_command('rubocop -a')
+
+                 run_command("git add .; git commit -m 'chore: #{options.description.downcase}'; git push")
+               end
+               .blueprint(
+                 active: true,
+                 name: :ci_cd,
+                 description: 'github actions (CI/CD)',
+                 on_exist: :write
+               ) do
+      cd(:app)
+
+      run_command('gh secret set SLACK_WEBHOOK --body "$SLACK_REPO_WEBHOOK"')
+      run_command('gh secret set GEM_HOST_API_KEY --body "$GEM_HOST_API_KEY"')
+
+      add('.github/workflows/main.yml')
+      add('.releaserc.json')
+
+      run_command("git add .; git commit -m 'chore: #{options.description.downcase}'; git push")
+    end
 
     director.play_actions
     # director.builder.logit

data/.builders/generators/20-categories.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+KManager.action :categories do
+  action do
+    CategoryDirector
+      .init(k_builder)
+      .category(:case       , 'Tokenize and apply case and/or separator')
+      .category(:comparison , 'Comparison helpers, eg. or, and, equal, not equal, less than, greater than etc.')
+      .category(:inflection , 'Inflection handling routines, eg. pluralize, singular, ordinalize')
+      .category(:string     , 'String handling helpers')
+      .category(:array      , 'Array handling routines, eg. join, join_prefix, join_post')
+      .category(:transform  , 'Tokenize and apply case and/or separator')
+      .save_categories
+      .generate
+  end
+end

data/.builders/generators/30-commands-bak.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+KManager.action :commands_bak do
+  action do
+    puts commands.first.function_description
+    # Ruby Gem Bootstrap
+    director = KDirector::Dsls::BasicDsl
+               .init(k_builder,
+                     template_base_folder: '',
+                     on_exist: :skip, # %i[skip write compare]
+                     on_action: :queue # %i[queue execute]
+                    )
+               .blueprint(
+                 active: true,
+                 name: :build_commands,
+                 description: 'Build Commandlets',
+                 on_exist: :write
+               ) do
+      cd(:lib)
+
+      # builder
+      #   .add_file('FUNCTIONS.md',
+      #             template_file: 'FUNCTIONS.md',
+      #             categories: categories.sort_by { |r| r.name },
+      #             functions: functions.sort_by { |r| [r.category, r.name] },
+      #             on_exist: :write)
+
+      add('all_commands.rb',
+          template_file: 'all_commands.rb',
+          commands: commands.sort_by { |r| [r.category, r.name] },
+          on_exist: :write)
+
+      cmdlets.each do |cmdlet|
+        add("#{cmdlet.category}/#{cmdlet.name}.rb",
+            cmdlet: cmdlet,
+            template_file: 'command.rb',
+            on_exist: :write)
+      end
+    end
+
+    director.play_actions
+    # director.builder.logit
+  end
+end
+
+KManager.opts.app_name                    = 'commands'
+KManager.opts.sleep                       = 2
+KManager.opts.reboot_on_kill              = 0
+KManager.opts.reboot_sleep                = 4
+KManager.opts.exception_style             = :short
+KManager.opts.show.time_taken             = true
+KManager.opts.show.finished               = true
+KManager.opts.show.finished_message       = 'FINISHED :)'

data/.builders/generators/cmdlets/array.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+KManager.action :array_commands do
+  action do
+    CmdletDirector
+      .init(k_builder, category: :array)
+      .cmdlet do
+        name :join
+        description           'join an array of values with separator as a string'
+        result                'new String formed by joining the array elements with seperator'
+
+        parameter             :values, 'array of values to join', param_type: 'String|Int'
+        parameter             :separator, 'separator between values, defaults to comma', default: "','"
+
+        ruby <<-RUBY
+          return false if values.nil? || values.length == 0
+          values = values.reject(&:blank?)
+          return '' if values.length.zero?
+
+          values.join(separator)
+        RUBY
+      end
+      .cmdlet do
+        name :join_pre
+        description           'join an array of values with separator as a string and using the separator at the beginning of string'
+
+        parameter             :values, 'array of values to join', param_type: 'String|Int'
+        parameter             :separator, 'separator between values, defaults to comma', default: "','"
+
+        ruby <<-'RUBY'
+          return '' if values.nil? || !values.is_a?(::Array)
+          values = values.reject(&:blank?)
+          return '' if values.length.zero?
+
+          "#{separator}#{values.join(separator)}"
+        RUBY
+      end
+      .cmdlet do
+        name :join_pre
+        description           'join an array of values with separator as a string and using the separator at the beginning of string'
+
+        parameter             :values, 'array of values to join', param_type: 'String|Int'
+        parameter             :separator, 'separator between values, defaults to comma', default: "','"
+
+        ruby <<-'RUBY'
+          return '' if values.nil? || !values.is_a?(::Array)
+          values = values.reject(&:blank?)
+          return '' if values.length.zero?
+
+          "#{separator}#{values.join(separator)}"
+        RUBY
+      end
+      .cmdlet do
+        name :join_post
+        description           'join an array of values with separator as a string and using the separator at the end of string'
+
+        parameter             :values, 'array of values to join', param_type: 'String|Int'
+        parameter             :separator, 'separator between values, defaults to comma', default: "','"
+
+        ruby <<-'RUBY'
+            return '' if values.nil? || !values.is_a?(::Array)
+            values = values.reject(&:blank?)
+            return '' if values.length.zero?
+
+            "#{values.join(separator)}#{separator}"
+        RUBY
+      end
+      .generate
+      .debug
+  end
+end

data/.builders/generators/cmdlets/comparison.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+KManager.action :comparison_commands do
+  action do
+    CmdletDirector
+      .init(k_builder, category: :comparison)
+      .cmdlet do
+        name :and
+        description           'Return true if **all of** the given values are truthy.'
+        result                'return true when every value is truthy'
+
+        parameter             :values, 'list of values (via *splat) to be checked via AND condition', splat: '*', param_type: 'Object'
+
+        ruby <<-RUBY
+          values.all? { |value| value }
+        RUBY
+      end
+      .cmdlet do
+        name :default
+        description           'Return true if **all of** the given values are truthy.'
+        result                'return true when every value is truthy'
+
+        parameter             :values, 'one or more paramaters that may or may not contain nil', splat: '*', param_type: 'Object'
+
+        ruby <<-RUBY
+          default_value = values[-1]
+
+          find_value = values[0..-2].find { |value| !value.nil? }
+
+          find_value || default_value
+        RUBY
+
+      end
+      .cmdlet do
+        name :eq
+        description           'Return true if two values are equal'
+        result                'return truthy value if left hand side equals right hand side'
+
+        parameter             :lhs, 'lhs - left hand side value', param_type: 'Object'
+        parameter             :rhs, 'rhs - right hand side value', param_type: 'Object'
+
+        ruby <<-RUBY
+          lhs = lhs.to_s if lhs.is_a?(Symbol)
+          rhs = rhs.to_s if rhs.is_a?(Symbol)
+
+          lhs == rhs
+        RUBY
+      end
+      .cmdlet do
+        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'
+
+        parameter             :lhs, 'lhs - left hand side value', param_type: 'Object'
+        parameter             :rhs, 'rhs - right hand side value', param_type: 'Object'
+
+        ruby <<-RUBY
+          lhs > rhs
+        RUBY
+      end
+      .cmdlet do
+        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'
+
+        parameter             :lhs, 'lhs - left hand side value', param_type: 'Object'
+        parameter             :rhs, 'rhs - right hand side value', param_type: 'Object'
+
+        ruby <<-RUBY
+          lhs >= rhs
+        RUBY
+      end
+      .cmdlet do
+        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'
+
+        parameter             :lhs, 'lhs - left hand side value', param_type: 'Object'
+        parameter             :rhs, 'rhs - right hand side value', param_type: 'Object'
+
+        ruby <<-RUBY
+          lhs < rhs
+        RUBY
+      end
+      .cmdlet do
+        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'
+
+        parameter             :lhs, 'lhs - left hand side value', param_type: 'Object'
+        parameter             :rhs, 'rhs - right hand side value', param_type: 'Object'
+
+        ruby <<-RUBY
+          lhs <= rhs
+        RUBY
+      end
+      .cmdlet do
+        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'
+
+        parameter             :lhs, 'lhs - left hand side value', param_type: 'Object'
+        parameter             :rhs, 'rhs - right hand side value', param_type: 'Object'
+
+        ruby <<-RUBY
+          lhs = lhs.to_s if lhs.is_a?(Symbol)
+          rhs = rhs.to_s if rhs.is_a?(Symbol)
+
+          lhs != rhs
+        RUBY
+      end
+      .cmdlet do
+        name :or
+        description           'Return true if any value is truthy.'
+        result                'return true when first value is truthy'
+
+        parameter             :values, 'list of values (via *splat) to be checked via AND condition', splat: '*', param_type: 'Object'
+
+        ruby <<-RUBY
+          values.any? { |value| value }
+        RUBY
+      end
+    .generate
+    .debug
+  end
+end

data/.builders/generators/cmdlets/inflection.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+KManager.action :inflection_commands do
+  action do
+    CmdletDirector
+      .init(k_builder, category: :inflection)
+      .cmdlet do
+        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'
+
+        parameter             :value, 'value - numeric value', param_type: 'String|Int'
+
+        ruby <<-RUBY
+          return '' if value.nil?
+
+          value = value.to_i if value.is_a? String
+
+          value.ordinal
+        RUBY
+      end
+      .cmdlet do
+        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.'
+
+        parameter             :value, 'value - numeric value', param_type: 'Int'
+
+        ruby <<-RUBY
+          return '' if value.nil?
+
+          value = value.to_i if value.is_a? String
+
+          value.ordinalize
+        RUBY
+      end
+      .cmdlet do
+        name :pluralize
+        description           'Returns the plural form of the word in the string'
+        result                'value in plural form'
+
+        parameter             :value, 'value - value to pluralize', param_type: 'String'
+
+        ruby <<-RUBY
+          return '' if value.nil?
+
+          value = value.to_s if value.is_a?(Symbol)
+
+          value.pluralize
+        RUBY
+      end
+      .cmdlet do
+        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'
+
+        parameter             :value, 'value - value to pluralize', param_type: 'String'
+        parameter             :count, 'count used to determine pluralization', param_type: 'Int'
+        parameter             :format, '(Optional) what format should output be. :word, :number_word'
+
+        ruby <<-'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
+      end
+      .cmdlet do
+        name :singularize
+        description           'The reverse of #pluralize, returns the singular form of a word in a string'
+        result                'plural value turned to singular value'
+
+        parameter             :value, 'value - value to singularized', param_type: 'String'
+
+        ruby <<-RUBY
+          return '' if value.nil?
+
+          value = value.to_s if value.is_a?(Symbol)
+
+          value.singularize
+        RUBY
+      end
+      .generate
+      .debug
+  end
+end