cmdlet 0.0.7 → 0.2.1

data/.builders/director/cmdlet_dao.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class CmdletDao
+  attr_reader :k_builder
+
+  def initialize(k_builder)
+    @k_builder = k_builder
+  end
+
+  def all_cmdlets
+    data_access
+      .category
+      .categories.flat_map { |category| read_cmdlets(category[:name]) }
+      .compact
+      .uniq
+      .sort_by { |r| [r[:category], r[:name]] }
+  end
+
+  private
+
+  def read_cmdlets(category_name)
+    file_name = k_builder.target_folders.join(:builder_data, 'cmdlets', "#{category_name}.json")
+
+    return JSON.parse(File.read(file_name), symbolize_names: true)[:cmdlets] if File.exist?(file_name)
+
+    puts "Cmdlet file #{file_name} not found"
+    nil
+  end
+end

data/.builders/director/cmdlet_director.rb

@@ -1,36 +1,60 @@
 # frozen_string_literal: true
 
 class CmdletDirector < KDirector::Directors::BaseDirector
-  default_builder_type(CmdletBuilder)
+  defaults(builder_type: CmdletBuilder, on_exist: :write, on_action: :execute)
 
-  def category(name, description)
-    builder.category(name, description)
+  def initialize(k_builder, builder, **opts)
+    super(k_builder, builder, **opts)
+
+    builder.category_key = opts[:category] || :unknown
+  end
+
+  def cmdlet(**opts, &block)
+    cmdlet = CmdletChild.new(self, **opts)
+    cmdlet.instance_eval(&block) if block_given?
 
     self
   end
 
-  def helper(**opts, &block)
-    helper = CmdletChild.new(self, **opts)
-    helper.instance_eval(&block) if block_given?
+  def categories
+    data_access.category_director.categories
+  end
+
+  def generate
+    build_cmdlets
+    save_cmdlets
+    run_cop
 
     self
   end
 
-  def build_helpers
-    builder.helpers.each do |helper|
+  def build_cmdlets
+    builder.cmdlets.each do |cmdlet|
+      cmdlet_file = "#{cmdlet[:category]}/#{cmdlet[:name]}.rb"
+      cmdlet_spec_file = "#{cmdlet[:category]}/#{cmdlet[:name]}_spec.rb"
+
       cd(:lib)
-      add("helpers/#{helper[:category]}/#{helper[:name]}.rb", template_file: 'helper.rb', helper: helper)
+      add(cmdlet_file, template_file: 'cmdlet.rb', cmdlet: cmdlet)
 
       cd(:spec)
-      add("helpers/#{helper[:category]}/#{helper[:name]}_spec.rb", template_file: 'helper_spec.rb', helper: helper)
+      add(cmdlet_spec_file, template_file: 'cmdlet_spec.rb', cmdlet: cmdlet, on_exist: :skip)
     end
 
     self
   end
 
-  def save_categories
+  def run_cop
+    Dir.chdir(k_builder.target_folders.get(:app)) do
+      k_builder.run_cop('**/*.rb', fix_unsafe: true)
+    end
+
+    self
+  end
+
+  def save_cmdlets
     cd(:builder_data)
-    add('categories.json', content: JSON.pretty_generate(builder.categories.map(&:to_h)))
-    play_actions
+    add("cmdlets/#{builder.category_key}.json", content: builder.to_json)
+
+    self
   end
 end

data/.builders/director/dao.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+def data_access
+  @data_access ||= Dao.new(k_builder)
+end
+
+class Dao
+  attr_reader :k_builder
+  attr_reader :category
+  attr_reader :cmdlet
+
+  def initialize(k_builder)
+    @category = CategoryDao.new(k_builder)
+    @cmdlet = CmdletDao.new(k_builder)
+  end
+end

data/.builders/documents/commands.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 def commands
   return @commands unless @commands.nil?
-  
+
   result = KDoc.model :document do
     table :rows do
       fields :category, :name, :alias, :description, :ruby # , f(name: :params, default: [:value])
@@ -23,7 +25,7 @@ def commands
       #   it { is_expected.to eq('the,quick,fox') }
       # end
 
-      row :array                , :join            , []    , "join an array of values with separator as a string", <<-'RUBY'
+      row :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?
@@ -32,14 +34,14 @@ def commands
         values.join(separator)
       RUBY
 
-      # row :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?
+      row :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
+        separator = ','
+        "#{separator}#{value.join(separator)}"
+      RUBY
 
       # row :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)
@@ -59,7 +61,7 @@ def commands
       # RUBY
 
       # row :a_transform            , :constant             , [:constantize]                   , "", <<-'RUBY'
-      #   tokenizer.parse(value, separator: '_').upcase      
+      #   tokenizer.parse(value, separator: '_').upcase
       # RUBY
 
       # row :a_transform            , :dash                 , [:dasherize]                     , "convert to dash notation", <<-'RUBY'
@@ -81,7 +83,7 @@ def commands
       # 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'
@@ -129,7 +131,6 @@ def commands
       #   value.upcase
       # RUBY
 
-  
       # row :a_comparison         , :and                  , [:all] , "", <<-'RUBY'
       #   values.all? { |value| value }
       # RUBY
@@ -177,8 +178,6 @@ def commands
       #   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?
 
@@ -216,11 +215,11 @@ def commands
       #     value.pluralize(count)
       #   end
       # RUBY
-      
+
       # row :a_inflection         , :singularize          , [] , ""
     end
   end
-  
+
   @commands = result.raw_data_struct.rows
 end
 @commands = nil

data/.builders/documents/use_cases.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 def use_cases
   return @use_cases unless @use_cases.nil?
-  
-  result = KDoc.model :document do
 
+  result = KDoc.model :document do
     # table :inputs do
     #   fields :name, :value
 
