mothership 0.2.5 → 0.3.0

data/lib/mothership/base.rb

@@ -14,6 +14,11 @@ class Mothership
   end
 
   class << self
+    # all of the defined commands
+    def commands
+      @@commands
+    end
+
     # start defining a new command with the given description
     def desc(description)
       @command = Command.new(self, description)

data/lib/mothership/command.rb

@@ -90,15 +90,17 @@ class Mothership
       options[:interact] = interact if interact
       options[:description] = options.delete(:desc) if options.key?(:desc)
 
-      @flags["--#{name.to_s.gsub("_", "-")}"] = name
+      unless options[:hidden]
+        @flags["--#{name.to_s.gsub("_", "-")}"] = name
 
-      if options[:singular]
-        @flags["--#{options[:singular]}"] = name
-      end
+        if options[:singular]
+          @flags["--#{options[:singular]}"] = name
+        end
 
-      if aliases = options[:aliases] || options[:alias]
-        Array(aliases).each do |a|
-          @flags[a] = name
+        if aliases = options[:aliases] || options[:alias]
+          Array(aliases).each do |a|
+            @flags[a] = name
+          end
         end
       end
 

data/lib/mothership/help.rb

@@ -1,4 +1,5 @@
 require "mothership/base"
+require "mothership/help/commands"
 
 module Mothership::Help
   @@groups = []
@@ -9,69 +10,6 @@ module Mothership::Help
       !@@groups.empty?
     end
 
-    def print_help_groups(global = nil, all = false)
-      @@groups.each do |commands|
-        print_help_group(commands, all)
-      end
-
-      command_options(global)
-    end
-
-    def unique_commands(commands)
-      uniq_commands = []
-      cmd_index = {}
-
-      commands.each do |cmd|
-        if idx = cmd_index[cmd.name]
-          uniq_commands[idx] = cmd
-        else
-          cmd_index[cmd.name] = uniq_commands.size
-          uniq_commands << cmd
-        end
-      end
-
-      uniq_commands
-    end
-
-    def print_help_group(group, all = false, indent = 0)
-      return if nothing_printable?(group, all)
-
-      members = group[:members]
-
-      unless all
-        members = members.reject do |_, opts|
-          opts[:hidden]
-        end
-      end
-
-      commands = members.collect(&:first)
-
-      i = "  " * indent
-
-      print i
-      puts group[:description]
-
-      commands = unique_commands(commands)
-
-      width = 0
-      commands.each do |cmd|
-        len = cmd.usage.size
-        if len > width
-          width = len
-        end
-      end
-
-      commands.each do |cmd|
-        puts "#{i}  #{cmd.usage.ljust(width)}\t#{cmd.description}"
-      end
-
-      puts "" unless commands.empty?
-
-      group[:children].each do |group|
-        print_help_group(group, all, indent + 1)
-      end
-    end
-
     # define help groups
     def groups(*tree)
       tree.each do |*args|
@@ -79,119 +17,33 @@ module Mothership::Help
       end
     end
 
-    def add_to_group(command, names, options)
-      where = @@tree
-      top = true
-      names.each do |n|
-        where = where[:children] unless top
-        break unless where
-
-        where = where[n]
-        break unless where
-
-        top = false
-      end
-
-      unless where
-        raise "unknown help group: #{names.join("/")}"
-      end
-
-      where[:members] << [command, options]
-    end
-
-    def basic_help(commands, global)
-      puts "Commands:"
-
-      width = 0
-      commands.each do |_, c|
-        len = c.usage.size
-        width = len if len > width
-      end
-
-      commands.each do |_, c|
-        puts "  #{c.usage.ljust(width)}\t#{c.description}"
-      end
-
-      unless global.flags.empty?
-        puts ""
-        command_options(global)
+    def group(*names)
+      if where = find_group(names, @@tree)
+        where[:members].collect(&:first)
+      else
+        []
       end
     end
 
