technicalpickles-jeweler 0.9.1 → 0.10.0

data/lib/jeweler/commands/validate_gemspec.rb

@@ -16,6 +16,15 @@ class Jeweler
           raise
         end
       end
+
+      def self.build_for(jeweler)
+        command = new
+
+        command.gemspec_helper = jeweler.gemspec_helper
+        command.output = jeweler.output
+
+        command
+      end
     end
   end
 end

data/lib/jeweler/commands/version/base.rb

@@ -24,6 +24,17 @@ class Jeweler
             self.repo.commit("Version bump to #{self.version_helper.to_s}", 'VERSION.yml')
           end
         end
+
+
+        def self.build_for(jeweler)
+          command = new
+          command.repo = jeweler.repo
+          command.version_helper = jeweler.version_helper
+          command.gemspec = jeweler.gemspec
+          command.commit = jeweler.commit
+
+          command
+        end
       end
     end
   end

data/lib/jeweler/commands/write_gemspec.rb

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

data/lib/jeweler/errors.rb

@@ -5,4 +5,16 @@ class Jeweler
 
    class VersionYmlError < StandardError
    end
-end
+
+   # Occurs when interacting with RubyForge, and an expected project isn't available on RubyForge.
+   class MissingRubyForgePackageError < StandardError
+   end
+
+   # Occurs when interacting with RubyForge, and 'rubyforge_project' isn't set on the Gem::Specification
+   class NoRubyForgeProjectInGemspecError < StandardError
+   end
+
+   # Occurs when interacting with RubyForge, and the 'rubyforge_project' isn't setup in ~/.rubyforge/autoconfig.yml or it doesn't exist on RubyForge
+   class RubyForgeProjectNotConfiguredError < StandardError
+   end
+end

data/lib/jeweler/generator.rb

@@ -23,7 +23,7 @@ class Jeweler
   class Generator    
     attr_accessor :target_dir, :user_name, :user_email, :summary, :testing_framework,
                   :github_repo_name, :github_username, :github_token,
-                  :repo, :should_create_repo, :should_use_cucumber
+                  :repo, :should_create_repo, :should_use_cucumber, :should_setup_rubyforge
 
     SUPPORTED_TESTING_FRAMEWORKS = [:shoulda, :testunit, :bacon, :rspec, :micronaut, :minitest]
 
@@ -44,6 +44,7 @@ class Jeweler
       self.should_create_repo = options[:create_repo]
       self.summary            = options[:summary] || 'TODO'
       self.should_use_cucumber= options[:use_cucumber]
+      self.should_setup_rubyforge = options[:rubyforge]
 
       use_user_git_config
       
@@ -209,6 +210,7 @@ class Jeweler
       output_template_in_target 'Rakefile'
       output_template_in_target 'LICENSE'
       output_template_in_target 'README.rdoc'
+      output_template_in_target '.document'
 
       mkdir_in_target           lib_dir
       touch_in_target           File.join(lib_dir, "#{file_name_prefix}.rb")

data/lib/jeweler/generator/options.rb

@@ -43,6 +43,10 @@ class Jeweler
             self[:create_repo] = true
           end
 
+          o.on('--rubyforge', 'setup project for rubyforge') do
+            self[:rubyforge] = true
+          end
+
           o.on('--summary [SUMMARY]', 'specify the summary of the project') do |summary|
             self[:summary] = summary
           end

data/lib/jeweler/tasks.rb

@@ -28,7 +28,7 @@ class Jeweler
       end
 
       desc "Install gem using sudo"
-      task :install do
+      task :install => :build do
         @jeweler.install_gem
       end
 
@@ -48,14 +48,11 @@ class Jeweler
       end
 
       desc "Displays the current version"
-      task :version => 'version:setup' do
+      task :version => 'VERSION.yml' do
         $stdout.puts "Current version: #{@jeweler.version}"
       end
 
       namespace :version do
-        desc "Setup initial version of 0.0.0"
-        task :setup => "VERSION.yml"
-
         desc "Writes out an explicit version. Respects the following environment variables, or defaults to 0: MAJOR, MINOR, PATCH"
         task :write do
           major, minor, patch = ENV['MAJOR'].to_i, ENV['MINOR'].to_i, ENV['PATCH'].to_i
@@ -88,6 +85,33 @@ class Jeweler
       task :release do
         @jeweler.release
       end
