commandant 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+doc
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rein Henrichs
+
+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.rdoc

@@ -0,0 +1,34 @@
+= commander
+
+The simplest possible command line subcommand tool. It provides about half of
+what you want and none of what you don't. If you don't like it, don't use it.
+
+== Example:
+
+    #!/usr/bin/env ruby -rubygems
+    require 'commander'
+    include Commander
+
+    command :hello do
+      puts "Hello, World!"
+    end
+
+    command :argprint do |args| # Array of arguments, like ARGV
+      puts args
+    end
+
+    run
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Rein Henrichs. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "commandant"
+    gem.summary = %Q{A simple library for writing commands with subcommands (like git)}
+    gem.email = "reinh@reinh.com"
+    gem.homepage = "http://github.com/reinh/commandant"
+    gem.authors = ["Rein Henrichs"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude /Library,spec/'] # not excluding /Library for some reason"
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/commandant.rb

@@ -0,0 +1,76 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'commandant/command'
+
+module Commandant
+  COMMANDS = {}
+
+  class UnknownCommand < NameError
+    def initialize(name); super "Unknown command `#{name}`" end
+  end
+
+  # Call a given command by name
+  #
+  # @param [Symbol] name the name of the command to be called
+  # @param [Array] args the command's arguments
+  # @raise [UnknownCommand] attempt to call a command that does not exist
+  def self.call(name, args=nil)
+    raise UnknownCommand.new(name) unless COMMANDS[name]
+    COMMANDS[name].call(args)
+  end
+
+  # Clears out all defined commands.  Primarily useful for testing
+  def self.clear!
+    COMMANDS.clear
+  end
+
+  # Creates an alias for each given command.
+  #
+  # @param [Hash<Symbol => Symbol>] commands the aliases to create ( new name => old name )
+  # @example
+  #   alias :br => :branch, :co => :checkout
+  def add_alias(commands)
+    commands.each do |new, old|
+      Commandant::COMMANDS[new] = Commandant::COMMANDS[old]
+    end
+  end
+  module_function :add_alias
+
+  # Create a new command
+  #
+  # @param [Symbol] name the name of the command that is created
+  # @param [String, nil] description the command's description
+  # @yield The command that will be run
+  # @yieldparam [Array] args optional: arguments to the command (typically from ARGV)
+  #
+  # @example A Hello World! command
+  #   Commandant.command :hello do
+  #     puts "Hello World!"
+  #   end
+  #
+  #   Commandant.run "hello"
+  # 
+  # @example A command with arguments
+  #   Commandant.command :argprint do |args|
+  #     puts args
+  #   end
+  #
+  #   Commandant.run "argprint foo bizz bazz"
+  def command(name, description="", &command)
+    Command.new(name, description, &command)
+  end
+  module_function :command
+
+  # Runs a given commandline by parsing the command name and arguments. If no
+  # command is given, defaults to a command called :main. If that is not
+  # present, an UnknownCommand error will be raised.
+  #
+  # @param [Array] cmdline the command line args to be run
+  # @raise [UnknownCommand] command is unknown and no :main command is available
+  def run(cmdline=ARGV)
+    name, *args = cmdline
+    name, args = :main, [name, *args] if name.nil? || COMMANDS[name.to_sym].nil? && COMMANDS[:main]
+    Commandant.call name.to_sym, args.compact
+  end
+  module_function :run
+
+end

data/lib/commandant/command.rb

@@ -0,0 +1,30 @@
+module Commandant
+  class Command
+    attr_reader :description
+
+    # Create a new command by name and add it to the commands list.
+    #
+    # @param [Symbol] name the name of the command
+    # @param [String, nil] description the command's description
+    # @raise [ArgumentError] if a command block is not provided
+    # @raise [ArgumentError] if a command already exists by that name
+    def initialize(name, description=nil, &command)
+      raise ArgumentError, "Must provide a command block" unless command
+      raise ArgumentError, "Command already exists: #{name}" if COMMANDS[name]
+
+      @name        = name
+      @description = description
+      @command     = command
+
+      COMMANDS[@name] = self
+    end
+
+    # Execute the command
+    #
+    # @param [Array] args the command's arguments
+    def call(args=nil)
+      @command.call(args)
+    end
+  end
+
+end

data/spec/commandant/commands_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Commandant::Command do
+  before  { Commandant.clear! }
+  subject { Commandant::Command }
+
+  describe ".new" do
+    it "requres a name" do
+      lambda { subject.new(){ "this is the command" }
+      }.should raise_error(ArgumentError)
+    end
+
+    it "requires a block" do
+      lambda { subject.new(:name)
+      }.should raise_error(ArgumentError)
+    end
+
+    it "accepts a description" do
+      subject.new(:name, "description"){}.description.should == "description"
+    end
+
+    it "adds the command to the list of commands by name" do
+      command = subject.new(:name){ "block" }
+      Commandant::COMMANDS[:name].should == command
+    end
+
+    describe "when the command already exists" do
+      before { Commandant::Command.new(:dup) { "I am a duplicate" } }
+
+      it do
+        lambda {
+          Commandant.command(:dup) { "I am a duplicate" }
+        }.should raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#call" do
+    subject { Commandant::Command.new(:name){ "called" } }
+
+    it "calls the given command" do
+      subject.call.should == "called"
+    end
+  end
+end

data/spec/commandant_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Commandant do
+  before  { Commandant.clear! }
+
+  describe ".call" do
+    it "calls the given command" do
+      Commandant.command(:test) { "test" }
+      Commandant.call(:test).should == "test"
+    end
+
+    it "passes args if given" do
+      Commandant.command(:test) {|args| args }
+
+      Commandant.call(:test, "args").should == "args"
+    end
+
+    describe "when the command is unavailable" do
+      subject { lambda{Commandant.call(:missing)} }
+      it { should raise_error(Commandant::UnknownCommand) }
+    end
+  end
+
+  describe ".clear!" do
+    before { Commandant.command(:main){"main"} }
+
+    it "should empty the command list" do
+      lambda {
+        Commandant.clear!
+      }.should change{Commandant::COMMANDS.empty?}.from(false).to(true)
+    end
+  end
+
+  describe ".add_alias" do
+    it "creates an alias for a given command" do
+      Commandant.command(:hello) { "hello" }
+      Commandant.add_alias :hi => :hello
+
+      Commandant.run(:hi).should == "hello"
+    end
+  end
+
+  describe ".command" do
+    subject { Commandant.command(:test) { "this is a test" } }
+    it "creates a new Command with the given name and command block" do
+      should be_a_kind_of(Commandant::Command)
+    end
+  end
+
+  describe ".run" do
+    before { Commandant.command(:main) {|args| "main called with #{args.inspect}" } }
+
+    it "runs the command specified" do
+      Commandant::COMMANDS[:main].should_receive(:call)
+
+      Commandant.run("main")
+    end
+
+    it "runs the command with arguments" do
+      Commandant::COMMANDS[:main].should_receive(:call).with(["args"])
+
+      Commandant.run(%w{main args})
+    end
+
+    it "defaults to the :main command, if available" do
+      Commandant.run(%w{ some args }).should == 'main called with ["some", "args"]'
+    end
+
+    it "runs the main command if no arguments are passed" do
+      Commandant.run(nil).should == "main called with []"
+    end
+
+    it "raises an errur of no main command is available" do
+      Commandant.clear!
+
+      lambda {
+        Commandant.run(%w{ some args })
+      }.should raise_error(Commandant::UnknownCommand)
+    end
+
+  end
+
+end

data/spec/fixtures/basic_runner.rb

@@ -0,0 +1,12 @@
+require 'lib/commandant'
+include Commandant
+
+command :main do
+  print "main"
+end
+
+command :argprinter do |args|
+  print args.inspect
+end
+
+run

data/spec/integration/run_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Integration:", "Running a command" do
+  def running(args, &block)
+    IO.popen "ruby spec/fixtures/basic_runner.rb #{args}", &block
+  end
+  private :running
+
+  describe "that prints \"main\" to STDOUT" do
+    it "should output \"main\" to STDOUT" do
+      running :main do |io|
+        io.read.should == "main"
+      end
+    end
+  end
+
+  describe "that prints its arguments to STDOUT" do
+    it "should output its arguments to STDOUT" do
+      running "argprinter foo biz bazz" do |io|
+        io.read.should == %w{foo biz bazz}.inspect
+      end
+    end
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude /Library

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'commandant'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: commandant
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Rein Henrichs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: reinh@reinh.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/commandant.rb
+- lib/commandant/command.rb
+- spec/commandant/commands_spec.rb
+- spec/commandant_spec.rb
+- spec/fixtures/basic_runner.rb
+- spec/integration/run_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/reinh/commandant
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple library for writing commands with subcommands (like git)
+test_files: 
+- spec/commandant/commands_spec.rb
+- spec/commandant_spec.rb
+- spec/fixtures/basic_runner.rb
+- spec/integration/run_spec.rb
+- spec/spec_helper.rb