jeweler 1.0.2 → 1.1.0

data/lib/jeweler/commands/install_gem.rb

@@ -1,3 +1,5 @@
+require 'rbconfig'
+
 class Jeweler
   module Commands
     class InstallGem
@@ -9,10 +11,22 @@ class Jeweler
 
 
       def run
-        command = "sudo gem install #{gemspec_helper.gem_path}"
+        command = "gem install #{gemspec_helper.gem_path}"
         output.puts "Executing #{command.inspect}:"
 
-        sh command # TODO where does sh actually come from!?
+        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
+      end
+
+      def host_os
+        Config::CONFIG['host_os']
       end
 
       def self.build_for(jeweler)

data/lib/jeweler/commands/release.rb

@@ -12,7 +12,7 @@ class Jeweler
       end
 
       def run
-        raise "Hey buddy, try committing them files first" if any_pending_changes?
+        raise "Hey buddy, try committing them files first" unless clean_staging_area?
 
         repo.checkout('master')
 
@@ -22,11 +22,12 @@ class Jeweler
         output.puts "Pushing master to origin"
         repo.push
 
-        tag_release! unless release_tagged?
+        tag_release! if release_not_tagged?
       end
       
-      def any_pending_changes?
-        !(@repo.status.added.empty? && @repo.status.deleted.empty? && @repo.status.changed.empty?)
+      def clean_staging_area?
+        status = repo.status
+        status.added.empty? && status.deleted.empty? && status.changed.empty?
       end
 
       def tag_release!
@@ -52,13 +53,15 @@ class Jeweler
         "v#{version}"
       end
 
-      def release_tagged?
+      def release_not_tagged?
         tag = repo.tag(release_tag) rescue nil
-        ! tag.nil?
+        tag.nil?
       end
 
       def gemspec_changed?
-        any_pending_changes?
+        `git status` # OMGHAX. status always ends up being 'M' unless this runs
+        status = repo.status[gemspec_helper.path]
+        ! status.type.nil?
       end
 
       def gemspec_helper

data/lib/jeweler/commands/setup_rubyforge.rb

@@ -11,7 +11,26 @@ class Jeweler
         output.puts "Logging into rubyforge"
         @rubyforge.login
 
+        if package_exists?
+          output.puts "#{@gemspec.name} package already exists in the #{@gemspec.rubyforge_project} project"
+          return
+        end
+
         output.puts "Creating #{@gemspec.name} package in the #{@gemspec.rubyforge_project} project"
+        create_package
+      end
+
+      def package_exists?
+        begin
+          @rubyforge.lookup 'package', @gemspec.name
+          true
+        rescue RuntimeError => e
+          raise unless e.message == "no <package_id> configured for <#{@gemspec.name}>"
+          false
+        end
+      end
+
+      def create_package
         begin
           @rubyforge.create_package(@gemspec.rubyforge_project, @gemspec.name)
         rescue StandardError => e

data/lib/jeweler/gemspec_helper.rb

@@ -30,6 +30,9 @@ class Jeweler
         gemspec_ruby = prettyify_array(gemspec_ruby, :files)
         gemspec_ruby = prettyify_array(gemspec_ruby, :test_files)
         gemspec_ruby = prettyify_array(gemspec_ruby, :extra_rdoc_files)
+        f.puts "# Generated by jeweler"
+        f.puts "# DO NOT EDIT THIS FILE"
+        f.puts "# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`"
         f.write gemspec_ruby
       end 
     end

data/lib/jeweler/generator.rb

@@ -28,13 +28,16 @@ class Jeweler
   end    
 
   class Generator    
-    attr_accessor :target_dir, :user_name, :user_email, :summary, :testing_framework,
+    attr_accessor :target_dir, :user_name, :user_email, :summary,
                   :project_name, :github_username, :github_token,
-                  :repo, :should_create_repo, :should_use_cucumber, :should_setup_rubyforge,
+                  :repo, :should_create_repo, 
+                  :testing_framework, :documentation_framework,
+                  :should_use_cucumber, :should_setup_rubyforge,
                   :should_use_reek, :should_use_roodi,
                   :description
 
     DEFAULT_TESTING_FRAMEWORK = :shoulda
+    DEFAULT_DOCUMENTATION_FRAMEWORK = :rdoc
 
     def initialize(project_name, options = {})
       if project_name.nil? || project_name.squeeze.strip == ""
@@ -44,6 +47,7 @@ class Jeweler
       self.project_name   = project_name
 
       self.testing_framework  = (options[:testing_framework] || DEFAULT_TESTING_FRAMEWORK).to_sym
