choice 0.1.0

data/lib/choice/version.rb

@@ -0,0 +1,8 @@
+module Choice
+  module Version #:nodoc:
+    STRING = "0.1.0"
+    MAJOR  = 0
+    MINOR  = 1
+    TINY   = 0
+  end
+end

data/lib/choice/writer.rb

@@ -0,0 +1,186 @@
+module Choice
+  # This module writes to the screen.  As of now, its only real use is writing
+  # the help screen.
+  module Writer #:nodoc: all
+    
+    # Some constants used for printing and line widths
+    SHORT_LENGTH = 6
+    SHORT_BREAK_LENGTH = 2 
+    LONG_LENGTH = 29
+    PRE_DESC_LENGTH = SHORT_LENGTH + SHORT_BREAK_LENGTH + LONG_LENGTH
+    
+    
+    # The main method.  Takes a hash of arguments with the following possible
+    # keys, running them through the appropriate method:
+    #  banner, header, options, footer
+    #
+    # Can also be told where to print (default STDOUT) and not to exit after
+    # printing the help screen, which it does by default.
+    def self.help(args, target = STDOUT, dont_exit = false)
+      # Set our printing target.
+      self.target = target
+
+      # The banner method needs to know about the passed options if it's going
+      # to do its magic.  Only really needs :options if :banner is nil.
+      banner(args[:banner], args[:options])
+
+      # Run these three methods, passing in the appropriate hash element.
+      %w[header options footer].each do |meth|
+        send(meth, args[meth.to_sym])
+      end
+
+      # Exit.  Unless you don't want to.
+      exit unless dont_exit
+    end
+
+    class <<self
+      private
+      
+      # Print a passed banner or assemble the default banner, which is usage.
+      def banner(banner, options)
+        if banner
+          puts banner
+        else
+          # Usage needs to know about the defined options.
+          usage(options)
+        end
+      end
+      
+      # Print our header, which is just lines after the banner and before the
+      # options block.  Needs an array, prints each element as a line.
+      def header(header)
+        if header.is_a?(Array) and header.size > 0
+          header.each { |line| puts line }
+        end
+      end
+
+      # Print out the options block by going through each option and printing
+      # it as a line (or more).  Expects an array.
+      def options(options)
+        # Do nothing if there's nothing to do.
+        return if options.nil? || !options.size
+        
+        # If the option is a hash, run it through option_line.  Otherwise
+        # just print it out as is.
+        options.each do |name, option|
+          if option.respond_to?(:to_h)
+            option_line(option.to_h)          
+          else
+            puts name
+          end
+        end
+      end
+      
+      # The heavy lifting: print a line for an option.  Has intimate knowledge
+      # of what keys are expected.
+      def option_line(option)
+        # Expect a hash
+        return unless option.is_a?(Hash)
+
+        # Make this easier on us
+        short = option['short']
+        long = option['long']
+        line = ''
+
+        # Get the short part.
+        line << sprintf("%#{SHORT_LENGTH}s", short)
+        line << sprintf("%-#{SHORT_BREAK_LENGTH}s", (',' if short && long))
+
+        # Get the long part.
+        line << sprintf("%-#{LONG_LENGTH}s", long)
+
+        # Print what we have so far
+        print line
+
+        # If there's a desc, print it.
+        if option['desc']
+          # If the line is too long, spill over to the next line
+          if line.length > PRE_DESC_LENGTH
+            puts           
+            print " " * PRE_DESC_LENGTH
+          end
+
+          puts option['desc'].shift
+          
+          # If there is more than one desc line, print each one in succession
+          # as separate lines.
+          option['desc'].each do |desc| 
+            puts ' '*37 + desc
+          end
+
+        else
+          # No desc, just print a newline.
+          puts 
+
+        end
+      end
+      
+      # Expects an array, prints each element as a line.
+      def footer(footer)
+        footer.each { |line| puts line } unless footer.nil?
+      end
+      
+      # Prints the usage statement, e.g. Usage prog.rb [-abc]
+      # Expects an array.
+      def usage(options)
+        # Really we just need an enumerable.
+        return unless options.respond_to?(:each)
+
+        # Start off the options with a dash.
+        opts = '-'
+
+        # Figure out the option shorts.
+        options.dup.each do |option|
+          # We really need an array here.
+          next unless option.is_a?(Array)
+
+          # Grab the hash of the last element, which should be the second 
+          # element.
+          option = option.last.to_h
+
+          # Add the short to the options string.
+          opts << option['short'].sub('-','') if option['short']
+        end
+        
+        # Figure out if we actually got any options.
+        opts = if opts =~ /^-(.+)/
+                 " [#{opts}]"
+               end.to_s
+        
+        # Print it out, with our newly aquired options string.
+        puts "Usage: #{program}" <<  opts
+      end
+
+      # Figure out the name of this program based on what was run.
+      def program
+        if (/(\/|\\)/ =~ $0) then File.basename($0) else $0 end
+      end
+
+      # Set where we print.
+      def target=(target)
+        @@target = target
+      end
+      
+      # Where do we print?
+      def target
+        @@target
+      end
+
+      # Fake puts
+      def puts(str = nil)
+        str = '' if str.nil?
+        print(str + "\n")
+      end
+      
+      # Fake printf
+      def printf(format, *args)
+        print(sprintf(format, *args))
+      end
+
+      # Fake print -- just add to target, which may not be STDOUT.
+      def print(str)
+        target << str 
+      end
+    end
+  end
+end

