thor_enhance 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd2c2b70158e1ab7a387dddfefde9c88c27c1809278ee05608dfca0f7de6484
-  data.tar.gz: eb3ed82f1b26e2239130ff9383971c7167975ac685815e08d48de42cf7eea74c
+  metadata.gz: c35515a53e679dc8e52c1c615dc19c4c24214280fb75e1af513e257d831cf457
+  data.tar.gz: 68a91514f8b7dde6df20913f4ec8fdfce263c1a36e8700da80569d79fd3480d3
 SHA512:
-  metadata.gz: 52f31daa639f2db023690b1c5b67ae261f0de382a1e03c9ad0a4801162e2ddef4127a942d8b57ad9a2dd72392a17953e63ad9ebfa913bf3e6a70d753bc668617
-  data.tar.gz: b504a6e6087671967755adf851386e0ad499d568a9f66ae561b2aee44b77a2b84c882ace9656136a10f2ed91ce77101023ee8e1ee9b2136d79f02dc428c1e63b
+  metadata.gz: 7cd3bda1a32242ad57a0f55f956d5e9780a1f5c22f9866718e1fc12944c40792f9aa89b2ae6ba885f7ffdb269890fa66056f2b8fac40c15bba64ef1a85288a9f
+  data.tar.gz: b30889ca39f92ef0e9851dd3c0b37930b472dd1db7a001bb1778a034c64904f216f5c3cc16ed71d590f96fd515052441eb649aa2856638ad29f6e2f4656f6679

data/CHANGELOG.md

@@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [0.5.0]
+- Autogenerate Readme based on command options and method options
+
 ## [0.4.0]
 - Enable Enhancements on a klass basis
 - Add Enable/disable blocks for enhancements to allow for onboarding new tasks

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    thor_enhance (0.5.0)
+    thor_enhance (0.5.1)
       activesupport (>= 6)
       thor (~> 1.3)
 

data/docs/autogenerate/Readme.md