+      self.documentation_framework = options[:documentation_framework] || DEFAULT_DOCUMENTATION_FRAMEWORK
       begin
         generator_mixin_name = "#{self.testing_framework.to_s.capitalize}Mixin"
         generator_mixin = self.class.const_get(generator_mixin_name)
@@ -127,14 +131,19 @@ class Jeweler
       File.join(features_dir, 'step_definitions')
     end
 
+    def doc_task
+      case documentation_framework
+      when :yard then "yardoc"
+      else
+        documentation_framework.to_s
+      end
+    end
+
   protected
 
     # This is in a separate method so we can stub it out during testing
     def read_git_config
-      # we could just use Git::Base's .config, but that relies on a repo being around already
-      # ... which we don't have yet, since this is part of a sanity check
-      lib = Git::Lib.new(nil, nil)
-      config = lib.parse_config '~/.gitconfig'
+      Git.global_config
     end
 
   private

data/lib/jeweler/generator/options.rb

@@ -7,7 +7,8 @@ class Jeweler
         super()
 
         @orig_args = args.clone
-        self[:testing_framework] = :shoulda
+        self[:testing_framework]       = :shoulda
+        self[:documentation_framework] = :rdoc
 
         @opts = OptionParser.new do |o|
           o.banner = "Usage: #{File.basename($0)} [options] reponame\ne.g. #{File.basename($0)} the-perfect-gem"
@@ -68,6 +69,14 @@ class Jeweler
             self[:directory] = directory
           end
 
+          o.on('--yard', 'use yard for documentation') do
+            self[:documentation_framework] = :yard
+          end
+
+          o.on('--rdoc', 'use rdoc for documentation') do
+            self[:documentation_framework] = :rdoc
+          end
+
           o.on_tail('-h', '--help', 'display this help and exit') do
             self[:show_help] = true
           end

data/lib/jeweler/rubyforge_tasks.rb

@@ -4,8 +4,29 @@ require 'rake/contrib/sshpublisher'
 
 
 class Jeweler
+  # Rake tasks for putting a Jeweler gem on Rubyforge.
+  #
+  # Jeweler::Tasks.new needs to be used before this.
+  #
+  # Basic usage:
+  #
+  #     Jeweler::RubyforgeTasks.new
+  #
+  # Easy enough, right?
+  # 
+  # There are a few options you can tweak:
+  #
+  #  * project: the rubyforge project to operate on. This defaults to whatever you specified in your gemspec. Defaults to your gem name.
+  #  * remote_doc_path: the place to upload docs to on Rubyforge under /var/www/gforge-projects/#{project}/
+  #
   class RubyforgeTasks < ::Rake::TaskLib
-    attr_accessor :project, :remote_doc_path
+    # The RubyForge project to interact with. Defaults to whatever is in your jeweler gemspec.
+    attr_accessor :project
+    # The path to upload docs to. It is relative to /var/www/gforge-projects/#{project}/, and defaults to your gemspec's name
+    attr_accessor :remote_doc_path
+    # Task to be used for generating documentation, before they are uploaded. Defaults to rdoc.
+    attr_accessor :doc_task
+
     attr_accessor :jeweler
 
     def initialize
@@ -15,6 +36,7 @@ class Jeweler
 
       self.remote_doc_path ||= jeweler.gemspec.name
       self.project ||= jeweler.gemspec.rubyforge_project
+      self.doc_task ||= :rdoc
 
       define
     end
@@ -26,21 +48,51 @@ class Jeweler
         task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
 
         namespace :release do
-          desc "Publish RDoc to RubyForge."
-          task :docs => [:rdoc] 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 MissingRubyForgePackageError => e
+              abort "Rubyforge reported that the #{e.message} package isn't setup. Run rake rubyforge:setup to do so."
+            rescue RubyForgeProjectNotConfiguredError => e
+              abort "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
+
+          desc "Publish docs to RubyForge."
+          task :docs => doc_task do
             config = YAML.load(
               File.read(File.expand_path('~/.rubyforge/user-config.yml'))
             )
 
             host = "#{config['username']}@rubyforge.org"
             remote_dir = "/var/www/gforge-projects/#{project}/#{remote_doc_path}"
-            local_dir = 'rdoc'
+
+            local_dir = case self.doc_task.to_sym
+                        when :rdoc then 'rdoc'
+                        when :yardoc then 'doc'
+                        else
+                          raise "Unsure what to run to generate documentation. Please set doc_task and re-run."
+                        end
 
             sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
           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/specification.rb

@@ -31,12 +31,12 @@ class Jeweler
           self.files = repo.ls_files.keys - repo.lib.ignored_files
         end
 
