pickled_optparse 0.1.0 → 0.1.1

data/HISTORY.rdoc

@@ -0,0 +1,14 @@
+=== Version 0.1.1
+
+No functional differences just some internal refactoring and clean up.
+
+* Replaced intrusive replacement of make_switch with a wrapper and alias.
+* Minor reorginization of directories to follow best practices.
+* Added Jeweler style versioning.
+* Cleaned up and moved example.rb to examples directory (best practices?).
+* Cleaned up rakefile.
+* Kludged the hell out of rdoc to make it allow example ruby files in the files section.
+
+=== Version 0.1.0
+
+Initial release.

data/README.rdoc

@@ -16,9 +16,10 @@ Then at the end of your OptionParser block add something like this:
     exit
   end
 
-You of course need to require the "pickled_optparse" gem but that's it. You don't need to require the opt_parse file because that's already handled for you.
+You of course need to require the "pickled_optparse" gem but that's it. 
+You don't need to require the opt_parse file because that's already handled for you.
 
-For a complete usage example see the lib/example.rb file.
+For a complete usage example see the examples/example.rb file.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -1,17 +1,23 @@
 require 'rubygems'
 require 'rake'
 
+$:.unshift 'lib'
+require 'pickled_optparse/version'
+version = PickledOptparse::Version::STRING
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.required_ruby_version = '~> 1.9.2' # Everyone should upgrade, now!
     gem.name = "pickled_optparse"