-    def command_help(cmd)
-      puts cmd.description
-      puts ""
-      command_usage(cmd)
-    end
-
-    def command_usage(cmd, io = $stdout)
-      io.puts "Usage: #{cmd.usage}"
-
-      unless cmd.flags.empty?
-        io.puts ""
-        command_options(cmd, io)
-      end
+    def add_to_group(command, names, options)
+      where = find_group(names, @@tree)
+      raise "unknown help group: #{names.join("/")}" unless where
+      
+      where[:members] << [command, options]
     end
 
-    def command_options(cmd, io = $stdout)
-      io.puts "Options:"
-
-      rev_flags = Hash.new { |h, k| h[k] = [] }
-
-      cmd.flags.each do |f, n|
-        rev_flags[n] << f
-      end
-
-      usages = []
-
-      max_width = 0
-      rev_flags.collect do |name, fs|
-        info = cmd.inputs[name]
-
-        flag = name.to_s.gsub("_", "-")
-
-        # move full form to the front
-        fs.unshift fs.delete("--#{flag}")
-
-        if short = fs.find { |x| x =~ /^-.$/ }
-          fs.delete short
-        end
-
-        if info[:type] == :boolean && info[:default]
-          fs[0] = "--[no-]#{flag}"
-        end
-
-        if info.key?(:default) && info.key?(:interact)
-          fs.unshift "--ask-#{flag}"
-        end
-
-        usage = "#{short ? short + "," : "   "} #{fs.join ", "}"
-
-        unless info[:type] == :boolean
-          usage << " #{(info[:value] || name).to_s.upcase}"
-        end
-
-        max_width = usage.size if usage.size > max_width
-
-        usages << [usage, info[:description]]
-      end
+    private
 
-      usages.sort! { |a, b| a.first <=> b.first }
+    def find_group(names, where)
+      names.each_with_index do |n, index|
+        where = where[:children] unless index == 0
+        break unless where
 
-      usages.each do |u, d|
-        if d
-          io.puts "  #{u.ljust(max_width)}    #{d}"
-        else
-          io.puts "  #{u}"
-        end
+        where = where[n]
+        break unless where
       end
-    end
-
-    private
 
-    def nothing_printable?(group, all = false)
-      group[:members].reject { |_, opts| !all && opts[:hidden] }.empty? &&
-        group[:children].all? { |g| nothing_printable?(g) }
+      where
     end
 
     def add_group(groups, tree, name, desc, *subs)
@@ -210,51 +62,3 @@ module Mothership::Help
     end
   end
 end
-
-class Mothership
-  class << self
-    # add command to help group
-    def group(*names)
-      options =
-        if names.last.is_a? Hash
-          names.pop
-        else
-          {}
-        end
-
-      Mothership::Help.add_to_group(@command, names, options)
-    end
-  end
-
-  def default_action
-    invoke :help
-  end
-
-  def unknown_command(name)
-    $stderr.print "Unknown command '#{name.to_s.gsub("_", "-")}'. "
-    $stderr.puts "See 'help' for available commands."
-    exit_status 1
-  end
-
-  desc "Help!"
-  input :command, :argument => :optional
-  input :all, :type => :boolean
-  def help
-    if name = input[:command]
-      if cmd = @@commands[name.gsub("-", "_").to_sym]
-        Mothership::Help.command_help(cmd)
-      else
-        unknown_command(name)
-      end
-    elsif Help.has_groups?
-      unless input[:all]
-        puts "Showing basic command set. Pass --all to list all commands."
-        puts ""
-      end
-
-      Mothership::Help.print_help_groups(@@global, input[:all])
-    else
-      Mothership::Help.basic_help(@@commands, @@global)
-    end
-  end
-end

data/lib/mothership/help/commands.rb