-        if blank?(test_files)
+        if blank?(test_files) && File.directory?(File.join(base_dir, '.git'))
           repo = Git.open(base_dir)
           self.test_files = FileList['{spec,test,examples}/**/*.rb'] - repo.lib.ignored_files
         end
 
-        if blank?(executable)
+        if blank?(executables)
           self.executables = Dir["bin/*"].map { |f| File.basename(f) }
         end
 

data/lib/jeweler/tasks.rb

@@ -6,6 +6,28 @@ class Rake::Application
 end
 
 class Jeweler
+  # Rake tasks for managing your gem.
+  #
+  # Here's a basic example of using it:
+  #
+  #   Jeweler::Tasks.new do |gem|
+  #     gem.name = "jeweler"
+  #     gem.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  #     gem.email = "josh@technicalpickles.com"
+  #     gem.homepage = "http://github.com/technicalpickles/jeweler"
+  #     gem.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+  #     gem.authors = ["Josh Nichols"]
+  #   end
+  #
+  # The block variable gem is actually a Gem::Specification, so you can do anything you would normally do with a Gem::Specification. For more details, see the official gemspec reference: http://docs.rubygems.org/read/chapter/20
+  #
+  # Jeweler fills in a few reasonable defaults for you:
+  #
+  # [gem.files] a Rake::FileList of anything that is in git and not gitignored. You can include/exclude this default set, or override it entirely
+  # [gem.test_files] Similar to gem.files, except it's only things under the spec, test, or examples directory.
+  # [gem.extra_rdoc_files] a Rake::FileList including files like README*, ChangeLog*, and LICENSE*
+  # [gem.executables] uses anything found in the bin/ directory. You can override this.
+  #
   class Tasks < ::Rake::TaskLib
     attr_accessor :gemspec, :jeweler
 
@@ -90,34 +112,6 @@ class Jeweler
         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 MissingRubyForgePackageError => e
-              abort "Rubyforge reported that the #{e.message} package isn't setup. Run rake rubyforge:setup to do so."
-            rescue RubyForgeProjectNotConfiguredError => e
-              abort "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

@@ -17,7 +17,9 @@ begin
   end
 
 <% if should_setup_rubyforge %>
-  Jeweler::RubyforgeTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "<%= doc_task %>"
+  end
 <% end %>
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
@@ -115,11 +117,12 @@ end
 
 task :default => :<%= default_task %>
 
+<% case documentation_framework %>
+<% when :rdoc %>
 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]}"
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
   else
     version = ""
   end
@@ -129,4 +132,13 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
+<% when :yard %>
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+<% end %>

data/test/jeweler/commands/test_install_gem.rb

@@ -3,6 +3,59 @@ require 'test_helper'
 class Jeweler
   module Commands
     class TestInstallGem < Test::Unit::TestCase
+      rubyforge_command_context "running" do
+        setup do
+          stub(@gemspec_helper).gem_path { 'pkg/zomg-1.1.1.gem' } 
+          stub(@command).sudo_wrapper { 'sudo gem install pkg/zomg-1.1.1.gem' }
+          stub(@command).sh
+
+          @command.run
+        end
+
+        should "call sudo wrapper with gem install" do
+          assert_received(@command) {|command| command.sudo_wrapper('gem install pkg/zomg-1.1.1.gem') }
+        end
+
+        should "call sh with output of sudo wrapper" do
+          assert_received(@command) {|command| command.sh 'sudo gem install pkg/zomg-1.1.1.gem' }
+        end
+      end
+
+      rubyforge_command_context "use_sudo?" do
+        should "be false on mswin" do
+          stub(@command).host_os { "i386-mswin32" }
+          assert ! @command.use_sudo?
+        end
+
+        should "be false on windows" do
+          stub(@command).host_os { "windows" }
+          assert ! @command.use_sudo?
+        end
+
+        should "be false on cygwin" do
+          stub(@command).host_os { "cygwin" }
+          assert ! @command.use_sudo?
+        end
+
+        should "be true on basically anything else" do
+          stub(@command).host_os { "darwin9" }
+          assert @command.use_sudo?
+        end
+      end
+
+      rubyforge_command_context "sudo_wrapper" do
+        should "prefix sudo if needed" do
+          stub(@command).use_sudo? { true }
+          assert_equal "sudo blarg", @command.sudo_wrapper("blarg")
+        end
+
+        should "not prefix with sudo if unneeded" do
+          stub(@command).use_sudo? { false }
+          assert_equal "blarg", @command.sudo_wrapper("blarg")
+        end
+      end
+      
+
       build_command_context "build for jeweler" do
         setup do
           @command = Jeweler::Commands::InstallGem.build_for(@jeweler)