mercenary 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9ebb7e735aa1147cbcc69420fa3a934830c0415
-  data.tar.gz: 120e555e1d05e2af4e674b42cd9143195310b92e
+  metadata.gz: 3c649528973138a967d8f6cafe92e65ae25a4a95
+  data.tar.gz: 3a7b3477db81d199a956536247c0c0e6bd44fda9
 SHA512:
-  metadata.gz: becf09d037cb3f6475239595c42deba5c89791ccc13f5d2c622d1a88769d91e89c7da2685f1c238f2e41d0308b81cd81679f7ac7352fffa93d36cf7d989a7975
-  data.tar.gz: 2ca3a69a6039ab31343002957dec0c8753181c17817d3d6b59afaa7dc6186e3d78f501979ffae98e3ecb4ba730bdbd46e4d8d5974f653f25fedf603fc9c75cde
+  metadata.gz: 906d1c04846f347c39bed714774527ccc7173b80e15799a69852368003b3d720da0e3dd0134a6069d7e353fa1c77205ca3e29cec731d0172b44377157b664bee
+  data.tar.gz: 6158035bcfa8721c4494498daba38e346d653484b20d29574bda9913dd8fd2f98cfee754227aa28c806a955a627582e3036b2df99819640784dff354152cee9b

data/History.markdown

@@ -8,6 +8,17 @@
 
 ### Development Fixes
 
+## 0.3.1 / 2014-02-21
+
+### Minor Enhancements
+
+* Add `-t/--trace` to list of options in help message (#19)
+
+### Bug Fixes
+
+* `Mercenary::Option` now accepts return values in the form of Class constants
+  (#22)
+
 ## 0.3.0 / 2014-02-20
 
 ### Major Enhancements

data/README.md

@@ -22,22 +22,26 @@ Or install it yourself as:
 
 ## Usage
 
+Creating programs and commands with Mercenary is easy:
+
 ```ruby
 Mercenary.program(:jekyll) do |p|
   p.version Jekyll::VERSION
   p.description 'Jekyll is a blog-aware, static site generator in Ruby'
+  p.syntax "jekyll <subcommand> [options]"
 
   p.command(:new) do |c|
-    c.syntax "jekyll new PATH"
+    c.syntax "new PATH" # do not include the program name or super commands
     c.description "Creates a new Jekyll site scaffold in PATH"
+    c.option 'blank', '--blank', 'Initialize the new site without any content.'
 
     c.action do |args, options|
-      Jekyll::Commands::New.process(args)
+      Jekyll::Commands::New.process(args, blank: options['blank'])
     end
   end
 
   p.command(:build) do |c|
-    c.syntax "jekyll build [options]"
+    c.syntax "build [options]"
     c.description "Builds your Jekyll site"
 
     c.option 'safe', '--safe', 'Run in safe mode'
@@ -49,28 +53,23 @@ Mercenary.program(:jekyll) do |p|
     end
   end
 
-  p.command(:import) do |c|
-    c.syntax "jekyll import <platform> [options]"
-    c.description "Import your old blog to Jekyll"
-
-    c.action do |args, options|
-      begin
-        require "jekyll-import"
-      rescue
-        msg  = "You must install the 'jekyll-import' gem before continuing.\n"
-        msg += "* Do this by running `gem install jekyll-import`.\n"
-        msg += "* Or if you need root privileges, run `sudo gem install jekyll-import`."
-        abort msg
-      end
-
-      Jekyll::Commands::Import.process(args.first, options)
-    end
+  # Bring in command bundled in external gem
+  begin
+    require "jekyll-import"
+    JekyllImport.init_with_program(p)
+  rescue LoadError
   end
 
   p.default_command(:build)
 end
 ```
 
+All commands have the following default options:
+
+- `-h/--help` - show a help message
+- `-v/--version` - show the program version
+- `-t/--trace` - show the full backtrace when an error occurs
+
 ## Contributing
 
 1. Fork it

data/lib/mercenary/command.rb

@@ -188,6 +188,7 @@ module Mercenary
     def add_default_options(opts)
       option 'show_help', '-h', '--help', 'Show this message'
       option 'show_version', '-v', '--version', 'Print the name and version'
+      option 'show_backtrace', '-t', '--trace', 'Show the full backtrace when an error occurs'
       opts.on("-v", "--version", "Print the version") do
         puts "#{name} #{version}"
         abort

data/lib/mercenary/option.rb

@@ -1,24 +1,40 @@
 module Mercenary
   class Option
-    attr_reader :config_key, :description, :switches
+    attr_reader :config_key, :description, :short, :long, :return_type
 
     # Public: Create a new Option
     #
-    # config_key - the key in the config hash to which the value of this option will map
-    # info       - an array containing first the switches, then a description of the option
+    # config_key - the key in the config hash to which the value of this option
+    #              will map
+    # info       - an array containing first the switches, then an optional
+    #              return type (e.g. Array), then a description of the option
     #
     # Returns nothing
     def initialize(config_key, info)
-      @config_key = config_key
-      @description = info.last unless info.last.start_with?("-")
-      set_switches(info.take(info.size - [@description].reject(&:nil?).size))
+      @config_key  = config_key
+      while arg = info.shift
+        begin
+          @return_type = Object.const_get("#{arg}")
+          next
+        rescue NameError
+        end
+        if arg.start_with?("-")
+          if arg.start_with?("--")
+            @long = arg
+          else
+            @short = arg
+          end
+          next
+        end
+        @description = arg
+      end
     end
 
     # Public: Fetch the array containing the info OptionParser is interested in
     #
     # Returns the array which OptionParser#on wants
     def for_option_parser
-      [switches.reject(&:empty?), description].reject{ |o| o.nil? || o.empty? }.flatten
+      [short, long, return_type, description].flatten.reject{ |o| o.to_s.empty? }
     end
 
     # Public: Build a string representation of this option including the
@@ -59,21 +75,12 @@ module Mercenary
       end.all?
     end
 
-    private
-
-    # Private: Set the full switches array, ensuring the first element is the
-    #   short switch and the second element is the long switch
+    # Public: Fetch an array of switches, including the short and long versions
     #
-    # Returns the corrected switches array
-    def set_switches(switches)
-      if switches.size < 2
-        if switches.first.start_with?("--")
-          switches.unshift ""
-        else
-          switches << ""
-        end
-      end
-      @switches = switches
+    # Returns an array of two strings. An empty string represents no switch in
+    # that position.
+    def switches
+      [short, long].map(&:to_s)
     end
 
   end

data/lib/mercenary/version.rb

@@ -1,3 +1,3 @@
 module Mercenary
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/command_spec.rb

@@ -60,7 +60,7 @@ describe(Mercenary::Command) do
       option = Mercenary::Option.new(name, opts)
       command.option name, *opts
       expect(command.options).to eql([option])
-      expect(command.map).to include({option.hash => name})
+      expect(command.map.values).to include(name)
     end
 
     it "knows its full name" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mercenary
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler