optiflag 0.6.5 → 0.7

data/examples/example_2_4.rb

@@ -1,7 +1,7 @@
 require 'optiflag'
 
 # Title:  Other clause-level modifiers, like arity and flag symbol  
-#  Variation 4:  Selectively changing the symbol for a flag, and change the arity to be no-args
+# Description: Variation 4:  Selectively changing the symbol for a flag, and change the arity to be no-args
 module Example extend OptiFlagSet
   flag "dir" do 
     alternate_forms "directory","D","d"

data/examples/example_3.rb

@@ -6,14 +6,16 @@ module Example extend OptiFlagSet
   flag "dir" 
   flag "connection" do
     # this is our new clause-level modifier
-    value_matches ["Connection string must be of the form username/password@servicename", /^\b.+\b\/\b.+@.+$/ ]
+    value_matches ["Connection string must be of the form username/password@servicename", 
+                   /^\b.+\b\/\b.+@.+$/ ]
   end
   optional_flag "mode" do
     # this is our second new clause-level modifier
     value_in_set ["read","write","execute"]
   end
   optional_flag "run_date" do
-    value_matches ["run_date must be of the form mm/DD/YY",/^[0-9]{2}\/[0-9]{2}\/[0-9]{2,4}$/]
+    value_matches ["run_date must be of the form mm/DD/YY",
+                   /^[0-9]{2}\/[0-9]{2}\/[0-9]{2,4}$/]
   end
 
   and_process! 

data/examples/example_6.rb

@@ -5,16 +5,16 @@ require 'optiflag'
 module HashAcess extend OptiFlagSet
   flag "dir"
   flag "log_level"
-  flag "&"
+  flag "and"
   
   and_process!
 end 
 
 puts "Dir is: #{ ARGV.flags[:dir] }"
 puts "Log Level is: #{ ARGV.flags[:log_level] }"
-puts "Ampersand Level is: #{ ARGV.flags[:&] }"
+puts "And Level is: #{ ARGV.flags[:and] }"
 
-#h# ruby example_6.rb -dir "c:/Program Files/Apache Software Foundation/Tomcat 5/" -log_level 3 -& ETALL
+#h# ruby example_6.rb -dir "c:/Program Files/Apache Software Foundation/Tomcat 5/" -log_level 3 -and ETALL
 
 
 

data/optiflag-parse.rb

@@ -2,7 +2,7 @@ module OptiFlag
   module Flagset
     def parse(args,clone=true)
       init_help_bundle()
-      safe_args = args.clone if clone
+      safe_args = args.clone.compact if clone
       safe_args = args if ! clone
       # the following 10 lines were changed so
       # that a module could reparse a command-line
@@ -32,18 +32,19 @@ module OptiFlag
     private
     def init_help_bundle
       # thank god for the ||= operator
-      @help_bundle ||= Help::StandardHelpBundle
+      @help_bundle ||= OptiFlag::Flagset::Help::StandardHelpBundle
     end
     def now_populate_hash(all_flags,safe_args)
       all_flags.each_pair do |k,v| 
         safe_args.flag_value[k.to_sym] = v.value
         v.the_alternate_forms.each do |x|
+
           safe_args.flag_value[x.to_sym] = v.value
         end
       end
     end
      def find_help_flags(safe_args)
-       arg_copy = safe_args.clone
+       arg_copy = safe_args.clone.compact
 
        #first we get rid of all non-help flags... 
        non_help_flags = @all_flags.values.select{|value| !value.for_help }
@@ -57,13 +58,14 @@ module OptiFlag
 
          found,discard = flag_finder_and_stripper(flag,1,arg_copy)
          if found.length > 0
+
            safe_args.help_requested = true
            if found.length == 2
              safe_args.help_requested_on = found[1]
            end
          end
        end     
-       arg_copy = safe_args.clone
+       arg_copy = safe_args.clone.compact
 
        ext_help_flag = @all_flags.values.select{|value| value.for_extended_help }
        if ext_help_flag.length > 0
@@ -76,20 +78,21 @@ module OptiFlag
        end 
      end
      def flag_finder_and_stripper(flag,arity,args)
+       args = args.compact
        idx = args.index(flag)
        if idx == nil 
          return [], args
        end
        the_range = idx..(idx + arity)