@@ -14,10 +14,20 @@ ThorEnhance.configure do |c|
 end
 ```
 
+### Pro Tip
+The Readme's are generated based on the code. We suggest to enable the following in your `.gitattributes`
+```
+# .gitattributes
+...
+generated_readme/** linguist-generated=true
+...
+```
+`generated_readme/**` is the default location for ThorEnhance Readmes. The code above will tell github to ignore these files for code review. This will help in the process to ensure that only the code gets changes rather than the generated readme.
+
 ## Default capabilities
 
 ### Example Command Option
-When `readme_enhance` is enabled, by default the `example`ew command option is available on for every command.
+When `readme_enhance` is enabled, by default the `example` command option is available on for every command.
 
 ```ruby
 desc "sample", "This Sample command"
@@ -27,13 +37,13 @@ method_option :boolean, type: :boolean, desc: "Just a normal boolean"
 def sample;end;
 ```
 
-The example command takes signature expects:
+The example command signature expects:
 ```ruby
 # remove basename and any submodules from command execution
 example "command execution", desc: "Description of what the command does"
 ```
 
-By default, `example` is not required for every command. To make example required for every command, modify the configuration to
+By default, `example` is not required for every command. To make `example` required for every command, modify the configuration to:
 ```ruby
 ThorEnhance.configure do |c|
   c.readme_enhance! do |r|
@@ -43,7 +53,7 @@ end
 ```
 
 ### Header Command Option
-When `readme_enhance` is enabled, by default a the `header` option is available on every command.
+When `readme_enhance` is enabled, by default the `header` option is available on every command.
 
 ```ruby
 desc "sample", "This Sample command"
@@ -61,11 +71,11 @@ This optional command option gets used for the Readme title. Otherwise, the meth
 
 ```ruby
 desc "sample", "This Sample command"
-title ""
+title "Useless Sample command"
 def sample;end;
 ```
 
-By default, `title` is not required for every command. To make example required for every command, modify the configuration to
+By default, `title` is not required for every command. To make `title` required for every command, modify the configuration to
 ```ruby
 ThorEnhance.configure do |c|
   c.readme_enhance! do |r|
@@ -149,4 +159,8 @@ is_this_important "Yes this is imporant. It even has a custom tag", tag: 1
 def sample;end;
 ```
 
-Take special not of the `tag` option on the custom header. By default, header will output as an <h2> header tag. To change, this you can use numeric `1|2|3|4` or you can use string `h[1234]`
+Take special note of the `tag` option on the custom header. By default, header will output as an `<h2>` header tag. You can optionally change the header tag value to a numeric: `1|2|3|4` or you can use a header string: `h1|h2|h3|h4`
+
+# Example:
+
+ThorEnanhace has sample thor tasks defined in [ThorEnhance::Sample](/lib/thor_enhance/sample.rb). View the [AutoGenerated Commands here](/generated_readme/commands)

data/generated_readme/commands/Readme.md

@@ -0,0 +1,34 @@
+## [Subcommand for sample class](sub/Readme.md)
+Thor sub command validation for thor enhance
+
+```bash
+# Help Command
+thor_enhance sub <options>
+
+
+```
+
+## [sample](sample.md)
+This Sample command does a lot of nothing
+
+```bash
+# Help Command
+thor_enhance sample <options>
+
+thor_enhance sample
+thor_enhance sample --boolean
+```
+
+## [autobots](autobots.md)
+Command outputs what Optimus prime is thniking
+
+```bash
+# Help Command
+thor_enhance autobots <options>
+
+thor_enhance sample
+thor_enhance sample --boolean
+```
+
+> AutoGenerateted by [ThorEnhance](https://github.com/matt-taylor/thor_enhance) <br>
+> Regenerate readme files with: thor_enhance thor_enhance_autogenerate --apply

data/generated_readme/commands/autobots.md

@@ -0,0 +1,69 @@
+# Autobots
+
+Source code for this command can be found at: [ThorEnhance::Sample#autobots](/lib/thor_enhance/sample.rb#L51)
+
+## Description
+Command outputs what Optimus prime is thniking
+
+```bash
+# Base command for `autobots`
+thor_enhance autobots <options>
+```
+
+## When Should I Use This?
+
+Do you ever feel angry about how powerful the Decepticons are compared to the Autobots? It seems unfair.
+Trust...The autobots agree.
+
+
+
+
+---
+
+## Examples
+
+```bash
+# yo yo ma
+thor_enhance sample
+```
+
+```bash
+# yo yo ma
+thor_enhance sample --boolean
+```
+
+
+
+---
+
+
+## Method Options
+
+
+
+<details open>
+  <summary> <h3> Important options </h3> </summary>
+
+```bash
+# What: Enable bumblee bee flag
+# Type: boolean
+# Required: false
+--bumble | -b | --no-bumble
+
+```
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+> AutoGenerateted by [ThorEnhance](https://github.com/matt-taylor/thor_enhance) <br>
+> Regenerate readme files with: thor_enhance thor_enhance_autogenerate --apply
+

data/generated_readme/commands/sample.md

@@ -0,0 +1,84 @@
+# Sample
+
+Source code for this command can be found at: [ThorEnhance::Sample#sample](/lib/thor_enhance/sample.rb#L39)
+
+## Description
+This Sample command does a lot of nothing
+
+```bash
+# Base command for `sample`
+thor_enhance sample <options>
+```
+
+#### How Does This Help
+
+Honestly, this does not help at all
+
+# How Does This Help
+
+But its cool because it is a repatable command
+
+## When Should I Use This?
+
+Have you ever wanted your code to be useless?
+Well, this command does absolutely nothing.
+This output is to say that this command does absolutely nothing
+
+
+
+
+---
+
+## Examples
+
+```bash
+# yo yo ma
+thor_enhance sample
+```
+
+```bash
+# yo yo ma
+thor_enhance sample --boolean
+```
+
+
+
+---
+
+
+## Method Options
+
+
+
+<details open>
+  <summary> <h3> Important options </h3> </summary>
+
+```bash
+# What: Just a normal boolean
+# Type: boolean
+# Required: false
+--boolean | -b | --no-boolean
+
+# What: How many times to output text
+# Type: numeric
+# Required: false
+# Allowed Inputs: [1, 2, 3, 4, 5]
+--count
+
+```
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+> AutoGenerateted by [ThorEnhance](https://github.com/matt-taylor/thor_enhance) <br>
+> Regenerate readme files with: thor_enhance thor_enhance_autogenerate --apply
+

data/generated_readme/commands/sub/Readme.md

@@ -0,0 +1,37 @@
+# Subcommand For Sample Class
+
+
+
+## Description
+Thor sub command validation for thor enhance
+
+```bash
+# Base command for `sub`
+thor_enhance sub <options>
+```
+
+
+
+
+
+
+
+### [Innard command for Subtask Subcommand](innard.md)
+
+
+Wow, This longer description will take precedence over the desc above. This is what will be shown in the readme autogenerated page. Try me out!
+
+```bash
+thor_enhance sub innard <options>
+thor_enhance sub innard --count 5
+thor_enhance sub innard --count 35
+```
+
+
+
+
+---
+
+> AutoGenerateted by [ThorEnhance](https://github.com/matt-taylor/thor_enhance) <br>
+> Regenerate readme files with: thor_enhance thor_enhance_autogenerate --apply
+

data/generated_readme/commands/sub/innard.md

@@ -0,0 +1,46 @@
+# Innard Command For Subtask Subcommand
+
+Source code for this command can be found at: [ThorEnhance::Sample::SubCommand#innard](/lib/thor_enhance/sample.rb#L20)
+
+## Description
+Wow, This longer description will take precedence over the desc above. This is what will be shown in the readme autogenerated page. Try me out!
+
+```bash
+# Base command for `innard`
+thor_enhance sub innard <options>
+```
+
+## When Should I Use This?
+
+Use sub command task to validate that subocommands work as expected
+
+
+## Deprecation warning
+This command will get deprecated in the next major version
+
+
+---
+
+## Examples
+
+```bash
+# Innard sub command with a count of 5
+thor_enhance sub innard --count 5
+```
+
+```bash
+# Innard sub command with a count of 35
+thor_enhance sub innard --count 35
+```
+
+
+
+
+
+
+
+---
+
+> AutoGenerateted by [ThorEnhance](https://github.com/matt-taylor/thor_enhance) <br>
+> Regenerate readme files with: thor_enhance thor_enhance_autogenerate --apply
+

data/lib/thor_enhance/autogenerate/command.rb

@@ -13,17 +13,21 @@ module ThorEnhance
       AGGREGATE_OPTIONS_ERB = "#{File.dirname(__FILE__)}/templates/aggregate_options.rb.erb"
       AGGREGATE_OPTIONS_TEMPLATE = ERB.new(File.read(AGGREGATE_OPTIONS_ERB))
 
+      CLASS_OPTIONS_ERB = "#{File.dirname(__FILE__)}/templates/class_options.rb.erb"
+      CLASS_OPTIONS_TEMPLATE = ERB.new(File.read(CLASS_OPTIONS_ERB))
+
       FOOTER_ERB = "#{File.dirname(__FILE__)}/templates/footer.rb.erb"
       FOOTER_TEMPLATE = ERB.new(File.read(FOOTER_ERB))
 
-      attr_reader :leaf, :name, :basename, :child_commands, :parent
+      attr_reader :root, :leaf, :name, :basename, :child_commands, :parent
 
-      def initialize(leaf:, name:, basename:, parent: nil)
+      def initialize(leaf:, name:, basename:, root: , parent: nil)
         @leaf = leaf
         @name = name
         @basename = basename
         @child_commands = []
         @parent = parent
+        @root = root
         initialize_children!
       end
 
@@ -31,42 +35,68 @@ module ThorEnhance
         return unless children?
 
         @child_commands = leaf.children.map do |name, child_leaf|
-          self.class.new(leaf: child_leaf, name: name, basename: basename, parent: self)
+          self.class.new(root: root, leaf: child_leaf, name: name, basename: basename, parent: self)
         end
       end
 
       def method_options
         @method_options ||= begin
           _options = options.map { |name, option| Option.new(name: name, option: option) }
+          _options = _options.group_by { _1.readme_type }
+          unless _options.empty?
+            _options.delete(ThorEnhance.configuration.autogenerated_config.readme_skip_key)
+          end
 
-          _options.group_by { _1.readme_type }
+          _options
         end
       end
 
       def command_erb
         @command_erb ||= begin
           params = {
+            all_bases: all_bases,
             basename_string: basename_string,
             children_descriptors: children_descriptors,
+            class_options_erb: class_options_erb,
             command: command,
+            command_source: command_source,
             custom_headers: custom_headers,
+            default_command: default_command,
+            default_command_string: default_command_string,
             description: description,
             drawn_out_examples: drawn_out_examples,
             footer_erb: footer_erb,
             headers: headers,
             method_options_erb: method_options_erb,
             parent_basename_string: parent_basename_string,
+            preferred_basename_string: preferred_basename_string,
             title: title,
           }
           COMMAND_TEMPLATE.result_with_hash(params)
         end
       end
 
+      def command_source
+        # if children exists, it is a subcommand
+        # source location for a command does not accurately find the correct source
+        # Return nil and skip output
+        return nil if children?
+
+        file, line = leaf.base.instance_method(name).source_location
+        # This value returns the length of the root up to generated_readme
+        # This allows us to understand how many directories to remove from the local `source_location`
+        remove_length = root.split("/")[0..-2].length
+
+        # this will return the relative location of the command source line
+        relative_source = file.split("/")[remove_length..-1]
+        relative_link = "/#{relative_source.join("/")}#L#{line}"
+        "Source code for this command can be found at: [#{leaf.base.name}##{name}](#{relative_link})"
+      end
+
       def footer_erb
         @footer_erb ||=  begin
-          regenerate_single_command = "#{parent_basename_string} thor_enhance_autogenerate --command #{command.usage} --apply"
           regenerate_thor_command = "#{basename} thor_enhance_autogenerate --apply"
-          FOOTER_TEMPLATE.result_with_hash({ regenerate_single_command: regenerate_single_command, regenerate_thor_command: regenerate_thor_command })
+          FOOTER_TEMPLATE.result_with_hash({ regenerate_thor_command: regenerate_thor_command })
         end
       end
 
@@ -92,8 +122,36 @@ module ThorEnhance
         @method_options_erb ||= AGGREGATE_OPTIONS_TEMPLATE.result_with_hash({ method_options: method_options })
       end
 
+      def class_options_erb
+        @class_options_erb ||= begin
+          if class_options.empty?
+            nil
+          else
+            CLASS_OPTIONS_TEMPLATE.result_with_hash({ method_options_text_array: class_options.map(&:template_text) })
+          end
+        end
+      end
+
+      def class_options
+        leaf.base.class_options.map do |name, class_option|
+          class_option.hide ? nil : Option.new(name: name, option: class_option)
+        end.compact
+      end
+
       def basename_string
-        "#{parent_basename_string} #{command.usage}"
+         "#{parent_basename_string} #{command.usage}"
+      end
+
+      def default_command_string
+        parent_basename_string if name == default_command
+      end
+
+      def all_bases
+        [default_command_string, basename_string].compact
+      end
+
+      def preferred_basename_string
+        default_command_string || basename_string
       end
 
       def parent_basename_string
@@ -158,13 +216,23 @@ module ThorEnhance
       end
 
       def title
-        command.title || command.usage
+        command.title&.dig(:input) || command.usage
       end
 
       def self_for_root
         params_for_child(self)
       end
 
+      def default_command
+        if children?
+          leaf.base.subcommand_classes[name].default_task
+        else
+          leaf.base.default_task
+        end
+      rescue
+        nil
+      end
+
       private
 
       def custom_headers
@@ -207,19 +275,45 @@ module ThorEnhance
       end
 
       def children_descriptors
-        child_commands.map { params_for_child(_1) }
+        default = child_commands.map { params_for_child(_1) }.select { _1[:default_command] }
+        not_default = child_commands.map { params_for_child(_1) }.select { !_1[:default_command] }
+        default + not_default
       end
 
       def params_for_child(child)
+        relative_link = find_iterations_back(child)
+        link = child.relative_readme_path[relative_link..-1].join("/")
         {
-          title: child.title,
-          link: child.relative_readme_path[-1],
-          description: child.description,
+          all_bases: child.all_bases,
           basename_string: child.basename_string,
+          default_command: child.name == default_command,
+          default_command_string: default_command_string,
+          description: child.description,
           examples: child.drawn_out_examples(with_desc: false) || [],
+          link: link,
+          preferred_basename_string: child.preferred_basename_string,
+          title: child.title,
         }
       end
 
+      def find_iterations_back(child)
+        # if parent is not present, then start from 0th position
+        return 0 if child.parent.nil?
+        # When there is no children, just take the last
+        return -1 unless child.leaf.children?
+
+        # when parent exists, find out how many parents there are
+        # Return how many parents there are
+        iterations = -1
+        temp_child = child
+        while temp = temp_child.parent
+          iterations -= 1
+          temp_child = temp_child.parent
+        end
+
+        iterations
+      end
+
       def headers
         (command.header || []).map { _1[:arguments][:kwargs] }
       end
@@ -233,7 +327,7 @@ module ThorEnhance
       end
 
       def options
-        command.options
+        command.options.reject { |name, option| option.hide}
       end
     end
   end

data/lib/thor_enhance/autogenerate/configuration.rb

@@ -61,9 +61,9 @@ module ThorEnhance
       def readme(required: nil, empty_group: :unassigned, skip_key: DEFAULT_SKIP_KEY, enums: [:important, :advanced, skip_key.to_sym].compact)
         ThorEnhance::Configuration.allow_changes?
 
-        @readme_empty_group = empty_group
+        @readme_empty_group = empty_group.to_sym
         @readme_skip_key = skip_key
-        @readme_enums = enums.map(&:to_sym)
+        @readme_enums = enums.map(&:to_sym) << empty_group.to_sym
         required = required.nil? ? @required : required
         configuration[:add_option_enhance][:readme] = { enums: enums, required: required }
       end

data/lib/thor_enhance/autogenerate/templates/aggregate_options.rb.erb

@@ -4,9 +4,8 @@
   <summary> <h3> <%= group_name.to_s.titlecase %> options </h3> </summary>
 
 ```bash
-<%= method_options[group_name].map { _1.template_text }.join("\n") %>
+<%= method_options[group_name].map { "#{_1.template_text}\n" }.join("\n") %>
 ```
 
 </details>
-
 <% end %>

data/lib/thor_enhance/autogenerate/templates/class_options.rb.erb

@@ -0,0 +1,7 @@
+<details>
+  <summary> <h3> Class Options </h3> </summary>
+
+```bash
+<%= method_options_text_array.join("\n\n") %>
+```
+</details>

data/lib/thor_enhance/autogenerate/templates/command.rb.erb

@@ -1,11 +1,13 @@
 # <%= title.to_s.titlecase %>
 
+<%= command_source %>
+
 ## Description
 <%= command.long_description || command.description %>
 
 ```bash
 # Base command for `<%= command.usage %>`
-<%= basename_string %>
+<%= all_bases.join(" <options> \n") %> <options>
 ```
 
 <%= custom_headers %>
@@ -36,14 +38,17 @@
 <% children_descriptors.each do |child| %>
 ### [<%= child[:title]%>](<%= child[:link] %>)
 
+<%= "**Default Command** <br>" if child[:default_command] %>
 <%= child[:description] %>
 
 ```bash
-<%= child[:basename_string]%> <options>
+<%= child[:all_bases].join(" <options> \n") %> <options>
 <%= child[:examples].map { _1 }.join("\n") %>
 ```
 <% end %>
 <% end %>
+
+<%= class_options_erb %>
 ---
 
 <%= footer_erb %>

data/lib/thor_enhance/autogenerate/templates/footer.rb.erb

@@ -1,3 +1,2 @@
 > AutoGenerateted by [ThorEnhance](https://github.com/matt-taylor/thor_enhance) <br>
-> Regenerate file with: <%= regenerate_single_command %> <br>
-> Regenerate all files with: <%= regenerate_thor_command %>
+> Regenerate readme files with: <%= regenerate_thor_command %>

data/lib/thor_enhance/autogenerate.rb

@@ -30,16 +30,24 @@ module ThorEnhance
         end
 
       command_structure = leaves.map do |name, leaf|
-        parent = Command.new(name: name, leaf: leaf, basename: basename)
+        Command.new(name: name, leaf: leaf, basename: basename, root: options.generated_root)
       end
 
       # flatten_children returns all kids, grandkids, great grandkids etc of the commands returned from the above mapping
       youthful_kids = command_structure.map(&:flatten_children).flatten
+      children_result = save_generated_readmes!(commands: youthful_kids, generated_root: options.generated_root, apply: options.apply)
+      return children_result if children_result[:status] != :pass
 
-      # this is a flat map of the entire family tree. Each node knows where it is so we can flatten it
-      family_tree = command_structure + youthful_kids
+      root_result = save_generated_readmes!(commands: command_structure, generated_root: options.generated_root, apply: options.apply)
+      return root_result if root_result[:status] != :pass
 
-      save_generated_readmes!(commands: family_tree, generated_root: options.generated_root, apply: options.apply)
+      self_for_roots = root_result[:saved_status].collect { _1[:self_for_root] }
+      # Add saved results from the children
+      root_result[:saved_status] += children_result[:saved_status]
+      # Add root savior saved results
+      root_result[:saved_status] << root_savior!(basename: basename, apply: options.apply, full_root: root_result[:full_root], self_for_roots: self_for_roots)
+
+      root_result
     end
 
     def save_generated_readmes!(commands:, generated_root:, apply:)
@@ -48,17 +56,18 @@ module ThorEnhance
       saved_status = commands.map do |command|
         command.save_self!(root: full_root, apply: apply)
       end
-      self_for_roots =  saved_status.collect { _1[:self_for_root] }
-      saved_status << root_savior!(apply: apply, full_root: full_root, self_for_roots: self_for_roots)
 
-      { status: :pass, saved_status: saved_status }
+      { status: :pass, full_root: full_root, saved_status: saved_status }
     end
 
-    def root_savior!(full_root:, self_for_roots:, apply:)
+    def root_savior!(basename:, full_root:, self_for_roots:, apply:)
       full_path = "#{full_root}/Readme.md"
-      root_erb_result = self_for_roots.map do |root_child|
+      regenerate_thor_command = "#{basename} thor_enhance_autogenerate --apply"
+      footer = ThorEnhance::Autogenerate::Command::FOOTER_TEMPLATE.result_with_hash({ regenerate_thor_command: regenerate_thor_command })
+
+      root_erb_result = (self_for_roots.map do |root_child|
         ROOT_TEMPLATE.result_with_hash({ root_child: root_child })
-      end.join("\n")
+      end + [footer]).join("\n")
 
       FileUtils.mkdir_p(full_root)
       if File.exist?(full_path)

data/lib/thor_enhance/command_method.rb

@@ -100,7 +100,10 @@ module ThorEnhance
               # The value is nil/unset
 
               # If we have disabled required operations, go ahead and skip this
-              next if ::Thor.__thor_enhance_definition == ThorEnhance::CommandMethod::ClassMethods::THOR_ENHANCE_DISABLE
+              if ::Thor.__thor_enhance_definition == ThorEnhance::CommandMethod::ClassMethods::THOR_ENHANCE_DISABLE
+                ::Thor.__thor_enhance_definition_ignored << meth.to_sym
+                next
+              end
 
               # Skip if the expected command method was not required
               next unless object[:required]
@@ -135,8 +138,11 @@ module ThorEnhance
         @__thor_enhance_definition_stack ||= []
       end
 
-      private
+      def __thor_enhance_definition_ignored
+        @__thor_enhance_definition_ignored ||= []
+      end
 
+      private
 
       def __thor_enhance_validate_arguments!(object, input, args, kwargs)
         expected_arity = object.dig(:arity)

data/lib/thor_enhance/sample.rb

@@ -10,6 +10,7 @@ module ThorEnhance
       thor_enhance_allow!
 
       desc "innard", "Validate that a subcommand works. This description can be as long as you want it to be."
+      title "Innard command for Subtask Subcommand"
       long_desc "Wow, This longer description will take precedence over the desc above. This is what will be shown in the readme autogenerated page. Try me out!"
       example "innard --count 5", desc: "Innard sub command with a count of 5"
       example "innard --count 35", desc: "Innard sub command with a count of 35"
@@ -20,6 +21,7 @@ module ThorEnhance
     end
 
     desc "sub", "Thor sub command validation for thor enhance"
+    title "Subcommand for sample class"
     subcommand "sub", SubCommand
 
     desc "sample", "This Sample command does a lot of nothing"
@@ -33,8 +35,24 @@ module ThorEnhance
     example "sample", desc: "yo yo ma"
     example "sample --boolean", desc: "yo yo ma"
     method_option :boolean, aliases: "-b", type: :boolean, desc: "Just a normal boolean", readme: :important
+    method_option :count, type: :numeric, enum: [1,2,3,4,5], default: 1, desc: "How many times to output text", readme: :important
     def sample
-      Kernel.puts "Executed Sample method"
+      options[:count].times { Kernel.puts "Executed Sample method" }
+    end
+
+    desc "autobots", "Command outputs what Optimus prime is thniking"
+    when_should_i_use_this <<~README
+    Do you ever feel angry about how powerful the Decepticons are compared to the Autobots? It seems unfair.
+    Trust...The autobots agree.
+    README
+    example "sample", desc: "yo yo ma"
+    example "sample --boolean", desc: "yo yo ma"
+    method_option :bumble, aliases: "-b", type: :boolean, desc: "Enable bumblee bee flag", readme: :important
+    def autobots
+      Kernel.puts "Optimus prime requires megatron must be eliminated"
+      if options.bumble
+        Kernel.puts "Bumble bee agrees"
+      end
     end
   end
 end

data/lib/thor_enhance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ThorEnhance
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thor_enhance
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-19 00:00:00.000000000 Z
+date: 2023-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -70,12 +70,18 @@ files:
 - examples/basic_example.md
 - examples/example_with_subcommand.md
 - examples/hooks.md
+- generated_readme/commands/Readme.md
+- generated_readme/commands/autobots.md
+- generated_readme/commands/sample.md
+- generated_readme/commands/sub/Readme.md
+- generated_readme/commands/sub/innard.md
 - lib/thor_enhance.rb
 - lib/thor_enhance/autogenerate.rb
 - lib/thor_enhance/autogenerate/command.rb
 - lib/thor_enhance/autogenerate/configuration.rb
 - lib/thor_enhance/autogenerate/option.rb
 - lib/thor_enhance/autogenerate/templates/aggregate_options.rb.erb
+- lib/thor_enhance/autogenerate/templates/class_options.rb.erb
 - lib/thor_enhance/autogenerate/templates/command.rb.erb
 - lib/thor_enhance/autogenerate/templates/footer.rb.erb
 - lib/thor_enhance/autogenerate/templates/option.rb.erb