quickl 0.2.0 → 0.2.1

data/tasks/spec_test.rake

@@ -0,0 +1,79 @@
+# Installs a rake task for for running examples written using rspec.
+#
+# This file installs the 'rake spec_test' (aliased as 'rake spec') as well as
+# extends 'rake test' to run spec tests, if any. It is automatically generated 
+# by Noe from your .noespec file, and should therefore be configured there, 
+# under the variables/rake_tasks/spec_test entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     spec_test:
+#       pattern: spec/**/*_spec.rb
+#       verbose: true
+#       rspec_opts: [--color, --backtrace]
+#       ...
+#
+# 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/spec_test.rake:
+#       safe-override: false
+#
+# This file has been written to conform to RSpec v2.4.0. More information about 
+# rspec and options of the rake task defined below can be found on 
+# http://relishapp.com/rspec
+#
+begin
+  require "rspec/core/rake_task"
+  desc "Run RSpec code examples"
+  RSpec::Core::RakeTask.new(:spec_test) do |t|
+    # Glob pattern to match files.
+    t.pattern = "spec/**/*_spec.rb"
+
+    # By default, if there is a Gemfile, the generated command will include
+    # 'bundle exec'. Set this to true to ignore the presence of a Gemfile, 
+    # and not add 'bundle exec' to the command.
+    t.skip_bundler = false
+
+    # Name of Gemfile to use
+    t.gemfile = "Gemfile"
+
+    # Whether or not to fail Rake when an error occurs (typically when 
+    # examples fail).
+    t.fail_on_error = true
+
+    # A message to print to stderr when there are failures.
+    t.failure_message = nil
+
+    # Use verbose output. If this is set to true, the task will print the
+    # executed spec command to stdout.
+    t.verbose = true
+
+    # Use rcov for code coverage?
+    t.rcov = false
+
+    # Path to rcov.
+    t.rcov_path = "rcov"
+
+    # Command line options to pass to rcov. See 'rcov --help' about this
+    t.rcov_opts = []
+
+    # Command line options to pass to ruby. See 'ruby --help' about this 
+    t.ruby_opts = []
+
+    # Path to rspec
+    t.rspec_path = "rspec"
+
+    # Command line options to pass to rspec. See 'rspec --help' about this
+    t.rspec_opts = ["--color", "--backtrace"]
+  end
+rescue LoadError => ex
+  task :spec_test do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+ensure
+  task :spec => [:spec_test]
+  task :test => [:spec_test]
+end

data/tasks/unit_test.rake

@@ -0,0 +1,77 @@
+# Installs a rake task for for running unit tests.
+#
+# This file installs the 'rake unit_test' and extends 'rake test' to run unit 
+# tests, if any. It is automatically generated by Noe from your .noespec file, 
+# and should therefore be configured there, under the variables/rake_tasks/unit_test 
+# entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     unit_test:
+#       pattern: test/test*.rb
+#       verbose: false
+#       warning: 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/unit_test.rake:
+#       safe-override: false
+#
+# More info about the TestTask and its options can be found on 
+# http://rake.rubyforge.org/classes/Rake/TestTask.html
+#
+begin
+  require 'rake/testtask'
+  desc "Run unit tests"
+  Rake::TestTask.new(:unit_test) do |t|
+
+    # List of directories to added to $LOAD_PATH before running the
+    # tests. (default is 'lib')
+    t.libs = ["lib"]
+
+    # True if verbose test output desired. (default is false)
+    t.verbose = false
+
+    # Test options passed to the test suite.  An explicit TESTOPTS=opts 
+    # on the command line will override this. (default is NONE)
+    t.options = nil
+
+    # Request that the tests be run with the warning flag set.
+    # E.g. warning=true implies "ruby -w" used to run the tests.
+    t.warning = false
+
+    # Glob pattern to match test files. (default is 'test/test*.rb')
+    t.pattern = "examples/**/*_test.rb"
+
+    # Style of test loader to use.  Options are:
+    #
+    # * :rake -- Rake provided test loading script (default).
+    # * :testrb -- Ruby provided test loading script.
+    # * :direct -- Load tests using command line loader.
+    # 
+    t.loader = :rake
+
+    # Array of commandline options to pass to ruby when running test 
+    # loader.
+    t.ruby_opts = []
+
+    # Explicitly define the list of test files to be included in a
+    # test.  +list+ is expected to be an array of file names (a
+    # FileList is acceptable).  If both +pattern+ and +test_files+ are
+    # used, then the list of test files is the union of the two.
+    t.test_files = nil
+
+  end
+rescue LoadError => ex
+  task :unit_test do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+ensure
+  desc "Run all tests"
+  task :test => [:unit_test]
+end
+

