quickl 0.2.1 → 0.2.2

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.2.2 / 2011.07.12
+
+* Enhancements
+
+  * Added a template/delegator.erb template (quickl --layout=delegator ...)
+  * Added --[no-]header and --[no-]footer options to the template generator
+
+* Bug fixes
+
+  * The gem is now shipped with the template/single.erb file. This fixes the 
+    'quickl' commandline that generates skeletons as illustrated in README 
+    (patch and thanks to Rit Li)
+  * Broken links to the examples from the README are fixed (Travis Briggs)
+  * Other typos fixed that led to failures on --help in examples (Tomasz Łoszko)
+
 # 0.2.1 / 2011.06.19
 
 * Enhancements

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    quickl (0.2.1)
+    quickl (0.2.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    bluecloth (2.0.9)
+    bluecloth (2.0.11)
     diff-lcs (1.1.2)
-    rake (0.8.7)
+    rake (0.9.2)
     rspec (2.4.0)
       rspec-core (~> 2.4.0)
       rspec-expectations (~> 2.4.0)
@@ -17,8 +17,8 @@ GEM
     rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.4.0)
-    wlang (0.10.1)
-    yard (0.6.4)
+    wlang (0.10.2)
+    yard (0.6.8)
 
 PLATFORMS
   java
@@ -28,7 +28,7 @@ DEPENDENCIES
   bluecloth (~> 2.0.9)
   bundler (~> 1.0)
   quickl!
-  rake (~> 0.8.7)
+  rake (~> 0.9.2)
   rspec (~> 2.4.0)
   wlang (~> 0.10.1)
   yard (~> 0.6.4)

data/Manifest.txt

@@ -6,10 +6,11 @@ Gemfile
 Gemfile.lock
 bin/**/*
 lib/**/*
+templates/single.erb
 LICENCE.md
 Manifest.txt
 Rakefile
 README.md
 spec/**/*
 tasks/**/*
-test/**/*
+test/**/*

data/README.md

@@ -1,6 +1,7 @@
 # Quickl
 
 * http://github.com/blambeau/quickl
+* http://rubydoc.info/github/blambeau/quickl/master/frames
 
 ## Description
 
@@ -13,7 +14,7 @@ Quickl helps you create commandline programs as simply as:
     #   Usage: ...
     #
     # OPTIONS:
-    # #{sumarized_options}
+    # #{summarized_options}
     #
     # DESCRIPTION
     #   Long description here...
@@ -36,7 +37,8 @@ Running them as simply as:
 
     SimpleCommand.run(ARGV)
     
-From simple command to complex delegator (_ala_ 'git [--version] [--help] COMMAND [cmd options] ARGS...'), Quickl provides (or aims at providing) the following features:
+From simple command to complex delegator (_ala_ 'git [--version] [--help] COMMAND [cmd options] ARGS...'), 
+Quickl provides (or aims at providing) the following features:
 
 * Simple command creations via simple classes
 * Delegator commands and categories via ruby namespaces and naming conventions
@@ -69,12 +71,31 @@ Try this:
   
 Additional examples (see examples folder):
 
