technicalpickles-jeweler 0.9.1 → 0.10.0

data/ChangeLog.markdown

@@ -1,4 +1,10 @@
 # jeweler x.y.z
+ 
+ * 'rake install' now will 'rake build' first
+ * Support for releasing to RubyForge, thanks to jtrupiano
+ * Steps towards Ruby 1.9 support, thanks to rsanheim
+
+# jeweler 0.9.1 2009-03-05
 
  * Tasks:
   * Fixed populating default spec's extra_rdoc_files

data/README.markdown

@@ -48,6 +48,7 @@ It supports a number of options:
  * --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
+ * --rubyfoge: setup releasing to rubyforge
 
 ## Gemspec
 
@@ -74,7 +75,7 @@ Initially, your project starts out at 0.0.0. Jeweler provides Rake tasks for bum
     rake version:bump:minor
     rake version:bump:patch
 
-## Releasing
+## Releasing to GitHub
 
 Jeweler handles releasing your gem into the wild:
 
@@ -86,12 +87,76 @@ It does the following for you:
  * Push to GitHub (which results in a gem being build)
  * Tag the version and push to GitHub
 
+## 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:
+
+ * [Create an account on RubyForge](http://rubyforge.org/account/register.php)
+ * Request a project on RubyForge. This involves waiting for a project approval, which can take any amount of time from a few hours to a week
+   * You might want to create an umbrella project where you can publish your gems, instead of one project per gem
+ * Install the RubyForge gem: sudo gem install rubyforge
+ * Run 'rubyforge setup' and fill in your username and password for RubyForge
+ * Run 'rubyforge config' to pull down information about your projects
+ * Run 'rubyforge login' to make sure you are able to login
+
+With this in place, you now update your Jeweler::Tasks to setup `rubyforge_project` with the RubyForge project you've just created. (Note, using `jeweler --rubyforge` when generating the project does this for you automatically.)
+
+    begin
+      require 'jeweler'
+      Jeweler::Tasks.new do |s|
+        s.name = "the-perfect-gem"
+        s.summary = "TODO"
+        s.email = "josh@technicalpickles.com"
+        s.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+        s.description = "TODO"
+        s.authors = ["Josh Nichols"]
+        s.rubyforge_project = 'the-perfect-gem' # This line would be new
+      end
+    rescue LoadError
+      puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+    end
+
+    # These are new tasks
+    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/the-perfect-gem/"
+            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
+
+Now you must initially create a 'package' for your gem in your 'project':
+
+    $ 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.
+
+    $ rake rubyforge: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
- * Go to [Has My Gem Built Yet](http://hasmygembuiltyet.org) and wait for your gem to be built
+ * 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.
 
 ## Links
 

data/Rakefile

@@ -11,8 +11,9 @@ begin
     gem.homepage = "http://github.com/technicalpickles/jeweler"
     gem.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
     gem.authors = ["Josh Nichols"]
-    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
-    gem.add_dependency 'schacon-git'
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.documena', 'lib/jeweler/templates/.gitignore']
+    gem.add_dependency "peterwald-git"
+    gem.rubyforge_project = "pickles"
   end
 rescue LoadError
   puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
@@ -22,13 +23,14 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_*.rb'
   test.libs << 'test'
+  test.verbose = true
+  #test.ruby_opts << '-rtest_helper'
 end
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'jeweler'
-  rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README.markdown')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
@@ -54,6 +56,32 @@ 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

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 9
-:patch: 1
 :major: 0
+:minor: 10
+:patch: 0

data/lib/jeweler.rb

@@ -1,9 +1,11 @@
 require 'date'
+require 'rubygems/user_interaction'
 require 'rubygems/builder'
+require 'rubyforge'
 
+require 'jeweler/errors'
 require 'jeweler/version_helper'
 require 'jeweler/gemspec_helper'
-require 'jeweler/errors'
 require 'jeweler/generator'
 require 'jeweler/generator/options'
 require 'jeweler/generator/application'
@@ -15,8 +17,8 @@ require 'jeweler/tasks'
 # A Jeweler helps you craft the perfect Rubygem. Give him a gemspec, and he takes care of the rest.
 class Jeweler
 
-  attr_reader :gemspec, :gemspec_helper
-  attr_accessor :base_dir, :output
+  attr_reader :gemspec, :gemspec_helper, :version_helper
+  attr_accessor :base_dir, :output, :repo, :commit, :rubyforge
 
   def initialize(gemspec, base_dir = '.')
     raise(GemspecError, "Can't create a Jeweler with a nil gemspec") if gemspec.nil?
@@ -24,9 +26,11 @@ class Jeweler
     @base_dir       = base_dir
     @gemspec        = fill_in_gemspec_defaults(gemspec)
     @repo           = Git.open(base_dir) if in_git_repo?
-    @version_helper        = Jeweler::VersionHelper.new(@base_dir)
+    @version_helper = Jeweler::VersionHelper.new(@base_dir)
     @output         = $stdout
-    @gemspec_helper = GemSpecHelper.new(@gemspec,base_dir)
+    @commit         = true
+    @gemspec_helper = GemSpecHelper.new(@gemspec, base_dir)
+    @rubyforge      = RubyForge.new
   end
 
   # Major version, as defined by the gemspec's Version module.
@@ -54,13 +58,13 @@ class Jeweler
 
   # Writes out the gemspec
   def write_gemspec
-    build_command(Jeweler::Commands::WriteGemspec).run
+    Jeweler::Commands::WriteGemspec.build_for(self).run
   end
 
   # Validates the project's gemspec from disk in an environment similar to how 
   # GitHub would build from it. See http://gist.github.com/16215
   def validate_gemspec
-    build_command(Jeweler::Commands::ValidateGemspec).run
+    Jeweler::Commands::ValidateGemspec.build_for(self).run
   end
 
   # is the project's gemspec from disk valid?
@@ -69,37 +73,37 @@ class Jeweler
   end
 
   def build_gem
-    build_command(Jeweler::Commands::BuildGem).run
+    Jeweler::Commands::BuildGem.build_for(self).run
   end
 
   def install_gem
-    build_command(Jeweler::Commands::InstallGem).run
+    Jeweler::Commands::InstallGem.build_for(self).run
   end
 
   # Bumps the patch version.
   #
   # 1.5.1 -> 1.5.2
-  def bump_patch_version(options = {})
-    build_command(Jeweler::Commands::Version::BumpPatch).run
+  def bump_patch_version()
+    Jeweler::Commands::Version::BumpPatch.build_for(self).run
   end
 
   # Bumps the minor version.
   #
   # 1.5.1 -> 1.6.0
-  def bump_minor_version(options = {})
-    build_command(Jeweler::Commands::Version::BumpMinor).run
+  def bump_minor_version()
+    Jeweler::Commands::Version::BumpMinor.build_for(self).run
   end
 
   # Bumps the major version.
   #
   # 1.5.1 -> 2.0.0
-  def bump_major_version(options = {})
-    build_command(Jeweler::Commands::Version::BumpMajor).run
+  def bump_major_version()
+    Jeweler::Commands::Version::BumpMajor.build_for(self).run
   end
 
   # Bumps the version, to the specific major/minor/patch version, writing out the appropriate version.rb, and then reloads it.
   def write_version(major, minor, patch, options = {})
-    command = build_command(Jeweler::Commands::Version::Write)
+    command = Jeweler::Commands::Version::Write.build_for(self)
     command.major = major
     command.minor = minor
     command.patch = patch
@@ -108,29 +112,24 @@ class Jeweler
   end
 
   def release
-    build_command(Jeweler::Commands::Release).run
+    Jeweler::Commands::Release.build_for(self).run
+  end
+  
+  def release_gem_to_rubyforge
+    Jeweler::Commands::ReleaseToRubyforge.build_for(self).run
   end
 
-  protected
-
-  def build_command(command_class)
-    command = command_class.new
-    command.repo = @repo if command.respond_to?(:repo=)
-    command.version_helper = @version_helper if command.respond_to?(:version_helper=)
-    command.gemspec = @gemspec if command.respond_to?(:gemspec=)
-    command.commit = true if command.respond_to?(:commit=)
-    command.version = self.version if command.respond_to?(:version=)
-    command.output = output if command.respond_to?(:output=)
-    command.base_dir = @base_dir if command.respond_to?(:base_dir=)
-    command.gemspec_helper = GemSpecHelper.new(@gemspec, @base_dir) if command.respond_to?(:gemspec_helper)
-
-    command
+  def setup_rubyforge
+    Jeweler::Commands::SetupRubyforge.build_for(self).run
   end
 
+
   def in_git_repo?
     File.exists?(File.join(self.base_dir, '.git'))
   end
 
+  protected
+
   def fill_in_gemspec_defaults(gemspec)
     if gemspec.files.nil? || gemspec.files.empty?
       gemspec.files = FileList["[A-Z]*.*", "{bin,generators,lib,test,spec}/**/*"]

data/lib/jeweler/commands.rb

@@ -1,6 +1,8 @@
 require 'jeweler/commands/build_gem'
 require 'jeweler/commands/install_gem'
 require 'jeweler/commands/release'
+require 'jeweler/commands/release_to_rubyforge'
+require 'jeweler/commands/setup_rubyforge'
 require 'jeweler/commands/validate_gemspec'
 require 'jeweler/commands/write_gemspec'
 require 'jeweler/commands/version/base'

data/lib/jeweler/commands/build_gem.rb

@@ -17,6 +17,15 @@ class Jeweler
         gem_file_name = File.join(base_dir, gem_file_name)
         file_utils.mv gem_file_name, pkg_dir
       end
+
+      def self.build_for(jeweler)
+        command = new
+
+        command.base_dir = jeweler.base_dir
+        command.gemspec_helper = jeweler.gemspec_helper
+
+        command
+      end
     end
   end
 end

data/lib/jeweler/commands/install_gem.rb

@@ -14,6 +14,13 @@ class Jeweler
 
         sh command # TODO where does sh actually come from!?
       end
+
+      def self.build_for(jeweler)
+        command = new
+        command.output = jeweler.output
+        command.gemspec_helper = jeweler.gemspec_helper
+        command
+      end
     end
   end
 end

data/lib/jeweler/commands/release.rb

@@ -41,6 +41,19 @@ class Jeweler
         @gemspec_helper ||= Jeweler::GemSpecHelper.new(self.gemspec, self.base_dir)
       end
 
+      def self.build_for(jeweler)
+        command = self.new
+
+        command.base_dir = jeweler.base_dir
+        command.gemspec = jeweler.gemspec
+        command.version = jeweler.version
+        command.repo = jeweler.repo
+        command.output = jeweler.output
+        command.gemspec_helper = jeweler.gemspec_helper
+
+        command
+      end
+
     end
   end
 end

data/lib/jeweler/commands/release_to_rubyforge.rb

@@ -0,0 +1,51 @@
+require 'rubyforge'
+
+class Jeweler
+  module Commands
+    class ReleaseToRubyforge
+      attr_accessor :gemspec, :version, :output, :gemspec_helper, :rubyforge
+
+      def initialize
+        self.output = $stdout
+      end
+
+      def run
+        raise NoRubyForgeProjectInGemspecError unless @gemspec.rubyforge_project
+        
+        @rubyforge.configure rescue nil
+
+        output.puts 'Logging in rubyforge'
+        @rubyforge.login
+
+        @rubyforge.userconfig['release_notes'] = @gemspec.description if @gemspec.description
+        @rubyforge.userconfig['preformatted'] = true
+
+        output.puts "Releasing #{@gemspec.name}-#{@version} to #{@gemspec.rubyforge_project}"
+        begin
+          @rubyforge.add_release(@gemspec.rubyforge_project, @gemspec.name, @version.to_s, @gemspec_helper.gem_path)
+        rescue StandardError => e
+          case e.message
+          when /no <group_id> configured for <#{Regexp.escape @gemspec.rubyforge_project}>/
+            raise RubyForgeProjectNotConfiguredError, @gemspec.rubyforge_project
+          when /no <package_id> configured for <#{Regexp.escape @gemspec.name}>/i
+            raise MissingRubyForgePackageError, @gemspec.name
+          else
+            raise
+          end
+        end
+      end
+
+      def self.build_for(jeweler)
+        command = new
+        command.gemspec = jeweler.gemspec
+        command.gemspec_helper = jeweler.gemspec_helper
+        command.version = jeweler.version
+        command.rubyforge = jeweler.rubyforge
+        command.output = jeweler.output
+
+        command
+      end
+      
+    end
+  end
+end

data/lib/jeweler/commands/setup_rubyforge.rb

@@ -0,0 +1,38 @@
+class Jeweler
+  module Commands
+    class SetupRubyforge
+      attr_accessor :gemspec, :output, :rubyforge
+
+      def run
+        raise NoRubyForgeProjectInGemspecError unless @gemspec.rubyforge_project
+
+        @rubyforge.configure
+
+        output.puts "Logging into rubyforge"
+        @rubyforge.login
+
+        output.puts "Creating #{@gemspec.name} package in the #{@gemspec.rubyforge_project} project"
+        begin
+          @rubyforge.create_package(@gemspec.rubyforge_project, @gemspec.name)
+        rescue StandardError => e
+          case e.message
+          when /no <group_id> configured for <#{Regexp.escape @gemspec.rubyforge_project}>/
+            raise RubyForgeProjectNotConfiguredError, @gemspec.rubyforge_project
+          else
+            raise
+          end
+        end
+      end
+
+      def self.build_for(jeweler)
+        command = new
+
+        command.gemspec = jeweler.gemspec
+        command.output = jeweler.output
+        command.rubyforge = jeweler.rubyforge
+
+        command
+      end
+    end
+  end
+end