@@ -18,9 +19,9 @@ def use_cases
 
     # end
 
-    sentence1 = "The quick  brown fox, jumped  over the lazy dog"
-    sentence2 = "coyote and the acme company"
-    text1     = "the Quick brown Fox 99"
+    sentence1 = 'The quick  brown fox, jumped  over the lazy dog'
+    sentence2 = 'coyote and the acme company'
+    text1     = 'the Quick brown Fox 99'
 
     table :rows do
       # fields :category, :function, :input, :commands, :expected_value
@@ -62,37 +63,36 @@ def use_cases
       row :a_transform  , :title          , [text1]     , 'The Quick Brown Fox 99'
       row :a_transform  , :title          , [sentence1] , 'The Quick Brown Fox Jumped over the Lazy Dog'
       row :a_transform  , :upper          , [text1]     , 'THE QUICK BROWN FOX 99'
-      
 
       row :a_comparison , :and            , [nil, nil]        , false
       row :a_comparison , :and            , ['data', nil]     , false
       row :a_comparison , :and            , [nil, 'data']     , false
-      row :a_comparison , :and            , ['data', 'data']  , true
-      row :a_comparison , :and            , ['aaa', 'bbb']    , true
+      row :a_comparison , :and            , %w[data data]  , true
+      row :a_comparison , :and            , %w[aaa bbb]    , true
 
       # DEFAULT does not make sense in comparison
-      row :a_comparison , :default        , [nil, 'happy'] , "happy"
-      row :a_comparison , :default        , ['sad', 'happy'] , "sad"
-      row :a_comparison , :default        , [nil, nil, nil, nil, 'david'] , "david"
-      row :a_comparison , :default        , ['', 'happy'] , "happy"
+      row :a_comparison , :default        , [nil, 'happy'] , 'happy'
+      row :a_comparison , :default        , %w[sad happy] , 'sad'
+      row :a_comparison , :default        , [nil, nil, nil, nil, 'david'] , 'david'
+      row :a_comparison , :default        , ['', 'happy'] , 'happy'
 
       # type: :strict, :equiv, :cast, :insensitive
-      row :a_comparison , :eq             , [111, '111'  ], false
-      row :a_comparison , :eq             , [111, 111.0  ], false
-      row :a_comparison , :eq             , ['aaa', 'aaa'], true
-      row :a_comparison , :eq             , ['aaa', 'bbb'], false
-      row :a_comparison , :eq             , [:aaa,  :aaa] , true
+      row :a_comparison , :eq             , [111, '111'], false
+      row :a_comparison , :eq             , [111, 111.0], false
+      row :a_comparison , :eq             , %w[aaa aaa], true
+      row :a_comparison , :eq             , %w[aaa bbb], false
+      row :a_comparison , :eq             , %i[aaa aaa] , true
       row :a_comparison , :eq             , ['aaa', :aaa] , false
-      row :a_comparison , :eq             , ['aaa', 'bbb'], false
-      row :a_comparison , :eq             , ['aaa', 'AAA'], false
+      row :a_comparison , :eq             , %w[aaa bbb], false
+      row :a_comparison , :eq             , %w[aaa AAA], false
 
       row :a_comparison , :gt             , [2, 1] , true
       row :a_comparison , :gt             , [2, 2] , false
-      
+
       row :a_comparison , :gte            , [1, 2] , false
       row :a_comparison , :gte            , [1, 1] , true
       row :a_comparison , :gte            , [2, 1] , true
-      
+
       row :a_comparison , :lt             , [1, 2] , true
       row :a_comparison , :lt             , [2, 1] , false
 
@@ -102,16 +102,15 @@ def use_cases
 
       row :a_comparison , :ne             , [1, 2] , true
       row :a_comparison , :ne             , [1, 1] , false
-      
+
       row :a_comparison , :or             , [nil, nil]        , false
       row :a_comparison , :or             , ['data', nil]     , true
       row :a_comparison , :or             , [nil, 'data']     , true
-      row :a_comparison , :or             , ['data', 'data']  , true
-      row :a_comparison , :or             , ['aaa', 'bbb']    , true
+      row :a_comparison , :or             , %w[data data]  , true
+      row :a_comparison , :or             , %w[aaa bbb]    , true
       # row :text1          , %i[backslash]     , 'the\quick\brown\fox99'
       # row :text1          , %i[camel]         , 'TheQuickBrownFox99'
 
-
       # row :sentence3      , %i[plural]        , "jumped over the lazy dogs"
       # row :title          , %i[plural]        , "Account Categories"
       # row :sentence1      , %i[dash]          , "The-quick-brown-fox-jumped-over-the-lazy-dog"
@@ -120,17 +119,16 @@ def use_cases
       # row :bsb_account    , %i[lower snake]   , "abc_123"
       # row :bsb_account    , %i[slash]         , "ABC/123"
     end
-
   end
-  
+
   @use_cases = result.raw_data_struct.rows
 end
 @use_cases = nil
 
-  # def self.camel_case(string, tokenizer = PreservePrefixedUnderscoreTokenizer.new)
-  #   # DAVE INPUT 9 Oct 21 from lucky_case play
-  #   # dependency injection: to use enhanced tokenizer
-  #   a = split_case_string string
-  #   converted = ([a[0]] + a[1..-1].map { |e| capital e }).join('')
-  #   tokenizer.parse(converted)
-  # end
+# def self.camel_case(string, tokenizer = PreservePrefixedUnderscoreTokenizer.new)
+#   # DAVE INPUT 9 Oct 21 from lucky_case play
+#   # dependency injection: to use enhanced tokenizer
+#   a = split_case_string string
+#   converted = ([a[0]] + a[1..-1].map { |e| capital e }).join('')
+#   tokenizer.parse(converted)
+# end

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