data/test/test_choice.rb

@@ -0,0 +1,119 @@
+$:.unshift "../lib:lib"
+require 'test/unit'
+require 'choice'
+
+class TestChoice < Test::Unit::TestCase
+  
+  def setup
+    Choice.reset
+    Choice.dont_exit_on_help = true
+  end
+    
+  def test_choices
+    Choice.options do
+      header "Tell me about yourself?"
+      header ""
+      option :band do
+        short "-b"
+        long "--band=BAND"
+        cast String
+        desc "Your favorite band."
+        validate /\w+/
+      end
+      option :animal do
+        short "-a"
+        long "--animal=ANIMAL"
+        cast String
+        desc "Your favorite animal."
+      end
+      footer ""
+      footer "--help This message"
+    end
+    
+    band = 'LedZeppelin'
+    animal = 'Reindeer'
+    
+    args = ['-b', band, "--animal=#{animal}"]
+    Choice.args = args
+    
+    assert_equal band, Choice.choices['band']
+    assert_equal animal, Choice.choices[:animal]
+    assert_equal ["Tell me about yourself?", ""], Choice.header
+    assert_equal ["", "--help This message"], Choice.footer
+  end
+  
+  def test_failed_parse
+    assert Hash.new, Choice.parse
+  end
+  
+  HELP_STRING = ''
+  def test_help
+    Choice.output_to(HELP_STRING)
+    Choice.args = ['-m', 'lunch', '--help']
+    
+    Choice.options do
+      banner "Usage: choice [-mu]"
+      header ""
+      option :meal do
+        short '-m'
+        desc 'Your favorite meal.'
+      end
+      
+      separator ""
+      separator "And you eat it with..."
+      
+      option :utencil do
+        short "-u"
+        long "--utencil=[UTENCIL]"
+        desc "Your favorite eating utencil."
+      end
+    end
+    
+    help_string = <<-HELP
+Usage: choice [-mu]
+
+    -m                               Your favorite meal.
+
+And you eat it with...
+    -u, --utencil=[UTENCIL]          Your favorite eating utencil.
+HELP
+
+    assert_equal help_string, HELP_STRING
+  end
+  
+  UNKNOWN_STRING = ''
+  def test_unknown_argument
+    Choice.output_to(UNKNOWN_STRING)
+    Choice.args = ['-m', 'lunch', '--motorcycles']
+    
+    Choice.options do
+      banner "Usage: choice [-mu]"
+      header ""
+      option :meal do
+        short '-m'
+        desc 'Your favorite meal.'
+      end
+      
+      separator ""
+      separator "And you eat it with..."
+      
+      option :utencil do
+        short "-u"
+        long "--utencil=[UTENCIL]"
+        desc "Your favorite eating utencil."
+      end
+    end
+    
+    help_string = <<-HELP
+Usage: choice [-mu]
+
+    -m                               Your favorite meal.
+
+And you eat it with...
+    -u, --utencil=[UTENCIL]          Your favorite eating utencil.
+HELP
+    
+    assert_equal help_string, UNKNOWN_STRING
+  end
+  
+end

data/test/test_lazyhash.rb