-    gem.summary = %Q{Adds required switches to the OptionParser class}
+    gem.version = version
+    gem.summary = %Q{Adds required switches to Ruby's OptionParser class}
     gem.description = %Q{Adds the ability to easily specify and test for required switches in Ruby's built-in OptionParser class}
     gem.email = "picklepumpers@gmail.com"
     gem.homepage = "http://github.com/PicklePumpers/pickled_optparse"
     gem.authors = ["Mike Bethany"]
     gem.add_development_dependency "rspec", ">= 2.0.1"
+    gem.add_development_dependency "syntax", ">= 1.0.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -20,25 +26,50 @@ rescue LoadError
 end
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new do |t| 
+RSpec::Core::RakeTask.new(:spec) do |t| 
   t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"] 
   t.pattern = 'spec/*/*_spec.rb' 
 end
-
-RSpec::Core::RakeTask.new(:rcov) do |t|
-  t.rcov_opts =  %q[--exclude "spec"]
-end
-
 task :spec => :check_dependencies
 
-task :default => :spec
-
+# Build rdocs
 require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'syntax/convertors/html'
+rdoc_dir = 'rdoc'
+# This is rdoc1 but it doesn't work unless you DON'T wrap it in a task
+# Generate html files from example ruby files
+convertor = Syntax::Convertors::HTML.for_syntax "ruby"
+replacement_key = "REPLACE_THIS_TEXT_WITH_PROPER_HTML"
+# Create dummy files
+Dir.glob('examples/*.rb').each do |file|
+  File.open("#{file}.txt", "w") do |dummy_file|
+    dummy_file.write(replacement_key)
+  end
+end
 
-  rdoc.rdoc_dir = 'rdoc'
+# Call the rdoc task
+Rake::RDocTask.new(:rdoc2) do |rdoc|
+  rdoc.rdoc_dir = rdoc_dir
   rdoc.title = "pickled_optparse #{version}"
   rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('HISTORY*')
+  rdoc.rdoc_files.include('examples/*.txt')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task :rdoc3 do
+  # Now use a hammer to replace the dummy text with the
+  # html we want to use in our ruby example code file.
+  Dir.glob('examples/*.rb').each do |file|
+    html_header = File.read('rake_reqs/html_header.html')
+    html_ruby = convertor.convert(File.read(file))
+    rdoc_file = "#{rdoc_dir}/examples/#{File.basename(file,".rb")}_rb_txt.html"
+    fixed_html = File.read(rdoc_file).gsub!(replacement_key, "#{html_header}#{html_ruby}")
+    File.open(rdoc_file, "w") {|f| f.write(fixed_html)}
+    File.delete("#{file}.txt")
+  end
+end
+
+task :rdoc => [:rdoc2, :rdoc3]
+
+task :default => :spec

data/{lib → examples}/example.rb

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
-require_relative 'pickled_optparse'
+require_relative '../lib/pickled_optparse'
 
 # Configure options based on command line options
 @options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: test [options] in_file[.srt] out_file[.srt]"
+  opts.banner = "Usage: example.rb [options]"
   
   # Note that :required can be anywhere in the parameters
   
@@ -40,4 +40,5 @@ OptionParser.new do |opts|
     exit
   end
 
-end.parse!
+end.parse!
+

data/lib/pickled_optparse.rb

@@ -1,156 +1,2 @@
-require 'optparse'
-
-# Add the ability to specify switches as required to OptionParser
-class OptionParser
-  
-  # An array of messages describing any missing required switches
-  attr_reader :missing_switches
-  
-  # Convenience method to test if we're missing any required switches
-  def missing_switches?
-    !@missing_switches.nil?
-  end
-
-  def make_switch(opts, block = nil)
-    short, long, nolong, style, pattern, conv, not_pattern, not_conv, not_style = [], [], []
-    ldesc, sdesc, desc, arg = [], [], []
-    default_style = Switch::NoArgument
-    default_pattern = nil
-    klass = nil
-    n, q, a = nil
-
-    # Check for required switches
-    required = opts.delete(:required)
-
-    opts.each do |o|
-      
-      # argument class
-      next if search(:atype, o) do |pat, c|
-        klass = notwice(o, klass, 'type')
-        if not_style and not_style != Switch::NoArgument
-          not_pattern, not_conv = pat, c
-        else
-          default_pattern, conv = pat, c
-        end
-      end
-
-      # directly specified pattern(any object possible to match)
-      if (!(String === o || Symbol === o)) and o.respond_to?(:match)
-        pattern = notwice(o, pattern, 'pattern')
-        if pattern.respond_to?(:convert)
-          conv = pattern.method(:convert).to_proc
-        else
-          conv = SPLAT_PROC
-        end
-        next
-      end
-
-      # anything others
-      case o
-        when Proc, Method
-          block = notwice(o, block, 'block')
-        when Array, Hash
-          case pattern
-            when CompletingHash
-            when nil
-              pattern = CompletingHash.new
-              conv = pattern.method(:convert).to_proc if pattern.respond_to?(:convert)
-            else
-              raise ArgumentError, "argument pattern given twice"
-          end
-          o.each {|pat, *v| pattern[pat] = v.fetch(0) {pat}}
-        when Module
-          raise ArgumentError, "unsupported argument type: #{o}", ParseError.filter_backtrace(caller(4))
-        when *ArgumentStyle.keys
-          style = notwice(ArgumentStyle[o], style, 'style')
-        when /^--no-([^\[\]=\s]*)(.+)?/
-          q, a = $1, $2
-          o = notwice(a ? Object : TrueClass, klass, 'type')
-          not_pattern, not_conv = search(:atype, o) unless not_style
-          not_style = (not_style || default_style).guess(arg = a) if a
-          default_style = Switch::NoArgument
-          default_pattern, conv = search(:atype, FalseClass) unless default_pattern
-          ldesc << "--no-#{q}"
-          long << 'no-' + (q = q.downcase)
-          nolong << q
-        when /^--\[no-\]([^\[\]=\s]*)(.+)?/
-          q, a = $1, $2
-          o = notwice(a ? Object : TrueClass, klass, 'type')
-          if a
-            default_style = default_style.guess(arg = a)
-            default_pattern, conv = search(:atype, o) unless default_pattern
-          end
-          ldesc << "--[no-]#{q}"
-          long << (o = q.downcase)
-          not_pattern, not_conv = search(:atype, FalseClass) unless not_style
-          not_style = Switch::NoArgument
-          nolong << 'no-' + o
-        when /^--([^\[\]=\s]*)(.+)?/
-          q, a = $1, $2
-          if a
-            o = notwice(NilClass, klass, 'type')
-            default_style = default_style.guess(arg = a)
-            default_pattern, conv = search(:atype, o) unless default_pattern
-          end
-          ldesc << "--#{q}"
-          long << (o = q.downcase)
-        when /^-(\[\^?\]?(?:[^\\\]]|\\.)*\])(.+)?/
-          q, a = $1, $2
-          o = notwice(Object, klass, 'type')
-          if a
-            default_style = default_style.guess(arg = a)
-            default_pattern, conv = search(:atype, o) unless default_pattern
-          end
-          sdesc << "-#{q}"
-          short << Regexp.new(q)
-        when /^-(.)(.+)?/
-          q, a = $1, $2
-          if a
-            o = notwice(NilClass, klass, 'type')
-            default_style = default_style.guess(arg = a)
-            default_pattern, conv = search(:atype, o) unless default_pattern
-          end
-          sdesc << "-#{q}"
-          short << q
-        when /^=/
-          style = notwice(default_style.guess(arg = o), style, 'style')
-          default_pattern, conv = search(:atype, Object) unless default_pattern
-        else
-          desc.push(o)
-      end
-    
-    end
-    
-    default_pattern, conv = search(:atype, default_style.pattern) unless default_pattern
-    if !(short.empty? and long.empty?)
-      s = (style || default_style).new(pattern || default_pattern, conv, sdesc, ldesc, arg, desc, block)
-    elsif !block
-      if style or pattern
-        raise ArgumentError, "no switch given", ParseError.filter_backtrace(caller)
-      end
-      s = desc
-    else
-      short << pattern
-      s = (style || default_style).new(pattern, conv, nil, nil, arg, desc, block)
-    end
-
-    # Make sure required switches are given
-    if required && !(default_argv.include?("-#{short[0]}") || default_argv.include?("--#{long[0]}"))
-        @missing_switches ||= [] # Should be placed in initialize if incorporated into Ruby proper
-        
-        # This is ugly, long, and not very DRY but it is easy to understand
-        #missing = "-#{short[0]}" if !short.empty?
-        #missing = "#{missing} or " if !short.empty? && !long.empty?
-        #missing = "#{missing}--#{long[0]}" if !long.empty?
-        
-        # This is even uglier, and really hard to read, but it is shorter and 
-        # as DRY as I could figure out how to make it... but it still stinks.
-        @missing_switches << "Missing switch: #{"-#{short[0]}" if !short.empty?}#{" or " if !short.empty? && !long.empty?}#{"--#{long[0]}" if !long.empty?}"
-    end
-    
-    return s, short, long,
-      (not_style.new(not_pattern, not_conv, sdesc, ldesc, nil, desc, block) if not_style),
-      nolong
-  end
-  
-end
+require_relative 'pickled_optparse/pickled_optparse'
+require_relative 'pickled_optparse/version'

