dominion 0.0.1

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Leal
+
+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,17 @@
+= dominion
+
+Description goes here.
+
+== 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 David Leal. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dominion"
+    gem.summary = %Q{Yet another command line option parser}
+    gem.email = "david@thedigitalants.com"
+    gem.homepage = "http://github.com/david/dominion"
+    gem.authors = ["David Leal"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "rr", ">= 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
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/dominion.rb

@@ -0,0 +1,134 @@
+require 'active_support'
+
+module Dominion
+  class UnknownArguments < StandardError; end
+  
+  def self.parse(args, &block)
+    Parser.new(args).parse(&block)
+  end
+
+  class Parser
+    COMMAND = /\w+(?::\w+)*/
+    
+    def initialize(args)
+      @args     = args.dup
+      @mappers  = []
+    end
+
+    def command(matcher, options = {}, &mappers)
+      if @invoker.for?(matcher)
+        yield if block_given?
+        @invoker.options = options
+      end
+    end
+    
+    def map(arg, opts)
+      if switch?(arg)
+        @mappers.unshift(lambda { extract_option(@args, arg, opts) })
+      else
+        opts[:to] ||= arg
+
+        @mappers.push(lambda { extract_option(@args, arg, opts) })
+      end
+    end
+
+    def parse(&block)
+      @invoker = Invoker.new(@args.shift)
+      @result  = {}
+
+      instance_eval(&block)
+
+      @mappers.each(&:call)
+      
+      raise UnknownArguments, "Unknown arguments: #{@args.join(' ')}" unless @args.empty?
+
+      @invoker.invoke(@result)
+    end
+
+    private
+
+    def switch?(arg)
+      case arg
+      when Array
+        switch?(arg.first)
+      else
+        arg =~ /^--?/
+      end
+    end
+
+    def extract_option(args, arg, opts)
+      key_or_val, index = args.each_with_index.find do |a, i|
+        if arg.is_a?(Array)
+          arg.include?(a)
+        elsif arg == Integer
+          a =~ /^\d+$/
+        elsif arg == Hash
+          a =~ /^\w+:\w+$/
+        else
+          arg == a
+        end
+      end
+
+      if index
+        if switch?(arg)
+          val            = args[index + 1]
+          args[index, 2] = nil
+
+          @result[opts[:as]] = val
+        else
+          @result[opts[:as]] =
+            if opts[:to] == Integer
+              args.delete_at(index)
+              
+              Integer(key_or_val)
+            elsif opts[:to] == Hash
+              i = index
+              h = {}
+              while args[i] =~ /^\w+:\w+$/
+                k, v        = args[i].split(/:/)
+                h[k.to_sym] = v
+                i          += 1
+              end
+              args[index, i - index] = nil
+              h
+            end
+        end
+      end
+    end
+    
+  end
+
+  class Invoker
+    def initialize(path)
+      @path    = path
+      @options = {}
+    end
+
+    def options=(options)
+      @options.merge!(options)
+    end
+
+    def for?(path)
+      @path == path || path.to_s == '*'
+    end
+
+    def invoke(args)
+      top = case @options[:top]
+            when Class, Module
+              @options[:top].name
+            else
+              @options[:top]
+            end
+
+      elements = @path.split(/:/)
+      method   = elements.pop
+      klass    = [top].concat(elements.map(&:classify)).compact.join('::').constantize
+
+      if klass.instance_method(method).arity == 1
+        klass.new.send(method, args)
+      else
+        klass.new.send(method)
+      end
+    end
+  end
+end

data/spec/dominion_spec.rb

@@ -0,0 +1,168 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Dominion do
+  before { class Recipe; end }
+
+  after { Object.send(:remove_const, :Recipe) }
+
+  describe "no arguments" do
+    before { Recipe.class_eval { def create; end } }
+      
+    it "maps to a command in the top naming scope" do
+      mock(Recipe).new.mock!.create
+      
+      Dominion::parse(%w(recipe:create)) do
+        command :*
+      end
+    end
+
+    describe "search for commands inside a given path" do
+      before do
+        module Starships
+          class Enterprise
+            def explore; end
+          end
+        end
+      end
+
+      after do
+        Starships.send(:remove_const, :Enterprise)
+        Object.send(:remove_const, :Starships)
+      end
+
+      it "searches only inside a certain module" do
+        mock(Starships::Enterprise).new.mock!.explore
+
+        Dominion::parse(%w(enterprise:explore)) do
+          command :*, :top => Starships
+        end
+      end
+    end
+  end
+  
+  describe "with arguments" do
+    before do
+      Recipe.class_eval { def create(args); end }
+    end
+
+    it "calls a command with a single argument" do
+      mock(Recipe).new.mock!.create({})
+      
+      Dominion::parse(%w(recipe:create)) do
+        command :*
+      end
+    end
+
+    it "passes a single letter option to a command" do
+      mock(Recipe).new.mock!.create(:name => 'Bacalhau espiritual')
+      
+      Dominion::parse(%w(recipe:create -n Bacalhau\ espiritual)) do
+        command :* do
+          map "-n", :as => :name
+        end
+      end
+    end
+
+    it "passes a long option to a command" do
+      mock(Recipe).new.mock!.create(:name => 'Bacalhau espiritual')
+      
+      Dominion::parse(%w(recipe:create --name Bacalhau\ espiritual)) do
+        command :* do
+          map "--name", :as => :name
+        end
+      end
+    end
+
+    describe "short and long formats" do
+      [%w(long --name), %w(short -n)].each do |(format, switch)|
+        it "maps the #{format} format" do
+          mock(Recipe).new.mock!.create(:name => 'Bacalhau espiritual')
+
+          Dominion::parse(%W(recipe:create #{switch} Bacalhau\ espiritual)) do
+            command :* do
+              map %w(--name -n), :as => :name
+            end
+          end
+        end
+      end
+    end
+
+    it "honors command specific options" do
+      mock(Recipe).new.mock!.create(:name => 'Bacalhau espiritual', :author => 'unknown')
+      
+      Dominion::parse(%W(recipe:create --name Bacalhau\ espiritual --author unknown)) do
+        command :* do
+          map "--name", :as => :name
+        end
+
+        command 'recipe:create' do
+          map "--author", :as => :author
+        end
+
+        command 'recipe:destroy' do
+          map "--reason", :as => :reason
+        end
+      end
+    end
+
+    describe "number arguments" do
+      it "parses number arguments" do
+        mock(Recipe).new.mock!.create(:name => 'Bacalhau espiritual', :recipe_number => 123456)
+        
+        Dominion::parse(%W(recipe:create --name Bacalhau\ espiritual 123456)) do
+          command :* do
+            map "--name", :as => :name
+          end
+
+          command 'recipe:create' do
+            map Integer, :as => :recipe_number
+          end
+        end
+      end
+
+      it "omits number arguments if they're not present" do
+        mock(Recipe).new.mock!.create(:name => 'Bacalhau espiritual')
+        
+        Dominion::parse(%W(recipe:create --name Bacalhau\ espiritual)) do
+          command :* do
+            map "--name", :as => :name
+          end
+
+          command 'recipe:create' do
+            map Integer, :as => :recipe_number
+          end
+        end
+      end
+    end
+
+    it "parses hash arguments" do
+      mock(Recipe).new.mock!.create(:name => 'Bacalhau espiritual',
+                                    :meta => {:author => 'unknown', :recipe_number => '123456'})
+      
+      Dominion::parse(%W(recipe:create --name Bacalhau\ espiritual author:unknown recipe_number:123456)) do
+        command :* do
+          map "--name", :as => :name
+        end
+
+        command 'recipe:create' do
+          map Integer, :as => :recipe_number
+          map Hash, :as => :meta
+        end
+      end
+    end
+
+    it "complains if there are unparsed arguments left" do
+      lambda do
+        Dominion::parse(%W(recipe:create --name Bacalhau\ espiritual 123456)) do
+          command :* do
+            map "--name", :as => :name
+          end
+
+          command 'recipe:create' do
+            map Integer, :as => :recipe_number
+          end
+        end.should raise_error(Dominion::UnknownArguments)
+      end
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: dominion
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Leal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        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 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: david@thedigitalants.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/dominion.rb
+- spec/dominion_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/david/dominion
+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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Yet another command line option parser
+test_files: 
+- spec/dominion_spec.rb
+- spec/spec_helper.rb