rake_tasks 2.0.5 → 2.0.6

data/Gemfile

@@ -1,8 +1,3 @@
 source "http://rubygems.org"
 
 gemspec
-
-group :test do
-  gem 'mocha' , '~> 0.10.0'
-  gem 'fakefs', '~> 0.4.0', :require => 'fakefs/safe'
-end

data/README.md

@@ -0,0 +1,106 @@
+Welcome to RakeTasks
+====================
+
+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:
+
+* There is a valid .gemspec file in the root folder that is named the same
+   as the root folder.
+
+* Tests reside in a folder named either 'test' or 'tests'
+   and test files are named *_test.rb or test_*.rb.
+
+   Additionally, if you have sub-folders under test(s)
+   (i.e. test/unit, test/performance), they will be available
+   using rake test:unit and rake test:performance.
+   Sub-folders that do not contain files matching the test file name patterns
+   will not be included in this set.
+
+   You may run a single test from any test file by using the following:
+
+    rake test:test_file[test_method]
+
+   test_file is the name of the test file without the pattern,
+   so if you have a test named my_class_test.rb with a test method
+   named my_test_method, it would be invoked by:
+
+    rake test:my_class[my_test_method]
+
+* Additional rake tasks are named *.rb and reside in a folder named 'tasks'.
+
+* README generation useo the gemspec data to populate the license information.
+
+  If README.md does not exist, one will be created.
+  If README.md does exist, a README_GENERATED.md file will be created,
+  so as not to overwrite a 'real' README.md file.
+
+The default task will be set in the following order:
+
+1. If tests are found, rake will run test:all.
+
+2. If tests are not found, but an appropriately named .gemspec file is,
+   gem:build will be run.
+
+3. If no tests or .gemspec are found, rdoc:app will be run.
+
+Getting Started
+---------------
+
+Install RakeTasks at the command prompt if you haven't yet:
+
+    $ gem install rake_tasks
+
+Require the gem in your Gemfile:
+
+    gem 'rake_tasks', '~> 2.0.6'
+
+Require the gem wherever you need to use it:
+
+    require 'rake_tasks'
+
+Updates
+-------
+
+    2.0.6 Use markdown for generated README.
+          Convert rake_task's README to markdown and rename it to README.md.
+
+          The gemspec is now located by extension rather than root folder.
+
+    2.0.5 Specify load order of rake tasks.
+
+    2.0.4 Added license files to the included files in the gemspec.
+          Excluded Gemfile.lock from included fileo in the gemspec.
+
+    2.0.3 Added bundle_install.sh to the included files in the gemspec.
+
+    2.0.2 test:[test_file] will now run all the tests in the specified file
+          if a method is not specified. It should be noted that 'test_file' is
+          the name of the file with the test pattern removed
+          (i.e. 'my_module_test.rb' => 'my_module',
+          'test_my_module.rb' => 'my_module').
+
+    2.0.1 Added test:full task (requires rvm).
+
+          test:full allows a user to run tests against multiple ruby/gemset/rake
+          configurations by specifying them in a yaml file in the test folder.
+
+          A common rubies.yml file might look something like this:
+
+          - ruby: 1.9.2
+            gemset: my_gem_test
+          - ruby: 1.9.3
+            gemset: my_gem_test
+
+Additional Documentation
+------------------------
+
+    rake rdoc:app
+
+License
+-------
+
+RakeTasks is released under the LGPLv3 license.

data/lib/rake_tasks/doc.rb

@@ -35,8 +35,8 @@ if RakeTasks::Gem.gem_file?
 
     gem_spec_file = RakeTasks::Gem.gem_spec_file
 
-    readme = 'README'
-    readme = 'README_GENERATED' if File.file?(readme)
+    readme = 'README.md'
+    readme = 'README_GENERATED.md' if File.file?(readme)
 
     file readme => gem_spec_file do |t|
       doc_obj = RakeTasks::Doc.new

data/lib/rake_tasks/lib/bundle_install.sh

@@ -14,3 +14,4 @@ rvm use $1@$2
 
 gem install bundler --no-rdoc --no-ri
 bundle install
+bundle clean --force

data/lib/rake_tasks/lib/doc.rb

