choosy 0.3.4 → 0.3.5

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.3.5 (March 26, 2011)
+
+Features:
+
+  - Added additional rake tasks to make creating a release somewhat easier, including integration with git and gem. This makes my life easier in all my dependent projects.
+  - Skipped a couple of version numbers working out the rake integration :).
+
+Fixes:
+
+  - Added or fixed the general documentation for printing functionality.
+
+## 0.3.1 (March 25, 2011)
+
+Features:
+
+  - Refactored the version class to be easier to integrate with rake and dependent projects, if they want.
+  - Added some minor integration with rake for versioning assets.
+
 ## 0.3.0 (March 24, 2011)
 
 Features:

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    choosy ()
+    choosy (0.3.5)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.4.2)
+    ZenTest (4.5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
     autotest-notification (2.3.1)
@@ -25,6 +25,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  ZenTest (>= 4.5.0)
   autotest
   autotest-notification
   choosy!

data/README.markdown

@@ -1,4 +1,4 @@
-# Choosy: Picking your arguments carefully
+# Choosy: Picking your Arguments Carefully
 
 This is a small DSL library for creating command line clients in Ruby. It is largely inspired by the <a href="https://github.com/defunkt/choice">choice</a>, <a href="https://github.com/visionmedia/commander">commander</a>, and <a href="http://furius.ca/optcomplete/">optcomplete.py</a> libraries, though it makes some different design decisions than they do.  It is opinionated software.
 
@@ -8,7 +8,7 @@ This library should:
   - Make creating supercommands like git, subversion, and gem easier.
   - Allow you to add validation logic for your arguments within the parsing phase.
   - Allowing for dependencies between options, so that you can more easily validate related options (i.e. if the<code>--bold</code> flag requires the <code>--font Arial</code> flag, then you should be able to ask for the <code>--font</code> option to be validated first, and then the <code>--bold</code> option.
-  - Allow you to customize its output using your own formatting system.
+  - Allow you to customize its output using your own formatting system, or provide several convenient defaults when you don't want to provide your own.
 
 This library should never:
 
@@ -406,12 +406,12 @@ Choosy allows you to customize the output printing of your documentation. It exp
 The <code>:standard</code> printer that is the default for any command can also be customized to meet some of your needs:
 
     Choosy::Command.new :foo do
-      printer :standard, 
-              :max_width => 80,
-              :color => true, 
-              :header_styles => [:bold, :green], 
-              :indent => '   ', 
-              :offset => '  '
+      printer :standard,              # The default printer 
+              :max_width => 80,       # Defaults to the column witdh of the terminal
+              :color => true,         # Default is true 
+              :header_styles => [:bold, :green],  # Defaults to [:bold, :blue]
+              :indent => '   ',       # Defaults to this width 
+              :offset => '  '         # Defaults to this width
 
       help "Show this help command."
     end
@@ -428,7 +428,7 @@ For those who want the nice, manpage experience, there's also the <code>:manpage
               :option_sytles => [:bold],         # Same as :standard
               :indent => '   ',                  # Same as :standard
               :offset => '  ',                   # Same as :standard
-              :version => FOO_VERSION, # Will use the version name you specify
+              :version => FOO_VERSION, # Will use the version name you specify, see below.
               :section => 1,           # Default is always '1'
               :date => '03/24/2011',   # Date you want displayed
               :manual => 'Foo Co.'     # The manual page group
@@ -436,14 +436,28 @@ For those who want the nice, manpage experience, there's also the <code>:manpage
       version FOO_VERSION # If you don't supply a version above, this will be used
     end
 
-Because the library is super-awesome, the manpage will even be in color when piped to less (!). If you don't like the format of my manpage, feel free to implement your own using the <code>choosy/printing/manpage</code> class, a useful utility class for formatting manpage output correctly.
+Because the library is super-awesome, the manpage will even be in color when piped to <code>less -R<code> (the default)! If you don't like the format of my manpage, feel free to implement your own using the <code>choosy/printing/manpage</code> class, a useful utility class for formatting manpage output correctly.
 
-There is also the <code>:erb</code> template that can be customized by writing a template of your choice:
+If you already have some templates that you'd like to use, there is also the <code>:erb</code> template that can be customized by writing a template of your choice:
 
-    Choosy::Command.new :foo od
-      printer :erb, :color => true, :template => 'path/to/file.erb'
+    Choosy::Command.new :foo do
+      printer :erb, 
+              :color => true,                 # Defaults to true
+              :template => 'path/to/file.erb' # Required
     end
 
 The ERB printer also accepts the <code>:color</code> option. The color is exposed via a <code>color</code> property in the template; the command is exposed by the <code>command</code> property.
 
-By the way, if you implement a custom printer, you can also include the <code>choosy/printing/terminal</code> module to get access to the line and column information of the console, if available.
+Finally, because I don't want to tell you how to print your help, I also give you the option of supplying your own printer. Just create a class with a <code>print!(command)</code> method on that class, and it will be passed in the command that it should print the help for. I have supplied some code you may find useful in <code>choosy/printing/terminal</code> that will help with things like finding commands and determining the column width of the terminal.
+
+    class CustomPrinter
+      def print!(command)
+        puts "I got called on help for #{command.name}"
+      end
+    end
+
+    Choosy::Command.new :foo do
+      printer CustomPrinter.new
+    end
+
+

data/lib/VERSION.yml

@@ -1,6 +1,6 @@
 --- 
+date: 26/03/2011
 version: 
+  tiny: 5
   major: 0
   minor: 3
-  tiny: 4
-date: 25/03/2011

data/lib/choosy/rake.rb

@@ -72,7 +72,7 @@ end
 #########################################################################
 # Release
 desc "Tags the current release in git, builds the gemspec, and pushes the gem"
-task :release => ['git:diff', 'gem:push', 'git:tag', 'git:push']
+task :release => ['gem:clean', 'git:diff', 'gem:push', 'git:tag', 'git:push']
 
 #########################################################################
 # Git
@@ -102,7 +102,7 @@ task :gem => ['gem:build']
 
 namespace :gem do
   desc "Builds the current gemspec."
-  task :build do
+  task :build => ['version:load'] do
     SH.files('gemspec') do |gemspec|
       puts "  Building gemspec: #{gemspec}"
       SH.attempt "gem build #{gemspec}"
@@ -111,7 +111,7 @@ namespace :gem do
   
   desc "Pushes the current gem."
   task :push => :build do
-    SH.files ("#{$version}.gem") do |gem|
+    SH.files("#{$version}.gem") do |gem|
       puts "  Pushing gems: #{gem}"
       SH.attempt "gem push #{gem}"
     end
@@ -119,7 +119,7 @@ namespace :gem do
 
   desc "Installs the current gem."
   task :install => :build do
-    SH.files ("#{$version}.gem") do |gem|
+    SH.files("#{$version}.gem") do |gem|
       puts "  Installing gem: #{gem}"
       SH.attempt "gem install --no-ri --no-rdoc #{gem}"
     end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: choosy
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Gabe McArthur
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-25 00:00:00 -07:00
+date: 2011-03-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 5
@@ -39,6 +41,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -52,11 +55,28 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 4
+        - 5
+        - 0
+        version: 4.5.0
+  type: :development
+  version_requirements: *id004
 description: This is a DSL for creating more complicated command line tools.
 email: 
 - madeonamac@gmail.com
@@ -68,71 +88,71 @@ extra_rdoc_files: []
 
 files: 
 - TODO.md
+- LICENSE
+- Rakefile
 - Gemfile
 - README.markdown
-- Gemfile.lock
 - CHANGELOG.md
-- LICENSE
-- Rakefile
-- lib/choosy.rb
-- lib/VERSION.yml
-- lib/choosy/errors.rb
+- Gemfile.lock
+- lib/choosy/super_parser.rb
+- lib/choosy/option.rb
+- lib/choosy/version.rb
 - lib/choosy/printing.rb
-- lib/choosy/rake.rb
+- lib/choosy/command.rb
 - lib/choosy/converter.rb
 - lib/choosy/parse_result.rb
-- lib/choosy/verifier.rb
+- lib/choosy/parser.rb
 - lib/choosy/argument.rb
-- lib/choosy/version.rb
-- lib/choosy/option.rb
-- lib/choosy/command.rb
 - lib/choosy/super_command.rb
-- lib/choosy/dsl/argument_builder.rb
+- lib/choosy/dsl/base_command_builder.rb
 - lib/choosy/dsl/super_command_builder.rb
-- lib/choosy/dsl/base_builder.rb
 - lib/choosy/dsl/command_builder.rb
+- lib/choosy/dsl/base_builder.rb
 - lib/choosy/dsl/option_builder.rb
-- lib/choosy/dsl/base_command_builder.rb
-- lib/choosy/parser.rb
+- lib/choosy/dsl/argument_builder.rb
 - lib/choosy/base_command.rb
+- lib/choosy/errors.rb
+- lib/choosy/printing/terminal.rb
+- lib/choosy/printing/manpage.rb
 - lib/choosy/printing/manpage_printer.rb
-- lib/choosy/printing/base_printer.rb
+- lib/choosy/printing/help_printer.rb
 - lib/choosy/printing/formatting_element.rb
-- lib/choosy/printing/manpage.rb
-- lib/choosy/printing/terminal.rb
-- lib/choosy/printing/color.rb
 - lib/choosy/printing/erb_printer.rb
-- lib/choosy/printing/help_printer.rb
-- lib/choosy/super_parser.rb
-- spec/integration/command-A_spec.rb
-- spec/integration/supercommand-C_spec.rb
-- spec/integration/command-B_spec.rb
-- spec/integration/supercommand-B_spec.rb
-- spec/integration/supercommand-A_spec.rb
-- spec/integration/command-C_spec.rb
-- spec/choosy/converter_spec.rb
-- spec/choosy/option_spec.rb
+- lib/choosy/printing/color.rb
+- lib/choosy/printing/base_printer.rb
+- lib/choosy/rake.rb
+- lib/choosy/verifier.rb
+- lib/choosy.rb
+- lib/VERSION.yml
 - spec/choosy/version_spec.rb
-- spec/choosy/argument_spec.rb
-- spec/choosy/base_command_spec.rb
+- spec/choosy/super_parser_spec.rb
+- spec/choosy/super_command_spec.rb
 - spec/choosy/version.yml
 - spec/choosy/command_spec.rb
+- spec/choosy/converter_spec.rb
+- spec/choosy/dsl/argument_builder_spec.rb
+- spec/choosy/dsl/commmand_builder_spec.rb
 - spec/choosy/dsl/super_command_builder_spec.rb
 - spec/choosy/dsl/option_builder_spec.rb
 - spec/choosy/dsl/base_builder_spec.rb
-- spec/choosy/dsl/argument_builder_spec.rb
-- spec/choosy/dsl/commmand_builder_spec.rb
 - spec/choosy/dsl/base_command_builder_spec.rb
-- spec/choosy/super_command_spec.rb
-- spec/choosy/super_parser_spec.rb
+- spec/choosy/option_spec.rb
 - spec/choosy/verifier_spec.rb
-- spec/choosy/printing/help_printer_spec.rb
-- spec/choosy/printing/terminal_spec.rb
+- spec/choosy/printing/manpage_spec.rb
 - spec/choosy/printing/base_printer_spec.rb
+- spec/choosy/printing/terminal_spec.rb
 - spec/choosy/printing/manpage_printer_spec.rb
+- spec/choosy/printing/help_printer_spec.rb
 - spec/choosy/printing/color_spec.rb
-- spec/choosy/printing/manpage_spec.rb
+- spec/choosy/argument_spec.rb
+- spec/choosy/base_command_spec.rb
 - spec/choosy/parser_spec.rb
+- spec/integration/supercommand-A_spec.rb
+- spec/integration/command-A_spec.rb
+- spec/integration/supercommand-C_spec.rb
+- spec/integration/command-B_spec.rb
+- spec/integration/command-C_spec.rb
+- spec/integration/supercommand-B_spec.rb
 - spec/spec_helpers.rb
 has_rdoc: true
 homepage: http://github.com/gabemc/choosy
@@ -148,6 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -156,6 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3
@@ -164,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Yet another option parsing library.