-* [hello world example](https://github.com/blambeau/quickl/blob/master/examples/hello_world)
+* [hello world example](https://github.com/blambeau/quickl/blob/master/examples/hello)
 * [delegator example](https://github.com/blambeau/quickl/blob/master/examples/delegator)
 
+## Related work
+
+A few other gems similarly provide tools to generate commandline app. 
+
+* https://github.com/wycats/thor provides a way to bundle command line utilities
+  as class methods. It also provides an alternative to Rake and therefore sees 
+  commands as tasks. It is more mature that quickl but is also a bit more 
+  opinionated IMHO. If you want one command by class, use quickl; one command by
+  method, go for thor instead.
+* https://github.com/mdub/clamp is very similar to quickl as well, even more 
+  similar than thor in fact. Clamp supports subcommands and options (not through
+  OptionParser, though). It does not have the quickl's auto-documentation 
+  feature, but has an automatic --help. I would say that Clamp is maybe a bit 
+  lighter and 'straight to the point' than quickl, but also more magic and 
+  opinionated.
+* See also: http://trollop.rubyforge.org/, http://clip.rubyforge.org/
+
 ## Version policy
 
-Until version 1.0.0, moditications of public interfaces increase the minor version, while other changes increase the tiny version. After version 1.0.0, same changes will affect major and minor versions, respectively.
+Until version 1.0.0, moditications of public interfaces increase the minor version, 
+while other changes increase the tiny version. After version 1.0.0, same changes will 
+affect major and minor versions, respectively.
 
     0.1.0 -> 0.1.1    # enhancements and private API changes
     0.1.0 -> 0.2.0    # broken API on public interfaces
@@ -87,7 +108,8 @@ Public interfaces are:
 * Naming conventions (module <-> command conversions)
 * Default reactions to errors (Quickl::Help, Quickl::Exit, ...)
 
-Until version 1.0.0, to preserve your application from hurting changes you should require quickl as follows:
+Until version 1.0.0, to preserve your application from hurting changes you should 
+require quickl as follows:
 
-    gem 'quickl', '< 0.2.0'    # Assuming current version is 0.1.xx
+    gem 'quickl', '~> 0.2.0'    # Assuming current version is 0.2.xx
     require 'quickl'

data/bin/quickl

@@ -34,6 +34,12 @@ class Quickl::Main < Quickl::Command(__FILE__, __LINE__)
   # Name of the command to generate
   attr_reader :cmd_name
   
+  # Generate require header
+  attr_reader :header
+  
+  # Generate require footer
+  attr_reader :footer
+  
   # Creates a command instance
   def initialize
     @layout = :single
@@ -43,8 +49,8 @@ class Quickl::Main < Quickl::Command(__FILE__, __LINE__)
   # Install options
   options do |opt|
     
-    opt.on("--layout=LAYOUT", [:single], 
-           "Select specific command layout (single)") do |l|
+    opt.on("--layout=LAYOUT", [:single, :delegator], 
+           "Select specific command layout (single,delegator)") do |l|
       @layout = l
     end
     
@@ -55,6 +61,18 @@ class Quickl::Main < Quickl::Command(__FILE__, __LINE__)
         raise Quickl::InvalidOption, "Unknown option helpers: #{unknown.join(',')}"
       end
     end
+
+    @header = true
+    opt.on('--[no-]header',
+           "Generate header (require rubygems + quickl)"){|value|
+      @header = value
+    }
+    
+    @footer = true
+    opt.on('--[no-]footer',
+           "Generate footer (command execution)"){|value|
+      @footer = value
+    }
     
     # Show the help and exit
     opt.on_tail("--help", "Show help") do

data/lib/quickl/naming.rb

@@ -35,15 +35,11 @@ module Quickl
     def module2command(mod)
       case mod
         when Module
-          name = RubyTools::class_unqualified_name(mod)
-          name = name.gsub(/[A-Z]/){|x| "-#{x.downcase}"}[1..-1]
+          module2command(RubyTools::class_unqualified_name(mod))
         when String
-          name = mod.to_s
-          name = name.gsub(/[A-Z]/){|x| "-#{x.downcase}"}[1..-1]
+          mod.gsub(/[A-Z]/){|x| "-#{x.downcase}"}[1..-1]
         when Symbol
-          name = mod.to_s
-          name = name.gsub(/[A-Z]/){|x| "-#{x.downcase}"}[1..-1]
-          name.to_sym
+          module2command(mod.to_s).to_sym
         else
           raise ArgumentError, "Invalid module argument #{mod.class}"
       end

data/lib/quickl/version.rb

@@ -3,7 +3,7 @@ module Quickl
   
     MAJOR = 0
     MINOR = 2
-    TINY  = 1
+    TINY  = 2
   
     def self.to_s
       [ MAJOR, MINOR, TINY ].join('.')

data/quickl.gemspec

@@ -123,7 +123,7 @@ Gem::Specification.new do |s|
   # One call to add_development_dependency('gem_name', 'gem version requirement')
   # for each development dependency. These gems are required for developers
   #
-  s.add_development_dependency("rake", "~> 0.8.7")
+  s.add_development_dependency("rake", "~> 0.9.2")
   s.add_development_dependency("bundler", "~> 1.0")
   s.add_development_dependency("rspec", "~> 2.4.0")
   s.add_development_dependency("yard", "~> 0.6.4")

data/quickl.noespec

@@ -18,7 +18,7 @@ variables:
 
   # Version of your library
   version:
-    0.2.1
+    0.2.2
     
   # Project summary (~ 1 line).
   summary: |-
@@ -42,7 +42,7 @@ variables:
   # Gem dependencies. (- {name: ..., version: ..., groups: [...]}, ...)
   dependencies: 
     # Rake is required for developers, as usual
-    - {name: rake,      version: "~> 0.8.7", groups: [development]}
+    - {name: rake,      version: "~> 0.9.2", groups: [development]}
     # Bundler is required for developers and is used by the Rakefile
     - {name: bundler,   version: "~> 1.0",   groups: [development]}
     # RSpec is required to run 'rake spec'. See tasks/spec.rake 

data/tasks/clean.rake

@@ -0,0 +1,3 @@
+task :clean do
+  Dir["**/*.rbc"].each{|f| FileUtils.rm_rf(f)}
+end

data/templates/single.erb

@@ -0,0 +1,42 @@
+<% if header %>
+begin
+  require 'quickl'
+rescue LoadError
+  require 'rubygems'
+  gem 'quickl'
+  retry  
+end
+<% 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 footer %>
+if __FILE__ == $0
+  <%= cmd_class_name %>.run(ARGV)
+end
+<% end %>

metadata

@@ -1,95 +1,132 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: quickl
-version: !ruby/object:Gem::Version
-  version: 0.2.1
+version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
 platform: ruby
-authors:
+authors: 
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-19 00:00:00.000000000 +02:00
-default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &83708950 !ruby/object:Gem::Requirement
+
+date: 2011-07-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.7
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
   type: :development
+  requirement: *id001
   prerelease: false
-  version_requirements: *83708950
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &83708460 !ruby/object:Gem::Requirement
+  name: rake
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :development
+  requirement: *id002
   prerelease: false
-  version_requirements: *83708460
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &83707960 !ruby/object:Gem::Requirement
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
         version: 2.4.0
   type: :development
+  requirement: *id003
   prerelease: false
-  version_requirements: *83707960
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &83707400 !ruby/object:Gem::Requirement
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 6
+        - 4
         version: 0.6.4
   type: :development
+  requirement: *id004
   prerelease: false
-  version_requirements: *83707400
-- !ruby/object:Gem::Dependency
-  name: bluecloth
-  requirement: &83706930 !ruby/object:Gem::Requirement
+  name: yard
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 0
+        - 9
         version: 2.0.9
   type: :development
+  requirement: *id005
   prerelease: false
-  version_requirements: *83706930
-- !ruby/object:Gem::Dependency
-  name: wlang
-  requirement: &83706160 !ruby/object:Gem::Requirement
+  name: bluecloth
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 10
+        - 1
         version: 0.10.1
   type: :development
+  requirement: *id006
   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:
+  name: wlang
+description: |-
+  Quickl helps you creating commandline ruby programs. From simple commands 
+  with options to complex delegators with subcommands, global and local 
+  options.
+email: 
 - blambeau@gmail.com
-executables:
+executables: 
 - quickl
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.md
 - CHANGELOG.md
 - LICENCE.md
-files:
+files: 
 - quickl.gemspec
 - quickl.noespec
 - CHANGELOG.md
@@ -109,6 +146,7 @@ files:
 - lib/quickl/ruby_tools.rb
 - lib/quickl/command.rb
 - lib/quickl/version.rb
+- templates/single.erb
 - LICENCE.md
 - Manifest.txt
 - Rakefile
@@ -137,42 +175,45 @@ files:
 - spec/naming/command2module_spec.rb
 - tasks/debug_mail.rake
 - tasks/yard.rake
+- tasks/clean.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: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 178817935
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 178817935
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Helper to create commandline ruby programs
-test_files:
+test_files: 
 - spec/spec_helper.rb
 - spec/command/usage_spec.rb
 - spec/command/command_name_spec.rb