acclaim 0.0.1.alpha1

data/.gitignore

@@ -0,0 +1 @@
+*.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.GPLv3

@@ -0,0 +1,14 @@
+Copyright © 2011 Matheus Afonso Martins Moreira
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.markdown

@@ -0,0 +1,5 @@
+# Acclaim
+
+Command-line option parsing and command interface.
+
+Extracted from [Safeguard](https://github.com/matheusmoreira/safeguard).

data/Rakefile

@@ -0,0 +1,44 @@
+this_dir  = File.expand_path('..', __FILE__)
+gem_dir   = File.join this_dir, 'gem'
+spec_file = File.join this_dir, 'acclaim.gemspec'
+
+spec = Gem::Specification.load spec_file
+
+task :mkdir do
+  FileUtils.mkdir_p gem_dir
+end
+
+task :gem => :mkdir do
+  gem_file = File.join this_dir, Gem::Builder.new(spec).build
+  FileUtils.mv gem_file, gem_dir
+end
+
+namespace :gem do
+
+  task :build => :gem
+
+  gem_file = File.join gem_dir, "#{spec.name}-#{spec.version}.gem"
+
+  task :push => :gem do
+    sh "gem push #{gem_file}"
+  end
+
+  task :install => :gem do
+    sh "gem install #{gem_file}"
+  end
+
+  task :uninstall do
+    sh "gem uninstall #{spec.name}"
+  end
+
+  task :clean do
+    FileUtils.rm_rf gem_dir
+  end
+
+end
+
+task :clean => 'gem:clean'
+
+task :setup => [ 'gem:install', :clean ]
+
+task :default => :setup

data/acclaim.gemspec

@@ -0,0 +1,20 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'acclaim/version'
+
+Gem::Specification.new('acclaim') do |gem|
+
+  gem.version     = Acclaim::Version::STRING
+  gem.summary     = 'Command-line option parser and command interface.'
+  gem.description = gem.summary
+
+  gem.author = 'Matheus Afonso Martins Moreira'
+  gem.email  = 'matheus.a.m.moreira@gmail.com'
+
+  gem.files       = `git ls-files`.split "\n"
+
+  gem.add_development_dependency 'rspec'
+
+end

data/lib/acclaim.rb

@@ -0,0 +1 @@
+%w(command option option/parser options version).each { |file| require file.prepend 'acclaim/' }

data/lib/acclaim/command.rb

@@ -0,0 +1,68 @@
+require 'acclaim/option'
+require 'acclaim/option/parser'
+
+module Acclaim
+
+  # A command is a single word whose meaning the program understands. It calls
+  # upon a function of the program, which may be fine-tuned with options and
+  # given arguments.
+  #
+  #   app --global-option do --option
+  #
+  # A subcommand benefits from its parent's option processing.
+  #
+  #   app do something --option --option-for-something
+  #
+  # A command can be instantiated in the following form:
+  #
+  #   cmd = Command.new :foo do
+  #     opt :verbose, short: '-v', long: '--verbose',
+  #                   description: 'Run verbosely', default: false
+  #   end
+  #
+  # TODO: make these class methods instead of instance methods, with one class
+  #       per command
+  class Command
+
+    attr_accessor :name, :action
+
+    # Initializes a command with a name and evalutes the block if one is given.
+    def initialize(name, &block)
+      self.name = name.to_s
+      instance_eval &block if block
+    end
+
+    # The options this command can take.
+    def options
+      @options ||= []
+    end
+
+    def option(name, args)
+      args.merge!(:name => name) { |key, old, new| new }
+      options << Option.new(args)
+    end
+
+    alias :opt :option
+
+    # Executes the command with the given options and arguments.
+    def execute(options, *args)
+      action.call options, *args
+    end
+
+    def parse_options!(*args)
+    end
+
+    alias :call :execute
+
+    # The commands that may be given to this command.
+    def subcommands
+      @subcommands ||= []
+    end
+
+    def subcommand(*args, &block)
+      subcommands << Command.new(*args, &block)
+    end
+
+  end
+
+end

data/lib/acclaim/option.rb

@@ -0,0 +1,31 @@
+module Acclaim
+
+  # Represents a command-line option.
+  class Option
+
+    attributes = %w(name short long description arity default).map!(&:to_sym).freeze
+
+    attr_accessor *attributes
+
+    def initialize(args = {})
+      args.each do |attribute, value|
+        instance_variable_set :"@#{attribute}", value
+      end
+      yield self if block_given?
+    end
+
+    def =~(str)
+      str = str.strip
+      long == str or short == str
+    end
+
+    def flag?
+      not arity or arity.empty? or arity == [0, 0]
+    end
+
+    alias :bool?    :flag?
+    alias :boolean? :flag?
+    alias :switch?  :flag?
+
+  end
+end

data/lib/acclaim/option/parser.rb

@@ -0,0 +1,99 @@
+require 'acclaim/options'
+
+module Acclaim
+  class Option
+
+    # Parses arrays of strings and returns an Options instance containing data.
+    class Parser
+
+      class Error < StandardError; end
+
+      attr_accessor :argv, :options
+
+      # Initializes a new parser, with the given argument array and set of
+      # options. If no option array is given, the argument array will be
+      # preprocessed only.
+      def initialize(argv, options = nil)
+        self.argv = argv
+        self.options = options
+      end
+
+      def parse!
+        preprocess_argv!
+        instance = build_options_instance! unless options.nil?
+      end
+
+      private
+
+      # Argument array preprocessing. Does not touch
+      def preprocess_argv!
+        split_multiple_short_options!
+        # TODO: normalize parameter formats?
+        # --switch=PARAM1[,PARAM2,PARAM3] - split on =, then split on comma,
+        #                                   then reinsert them into argv
+        # -sPARAM1[,PARAM2,PARAM3...] - possibly incompatible with split_multiple_short_options!
+        argv.compact!
+      end
+
+      def split_multiple_short_options!
+        argv.find_all { |arg| arg =~ /^-\w{2,}/ }.each do |multiples|
+          multiples_index = argv.index multiples
+          argv.delete multiples
+          options, *parameters = multiples.split /\s+/
+          separated_options = options.sub!(/^-/, '').split(//).map! { |option| option.prepend '-' }
+          separated_options.each_index do |option_index|
+            argv.insert multiples_index + option_index, separated_options[option_index]
+          end
+          last_option_index = argv.index separated_options.last
+          parameters.each_index do |parameter_index|
+            argv.insert last_option_index + paramter_index + 1,
+                        parameters[parameter_index]
+          end
+        end
+      end
+
+      def build_options_instance!
+        Options.new.tap do |options_instance|
+          options.each do |option|
+            key = option.name.to_s.to_sym
+            options_instance[key] = option.default
+            args = argv.find_all { |arg| option =~ arg }
+            if args.any?
+              if option.flag?
+                options_instance[key] = true
+              else
+                minimum, optional = option.arity
+                args.each do |arg|
+                  arg_index = argv.index arg
+                  len = if optional >= 0
+                    arg_index + minimum + optional
+                  else
+                    argv.length - 1
+                  end
+                  params = argv[arg_index + 1, len]
+                  values = []
+                  params.each do |param|
+                    break if param.nil? or param =~ /^-{1,2}/ or param =~ /^-{2,}$/
+                    values << param
+                  end
+                  count = values.count
+                  if count < minimum
+                    raise Error, "Wrong number of arguments (%d for %d)" % [count, minimum]
+                  end
+                  options_instance[key] = if minimum == 1 and optional.zero?
+                    values.first
+                  else
+                    values
+                  end
+                  values.each { |value| argv.delete value }
+                end
+              end
+              args.each { |arg| argv.delete arg }
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/acclaim/options.rb

@@ -0,0 +1,41 @@
+module Acclaim
+
+  # Represents a set of options.
+  class Options
+
+    def [](key)
+      data[key]
+    end
+
+    def []=(key, value)
+      data[key] = value
+    end
+
+    # Handles the following cases:
+    #
+    #   options.method = value
+    #   options.method?
+    #   options.method
+    def method_missing(method, *args, &block)
+      m = method.to_s
+      case m
+        when /=$/
+          self[:"#{m.chop!}"] = args.first
+        when /\?$/
+          self[:"#{m.chop!}"] ? true : false
+        else
+          self[method]
+      end
+    end
+
+    private
+
+    # The option values
+    def data
+      @options ||= {}
+    end
+
+
+  end
+
+end

data/lib/acclaim/version.rb

@@ -0,0 +1,12 @@
+module Acclaim
+  module Version
+
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+    BUILD = 'alpha1'
+
+    STRING = [ MAJOR, MINOR, PATCH, BUILD ].compact.join '.'
+
+  end
+end

data/spec/acclaim/option/parser_spec.rb

@@ -0,0 +1,73 @@
+require 'acclaim/option'
+require 'acclaim/option/parser'
+
+describe Acclaim::Option::Parser do
+
+  describe '#parse!' do
+
+    let!(:args) do
+      %w(cmd subcmd -a -b PARAM1 -cdef PARAM2 --long --parameters PARAM3 PARAM4 -- FILE1 FILE2)
+    end
+
+    subject { Acclaim::Option::Parser.new(args) }
+
+    it 'should split multiple short options' do
+      new_argv = args.dup.tap do |args|
+        args[args.index('-cdef')] = %w[-c -d -e -f]
+      end.flatten!
+      subject.parse!
+      args.should == new_argv
+    end
+
+    context 'when not given an array of options' do
+
+      it 'should not return an options instance' do
+        subject.parse!.should be_nil
+      end
+
+    end
+
+    context 'when given an array of options' do
+
+      let(:options) do
+        [].tap do |opts|
+          ('a'..'f').each do |c|
+            hash = { name: c, short: "-#{c}" }
+            hash[:arity] = [1, 0] if c == 'b' or c == 'f'
+            opts << Acclaim::Option.new(hash)
+          end
+          opts << Acclaim::Option.new(name: 'long', long: '--long')
+          opts << Acclaim::Option.new(name: 'params', long: '--parameters',
+                                      arity: [1, -1], default: [])
+        end
+      end
+
+      subject { Acclaim::Option::Parser.new(args, options) }
+
+      it 'should return an options instance' do
+        subject.parse!.should_not be_nil
+      end
+
+      it 'should parse arguments correctly' do
+        subject.parse!.instance_eval do
+          a?.should be_true
+          b.should == 'PARAM1'
+          c?.should be_true
+          d?.should be_true
+          e?.should be_true
+          f.should == 'PARAM2'
+          long?.should be_true
+          params.should == %w(PARAM3 PARAM4)
+        end
+      end
+
+      it 'should leave unparsed arguments in argv' do
+        subject.parse!
+        args.should == %w(cmd subcmd -- FILE1 FILE2)
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: acclaim
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha1
+  prerelease: 6
+platform: ruby
+authors:
+- Matheus Afonso Martins Moreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14045320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14045320
+description: Command-line option parser and command interface.
+email: matheus.a.m.moreira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.GPLv3
+- README.markdown
+- Rakefile
+- acclaim.gemspec
+- lib/acclaim.rb
+- lib/acclaim/command.rb
+- lib/acclaim/option.rb
+- lib/acclaim/option/parser.rb
+- lib/acclaim/options.rb
+- lib/acclaim/version.rb
+- spec/acclaim/option/parser_spec.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Command-line option parser and command interface.
+test_files: []