data/tasks/yard.rake

@@ -0,0 +1,51 @@
+# Installs a rake task to generate API documentation using yard.
+#
+# This file installs the 'rake yard' task. It is automatically generated by Noe from 
+# your .noespec file, and should therefore be configured there, under the 
+# variables/rake_tasks/yard entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     yard:
+#       files: lib/**/*.rb
+#       options: []
+#       ...
+#
+# 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/yard.rake:
+#       safe-override: false
+#
+# This file has been written to conform to yard v0.6.4. More information about 
+# yard and the rake task installed below can be found on http://yardoc.org/
+#
+begin
+  require "yard"
+  desc "Generate yard documentation"
+  YARD::Rake::YardocTask.new(:yard) do |t|
+    # Array of options passed to yardoc commandline. See 'yardoc --help' about this
+    t.options = ["--output-dir", "doc/api", "-", "README.md", "CHANGELOG.md", "LICENCE.md"]
+    
+    # Array of ruby source files (and any extra documentation files 
+    # separated by '-')
+    t.files = ["lib/**/*.rb"]
+    
+    # A proc to call before running the task
+    # t.before = proc{ }
+    
+    # A proc to call after running the task
+    # r.after = proc{ }
+    
+    # An optional lambda to run against all objects being generated. 
+    # Any object that the lambda returns false for will be excluded 
+    # from documentation. 
+    # t.verifier = lambda{|obj| true}
+  end
+rescue LoadError
+  task :yard do
+    abort 'yard is not available. In order to run yard, you must: gem install yard'
+  end
+end

metadata

@@ -1,152 +1,197 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: quickl
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-10 00:00:00 +01:00
+date: 2011-06-19 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
+  requirement: &83708950 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *83708950
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &83708460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *83708460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &83707960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 4
-        - 0
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *83707960
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &83707400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 4
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 0.6.4
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *83707400
+- !ruby/object:Gem::Dependency
   name: bluecloth
+  requirement: &83706930 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.9
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *83706930
+- !ruby/object:Gem::Dependency
+  name: wlang
+  requirement: &83706160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 4
-        version: 0.6.4
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.1
   type: :development
-  version_requirements: *id004
-description: Generate Ruby command line apps quickly
-email: blambeau@gmail.com
-executables: 
+  prerelease: false
+  version_requirements: *83706160
+description: ! "Quickl helps you creating commandline ruby programs. From simple commands
+  \nwith options to complex delegators with subcommands, global and local \noptions."
+email:
+- blambeau@gmail.com
+executables:
 - quickl
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+- CHANGELOG.md
+- LICENCE.md
+files:
+- quickl.gemspec
+- quickl.noespec
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- bin/quickl
+- lib/quickl.rb
+- lib/quickl/command/single.rb
 - lib/quickl/command/builder.rb
-- lib/quickl/command/delegator.rb
 - lib/quickl/command/options.rb
 - lib/quickl/command/robustness.rb
-- lib/quickl/command/single.rb
-- lib/quickl/command.rb
+- lib/quickl/command/delegator.rb
+- lib/quickl/naming.rb
 - lib/quickl/errors.rb
+- lib/quickl/loader.rb
 - lib/quickl/ext/object.rb
-- lib/quickl/naming.rb
 - lib/quickl/ruby_tools.rb
