rake_tasks 0.0.3 → 0.0.4

data/README

@@ -1,8 +1,9 @@
 == Welcome to RakeTasks
 
-RakeTasks provides basic rake tasks, such as rdoc generation,
-building and installing gems, and running tests. It will also load additional
-rake tasks if they are found. mmmm yummy
+RakeTasks provides basic rake tasks for generating documentation,
+building and installing gems, and running tests.
+It will also load additional rake tasks if they are in a folder named 'tasks'.
+mmmm yummy
 
 The following assumptions are currently made:
 
@@ -28,11 +29,11 @@ The default task will be set in the following order:
 
     gem install rake_tasks
 
-2. Require the gem in your gemfile:
+2. Require the gem in your Gemfile:
 
-    gem 'rake_tasks', '~> 0.0.1'
+    gem 'rake_tasks', '~> 0.0.4'
 
-3. Require the gem wherever you want/need these nifty rake tasks:
+3. Require the gem wherever you need to use it:
 
     require 'rake_tasks'
 

data/lib/rake_tasks/doc.rb

@@ -0,0 +1,78 @@
+gem_spec_file = "#{File.basename(Dir.getwd)}.gemspec"
+
+if File.file?(gem_spec_file)
+  ############################################################################
+  namespace :doc do
+  ############################################################################
+
+    gem_spec = Gem::Specification.load(gem_spec_file)
+
+    readme = 'README_GENERATED'
+
+    file readme => gem_spec_file do |t|
+      gem_title = camelize(gem_spec.name)
+      header = '=='
+
+      content =<<-EOD
+#{header} Welcome to #{gem_title}
+
+#{gem_spec.description}
+
+#{header} Getting Started
+
+1. Install #{gem_title} at the command prompt if you haven't yet:
+
+    gem install #{gem_spec.name}
+
+2. Require the gem in your Gemfile:
+
+    gem '#{gem_spec.name}', '~> #{gem_spec.version}'
+
+3. Require the gem wherever you need to use it:
+
+    require '#{gem_spec.name}'
+
+#{header} Usage
+
+TODO
+
+#{header} Additional Notes
+
+TODO
+
+#{header} Additional Documentation
+
+ rake rdoc:app
+
+#{header} License
+
+#{gem_title} is released under the #{gem_spec.license} license.
+EOD
+
+      File.open(readme, 'w') do |file|
+        file.puts content
+      end
+    end
+
+    desc "Generate a #{readme} file."
+    task :readme => readme
+
+    desc "Removes files associated with generating documentation."
+    task :clobber do |t|
+      rm_f readme
+    end
+
+    def camelize(word)
+      result = ''
+      word.split('_').each do |section|
+        result += section.capitalize
+      end
+      return result
+    end
+
+  ############################################################################
+  end # :doc
+  ############################################################################
+
+  task :clobber => 'doc:clobber'
+end

data/lib/rake_tasks.rb

@@ -6,6 +6,7 @@ require 'tempfile'
 
 gem_name = File.basename(__FILE__, '.rb')
 
+require_relative File.join(gem_name, 'doc')
 require_relative File.join(gem_name, 'rdoc')
 require_relative File.join(gem_name, 'gem')
 require_relative File.join(gem_name, 'test')

data/rake_tasks.gemspec

@@ -1,18 +1,20 @@
 Gem::Specification.new do |s|
   s.name = 'rake_tasks'
-  s.version = '0.0.3'
+  s.version = '0.0.4'
 
-  s.summary = 'Basic rake tasks.'
-  s.description = 'RakeTasks contains basic rake tasks ' +
-    'for generating documentation, building gems, and running tests. ' +
-    'It will also find additional rake files if they are included in a ' +
-    'folder named tasks.'
+  s.summary = 'Basic rake tasks. You know you want some.'
+  s.description =%Q{
+RakeTasks provides basic rake tasks for generating documentation,
+building and installing gems, and running tests.
+It will also load additional rake tasks if they are in a folder named 'tasks'.
+mmmm yummy
+}.strip
 
   s.author   = 'Travis Herrick'
   s.email    = 'tthetoad@gmail.com'
   s.homepage = 'http://www.bitbucket.org/ToadJamb/gems_rake_tasks'
 
-  s.license = 'GPLV3'
+  s.license = 'GPLv3'
 
   s.extra_rdoc_files << 'README'
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Travis Herrick
@@ -32,7 +32,11 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: *id001
-description: RakeTasks contains basic rake tasks for generating documentation, building gems, and running tests. It will also find additional rake files if they are included in a folder named tasks.
+description: |-
+  RakeTasks provides basic rake tasks for generating documentation,
+  building and installing gems, and running tests.
+  It will also load additional rake tasks if they are in a folder named 'tasks'.
+  mmmm yummy
 email: tthetoad@gmail.com
 executables: []
 
@@ -43,17 +47,18 @@ extra_rdoc_files:
 files: 
 - lib/rake_tasks/rdoc.rb
 - lib/rake_tasks/gem.rb
+- lib/rake_tasks/doc.rb
 - lib/rake_tasks/test.rb
 - lib/rake_tasks.rb
 - Gemfile.lock
 - Gemfile
-- rakefile
 - README
+- rakefile
 - rake_tasks.gemspec
 has_rdoc: true
 homepage: http://www.bitbucket.org/ToadJamb/gems_rake_tasks
 licenses: 
-- GPLV3
+- GPLv3
 post_install_message: 
 rdoc_options: []
 
@@ -64,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1773998669685223722
+      hash: -859823795052376856
       segments: 
       - 0
       version: "0"
@@ -82,6 +87,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Basic rake tasks.
+summary: Basic rake tasks. You know you want some.
 test_files: []