bales 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17c462972479f90f386f6ea8b6e5f710ae18262e
-  data.tar.gz: 72374a11afb564934358320e62eb0e69176b3847
+  metadata.gz: 4301c3b933852b3c9cd2f1e66b2adc6c31fa5e7f
+  data.tar.gz: 41e05ffb0f56874d16f38508d038d337a507a0b1
 SHA512:
-  metadata.gz: 44a588c1e833245146d6366abd2e12736bbb019d0ee771833eac545c74a5cca79f75f5ed9e5fbf55a3ccf4827ecd45db71357ed11ba59a35e638dd6db7f33c87
-  data.tar.gz: e54a24cbc39f4a8248a339bf25c5b5cc11e330190887b6adf7d87fc8bc5d47a6b59b78625d91d004e2b6904018325fd3724ea0f116c5393e6da6bb0049804e4b
+  metadata.gz: dbfbacab09a7b0b517f23703fa811106091625006a1e273447a7814464c99702a85c3611442a78b219f3ec81c3ed2287aaca545a079bc2c5660f198592b4f1d5
+  data.tar.gz: 402eb19431e501717fdd54a9202ba898d0865379dda6f689b7609e56ee0f806b34f58d36fdafd5c2b6e6fcbca3c213e99a2ac5e9fc70188f516803dd83f11cea

data/lib/bales/application.rb

@@ -130,21 +130,15 @@ module Bales
       command ||= default_command
       opts, args = command.parse_opts result
       return command, args, opts
-    end
-
-    ##
-    # Parses ARGV (or some other array if you specify one) for a
-    # command to run and its arguments/options, then runs the command.
-    def self.parse_and_run(argv=ARGV)
-      command, args, opts = parse argv
-      run command, *args, **opts
     rescue OptionParser::MissingArgument
       flag = $!.message.gsub("missing argument: ", '')
       puts "#{$0}: error: option needs an argument (#{flag})"
+      puts "Usage: #{command.usage}"
       exit!
     rescue OptionParser::InvalidOption
       flag = $!.message.gsub("invalid option: ", '')
       puts "#{$0}: error: unknown option (#{flag})"
+      puts "Usage: #{command.usage}"
       exit!
     rescue ArgumentError
       raise unless $!.message.match(/wrong number of arguments/)
@@ -154,9 +148,18 @@ module Bales
                              .gsub(")", '')
                              .split(" for ")
       puts "#{$0}: error: expected #{expected} args but got #{received}"
+      puts "Usage: #{command.usage}"
       exit!
     end
 
+    ##
+    # Parses ARGV (or some other array if you specify one) for a
+    # command to run and its arguments/options, then runs the command.
+    def self.parse_and_run(argv=ARGV)
+      command, args, opts = parse argv
+      run command, *args, **opts
+    end
+
     private
 
     def self.parse_command_name(argv)

data/lib/bales/command/help.rb

@@ -13,6 +13,7 @@ class Bales::Command::Help < Bales::Command
       target = basename
     end
 
+    print_usage(target)
     print_summary(target)
     print_options(target)
     print_commands(target)
@@ -109,6 +110,10 @@ class Bales::Command::Help < Bales::Command
     print "Description:\n#{command.description}\n\n"
   end
 
+  def self.print_usage(command)
+    print "Usage: #{command.usage}\n\n"
+  end
+
   def self.print_commands(namespace)
     cmds = commands(namespace)
 

data/lib/bales/command.rb

@@ -93,6 +93,60 @@ module Bales
       end
     end
 
+    ##
+    # Translates the command's class name to a more complete name
+    # passed on the command line, including the subcommand, all
+    # commands leading to it, and the root command.
+    def self.full_name
+      parts = self
+             .name
+             .split('::')
+             .map { |p| p.gsub(/(.)([A-Z])/, '\1-\2').downcase }
+      parts = parts[2..-1].join(' ')
+      "#{$0} #{parts}"
+    end
+
+    ##
+    # Print the command's usage statement.
+    def self.usage
+      usage = []
+
+      # Name
+      usage << full_name
+
+      # Arguments
+      method(:run).parameters.each do |type, name|
+        # We don't handle keys and keyrests, since they're going to be
+        # taken care of once we start dealing with options.
+        case type
+        when :req then usage << "<#{name}>"
+        when :opt then usage << "[<#{name}>]"
+        when :rest then usage << "[<#{name}> ...]"
+        end
+      end
+
+      # Options
+      options.each_pair do |opt, args|
+        case
+        when (args[:type] <= TrueClass or args[:type] <= FalseClass)
+          if args.key?(:short_form)
+            usage << "[(#{args[:long_form]}|#{args[:short_form]})]"
+          else
+            usage << "[#{args[:long_form]}]"
+          end
+        else
+          if args.key?(:short_form)
+            usage << "[(#{args[:long_form]}|#{args[:short_form]}) " \
+                     "<#{args[:arg]}>]"
+          else
+            usage << "[#{args[:long_form]} <#{args[:arg]}>]"
+          end
+        end
+      end
+
+      usage.join(' ')
+    end
+
     ##
     # Creates a new subcommand of the current command.  Identical in
     # usage to +Bales::Application.command+, the only significant

data/lib/bales/version.rb

@@ -1,3 +1,3 @@
 module Bales
-  VERSION="0.0.5"
+  VERSION="0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bales
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryan S. Northrup
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies: []
 description: A framework for building command-line applications
 email: