rake_tasks 1.1.0 → 2.0.0

data/lib/rake_tasks.rb

@@ -33,17 +33,21 @@ require 'rake/testtask'
 require 'rdoc/task'
 require 'rake/clean'
 require 'tempfile'
+require 'fileutils'
 
 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')
+# Require lib files.
+Dir[File.join(File.dirname(__FILE__), gem_name, 'lib', '*.rb')].each do |lib|
+  require lib
+end
 
-# Include any ruby files in the tasks folder.
-task_files = Dir[File.join(Dir.getwd, 'tasks', '*.rb')]
+# Require tasks.
+Dir[File.join(File.dirname(__FILE__), gem_name, '*.rb')].each do |task|
+  require task
+end
 
-task_files.each do |rake_file|
+# Include any ruby files in the tasks folder.
+Dir[File.join(Dir.getwd, 'tasks', '*.rb')].each do |rake_file|
   require rake_file
 end

data/rake_tasks.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rake_tasks'
-  s.version = '1.1.0'
+  s.version = '2.0.0'
 
   s.summary = 'Basic rake tasks. You know you want some.'
   s.description =%Q{
@@ -25,5 +25,7 @@ mmmm yummy
   s.add_dependency 'rdoc', '~> 3.9.4'
   s.add_dependency 'rake', '~> 0.9.2'
 
+  s.add_development_dependency 'mocha', '~> 0.10.0'
+
   s.has_rdoc = true
 end

data/test/integration/doc_integration_test.rb

@@ -0,0 +1,79 @@
+#--
+################################################################################
+#                      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/>.        #
+################################################################################
+#++
+
+require_relative File.join('../require.rb'.split('/'))
+
+class DocIntegrationTest < Test::Unit::TestCase
+  def setup
+    @class = RakeTasks::Doc
+    @gem = RakeTasks::Gem
+    @gem_spec = @gem.gem_spec
+    @title = @gem.gem_title
+    @obj = @class.new
+  end
+
+  def test_readme_basic_contents
+    [
+      @title,
+      'Getting Started',
+      'Usage',
+      'Additional Notes',
+      'Additional Documentation',
+      "gem install #{@gem_spec.name}",
+      "gem '#{@gem_spec.name}', '~> #{@gem_spec.version}'",
+      "require '#{@gem_spec.name}'",
+      "rake rdoc:app",
+      "the {#{@gem_spec.license} license}" +
+        "[link:../../license/#{@gem_spec.license.downcase}].\n\n" +
+        "link:../../license/#{@gem_spec.license.downcase}.png",
+    ].each do |text|
+      assert_contains readme, text
+    end
+  end
+
+  def test_actual_readme_contents
+    contents = File.open('README', 'r')
+    assert_contains contents.read,
+      "gem '#{@gem_spec.name}', '~> #{@gem_spec.version}'"
+  end
+
+  ############################################################################
+  private
+  ############################################################################
+
+  def assert_contains(text, snippet)
+    assert text.include?(snippet),
+      "The specified text does not contain '#{snippet}'."
+  end
+
+  def readme
+    @readme ||= @obj.readme_contents
+  end
+end

data/test/integration/gem_integration_test.rb

@@ -0,0 +1,74 @@
+#--
+################################################################################
+#                      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/>.        #
+################################################################################
+#++
+
+require_relative File.join('../require.rb'.split('/'))
+
+class GemIntegrationTest < Test::Unit::TestCase
+  def setup
+    @class = RakeTasks::Gem
+    @version = @class.gem_spec.version
+  end
+
+  def teardown
+    if @version != @class.gem_spec.version
+      @class.version! @version.to_s
+    end
+  end
+
+  def test_gem_title
+    assert_equal 'RakeTasks', @class.gem_title
+  end
+
+  def test_load_gem_spec
+    assert_kind_of Gem::Specification, @class.gem_spec
+  end
+
+  def test_gem_spec_file
+    assert_equal File.basename(Dir.getwd) + '.gemspec', @class.gem_spec_file
+  end
+
+  def test_gem_file_exists
+    assert @class.gem_file?, "#{@class.gem_spec_file} does not exist."
+  end
+
+  def test_set_version
+    old_spec = @class.gem_spec
+    @class.version! '0.0.0'
+    new_spec = @class.gem_spec
+
+    assert_not_equal old_spec.version, new_spec.version
+    assert_equal '0.0.0', new_spec.version.to_s
+  end
+
+  def test_version
+    spec = @class.gem_spec
+    assert_equal "#{spec.name} version #{spec.version}", @class.version
+  end
+end

data/test/integration/tests_integration_test.rb

@@ -0,0 +1,79 @@
+#--
+################################################################################
+#                      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/>.        #
+################################################################################
+#++
+
+require_relative File.join('../require'.split('/'))
+
+class TestsIntegrationTest < Test::Unit::TestCase
+  def setup
+    @class = RakeTasks::Tests
+    @file_path = 'test'
+  end
+
+  def test_tests_exist
+    assert_equal true, @class.exist?
+  end
+
+  def test_types
+    types = @class.types
+
+    assert_equal 2, types.count
+
+    ['integration', 'unit'].each do |type|
+      assert types.include?(type), "Test types do not include #{type} tests."
+    end
+  end
+
+  def test_file_list
+    file = File.join(@file_path, 'integration', File.basename(__FILE__))
+
+    assert @class.file_list.include?(file),
+      "#{file} is not in the list of test files:\n" +
+      @class.file_list.join("\n")
+
+    check_file_list :unit
+    check_file_list :integration
+  end
+
+  ############################################################################
+  private
+  ############################################################################
+
+  def check_file_list(group)
+    files = Dir[File.join(@file_path, group.to_s, '*.rb')]
+
+    assert_equal files.count, @class.file_list(group).count
+
+    files.each do |file|
+      assert @class.file_list(group).include?(file),
+        "#{file} is not in the list of test files:\n" +
+        @class.file_list(group).join("\n")
+    end
+  end
+end

data/test/require.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+
+Bundler.require :test
+
+require_relative File.join('../lib/rake_tasks'.split('/'))

data/test/unit/doc_unit_test.rb

@@ -0,0 +1,145 @@
+#--
+################################################################################
+#                      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/>.        #
+################################################################################
+#++
+
+require_relative File.join('../require'.split('/'))
+
+class DocUnitTest < Test::Unit::TestCase
+  def setup
+    @class = RakeTasks::Doc
+    @gem = RakeTasks::Gem
+    @spec_class = Gem::Specification
+    stubs :gem_spec
+    stubs :file?
+    @spec = @gem.gem_spec
+    @obj = @class.new(@gem)
+    @readme = nil
+  end
+
+  def test_readme_basic_contents
+    expectations :file_list
+    [
+      spec[:title],
+      'Getting Started',
+      'Usage',
+      'Additional Notes',
+      'Additional Documentation',
+      "gem install #{spec[:name]}",
+      "gem '#{spec[:name]}', '~> #{spec[:version]}'",
+      "require '#{spec[:name]}'",
+      "rake rdoc:app",
+      "the {#{spec[:license]} license}[link:../../license/MiT].\n\n" +
+        "link:../../license/MiT.png",
+    ].each do |text|
+      assert_contains readme, text
+    end
+  end
+
+  def test_no_license_information
+    @spec.expects(:licenses).with.returns([]).at_least_once
+    assert_not_contains readme, ' license.'
+  end
+
+  def test_readme_license_no_files_match
+    Dir.expects(:[] => ['license/file3', 'license/file4'])
+    Dir.expects(:[] => ['license/file1.jpg', 'license/file2.png'])
+
+    assert_contains readme, "the #{spec[:license]} license."
+  end
+
+  def test_readme_license_with_license_but_no_images
+    Dir.expects(:[] => ['license/file1', 'license/MiT'])
+    Dir.expects(:[] => [])
+
+    assert_contains readme, "the {#{spec[:license]} license}" +
+      "[link:../../license/MiT]."
+  end
+
+  def test_readme_license_with_images_but_no_license
+    Dir.expects(:[] => [])
+    Dir.expects(:[] => ['license/file1.jpg', 'license/mIt.png'])
+
+    assert_contains readme, "the #{spec[:license]} license.\n\n" +
+      "link:../../license/mIt.png"
+  end
+
+
+  ############################################################################
+  private
+  ############################################################################
+
+  def expectations(key)
+    case key
+      when :file_list then
+        Dir.expects(:[]).returns(['license/file1', 'license/MiT'])
+        Dir.expects(:[]).returns(['license/file1.jpg', 'license/MiT.png'])
+    end
+  end
+
+  def stubs(item)
+    case item
+      when :file? then File.stubs(:file? => true)
+      when :spec
+        gem_spec = mock.responds_like(@spec_class.new)
+        gem_spec.stubs spec
+        return gem_spec
+      when :gem_spec
+        @gem.stubs(:gem_spec => stubs(:spec))
+    end
+  end
+
+  def assert_not_contains(text, snippet)
+    assert !text.include?(snippet),
+      "The specified text should not contain '#{snippet}'."
+  end
+
+  def assert_contains(text, snippet)
+    assert text.include?(snippet),
+      "The specified text does not contain '#{snippet}'."
+  end
+
+  def readme
+    @readme ||= @obj.readme_contents
+  end
+
+  def spec
+    {
+      :name        => 'test_gem',
+      :title       => 'TestGem',
+      :version     => '0.0.1',
+      :licenses    => ['MIT', 'GPL'],
+      :license     => 'MIT',
+      :description =>
+%Q{
+A long explanation of what this thing can do.
+Yeah, it's cool.
+}.strip,
+    }
+  end
+end