@@ -48,35 +48,35 @@ module RakeTasks
       gem_spec = @gem_spec
 
       @contents ||= %Q{
-#{header} Welcome to #{gem_title}
+#{header :h1, "Welcome to #{gem_title}"}
 
 #{gem_spec.description}
 
-#{header} Getting Started
+#{header :h2, 'Getting Started'}
 
-1. Install #{gem_title} at the command prompt if you haven't yet:
+Install #{gem_title} at the command prompt if you haven't yet:
 
-  gem install #{gem_spec.name}
+    $ gem install #{gem_spec.name}
 
-2. Require the gem in your Gemfile:
+Require the gem in your Gemfile:
 
-  gem '#{gem_spec.name}', '~> #{gem_spec.version}'
+    gem '#{gem_spec.name}', '~> #{gem_spec.version}'
 
-3. Require the gem wherever you need to use it:
+Require the gem wherever you need to use it:
 
-  require '#{gem_spec.name}'
+    require '#{gem_spec.name}'
 
-#{header} Usage
+#{header :h2, 'Usage'}
 
 TODO
 
-#{header} Additional Notes
+#{header :h2, 'Additional Notes'}
 
 TODO
 
-#{header} Additional Documentation
+#{header :h2, 'Additional Documentation'}
 
-rake rdoc:app
+    $ rake rdoc:app
 #{license_details}}.strip
 
       return @contents
@@ -86,67 +86,25 @@ rake rdoc:app
     private
     ########################################################################
 
-    # Header indicator.
-    def header
-      '=='
+    # Returns formatted headers.
+    def header(type, text = nil)
+      case type
+      when :h1
+        "#{text}\n#{'=' * text.length}"
+      when :h2
+        "#{text}\n#{'-' * text.length}"
+      end
     end
 
     # Compose the license details.
-    # This will include links to the license and image,
-    # if they exist in the license folder.
     def license_details
       return if @gem_spec.licenses.empty?
 
-      # Set up the header (and other info. that will be the same regardless).
-      out = ''
-      out += "\n#{header} License\n\n"
-      out += "#{@gem_title} is released under the "
-
-      # Get image files.
-      images = Dir[
-        File.join(@license_path, '*.png'),
-        File.join(@license_path, '*.jpg'),
-        File.join(@license_path, '*.jpeg'),
-        File.join(@license_path, '*.gif')
-      ]
-
-      # Get license files (by removing images from all files).
-      files = Dir[File.join(@license_path, '*')] - images
-
-      # Find the license file that matches the license.
-      found = nil
-      files.each do |file|
-        next unless File.file?(file)
-        if @gem_spec.license.downcase == File.basename(file).downcase
-          found = file
-          break
-        end
-      end
-
-      # Add the link to the license file.
-      if found
-        out += "{#{@gem_spec.license} license}[link:../../#{found}].\n"
-      else
-        out += "#{@gem_spec.license} license.\n"
-      end
-
-      # Find the image file that matches the license.
-      found = nil
-      images.each do |file|
-        next unless File.file?(file)
-        if @gem_spec.license.downcase ==
-            File.basename(file).sub(/\..+?$/, '').downcase
-          found = file
-          break
-        end
-      end
-
-      # Add the link to the image file.
-      if found
-        out += "\nlink:../../#{found}"
-      end
+      %Q{
+#{header :h2, 'License'}
 
-      return out
+#{@gem_title} is released under the #{@gem_spec.licenses.first} license.
+}
     end
   end
 end

data/lib/rake_tasks/lib/gem.rb

@@ -49,15 +49,14 @@ module RakeTasks
       end
 
       # Get the gem specification.
-      def gem_spec(spec = Kernel.const_get('Gem').const_get('Specification'))
-        spec.load(gem_spec_file) if gem_file?
+      def gem_spec
+        ::Gem::Specification.load(gem_spec_file) if gem_file?
       end
 
       # Check for a gem spec file.
       def gem_spec_file
-        file = File.basename(Dir.getwd) + '.gemspec'
-        return nil unless File.file? file
-        return file
+        file_name = Dir['*.gemspec'].first
+        return file_name
       end
 
       # Returns the name and version from the specified gem specification.
@@ -68,28 +67,27 @@ module RakeTasks
       end
 
       # Updates the version in the gem specification file.
-      def version!(value, spec = gem_spec, temp = Tempfile.new('temp_gem_spec'))
-        return if spec.nil?
+      def version!(value, spec = gem_spec)
+        return unless gem_spec_file
 
-        begin
-          file = File.open(gem_spec_file, 'r')
+        temp = StringIO.new
 
+        File.open(gem_spec_file, 'r') do |file|
           while line = file.gets
             if line =~ /version *= *['"]#{spec.version}['"]/
-              temp.puts line.sub(/(['"])#{spec.version}(['"])/, "\\1#{value}\\2")
+              temp.puts line.sub(/['"].*['"]/, "'#{value}'")
             else
               temp.puts line
             end
           end
+        end
 
-          temp.flush
+        temp.rewind
 
-          FileUtils.mv temp.path, gem_spec_file
-        rescue Exception => ex
-          raise ex
-        ensure
-          temp.close
-          temp.unlink
+        File.open(gem_spec_file, 'w') do |file|
+          while line = temp.gets
+            file.puts line
+          end
         end
       end
     end

data/lib/rake_tasks/lib/rubies.sh

@@ -9,4 +9,10 @@ else
 fi
 
 rvm use $2
-rake $3 $1
+
+if [ $# -ge 3 ]; then
+  gem install rake -v $3 --no-rdoc --no-ri
+  rake _$3_ $1
+else
+  bundle exec rake $1
+fi 

data/lib/rake_tasks/lib/tests.rb

@@ -128,7 +128,7 @@ module RakeTasks
 
           cmd = ['bash', RakeTasks::SCRIPTS[:rubies], 'test:all']
           cmd << config[:ruby]
-          cmd << "_#{config[:rake]}_" if config[:rake]
+          cmd << config[:rake] if config[:rake]
 
           # Run the tests.
           pid = Process.spawn(*cmd, :out => 'out.log', :err => 'err.log')

data/lib/rake_tasks.rb

@@ -31,7 +31,6 @@
 require 'rake/testtask'
 require 'rdoc/task'
 require 'rake/clean'
-require 'tempfile'
 require 'fileutils'
 require 'psych'