kerplutz 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+tmp/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@kerplutz

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    kerplutz (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.3.6)
+      childprocess (>= 0.1.7)
+      cucumber (>= 0.10.0)
+      rspec (>= 2.5.0)
+    builder (3.0.0)
+    childprocess (0.1.8)
+      ffi (~> 1.0.6)
+    cucumber (0.10.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (>= 2.3.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.2)
+    ffi (1.0.7)
+      rake (>= 0.8.7)
+    gherkin (2.3.7)
+      json (>= 1.4.6)
+    json (1.5.1)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  cucumber
+  kerplutz!
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mike Sassak
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+# Kerplutz
+
+Command-line option parsing that won't leave you feeling kerplutz.
+
+## OMG WHY DO WE NEED ANOTHER ONE OF THESE THINGS?
+
+Geez I love you too, sunshine. I hesitated for a long while before
+committing myself to writing Kerplutz. Eventually what pushed me into
+action was the observation (hopefully correct) that OptionParser is
+generally a pretty slick library, even if its interface is a bit wonky.
+It seemed like a shame to let it go to waste, when getting from it what
+I needed requires only a small amount of code.
+
+## Todo
+
+* Read defaults from a config file
+* Argument type-casts
+* List arguments
+* Cleanup OptionParser's puking when an option isn't recognized
+* Be more shy with the parsed arguments collection via callbacks
+* Multiline descriptions?
+
+## Copyright
+
+Copyright (c) 2011 Mike Sassak. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+desc "Run Cukes and Specs"
+task :default => ["spec", "cukes"]
+
+task :cukes do
+  sh "cucumber"
+end
+
+task :spec do
+  sh "rspec spec"
+end

data/cucumber.yml

@@ -0,0 +1 @@
+default: --tags ~@todo

data/features/kerplutz.feature

@@ -0,0 +1,110 @@
+Feature: Kerplutz
+
+  Command-line option parser for executables with sub-commands
+  (like git or svn) that will not make developers feel kerplutz.
+
+  Background: Option parsing configuration
+    Given an executable named "my-bin" with:
+      """
+      require 'kerplutz'
+
+      kerplutz = Kerplutz.build "my-bin" do |base|
+        base.banner = "Usage: #{base.name} [OPTIONS] COMMAND [ARGS]"
+
+        base.switch :blinkenlights, "Enable or disable the blinkenlights", abbrev: :b
+        base.flag   :frobnicate,    "Frobnicate the furtwangler", optional: :target
+
+        base.action :my_action, "Execute my action" do
+          puts "This is my action!"
+        end
+
+        base.action :version, "Show the version", abbrev: :V do
+          puts "#{base.name} version 1.2.3"
+        end
+
+        base.command :start, "Start the reactor!" do |command|
+          command.banner = "Usage: #{base.name} #{command.name} [ARGS]"
+
+          command.switch :lightbulb, "Turn the lightbulb on or off"
+          command.flag   :dry_run,   "Look, but don't touch", abbrev: :d
+        end
+
+        base.command :open, "Open your mind, Quaid" do |command|
+          command.flag   :kuato,     "High-level summon",        abbrev: :k, required: :host
+          command.switch :backtrace, "Print the full backtrace", abbrev: :b
+        end
+      end
+
+      kerplutz.parse(ARGV.dup)
+      """
+
+  Scenario: help
+    When I run `./my-bin help`
+    Then the output should contain exactly:
+      """
+      Usage: my-bin [OPTIONS] COMMAND [ARGS]
+
+          -b, --[no-]blinkenlights         Enable or disable the blinkenlights
+              --frobnicate [TARGET]        Frobnicate the furtwangler
+              --my-action                  Execute my action
+          -V, --version                    Show the version
+
+       Commands:
+        start Start the reactor!
+        open Open your mind, Quaid
+
+      Type 'my-bin help COMMAND' for help with a specific command.
+
+      """
+
+  Scenario: no arguments
+    When I run `./my-bin`
+    Then the output should contain:
+      """
+      Type 'my-bin help COMMAND' for help with a specific command.
+
+      """
+
+  Scenario: Known flag to executable
+    When I run `./my-bin --version`
+    Then the output should contain exactly:
+      """
+      my-bin version 1.2.3
+
+      """
+
+  Scenario: Only first action is executed
+    When I run `./my-bin --my-action --version`
+    Then the output should contain exactly:
+      """
+      This is my action!
+
+      """
+
+  Scenario: Get help about a command
+    When I run `./my-bin help start`
+    Then the output should contain exactly:
+      """
+      Usage: my-bin start [ARGS]
+
+              --[no-]lightbulb             Turn the lightbulb on or off
+          -d, --dry-run                    Look, but don't touch
+
+      """
+
+  Scenario: Get help about a command with a default banner
+    When I run `./my-bin help open`
+    Then the output should contain exactly:
+      """
+      Usage: my-bin open [OPTIONS]
+
+          -k, --kuato HOST                 High-level summon
+          -b, --[no-]backtrace             Print the full backtrace
+
+      """
+
+  @todo
+  Scenario: Invoke a flag with required argument without an argument
+
+  @todo
+  Scenario: Invoke an unknown option

data/features/step_definitions/kerplutz_steps.rb

@@ -0,0 +1,11 @@
+Given /^an executable named "(.+)" with:$/ do |name, body|
+  contents = <<EOF
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../../lib'))
+
+#{body}
+EOF
+
+  write_file(name, contents)
+  File.open("tmp/aruba/#{name}") { |file| file.chmod(0755) }
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib/')
+
+require 'kerplutz'
+require 'aruba/cucumber'

data/kerplutz.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'kerplutz'
+  s.version     = '0.1.0'
+  s.authors     = ["Mike Sassak"]
+  s.description = "Command-line option parser with subcommands that won't leave you feeling Kerplutz"
+  s.summary     = "kerplutz #{s.version}"
+  s.email       = "msassak@gmail.com"
+  s.homepage    = "https://github.com/msassak/kerplutz"
+
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'rspec'
+
+  s.rubygems_version   = "1.3.7"
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ["LICENSE", "README.md"]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+end

data/lib/kerplutz.rb

@@ -0,0 +1,12 @@
+require 'kerplutz/executable'
+require 'kerplutz/builder'
+
+module Kerplutz
+  class << self
+    def build(name)
+      executable = Executable.new(name)
+      yield builder = Builder.new(executable)
+      builder.result
+    end
+  end
+end

data/lib/kerplutz/builder.rb

@@ -0,0 +1,42 @@
+require 'kerplutz/executable'
+require 'kerplutz/options'
+
+module Kerplutz
+  class Builder
+    attr_reader :base
+
+    def initialize(base)
+      @base = base
+    end
+
+    def name
+      base.name
+    end
+
+    def banner=(banner)
+      base.banner = banner
+    end
+
+    def flag(name, desc, opts={})
+      base.add_option(Flag.build(name, desc, opts))
+    end
+
+    def switch(name, desc, opts={})
+      base.add_option(Switch.build(name, desc, opts))
+    end
+
+    def action(name, desc, opts={}, &action)
+      base.add_option(Action.build(name, desc, opts, &action))
+    end
+
+    def command(name, desc)
+      command = Command.new(name, desc, base.arguments)
+      yield builder = Builder.new(command)
+      base.add_command(builder.result)
+    end
+
+    def result
+      base
+    end
+  end
+end

data/lib/kerplutz/command.rb

@@ -0,0 +1,56 @@
+require 'optparse'
+require 'forwardable'
+
+module Kerplutz
+  class Command
+    attr_reader :name, :desc, :arguments, :parser
+
+    extend Forwardable; def_delegators :@parser, :banner, :help, :parse
+
+    def initialize(name, desc, arguments={})
+      @name      = name
+      @desc      = desc
+      @arguments = arguments
+      @parser    = OptionParser.new(default_banner)
+    end
+
+    def display_name
+      @display_name ||= name.to_s.tr("_", "-")
+    end
+
+    def banner=(banner)
+      parser.banner = (banner.chomp << "\n\n")
+    end
+
+    def add_option(option, prefix_key=true)
+      if prefix_key
+        key = :"#{name}_#{option.name}"
+      else
+        key = option.name.to_sym
+      end
+
+      option.configure(parser) do |value|
+        arguments[key] = value
+      end
+    end
+
+    private
+
+    # TODO: Is this a better fit for Executable?
+    def default_banner
+      "Usage: #{command_name} [OPTIONS]\n\n"
+    end
+
+    def command_name
+      if program_name == display_name
+        program_name
+      else
+        "#{program_name} #{display_name}"
+      end
+    end
+
+    def program_name
+      @program_name ||= File.basename($PROGRAM_NAME)
+    end
+  end
+end

data/lib/kerplutz/command_map.rb

@@ -0,0 +1,31 @@
+module Kerplutz
+  class CommandMap
+    attr_reader :commands
+
+    def initialize
+      @commands = {}
+    end
+
+    def add(command)
+      commands[command.display_name] = command
+    end
+
+    def <<(command)
+      add(command) and return self
+    end
+
+    def [](display_name)
+      commands[display_name]
+    end
+
+    def ===(display_name)
+      commands.has_key?(display_name)
+    end
+
+    def summary(indent=2)
+      commands.inject("") do |acc, (display_name, command)|
+        acc << " " * indent << "#{display_name} #{command.desc}\n"
+      end
+    end
+  end
+end

data/lib/kerplutz/executable.rb

@@ -0,0 +1,65 @@
+require 'forwardable'
+
+require 'kerplutz/command'
+require 'kerplutz/command_map'
+
+module Kerplutz
+  class Executable
+    attr_reader :top, :commands, :arguments
+
+    extend Forwardable; def_delegators :@top, :name, :banner, :banner=
+
+    def initialize(name, arguments={})
+      @arguments = arguments
+      @top       = Command.new(name, '', @arguments)
+      @commands  = CommandMap.new
+    end
+
+    def add_command(command)
+      commands << command
+    end
+
+    def add_option(option)
+      top.add_option(option, false)
+    end
+
+    def parse(args)
+      first, *rest = args
+      remainder = []
+
+      case first
+
+      when help
+        puts (rest.empty? ? banner : commands[rest.first].help)
+
+      when option
+        remainder = top.parse(args)
+
+      when commands
+        remainder = commands[first].parse(rest)
+
+      else
+        puts banner
+      end
+
+      [arguments, remainder]
+    end
+
+    def banner
+      help = ""
+      help << top.help << "\n"
+      help << " Commands:\n" << commands.summary << "\n"
+      help << "Type '#{name} help COMMAND' for help with a specific command.\n"
+    end
+
+    private
+
+    def help
+      /^(--help|help)$/
+    end
+
+    def option
+      /^(--|-)[\w-]+$/
+    end
+  end
+end

data/lib/kerplutz/options.rb

@@ -0,0 +1,111 @@
+module Kerplutz
+  class Option
+    attr_reader   :name, :desc
+    attr_accessor :abbrev
+
+    def self.build(name, desc, opts)
+      option = self.new(name, desc)
+      option.abbrev = opts[:abbrev]
+      option
+    end
+
+    def initialize(name, desc)
+      @name = name
+      @desc = desc
+    end
+
+    def display_name
+      name.to_s.tr("_", "-")
+    end
+
+    def option_sig
+      "--#{display_name}"
+    end
+
+    def abbrev_sig
+      return "-#{abbrev[0]}" if abbrev
+    end
+
+    def parser_args
+      [abbrev_sig, option_sig, desc].compact
+    end
+
+    def configure(parser, &blk)
+      raise "You'll need to implement this one yourself, bub."
+    end
+  end
+
+  class Flag < Option
+    attr_accessor :arg_name, :arg_required
+
+    def self.build(name, desc, opts)
+      flag = super(name, desc, opts)
+      flag.arg_name = opts[:required] || opts[:optional]
+      flag.arg_required = opts.has_key?(:required)
+      flag
+    end
+
+    def initialize(name, desc, arg_name=nil)
+      super(name, desc)
+      @arg_name = arg_name
+    end
+
+    def configure(parser, &blk)
+      parser.on(*parser_args) do |arg|
+        if NilClass === arg
+          blk.call(true)
+        else
+          blk.call(arg)
+        end
+      end
+    end
+
+    def option_sig
+      "#{super}#{formatted_arg_name}"
+    end
+
+    private
+
+    def formatted_arg_name
+      if arg_name and arg_required
+        " #{arg_name.to_s.upcase}"
+      elsif arg_name
+        " [#{arg_name.to_s.upcase}]"
+      end
+    end
+  end
+
+  class Switch < Option
+    def option_sig
+      "--[no-]#{display_name}"
+    end
+
+    def configure(parser, &blk)
+      parser.on(*parser_args) do |arg|
+        blk.call(arg)
+      end
+    end
+  end
+
+  class Action < Option
+    attr_accessor :action, :continue_after_exec
+
+    def self.build(name, desc, opts, &action)
+      new_action = super(name, desc, opts)
+      new_action.action = action
+      new_action
+    end
+
+    def initialize(name, desc, &action)
+      super(name, desc)
+      @action = action
+    end
+
+    def configure(parser, &blk)
+      parser.on(*parser_args) do
+        action.call
+        exit unless continue_after_exec
+      end
+    end
+  end
+end

data/spec/kerplutz/command_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Kerplutz
+  describe Command do
+    let(:option) { Flag.new(:name, "Description") }
+    let(:args) { Hash.new }
+    subject { Command.new("commandy", "", args) }
+
+    context "#add_option" do
+      it "passes the parser into the option for configuration" do
+        option.should_receive(:configure).with(subject.parser)
+        subject.add_option(option)
+      end
+    end
+
+    context "#parse" do
+      it "adds the parsed argument into the arguments hash" do
+        subject.add_option(option)
+        subject.parse("--name")
+        args.should have_key(:commandy_name)
+        args[:commandy_name].should eq(true)
+      end
+    end
+  end
+end
+

data/spec/kerplutz/executable_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Kerplutz
+  describe Executable do
+    subject { Executable.new("test") }
+
+    describe "#parse" do
+      it "extracts the options from the arguments" do
+        subject.add_option(Switch.new(:foo, ''))
+        subject.parse(["--foo"]).should == [{ :foo => true }, []]
+      end
+    end
+
+    describe "#banner" do
+      it "has a sensible default" do
+        subject.banner.should =~ /^Usage: rspec test \[OPTIONS\]$/
+      end
+    end
+  end
+end

data/spec/kerplutz/options_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+module Kerplutz
+  describe Option do
+    let(:parser) { OptionParser.new }
+    subject { Option.new(:foo, "Do foo") }
+
+    it "generates the parser arguments" do
+      subject.parser_args.should == ["--foo", "Do foo"]
+    end
+
+    context "with an abbreviation" do
+      it "generates the parser arguments" do
+        subject.abbrev = :f
+        subject.parser_args.should == ["-f", "--foo", "Do foo"]
+        subject.abbrev = :option_parser_does_weird_things_if_more_than_one_character
+        subject.parser_args.should == ["-o", "--foo", "Do foo"]
+      end
+    end
+  end
+
+  describe Flag do
+    let(:parser) { OptionParser.new }
+    let(:args) { Hash.new }
+
+    context "with no arguments" do
+      subject { Flag.new(:kuato, 'Summon Kuato') }
+
+      its(:option_sig) { should == "--kuato" }
+
+      it "configures the parser" do
+        subject.configure(parser) do |value|
+          value.should === true
+        end
+        parser.parse("--kuato")
+      end
+    end
+
+    context "with an optional argument" do
+      subject { Flag.new(:kuato, 'Summon Kuato', :host) }
+
+      its(:option_sig) { should == "--kuato [HOST]" }
+
+      it "configures the parser" do
+        subject.configure(parser) do |value|
+          value.should == "George"
+        end
+        parser.parse("--kuato", "George")
+
+        subject.configure(parser) do |value|
+          value.should === true
+        end
+        parser.parse("--kuato")
+      end
+    end
+
+    context "with a required argument" do
+      subject do
+        flag = Flag.new(:kuato, 'Summon Kuato', :host)
+        flag.arg_required = true
+        flag
+      end
+
+      its(:option_sig) { should == "--kuato HOST" }
+
+      it "configures the parser" do
+        subject.configure(parser) { |value| } # no-op
+        expect { parser.parse("--kuato") }.to raise_error(OptionParser::MissingArgument)
+
+        subject.configure(parser) do |value|
+          value.should == "George"
+        end
+        parser.parse("--kuato", "George")
+      end
+    end
+  end
+
+  describe Switch do
+    let(:parser) { OptionParser.new }
+    let(:args) { Hash.new }
+
+    subject { Switch.new(:verbose, "Be chatty") }
+
+    its(:option_sig) { should == "--[no-]verbose" }
+
+    it "configures the parser" do
+      subject.configure(parser) do |value|
+        value.should === true
+      end
+      parser.parse("--verbose")
+
+      subject.configure(parser) do |value|
+        value.should be_false
+      end
+      parser.parse("--no-verbose")
+    end
+  end
+
+  describe Action do
+    let(:parser) { OptionParser.new }
+    let(:args) { Hash.new }
+
+    subject do
+      action = Action.new(:start_reactor, "Start the reactor!") do
+        $action = "Hello there"
+      end
+      action.continue_after_exec = true
+      action
+    end
+
+    it "configures the parser" do
+      subject.configure(parser)
+      $action.should eq(nil)
+      parser.parse("--start-reactor")
+      $action.should eq("Hello there")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require 'kerplutz'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: kerplutz
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mike Sassak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Command-line option parser with subcommands that won't leave you feeling Kerplutz
+email: msassak@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- cucumber.yml
+- features/kerplutz.feature
+- features/step_definitions/kerplutz_steps.rb
+- features/support/env.rb
+- kerplutz.gemspec
+- lib/kerplutz.rb
+- lib/kerplutz/builder.rb
+- lib/kerplutz/command.rb
+- lib/kerplutz/command_map.rb
+- lib/kerplutz/executable.rb
+- lib/kerplutz/options.rb
+- spec/kerplutz/command_spec.rb
+- spec/kerplutz/executable_spec.rb
+- spec/kerplutz/options_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/msassak/kerplutz
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: kerplutz 0.1.0
+test_files: 
+- features/kerplutz.feature
+- features/step_definitions/kerplutz_steps.rb
+- features/support/env.rb
+- spec/kerplutz/command_spec.rb
+- spec/kerplutz/executable_spec.rb
+- spec/kerplutz/options_spec.rb
+- spec/spec_helper.rb