-       flag_and_values = args[the_range]       
-       fragment = args[the_range].clone
+       fragment = args[the_range].clone.compact
        args[the_range] = nil
-       return fragment, args
+       return fragment, args.compact
      end
      def populate_values(safe_args)
-       find_the_flag_that_is_actually_used(safe_args)
-       arg_copy = safe_args.clone
+       safe_args = find_the_flag_that_is_actually_used(safe_args)
+       arg_copy = safe_args.clone.compact
        @all_flags.values.each do |flag_obj|
+
          the_string_flag = flag_obj.as_the_form_that_is_actually_used
          flag_and_values, arg_copy = 
              flag_finder_and_stripper(the_string_flag,flag_obj.the_arity,arg_copy)
@@ -99,9 +102,11 @@ module OptiFlag
          end
          flag_obj.value = flag_and_values[1] if flag_and_values.length ==2
          flag_obj.value = true if flag_and_values.length == 1  and flag_obj.the_arity == 0
+
          if flag_and_values.length == 1 and flag_obj.the_arity >0
-           problem = "Argument(s) missing for flag #{ flag_obj.as_the_form_that_is_actually_used }"
-           safe_args.errors ||= Errors.new
+
+           problem = "Argument(s) missing for flag : #{ flag_obj.as_the_form_that_is_actually_used }"
+           safe_args.errors ||= OptiFlag::Flagset::Errors.new
            safe_args.errors.validation_errors << problem
          end
        end
@@ -134,7 +139,7 @@ module OptiFlag
          value = flag_obj.value
          flag_obj.the_validation_rules.each do |proc|
            errors = safe_args.errors
-           errors ||= Errors.new
+           errors ||= OptiFlag::Flagset::Errors.new
            proc.call flag_obj, errors.validation_errors
            if errors.validation_errors.length > 0 
              safe_args.errors = errors
@@ -184,8 +189,8 @@ module OptiFlag
      end
      # private method
      def find_the_flag_that_is_actually_used(safe_args)
-       there_might_be_errors = safe_args.errors || Errors.new
-       args_copy = safe_args.clone
+       there_might_be_errors = safe_args.errors || OptiFlag::Flagset::Errors.new
+       args_copy = safe_args.clone.compact
        @all_flags.values.each do |x|
          shortform,longform = x.as_string_basic,x.as_string_extended
          all_forms = [shortform,longform] + x.as_alternate_forms     
@@ -209,7 +214,7 @@ module OptiFlag
        return safe_args
      end
      def search_for_missing_character_switches(safe_args)
-       these_args = safe_args.clone
+       these_args = safe_args.clone.compact
        return safe_args if @group == nil
        chars_found_for_this_group = {}
        all_chars = ""
@@ -240,11 +245,12 @@ module OptiFlag
      end
 
      def search_for_missing_flags(safe_args)
-       there_might_be_errors = Errors.new
+       there_might_be_errors = OptiFlag::Flagset::Errors.new
        required_flags = @all_flags.values.sort do |x,y| 
          x.order_added <=> y.order_added 
        end.select{ |x| x.the_is_required }
-       args_copy = safe_args.clone
+       #puts "Required flags #{required_flags}"
+       args_copy = safe_args.clone.compact
        required_flags.each do |x| 
          shortform,longform = x.as_string_basic,x.as_string_extended
          all_forms = [shortform,longform] + x.as_alternate_forms
@@ -273,7 +279,7 @@ module OptiFlag
        return safe_args
      end
      def create_api(safe_args)
-       safe_args.extend NewInterface
+       safe_args.extend OptiFlag::Flagset::NewInterface
        safe_args.flag_value =  create_new_value_class()
        return safe_args
      end

data/optiflag.gemspec

@@ -2,7 +2,7 @@ require 'rake'
 Gem::Specification.new do |spec|
 	spec.name = "optiflag"
         spec.require_path = '.'	
-	spec.version = "0.6.5"
+	spec.version = "0.7"
 	spec.summary = "OptiFlag is an embeddable DSL library for declaring and using command-line options/flags in any Ruby program."
 	spec.author = "Daniel Eklund"
 	spec.email = "doeklund@gmail.com"

data/optiflag.rb

@@ -7,7 +7,7 @@
 # Copyright:: Copyright (c) 2006 Daniel O. Eklund. All rights reserved.
 # License:: Ruby license.
 module OptiFlag
