quickl 0.2.0 → 0.2.1

data/spec/command/documentation_spec.rb

@@ -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/spec/command/overview_spec.rb

@@ -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/spec/command/requester_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::requester /" do
+    
+    it "should return nil if invoked immediately" do
+      MiniClient::Requester.run([]).should be_nil
+    end
+    
+    it "should return delegator if ran from delegator" do
+      x = MiniClient.run(["requester"])
+      x.should_not be_nil
+      x.should be_a(MiniClient)
+    end
+    
+  end # Command::requester
+end # module Quickl

data/spec/command/robustness/valid_read_file_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::Robustness#valid_read_file!" do
+    
+    let(:r){ Object.new.extend(Command::Robustness) }
+    
+    describe "with default options" do
+    
+      it "should raise a Quickl::IOAccessError with a friendly message" do
+        begin
+          r.valid_read_file!("nosuchone.nosuchextension") 
+          true.should == false
+        rescue Quickl::IOAccessError => ex
+          ex.message.should =~ /Not a file/ 
+          ex.message.should =~ /nosuchone.nosuchextension/
+        end
+      end
+      
+    end # with default options
+    
+    describe "with specific error class" do
+
+      it "should raise it with a default message" do
+        begin
+          r.valid_read_file!("nosuchone.nosuchextension", ArgumentError) 
+          true.should == false
+        rescue ArgumentError => ex
+          ex.message.should =~ /Not a file/ 
+          ex.message.should =~ /nosuchone.nosuchextension/
+        end
+      end
+
+    end # with specific message
+
+    describe "with specific message" do
+
+      it "should raise a Quickl::IOAccessError with a specific message" do
+        begin
+          r.valid_read_file!("nosuchone.nosuchextension", nil, "specific") 
+          true.should == false
+        rescue Quickl::IOAccessError => ex
+          ex.message.should == "specific"
+        end
+      end
+
+    end # with specific message
+    
+    describe 'with specific message and error class' do
+
+      it "should raise a Quickl::IOAccessError with a specific message" do
+        begin
+          r.valid_read_file!("nosuchone.nosuchextension", ArgumentError, "specific") 
+          true.should == false
+        rescue ArgumentError => ex
+          ex.message.should == "specific"
+        end
+      end
+
+    end
+    
+  end
+end # module Quickl

data/spec/command/run_spec.rb

@@ -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 delegator 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/spec/command/subcommand_by_name_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../../spec_helper', __FILE__)
+module Quickl
+  describe "Command::subcommand_by_name /" do
+    
+    specify "when called on single command names" do
+      MiniClient.subcommand_by_name("help").should == MiniClient::Help
+      MiniClient.subcommand_by_name("noway").should be_nil
+    end
+    
+    specify "when called on complex command names" do
+      MiniClient.subcommand_by_name("say:hello").should == MiniClient::Say::Hello
+    end
+    
+  end # Command::command_name
+end # module Quickl

data/spec/command/subcommands_spec.rb

@@ -0,0 +1,24 @@
+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,
+        MiniClient::Requester,
+      ]
+      MiniClient::Say.subcommands.should == [ 
+        MiniClient::Say::Hello,
+        MiniClient::Say::Goodbye,
+      ]
+    end
+    
+    it "should take care of the command_parent= in command builder" do
+      MiniClient::Requester.subcommands.should == [
+        MiniClient::Factored
+      ]
+    end
+
+  end # Command::subcommand
+end # module Quickl

data/spec/command/usage_spec.rb

@@ -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/spec/mini_client.rb