-- lib/quickl.rb
-- examples/delegator/bin/delegator
-- examples/delegator/lib/delegator.rb
-- examples/delegator/lib/hello_world.rb
-- examples/delegator/lib/help.rb
-- examples/delegator/README.md
-- examples/delegator/test/delegator_test.rb
-- examples/hello/hello
-- examples/hello/hello_test.rb
-- examples/hello/README.md
-- examples/helper.rb
-- templates/single.erb
-- bin/quickl
-- quickl.gemspec
+- lib/quickl/command.rb
+- lib/quickl/version.rb
+- LICENCE.md
+- Manifest.txt
 - Rakefile
 - README.md
-- CHANGELOG.md
+- spec/spec_helper.rb
+- spec/command/usage_spec.rb
+- spec/command/command_name_spec.rb
+- spec/command/subcommands_spec.rb
+- spec/command/requester_spec.rb
+- spec/command/subcommand_by_name_spec.rb
+- spec/command/run_spec.rb
+- spec/command/robustness/valid_read_file_spec.rb
+- spec/command/overview_spec.rb
+- spec/command/documentation_spec.rb
+- spec/command/command_building_spec.rb
+- spec/mini_client.rb
+- spec/ruby_tools/fixtures.rb
+- spec/ruby_tools/class_unqualified_name_spec.rb
+- spec/ruby_tools/extract_file_rdoc_spec.rb
+- spec/ruby_tools/parent_module_spec.rb
+- spec/ruby_tools/optional_args_block_call_spec.rb
+- spec/ruby_tools/fixtures/RubyTools.rdoc
+- spec/ruby_tools/fixtures/Utils.rdoc
+- spec/quickl_spec.rb
+- spec/naming/module2command_spec.rb
+- spec/naming/command2module_spec.rb
+- tasks/debug_mail.rake
+- tasks/yard.rake
+- tasks/gem.rake
+- tasks/spec_test.rake
+- tasks/unit_test.rake
+- tasks/debug_mail.txt
 has_rdoc: true
 homepage: http://github.com/blambeau/quickl
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Quickl
-- --main
-- Quickl
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 178817935
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 178817935
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Generate Ruby command line apps quickly
-test_files: []
-
+summary: Helper to create commandline ruby programs
+test_files:
+- spec/spec_helper.rb
+- spec/command/usage_spec.rb
+- spec/command/command_name_spec.rb
+- spec/command/subcommands_spec.rb
+- spec/command/requester_spec.rb
+- spec/command/subcommand_by_name_spec.rb
+- spec/command/run_spec.rb
+- spec/command/robustness/valid_read_file_spec.rb
+- spec/command/overview_spec.rb
+- spec/command/documentation_spec.rb
+- spec/command/command_building_spec.rb
+- spec/mini_client.rb
+- spec/ruby_tools/fixtures.rb
+- spec/ruby_tools/class_unqualified_name_spec.rb
+- spec/ruby_tools/extract_file_rdoc_spec.rb
+- spec/ruby_tools/parent_module_spec.rb
+- spec/ruby_tools/optional_args_block_call_spec.rb
+- spec/ruby_tools/fixtures/RubyTools.rdoc
+- spec/ruby_tools/fixtures/Utils.rdoc
+- spec/quickl_spec.rb
+- spec/naming/module2command_spec.rb
+- spec/naming/command2module_spec.rb

data/examples/delegator/README.md

