mvn2 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b39f2e1b31e73e8e0e46b2933b0a99a61a894f15
-  data.tar.gz: 8910e23d49347ba7beb82506f0e3fa34ebbecee9
+  metadata.gz: 6d175cc8ec8383e2dabc52b382c7da7896e98f5f
+  data.tar.gz: 935f582ce639c4cf457fc53f22cb02479c14ea35
 SHA512:
-  metadata.gz: 9f6c81c323f67a021138a7fcd5a655d6c660331942cedb07981aebc85b4c2a96f33325c21912e1f530a8d5f27374e94bab229c0a48acdfe378a3f77769b2477f
-  data.tar.gz: bd83204629ee2518a77280f9e01567e1235ad3fb4f6cad43ada9aebc3b6e22e3508d8f81fdb5d8e0591ae9d8f963ce89c0e63d38a7ae615526542089adaf1ba0
+  metadata.gz: 67b6338088188ac8b94e9e0fc8500c6157b866df54b87d8db4140769d663ee7931e0c32c2109e41dc228eb44d3f3d97bb72ba933a5b22182cbc19b15986404c6
+  data.tar.gz: f187506c332451d0064851d6610a8240c65f5df2085096be8391cb563e4489f88dd0dec7d376808c28672aa9e871be108fd56ff2620fc95589b18b774cfd1956

data/README.md

@@ -30,7 +30,7 @@ Please see the plugin folder in this gem for examples of how to use the plugin s
 * `-h` or `--hide-between` to hide the output between the end of test results (the line starting with "Tests run:") and the next trigger line
 * `-w` or `--show-average` to show the average(s) before and after the build (average tracking must be enabled) (default is to not show averages)
 * `-b` or `--block-update` to block the average feature from updating the file(s)
-* `-v` or `--override-colors` to override the colors with the ones configured by the [colorconfig][colorconfig] script
+* `-v` or `--override-colors` to override the colors with the ones configured by the `colorconfig` script
 * `-j` or `--show-projects` to show the `Building <project>` lines when outputting
 * `--run-before CMD` to run `CMD` before calling the maven build
 * `--run-after CMD` to run `CMD` after finishing the maven build
@@ -51,68 +51,9 @@ The following is my initial documentation of the plugin system.  It may be impro
 
 Version 2.0.0 introduces a plugin system.  Other gems can add plugins to mvn2.  The files have to match the pattern `mvn2/plugin/*.plugin.rb` in your gem's `lib/` folder.  If you do that, when the gem is installed, `mvn2` will automatically pick up on it and load it.
 