@@ -0,0 +1,96 @@
+#
+# MiniClient main command
+#
+class MiniClient < Quickl::Delegator(__FILE__, __LINE__)
+
+  #
+  # Print help
+  #
+  # SYNOPSIS
+  #   #{MiniClient.command_name} help
+  #
+  # DESCRIPTION
+  #   #{command_name} prints help
+  #
+  class Help < Quickl::Command(__FILE__, __LINE__)
+
+    def execute(*args)
+      :help
+    end
+      
+  end # class Help
+  
+  class Say < Quickl::Delegator(__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 execute(*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 execute(*args)
+        :goodbye
+      end
+      
+    end # class Goodbye
+
+  end # class Say
+    
+  #
+  # Returns the requester object
+  #
+  # SYNOPSIS
+  #   #{MiniClient.command_name} requester
+  #
+  class Requester < Quickl::Command(__FILE__, __LINE__)
+
+    def execute(*args)
+      requester
+    end
+    
+  end # class Requester
+
+  def self.Factor(file, line, arg)
+    Quickl::Command(file, line) do |builder|
+      builder.command_parent = MiniClient::Requester
+      builder.callback{|cmd| 
+        cmd.instance_eval{ @factored_arg = arg }
+      }
+    end
+  end
+      
+  #
+  # Returns an argument passed at factoring time
+  #
+  # SYNOPSIS
+  #   #{MiniClient.command_name} factored
+  #
+  class Factored < Factor(__FILE__, __LINE__, :hello)
+    
+    def execute(*args)
+      self.class.instance_eval{ @factored_arg }
+    end
+    
+  end
+  
+end # module MiniClient

data/spec/naming/command2module_spec.rb

@@ -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/spec/naming/module2command_spec.rb

@@ -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/spec/quickl_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path('../spec_helper', __FILE__)
+describe Quickl do
+  
+  it "should have a version number" do
+    Quickl.const_defined?(:VERSION).should be_true
+  end
+  
+end

data/spec/ruby_tools/class_unqualified_name_spec.rb

@@ -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/spec/ruby_tools/extract_file_rdoc_spec.rb

@@ -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/spec/ruby_tools/fixtures/RubyTools.rdoc

@@ -0,0 +1,12 @@
+
+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
+

data/spec/ruby_tools/fixtures/Utils.rdoc

@@ -0,0 +1,3 @@
+
+This is the documentation of the Utils module
+

data/spec/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

data/spec/ruby_tools/optional_args_block_call_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../fixtures', __FILE__)
+module Quickl
+  describe "RubyTools#optional_args_block_call /" do
+  
+    subject{ RubyTools::optional_args_block_call(block, args) }
+  
+    describe "when block has no arguments /" do
+      let(:block){ lambda {
+        "ok"
+      } }
+
+      describe "when no args are given" do
+        let(:args){ [ ] } 
+        it { should == "ok" }
+      end
+
+      describe "when no args are given" do
+        let(:args){ [ "hello" ] } 
+        it { should == "ok" }
+      end
+
+    end
+  
+    describe "when block has one arguments /" do
+      let(:block){ lambda {|name|
+        name
+      } }
+
+      describe "when args are given" do
+        let(:args){ [ "hello" ] } 
+        it { should == "hello" }
+      end
+
+    end
+  
+  end
+end

data/spec/ruby_tools/parent_module_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../spec', __FILE__)
+require 'quickl'
+require 'mini_client'

data/tasks/debug_mail.rake

@@ -0,0 +1,78 @@
+# Installs a rake task for debuging the announcement mail.
+#
+# This file installs the 'rake debug_mail' that flushes an announcement mail
+# for your library on the standard output. It is automatically generated 
+# by Noe from your .noespec file, and should therefore be configured there, 
+# under the variables/rake_tasks/debug_mail entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     debug_mail:
+#       rx_changelog_sections: /^#/
+#       nb_changelog_sections: 1
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file, 
+# don't forget to set safe-override to false in your noe specification:
+# 
+# template-info:
+#   manifest:
+#     tasks/debug_mail.rake:
+#       safe-override: false
+#
+# The mail template used can be found in debug_mail.txt. That file may be
+# changed to tune the mail you want to send. If you do so, don't forget to
+# add a manifest entry in your .noespec file to avoid overriding you 
+# changes. The mail template uses wlang, with parentheses for block 
+# delimiters.
+#
+# template-info:
+#   manifest:
+#     tasks/debug_mail.txt:
+#       safe-override: false
+#
+begin
+  require 'wlang'
+  require 'yaml'
+  
+  desc "Debug the release announcement mail"
+  task :debug_mail do 
+    # Check that a .noespec file exists
+    noespec_file = File.expand_path('../../quickl.noespec', __FILE__)
+    unless File.exists?(noespec_file)
+      raise "Unable to find .noespec project file, sorry."
+    end
+    
+    # Load it as well as variables and options
+    noespec = YAML::load(File.read(noespec_file))
+    vars = noespec['variables'] || {}
+
+    # Changes are taken from CHANGELOG 
+    logs = Dir[File.expand_path("../../CHANGELOG.*", __FILE__)]
+    unless logs.size == 1
+      abort "Unable to find a changelog file"
+    end
+
+    # Load interesting changesets
+    changes, end_found = [], 0
+    File.readlines(logs.first).select{|line|
+      if line =~ /^#/
+        break if end_found >= 1
+        end_found += 1
+      end
+      changes << line
+    }
+    vars['changes'] = changes.join
+    
+    # WLang template
+    template = File.expand_path('../debug_mail.txt', __FILE__)
+    
+    # Let's go!
+    $stdout << WLang::file_instantiate(template, vars, "wlang/active-text")
+  end
+
+rescue LoadError 
+  task :debug_mail do
+    abort "wlang is not available. Try 'gem install wlang'"
+  end
+end

data/tasks/debug_mail.txt

@@ -0,0 +1,13 @@
+Subject: [ANN] !{lower} !{version} Released
+
+!{lower} version !{version} has been released!
+
+!{summary}
+
+*{links as l}{* <!{l}>}{!{"\n"}}
+
+!{description}
+
+Changes:
+
+!{changes}

data/tasks/gem.rake

@@ -0,0 +1,68 @@
+# Installs rake tasks for gemming and packaging
+#
+# This file installs the 'rake package', 'rake gem' tasks and associates 
+# (clobber_package, repackage, ...). It is automatically generated by Noe 
+# from your .noespec file, and should therefore be configured there, under 
+# the variables/rake_tasks/gem entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     gem:
+#       package_dir: pkg
+#       need_tar: false
+#       need_tar_gz: false
+#       need_tar_bz2: false
+#       need_zip: false
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file, 
+# don't forget to set safe-override to false in your noe specification:
+# 
+# template-info:
+#   manifest:
+#     tasks/gem.rake:
+#       safe-override: false
+#
+begin
+  require 'rubygems/package_task'
+  Gem::PackageTask.new($gemspec) do |t|
+
+    # Name of the package
+    t.name = $gemspec.name
+
+    # Version of the package
+    t.version = $gemspec.version
+    
+    # Directory used to store the package files
+    t.package_dir = "pkg"
+    
+    # True if a gzipped tar file (tgz) should be produced
+    t.need_tar = false
+    
+    # True if a gzipped tar file (tar.gz) should be produced
+    t.need_tar_gz = false
+    
+    # True if a bzip2'd tar file (tar.bz2) should be produced
+    t.need_tar_bz2 = false
+    
+    # True if a zip file should be produced (default is false)
+    t.need_zip = false
+    
+    # List of files to be included in the package.
+    t.package_files = $gemspec.files
+    
+    # Tar command for gzipped or bzip2ed archives.
+    t.tar_command = "tar"
+    
+    # Zip command for zipped archives.
+    t.zip_command = "zip"
+
+  end
+rescue LoadError
+  task :gem do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+  task :package do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+end