rake_tasks 1.1.0 → 2.0.0

data/Gemfile

@@ -1,3 +1,7 @@
 source "http://rubygems.org"
 
 gemspec
+
+group :test do
+  gem 'mocha', '~> 0.10.0'
+end

data/Gemfile.lock

@@ -1,19 +1,22 @@
 PATH
   remote: .
   specs:
-    rake_tasks (1.0.1)
+    rake_tasks (2.0.0)
       rake (~> 0.9.2)
       rdoc (~> 3.9.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
     rake (0.9.2)
     rdoc (3.9.4)
 
 PLATFORMS
   ruby
-  x86-mingw32
 
 DEPENDENCIES
+  mocha (~> 0.10.0)
   rake_tasks!

data/README

@@ -10,10 +10,37 @@ The following assumptions are currently made:
 1. There is a valid .gemspec file in the root folder that is named the same
    as the root folder.
 
-2. Tests reside in a folder named 'test' and test files are named *_test.rb.
+2. 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]
 
 3. Additional rake tasks are named *.rb and reside in a folder named 'tasks'.
 
+4. README generation is more intelligent about licensing information.
+   If nothing else is available, RakeTasks will use the gemspec information
+   to populate the license information. If a license folder exists, RakeTasks
+   will look for files that match the license name and include links
+   to both licenses and images in the README.
+
+   If a README does not exist, one will be created.
+   If a README does exist, a README_GENERATED file will be created,
+   so as not to overwrite a 'real' README file.
+
 The default task will be set in the following order:
 
 1. If tests are found, rake will run test:all.
@@ -31,7 +58,7 @@ The default task will be set in the following order:
 
 2. Require the gem in your Gemfile:
 
-    gem 'rake_tasks', '~> 0.0.4'
+    gem 'rake_tasks', '~> 2.0.0'
 
 3. Require the gem wherever you need to use it:
 
@@ -43,6 +70,6 @@ The default task will be set in the following order:
 
 == License
 
-RakeTasks is released under the {LGPLv3 license}[link:../../license/lgpl].
+RakeTasks is released under the {LGPLv3 license}[link:../../license/lgplv3].
 
-link:../../license/lgplv3-88x31.png
+link:../../license/lgplv3.png

data/lib/rake_tasks/doc.rb

@@ -28,59 +28,22 @@
 ################################################################################
 #++
 
-gem_spec_file = "#{File.basename(Dir.getwd)}.gemspec"
-
-if File.file?(gem_spec_file)
+if RakeTasks::Gem.gem_file?
   ############################################################################
   namespace :doc do
   ############################################################################
 
-    gem_spec = Gem::Specification.load(gem_spec_file)
+    gem_spec_file = RakeTasks::Gem.gem_spec_file
+    gem_spec = RakeTasks::Gem.gem_spec
 
-    readme = 'README_GENERATED'
+    readme = 'README'
+    readme = 'README_GENERATED' if File.file?(readme)
 
     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
+      doc_obj = RakeTasks::Doc.new
 
       File.open(readme, 'w') do |file|
-        file.puts content
+        file.puts doc_obj.readme_contents
       end
     end
 
@@ -92,14 +55,6 @@ EOD
       rm_f readme
     end
 
-    def camelize(word)
-      result = ''
-      word.split('_').each do |section|
-        result += section.capitalize
-      end
-      return result
-    end
-
   ############################################################################
   end # :doc
   ############################################################################

data/lib/rake_tasks/gem.rb

@@ -28,14 +28,13 @@
 ################################################################################
 #++
 
-gem_spec_file = "#{File.basename(Dir.getwd)}.gemspec"
-
-if File.file?(gem_spec_file)
+if RakeTasks::Gem.gem_file?
   ############################################################################
   namespace :gem do
   ############################################################################
 
-    gem_spec = Gem::Specification.load(gem_spec_file)
+    gem_spec = RakeTasks::Gem.gem_spec
+    gem_spec_file = RakeTasks::Gem.gem_spec_file
 
     file gem_spec.file_name =>
         [gem_spec_file, *Dir['lib/**/*.rb'], 'Gemfile', 'Gemfile.lock'] do |t|
@@ -61,32 +60,11 @@ if File.file?(gem_spec_file)
     desc "Show/Set the version number."
     task :version, [:number] do |t, args|
       if args[:number].nil?
