cinatra 0.3.1 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/examples/todo.rb

@@ -0,0 +1,30 @@
+require 'cinatra'
+
+TODOS = []
+
+def show_todos
+  TODOS.each_with_index do |todo, index|
+    puts "#{index}: #{todo}"
+  end
+end
+
+command 'todo add', <<DESC do |arg|
+Add a todo to list
+usage: todo add buy the milk
+DESC
+  TODOS << arg
+  show_todos
+end
+
+command 'todo delete', 'Delete a todo from list' do |arg|
+  TODOS.delete_at(arg.to_i)
+  show_todos
+end
+
+command 'todo list', 'Show todo list' do |arg|
+  show_todos
+end
+
+command 'todo clear', 'Clear todo list' do |arg|
+  TODOS.clear
+end

data/lib/cinatra.rb

@@ -1,22 +1,22 @@
 require 'singleton'
 require 'readline'
+require 'cinatra/command'
 
 class Cinatra
   include Singleton
 
   attr_accessor :exiting
 
-  def add_command(name, &block)
-    name = self.class.normalize_as_command_name(name.to_s).to_sym
+  def add_command(name, desc = '', &block)
+    name = normalize_as_command_name(name)
     if commands.key?(name)
-      puts "Warning: command '#{name}' is already exists."
-      return
+      puts "Warning: The command '#{name}' will be overridden."
     end
-    commands[name] = block
+    commands[name] = Command.new(name, desc, &block)
   end
 
   def delete_command(name)
-    commands.delete(name.to_sym)
+    commands.delete(normalize_as_command_name(name))
   end
 
   def get_command(name)
@@ -72,7 +72,7 @@ class Cinatra
 
   def resolve_command_name_and_arg(line)
     command_names.map {|i| i.split(' ')}.sort_by{|i| i.size}.reverse_each do |command|
-      if self.class.is_command_match_to_line?(command, line)
+      if is_command_match_to_line?(command, line)
         name = command.join(' ').to_sym
         arg = line.split(' ', command.size + 1)[command.size]
         return name, arg
@@ -81,11 +81,20 @@ class Cinatra
     return nil, nil
   end
 
+  def normalize_as_command_name(name)
+    name = name.to_s
+    raise ArgumentError, "`#{name}` is invalid for command name." if /^\s*$/ =~ name
+    name.strip.gsub(/\s+/, ' ').to_sym
+  end
+
+  def is_command_match_to_line?(command, line)
+    line.split(' ')[0...command.size] == command
+  end
+
   class << self
     [
       :add_command, :get_command, :delete_command,
-      :commands, :start, :call, :command_names,
-      :resolve_command_name_and_arg, :exit
+      :commands, :start, :call, :command_names, :exit
     ].each do |method|
       class_eval <<-DELIM
         def #{method}(*args, &block)
@@ -93,27 +102,34 @@ class Cinatra
         end
       DELIM
     end
-
-    def normalize_as_command_name(name)
-      name.strip.gsub(/\s+/, ' ')
-    end
-
-    def is_command_match_to_line?(command, line)
-      line.split(' ')[0...command.size] == command
-    end
   end
 end
 
 module Kernel
-  def command(name, &block)
-    Cinatra.add_command(name, &block)
+  def command(name, desc = '', &block)
+    Cinatra.add_command(name, desc, &block)
   end
 end
 
-command 'exit' do
+command 'exit', 'Exit' do
   Cinatra.exit
 end
 
+command 'help', 'Show help'do |arg|
+  if arg
+    command = Cinatra.get_command(arg)
+    if command
+      puts command.desc
+    end
+  else
+    commands = Cinatra.commands.values
+    max_length = commands.inject(0) {|max, command| [command.name.to_s.size, max].max }
+    commands.each do |command|
+      puts "#{command.name.to_s.ljust(max_length)}  #{command.desc.split("\n")[0]}"
+    end
+  end
+end
+
 at_exit do
   Cinatra.start
 end

data/lib/cinatra/command.rb

@@ -0,0 +1,15 @@
+class Cinatra
+  class Command
+    attr_reader :name, :desc, :proc
+
+    def initialize(name, desc = '', &block)
+      @name = name
+      @desc = desc
+      @proc = block
+    end
+
+    def call(*args)
+      proc.call(*args)
+    end
+  end
+end

data/test/test_cinatra.rb

@@ -8,6 +8,7 @@ class TestCinatra < Test::Unit::TestCase
   context 'default' do
     setup do
       Cinatra.commands.clear
+      @instance = Cinatra.instance
     end
 
     should 'add command' do
@@ -26,8 +27,14 @@ class TestCinatra < Test::Unit::TestCase
         Cinatra.add_command('test', &@block)
       end
 
+      should "override a command" do
+        block = lambda {}
+        Cinatra.add_command('test', &block)
+        assert_equal block, Cinatra.get_command('test').proc
+      end
+
       should "get a command" do
-        assert_equal @block, Cinatra.get_command('test')
+        assert_equal @block, Cinatra.get_command('test').proc
       end
 
       should "delete a command" do
@@ -49,10 +56,10 @@ class TestCinatra < Test::Unit::TestCase
       end
 
       should 'resolve command name' do
