jeweler 1.3.0 → 1.4.0

data/ChangeLog.markdown

@@ -1,3 +1,33 @@
+# jeweler 1.4.0 2009-11-19
+
+ * Generator now adds gemcutter support by default. Disable it with --no-gemcutter
+ * Generator now creates a reek task that works with the latest reek. If you have a previously generated project using it, you may need to change the require line to: require 'reek/adapters/rake_task'
+ * Generator now exits with the correct exit code
+ * `rake install` no longer uses `sudo` to install. If your ruby configuration needs sudo to install, use `sudo rake install` instead.
+ * `rake install` now correctly installs dependencies as well
+ * `rake install` should correctly figure out which `gem` binary to invoke now
+ * `rake build` now will regenerate the gemspec as well
+ * `rake gemspec` now eliminates duplicates for gemspec.files, gemspec.rdoc_files, etc
+ * `rake gemspec` now automtically populate gemspec.extensions with any extconf.rb files you have in `ext`
+ * Releasing to Rubyforge is now deprecated in favor of Gemcutter.
+
+# jeweler 1.3.0
+
+ * Now supports an addition version type, build. This can be used to add a fourth segment of the version that's arbirtary. One example use is having prereleases.
+ * Jeweler now lazily loads, to avoid causing side-effects when running other rake tasks
+ * Version can now be set explicitly on the gemspec, rather than relying on a VERSION file
+ * Rubyforge and Gemcutter support now hooks into `rake release`
+ * `rake build` now uses an in-memory copy of the gemspec, rather than the filesystem persisted one
+ * Rubyforge support no longer forces the uploading of documentation
+ * Generator:
+  * Allow arbitrary homepage and git remotes, to decouple a bit from GitHub
+  * Support for the riot testing framework: http://github.com/thumblemonks/riot/ 
+  * Support for test/spec
+  * .gitignore now ignores emacs temporary files
+  * rspec support now creates a spec.opts with support for color and other stuff
+  * Updated minitest support (formally miniunit)
+  * Improved support for autotest
+
 # jeweler 1.2.0 2009-08-06
  * Generator now adds development dependencies appropriate to your testing framework
  * Added check_dependencies tasks for verifying gem dependencies are installed

data/README.markdown

@@ -3,11 +3,12 @@
 Jeweler provides two things:
 
  * Rake tasks for managing gems and versioning of a <a href="http://github.com">GitHub</a> project
