quickl 0.1.1

data/lib/quickl/ruby_tools.rb

@@ -0,0 +1,60 @@
+module Quickl
+  module RubyTools
+
+    # Returns the parent module of a class
+    def parent_module(clazz)
+      name = clazz.name
+      (name =~ /^(.*?)::([^:]+)$/) ? Kernel.eval($1) : nil
+    end
+    module_function :parent_module
+
+    # Returns the unqualified name of a class
+    def class_unqualified_name(clazz)
+      name = clazz.name
+      (name =~ /::([^:]+)$/) ? $1 : name
+    end
+    module_function :class_unqualified_name
+
+    # Makes a call to a block that accepts optional arguments
+    def optional_args_block_call(block, args)
+      if RUBY_VERSION >= "1.9.0"
+        if block.arity == 0
+          block.call
+        else
+          block.call(*args)
+        end
+      else
+        block.call(*args)
+      end
+    end
+    module_function :optional_args_block_call
+
+    # Extracts the rdoc of a given ruby file source.
+    def extract_file_rdoc(file, from = nil, reverse = false)
+      lines = File.readlines(file)
+      if from.nil? and reverse
+        lines = lines.reverse
+      elsif !reverse
+        lines = lines[(from || 0)..-1]
+      else
+        lines = lines[0...(from || -1)].reverse
+      end
+      
+      doc, started = [], false
+      lines.each{|line|
+        if /^\s*[#]/ =~ line
+          doc << line
+          started = true
+        elsif started
+          break
+        end 
+      }
+      
+      doc = reverse ? doc.reverse[0..-1] : doc[0..-1]
+      doc = doc.join("\n")
+      doc.gsub(/^\s*[#] ?/, "")
+    end
+    module_function :extract_file_rdoc
+
+  end # module RubyTools
+end # module Quickl

data/quickl.gemspec

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'rubygems'
+require 'quickl'
+
+Gem::Specification.new do |s|
+  s.name = 'quickl'
+  s.version = Quickl::VERSION.dup
+  s.date = Time.now.strftime('%Y-%m-%d')
+
+  s.summary = 'Generate Ruby command line apps quickly'
+  s.description = 'Generate Ruby command line apps quickly'
+
+  s.author = 'Bernard Lambeau'
+  s.email = 'blambeau@gmail.com'
+
+  s.require_paths = %w{ lib }
+
+  s.files = 
+    Dir['lib/**/*'] +
+    Dir['examples/**/*'] +
+    Dir['templates/**/*'] +
+    Dir['bin/**/*'] +
+    Dir['test/**/*'] +
+    %w{ quickl.gemspec Rakefile README.md CHANGELOG.md }
+
+  s.test_files = s.files.select {|path| path =~ /^test\/.*_test.rb/ }
+
+  s.bindir = "bin"
+  s.executables = ["quickl"]
+
+  s.add_development_dependency('rake')
+
+  s.has_rdoc = true
+  s.rdoc_options = %w< --line-numbers --inline-source --title Quickl --main Quickl >
+  s.extra_rdoc_files = %w< README.md >
+
+  s.homepage = 'http://github.com/blambeau/quickl'
+end

data/templates/single.erb

@@ -0,0 +1,40 @@
+begin
+  require 'quickl'
+rescue LoadError
+  require 'rubygems'
+  gem 'quickl'
+  retry  
+end
+
+#
+# FIX: overview
+#
+# SYNOPSIS
+#   #{command_name} [options] ARGS...
+#
+# OPTIONS
+# #{summarized_options}
+#
+# DESCRIPTION
+#   FIX: description 
+#
+class <%= cmd_class_name %> < Quickl::Command(__FILE__, __LINE__)
+
+  VERSION   = "0.1.0"
+
+  # Install options
+  options do |opt|
+<%= option_helpers.collect{|s| tabto(s,4)}.join("\n") %>
+  end
+  
+  # Run the command
+  def execute(args)
+    # FIX: do something here
+    puts "Hello #{args.join(' and ')} from #{program_name}"
+  end
+
+end # class <%= cmd_class_name %>
+
+if __FILE__ == $0
+  <%= cmd_class_name %>.run(ARGV)
+end

data/test/command/command_name.spec

@@ -0,0 +1,16 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::command_name /" do
+    
+    it "should be installed from inline rdoc" do
+      MiniClient::Say::Hello.command_name.should == "hello"
+      MiniClient::Say::Goodbye.command_name.should == "goodbye"
+    end
+    
+    it "should be accessible on instance" do
+      MiniClient::Say::Hello.new.command_name.should == "hello"
+      MiniClient::Say::Goodbye.new.command_name.should == "goodbye"
+    end
+
+  end # Command::command_name
+end # module Quickl

data/test/command/documentation.spec

@@ -0,0 +1,23 @@
+$hello_doc = <<EOF
+
+Say hello to the user whose name is requested on the standard input
+
+SYNOPSIS
+  mini-client say:hello
+
+DESCRIPTION
+  And an explanation here
+  on multiple lines with replacement: hello
+
+EOF
+
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::documentation /" do
+    
+    it "should be correctly installed" do
+      MiniClient::Say::Hello.documentation.should == $hello_doc[0..-1]
+    end
+
+  end # Command::command
+end # module Quickl

data/test/command/overview.spec

@@ -0,0 +1,14 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::overview /" do
+    
+    it "should be installed from inline rdoc" do
+      MiniClient::Help.overview.should == "Print help"
+    end
+
+    it "should be installed accessible on instance" do
+      MiniClient::Help.new.overview.should == "Print help"
+    end
+
+  end # Command::overview
+end # module Quickl

data/test/command/run.spec

@@ -0,0 +1,22 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::run /" do
+    
+    it "when invoked on a terminal command" do
+      MiniClient::Say::Hello.run.should == :hello
+      MiniClient::Say::Goodbye.run.should == :goodbye
+    end
+
+    it "when invoked on a delegate command" do
+      MiniClient.run(["help"]).should == :help
+      MiniClient::Say.run(["hello"]).should == :hello
+      MiniClient::Say.run(["goodbye"]).should == :goodbye
+    end
+
+    it "when invoked on qualified command names" do
+      MiniClient.run(["say:hello"]).should == :hello
+      MiniClient.run(["say:goodbye"]).should == :goodbye
+    end
+
+  end # Command::command
+end # module Quickl

data/test/command/subcommands.spec

@@ -0,0 +1,20 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::subcommands /" do
+    
+    it "should return installed commands in an array" do
+      MiniClient.subcommands.should == [ 
+        MiniClient::Help, 
+        MiniClient::Say 
+      ]
+    end
+    
+    it "should return installed commands in an array" do
+      MiniClient::Say.subcommands.should == [ 
+        MiniClient::Say::Hello,
+        MiniClient::Say::Goodbye
+      ]
+    end
+
+  end # Command::subcommand
+end # module Quickl

data/test/command/usage.spec

@@ -0,0 +1,16 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::usage /" do
+    
+    it "should be installed from inline rdoc" do
+      MiniClient::Say::Hello.usage.should == "mini-client say:hello"
+      MiniClient::Say::Goodbye.usage.should == "mini-client say:goodbye"
+    end
+    
+    it "should be accessible on instance" do
+      MiniClient::Say::Hello.new.usage.should == "mini-client say:hello"
+      MiniClient::Say::Goodbye.new.usage.should == "mini-client say:goodbye"
+    end
+
+  end # Command::usage
+end # module Quickl

data/test/mini_client.rb

@@ -0,0 +1,59 @@
+#
+# MiniClient main command
+#
+class MiniClient < Quickl::Delegate(__FILE__, __LINE__)
+    
+  #
+  # Print help
+  #
+  # SYNOPSIS
+  #   #{MiniClient.command_name} help
+  #
+  # DESCRIPTION
+  #   #{command_name} prints help
+  #
+  class Help < Quickl::Command(__FILE__, __LINE__)
+
+    def run(*args)
+      :help
+    end
+      
+  end # class Help
+  
+  class Say < Quickl::Delegate(__FILE__, __LINE__)
+
+    #
+    # Say hello to the user whose name is requested on the standard input
+    #
+    # SYNOPSIS
+    #   #{MiniClient.command_name} say:hello
+    #
+    # DESCRIPTION
+    #   And an explanation here
+    #   on multiple lines with replacement: #{command_name}
+    #
+    class Hello < Quickl::Command(__FILE__, __LINE__)
+      
+      def run(*args)
+        :hello
+      end
+      
+    end # class Hello
+
+    #
+    # Say goodbye to the currently connected user
+    #
+    # SYNOPSIS
+    #   #{MiniClient.command_name} say:goodbye
+    #
+    class Goodbye < Quickl::Command(__FILE__, __LINE__)
+
+      def run(*args)
+        :goodbye
+      end
+      
+    end # class Goodbye
+
+  end # class Say
+    
+end # module MiniClient

data/test/naming/command2module.spec

@@ -0,0 +1,17 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Naming::command2module /" do
+    include Naming
+    
+    it "should capitalize first char" do
+      command2module("say").should == "Say"
+      command2module(:say).should == :Say
+    end
+
+    it "should capitalize support dashes" do
+      command2module("say-hello").should == "SayHello"
+      command2module(:"say-hello").should == :SayHello
+    end
+    
+  end # module Quickl
+end # module Quickl

data/test/naming/module2command.spec

@@ -0,0 +1,21 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Naming::module2command /" do
+    include Naming
+    
+    it "should uncapitalize first char" do
+      module2command("Say").should == "say"
+      module2command(:Say).should == :say
+    end
+
+    it "should uncapitalize and introduce dashes" do
+      module2command("SayHello").should == "say-hello"
+      module2command(:"SayHello").should == :"say-hello"
+    end
+    
+    it "should support taking modules as argument" do
+      module2command(Quickl::Command).should == "command"
+    end
+    
+  end # module Quickl
+end # module Quickl

data/test/ruby_tools/class_unqualified_name.spec

@@ -0,0 +1,28 @@
+require File.expand_path('../fixtures', __FILE__)
+module Quickl
+  describe "RubyTools#class_unqualified_name /" do
+  
+    subject{ RubyTools::class_unqualified_name(clazz) }
+  
+    describe "when called on unqualified class" do
+      let(:clazz){ ::String }
+      it{ should == "String" }
+    end
+  
+    describe "when called on qualified class" do
+      let(:clazz){ RubyTools }
+      it{ should == "RubyTools" }
+    end
+  
+    describe "when called on long qualified class" do
+      let(:clazz){ Quickl::Fixtures::Utils }
+      it{ should == "Utils" }
+    end
+  
+    describe "when piped with parent_module" do
+      let(:clazz){ RubyTools::parent_module(Quickl::Fixtures::Utils) }
+      it{ should == "Fixtures" }
+    end
+
+  end
+end

data/test/ruby_tools/extract_file_rdoc.spec

@@ -0,0 +1,28 @@
+require File.expand_path('../fixtures', __FILE__)
+module Quickl
+  describe "RubyTools#extract_file_rdoc /" do
+    
+    let(:file){ File.expand_path('../fixtures.rb', __FILE__) }
+    
+    describe "when used without line and reverse options" do
+
+      subject{ RubyTools::extract_file_rdoc(file) }
+  
+      it "should be as expected" do
+        subject.should == File.read(File.expand_path('../fixtures/RubyTools.rdoc', __FILE__))
+      end
+
+    end
+    
+    describe "when used with line and reverse options" do
+
+      subject{ RubyTools::extract_file_rdoc(file, 23, true) }
+  
+      it "should be as expected" do
+        subject.should == File.read(File.expand_path('../fixtures/Utils.rdoc', __FILE__))
+      end
+
+    end
+  
+  end # RubyTools#extract_file_rdoc
+end # module Quickl

data/test/ruby_tools/fixtures.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  module Fixtures
+
+    #
+    # This is a fixtures helper that matches documentation conventions.
+    #
+    # This is a second paragraph
+    # That append on two lines
+    #
+    #
+    # WARNING:
+    #   This kind of indentation should not be interpreted as code
+    #
+    #   But this one yes
+    #
+    module RubyTools
+    end # module RubyTools
+    
+    #
+    # This is the documentation of the Utils module
+    #
+    module Utils
+    end # module Utils
+
+  end # module Fixtures
+end # module Quickl