everyday_thor_util 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bd362d79f59609423afdbfebeac5f272bc9c88a
-  data.tar.gz: fad77f8f90ee22429cfae4bbee5812f00be1222e
+  metadata.gz: d2ac4f3f244fb40340d7190bb4021f8d56491c49
+  data.tar.gz: c89b4f721f28e61423298f3327fc8abaee29d455
 SHA512:
-  metadata.gz: b1f52cde798d3b05be01dd81c46b9b0e482fe4031c7a8e64d6a0e667d7ce09b8447ee59f27f5b83c7e8545207a04c05bd177679517471736a2b68f514d080066
-  data.tar.gz: df0098141f9e037ee8defb79131ee2bd63643a8ca60ce931d56531c0d332f1b84c28e0015118393a05054d6825fbff47edbf10678b885be25ec2bd680a730c7a
+  metadata.gz: 91e8839347cc288aa41f8d87e86f3d6d1ce6fe026ae037bf67e9303ea3a78f8ce731c902c573cc0df0738f19a302b8097e9e8e8b5b2c77c9b2abc5e8cbb0c83a
+  data.tar.gz: d7bf6ef60980e017dce1c1cd2dc731aaa435df512a0d61b3792d079b664dfe115563491b6510c6a52ff366ab928119b928f90e7e8293a791b7efb3f6bd3de001

data/README.md

@@ -1,6 +1,6 @@
 # EverydayThorUtil
 
-TODO: Write a gem description
+Two parts: `everyday_thor_util/thor-fix` patches `Thor` with a fix for help messages with multi-level command nesting not showing the full command string. `everyday_thor_util/plugin-helper` provides `everyday-plugins` types for `Thor` commands and `Thor` flags
 
 ## Installation
 