-Two examples of this are my gems `colorconfig` and `mvn2-say`.
+Two examples of this are my gems `colorconfig` (https://rubygems.org/gems/colorconfig) and `mvn2-say` (https://rubygems.org/gems/mvn2-say).
 
-The `Mvn2::Plugin` module is used for registering a plugin of a defined type.  It defines the `register` method.  You should use `extend` so that you can define things statically.  There is no need for a `build` method because it automatically adds the plugins at the time you call the method.
-
-Here is an example:
-
-```ruby
-register :option, sym: :timer, names: %w(-t --timer), desc: 'display a timer while the build is in progress'
-```
-
-And another:
-
-```ruby
-register(:before_run, order: 2) { |options|
-  Mvn2::Plugins.set_var :time1, Time.now
-  Mvn2::Plugins.set_var :thread, options[:timer] ? Thread.new {
-    start_time = Mvn2::Plugins.get_var :time1
-    while true
-      print "\r#{get_timer_message(start_time, Time.now)}"
-      sleep(0.05)
-    end
-  } : nil
-}
-```
-
-The `register` method takes a first parameter of the plugin type identifier, followed by an optional (but probably necessary) hash of options, and an optional block (usable with most built-in plugin types, required by some).
-
------
-
-If you want to define a new plugin type, you can extend the `Mvn2::PluginType`.  This defines the `register_type` and `register_variable` methods.  Technically, you don't really need to register a variable, but if you want to give it a certain starting value, you will need to register it and pass over the value.  `register_type` takes a first parameter of the plugin type identifier, followed by a block.  The block will always take a first parameter of the list of instances, followed by any additional parameters passed to the plugin when it is called.  The block has the task of taking the list of plugin instances and turning it into whatever result the plugin is supposed to have.
-
-Here is an example:
-
-```ruby
-register_type(:command_flag) { |list|
-  options = Mvn2::Plugins.get_var :options
-  flags   = []
-  list.each { |flag|
-    if flag[:block].nil?
-      flags << " #{flag[:options][:flag]}" if flag[:options].has_key?(:option) && options[flag[:options][:option]] == (flag[:options].has_key?(:value) ? flag[:options][:value] : true)
-    else
-      flag[:block].call(options, flags)
-    end
-  }
-  flags.join
-}
-```
-
------
-
-You might notice in the second plugin example, as well as the plugin type example, methods are called on `Mvn2::Plugins`.  This is the class that stores all of the plugins and types.  It has various methods, but the ones involved in making a plugin are:
-
-* `Mvn2::Plugins.get(type, *args)`
-    * Gets the result of a plugin type.  The first parameter is the plugin type identifier, followed by any additional arguments the plugin type takes.
-* `Mvn2::Plugins.get_var(name)`
-    * Gets a single variable by name
-* `Mvn2::Plugins.get_vars(*names)`
-    * Gets a list of variables by name.  Useful for getting a lot of variables in one line.
-* `Mvn2::Plugins.set_var(name, value)`
-    * Sets a single variable of the given name to the given value.
-* `Mvn2::Plugins.set_vars(vars = {})`
-    * Sets a list of variables to the values specified.  It use a hash format, so you can do something like `Mvn2::Plugins.set_vars found: true, info_line_last: false`
+Please see my `everyday-plugins` (https://github.com/henderea/everyday-plugins) gem for more info on plugins.
 
 If you come up with a plugin, feel free to publish it on your own (that's what the plugin system is designed to support).  If you think it should be part of the built-in plugin set, you can always file a pull request.
 

data/bin/mvn2

@@ -14,8 +14,8 @@ include EverydayPlugins
 
 Plugins.load_plugins 'mvn2'
 
-#abcd   h jkl n p  stuvw y 012
-#    efg i   m o qr     x z   3456789
+#abcd   h jkl n p  stuvw y 012      9
+#    efg i   m o qr     x z   345678
 
 class MyOptions
   extend OptionUtil
@@ -23,6 +23,7 @@ class MyOptions
   default_settings toggle: true
 
   defaults_option 'mvn2-defaults.yaml', %w(-1 --set-defaults), desc: 'set the defaults so you can just run mvn2 without any parameters (local to each folder)'
+  global_defaults_option '~/mvn2-defaults.yaml', %w(-2 --set-global-defaults), desc: 'set the global defaults so you can just run mvn2 without any parameters (global per user)'
 
   help_option ['--help'], desc: 'print out this help'
 end
@@ -34,7 +35,7 @@ MyOptions.parse!
 
 options = MyOptions.options
 
-Plugins.set_var(:options, options)
+Plugins.set_var :options, options
 
 Signal.trap('SIGINT') {
   puts "\nBuild Canceled\n\n"

data/lib/mvn2/plugin.rb

@@ -196,7 +196,6 @@ module Mvn2
   end
   class ColorTypes
     extend PluginType
-    extend TypeHelper
 
     DEFAULT_COLOR_OPTS = {
         time:    {

data/lib/mvn2/version.rb

@@ -1,3 +1,3 @@
 module Mvn2
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/mvn2.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'
 
-  spec.add_dependency 'everyday-cli-utils', '>= 1.3.0'
+  spec.add_dependency 'everyday-cli-utils', '>= 1.5.0'
   spec.add_dependency 'everyday-plugins', '>= 1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mvn2
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Eric Henderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: everyday-plugins
   requirement: !ruby/object:Gem::Requirement
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Maven helper