@@ -0,0 +1,49 @@
+require "mothership/help/printer"
+
+class Mothership
+  class << self
+    # add command to help group
+    def group(*names)
+      options =
+        if names.last.is_a? Hash
+          names.pop
+        else
+          {}
+        end
+
+      Mothership::Help.add_to_group(@command, names, options)
+    end
+  end
+
+  def default_action
+    invoke :help
+  end
+
+  def unknown_command(name)
+    $stderr.print "Unknown command '#{name.to_s.gsub("_", "-")}'. "
+    $stderr.puts "See 'help' for available commands."
+    exit_status 1
+  end
+
+  desc "Help!"
+  input :command, :argument => :optional
+  input :all, :type => :boolean
+  def help
+    if name = input[:command]
+      if cmd = @@commands[name.gsub("-", "_").to_sym]
+        Mothership::Help.command_help(cmd)
+      else
+        unknown_command(name)
+      end
+    elsif Help.has_groups?
+      unless input[:all]
+        puts "Showing basic command set. Pass --all to list all commands."
+        puts ""
+      end
+
+      Mothership::Help.print_help_groups(@@global, input[:all])
+    else
+      Mothership::Help.basic_help(@@commands, @@global)
+    end
+  end
+end

data/lib/mothership/help/printer.rb

@@ -0,0 +1,162 @@
+module Mothership::Help
+  class << self
+    def print_help_groups(global = nil, all = false)
+      @@groups.each do |commands|
+        print_help_group(commands, all)
+      end
+
+      command_options(global)
+    end
+
+    def print_help_group(group, all = false, indent = 0)
+      return if nothing_printable?(group, all)
+
+      members = group[:members]
+
+      unless all
+        members = members.reject do |_, opts|
+          opts[:hidden]
+        end
+      end
+
+      commands = members.collect(&:first)
+
+      i = "  " * indent
+
+      print i
+      puts group[:description]
+
+      commands = unique_commands(commands)
+
+      width = 0
+      commands.each do |cmd|
+        len = cmd.usage.size
+        if len > width
+          width = len
+        end
+      end
+
+      commands.each do |cmd|
+        puts "#{i}  #{cmd.usage.ljust(width)}\t#{cmd.description}"
+      end
+
+      puts "" unless commands.empty?
+
+      group[:children].each do |group|
+        print_help_group(group, all, indent + 1)
+      end
+    end
+
+    def basic_help(commands, global)
+      puts "Commands:"
+
+      width = 0
+      commands.each do |_, c|
+        len = c.usage.size
+        width = len if len > width
+      end
+
+      commands.each do |_, c|
+        puts "  #{c.usage.ljust(width)}\t#{c.description}"
+      end
+
+      unless global.flags.empty?
+        puts ""
+        command_options(global)
+      end
+    end
+
+    def command_help(cmd)
+      puts cmd.description
+      puts ""
+      command_usage(cmd)
+    end
+
+    def command_usage(cmd, io = $stdout)
+      io.puts "Usage: #{cmd.usage}"
+
+      unless cmd.flags.empty?
+        io.puts ""
+        command_options(cmd, io)
+      end
+    end
+
+    def command_options(cmd, io = $stdout)
+      io.puts "Options:"
+
+      rev_flags = Hash.new { |h, k| h[k] = [] }
+
+      cmd.flags.each do |f, n|
+        rev_flags[n] << f
+      end
+
+      usages = []
+
+      max_width = 0
+      rev_flags.collect do |name, fs|
+        info = cmd.inputs[name]
+        next if info[:hidden]
+
+        flag = name.to_s.gsub("_", "-")
+
+        # move full form to the front
+        fs.unshift fs.delete("--#{flag}")
+
+        if short = fs.find { |x| x =~ /^-.$/ }
+          fs.delete short
+        end
+
+        if info[:type] == :boolean && info[:default]
+          fs[0] = "--[no-]#{flag}"
+        end
+
+        if info.key?(:default) && info.key?(:interact)
+          fs.unshift "--ask-#{flag}"
+        end
+
+        usage = "#{short ? short + "," : "   "} #{fs.join ", "}"
+
+        unless info[:type] == :boolean
+          usage << " #{(info[:value] || name).to_s.upcase}"
+        end
+
+        max_width = usage.size if usage.size > max_width
+
+        usages << [usage, info[:description]]
+      end
+
+      usages.sort! { |a, b| a.first <=> b.first }
+
+      usages.each do |u, d|
+        if d
+          io.puts "  #{u.ljust(max_width)}    #{d}"
+        else
+          io.puts "  #{u}"
+        end
+      end
+    end
+
+    private
+
+    def nothing_printable?(group, all = false)
+      group[:members].reject { |_, opts| !all && opts[:hidden] }.empty? &&
+        group[:children].all? { |g| nothing_printable?(g) }
+    end
+
+    def unique_commands(commands)
+      uniq_commands = []
+      cmd_index = {}
+
+      commands.each do |cmd|
+        if idx = cmd_index[cmd.name]
+          uniq_commands[idx] = cmd
+        else
+          cmd_index[cmd.name] = uniq_commands.size
+          uniq_commands << cmd
+        end
+      end
+
+      uniq_commands
+    end
+  end
+end