- * A generator for creating kickstarting a new project
+ * A generator for creating/kickstarting a new project
 
 ## Quick Links
 
  * [Wiki](http://wiki.github.com/technicalpickles/jeweler)
+ * [Mailing List](http://groups.google.com/group/jeweler-rb)
  * [Bugs](http://github.com/technicalpickles/jeweler/issues)
  * [Donate](http://pledgie.org/campaigns/2604)
 
@@ -15,7 +16,7 @@ Jeweler provides two things:
 
     # Install the gem:
     sudo gem install jeweler
-    
+
 ## Using in an existing project
 
 It's easy to get up and running. Update your Rakefile to instantiate a `Jeweler::Tasks`, and give it a block with details about your project.
@@ -24,15 +25,14 @@ It's easy to get up and running. Update your Rakefile to instantiate a `Jeweler:
       require 'jeweler'
       Jeweler::Tasks.new do |gemspec|
         gemspec.name = "the-perfect-gem"
-        gemspec.summary = "Summarize your gem"
-        gemspec.description = "Describe your gem"
+        gemspec.summary = "One line summary of your gem"
+        gemspec.description = "A different and possibly longer explanation of"
         gemspec.email = "josh@technicalpickles.com"
         gemspec.homepage = "http://github.com/technicalpickles/the-perfect-gem"
-        gemspec.description = "TODO"
         gemspec.authors = ["Josh Nichols"]
       end
     rescue LoadError
-      puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+      puts "Jeweler not available. Install it with: sudo gem install jeweler"
     end
 
 The yield object here, `gemspec`, is a `Gem::Specification` object. See the [Customizing your project's gem specification](http://wiki.github.com/technicalpickles/jeweler/customizing-your-projects-gem-specification) for more details about how you can customize your gemspec.
@@ -45,11 +45,11 @@ Jeweler provides a generator. It requires you to [setup your name and email for
 
 This will prepare a project in the 'the-perfect-gem' directory, setup to use Jeweler.
 
-It supports a number of options:
+It supports a number of options. Here's a taste, but `jeweler --help` will give you the most up-to-date listing:
 
  * --create-repo: in addition to preparing a project, it create an repo up on GitHub and enable RubyGem generation
  * --testunit: generate test_helper.rb and test ready for test/unit
- * --minitest: generate test_helper.rb and test ready for minitest 
+ * --minitest: generate test_helper.rb and test ready for minitest
  * --shoulda: generate test_helper.rb and test ready for shoulda (this is the default)
  * --rspec: generate spec_helper.rb and spec ready for rspec
  * --bacon: generate spec_helper.rb and spec ready for bacon
@@ -72,11 +72,22 @@ This creates a gemspec for your project. It's based on the info you give `Jewele
 
 ## Gem
 
-Jeweler gives you tasks for building and installing your gem:
+Jeweler gives you tasks for building and installing your gem.
+
+    rake install
+
+To build the gem (which will end up in `pkg`), run:
 
     rake build
+
+To install the gem (and build if necessary), i.e. using gem install, run:
+
     rake install
 
+Note, this does not use `sudo` to install it, so if your ruby setup needs that, you should prefix it with sudo:
+
+    sudo rake install
+
 ## Versioning
 
 Jeweler tracks the version of your project. It assumes you will be using a version in the format `x.y.z`. `x` is the 'major' version, `y` is the 'minor' version, and `z` is the patch version.
@@ -87,7 +98,27 @@ Initially, your project starts out at 0.0.0. Jeweler provides Rake tasks for bum
     rake version:bump:minor
     rake version:bump:patch
 
-## Releasing to GitHub
+You can also programmatically set the version if you wish. Typically, you use this to have a module with the version info so clients can access it. The only downside here is you no longer can use the version:bump tasks.
+
+    require File.dirname(__FILE__) + "/lib/my_project/version.rb"
+
+    Jeweler::Tasks.new do |gemspec|
+       gemspec.version = MyProject::VERSION
+       # more stuff
+    end
+
+### Prerelease versioning
+
+Major, minor, and patch versions have a distant cousin: build. You can use this to add an arbitrary (or you know, regular type) version. This is particularly useful for prereleases.
+
+You have two ways of doing this:
+
+ * Use `version:write` and specify `BUILD=pre1`
+ * Edit VERSION by hand to add a fourth version segment
+
+Jeweler does not provide a `version:bump:build` because the build version can really be anything, so it's hard to know what should be the next bump.
+
+## Releasing
 
 Jeweler handles releasing your gem into the wild:
 
@@ -96,16 +127,18 @@ Jeweler handles releasing your gem into the wild:
 It does the following for you:
 
  * Regenerate the gemspec to the latest version of your project
- * Push to GitHub (which results in a gem being build)
- * Tag the version and push to GitHub
+ * git pushes to origin/master branch
+ * git tags the version and pushes to the origin remote
+
+As is though, it doesn't actually get your gem anywhere. To do that, you'll need to use rubyforge or gemcutter.
 
-## Releasing to Gemcutter
+### Releasing to Gemcutter
 
 Jeweler can also handle releasing to [Gemcutter](http://gemcutter.org). There are a few steps you need to do before doing any Gemcutter releases with Jeweler:
 
  * [Create an account on Gemcutter](http://gemcutter.org/sign_up)
- * Install the Gemcutter gem: sudo gem install gemcutter
- * Run 'gemcutter tumble' to set up RubyGems to use gemcutter as the default source
+ * Install the Gemcutter gem: gem install gemcutter
+ * Run 'gem tumble' to set up RubyGems to use gemcutter as the default source if you haven't already
  * Update your Rakefile to make an instance of `Jeweler::GemcutterTasks`
 
 
@@ -113,8 +146,8 @@ A Rakefile setup for gemcutter would include something like this:
 
     begin
       require 'jeweler'
-      Jeweler::Tasks.new do |gem|
-        # ommitted for brevity
+      Jeweler::Tasks.new do |gemspec|
+        # omitted for brevity
       end
       Jeweler::GemcutterTasks.new
     rescue LoadError
@@ -122,11 +155,13 @@ A Rakefile setup for gemcutter would include something like this:
     end
 
 
-With all that setup out of the way, you can now release to Gemcutter with impunity. This would release the current version of your gem.
+After you have configured this, `rake release` will now also release to Gemcutter.
+
+If you need to release it without the rest of the release task, you can run:
 
     $ rake gemcutter:release
 
-## Releasing to RubyForge
+### Releasing to RubyForge
 
 Jeweler can also handle releasing to [RubyForge](http://rubyforge.org). There are a few steps you need to do before doing any RubyForge releases with Jeweler:
 
@@ -144,9 +179,9 @@ A Rakefile setup for rubyforge would include something like this:
 
     begin
       require 'jeweler'
-      Jeweler::Tasks.new do |s|
+      Jeweler::Tasks.new do |gemspec|
         # ommitted for brevity
-        s.rubyforge_project = 'the-perfect-gem' # This line would be new
+        gemspec.rubyforge_project = 'the-perfect-gem' # This line would be new
       end
 
       Jeweler::RubyforgeTasks.new do |rubyforge|
@@ -160,14 +195,14 @@ Now you must initially create a 'package' for your gem in your RubyForge 'projec
 
     $ rake rubyforge:setup
 
-With all that setup out of the way, you can now release to RubyForge with impunity. This would release the current version of your gem, and upload the rdoc as your project's webpage.
+After you have configured this, `rake release` will now also release to RubyForge.
+
+If you need to release it without the rest of the release task, you can run:
 
     $ rake rubyforge:release
 
-## Release Workflow
+## Development and Release Workflow
 
  * Hack, commit, hack, commit, etc, etc
  * `rake version:bump:patch release` to do the actual version bump and release
- * Have a delicious scotch
- * Install [gemstalker](http://github.com/technicalpickles/gemstalker), and use it to know when gem is built. It typically builds in a few minutes, but won't be installable for another 15 minutes.
-
+ * Have a delicious beverage (I suggest scotch)

data/Rakefile

@@ -23,6 +23,10 @@ Jeweler::Tasks.new do |gem|
   gem.add_development_dependency "rr"
   gem.add_development_dependency "mocha"
   gem.add_development_dependency "redgreen"
+  gem.add_development_dependency "devver-construct"
+
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "cucumber"
 end
 
 Jeweler::GemcutterTasks.new
@@ -47,22 +51,18 @@ begin
     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
+  task :yardoc => :check_dependencies
 end
 
 
 begin
   require 'rcov/rcovtask'
-  Rcov::RcovTask.new(:rcov) do |rcov|
+  Rcov::RcovTask.new(:rcov => :check_dependencies) do |rcov|
     rcov.libs << 'test'
     rcov.pattern = 'test/**/test_*.rb'
   end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+rescue
+  task :rcov => :check_dependencies
 end
 
 begin
@@ -76,13 +76,9 @@ begin
     end
   end
 rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
+  task :features => :check_dependencies
   namespace :features do
-    task :pretty do
-      abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-    end
+    task :pretty => :check_dependencies
   end
 end
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
+:minor: 4
 :patch: 0
 :major: 1
-:minor: 3
 :build: 

data/bin/jeweler

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'jeweler/generator'
 
-Jeweler::Generator::Application.run!(*ARGV)
+exit Jeweler::Generator::Application.run!(*ARGV)

data/features/generator/rakefile.feature

@@ -85,13 +85,13 @@ Feature: generated Rakefile
   Scenario: no 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'
+    Then Rakefile does not require 'reek/adapters/rake_task'
     And Rakefile does not instantiate a Reek::RakeTask
 
   Scenario: 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'
+    Then Rakefile requires 'reek/adapters/rake_task'
     And Rakefile instantiates a Reek::RakeTask
 
   Scenario: no roodi

data/features/step_definitions/generator_steps.rb

@@ -126,7 +126,7 @@ end
 Then /^a sane '.gitignore' is created$/ do
   Then "a file named 'the-perfect-gem/.gitignore' is created"
   Then "'coverage' is ignored by git"
-  Then "'*.sw?' is ignored by git"
+  Then "'*.swp' is ignored by git"
   Then "'.DS_Store' is ignored by git"
   Then "'rdoc' is ignored by git"
   Then "'pkg' is ignored by git"

data/jeweler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jeweler}
-  s.version = "1.3.0"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Nichols"]
-  s.date = %q{2009-10-18}
+  s.date = %q{2009-11-19}
   s.default_executable = %q{jeweler}
   s.description = %q{Simple and opinionated helper for creating Rubygem projects on GitHub}
   s.email = %q{josh@technicalpickles.com}
@@ -85,8 +85,6 @@ Gem::Specification.new do |s|
      "lib/jeweler/specification.rb",
      "lib/jeweler/tasks.rb",
      "lib/jeweler/templates/.document",
-     "lib/jeweler/templates/.document",
-     "lib/jeweler/templates/.gitignore",
      "lib/jeweler/templates/.gitignore",
      "lib/jeweler/templates/LICENSE",
      "lib/jeweler/templates/README.rdoc",
@@ -95,10 +93,12 @@ Gem::Specification.new do |s|
      "lib/jeweler/templates/bacon/helper.rb",
      "lib/jeweler/templates/features/default.feature",
      "lib/jeweler/templates/features/support/env.rb",
+     "lib/jeweler/templates/jeweler_tasks.erb",
      "lib/jeweler/templates/micronaut/flunking.rb",
      "lib/jeweler/templates/micronaut/helper.rb",
      "lib/jeweler/templates/minitest/flunking.rb",
      "lib/jeweler/templates/minitest/helper.rb",
+     "lib/jeweler/templates/other_tasks.erb",
      "lib/jeweler/templates/riot/flunking.rb",
      "lib/jeweler/templates/riot/helper.rb",
      "lib/jeweler/templates/rspec/flunking.rb",
@@ -231,6 +231,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rr>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<redgreen>, [">= 0"])
+      s.add_development_dependency(%q<devver-construct>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
     else
       s.add_dependency(%q<git>, [">= 1.2.5"])
       s.add_dependency(%q<rubyforge>, [">= 2.0.0"])
@@ -240,6 +243,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rr>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<redgreen>, [">= 0"])
+      s.add_dependency(%q<devver-construct>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
     end
   else
     s.add_dependency(%q<git>, [">= 1.2.5"])
@@ -250,6 +256,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rr>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<redgreen>, [">= 0"])
+    s.add_dependency(%q<devver-construct>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
   end
 end
 

data/lib/jeweler/commands/install_gem.rb

@@ -1,5 +1,3 @@
-require 'rbconfig'
-
 class Jeweler
   module Commands
     class InstallGem
@@ -11,22 +9,14 @@ class Jeweler
 
 
       def run
-        command = "gem install --local #{gemspec_helper.gem_path}"
+        command = "#{gem_command} install #{gemspec_helper.gem_path}"
         output.puts "Executing #{command.inspect}:"
 
-        sh sudo_wrapper(command) # TODO where does sh actually come from!? - rake, apparently
-      end
-
-      def sudo_wrapper(command)
-        use_sudo? ? "sudo #{command}" : command
-      end
-
-      def use_sudo?
-        host_os !~ /mswin|windows|cygwin/i
+        sh command # TODO where does sh actually come from!? - rake, apparently
       end
 
-      def host_os
-        Config::CONFIG['host_os']
+      def gem_command
+        Config::CONFIG['RUBY_INSTALL_NAME'].sub('ruby', 'gem')
       end
 
       def self.build_for(jeweler)

data/lib/jeweler/generator.rb

@@ -105,8 +105,6 @@ class Jeweler
       if should_create_remote_repo
         create_and_push_repo
         $stdout.puts "Jeweler has pushed your repo to #{homepage}"
-        enable_gem_for_repo
-        #$stdout.puts "Jeweler has enabled gem building for your repo"
       end
     end
 
@@ -194,14 +192,17 @@ class Jeweler
 
     end
 
-    def output_template_in_target(source, destination = source)
-      final_destination = File.join(target_dir, destination)
-
+    def render_template(source)
       template_contents = File.read(File.join(template_dir, source))
-      template = ERB.new(template_contents, nil, '<>')
+      template          = ERB.new(template_contents, nil, '<>')
 
       # squish extraneous whitespace from some of the conditionals
-      template_result = template.result(binding).gsub(/\n\n\n+/, "\n\n")
+      template.result(binding).gsub(/\n\n\n+/, "\n\n")
+    end
+
+    def output_template_in_target(source, destination = source)
+      final_destination = File.join(target_dir, destination)
+      template_result   = render_template(source)
 
       File.open(final_destination, 'w') {|file| file.write(template_result)}
 
@@ -262,23 +263,8 @@ class Jeweler
                                 'token' => github_token,
                                 'description' => summary,
                                 'name' => project_name
-      # TODO do a HEAD request to see when it's ready
+      # TODO do a HEAD request to see when it's ready?
       @repo.push('origin')
     end
-
-    # FIXME This was borked awhile ago, and even more so with gems being disabled
-    def enable_gem_for_repo
-      $stdout.puts "Visit #{homepage}/edit and click 'Enable RubyGems'"
-      #url = "https://github.com/#{github_username}/#{project_name}/update"
-      #`curl -F 'login=#{github_username}' -F 'token=#{github_token}' -F 'field=repository_rubygem' -F 'value=1' #{url} 2>/dev/null`
-  
-      # FIXME use NET::HTTP instead of curl
-      #Net::HTTP.post_form URI.parse(url),
-                                #'login' => github_username,
-                                #'token' => github_token,
-                                #'field' => 'repository_rubygem',
-                                #'value' => '1'
-    end
-
   end
 end