cmd 0.7.0 → 0.7.1

data/CHANGELOG

@@ -1,5 +1,11 @@
 = Cmd Changelog
 
+== Version 0.7.1 
+
+* Broke assignment to READLINE_SUPPORTED over several lines as removing the
+  semicolons resulted in the incorrect behavior, and having the semicolons made
+  RDoc fail to parse the file. [Jim Weirich]
+
 == Version 0.7.0 
 
 * Initial public release

data/Rakefile

@@ -9,7 +9,7 @@ require 'date'
 require 'rbconfig'
 
 PKG_NAME         = 'cmd'
-PKG_VERSION      = '0.7.0'
+PKG_VERSION      = '0.7.1'
 PKG_FILE_NAME    = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_DESTINATION  = "../#{PKG_NAME}"
 PKG_AUTHOR       = 'Marcel Molina Jr.' 

data/TODO

@@ -4,6 +4,38 @@ Send suggestions for this list to marcel@vernix.org.
 
 == Todo list
 
+* The subclassing from Cmd and defining do_ methods for commands paradigm is a
+  bit limiting. So, ideas for radical change:
+
+  Cmd is a module. All do_ methods are no longer the way to write commands.
+  There are two ways to get Cmd functionality into a class.
+  
+  1) You mix in Cmd::Interpreter (or something like that). You then just define
+  methods in the class where Cmd::Interpreter is mixed in, and then use a
+  command macro to indicate that the method is a command.
+
+    e.g. 
+      command :add
+      def add(etc)
+
+  This would be useful fo pre-existing classes that would like to add Cmd
+  behavior. [credit Chad Fowler and Sam Stephenson]
+
+  2) There is a Cmd::Base class that mixes in Cmd::Interpreter. You inherit
+  from Cmd::Base and in this case all methods that are public are commands
+  implicitly without needing to use the +command+ macro. This base class would
+  be a convenience class that automatically defnotes every public method as a
+  command method.
+
+* Cmd::ClassMethods sucks. Using the singleton vars sucks. Create a metaprogramming
+  framework that is self hosting. It would be used to create the domain
+  language that would describe domain languages. [credit Sam Stephenson]
+
+* Create a way to define named-parameter options hashes and define certain
+  options as depending on other options. The allowed parameters should be able
+  to be changed depending on the values of a certain parameter. [credit Sam
+  Stephenson]
+
 * Writing a complete_(command name) is enough to have the completion results be
   displayed, but not enough to actually complete. In order to complete as well
   there must be additional logic such as what complete_grep does. So right now
@@ -76,6 +108,10 @@ Send suggestions for this list to marcel@vernix.org.
 
   I think that's pretty nice.
 
+  UPDATE: The above todo regarding making Cmd a module and having the choice of
+  subclassing Cmd::Base or mixing in something like Cmd::Interpreter obsoletes
+  this approach.
+
 * Take another shot at having more objects (e.g. Command, Subcommand,
   Documentation, etc)
 

data/example/my-phonebook.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'cmd'
+rescue LoadError
+  require File.dirname(__FILE__) + '/../lib/cmd'
+end
+require 'yaml'
+
+class PhoneBook < Cmd
+  STORAGE = File.expand_path('~/.phonebook')
+  
+  doc :list, "List names in phone book."
+  def do_list
+    write @data.names
+  end
+
+  doc :add, "Add an entry into the phone book."
+  def do_add
+    
+  end
+
+  protected
+
+    def setup
+      create_storage_if_need_be
+      File.open(STORAGE) do |file|
+        @data = YAML.load(file)
+      end
+    rescue
+      write "Unable to load phonebook - #$!"
+      exit
+    end
+
+    def create_storage_if_need_be
+      File.open(STORAGE, 'w') unless File.exists?(STORAGE)
+    end
+
+    def postloop
+      save_data
+    end
+
+    def save_data
+      write 'Saving...'
+      File.open(STORAGE, 'w') do |file|
+        file.write YAML.dump(@data)
+      end
+    end
+end
+
+class PhoneBookListing
+
+  attr_accessor :name, :number, :type 
+  def initialize
+  end
+end
+
+class PhoneBookList
+  def initialize
+    @list = []
+  end
+
+  def <<(listing)
+    @list.push listing
+  end
+
+  def names
+    @list.map {|listing| listing.name}.sort
+  end
+end
+
+PhoneBook.run

data/lib/cmd.rb

@@ -1,4 +1,9 @@
-READLINE_SUPPORTED = begin require 'readline' or true rescue LoadError end
+READLINE_SUPPORTED = begin 
+  require 'readline' 
+  true 
+rescue LoadError 
+end
+
 require 'abbrev'
 
 # A simple framework for writing line-oriented command interpreters, based 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.8.8
 specification_version: 1
 name: cmd
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
-date: 2005-04-10
+  version: 0.7.1
+date: 2005-04-11
 summary: A generic class to build line-oriented command interpreters.
 require_paths: 
   - lib
@@ -29,21 +29,23 @@ authors:
 files: 
   - test
   - lib
-  - Rakefile
-  - setup.rb
+  - example
   - AUTHORS
-  - TODO
   - INSTALL
-  - example
-  - CHANGELOG
-  - THANKS
   - MIT-LICENSE
+  - THANKS
+  - Rakefile
   - download
+  - rdoc
+  - setup.rb
+  - TODO
+  - CHANGELOG
   - README
   - lib/cmd.rb
   - test/tc_cmd.rb
-  - example/phonebook.rb
   - example/calc.rb
+  - example/my-phonebook.rb
+  - example/phonebook.rb
 test_files: 
   - test/tc_cmd.rb
 rdoc_options: