rake_tasks 2.0.6 → 3.0.0

data/rake_tasks.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rake_tasks'
-  s.version = '2.0.6'
+  s.version = '3.0.0'
 
   s.summary = 'Basic rake tasks. You know you want some.'
   s.description =%Q{
@@ -16,7 +16,11 @@ mmmm yummy
 
   s.license = 'LGPLv3'
 
-  s.extra_rdoc_files = ['README.md', 'license/gplv3.md', 'license/lgplv3.md']
+  s.extra_rdoc_files = [
+    'readme.markdown',
+    'license/gplv3.md',
+    'license/lgplv3.md',
+  ]
 
   s.require_paths = ['lib']
   s.files = Dir[
@@ -28,8 +32,10 @@ mmmm yummy
     Dir['Gemfile.lock']
   s.test_files = Dir['test/**/*.rb']
 
-  s.add_development_dependency 'mocha' , '~> 0.11.4'
-  s.add_development_dependency 'fakefs', '~> 0.4.0'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'faker'
 
   s.has_rdoc = true
 end

data/rakefile

@@ -1 +1,29 @@
-require_relative 'lib/rake_tasks'
+require_relative 'lib/rake_tasks'
+[
+  'cane',
+  'doc',
+  'gem',
+  'rdoc',
+  'test',
+  'checksum',
+].each do |task|
+  require_relative File.join('lib/rake_tasks/tasks', task)
+end
+
+require 'rspec/core/rake_task'
+require 'cane/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.ruby_opts = '-w'
+  #task.rspec_opts = '--format documentation'
+  #task.pattern = 'spec/**/*_save_config_spec.rb'
+end
+
+task :default
+Rake::Task[:default].clear_prerequisites
+
+task :default => [
+  'cane:quality',
+  :spec,
+  'test:all',
+]

data/readme.markdown

@@ -0,0 +1,131 @@
+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 'test', 'tests', or 'spec'
+   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 \*.rake (as of 3.0.0) and reside in a folder named 'tasks'.
+
+* README generation uses 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', '~> 3.0.0'
+
+Require the gem wherever you need to use it:
+(This will load any \*.rake files in your project.)
+
+    require 'rake\_tasks'
+
+Require the tasks that you want to use:
+
+    require 'rake\_tasks\tasks\doc'      # Generate readme
+    require 'rake\_tasks\tasks\cane'     # Cane rake tasks
+    require 'rake\_tasks\tasks\gem'      # Gem build, install, deploy, etc.
+    require 'rake\_tasks\tasks\rdoc'     # Generate RDoc
+    require 'rake\_tasks\tasks\test'     # Run tests - This may get deprecated
+    require 'rake\_tasks\tasks\checksum' # Generate a checksum for \*.gem file
+
+
+Updates
+-------
+
+    3.0.0 No tasks are automatically added to the default rake task.
+
+          Tasks must be included explicitly.
+          The only thing rake\_tasks does by default is load rake tasks for you.
+
+          Added cane and checksum tasks.
+
+          Added `rake test:script` as a workaround to problems with `rake test:full`.
+          For some reason the gem command no longer works for me from the shell scripts.
+
+          Support for rake 0.8.7 was removed due to what appears to be issues with rspec.
+
+          Custom rake tasks should now load properly from any tasks folder under the project root.
+
+    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/test/integration/doc_integration_test.rb

@@ -1,77 +1,81 @@
-#--
-################################################################################
-#                      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 '../require'
-
-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"
-    ].each do |text|
-      assert_contains readme, text
-    end
-  end
-
-  def test_actual_readme_contents
-    contents = File.open('README.md', '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
+#--
+################################################################################
+#                      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 '../require'
+
+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}",
+      require_gem,
+      "require '#{@gem_spec.name}'",
+      'rake rdoc:app',
+      "the #{@gem_spec.license} license"
+    ].each do |text|
+      assert_contains readme, text
+    end
+  end
+
+  def test_actual_readme_contents
+    contents = File.open('readme.markdown', 'r')
+    assert_contains contents.read,
+      require_gem.gsub('_', '\_')
+  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.join("\n")
+  end
+
+  def require_gem
+    "gem '#{@gem_spec.name}', '~> #{@gem_spec.version}'"
+  end
+end

data/test/integration/gem_integration_test.rb

@@ -54,17 +54,8 @@ class GemIntegrationTest < Test::Unit::TestCase
     assert_equal Dir['*.gemspec'].first, @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
+  def test_gemspec_file_exists
+    assert @class.gemspec_file?, "#{@class.gem_spec_file} does not exist."
   end
 
   def test_version

data/test/integration/tests_integration_test.rb

@@ -43,13 +43,16 @@ class TestsIntegrationTest < Test::Unit::TestCase
       '1.9.3-p0',
       '1.9.3-p125',
       '1.9.3-p194',
+      '1.9.3-p286',
     ]
   end
   private :rubies
 
   # Supported rake versions.
   def rakes
-    ['0.8.7', '0.9.0', '0.9.1', '0.9.2', '0.9.2.2']
+    # 0.8.7 is no longer supported.
+    ['0.9.0', '0.9.1', '0.9.2', '0.9.2.2', '0.9.3', '0.9.4', '0.9.5',
+      '10.0.0', '10.0.1', '10.0.2']
   end
   private :rakes
 
@@ -85,19 +88,23 @@ class TestsIntegrationTest < Test::Unit::TestCase
   end
 
   def test_rubies
-    assert_equal configs, @class.test_configs
+    test_configs = @class.test_configs
+    configs.each_with_index do |config, i|
+      assert_equal config, test_configs[i]
+    end
+    assert_equal configs, test_configs
   end
 
   def test_rubies_shell_script_location_should_be_lib
     loc = File.expand_path(File.join(
-      File.dirname(__FILE__), '../../lib/rake_tasks/lib/rubies.sh'))
+      File.dirname(__FILE__), '../../scripts/rubies.sh'))
     assert_equal loc, @module::SCRIPTS[:rubies]
     assert File.file?(loc)
   end
 
   def test_bundle_install_shell_script_location_should_be_lib
     loc = File.expand_path(File.join(
-      File.dirname(__FILE__), '../../lib/rake_tasks/lib/bundle_install.sh'))
+      File.dirname(__FILE__), '../../scripts/bundle_install.sh'))
     assert_equal loc, @module::SCRIPTS[:gemsets]
     assert File.file?(loc)
   end
@@ -112,19 +119,27 @@ class TestsIntegrationTest < Test::Unit::TestCase
     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")
+      assert_file group, file
     end
   end
 
   def configs
     configs = []
     rubies.each do |ruby|
+      unless ruby.match(/^1.9.2/)
+        configs << { :ruby => ruby + '@rake_tasks_test_no_rake' }
+      end
+
       rakes.each do |rake|
         configs << { :ruby => ruby + '@rake_tasks_test', :rake => rake }
       end
     end
     return configs
   end
+
+  def assert_file(group, 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