usage 0.0.3 → 0.0.4

data/CHANGES

@@ -1,3 +1,13 @@
+======== Version 0.4 ==============================================================
+
+This version adds open-uri support. This adds a new built-in file type:
+
+	<@ - Either a local file or a URI that is http:// or ftp://. Also, filenames that
+	     start with www. are prepended automatically with http:// and filenames that
+	     start with ftp. are prepended automatically with ftp://
+
+	Added sample12.rb to show how this new type works.
+
 ======== Version 0.3 ==============================================================
 
 The biggest change in version 0.3 is that the argument type architecture is 

data/README

@@ -124,6 +124,9 @@ long, long ago). Note: These can be replaced or added to.
 	>> - A file that will be appended to
 	>? - A file that will be written to but the user is prompted if it already exists
 	>>? - A file that will be appended to but the user is prompted if the file doesn't exist
+	<@ - Either a local file or a URI that is http:// or ftp://. Also, filenames that
+	     start with www. are prepended automatically with http:// and filenames that
+	     start with ftp. are prepended automatically with ftp://
 
 So when you send the argument message to the usage object, you will get a value of that
 type and if the user does not give that type, then they get an error message.

data/lib/Usage.rb

@@ -1,5 +1,6 @@
 require "rubygems"
 require_gem "SimpleTrace", "<= 0.1.0"
+require "open-uri"
 
 # 
 # Use module to hide usage classes
@@ -116,6 +117,22 @@ class FileAppendDoesntExistError < Error
 	end
 end
 
+class IOInputError < Error
+	attr_reader :uri, :msg
+	def initialize(uri, msg)
+		@uri = uri
+		super("error opening input: '#{uri}' because #{msg}")
+	end
+end
+
+class OpenURIBadFormatError < Error
+	attr_reader :uri
+	def initialize(uri)
+		@uri = uri
+		super("URI must be of the form: http:// or ftp://, not '#{uri}'")
+	end
+end
+
 # ------------------------------- Parsing Errors -----------------------------
 
 #
@@ -505,6 +522,39 @@ class FileReadLinesPlugin < ArgumentParserPlugin
 	end
 end
 
+class OpenURIInputPlugin < FilePlugin
+	def initialize(usage_ui, str)
+		$TRACE.debug 5, "trying to open uri '#{str}' for input"
+
+		# see if it looks like a URI
+		m = /^(\w+):\/\//.match(str)
+
+		# if it matches and its not either http or ftp (which is all open-uri
+		# does at this point
+		if m && !(["http", "ftp"].include?(m[1].downcase)) then
+			# tell the user
+			raise OpenURIBadFormatError.new(str)
+		end
+
+		# if it starts with www. or ftp. then just pre-pend the transport protocol
+		if m = /^(www|ftp)\./i.match(str) then
+			if m[1].downcase == "www" then
+				str = "http://" + str
+			else
+				str = "ftp://" + str
+			end
+		end
+		
+		# try opening it with open-uri
+		begin
+			@value = open(str)
+		rescue Exception => e
+			puts e.message
+			raise IOInputError.new(str, e.message)
+		end
+	end
+end
+
 #
 # This is the class that does the heavy lifting for the Usage class. It parses the
 # usage string, options string and makes the information available by using 
@@ -529,6 +579,7 @@ class Base
 			add_type_handler(">?", FileOutputQueryPlugin)
 			add_type_handler("<", FileInputPlugin)
 			add_type_handler(">", FileOutputPlugin)
+			add_type_handler("<@", OpenURIInputPlugin)
 		end
 	end
 

data/samples/Sample1.rb

@@ -1,7 +1,7 @@
 #
 # This is the simplist usage case (only required args)
 #
-require "Usage"
+require "usage"
 
 usage = Usage.new "infile outfile"
 

data/samples/Sample2.rb

@@ -1,7 +1,7 @@
 #
 # This is illustrates handling infinite arguments
 #
-require "Usage"
+require "usage"
 
 usage = Usage.new "outfile infiles..."
 

data/samples/Sample3.rb

@@ -5,7 +5,7 @@
 # #optional_arg returns the first argument and #required_arg returns the 
 # second.
 #
-require "Usage"
+require "usage"
 
 usage = Usage.new "required_arg [optional_arg] "
 

data/samples/Sample4.rb

@@ -7,7 +7,7 @@
 # When the usage is reported to the user, the parenthesis are not included.
 #
 
-require "Usage"
+require "usage"
 
 usage = Usage.new "[-y] [-x excluded_tags] (-z ztag) (-w warning_arg) files..."
 

data/samples/Sample5.rb

@@ -1,7 +1,7 @@
 #
 # This illustrates how to use long options (ie. --option)
 #
-require "Usage"
+require "usage"
 
 usage = Usage.new "-x files...", <<EOT
 -x,--exclusive		specifies exclusive access to the files

data/samples/Sample6.rb

@@ -3,7 +3,7 @@
 # starts with % indicates and Integer and a @ indicates a
 # date/time (a Time object is produced).
 #
-require "Usage"
+require "usage"
 
 usage = Usage.new "%num_times @on_date"
 

data/samples/Sample7.rb

@@ -1,7 +1,7 @@
 #
 # This sample shows how to use choice arguments
 #
-require "Usage"
+require "usage"
 
 usage = Usage.new "[-a coffee|tea|milk]"
 

data/samples/Sample8.rb

@@ -1,7 +1,7 @@
 #
 # This is an example of a simple copy program
 #
-require "Usage"
+require "usage"
 
 Usage.new "<infile >outfile" do |usage|
 	usage.outfile.write(usage.infile.read)

data/samples/sample10.rb

@@ -2,7 +2,7 @@
 # This appends the input file to the output file and prompts the
 # user if the output file exists
 #
-require "Usage"
+require "usage"
 
 Usage.new "<infile >>?outfile" do |usage|
 	usage.outfile.write(usage.infile.read)

data/samples/sample11.rb

@@ -2,7 +2,7 @@
 # This sample takes the input file, sorts and writes it to the output
 # It demonstrates the use of readlines to read in the input file.
 #
-require "Usage"
+require "usage"
 
 Usage.new "<<infile >outfile" do |usage|
 	usage.outfile.write(usage.infile.sort.join(""))

data/samples/sample12.rb

@@ -0,0 +1,8 @@
+#
+# This is an example of a copying where the input uses open-uri program
+#
+require "usage"
+
+Usage.new "<@infile >outfile" do |usage|
+	usage.outfile.write(usage.infile.read)
+end

data/samples/sample9.rb

@@ -2,7 +2,7 @@
 # This copy program prompts the user if they wish to overwrite
 # the output file (if it exists)
 #
-require "Usage"
+require "usage"
 
 Usage.new "<infile >?outfile" do |usage|
 	usage.outfile.write(usage.infile.read)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.3
 specification_version: 1
 name: usage
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2005-10-15
+  version: 0.0.4
+date: 2005-10-17
 summary: This module implements a simple no thought command line option parser
 require_paths: 
   - lib
@@ -35,6 +35,7 @@ files:
   - samples/Sample1.rb
   - samples/sample10.rb
   - samples/sample11.rb
+  - samples/sample12.rb
   - samples/Sample2.rb
   - samples/Sample3.rb
   - samples/Sample4.rb