anttrap 0.02 → 0.03

data/README

@@ -1,3 +1,5 @@
 A tiny Gem that can generate an Apache Ant build file from a Rakefile. This allows for a developer to work in Rake, but integrate with any tool that supports Ant. The generated build file simply calls exec on the selected Rake task. 
 
+If you find this Gem useful, please send feedback to diparfitt at gmail dot com.
+
 see README.md

data/README.md

@@ -19,6 +19,7 @@ Sample rakefile
 	AntTrap.antproject="RakeFile #{Time.new}"
 	AntTrap.rake = '/usr/bin/rake'
 	AntTrap.rakeargs = ["-v"]
+	AntTrap.antfile="build.xml"
 	
 	desc "The Bar task"
 	task :Bar do
@@ -95,7 +96,11 @@ bug report, please include a [Gist](http://gist.github.com/) that includes a sta
 details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
 operating system. 
 
+Feedback
+---
+If you find this Gem useful, please send feedback to diparfitt at gmail dot com.
+
 Copyright
 ---
 Copyright (c) 2011 Dave Parfitt
-See the LICENSE file for more details.
+

data/anttrap.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.requirements = "Rake, Ant"
   s.author = "Dave Parfitt"
   s.email = "diparfitt@gmail.com"
-  s.version = "0.02"
+  s.version = "0.03"
   s.homepage = "http://github.org/metadave/anttrap"
   s.platform = Gem::Platform::RUBY
   s.required_ruby_version = ">=1.8"

data/lib/anttrap.rb

@@ -21,38 +21,58 @@
 
 require 'builder'
 
+
+# A tiny Gem that can generate an Apache Ant build file from a Rakefile. 
+# This allows a developer to use Rake as a build tool for Java based 
+# projects, but integrate with any tool that supports Ant. The 
+# generated build file simply executes the selected Rake task. 
+#
+# Requiring the AntTrap module in your rakefile automatically adds 
+# the AntTrap rake task.
 module AntTrap
   # these are just the defaults
   @@rake = "rake"
   @@antfile = "build.xml"
   @@antproject = "Rake Project"
   @@rakeargs = []
-  
+
+  # Get the full path (including executable name) to rake
   def self.rake
     @@rake
   end
+
+  # Set the full path (including executable name) to rake
   def self.rake=(v)
     @@rake = v
   end
-
+  
+  # Get the name of the generated Ant file
   def self.antfile
     @@antfile
   end
+
+  # Set the name of the generated Ant file
   def self.antfile=(v)
     @@antfile = v
   end
 
+  # Get the name of the Ant project.
   def self.antproject
     @@antproject
   end
+
+  # Set the name of the Ant project.
   def self.antproject=(v)
     @@antproject=v
   end
-  
+ 
+  # Get extra command line args to pass to the rake executable 
   def self.rakeargs
     @@rakeargs
   end
 
+  # Set extra command line args to pass to the rake executable.
+  # This property expects a list
   def self.rakeargs=(v)
     @@rakeargs = v
   end

data/samples/rakefile

@@ -10,6 +10,9 @@ require 'anttrap'
 # adding a timestamp may be helpful to you
 AntTrap.antproject="RakeFile #{Time.new}"
 
+# Generate a file named build.xml
+AntTrap.antfile="build.xml"
+
 # path to the rake binary
 # the default is rake, but you can use what you like here
 AntTrap.rake = '/usr/bin/rake'

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: anttrap
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
-  - 2
-  version: "0.02"
+  - 3
+  version: "0.03"
 platform: ruby
 authors: 
 - Dave Parfitt
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-10 00:00:00 -04:00
+date: 2011-08-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,8 @@ dependencies:
 description: |
   A tiny Gem that can generate an Apache Ant build file from a Rakefile. This allows for a developer to work in Rake, but integrate with any tool that supports Ant. The generated build file simply calls exec on the selected Rake task. 
   
+  If you find this Gem useful, please send feedback to diparfitt at gmail dot com.
+  
   see README.md
 
 email: diparfitt@gmail.com