-        assert_equal [:test, nil],         Cinatra.resolve_command_name_and_arg('test')
-        assert_equal [:test, 'foo'],       Cinatra.resolve_command_name_and_arg('test foo')
-        assert_equal [:test, 'foo bar'],   Cinatra.resolve_command_name_and_arg('test foo bar')
-        assert_equal [:test, 'foo  bar'],  Cinatra.resolve_command_name_and_arg('test foo  bar')
+        assert_equal [:test, nil],         @instance.resolve_command_name_and_arg('test')
+        assert_equal [:test, 'foo'],       @instance.resolve_command_name_and_arg('test foo')
+        assert_equal [:test, 'foo bar'],   @instance.resolve_command_name_and_arg('test foo bar')
+        assert_equal [:test, 'foo  bar'],  @instance.resolve_command_name_and_arg('test foo  bar')
       end
 
       context "add a command 'test foo'" do
@@ -93,28 +100,24 @@ class TestCinatra < Test::Unit::TestCase
     end
 
     should "check to match command to line" do
-      assert Cinatra.is_command_match_to_line?(['test'], 'test') == true
-      assert Cinatra.is_command_match_to_line?(['test'], ' test ') == true
-      assert Cinatra.is_command_match_to_line?(['test'], 'te st') == false
-      assert Cinatra.is_command_match_to_line?(['test'], 'tes') == false
-      assert Cinatra.is_command_match_to_line?(['test', 'foo'], 'test foo') == true
-      assert Cinatra.is_command_match_to_line?(['test', 'foo'], ' test  foo ') == true
-      assert Cinatra.is_command_match_to_line?(['test', 'bar'], ' test  foo ') == false
-      assert Cinatra.is_command_match_to_line?(['test', 'foo'], 'foo test') == false
-      assert Cinatra.is_command_match_to_line?(['test', 'foo', 'bar'], 'test foo bar') == true
+      assert @instance.is_command_match_to_line?(['test'], 'test') == true
+      assert @instance.is_command_match_to_line?(['test'], ' test ') == true
+      assert @instance.is_command_match_to_line?(['test'], 'te st') == false
+      assert @instance.is_command_match_to_line?(['test'], 'tes') == false
+      assert @instance.is_command_match_to_line?(['test', 'foo'], 'test foo') == true
+      assert @instance.is_command_match_to_line?(['test', 'foo'], ' test  foo ') == true
+      assert @instance.is_command_match_to_line?(['test', 'bar'], ' test  foo ') == false
+      assert @instance.is_command_match_to_line?(['test', 'foo'], 'foo test') == false
+      assert @instance.is_command_match_to_line?(['test', 'foo', 'bar'], 'test foo bar') == true
     end
 
     should "normalize as command name" do
-      assert_equal 'test', Cinatra.normalize_as_command_name('test')
-      assert_equal 'test', Cinatra.normalize_as_command_name(' test ')
-      assert_equal 'test foo', Cinatra.normalize_as_command_name('test foo')
-      assert_equal 'test foo', Cinatra.normalize_as_command_name(' test  foo ')
-      assert_equal '', Cinatra.normalize_as_command_name('')
-    end
-
-    should "raise Error when add commans with same name" do
-      assert_nothing_raised(RuntimeError) { Cinatra.add_command('test') {} }
-      assert_raise(RuntimeError) { Cinatra.add_command('test') {} }
+      assert_equal :'test',      @instance.normalize_as_command_name('test')
+      assert_equal :'test',      @instance.normalize_as_command_name(:test)
+      assert_equal :'test',      @instance.normalize_as_command_name(' test ')
+      assert_equal :'test foo',  @instance.normalize_as_command_name('test foo')
+      assert_equal :'test foo',  @instance.normalize_as_command_name(' test  foo ')
+      assert_raise(ArgumentError) { @instance.normalize_as_command_name('') }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cinatra
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - jugyo
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-31 00:00:00 +09:00
+date: 2010-01-01 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,8 +48,9 @@ files:
 - Rakefile
 - VERSION
 - examples/sleep.rb
-- examples/sub_command.rb
+- examples/todo.rb
 - lib/cinatra.rb
+- lib/cinatra/command.rb
 - test/helper.rb
 - test/test_cinatra.rb
 has_rdoc: true
@@ -84,4 +85,4 @@ test_files:
 - test/helper.rb
 - test/test_cinatra.rb
 - examples/sleep.rb
-- examples/sub_command.rb
+- examples/todo.rb

data/examples/sub_command.rb

@@ -1,27 +0,0 @@
-require 'cinatra'
-
-TODOS = []
-
-def show_todos
-  TODOS.each_with_index do |todo, index|
-    puts "#{index}: #{todo}"
-  end
-end
-
-command 'todo add' do |arg|
-  TODOS << arg
-  show_todos
-end
-
-command 'todo delete' do |arg|
-  TODOS.delete_at(arg.to_i)
-  show_todos
-end
-
-command 'todo list' do |arg|
-  show_todos
-end
-
-command 'todo clear' do |arg|
-  TODOS.clear
-end