-        puts "#{gem_spec.name} version #{gem_spec.version}"
+        puts RakeTasks::Gem.version(gem_spec)
       else
-        temp_file = Tempfile.new("#{gem_spec.name}_gemspec")
-
-        begin
-          File.open(gem_spec_file, 'r') do |file|
-            while line = file.gets
-              if line =~ /version *= *['"]#{gem_spec.version}['"]/
-                temp_file.puts line.sub(
-                  /['"]#{gem_spec.version}['"]/, "'#{args[:number]}'")
-              else
-                temp_file.puts line
-              end
-            end
-          end
-
-          temp_file.flush
-
-          mv temp_file.path, gem_spec_file
-
-        rescue Exception => ex
-          raise ex
-        ensure
-          temp_file.close
-          temp_file.unlink
-        end
+        RakeTasks::Gem.version! args[:number], gem_spec
+        gem_spec = RakeTasks::Gem.gem_spec
+        puts RakeTasks::Gem.version(gem_spec)
       end
     end
 

data/lib/rake_tasks/lib/doc.rb

@@ -0,0 +1,152 @@
+# This file holds the class that handles documentation utilities.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU Lesser General Public License    #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU Lesser General Public License for more details.                  #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# The main module for this gem.
+module RakeTasks
+  # This class will handle documentation utilities.
+  class Doc
+    # Constructor.
+    def initialize(gem_info = RakeTasks::Gem)
+      @gem_spec = gem_info.gem_spec
+      @gem_title = gem_info.gem_title(@gem_spec)
+      @license_path = 'license'
+      @contents = nil
+    end
+
+    # The default contents for a readme file.
+    def readme_contents
+      gem_title = @gem_title
+      gem_spec = @gem_spec
+
+      @contents ||= %Q{
+#{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
+#{license_details}}.strip
+
+      return @contents
+    end
+
+    ########################################################################
+    private
+    ########################################################################
+
+    # Header indicator.
+    def header
+      '=='
+    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
+
+      return out
+    end
+  end
+end

data/lib/rake_tasks/lib/gem.rb

@@ -0,0 +1,97 @@
+# This file holds the class that handles gem utilities.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU Lesser General Public License    #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU Lesser General Public License for more details.                  #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# The main module for this gem.
+module RakeTasks
+  # This class will handle gem utilities.
+  class Gem
+    class << self
+      # Check whether a gem spec file exists for this project.
+      def gem_file?
+        return !gem_spec_file.nil?
+      end
+
+      # Returns the gem title.
+      # This is the gem name with underscores removed.
+      # Wherever an underscore is removed, the next letter is capitalized.
+      def gem_title(spec = gem_spec)
+        return nil unless spec.respond_to?(:name)
+        spec.name.split('_').map { |w| w.capitalize }.join('')
+      end
+
+      # Get the gem specification.
+      def gem_spec(spec = Kernel.const_get('Gem').const_get('Specification'))
+        spec.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
+      end
+
+      # Returns the name and version from the specified gem specification.
+      def version(spec = gem_spec)
+        if spec.respond_to?(:name) && spec.respond_to?(:version)
+          "#{spec.name} version #{spec.version}"
+        end
+      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?
+
+        begin
+          file = File.open(gem_spec_file, 'r')
+
+          while line = file.gets
+            if line =~ /version *= *['"]#{spec.version}['"]/
+              temp.puts line.sub(/(['"])#{spec.version}(['"])/, "\\1#{value}\\2")
+            else
+              temp.puts line
+            end
+          end
+
+          temp.flush
+
+          FileUtils.mv temp.path, gem_spec_file
+        rescue Exception => ex
+          raise ex
+        ensure
+          temp.close
+          temp.unlink
+        end
+      end
+    end
+  end
+end

data/lib/rake_tasks/lib/tests.rb

@@ -0,0 +1,143 @@
+# This file contains the class that assists in setting up test tasks.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU Lesser General Public License    #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU Lesser General Public License for more details.                  #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# The main module for this gem.
+module RakeTasks
+  # This class assists in setting up test tasks.
+  class Tests
+    class << self
+      # Indicates that tests exist.
+      def exist?
+        return !Dir[File.join(root, '**')].empty?
+      end
+
+      # Returns an array of test files for the specified group.
+      def file_list(group = :all)
+        group = group.to_sym unless group.is_a?(Symbol)
+
+        list = []
+
+        paths(group).each do |path|
+          patterns.each do |pattern|
+            files = Dir[File.join(path, pattern)]
+            list << files unless files.empty?
+          end
+        end
+
+        return list.flatten
+      end
+
+      # Convert a path to a file into an appropriate task name.
+      # This is done by removing the pattern that is used to indicate
+      # it is a test file.
+      def task_name(file_path)
+        file = File.basename(file_path, '.rb')
+
+        patterns.each do |pattern|
+          pattern = pattern.sub(/\.rb$/, '').sub(/\*/, '.+?')
+
+          if file =~ /#{pattern}/
+            pattern = pattern.sub(/\.\+\?/, '')
+
+            if pattern.index('_') == 0
+              return file.sub(/#{pattern}$/, '')
+            else
+              return file.sub(/^#{pattern}/, '')
+            end
+          end
+
+        end
+      end
+
+      # Return an array containing the types of tests that are included.
+      def types
+        types = []
+
+        Dir[File.join(root, '**')].each do |path|
+          next if !File.directory?(path)
+
+          patterns.each do |pattern|
+            next if types.include?(File.basename(path))
+            types << File.basename(path) unless Dir[File.join(path, pattern)].empty?
+          end
+        end
+
+        return types
+      end
+
+      ####################################################################
+      private
+      ####################################################################
+
+      # The patterns that indicate that a file contains tests.
+      def patterns
+        [
+          '*_test.rb',
+          'test_*.rb',
+        ]
+      end
+
+      # Paths to check for test files.
+      # Only paths for a specified type will be returned, if specified.
+      def paths(group = :all)
+        paths = []
+
+        paths << [root] if group == :all
+
+        types.each do |type|
+          if group == type.to_sym || group == :all
+            paths << File.join(root, type)
+          end
+        end
+
+        return paths
+      end
+
+      # The root test folder.
+      def root
+        roots.each do |r|
+          unless Dir[r].empty?
+            return r
+          end
+        end
+      end
+
+      # Returns an array of potential root folder names.
+      def roots
+        [
+          'test',
+          'tests'
+        ]
+      end
+    end
+  end
+end

data/lib/rake_tasks/test.rb

@@ -28,41 +28,32 @@
 ################################################################################
 #++
 
-test_dir = 'test'
-
-if File.directory?(test_dir)
+if RakeTasks::Tests.exist?
   ############################################################################
   namespace :test do
   ############################################################################
     # Add a task to run all tests.
     Rake::TestTask.new('all') do |task|
-      task.pattern = "#{test_dir}/*_test.rb"
+      task.test_files = RakeTasks::Tests.file_list
       task.verbose = true
       task.warning = true
     end
     Rake::Task[:all].comment = 'Run all tests'
 
-    file_list = Dir["#{test_dir}/*_test.rb"]
-
-    # Add a distinct test task for each test file.
-    file_list.each do |item|
-      # Get the name to use for the task by removing '_test.rb' from the name.
-      task_name = File.basename(item, '.rb').gsub(/_test$/, '')
-
-      # Add each test.
-      Rake::TestTask.new(task_name) do |task|
-        task.pattern = item
+    # Add tasks for each type of test (unit, integration, performance, etc.).
+    RakeTasks::Tests.types.each do |type|
+      Rake::TestTask.new(type) do |task|
+        task.test_files = RakeTasks::Tests.file_list(type)
         task.verbose = true
         task.warning = true
       end
+      Rake::Task[type].comment = "Run #{type} tests"
     end
 
-    file_name = File.basename(Dir.getwd) + '_test.rb'
-
-    if File.file?("#{test_dir}/#{file_name}")
-      desc "Run a single method in #{file_name}."
-      task :method, [:method_name] do |t, args|
-        puts `ruby ./#{test_dir}/#{file_name} --name #{args[:method_name]}`
+    # Add a way to call a specific method in a given file.
+    RakeTasks::Tests.file_list.each do |file_path|
+      task RakeTasks::Tests.task_name(file_path), [:method_name] do |t, args|
+        puts `ruby ./#{file_path} --name #{args[:method_name]}`
       end
     end
   ############################################################################