+      
+      namespace :rubyforge do
+        namespace :release do
+          desc "Release the current gem version to RubyForge."
+          task :gem => [:gemspec, :build] do
+            begin
+              @jeweler.release_gem_to_rubyforge
+            rescue NoRubyForgeProjectInGemspecError => e
+              abort "Setting up RubyForge requires that you specify a 'rubyforge_project' in your Jeweler::Tasks declaration"
+            rescue RubyForgeProjectNotConfiguredError => e
+              abort "The RubyForge reported that #{e.message} wasn't configured. This means you need to run 'rubyforge setup', 'rubyforge login', and 'rubyforge configure', or maybe the project doesn't exist on RubyForge"
+            end
+          end
+        end
+
+        desc "Setup a rubyforge project for this gem"
+        task :setup do
+          begin 
+            @jeweler.setup_rubyforge
+          rescue NoRubyForgeProjectInGemspecError => e
+            abort "Setting up RubyForge requires that you specify a 'rubyforge_project' in your Jeweler::Tasks declaration"
+          rescue RubyForgeProjectNotConfiguredError => e
+            abort "The RubyForge reported that #{e.message} wasn't configured. This means you need to run 'rubyforge setup', 'rubyforge login', and 'rubyforge configure', or maybe the project doesn't exist on RubyForge"
+          end
+        end
+
+      end
     end
   end
 end

data/lib/jeweler/templates/Rakefile

@@ -9,21 +9,15 @@ begin
     gem.email = "<%= user_email %>"
     gem.homepage = "<%= github_url %>"
     gem.authors = ["<%= user_name %>"]
+<% if should_setup_rubyforge %>
+    gem.rubyforge_project = "<%= github_repo_name %>"
+  <% end %>
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = '<%= github_repo_name %>'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 <% case testing_framework.to_sym %>
 <% when :rspec %>
 require 'spec/rake/spectask'
@@ -86,3 +80,46 @@ end
 <% end %>
 
 task :default => :<%= default_task %>
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "<%= github_repo_name %> #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+<% if should_setup_rubyforge %>
+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/<%= github_repo_name %>/"
+        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
+<% end %>

data/test/fixtures/existing-project-with-version/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Josh Nichols
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/test/fixtures/existing-project-with-version/README.rdoc

@@ -0,0 +1,7 @@
+= existing-project-with-version
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Josh Nichols. See LICENSE for details.

data/test/fixtures/existing-project-with-version/Rakefile

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "existing-project-with-version"
+    gem.summary = %Q{TODO}
+    gem.email = "josh@technicalpickles.com"
+    gem.homepage = "http://github.com/technicalpickles/existing-project-with-version"
+    gem.authors = ["Josh Nichols"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "existing-project-with-version #{version}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Rubyforge documentation task
+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/existing-project-with-version/"
+        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

data/test/fixtures/existing-project-with-version/VERSION.yml

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

data/test/fixtures/existing-project-with-version/existing-project-with-version.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{existing-project-with-version}
+  s.version = "1.5.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh Nichols"]
+  s.date = %q{2009-03-13}
+  s.email = %q{josh@technicalpickles.com}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+  s.files = ["README.rdoc", "VERSION.yml", "lib/existing_project_with_version.rb", "test/existing_project_with_version_test.rb", "test/test_helper.rb", "LICENSE"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/technicalpickles/existing-project-with-version}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/fixtures/existing-project-with-version/test/existing_project_with_version_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ExistingProjectWithVersionTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/fixtures/existing-project-with-version/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'existing_project_with_version'
+
+class Test::Unit::TestCase
+end

data/test/geminstaller.yml

@@ -0,0 +1,12 @@
+# Dependencies required to run the test suite
+gems:
+- name: rspec
+  version: '~> 1.1.12'
+- name: Shoulda
+  version: '~> 1.2.0'
+- name: ruby-debug
+  version: '~> 0.10.3'
+- name: rr
+  version: '~> 0.7.1'
+- name: mhennemeyer-output_catcher
+  version: '~> 1.0.1'

data/test/jeweler/commands/test_build_gem.rb

@@ -1,4 +1,5 @@
-require 'test_helper'
+# not sure why I need to use this form instead of just require 'test_helper'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_helper'))
 
 class Jeweler
   module Commands
@@ -48,6 +49,24 @@ class Jeweler
         end
       end
 
+      build_command_context "build for jeweler" do
+        setup do
+          @command = Jeweler::Commands::BuildGem.build_for(@jeweler)
+        end
+
+        should "assign base_dir" do
+          assert_same @base_dir, @jeweler.base_dir
+        end
+
+        should "assign gemspec_helper" do
+          assert_same @gemspec_helper, @jeweler.gemspec_helper
+        end
+
+        should "return BuildGem" do
+          assert_kind_of Jeweler::Commands::BuildGem, @command
+        end
+      end
+
     end
   end
 end