data/lib/pickled_optparse/pickled_optparse.rb

@@ -0,0 +1,42 @@
+require 'optparse'
+
+# Add the ability to specify switches as required to OptionParser
+class OptionParser
+  
+  # An array of messages describing any missing required switches
+  attr_reader :missing_switches
+  
+  # Convenience method to test if we're missing any required switches
+  def missing_switches?
+    !@missing_switches.nil?
+  end
+
+  # Alias the OptionParser::make_switch function 
+  # (instead of directly modifying it like I did in 0.1.0)
+  alias :pickled_make_switch :make_switch
+  
+  # Wrapper for OptionParser::make_switch to allow for required switches
+  def make_switch(opts, block = nil)
+  
+    # Test if a switch is required
+    required = opts.delete(:required)
+
+    return_values = pickled_make_switch(opts, block)
+
+    # Make sure required switches are given
+    if required 
+      short = return_values[1][0].nil? ? nil : "-#{return_values[1][0]}"
+      long = return_values[2][0].nil? ? nil : "--#{return_values[2][0]}"
+      
+      if !(default_argv.include?(short) || default_argv.include?(long))
+        @missing_switches ||= [] # Should be placed in initialize if incorporated into Ruby proper
+      
+        # Ugly and hard to read, should figure out a prettier way of doing this
+        @missing_switches << "Missing switch: #{short if !short.nil?}#{" or " if !short.nil? && !long.nil?}#{long if !long.nil?}"
+      end
+    end
+    
+    return return_values
+  end
+  
+end

data/lib/pickled_optparse/version.rb

@@ -0,0 +1,12 @@
+# Contains any pickled_optparse specific settings
+module PickledOptparse
+  # The current version of the software
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 1
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mike Bethany
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 -04:00
+date: 2010-11-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,21 @@ dependencies:
         version: 2.0.1
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: syntax
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
 description: Adds the ability to easily specify and test for required switches in Ruby's built-in OptionParser class
 email: picklepumpers@gmail.com
 executables: []
@@ -44,13 +59,15 @@ extra_rdoc_files:
 files: 
 - .document
 - .rspec
+- HISTORY.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - autotest/discover.rb
-- lib/example.rb
+- examples/example.rb
 - lib/pickled_optparse.rb
+- lib/pickled_optparse/pickled_optparse.rb
+- lib/pickled_optparse/version.rb
 - spec/pickled_optparse/pickled_optparse_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -86,7 +103,8 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Adds required switches to the OptionParser class
+summary: Adds required switches to Ruby's OptionParser class
 test_files: 
+- examples/example.rb
 - spec/pickled_optparse/pickled_optparse_spec.rb
 - spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-0.1.0