executable 1.2.0 → 1.3.0

data/lib/executable/core_ext.rb

@@ -1,102 +1 @@
-class UnboundMethod
-  if !method_defined?(:source_location)
-    if Proc.method_defined? :__file__  # /ree/
-      def source_location
-        [__file__, __line__] rescue nil
-      end
-    elsif defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /jruby/
-      require 'java'
-      def source_location
-        to_java.source_location(Thread.current.to_java.getContext())
-      end
-    end
-  end
-
-  #
-  def comment
-    Source.get_above_comment(*source_location)
-  end
-
-  # Source lookup.
-  #
-  module Source
-    extend self
-
-    # Read and cache file.
-    #
-    # @param file [String] filename, should be full path
-    #
-    # @return [Array] file content in array of lines
-    def read(file)
-      @read ||= {}
-      @read[file] ||= File.readlines(file)
-    end
-
-    # Get comment from file searching up from given line number.
-    #
-    # @param file [String] filename, should be full path
-    # @param line [Integer] line number in file
-    #
-    def get_above_comment(file, line)
-      get_above_comment_lines(file, line).join("\n").strip
-    end
-
-    # Get comment from file searching up from given line number.
-    #
-    # @param file [String] filename, should be full path
-    # @param line [Integer] line number in file
-    #
-    def get_above_comment_lines(file, line)
-      text  = read(file)
-      index = line - 1
-      while index >= 0 && text[index] !~ /^\s*\#/
-        return [] if text[index] =~ /^\s*end/
-        index -= 1
-      end
-      rindex = index
-      while text[index] =~ /^\s*\#/
-        index -= 1
-      end
-      result = text[index..rindex]
-      result = result.map{ |s| s.strip }
-      result = result.reject{ |s| s[0,1] != '#' }
-      result = result.map{ |s| s.sub(/^#/,'').strip }
-      #result = result.reject{ |s| s == "" }
-      result
-    end
-
-    # Get comment from file searching down from given line number.
-    #
-    # @param file [String] filename, should be full path
-    # @param line [Integer] line number in file
-    #
-    def get_following_comment(file, line)
-      get_following_comment_lines(file, line).join("\n").strip
-    end
-
-    # Get comment from file searching down from given line number.
-    #
-    # @param file [String] filename, should be full path
-    # @param line [Integer] line number in file
-    #
-    def get_following_comment_lines(file, line)
-      text  = read(file)
-      index = line || 0
-      while text[index] !~ /^\s*\#/
-        return nil if text[index] =~ /^\s*(class|module)/
-        index += 1
-      end
-      rindex = index
-      while text[rindex] =~ /^\s*\#/
-        rindex += 1
-      end
-      result = text[index..(rindex-2)]
-      result = result.map{ |s| s.strip }
-      result = result.reject{ |s| s[0,1] != '#' }
-      result = result.map{ |s| s.sub(/^#/,'').strip }
-      result.join("\n").strip
-    end
-
-  end
-
-end
+require 'executable/core_ext/unbound_method'

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
 
+    # TODO: Should this be in Help class?
+    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.
     #
@@ -16,14 +38,36 @@ module Executable
     #     @name
     #   end
     #
+    # TODO: Currently there is an unfortunate issue with using
+    # this helper method. If does not correctly record the location
+    # the method is called, so default help message is wrong.
     #
     def attr_switch(name)
-      attr_writer name
-      module_eval %{
+      file, line = *caller[0].split(':')[0..1]
+      module_eval(<<-END, file, line.to_i)
+        def #{name}=(value)
+          @#{name}=(value)
+        end
         def #{name}?
           @#{name}
         end
-      }
+      END
+    end
+
+    #
+    # Alias a switch.
+    #
+    def alias_switch(name, origin)
+      alias_method "#{name}=", "#{origin}="
+      alias_method "#{name}?", "#{origin}?"
+    end
+
+    #
+    # Alias an accessor.
+    #
+    def alias_accessor(name, origin)
+      alias_method "#{name}=", "#{origin}="
+      alias_method "#{name}",  "#{origin}"
     end
 
     #
@@ -34,7 +78,8 @@ module Executable
     end
 
     #
-    # Returns `help.to_s`.
+    # Returns `help.to_s`. If you want to provide your own help
+    # text you can override this method in your command subclass.
     #
     def to_s
       cli.to_s
@@ -93,7 +138,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

@@ -5,9 +5,6 @@ module Executable
   # Encpsulates command help for defining and displaying well formated help
   # output in plain text, markdown or via manpages if found.
   #
-  # TODO: Currently doesn't hande aliases/shortcuts well and simply
-  # lists them as separate entries.
-  #
   # Creating text help in the fly is fine for personal projects, but
   # for production app, ideally you want to have man pages. You can
   # use the #markdown method to generate `.ronn` files and use the
@@ -30,7 +27,9 @@ module Executable
       }
     end
 
+    #
     # Setup new help object.
+    #
     def initialize(cli_class)
       @cli_class = cli_class
 
@@ -63,10 +62,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 +118,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 +128,9 @@ module Executable
       end
     end
 
+    #
+    alias :show :show_help
+
     #
     def show_manpage(file)
       #exec "man #{file}"
@@ -155,8 +154,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
@@ -196,8 +197,8 @@ module Executable
       end
 
       if !options.empty?
-        s << "OPTIONS\n" + options.map{ |max, opt|
-          "  %2s%-#{max}s %s" % [opt.mark, opt.usage, opt.description]
+        s << "OPTIONS\n" + options.map{ |max, opts, desc|
+          "  %-#{max}s %s" % [opts.join(' '), desc]
         }.join("\n")
       end
 
@@ -216,10 +217,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"
@@ -237,8 +239,8 @@ module Executable
 
       if !options.empty?
         s << "## OPTIONS"
-        s << options.map{ |max, opt|
-          "  * `#{opt.mark}%s`:\n    %s" % [opt.usage, opt.description]
+        s << options.map{ |max, opts, desc|
+          "  * `%s`:\n    %s" % [opts.join(' '), desc]
         }.join("\n\n")
       end
 
@@ -298,10 +300,17 @@ module Executable
         end
       end    
 
-      max = option_list.map{ |opt| opt.usage.size }.max.to_i + 2
+      # if two options have the same description, they must aliases
+      aliased_options = option_list.group_by{ |opt| opt.description }
+
+      list = aliased_options.map do |desc, opts|
+        [opts.map{ |o| "%s%s" % [o.mark, o.usage] }, desc]
+      end
+
+      max = list.map{ |opts, desc| opts.join(' ').size }.max.to_i + 2
 
-      option_list.map do |opt|
-        [max, opt]
+      list.map do |opts, desc|
+        [max, opts, desc]
       end
     end
 
@@ -347,11 +356,11 @@ module Executable
                   -1
       ancestors = cli_class.ancestors[0...stop_at]
       ancestors.reverse_each do |a|
-        a.instance_methods(false).each do |m|
+        a.public_instance_methods(false).each do |m|
           list << cli_class.instance_method(m)
         end
       end
-      list
+      list #.uniq
     end
 
     #

data/lib/executable/parser.rb

@@ -25,7 +25,12 @@ module Executable
 
       cmd, argv = parse_subcommand(argv)
       cli  = cmd.new
-      args = parse_arguments(cli, argv)
+
+      if argv.first == "_"
+        cli = Completion.new(cli.class)
+      else
+        args = parse_arguments(cli, argv)
+      end
 
       return cli, args
     end
@@ -141,8 +146,7 @@ module Executable
       end
     end
 
-    # TODO: parse_flags needs some thought concerning character
-    # spliting and arguments.
+    # TODO: parse_flags needs some thought concerning character spliting and arguments.
 
     #
     # Parse single-dash command-line option.

data/lib/executable/version.rb

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

data/lib/executable.rb

@@ -3,6 +3,7 @@
 require 'executable/errors'
 require 'executable/parser'
 require 'executable/help'
+require 'executable/completion'
 require 'executable/utils'
 require 'executable/domain'
 require 'executable/dispatch'
@@ -22,7 +23,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={})
@@ -58,7 +59,7 @@ public
   end
 
   #
-  # Access to underlying Help instance.
+  # Access to underlying cli instance.
   #
   def cli
     self.class.cli

metadata

@@ -1,90 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: executable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
-- 7rans
-autorequire: 
+- Trans
 bindir: bin
 cert_chain: []
-date: 2012-02-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: qed
-  requirement: &16160360 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
-  version_requirements: *16160360
-- !ruby/object:Gem::Dependency
-  name: ae
-  requirement: &16158800 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *16158800
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: detroit
-  requirement: &16156720 !ruby/object:Gem::Requirement
-    none: false
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
-  version_requirements: *16156720
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &16155820 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *16155820
-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.'
+        version: '5'
+description: Think of Executable as a COM, a Commandline Object Mapper, in much the
+  same way that ActiveRecord is an ORM. A class utilizing Executable can define a
+  complete command line tool using nothing more than Ruby's own method definitions.
 email:
 - transfire@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- HISTORY.rdoc
-- DEMO.rdoc
-- README.rdoc
-- COPYING.rdoc
+extra_rdoc_files: []
 files:
-- .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
+- HISTORY.md
+- LICENSE.txt
+- README.md
+- 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
@@ -92,7 +65,10 @@ files:
 - demo/samples/man/hello.1
 - demo/samples/man/hello.1.html
 - demo/samples/man/hello.1.ronn
+- lib/executable.rb
+- lib/executable/completion.rb
 - lib/executable/core_ext.rb
+- lib/executable/core_ext/unbound_method.rb
 - lib/executable/dispatch.rb
 - lib/executable/domain.rb
 - lib/executable/errors.rb
@@ -100,47 +76,25 @@ files:
 - lib/executable/parser.rb
 - 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
-- test/test_executable.rb
-- HISTORY.rdoc
-- DEMO.rdoc
-- Schedule.reap
-- README.rdoc
-- COPYING.rdoc
-homepage: http://rubyworks.github.com/executable
+homepage: https://github.com/rubyworks/executable
 licenses:
 - BSD-2-Clause
-post_install_message: 
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.11
-signing_key: 
-specification_version: 3
+rubygems_version: 3.6.9
+specification_version: 4
 summary: Commandline Object Mapper
 test_files: []

data/.ruby

@@ -1,61 +0,0 @@
----
-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'

data/.yardopts

@@ -1,7 +0,0 @@
---title "Executable"
---readme README.rdoc
---protected
---private
-lib
--
-[A-Z]*.*