jeweler 1.0.2 → 1.1.0

data/.gitignore

@@ -1,7 +1,9 @@
 coverage
 pkg
+doc
 rdoc
 tags
 test/tmp
 test/version_tmp
 tmp
+.yardoc

data/ChangeLog.markdown

@@ -1,3 +1,25 @@
+# jeweler 1.1.0 2009-08-05
+
+ * Support for generating a project that uses yard instead of rdoc
+ * Generated gemspec now includes comments about it being generated by jeweler
+ * Only use sudo for installing on non-windows platforms [#1]
+ * Fixed rake release to be repeatable on the same version [#16]
+ * Fixed rake rubyforge:setup to not create duplicate packages
+ * Use a more recent version of ruby-git
+  * Fixes various issues with reading values out of ~/.gitconfig [#26] [#21] [#19]
+ * Experimenting with a rake task to check development time dependencies [#22]
+ * Fixed generated rdoc task to load from VERSION instead of VERSION.yml
+
+# jeweler 1.0.2 2009-07-29
+
+ * Don't include git ignored files for default gemspec's files and test_files
+ * Fixed rspec generator to allow specs to be run directly
+ * Removed misleading docstring for version_required rake task [#17]
+ * Includes some notes about contributed in generated README
+ * Added support for generating a project to use reek and roodi
+
+# jeweler 1.0.1 2009-05-15
+
 # jeweler 0.11.1
 
  * Lots of internal refactorings to how project generation happens

data/Rakefile

@@ -15,14 +15,27 @@ begin
     gem.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
     gem.authors = ["Josh Nichols"]
     gem.files.include %w(lib/jeweler/templates/.document lib/jeweler/templates/.gitignore)
-    gem.add_dependency "git", ">= 1.1.1"
+
+    gem.add_dependency "git", ">= 1.2.1"
     gem.add_dependency "rubyforge"
+
     gem.rubyforge_project = "pickles"
+
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "mhennemeyer-output_catcher"
+    gem.add_development_dependency "rr"
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "redgreen"
+  end
+
+  Jeweler::RubyforgeTasks.new do |t|
+    t.doc_task = :yardoc
   end
 rescue LoadError
   puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
 end
 
+
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.test_files = FileList.new('test/**/test_*.rb') do |list|
@@ -32,14 +45,18 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'jeweler'
-  rdoc.rdoc_files.include('README.markdown')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new(:yardoc) do |t|
+    t.files   = FileList['lib/**/*.rb'].exclude('lib/jeweler/templates/**/*.rb')
+  end
+rescue LoadError
+  task :yardoc do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
 end
 
+
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new(:rcov) do |rcov|
@@ -73,34 +90,37 @@ rescue LoadError
   end
 end
 
-begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-    
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-    
-    namespace :release do
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
-
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/pickles"
-        local_dir = 'rdoc'
-
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-end
-
 if ENV["RUN_CODE_RUN"] == "true"
   task :default => [:test, :features]
 else
   task :default => :test
 end
+
+namespace :development_dependencies do
+  task :check do
+    missing_dependencies = Rake.application.jeweler.gemspec.development_dependencies.select do |dependency|
+      begin
+        Gem.activate dependency.name, dependency.version_requirements.to_s
+        false
+      rescue LoadError => e
+        true
+      end
+    end
+
+    #require 'ruby-debug'; breakpoint
+
+    if missing_dependencies.empty?
+      puts "Development dependencies seem to be installed."
+    else
+      puts "Missing some dependencies. Install them with the following commands:"
+      missing_dependencies.each do |dependency|
+        puts %Q{\tgem install #{dependency.name} --version "#{dependency.version_requirements}"}
+      end
+      abort "Run the specified gem commands before trying to run this again: #{$0} #{ARGV.join(' ')}"
+    end
+
+  end
+end
+
+task :test => 'development_dependencies:check'
+task :features => 'development_dependencies:check'

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:patch: 2
-:minor: 0
+:patch: 0
+:minor: 1

data/features/generator/rakefile.feature

@@ -3,9 +3,11 @@ Feature: generated Rakefile
   A user should be able to
   generate a Rakefile
 
-  Scenario: shared
+  Background:
     Given a working directory
     And I have configured git sanely
+
+  Scenario: shared
     When I generate a project named 'the-perfect-gem' that is 'zomg, so good' and described as 'Descriptive'
 
     Then 'Rakefile' requires 'rubygems'
@@ -18,8 +20,6 @@ Feature: generated Rakefile
     And Rakefile has 'http://github.com/technicalpickles/the-perfect-gem' for the Jeweler::Tasks homepage
 
   Scenario: bacon
-    Given a working directory
-    And I have configured git sanely
     When I generate a bacon project named 'the-perfect-gem' that is 'zomg, so good'
 
     
@@ -30,8 +30,6 @@ Feature: generated Rakefile
     And Rakefile has "spec" as the default task
 
   Scenario: minitest
-    Given a working directory
-    And I have configured git sanely
     When I generate a minitest project named 'the-perfect-gem' that is 'zomg, so good'
 
     Then 'Rakefile' requires 'rcov/rcovtask'
@@ -41,8 +39,6 @@ Feature: generated Rakefile
     And Rakefile has "test" as the default task
 
   Scenario: rspec
-    Given a working directory
-    And I have configured git sanely
     When I generate a rspec project named 'the-perfect-gem' that is 'zomg, so good'
 
     Then 'Rakefile' requires 'spec/rake/spectask'
@@ -50,8 +46,6 @@ Feature: generated Rakefile
     And Rakefile has "spec" as the default task
 
   Scenario: shoulda
-    Given a working directory
-    And I have configured git sanely
     When I generate a shoulda project named 'the-perfect-gem' that is 'zomg, so good'
 
     Then 'Rakefile' requires 'rcov/rcovtask'
@@ -61,8 +55,6 @@ Feature: generated Rakefile
     And Rakefile has "test" as the default task
 
   Scenario: micronaut
-    Given a working directory
-    And I have configured git sanely
     When I generate a micronaut project named 'the-perfect-gem' that is 'zomg, so good'
 
     Then 'Rakefile' requires 'micronaut/rake_task'
@@ -70,8 +62,6 @@ Feature: generated Rakefile
     And Rakefile has "examples" as the default task
 
   Scenario: testunit
-    Given a working directory
-    And I have configured git sanely
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
 
     Then 'Rakefile' requires 'rcov/rcovtask'
@@ -81,65 +71,81 @@ Feature: generated Rakefile
     And Rakefile has "test" as the default task
 
   Scenario: no cucumber
-    Given a working directory
-    And I have configured git sanely
-    And I do not want cucumber stories
+    Given I do not want cucumber stories
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile does not require 'cucumber/rake/task' 
     And Rakefile does not instantiate a Cucumber::Rake::Task
 
   Scenario: cucumber
-    Given a working directory
-    And I have configured git sanely
-    And I want cucumber stories
+    Given I want cucumber stories
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile requires 'cucumber/rake/task' 
     And Rakefile instantiates a Cucumber::Rake::Task
 
   Scenario: no reek
-    Given a working directory
-    And I have configured git sanely
-    And I do not want reek
+    Given I do not want reek
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile does not require 'reek/rake_task' 
     And Rakefile does not instantiate a Reek::RakeTask
 
   Scenario: reek
-    Given a working directory
-    And I have configured git sanely
-    And I want reek
+    Given I want reek
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile requires 'reek/rake_task' 
     And Rakefile instantiates a Reek::RakeTask
 
   Scenario: no roodi
-    Given a working directory
-    And I have configured git sanely
-    And I do not want roodi
+    Given I do not want roodi
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile does not require 'roodi' 
     And Rakefile does not require 'roodi_task' 
     And Rakefile does not instantiate a RoodiTask
 
   Scenario: roodi
-    Given a working directory
-    And I have configured git sanely
-    And I want roodi
+    Given I want roodi
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile requires 'roodi' 
     And Rakefile requires 'roodi_task' 
     And Rakefile instantiates a RoodiTask
 
   Scenario: no rubyforge
-    Given a working directory
-    And I have configured git sanely
-    And I do not want rubyforge setup
+    Given I do not want rubyforge setup
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile does not instantiate a Jeweler::RubyforgeTasks
 
   Scenario: rubyforge
-    Given a working directory
-    And I have configured git sanely
+    Given I want rubyforge setup
+    When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
+    Then Rakefile instantiates a Jeweler::RubyforgeTasks
+
+  Scenario: yard
+    Given I want to use yard instead of rdoc
+    When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
+    
+    Then 'Rakefile' does not require 'rake/rdoctask'
+    And 'Rakefile' requires 'yard'
+    And Rakefile instantiates a YARD::Rake::YardocTask
+
+  Scenario: rdoc
+    Given I want to use rdoc instead of yard
+    When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
+    
+    Then 'Rakefile' does not require 'yard'
+    And 'Rakefile' requires 'rake/rdoctask'
+    And Rakefile does not instantiate a YARD::Rake::YardocTask
+    And Rakefile instantiates a Rake::RDocTask.new
+
+  Scenario: rubyforge and yard
+    Given I want to use yard instead of rdoc
+    And I want rubyforge setup
+    When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
+    Then Rakefile instantiates a Jeweler::RubyforgeTasks
+    And Rakefile has 'yardoc' for the Jeweler::RubyforgeTasks doc_task
+
+  Scenario: rubyfoge and doc
+    Given I want to use rdoc instead of yard
+    And I want rubyforge setup
     And I want rubyforge setup
     When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
     Then Rakefile instantiates a Jeweler::RubyforgeTasks
+    And Rakefile has 'rdoc' for the Jeweler::RubyforgeTasks doc_task

data/features/step_definitions/filesystem_steps.rb

@@ -25,6 +25,9 @@ end
 When /^I run "([^"]+)" in "([^"]+)"$/ do |command, directory|
   full_path = File.join(@working_dir, directory)
 
+  lib_path = File.expand_path 'lib'
+  command.gsub!(/^rake /, "rake -I#{lib_path} ")
+
   assert File.directory?(full_path), "#{full_path} is not a directory"
 
   @stdout = `cd #{full_path} && #{command}`

data/features/step_definitions/generator_steps.rb

@@ -30,6 +30,14 @@ And /^I want rubyforge setup$/ do
   @use_rubyforge = true
 end
 
+Given /^I want to use yard instead of rdoc$/ do
+  @documentation_framework = "yard"
+end
+
+Given /^I want to use rdoc instead of yard$/ do
+  @documentation_framework = "rdoc"
+end
+
 
 Given /^I intend to test with (\w+)$/ do |testing_framework|
   @testing_framework = testing_framework.to_sym
@@ -77,6 +85,7 @@ When /^I generate a (.*)project named '((?:\w|-|_)+)' that is '([^']*)' and desc
                 @use_rubyforge ? '--rubyforge' : nil,
                 @use_roodi ? '--roodi' : nil,
                 @use_reek ? '--reek' : nil,
+                @documentation_framework ? "--#{@documentation_framework}" : nil,
                 @name].compact
 
   @stdout = OutputCatcher.catch_out do

data/features/support/env.rb

@@ -1,8 +1,18 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 require 'jeweler'
 
-require 'mocha'
-require 'output_catcher'
+begin
+  require 'mocha'
+  require 'output_catcher'
+rescue LoadError => e
+  puts "*" * 80
+  puts "Some dependencies needed to run tests were missing. Run the following command to find them:"
+  puts
+  puts "\trake development_dependencies:check"
+  puts "*" * 80
+  exit 1
+end
+
 
 require 'test/unit/assertions'
 

data/jeweler.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{jeweler}
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Nichols"]
-  s.date = %q{2009-07-29}
+  s.date = %q{2009-08-05}
   s.default_executable = %q{jeweler}
   s.description = %q{Simple and opinionated helper for creating Rubygem projects on GitHub}
   s.email = %q{josh@technicalpickles.com}
@@ -150,7 +153,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{pickles}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Simple and opinionated helper for creating Rubygem projects on GitHub}
   s.test_files = [
     "test/fixtures/bar/lib/foo_the_ultimate_lib.rb",
@@ -191,14 +194,29 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<git>, [">= 1.1.1"])
+      s.add_runtime_dependency(%q<git>, [">= 1.2.1"])
       s.add_runtime_dependency(%q<rubyforge>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mhennemeyer-output_catcher>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<redgreen>, [">= 0"])
     else
-      s.add_dependency(%q<git>, [">= 1.1.1"])
+      s.add_dependency(%q<git>, [">= 1.2.1"])
       s.add_dependency(%q<rubyforge>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mhennemeyer-output_catcher>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<redgreen>, [">= 0"])
     end
   else
-    s.add_dependency(%q<git>, [">= 1.1.1"])
+    s.add_dependency(%q<git>, [">= 1.2.1"])
     s.add_dependency(%q<rubyforge>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mhennemeyer-output_catcher>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<redgreen>, [">= 0"])
   end
 end