data/lib/mothership/version.rb

@@ -1,3 +1,3 @@
 class Mothership
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mothership
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 5
-  version: 0.2.5
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Alex Suraci
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-19 00:00:00 -08:00
-default_executable: 
+date: 2012-11-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -59,23 +58,22 @@ extra_rdoc_files: []
 files: 
 - LICENSE
 - Rakefile
-- lib/mothership.rb
-- lib/mothership/version.rb
+- lib/mothership/base.rb
 - lib/mothership/callbacks.rb
-- lib/mothership/inputs.rb
-- lib/mothership/pretty.rb
-- lib/mothership/errors.rb
 - lib/mothership/command.rb
-- lib/mothership/base.rb
+- lib/mothership/errors.rb
+- lib/mothership/help/commands.rb
+- lib/mothership/help/printer.rb
 - lib/mothership/help.rb
+- lib/mothership/inputs.rb
 - lib/mothership/parser.rb
-- lib/mothership/progress.rb
-- spec/helpers.rb
+- lib/mothership/version.rb
+- lib/mothership.rb
 - spec/arguments_spec.rb
 - spec/combination_spec.rb
-- spec/Rakefile
 - spec/flags_spec.rb
-has_rdoc: true
+- spec/helpers.rb
+- spec/Rakefile
 homepage: https://github.com/vito/mothership
 licenses: []
 
@@ -105,13 +103,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: mothership
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Command-line library for big honkin' CLI apps.
 test_files: 
-- spec/helpers.rb
 - spec/arguments_spec.rb
 - spec/combination_spec.rb
-- spec/Rakefile
 - spec/flags_spec.rb
+- spec/helpers.rb
+- spec/Rakefile

data/lib/mothership/pretty.rb

