gestopft 0.0.1

data/.autotest

@@ -0,0 +1,8 @@
+# vim:set ft=ruby:
+
+Autotest.add_hook :initialize do |autotest|
+	autotest.add_mapping %r{lib/.*\.rb$} do |f, m|
+		Dir.glob "spec/**/*.rb"
+	end
+end
+

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--fail-fast
+

data/README.rdoc

@@ -0,0 +1,38 @@
+= gestopft
+
+== Description
+
+Framework for CLI Application (like {App::CLI}[http://search.cpan.org/dist/App-CLI/])
+
+
+== Installation
+
+=== Archive
+
+	rake install
+
+=== Gem
+
+	gem install gestopft
+
+
+== Synopsis
+
+	require "gestopft"
+
+	class Echo < Gestopft::App
+		option :verbose, "print debug messages."
+
+		def echo(message)
+			puts "Echo#echo is invoked." if @options[:verbose]
+			puts message
+		end
+	end
+
+
+== Copyright
+
+Copyright:: Copyright (c) 2011 AOKI,Hanae
+Author::    AOKI,Hanae (aereal, trasty.loose@gmail.com)
+License::   Ruby's
+

data/lib/gestopft.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+require "gestopft/core_ext"
+
+module Gestopft
+	VERSION = '0.0.1'
+
+	module Constants
+		class Error < ::StandardError; end
+		class NotSatisfiedRequirements < Error; end
+	end
+
+	autoload :App,    'gestopft/app'
+	autoload :Option, 'gestopft/option'
+end
+

data/lib/gestopft/app.rb

@@ -0,0 +1,101 @@
+# -*- encoding: utf-8
+
+class Gestopft::App
+	include Gestopft::Constants
+
+	def self.expectation
+		@expectation ||= []
+	end
+
+	def self.option(name, *args)
+		desc = args.find {|arg| arg.is_a? String }
+		params = args.find {|arg| arg.is_a? Array }
+		expectation << Gestopft::Option.new(name, {
+			:desc => desc,
+			:params => params
+		})
+	end
+
+	def self.run(argv)
+		new(argv).parse_arg.dispatch
+	end
+
+	def self.commands
+		public_instance_methods - Gestopft::App.public_instance_methods
+	end
+
+	attr_reader :options
+
+	def initialize(argv)
+		@argv = argv.option_args
+		@expectation = self.class.expectation
+		@options = {}
+		@commands = self.class.commands.map {|cmd| method(cmd) }
+	end
+
+	def parse_arg
+		@expectation.each do |opt|
+			if opt.require_args?
+				if (
+					pos = @argv.find_index(opt.option_name) and
+					params = @argv[pos + 1, opt.arity] and
+					params.none? {|param| param.option? } and
+					params.size == opt.arity
+				)
+					@options[opt.name] = params
+				else
+					raise NotSatisfiedRequirements
+				end
+			else
+				@options[opt.name] = opt.option_name
+			end
+		end
+		self
+	end
+
+	def dispatch
+		argv = @argv.reject {|arg| arg.option? }
+		@commands.each do |cmd|
+			if pos = argv.find_index(cmd.name.to_s)
+				params = argv[pos + 1, cmd.arity.abs]
+				return cmd.call(*params)
+			end
+		end
+		self
+	end
+
+	def help_message
+		msg = []
+		msg << <<-BANNER.strip
+Usage:
+	$ #{File.basename($0)} [options] #{"command [args, ...]" unless @commands.empty?}
+		BANNER
+
+		unless @expectation.empty?
+			msg << "Options: "
+			@expectation.each do |opt|
+				line = ["\t", opt.option_name]
+				line << opt.params.map {|param|
+					param.to_s.upcase
+				}.join(' ') unless opt.params.empty?
+				line << opt.desc unless opt.desc.empty?
+				msg << line.join(" ")
+			end
+		end
+
+		unless @commands.empty?
+			msg << <<-COMMANDS.strip
+Commands:
+	#{@commands.map {|cmd| cmd.name }.join(' ')}
+			COMMANDS
+		end
+
+		msg << ""
+		msg.join("\n\n")
+	end
+
+	def __default__
+		STDIN.puts help_message
+	end
+end
+

data/lib/gestopft/core_ext.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require "pathname"
+
+dir = Pathname.new(__FILE__).expand_path.parent + 'core_ext/'
+
+dir.each_child do |entry|
+	require entry.to_s
+end
+

data/lib/gestopft/core_ext/array.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module ArrayExtension
+	def option_args
+		pos = index('--') ? slice(0...pos) : dup
+	end
+end
+
+Array.send(:include, ArrayExtension)
+

data/lib/gestopft/core_ext/string.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module StringExtention
+	def option?
+		/^--[-a-zA-Z0-9]+$/ === self
+	end
+
+	def to_option
+		(slice(0..2) == '--' ? '' : '--') + strip.gsub('_', '-')
+	end
+end
+
+String.send(:include, StringExtention)
+

data/lib/gestopft/core_ext/symbol.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module SymbolExtension
+	def to_option
+		to_s.to_option
+	end
+end
+
+Symbol.send(:include, SymbolExtension)
+

data/lib/gestopft/option.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+class Gestopft::Option
+	attr_reader :name, :params, :description
+	alias_method :desc, :description
+
+	def initialize(name, args={})
+		@name = name
+		@params = args[:params] || []
+		@description = args[:desc] || args[:description] || ""
+	end
+
+	def option_name
+		@name.to_option
+	end
+
+	def require_args?
+		!@params.empty?
+	end
+
+	def arity
+		@params.size
+	end
+end
+

data/spec/gestopft/option_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+# vim:set ft=ruby:
+
+require "gestopft"
+
+include Gestopft::Constants
+
+describe Gestopft::Option do
+	subject do
+		Gestopft::Option.new(:my_option, :desc => "my description")
+	end
+
+	it "#option_name is option string." do
+		subject.option_name.should == '--my-option'
+	end
+
+	context "when given a description." do
+		it "#desc[ription] is the description about the option." do
+			subject.desc.should == "my description"
+			subject.description.should == "my description"
+		end
+	end
+
+	context "when does not given a description." do
+		subject do
+			Gestopft::Option.new(:my_option)
+		end
+
+		it "#desc[ription] is empty." do
+			subject.desc.should be_empty
+			subject.description.should be_empty
+		end
+	end
+
+	context "which requires parameters." do
+		subject do
+			Gestopft::Option.new(:delay, :params => %w(minute))
+		end
+
+		it "#require_args? is true" do
+			subject.require_args?.should be_true
+		end
+
+		it "#arity is the arity of option." do
+			subject.arity.should == 1
+		end
+	end
+
+	context "which requires no parameter." do
+		subject do
+			Gestopft::Option.new(:verbose)
+		end
+
+		it "#require_args? is false" do
+			subject.require_args?.should be_false
+		end
+
+		it "#arity is 0." do
+			subject.arity.should == 0
+		end
+	end
+end
+

data/spec/gestopft_spec.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+# vim: set ft=ruby:
+
+require "gestopft"
+
+include Gestopft::Constants
+
+describe Gestopft::App do
+	subject do
+		Class.new(Gestopft::App)
+	end
+
+	context "given a option which requires no arguments." do
+		before :all do
+			subject.module_eval do
+				option :with_no_args
+			end
+		end
+
+		it "has a option which given." do
+			subject.run(%w(--with-no-args)).options.
+				should include(:with_no_args)
+		end
+
+		it "does not have a option which does not given." do
+			subject.run(%w(--with-no-args)).options.
+				should_not include(:does_not_given)
+		end
+
+		it "succeeds when given a option which requires no arguments." do
+			expect { subject.run(%w(--with-no-args)) }.
+				should_not raise_error(Error)
+		end
+
+		it "succeeds when not given a option which is required." do
+			expect { subject.run([]) }.
+				should_not raise_error(NotSatisfiedRequirements)
+		end
+	end
+
+	context "a option which require a argument." do
+		before :all do
+			subject.module_eval do
+				option :delay, [:minute]
+			end
+		end
+
+		it "has a option which given with taken parameter." do
+			subject.run(%w(--delay 5)).options.
+				should include(:delay => ['5'])
+		end
+
+		it "does not have a option which given without any arguments." do
+			expect { subject.run(%w(--delay)) }.
+				should raise_error(NotSatisfiedRequirements)
+		end
+	end
+
+	context "when defined sub-commands" do
+		before do
+			subject.module_eval do
+				def update
+					:update
+				end
+			end
+		end
+
+		it ".commands is a array of available commands." do
+			subject.commands.should == [:update]
+		end
+
+		it "#dispatch return value which of sub-command's" do
+			subject.new(%w(update)).dispatch.should == subject.new([]).update
+		end
+	end
+
+	context "when not defined sub-commands" do
+		it ".commands is empty array." do
+			subject.commands.should be_empty
+		end
+	end
+end
+

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: gestopft
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-18 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: 
+email: trasty.loose@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- .autotest
+- .rspec
+- lib/gestopft/core_ext/array.rb
+- lib/gestopft/core_ext/symbol.rb
+- lib/gestopft/core_ext/string.rb
+- lib/gestopft/app.rb
+- lib/gestopft/option.rb
+- lib/gestopft/core_ext.rb
+- lib/gestopft.rb
+- spec/gestopft/option_spec.rb
+- spec/gestopft_spec.rb
+has_rdoc: true
+homepage: http://github.com/aereal/gestopft
+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: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Framework for CLI Application
+test_files: []
+