@@ -1,86 +0,0 @@
-# Quickl example: delegator
-
-This example shows how to create delegator commands. Delegators are commands
-that delegate the actual execution to sub commands (well known example is
-'git'). A delegator command typically has a signature like:
-
-    delegator [main options] COMMAND [cmd options] ARGS...
-
-## Structure
-
-The structure for delegator commands is as follows:
-
-    #
-    # Main command overview
-    #
-    # SYNOPSIS
-    #   Usage: #{command_name} [main options] COMMAND [cmd options] ARGS...
-    #
-    # OPTIONS
-    # #{sumarized_options}
-    #
-    # COMMANDS
-    # #{summarized_commands}
-    #
-    # DESCRIPTION
-    #   Long description here...
-    #
-    # See '#{command_name} help COMMAND' for more information on a specific command.
-    #
-    class DelegatorCommand < Quickl::Delegator(__FILE__, __LINE__)
-    
-      # install options below
-      options do |opt|
-        # _opt_ is an OptionParser instance
-      end
-      
-      #
-      # Sub command overview
-      # 
-      # ...
-      #
-      class SubCommand1 < Quickl::Command(__FILE__, __LINE__)
-      
-        # [ ... ]
-      
-      end
-      
-      #
-      # Sub command overview
-      # 
-      # ...
-      #
-      class SubCommand2 < Quickl::Command(__FILE__, __LINE__)
-      
-        # [ ... ]
-      
-      end
-      
-    end 
-    
-    # To run the command, typically in a bin/simple_command 
-    # shell file
-    DelegatorCommand.run(ARGV)
-    
-
-## Example
-
-Try the following:
-
-    ./delegator
-    # => [ ... complete help with subcommands summary ... ]
-    
-    ./delegator --help
-    # => [ ... complete help with subcommands summary ... ]
-    
-    ./delegator help 
-    # => [ ... complete help with subcommands summary ... ]
-    
-    ./delegator help hello-world 
-    # => [ ... help of hello-world's subcommand ... ]
-
-    ./delegator hello-world bob
-    # => Hello bob!
-    
-    ./hello_world --capitalize bob
-    # => Hello Bob!

data/examples/delegator/bin/delegator

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-require File.expand_path('../../../helper', __FILE__)
-
-# Load the delegate tool
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require "delegator"
-
-# Run the command
-Delegator.run(ARGV, __FILE__)

data/examples/delegator/lib/delegator.rb

@@ -1,41 +0,0 @@
-#
-# Delegate execution to a sub command
-#
-# SYNOPSIS
-#   #{program_name} [--version] [--help] [--output=...] COMMAND [cmd opts] ARGS...
-#
-# OPTIONS
-# #{summarized_options}
-#
-# COMMANDS
-# #{summarized_subcommands}
-#
-# DESCRIPTION
-#   This example shows how to write a delegator command, that is, a
-#   command which delegates to a subcommand
-#
-# See '#{program_name} help COMMAND' for more information on a specific command.
-#
-class Delegator < Quickl::Delegator(__FILE__, __LINE__)
-
-  # Single command version
-  VERSION = "0.1.0"
-  
-  # Install options
-  options do |opt|
-    
-    # Show the help and exit
-    opt.on_tail("--help", "Show help") do
-      raise Quickl::Help
-    end
-
-    # Show version and exit
-    opt.on_tail("--version", "Show version") do
-      raise Quickl::Exit, "#{program_name} #{VERSION} (c) 2010, Bernard Lambeau"
-    end
-
-  end
-
-end # class Delegator
-require "help"
-require "hello_world"

data/examples/delegator/lib/hello_world.rb

@@ -1,39 +0,0 @@
-class Delegator
-  #
-  # Say hello 
-  #
-  # SYNOPSIS
-  #   #{program_name} #{command_name} [--capitalize] [WHO]
-  #
-  # OPTIONS
-  # #{summarized_options}
-  #
-  # DESCRIPTION
-  #   Without any argument, says hello to the world. When a single argument 
-  #   is given says hello to the user.
-  #
-  class HelloWorld < Quickl::Command(__FILE__, __LINE__)
-  
-    # Install command options
-    options do |opt|
-
-      # Capitalize user name?
-      opt.on("--capitalize", "-c", "Capitalize user name") do 
-        @capitalize = true
-      end
-
-    end
-  
-    # Execute the command on some arguments
-    def execute(args)
-      if args.size <= 1
-        name = args.first || "world"
-        name = name.capitalize if @capitalize
-        puts "Hello #{name}!"
-      else
-        raise Quickl::InvalidArgument, "Useless arguments: #{args.join(' ')}"
-      end
-    end
-  
-  end # class HelloWorld
-end # class Delegator