-  VERSION = "0.6.5" 
+  VERSION = "0.7" 
 end
 
 load 'optiflag-help.rb'
@@ -301,8 +301,9 @@ But the value must be one of the following: [#{ array_of_acceptable_values.join(
       end
       # clause-level flag-modifier
       def alternate_forms(*args)
-        @the_alternate_forms = *args if args[0].class == Array
+        @the_alternate_forms = args[0] if args[0].class == Array
         @the_alternate_forms =  @the_alternate_forms + args if args[0].class != Array
+
       end
       # clause-level flag-modifier
       def long_form(form)
@@ -377,7 +378,7 @@ module OptiFlag
       end
       @all_flags ||= {} 
       obj = @all_flags[name]      
-      obj ||= EachFlag.new(name,flag,self)
+      obj ||= OptiFlag::Flagset::EachFlag.new(name,flag,self)
       obj.instance_eval &the_block if block_given?
       hash.each_pair do |fxn,val|
         obj.send(fxn,val)
@@ -645,7 +646,7 @@ module OptiFlag
       potential_opt_switch_flags, potential_methods = 
                potential_methods.partition {|x| x =~ /\?$/ }
       potential_methods.each_slice(2) do |getter,setter|
-         if setter == (getter + "=") 
+         if setter.to_s == (getter.to_s + "=") 
            valid_instance_var << [getter,setter]; 
          end  
       end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: optiflag
 version: !ruby/object:Gem::Version 
-  version: 0.6.5
-date: 2007-04-16 00:00:00 -04:00
+  version: "0.7"
+date: 2009-10-19 00:00:00 -04:00
 summary: OptiFlag is an embeddable DSL library for declaring and using command-line options/flags in any Ruby program.
 require_paths: 
 - .
@@ -29,110 +29,7 @@ post_install_message:
 authors: 
 - Daniel Eklund
 files: 
-- doc
 - examples
-- optiflag-help.rb
-- optiflag-parse.rb
-- optiflag.gemspec
-- optiflag.rb
-- quick.rb
-- ReleaseNotes.txt
-- testcases
-- doc/classes
-- doc/created.rid
-- doc/files
-- doc/fr_class_index.html
-- doc/fr_file_index.html
-- doc/fr_method_index.html
-- doc/index.html
-- doc/rdoc-style.css
-- doc/classes/OptiFlag
-- doc/classes/OptiFlag.html
-- doc/classes/OptiFlag.src
-- doc/classes/OptiFlag/Flagset
-- doc/classes/OptiFlag/Flagset.html
-- doc/classes/OptiFlag/Flagset.src
-- doc/classes/OptiFlag/Flagset/EachFlag.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src
-- doc/classes/OptiFlag/Flagset/Errors.html
-- doc/classes/OptiFlag/Flagset/Errors.src
-- doc/classes/OptiFlag/Flagset/Help
-- doc/classes/OptiFlag/Flagset/Help.html
-- doc/classes/OptiFlag/Flagset/NewInterface.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000024.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000025.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000026.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000027.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000028.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000029.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000030.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000031.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000032.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000033.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000034.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000035.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000036.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000037.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000038.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000039.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000040.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000041.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000042.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000043.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000044.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000045.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000046.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000047.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000048.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000049.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000050.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000051.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000052.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000053.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000054.html
-- doc/classes/OptiFlag/Flagset/EachFlag.src/M000055.html
-- doc/classes/OptiFlag/Flagset/Errors.src/M000021.html
-- doc/classes/OptiFlag/Flagset/Errors.src/M000022.html
-- doc/classes/OptiFlag/Flagset/Errors.src/M000023.html
-- doc/classes/OptiFlag/Flagset/Errors.src/M000024.html
-- doc/classes/OptiFlag/Flagset/Errors.src/M000025.html
-- doc/classes/OptiFlag/Flagset/Errors.src/M000026.html
-- doc/classes/OptiFlag/Flagset/Help/Bundle.html
-- doc/classes/OptiFlag/Flagset/Help/Bundle.src
-- doc/classes/OptiFlag/Flagset/Help/StandardHelpBundle.html
-- doc/classes/OptiFlag/Flagset/Help/Bundle.src/M000018.html
-- doc/classes/OptiFlag/Flagset/Help/Bundle.src/M000019.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src/M000017.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src/M000018.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src/M000019.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src/M000020.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src/M000021.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src/M000022.html
-- doc/classes/OptiFlag/Flagset/NewInterface.src/M000023.html
-- doc/classes/OptiFlag/Flagset.src/M000003.html
-- doc/classes/OptiFlag/Flagset.src/M000004.html
-- doc/classes/OptiFlag/Flagset.src/M000005.html
-- doc/classes/OptiFlag/Flagset.src/M000006.html
-- doc/classes/OptiFlag/Flagset.src/M000007.html
-- doc/classes/OptiFlag/Flagset.src/M000008.html
-- doc/classes/OptiFlag/Flagset.src/M000009.html
-- doc/classes/OptiFlag/Flagset.src/M000010.html
-- doc/classes/OptiFlag/Flagset.src/M000011.html
-- doc/classes/OptiFlag/Flagset.src/M000012.html
-- doc/classes/OptiFlag/Flagset.src/M000013.html
-- doc/classes/OptiFlag/Flagset.src/M000014.html
-- doc/classes/OptiFlag/Flagset.src/M000015.html
-- doc/classes/OptiFlag/Flagset.src/M000016.html
-- doc/classes/OptiFlag/Flagset.src/M000017.html
-- doc/classes/OptiFlag.src/M000001.html
-- doc/classes/OptiFlag.src/M000002.html
-- doc/classes/OptiFlag.src/M000003.html
-- doc/files/optiflag-help_rb.html
-- doc/files/optiflag-parse_rb.html
-- doc/files/optiflag_rb.html
-- doc/files/optiflag_rb.src
-- doc/files/optiflag_rb.src/M000001.html
 - examples/example_1.rb
 - examples/example_1_1.rb
 - examples/example_1_2.rb
@@ -147,6 +44,12 @@ files:
 - examples/example_6.rb
 - examples/example_7.rb
 - examples/example_8.rb
+- optiflag-help.rb
+- optiflag-parse.rb
+- optiflag.gemspec
+- optiflag.rb
+- ReleaseNotes.txt
+- testcases
 - testcases/tc_advanced_usage_helping.rb
 - testcases/tc_basic_alternate_forms.rb
 - testcases/tc_basic_char_flags.rb

data/doc/classes/OptiFlag.html

@@ -1,439 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: OptiFlag</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">OptiFlag</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/optiflag-help_rb.html">
-                optiflag-help.rb
-                </a>
-        <br />
-                <a href="../files/optiflag-parse_rb.html">
-                optiflag-parse.rb
-                </a>
-        <br />
-                <a href="../files/optiflag_rb.html">
-                optiflag.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-<a href="OptiFlag.html">OptiFlag</a> is the module that provides
-namespacing for the entire optiflag functionality. For usage and examples,
-see <a href="http://optiflag.rubyforge.org">optiflag.rubyforge.org</a>
-</p>
-<h1>Terminology</h1>
-<p>
-Please treat the following terminology as specific only to the <a
-href="OptiFlag.html">OptiFlag</a> code suite. In the remaining RDoc, we
-shall try to emphasize this consistent terminology with italics. If you see
-an italicized phrase, chances are that it is defined here.
-</p>
-<h2>Flag Set Declaration</h2>
-<p>
-A <em>flag set declaration</em> is a set of flag declarations created by
-the user of the <a href="OptiFlag.html">OptiFlag</a> suite and corresponds
-to the following code snippet:
-</p>
-<pre>
-  module AppArgs extend OptiFlagSet
-     # individual flag declaration goes here ...
-     # ... and here
-  end
-</pre>
-<p>
-In this case, the module <b>AppArgs</b> is a <em>flag set declaration</em>,
-and all code within the module definition (i.e. up to the end of <b>end</b>
-of the module) is either a <em>flag declaration</em> or a special command.
-</p>
-<p>
-Another way to treat this declaration is as a demarcation between the
-normal Ruby world and the mini-DSL (Domain Specific Language) that <a
-href="OptiFlag.html">OptiFlag</a> offers. In this view, the declaration
-provides a DSL-zone in which the DSL is allowed.
-</p>
-<pre>
-  module AppArgs extend OptiFlagSet
-     # DSL-zone
-     # DSL-zone  (for declaring and modifying flags)
-     # DSL-zone
-  end
-</pre>
-<p>
-the first line
-</p>
-<pre>
-  module AppArgs extend OptiFlagSet
-</pre>
-<p>
-is really just rote.
-</p>
-<p>
-Supply your own module argument name and make sure it extends this <a
-href="OptiFlag/Flagset.html">OptiFlag::Flagset</a> as is written. You will
-then have a scoped space to write in a command line DSL.
-</p>
-<h2>Flag Declaration</h2>
-<p>
-A <em>flag declaration</em> is placed within a <em>flag set
-declaration</em> to indicate that one input parameter per declaration is
-requested from the command line. A <em>flag declaration</em> is the
-mini-DSL&#8216;s main programming construct. In the following code, four
-<em>flag declarations</em> are placed within the overall <em>flag
-<b>set</b> declaration</em> named AppArgs:
-</p>
-<pre>
-    module AppArgs extend OptiFlagSet
-      flag &quot;dir&quot;
-      flag &quot;log&quot;
-      flag &quot;username&quot;
-      flag &quot;password&quot;
-    end
-</pre>
-<p>
-Please note that there are other <em>flag set declaration</em> nouns other
-than flag. For instance in the following snippet:
-</p>
-<pre>
-    module Example extend OptiFlagSet
-      flag &quot;dir&quot; do
-        alternate_forms &quot;directory&quot;,&quot;D&quot;,&quot;d&quot;
-        description &quot;The Appliction Directory&quot;
-      end
-      optional_flag &quot;log&quot; do
-        description &quot;The directory in which to find the log files&quot;
-        long_form &quot;logging-directory&quot; # long form is keyed after the '--' symbol
-      end
-      flag &quot;username&quot;, :description =&gt; &quot;Database username.&quot;  # alternate form
-      flag &quot;password&quot; do
-        description &quot;Database password.&quot;
-      end
-      usage_flag &quot;h&quot;,&quot;help&quot;,&quot;?&quot;
-      extended_help_flag &quot;superhelp&quot;
-
-      and_process!
-    end
-</pre>
-<p>
-there are six <em>flag declarations</em> in total:
-</p>
-<ul>
-<li>a flag named &quot;dir&quot;
-
-</li>
-<li>an optional flag named &quot;log&quot;
-
-</li>
-<li>a flag named &quot;username&quot;
-
-</li>
-<li>a flag named &quot;password&quot;
-
-</li>
-<li>a usage flag for summoning help on how to use the flags
-
-</li>
-<li>an extended help flag for summoning detailed usage for the flags
-
-</li>
-</ul>
-<p>
-Everything else is either a <em>clause level modifier</em> (e.g.
-alternate_forms, description, etc.) or a <em>special command</em>.
-</p>
-<p>
-<b>For a list of all <em>flag set declarations</em> and how to use them,
-see the RDoc for the <a href="OptiFlag/Flagset.html">OptiFlag::Flagset</a>
-module.</b>
-</p>
-<h2>Clause Level Modifier</h2>
-<p>
-As seen above, a <em>clause level modifier</em> is a word used to modify
-the basic flag, usually within a nested do block. It it this nesting which
-has inspired the use of the word clause. For instance:
-</p>
-<pre>
-    module Example extend OptiFlagSet
-      flag &quot;dir&quot; do
-        alternate_forms &quot;directory&quot;,&quot;D&quot;,&quot;d&quot;
-        description &quot;The Appliction Directory&quot;
-      end
-    end
-</pre>
-<p>
-We could read this as a sentence: &#8216;Create a flag &quot;dir&quot;
-which has three alternate forms &quot;directory&quot;, &quot;D&quot;, and
-&quot;d&quot; and which has a description that reads &quot;The Application
-Directory&#8217;.
-</p>
-<p>
-For the most part, these <em>clause level modifiers</em> are nested within
-a do-block, though <a href="OptiFlag.html">OptiFlag</a> allows us to
-conserve vertical space by using symbol hashes. (It is recommended that one
-only uses these in simple cases). For instance, the following two <em>flag
-set declarations</em> are equivalent:
-</p>
-<pre>
-    module Example extend OptiFlagSet
-      flag &quot;username&quot;, :description =&gt; &quot;Database username.&quot;  # alternate form
-
-      and_process!
-    end
-</pre>
-<p>
-and
-</p>
-<pre>
-    module Example extend OptiFlagSet
-      flag &quot;username&quot; do
-         description &quot;Database username.&quot;
-      end
-
-      and_process!
-    end
-</pre>
-<p>
-with the first being a syntactically friendly hash of the <em>clause level
-modifier</em> as a symbol pointing to the value of the modification.
-</p>
-<p>
-For a complete list of <em>clause level modifiers</em> see the RDoc for <a
-href="OptiFlag/Flagset/EachFlag.html">OptiFlag::Flagset::EachFlag</a>
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000003">Flagset</a>&nbsp;&nbsp;
-      <a href="#M000002">using_object</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-
-      Module <a href="OptiFlag/Flagset.html" class="link">OptiFlag::Flagset</a><br />
-
-    </div>
-
-    <div id="constants-list">
-      <h3 class="section-bar">Constants</h3>
-
-      <div class="name-list">
-        <table summary="Constants">
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">VERSION</td>
-          <td>=</td>
-          <td class="context-item-value">&quot;0.7&quot;</td>
-        </tr>
-        </table>
-      </div>
-    </div>
-
-
-
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
-
-        <div class="method-heading">
-          <a href="OptiFlag.src/M000003.html" target="Code" class="method-signature"
-            onclick="popupCode('OptiFlag.src/M000003.html');return false;">
-          <span class="method-name">Flagset</span><span class="method-args">(hash)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-This is a method that looks like a module. It is an excellent example of
-the syntactic tricks that ruby permits us. This method allows us to provide
-code like the following:
-</p>
-<pre>
-   module Example extend OptiFlagSet(:flag_symbol =&gt; &quot;/&quot;)
-     flag &quot;dir&quot;
-     flag &quot;log&quot;
-     flag &quot;username&quot;
-     flag &quot;password&quot;
-
-     and_process!
-   end
-</pre>
-<p>
-You will note that the top line looks a lot like the standard top line
-</p>
-<pre>
-   # our top line
-   module Example extend OptiFlagSet(:flag_symbol =&gt; &quot;/&quot;)
-</pre>
-<p>
-versus
-</p>
-<pre>
-   # standard top line
-   module Example extend OptiFlagSet
-</pre>
-<p>
-The difference is that while the latter (a standard top line) is a
-reference to a module, the former is a call to this method, that
-<b>returns</b> the <a href="OptiFlag/Flagset.html">OptiFlag::Flagset</a>
-module with some defaults changed.
-</p>
-<p>
-As of now the only symbol/method supported by this method that looks like a
-module, is the &#8216;<a
-href="OptiFlag/Flagset.html#M000005">OptiFlag::Flagset.flag_symbol</a>&#8217;
-class method.
-</p>
-<p>
-For those still not understanding the syntactic trick, or who find it odd,
-consider that something similar to this is done in the ruby core language
-using the proxy/delegate pattern. (See delegate.rb in the Ruby core
-library)
-</p>
-<pre>
-  class Tempfile &lt; DelegateClass(File)
-    # ...
-    # ...
-  end
-</pre>
-<p>
-You will note that the DelegateClass() is also a method that superficially
-resembles a class that parameterizes itself. This can be done because Ruby
-expects:
-</p>
-<pre>
-   class &lt;identifier&gt;  &lt;  &lt;expression&gt;
-</pre>
-<p>
-and not
-</p>
-<pre>
-   class &lt;identifier&gt;  &lt;  &lt;identifier&gt;
-</pre>
-<p>
-like some other languages. And likewise
-</p>
-<pre>
-   module &lt;identifier&gt; extend  &lt;expression&gt;
-</pre>
-<p>
-which allows us to create this method which has the exact same name as the
-module. Clever ruby.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000002" class="method-detail">
-        <a name="M000002"></a>
-
-        <div class="method-heading">
-          <a href="OptiFlag.src/M000002.html" target="Code" class="method-signature"
-            onclick="popupCode('OptiFlag.src/M000002.html');return false;">
-          <span class="method-name">using_object</span><span class="method-args">(a_single_object,&amp;the_block)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Special command (at the same level as a <em>flag declaration</em>)
-</p>
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>