@@ -18,11 +18,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+###Thor patch
+An issue I found with `Thor` is that when you have subcommands of a subcommand, the help messages mess up and just show the script name and the last subcommand.  `everyday_thor_util/thor-fix` provides a patch for this issue that will make sure that the messages display the full chain of commands by storing the parent command and referencing it (recursively) when getting the banner.  If you just want the patch, use
+```ruby
+require 'everyday_thor_util/thor-fix'
+```
+instead of requiring the base package (which loads the `plugin-helper` module too)
+
+###Plugin Helper
+My gem `everyday-plugins` is something I use for my own projects for allowing a plugin-based structure that can support loading plugins from other gems that provide them in the right way.  The `everyday_thor_util/plugin-helper` module will provide you with a method to register types for `Thor` commands, flags, and helpers.
+
+Here's an example (from my `mvn2chain` gem; note that I'm assuming you have already included `everyday-plugins` properly):
+```ruby
+require 'everyday_thor_util'
+EverydayThorUtil::SubCommandTypes.def_types(:command_ids, :flag, :command, :helper)
+register(:command, id: :path, parent: nil, name: 'path', short_desc: 'path', desc: 'print out the path of the current file') { puts __FILE__ }
+
+register(:command, id: :dep, parent: nil, name: 'dep', aliases: %w(deps dependency dependencies), short_desc: 'dep SUBCOMMAND ARGS...', desc: 'alter the stored dependencies')
+
+register(:command, id: :dep_add, parent: :dep, name: 'add', aliases: %w(register reg), short_desc: 'add DEP_ID DEP', desc: 'add a dependency to the list') { |dep_id, dep|
+  #contents excluded for brevity
+}
+
+register :flag, name: :force, aliases: ['-f'], parent: :dep_add, type: :boolean, desc: 'force the dependency to be added even if the provided directory does not contain a pom.xml or the dependency ID is already in use'
+
+register(:helper, name: 'chain_args', parent: nil) { |dep_id, arg_hash, exclude|
+  #contents excluded for brevity
+}
+
+root_command = Class.new(Thor)
+Plugins.get :command, root_command, nil
+
+root_command.start(ARGV)
+```
+
+A parent of `nil` means the parent is the root command.  Otherwise, use the `:id` parameter of the parent as the value of `:parent`.  For helpers, you can provide `global: true` instead of a parent if you want it to be available in all `Thor` command classes.  Command aliases actually duplicate the command and any children because I don't know of a `Thor` feature that lets you provide command aliases.  It will automatically replace the value provided for `:name` with the alias name in the `:short_desc` parameter that is used for the copied commands.
+
+####Define Helper
+The `plugin-helper` package contains a method for defining a pre-made helper function.  Currently, the only one I have created is `print_info`, but more may be added as I come up with them.
+
+Here is an example of `print_info` (note that I'm assuming you have already included `everyday-plugins` properly):
+
+```ruby
+require 'everyday_thor_util'
+EverydayThorUtil::SubCommandTypes.def_types(:command_ids, :flag, :command, :helper)
+EverydayThorUtil::SubCommandTypes.def_helper(:helper, :print_info)
+register(:command, id: :dep_add, parent: :dep, name: 'add', aliases: %w(register reg), short_desc: 'add DEP_ID DEP', desc: 'add a dependency to the list') { |dep_id, dep|
+  print_info(__method__) { |p| eval p }
+}
+```
+
+Now, if you run `mvn2chain dep add -f my_id /path/to/my/id`, it will print
+
+	command: mvn2chain dep add
+	parent_options: {"force"=>true}
+	options: {"force"=>true}
+	dep_id: my_id
+	dep: /path/to/my/id
+
+If you leave off the block passed to the `print_info` helper, it will not print out the parameter info.  This is because the scope change causes it to lose reference to the variables, meaning that in order to show the parameter values, it has to be given a way to turn the parameter name into a value.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/everyday_thor_util/fork )
+1. Fork it ( https://github.com/henderea/everyday_thor_util/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/everyday_thor_util/plugin-helper.rb

@@ -3,15 +3,13 @@ require 'everyday-plugins'
 include EverydayPlugins
 require 'thor'
 
-class Thor
-  class << self
-    def create_method(name, &block)
-      self.send(:define_method, name, &block)
-    end
+class Module
+  def create_method(name, &block)
+    self.send(:define_method, name, &block)
+  end
 
-    def dup_method(new_name, old_name)
-      self.send(:alias_method, new_name, old_name)
-    end
+  def dup_method(new_name, old_name)
+    self.send(:alias_method, new_name, old_name)
   end
 end
 
@@ -106,7 +104,7 @@ module EverydayThorUtil
       end
 
       def def_helper(helper_symbol, which_helper, method_name = nil, global = true, parent = nil)
-        case(which_helper)
+        case (which_helper)
           when :print_info
             register(helper_symbol, name: (method_name || 'print_info'), global: global, parent: parent) { |meth, &eval_block|
               meth_obj = self.method(meth)
@@ -119,6 +117,37 @@ module EverydayThorUtil
             puts "Unknown helper #{which_helper}"
         end
       end
+
+      def add_debugging(base, option_sym, env_sym)
+        methods = base.commands.keys - base.subcommands
+        base.class_eval {
+          methods.each { |method_name|
+            original_method = instance_method(method_name)
+            no_commands {
+              define_method(method_name) { |*args, &block|
+                debug = if options.has_key?(option_sym.to_s) || options.has_key?(option_sym.to_sym)
+                          options[option_sym.to_sym]
+                        else
+                          d = ENV[env_sym.to_s]
+                          d == '1' || d == 1 || d == 'true' || d == 't'
+                        end
+                if debug
+                  puts "command: #{self.class.basename2} #{__method__.to_s}"
+                  puts "parent_options: #{parent_options.inspect}"
+                  puts "options: #{options.inspect}"
+                  original_method.parameters.each_with_index { |p, i| puts "#{p[1].to_s}: #{args[i]}" }
+                end
+                begin
+                  original_method.bind(self).call(*args, &block)
+                rescue ArgumentError => e
+                  base.handle_argument_error(base.commands[method_name], e, args, original_method.arity)
+                end
+              }
+            }
+          }
+        }
+        base.subcommand_classes.values.each { |c| add_debugging(c, option_sym, env_sym) }
+      end
     end
   end
 end

data/lib/everyday_thor_util/version.rb

@@ -1,3 +1,3 @@
 module EverydayThorUtil
-  VERSION = '1.4.1'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everyday_thor_util
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Eric Henderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler