executable 1.2.0 → 1.2.1

data/.index

@@ -0,0 +1,71 @@
+---
+type: ruby
+revision: 2013
+sources:
+- var
+authors:
+- name: 7rans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: simplecov
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/executable
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/executable
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/executable/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/rubyworks-mailinglist
+  label: Mailing List
+- type: chat
+  uri: irc://chat.us.freenode.net#rubyworks
+  label: IRC Channel
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/executable.git
+categories: []
+paths:
+  load:
+  - lib
+copyrights:
+- holder: Rubyworks
+  year: '2008'
+  license: BSD-2-Clause
+created: '2008-08-08'
+summary: Commandline Object Mapper
+version: 1.2.1
+name: executable
+title: Executable
+description: ! 'Think of Executable as a *COM*, a Commandline Object Mapper,
+
+  in much the same way that ActiveRecord is an ORM,
+
+  an Object Relational Mapper. A class utilizing Executable
+
+  can define a complete command line tool using nothing more
+
+  than Ruby''s own method definitions.'
+date: '2012-12-18'

data/.ruby

@@ -1,61 +1 @@
----
-source:
-- meta
-authors:
-- name: 7rans
-  email: transfire@gmail.com
-copyrights:
-- holder: Rubyworks
-  year: '2008'
-  license: BSD-2-Clause
-replacements: []
-alternatives: []
-requirements:
-- name: qed
-  groups:
-  - test
-  development: true
-- name: ae
-  groups:
-  - test
-  development: true
-- name: detroit
-  groups:
-  - build
-  development: true
-- name: simplecov
-  groups:
-  - build
-  development: true
-dependencies: []
-conflicts: []
-repositories:
-- uri: git://github.com/rubyworks/executable.git
-  scm: git
-  name: upstream
-resources:
-  home: http://rubyworks.github.com/executable
-  code: http://github.com/rubyworks/executable
-  bugs: http://github.com/rubyworks/executable/issues
-  mail: http://groups.google.com/rubyworks-mailinglist
-  chat: irc://chat.us.freenode.net#rubyworks
-extra: {}
-load_path:
-- lib
-revision: 0
-created: '2008-08-08'
-summary: Commandline Object Mapper
-version: 1.2.0
-name: executable
-title: Executable
-description: ! 'Think of Executable as a *COM*, a Commandline Object Mapper,
-
-  in much the same way that ActiveRecord is an ORM,
-
-  an Object Relational Mapper. A class utilizing Executable
-
-  can define a complete command line tool using nothing more
-
-  than Ruby''s own method definitions.'
-organization: rubyworks
-date: '2012-01-31'
+ruby 1.9.3p327 (2012-11-10 revision 37606) [x86_64-linux]

data/Config.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# Code coverage.
+profile :cov do
+
+  # Setup QED.
+  config :qed do
+    require 'simplecov'
+    SimpleCov.start do
+      coverage_dir 'log/coverage'
+      add_filter "/demo/"
+      #add_group "RSpec", "lib/assay/rspec.rb"
+    end
+  end
+
+end

data/{DEMO.rdoc → DEMO.md}

@@ -301,6 +301,114 @@ method will automatically find the manpage and display it.
 
 
 