@@ -1,91 +0,0 @@
-require "rbconfig"
-
-# Mix in to your Mothership class to enable user-toggleable colors.
-#
-# Redefine color_enabled? to control color enabling/disabling. Colors will be
-# auto-disabled if the platform is Windows or if $stdout is not a tty.
-#
-# Redefine user_colors to return a hash from tags to color, e.g. from a user's
-# color config file.
-module Mothership::Pretty
-  WINDOWS = !!(RbConfig::CONFIG['host_os'] =~ /mingw|mswin32|cygwin/)
-
-  COLOR_CODES = {
-    :black => 0,
-    :red => 1,
-    :green => 2,
-    :yellow => 3,
-    :blue => 4,
-    :magenta => 5,
-    :cyan => 6,
-    :white => 7
-  }
-
-  DEFAULT_COLORS = {
-    :name => :blue,
-    :neutral => :blue,
-    :good => :green,
-    :bad => :red,
-    :error => :magenta,
-    :unknown => :cyan,
-    :warning => :yellow,
-    :instance => :yellow,
-    :number => :green,
-    :prompt => :blue,
-    :yes => :green,
-    :no => :red
-  }
-
-  private
-
-  # override with e.g. option(:color), or whatever toggle you use
-  def color_enabled?
-    true
-  end
-
-  # use colors?
-  def color?
-    color_enabled? && !WINDOWS && $stdout.tty?
-  end
-
-  # redefine to control the tag -> color settings
-  def user_colors
-    DEFAULT_COLORS
-  end
-
-  # colored text
-  #
-  # shouldn't use bright colors, as some color themes abuse
-  # the bright palette (I'm looking at you, Solarized)
-  def c(str, type)
-    return str unless color?
-
-    bright = false
-    color = user_colors[type]
-    if color.to_s =~ /bright-(.+)/
-      bright = true
-      color = $1.to_sym
-    end
-
-    return str unless color
-
-    code = "\e[#{bright ? 9 : 3}#{COLOR_CODES[color]}m"
-    "#{code}#{str.to_s.gsub("\e[0m", "\e[0m#{code}")}\e[0m"
-  end
-
-  # bold text
-  def b(str)
-    return str unless color?
-
-    code = "\e[1m"
-    "#{code}#{str.to_s.gsub("\e[0m", "\e[0m#{code}")}\e[0m"
-  end
-
-  # dim text
-  def d(str)
-    return str unless color?
-
-    code = "\e[2m"
-    "#{code}#{str.to_s.gsub("\e[0m", "\e[0m#{code}")}\e[0m"
-  end
-end

data/lib/mothership/progress.rb

@@ -1,112 +0,0 @@
-require "mothership/pretty"
-
-module Mothership::Progress
-  include Mothership::Pretty
-
-  module Dots
-    class << self
-      DOT_COUNT = 3
-      DOT_TICK = 0.15
-
-      def start!
-        @dots ||=
-          Thread.new do
-            before_sync = $stdout.sync
-
-            $stdout.sync = true
-
-            printed = false
-            i = 1
-            until @stop_dots
-              if printed
-                print "\b" * DOT_COUNT
-              end
-
-              print ("." * i).ljust(DOT_COUNT)
-              printed = true
-
-              if i == DOT_COUNT
-                i = 0
-              else
-                i += 1
-              end
-
-              sleep DOT_TICK
-            end
-
-            if printed
-              print "\b" * DOT_COUNT
-              print " " * DOT_COUNT
-              print "\b" * DOT_COUNT
-            end
-
-            $stdout.sync = before_sync
-            @stop_dots = nil
-          end
-      end
-
-      def stop!
-        return unless @dots
-        return if @stop_dots
-        @stop_dots = true
-        @dots.join
-        @dots = nil
-      end
-    end
-  end
-
-  class Skipper
-    def initialize(&ret)
-      @return = ret
-    end
-
-    def skip(&callback)
-      @return.call("SKIPPED", :warning, callback)
-    end
-
-    def give_up(&callback)
-      @return.call("GAVE UP", :bad, callback)
-    end
-
-    def fail(&callback)
-      @return.call("FAILED", :error, callback)
-    end
-  end
-
-  # override to determine whether to show progress
-  def quiet?
-    false
-  end
-
-  def with_progress(message)
-    unless quiet?
-      print message
-      Dots.start!
-    end
-
-    skipper = Skipper.new do |status, color, callback|
-      unless quiet?
-        Dots.stop!
-        puts "... #{c(status, color)}"
-      end
-
-      return callback && callback.call
-    end
-
-    begin
-      res = yield skipper
-      unless quiet?
-        Dots.stop!
-        puts "... #{c("OK", :good)}"
-      end
-      res
-    rescue
-      unless quiet?
-        Dots.stop!
-        puts "... #{c("FAILED", :error)}"
-      end
-
-      raise
-    end
-  end
-end