@@ -0,0 +1,76 @@
+$:.unshift "../lib:lib"
+require 'test/unit'
+require 'choice/lazyhash'
+
+class TestLazyHash < Test::Unit::TestCase
+  
+  def test_symbol
+    name = 'Igor'
+    age = 41
+    
+    hash = Choice::LazyHash.new
+    hash['name'] = name
+    hash[:age] = age
+   
+    assert_equal name, hash[:name]
+    assert_equal age, hash[:age]
+  end
+  
+  def test_string
+    name = "Frank Stein"
+    age = 30
+    
+    hash = Choice::LazyHash.new
+    hash[:name] = name
+    hash['age'] = age
+    
+    assert_equal name, hash['name']
+    assert_equal age, hash['age']
+  end
+  
+  def test_store_and_fetch
+    name = 'Jimini Jeremiah'
+    job = 'Interior Decorator'
+    
+    hash = Choice::LazyHash.new
+    hash.store('name', name)
+    hash.store(:job, job)
+    
+    assert_equal name, hash.fetch(:name)
+    assert_equal job, hash.fetch('job')
+  end
+  
+  def test_messages
+    star = 'Sol'
+    planet = 'Mars'
+
+    hash = Choice::LazyHash.new
+    hash.star = star
+    hash.planet = planet
+
+    assert_equal star, hash.star
+    assert_equal planet, hash.planet
+  end
+
+  def test_from_hash
+    state = 'Nebraska'
+    country = 'Mexico'
+
+    hash = { :state => state, :country => country }
+    lazy = Choice::LazyHash.new(hash)
+
+    assert_equal state, lazy['state']
+    assert_equal country, lazy[:country]
+  end
+  
+  def test_to_lazyhash
+    hash = { :name => 'Jimmy', :age => 25 }
+    lazy = hash.to_lazyhash
+
+    assert_equal hash[:name], lazy.name
+    assert_equal hash[:name], lazy[:name]
+    assert_equal hash[:age], lazy.age
+    assert_equal hash[:age], lazy[:age]
+  end
+
+end

data/test/test_option.rb

@@ -0,0 +1,144 @@
+$:.unshift "../lib:lib"
+require 'test/unit'
+require 'choice/option'
+
+class TestOption < Test::Unit::TestCase
+  def setup
+    Choice.reset
+    @option = Choice::Option.new
+  end
+  
+  def test_desc
+    line_one = "This is a description."
+    line_two = "I can add many lines."
+    line_three = "There is no limit."
+    
+    assert_equal false, @option.desc?
+    
+    @option.desc line_one
+    @option.desc line_two
+    
+    assert @option.desc?    
+    assert_equal [line_one, line_two], @option.desc
+    
+    @option.desc line_three
+    assert @option.desc?    
+    assert_equal [line_one, line_two, line_three], @option.desc
+  end
+  
+  def test_choice
+    short = "-p"
+    
+    assert_equal false, @option.short?
+    
+    @option.short short
+    
+    assert @option.short?
+    assert_equal short, @option.short
+  end
+  
+  def test_no_choice
+    default = 42
+    
+    assert_raise(Choice::Option::ParseError) do
+      @option.defaut?
+    end
+    
+    assert_raise(Choice::Option::ParseError) do
+      @option.defaut default
+    end    
+    
+    assert_raise(Choice::Option::ParseError) do
+      @option.defaut
+    end    
+
+  end
+  
+  def test_block_choice
+    assert_equal false, @option.action?
+
+    @option.action do 
+      1 + 1
+    end
+
+    assert @option.action?
+    assert_block(&@option.action)
+  end
+  
+  def test_default_option
+    option = Choice::Option.new('port')
+    
+    assert_equal '-p', option.short
+    assert_equal '--port=PORT', option.long
+  end  
+  
+  def test_format
+    @option = Choice::Option.new do
+      validate /^\w+$/
+    end
+    
+    assert_equal /^\w+$/, @option.validate
+  end  
+  
+  def test_dsl
+    @option = Choice::Option.new do
+      short "-h"
+      long "--host=HOST"
+      cast String
+      desc "The hostname."
+      desc "(Alphanumeric only)"
+      filter do
+        5 * 10
+      end
+    end
+
+    assert_equal "-h", @option.short
+    assert_equal "--host=HOST", @option.long
+    assert_equal String, @option.cast
+    assert_equal ["The hostname.", "(Alphanumeric only)"], @option.desc
+    assert_equal proc { 5 * 10 }.call, @option.filter.call
+  end
+  
+  def test_to_a
+    desc = "This is your description."
+    short = "-t"
+    long = "--test=METHOD"
+    default = :to_a
+    
+    @option.desc desc
+    @option.short short
+    @option.long long
+    @option.default default
+    @option.action { 1 + 1 }
+    array = @option.to_a
+        
+    assert_equal Choice::Option, @option.class
+    assert_equal Array, array.class
+    assert array.include?([desc])
+    assert array.include?(short)
+    assert array.include?(long)
+    assert array.include?(default)
+    assert_equal proc { 1 + 1 }.call, array.select { |a| a.is_a? Proc }.first.call
+  end
+  
+  def test_to_h
+    desc = "This is your description."
+    short = "-t"
+    long = "--test=METHOD"
+    cast = Integer
+    
+    @option.desc desc
+    @option.short short
+    @option.long long
+    @option.cast cast
+    @option.filter { 2 + 2 }
+    hash = @option.to_h
+        
+    assert_equal Choice::Option, @option.class
+    assert_equal Hash, hash.class
+    assert_equal [desc], hash['desc']
+    assert_equal short, hash['short']
+    assert_equal cast, hash['cast']    
+    assert_equal proc { 2 + 2 }.call, hash['filter'].call
+  end
+end