+= Subclass Example
+
+Lets say we have a class that we would like to work with on
+the command line, but want to keep the class itself unchanaged
+without mixin.
+
+    class Hello
+      attr_accessor :name
+
+      def initialize(name="World")
+        @name = name
+      end
+
+      def hello
+        @output = "Hello, #{name}!"
+      end
+
+      def output
+        @output
+      end
+    end
+
+Rather then including Exectuable in the class directly, we can
+create a subclass and use it instead.
+
+    class HelloCommand < Hello
+      include Executable
+
+      def call(*args)
+        hello
+      end
+    end
+
+Now we can execute the command perfectly well.
+
+    cmd = HelloCommand.execute(['hello', '--name=Fred'])
+    cmd.output.assert == "Hello, Fred!"
+
+And the original class remains undisturbed.
+
+
+= README Example
+
+This is the example used in the documentation.
+
+    class Example
+      include Executable
+
+      attr_switch :quiet
+
+      def bread(*args)
+        ["bread", quiet?, *args]
+      end
+
+      def butter(*args)
+        ["butter", quiet?, *args]
+      end
+
+      # Route call to methods.
+      def call(name, *args)
+        meth = public_method(name)
+        meth.call(*args)
+      end
+    end
+
+Use a subcommand and an argument.
+
+    c, a = Example.parse(['butter', 'yum'])
+    r = c.call(*a)
+    r.assert == ["butter", nil, "yum"]
+
+A subcommand and a boolean option.
+
+    c, a = Example.parse(['bread', '--quiet'])
+    r = c.call(*a)
+    r.assert == ["bread", true]
+
+
+== Legacy/Dispath
+
+The Dispatch mixin, which is also called Legacy b/c this is how older
+version of Executable worked, provides Executable with a `#call` method
+that automatically routes the to a method given by the first argument.
+
+  class DispatchExample < Executable::Command
+    include Legacy
+
+    attr :result
+
+    def foo
+      @result = :foo
+    end
+
+    def bar
+      @result = :bar
+    end
+
+  end
+
+Now when we invoke the command, the 
+
+  eg = DispatchExample.run('foo')
+  eg.result.assert == :foo
+
+  eg = DispatchExample.run('bar')
+  eg.result.assert == :bar
+
+
 == OptionParser Example
 
 This example mimics the one given in optparse.rb documentation.
@@ -454,114 +562,6 @@ Ensure extension begins with dot and inplace is set to true.
    cli.options.inplace.assert == true
 
 
-= Subclass Example
-
-Lets say we have a class that we would like to work with on
-the command line, but want to keep the class itself unchanaged
-without mixin.
-
-    class Hello
-      attr_accessor :name
-
-      def initialize(name="World")
-        @name = name
-      end
-
-      def hello
-        @output = "Hello, #{name}!"
-      end
-
-      def output
-        @output
-      end
-    end
-
-Rather then including Exectuable in the class directly, we can
-create a subclass and use it instead.
-
-    class HelloCommand < Hello
-      include Executable
-
-      def call(*args)
-        hello
-      end
-    end
-
-Now we can execute the command perfectly well.
-
-    cmd = HelloCommand.execute(['hello', '--name=Fred'])
-    cmd.output.assert == "Hello, Fred!"
-
-And the original class remains undisturbed.
-
-
-= README Example
-
-This is the example used in the documentation.
-
-    class Example
-      include Executable
-
-      attr_switch :quiet
-
-      def bread(*args)
-        ["bread", quiet?, *args]
-      end
-
-      def butter(*args)
-        ["butter", quiet?, *args]
-      end
-
-      # Route call to methods.
-      def call(name, *args)
-        meth = public_method(name)
-        meth.call(*args)
-      end
-    end
-
-Use a subcommand and an argument.
-
-    c, a = Example.parse(['butter', 'yum'])
-    r = c.call(*a)
-    r.assert == ["butter", nil, "yum"]
-
-A subcommand and a boolean option.
-
-    c, a = Example.parse(['bread', '--quiet'])
-    r = c.call(*a)
-    r.assert == ["bread", true]
-
-
-== Legacy/Dispath
-
-The Dispatch mixin, which is also called Legacy b/c this is how older
-version of Executable worked, provides Executable with a `#call` method
-that automatically routes the to a method given by the first argument.
-
-  class DispatchExample < Executable::Command
-    include Legacy
-
-    attr :result
-
-    def foo
-      @result = :foo
-    end
-
-    def bar
-      @result = :bar
-    end
-
-  end
-
-Now when we invoke the command, the 
-
-  eg = DispatchExample.run('foo')
-  eg.result.assert == :foo
-
-  eg = DispatchExample.run('bar')
-  eg.result.assert == :bar
-
-
 
 
 

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,6 +1,18 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 1.2.0 / 2012-01-31
+## 1.2.1 / 2012-12-19
+
+This release imporves the help output and manpage lookup
+as well as a few helpful additions the the API.
+
+Changes:
+
+* Improve manpage lookup.
+* Improve overall help output.
+* Add alias_switch and alias_accessor helpers.
+
+
+## 1.2.0 / 2012-01-31
 
 Version 1.2.0 is complete rewrite of Executable. Actually it was decided that
 the old design was too simplistic in it design concept, so another library
@@ -20,7 +32,7 @@ Changes:
 * Supports manpage look-up and display.
 
 
-== 1.1.0 / 2011-04-21
+## 1.1.0 / 2011-04-21
 
 This release simplifies Executable, removing the #option_missing method
 and using the standard #method_missing callback instead. Along with this
@@ -44,7 +56,7 @@ Changes:
   * The #method_missing callback takes the value of the option being set.
 
 
-== 1.0.0 / 2011-04-15
+## 1.0.0 / 2011-04-15
 
 This is the initialize release of Executable (as a stand alone project).
 Executable is a mixin that can turn any class into an commandline interface.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+BSD-2-Clause License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/{README.rdoc → README.md}

@@ -1,14 +1,10 @@
-= Executable
+[Website](http://rubyworks.github.com/executable) |
+[Report Issue](http://github.com/rubyworks/executable/features) |
+[Source Code](http://github.com/rubyworks/executable)
+( [![Build Status](https://secure.travis-ci.org/rubyworks/indexer.png)](http://travis-ci.org/rubyworks/indexer) )
 
-{Website}[http://rubyworks.github.com/executable] |
-{Source Code}[http://github.com/rubyworks/executable] |
-{Report Issue}[http://github.com/rubyworks/executable/features] |
-{#rubyworks}[irc://irc.freenode.org/rubyworks]
 
-{<img src="http://travis-ci.org/rubyworks/executable.png"/>}[http://travis-ci.org/rubyworks/executable]
-
-
-== DESCRIPTION
+# Executable
 
 Executable is to the commandline, what ActiveRecord is the database. 
 You can think of Executable as a *COM*, a Command-line Object Mapper,
@@ -18,7 +14,7 @@ a complete command line tool using nothing more than Ruby's standard
 syntax. No special DSL is required. 
 
 
-== FEATURES
+## Features
 
 * Easy to use, just mixin or subclass.
 * Define #call to control the command procedure.
@@ -28,18 +24,13 @@ syntax. No special DSL is required.
 * Generate help in plain text or markdown.
 
 
-== LIMITATIONS
+## Limitations
 
 * Ruby 1.9+ only.
 * Help doesn't handle aliases well (yet).
 
 
-== RELEASE NOTES
-
-Please see HISTORY.rdoc file.
-
-
-== SYNOPSIS
+## Instructions
 
 CLIs can be built by using a Executable as a mixin, or by subclassing 
 `Executable::Command`. Methods seemlessly handle command-line options.
@@ -48,13 +39,14 @@ methods (those ending in '?') modify them to be boolean switches.
 
 For example, here is a simple "Hello, World!" commandline tool.
 
+```ruby
     require 'executable'
 
     class HelloCommand
       include Executable
 
       # Say it in uppercase?
-      def load=(bool)
+      def loud=(bool)
         @loud = bool
       end
 
@@ -78,17 +70,21 @@ For example, here is a simple "Hello, World!" commandline tool.
         puts str
       end
     end
+```
 
 To make the command available on the command line, add an executable
-to your project passing ARGV to the #execute or #run methods.
+to your project calling the #execute or #run methods.
 
+```ruby
     #!usr/bin/env ruby
     require 'hello.rb'
     HelloCommand.run
+```
 
 If we named this file `hello`, set its execute flag and made it available
 on our systems $PATH, then:
 
+```
     $ hello
     Hello, World!
 
@@ -97,9 +93,11 @@ on our systems $PATH, then:
 
     $ hello --loud John
     HELLO, JOHN!
+```
 
 Executable can also generate help text for commands.
 
+```
     $ hello --help
     USAGE: hello [options]
 
@@ -107,38 +105,55 @@ Executable can also generate help text for commands.
 
     --loud      Say it in uppercase?
     --help      Show this message
+```
 
 If you look back at the class definition you can see it's pulling
 comments from the source to provide descriptions. It pulls the 
-description the command itself from the `#call` method.
+description for the command itself from the `#call` method.
 
 Basic help like this is fine for personal tools, but for public facing
 production applications it is desirable to utilize manpages. To this end,
 Executable provides Markdown formatted help as well. We can access this,
 for example, via `HelloCommand.help.markdown`. The idea with this is that
 we can save the output to `man/hello.ronn` or copy it the top of our `bin/`
-file, edit it to perfection and then use tools such a {ronn}[https://github.com/rtomayko/ronn],
-{binman}[https://github.com/sunaku/binman] or {md2man}[https://github.com/sunaku/md2man]
+file, edit it to perfection and then use tools such a [ronn](https://github.com/rtomayko/ronn),
+[binman](https://github.com/sunaku/binman) or [md2man](https://github.com/sunaku/md2man)
 to generate the manpages. What's particularly cool about Executable,
 is that once we have a manpage in the standard `man/` location in our project,
 the `#show_help` method will use it instead of the plain text.
 
-For a more detail example see {QED}[demo.html]
-and {API}[http://rubydoc.info/gems/executable/frames] documentation.
+For a more detail example see [QED](demo.html)
+and [API](http://rubydoc.info/gems/executable/frames) documentation.
 
 
-== INSTALLATION
+## Installation
 
 Install with RubyGems in the usual fashion.
 
+```
     $ gem install executable
+```
+
+## CONTRIBUTING
+
+Executable is a Rubyworks project. As such we largely use in house tools
+for development.
+
+### Testing
+
+QED and Microtest are being used for this project.
+
+### Getting In Touch
+
+* [#rubyworks](irc://irc.freenode.org/rubyworks)
 
 
-== LEGAL
+## Copyrights
 
-Copyright (c) 2008 Rubyworks
+Executable is copyrighted open source software.
 
-Distributable in accordance with the *BSD-2-Clause* license.
+    Copyright (c) 2008 Rubyworks (BSD-2-Clause License)
 
-See COPYING.rdoc for licensing details.
+It can be distributed and modified in accordance with the *BSD-2-Clause* license.
 
+See LICENSE.txt for details.

data/demo/{00_introduction.rdoc → 00_introduction.md}

@@ -1,4 +1,4 @@
-= Executable
+# Executable
 
 Require Executable library.
 

data/demo/{01_single_command.rdoc → 01_single_command.md}

@@ -1,4 +1,4 @@
-== No Subcommmands
+## No Subcommmands
 
 This example demonstrates using Executable::Command to create a simple command line
 interface without subcommands. (Note the Executable mixin could be used just

data/demo/{02_multiple_commands.rdoc → 02_multiple_commands.md}

@@ -1,4 +1,4 @@
-== Multiple Subcommmands
+## Multiple Subcommmands
 
 Setup an example CLI subclass.
 

data/demo/{03_help_text.rdoc → 03_help_text.md}

@@ -1,4 +1,4 @@
-== Command Help
+## Command Help
 
 Executable Commands can generate help output. It does this by extracting
 the commenst associated with the option methods. A description of the
@@ -62,7 +62,7 @@ The help output,
 
 should be clearly laid out as follows:
 
-    Usage: mycli-c1 [options...] [subcommand]
+    Usage: my c1 [options...] [subcommand]
 
     This does c1.
 
@@ -81,12 +81,12 @@ The help feature can also output ronn-style markdown,
 
 should be clearly laid out as follows:
 
-    mycli-c1(1) - This does c1.
-    ===========================
+    my-c1(1) - This does c1.
+    ========================
 
     ## SYNOPSIS
 
-    `mycli-c1` [options...] [subcommand]
+    `my c1` [options...] [subcommand]
 
     ## DESCRIPTION
 

data/demo/{04_manpage.rdoc → 04_manpage.md}

@@ -1,14 +1,14 @@
-== Manpage
+### Manpages
 
 If a man page is available for a given command using the #show_help
 method will automatically find the manpage and display it.
 
     sample = File.dirname(__FILE__) + '/samples'
 
-    load(sample + '/bin/hello')
-
-    manpage = Hello.cli.manpage
+    manpage = `ruby #{sample}/bin/hello --manpage`.strip
 
     manpage.assert == sample + '/man/hello.1'
 
+Note: Would rather use #load for this, but without a `.rb` on
+the `hello` file, it doesn't seem possible.
 

data/demo/{06_delegate_example.rdoc → 06_delegate_example.md}

@@ -1,4 +1,4 @@
-= Subclass Example
+## Subclass Example
 
 Lets say we have a class that we would like to work with on
 the command line, but want to keep the class itself unchanaged

data/demo/{07_command_methods.rdoc → 07_command_methods.md}

@@ -1,4 +1,4 @@
-= README Example
+## README Example
 
 This is the example used in the documentation.
 

data/demo/{08_dispatach.rdoc → 08_dispatach.md}

@@ -1,4 +1,4 @@
-== Legacy/Dispath
+## Legacy/Dispath
 
 The Dispatch mixin, which is also called Legacy b/c this is how older
 version of Executable worked, provides Executable with a `#call` method

data/demo/{05_optparse_example.rdoc → 09_optparse_example.md}

@@ -1,4 +1,4 @@
-== OptionParser Example
+## OptionParser Example
 
 This example mimics the one given in optparse.rb documentation.
 

data/demo/samples/bin/hello

@@ -1,10 +1,10 @@
-#!/usr/bin/env
+#!/usr/bin/env ruby
 
 require 'executable'
 
 class Hello < Executable::Command
   # Say it in uppercase?
-  def load=(bool)
+  def loud=(bool)
     @loud = bool
   end
 
@@ -27,5 +27,12 @@ class Hello < Executable::Command
     str  = str.upcase if loud?
     puts str
   end
+
+  # Where's the manpage?
+  def manpage!
+    puts cli.manpage
+    exit
+  end
 end
 
+Hello.execute

data/lib/executable.rb

@@ -22,7 +22,7 @@ module Executable
 
   #
   # Default initializer, simply takes a hash of settings
-  # to set attributes via writer methods. Not existnt
+  # to set attributes via writer methods. Not existant
   # attributes are simply ignored.
   #
   def initialize(settings={})

data/lib/executable.yml

@@ -0,0 +1,71 @@
+---
+type: ruby
+revision: 2013
+sources:
+- var
+authors:
+- name: 7rans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: simplecov
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/executable
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/executable
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/executable/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/rubyworks-mailinglist
+  label: Mailing List
+- type: chat
+  uri: irc://chat.us.freenode.net#rubyworks
+  label: IRC Channel
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/executable.git
+categories: []
+paths:
+  load:
+  - lib
+copyrights:
+- holder: Rubyworks
+  year: '2008'
+  license: BSD-2-Clause
+created: '2008-08-08'
+summary: Commandline Object Mapper
+version: 1.2.1
+name: executable
+title: Executable
+description: ! 'Think of Executable as a *COM*, a Commandline Object Mapper,
+
+  in much the same way that ActiveRecord is an ORM,
+
+  an Object Relational Mapper. A class utilizing Executable
+
+  can define a complete command line tool using nothing more
+
+  than Ruby''s own method definitions.'
+date: '2012-12-18'

data/lib/executable/dispatch.rb

@@ -2,7 +2,7 @@ module Executable
 
   # Variation of Executable which provides basic compatibility with
   # previous versions of Executable. It provides a call method that
-  # automatically dispatches to publich methods.
+  # automatically dispatches to public methods.
   #
   # Among other uses, Dispatch can be useful for dropping into any class
   # as a quick and dirty way to work with it on the command line.

data/lib/executable/domain.rb

@@ -3,6 +3,28 @@ module Executable
   #
   module Domain
 
+    #
+    def usage_name
+      list = []
+      ancestors.each do |ancestor|
+        break if Executable == ancestor
+        list.unshift calculate_command_name(ancestor).to_s.strip
+      end
+      list.reject{|n| n.empty?}.join(" ")
+    end
+
+    #
+    def calculate_command_name(ancestor)
+      if ancestor.methods(false).include?(:command_name)
+        command_name.to_s
+      else
+        cname = ancestor.name.sub(/\#\<.*?\>\:\:/,'').split('::').last.downcase
+        cname.chomp('command').chomp('cli')
+      end
+    end
+
+    private :calculate_command_name
+
     #
     # Helper method for creating switch attributes.
     #
@@ -26,6 +48,22 @@ module Executable
       }
     end
 
+    #
+    # 
+    #
+    def alias_switch(name, origin)
+      alias_method "#{name}=", "#{origin}="
+      alias_method "#{name}?", "#{origin}?"
+    end
+
+    #
+    #
+    #
+    def alias_accessor(name, origin)
+      alias_method "#{name}=", "#{origin}="
+      alias_method "#{name}",  "#{origin}"
+    end
+
     #
     # Inspection method. This must be redefined b/c #to_s is overridden.
     #
@@ -93,7 +131,9 @@ module Executable
         consts.inject({}) do |h, c|
           c = const_get(c)
           if Class === c && Executable > c
-            n = c.name.split('::').last.downcase
+            n = c.name.split('::').last
+            n = n.chomp('Command').chomp('CLI')
+            n = n.downcase
             h[n] = c
           end
           h

data/lib/executable/help.rb

@@ -63,10 +63,7 @@ module Executable
     # @method name(text=nil)
     #
     section(:name) do
-      str = cli_class.name.sub(/\#\<.*?\>\:\:/,'').downcase.gsub('::','-')
-      str.chomp!('command')
-      str.chomp!('cli')
-      str
+      cli_class.usage_name
     end
 
     #
@@ -122,7 +119,7 @@ module Executable
     #
     # Show help.
     #
-    # @todo man-pages will probably fail on Windows
+    # @todo man-pages will probably fail on Windows.
     #
     def show_help(hint=nil)
       if file = manpage(hint)
@@ -132,6 +129,9 @@ module Executable
       end
     end
 
+    #
+    alias :show :show_help
+
     #
     def show_manpage(file)
       #exec "man #{file}"
@@ -155,8 +155,10 @@ module Executable
           dir = File.dirname(file)
         end
 
+        man_name = name.gsub(/\s+/, '-') + '.1'
+
         if dir
-          glob = "man/{man1/,}#{name}.1"
+          glob = "man/{man1/,}#{man_name}"
           lookup(glob, dir)
         else
           nil
@@ -216,10 +218,11 @@ module Executable
     def markdown
       commands = text_subcommands
       options  = text_options
+      dashname = name.sub(/\s+/, '-')
 
       s = []
 
-      h = "#{name}(1) - #{text_description}"
+      h = "#{dashname}(1) - #{text_description}"
       s << h + "\n" + ("=" * h.size)
 
       s << "## SYNOPSIS"

data/lib/executable/version.rb

@@ -4,20 +4,17 @@ module Exectuable
   DIRECTORY = File.dirname(__FILE__)
 
   #
-  def self.version
-    @package ||= (
-      require 'yaml'
-      YAML.load(File.new(DIRECTORY + '/version.yml'))
-    )
+  def self.const_missing(name)
+    index[name.to_s.downcase] || super(name)
   end
 
   #
-  def self.const_missing(name)
-    version[name.to_s.downcase] || super(name)
+  def self.index
+    @index ||= (
+      require 'yaml'
+      YAML.load(File.new(DIRECTORY + '/../executable.yml'))
+    )
   end
 
-  # because Ruby 1.8~ gets in the way
-  remove_const(:VERSION) if const_defined?(:VERSION)
-
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: executable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-01 00:00:00.000000000 Z
+date: 2012-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &16160360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16160360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ae
-  requirement: &16158800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16158800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &16156720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16156720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &16155820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16155820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'Think of Executable as a *COM*, a Commandline Object Mapper,
 
   in much the same way that ActiveRecord is an ORM,
@@ -69,22 +89,23 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.rdoc
-- DEMO.rdoc
-- README.rdoc
-- COPYING.rdoc
+- LICENSE.txt
+- HISTORY.md
+- README.md
+- DEMO.md
 files:
+- .index
 - .ruby
 - .yardopts
-- demo/00_introduction.rdoc
-- demo/01_single_command.rdoc
-- demo/02_multiple_commands.rdoc
-- demo/03_help_text.rdoc
-- demo/04_manpage.rdoc
-- demo/05_optparse_example.rdoc
-- demo/06_delegate_example.rdoc
-- demo/07_command_methods.rdoc
-- demo/08_dispatach.rdoc
+- demo/00_introduction.md
+- demo/01_single_command.md
+- demo/02_multiple_commands.md
+- demo/03_help_text.md
+- demo/04_manpage.md
+- demo/06_delegate_example.md
+- demo/07_command_methods.md
+- demo/08_dispatach.md
+- demo/09_optparse_example.md
 - demo/applique/ae.rb
 - demo/applique/compare.rb
 - demo/applique/exec.rb
@@ -101,23 +122,13 @@ files:
 - lib/executable/utils.rb
 - lib/executable/version.rb
 - lib/executable.rb
-- meta/authors
-- meta/copyrights
-- meta/created
-- meta/description
-- meta/name
-- meta/organization
-- meta/repositories
-- meta/requirements
-- meta/resources
-- meta/summary
-- meta/version
+- lib/executable.yml
 - test/test_executable.rb
-- HISTORY.rdoc
-- DEMO.rdoc
-- Schedule.reap
-- README.rdoc
-- COPYING.rdoc
+- LICENSE.txt
+- HISTORY.md
+- README.md
+- DEMO.md
+- Config.rb
 homepage: http://rubyworks.github.com/executable
 licenses:
 - BSD-2-Clause
@@ -139,8 +150,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Commandline Object Mapper
-test_files: []
+test_files:
+- test/test_executable.rb

data/COPYING.rdoc

@@ -1,35 +0,0 @@
-= COPYRIGHT
-
-== NOTICES
-
-=== Executable
-
-Copyright:: (c) 2012 Rubyworks. All rights reserved.
-License::   (r) BSD-2-Clause
-Website::   http://rubyworks.github.com/assay
-
-
-== LICENSES
-
-=== BSD-2-Clause License
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
-
-       1. Redistributions of source code must retain the above copyright notice,
-          this list of conditions and the following disclaimer.
-
-       2. Redistributions in binary form must reproduce the above copyright
-          notice, this list of conditions and the following disclaimer in the
-          documentation and/or other materials provided with the distribution.
-
-    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-    FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
-    COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
-    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
-    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
-    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Schedule.reap

@@ -1,17 +0,0 @@
-task :default => [:test]
-
-desc "run unit tests (needs rubytest)"
-task :test do
-  sh "rubytest -Ilib test/*.rb"
-end
-
-desc "render README.rdoc to web/readme.html (need malt)"
-task :readme do
-  sh "malt README.rdoc > web/readme.html"
-end
-
-# if `README.rdoc` changes generate `web/readme.html`.
-file 'README.rdoc' do
-  sh "malt README.rdoc > web/readme.html"
-end
-

data/meta/authors

@@ -1,2 +0,0 @@
----
-- 7rans <transfire@gmail.com>

data/meta/copyrights

@@ -1,3 +0,0 @@
----
-- (c) 2008 Rubyworks (BSD-2-Clause)
-

data/meta/created

@@ -1 +0,0 @@
-2008-08-08

data/meta/description

@@ -1,6 +0,0 @@
-Think of Executable as a *COM*, a Commandline Object Mapper,
-in much the same way that ActiveRecord is an ORM,
-an Object Relational Mapper. A class utilizing Executable
-can define a complete command line tool using nothing more
-than Ruby's own method definitions.
-

data/meta/name

@@ -1 +0,0 @@
-executable

data/meta/organization

@@ -1 +0,0 @@
-rubyworks

data/meta/repositories

@@ -1,2 +0,0 @@
----
-upstream: git://github.com/rubyworks/executable.git

data/meta/requirements

@@ -1,6 +0,0 @@
----
-- qed       (test)
-- ae        (test)
-- detroit   (build)
-- simplecov (build)
-

data/meta/resources

@@ -1,7 +0,0 @@
----
-home: http://rubyworks.github.com/executable
-code: http://github.com/rubyworks/executable
-bugs: http://github.com/rubyworks/executable/issues
-mail: http://groups.google.com/rubyworks-mailinglist
-chat: irc://chat.us.freenode.net#rubyworks
-

data/meta/summary

@@ -1 +0,0 @@
-Commandline Object Mapper

data/meta/version

@@ -1 +0,0 @@
-1.2.0