cmdlet 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aaf22abcff261a22b71b4c4adeaf77dd8d629836936eabb1b20b2d8a61b3a28
-  data.tar.gz: 4d249fee0dd48b4774881e16bcc92b303f788e45b22c54c14a321a70468bcabf
+  metadata.gz: dc4888cd594af0dd224a836be55e28d9b6cdf153ac89e770807d412b14d11982
+  data.tar.gz: 00b2044a9a53f53afbe109a443aabd7cc38db54782fd1a1eebfbdc563db3de7c
 SHA512:
-  metadata.gz: ab39c705f59887093ecbf3a8ad2ec66f133bf14048f544b142b3de324fdb25006dfa19bb66efdf5e281d0167bac8b4bd2958769cff3ad8879515f833f24fa5d5
-  data.tar.gz: e78c0098b63350dfcc77bb7c6c50d902b8da963a9fc8531639a5c6835df4fdae3158b8518f2efd2f87a2fda9dfd9fb3a573f774159c04fad451dca50da09ac43
+  metadata.gz: f7470c8c5cc637bfc48aa1e5d9a63d73748831e71d323cdf3a09d2cb1b5b0e8e40970300072eafbbe00976334d7021e3e22ce66f5626b4983faa2d02f5e4ca70
+  data.tar.gz: e04137866c533b774510d0964be0a27f98110c23237da9d55b8c560d371f1a32d55e8e2af67799b0f58b3240434b1fb7b46f40915cb1baacf4adcfb5f037a496

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/generators/cmdlets/array.rb

@@ -69,41 +69,3 @@ KManager.action :array_commands do
       .debug
   end
 end
-
-# result                "return block when every value is truthy"
-
-# parameter('values', 'list of values (via *splat) to be checked via AND condition', splat: true)
-
-# example <<-TEXT
-#   {{#if (and p1 p2 p3 p4 p5)}}
-#     found
-#   {{/if}}
-# TEXT
-
-# example <<-TEXT
-#   {{#if (and name age)}}
-#     {{name}}-{{age}}
-#   {{else}}
-#     no name or age
-#   {{/if}}
-# TEXT
-
-# 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

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

@@ -124,41 +124,3 @@ KManager.action :comparison_commands do
     .debug
   end
 end
-
-# result                "return block when every value is truthy"
-
-# parameter('values', 'list of values (via *splat) to be checked via AND condition', splat: true)
-
-# example <<-TEXT
-#   {{#if (and p1 p2 p3 p4 p5)}}
-#     found
-#   {{/if}}
-# TEXT
-
-# example <<-TEXT
-#   {{#if (and name age)}}
-#     {{name}}-{{age}}
-#   {{else}}
-#     no name or age
-#   {{/if}}
-# TEXT
-
-# 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

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

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [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)
 
 

data/lib/cmdlet/_.rb

@@ -12,3 +12,8 @@ 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/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.1.2'
+  VERSION = '0.2.0'
 end

data/lib/cmdlet.rb

@@ -2,6 +2,8 @@
 
 # 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'

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "cmdlet",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "cmdlet",
-      "version": "0.1.2",
+      "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.1.2",
+  "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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmdlet
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - David Cruwys
@@ -55,6 +55,7 @@ files:
 - ".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"
@@ -71,6 +72,7 @@ files:
 - ".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"
@@ -100,6 +102,11 @@ files:
 - 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