dima-jeweler 0.9.2 → 1.2.0

data/lib/jeweler/commands/setup_rubyforge.rb

@@ -0,0 +1,57 @@
+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
+
+        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
+          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

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

@@ -20,10 +20,21 @@ class Jeweler
 
         def commit_version
           if self.repo
-            self.repo.add('VERSION.yml')
-            self.repo.commit("Version bump to #{self.version_helper.to_s}", 'VERSION.yml')
+            self.repo.add(version_helper.path)
+            self.repo.commit("Version bump to #{self.version_helper.to_s}")
           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/gemspec_helper.rb

@@ -19,10 +19,21 @@ class Jeweler
         false
       end
     end
-    
+
     def write
+      normalize_files(:files)
+      normalize_files(:files)
+      normalize_files(:extra_rdoc_files)
+
       File.open(path, 'w') do |f|
-        f.write @spec.to_ruby
+        gemspec_ruby = @spec.to_ruby
+        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
 
@@ -35,10 +46,27 @@ class Jeweler
     def parse
       data = File.read(path)
       parsed_gemspec = nil
-      Thread.new { parsed_gemspec = eval("$SAFE = 3\n#{data}", binding, path) }.join 
+      Thread.new { parsed_gemspec = eval("$SAFE = 3\n#{data}", binding, path) }.join
       parsed_gemspec
     end
 
+    def normalize_files(array_name)
+      array = @spec.send(array_name)
+      # only keep files, no directories, and sort
+      array = array.select do |path|
+        File.file? File.join(@base_dir, path)
+      end.sort
+
+      @spec.send("#{array_name}=", array)
+    end
+
+    def prettyify_array(gemspec_ruby, array_name)
+      gemspec_ruby.gsub(/s\.#{array_name.to_s} = \[.+?\]/) do |match|
+        leadin, files = match[0..-2].split("[")
+        leadin + "[\n    #{files.split(",").join(",\n    ")}\n  ]"
+      end
+    end
+
     def gem_path
       File.join(@base_dir, 'pkg', parse.file_name)
     end

data/lib/jeweler/generator.rb

@@ -4,6 +4,16 @@ require 'erb'
 require 'net/http'
 require 'uri'
 
+require 'jeweler/generator/bacon_mixin'
+require 'jeweler/generator/micronaut_mixin'
+require 'jeweler/generator/minitest_mixin'
+require 'jeweler/generator/rspec_mixin'
+require 'jeweler/generator/shoulda_mixin'
+require 'jeweler/generator/testunit_mixin'
+
+require 'jeweler/generator/rdoc_mixin'
+require 'jeweler/generator/yard_mixin'
+
 class Jeweler
   class NoGitUserName < StandardError
   end
@@ -21,29 +31,56 @@ class Jeweler
   end    
 
   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
-
-    SUPPORTED_TESTING_FRAMEWORKS = [:shoulda, :testunit, :bacon, :rspec, :micronaut, :minitest]
-
-    def initialize(github_repo_name, options = {})
-      if github_repo_name.nil? || github_repo_name.squeeze.strip == ""
+    attr_accessor :target_dir, :user_name, :user_email, :summary,
+                  :description, :project_name, :github_username, :github_token,
+                  :repo, :should_create_repo, 
+                  :testing_framework, :documentation_framework,
+                  :should_use_cucumber, :should_setup_rubyforge,
+                  :should_use_reek, :should_use_roodi,
+                  :development_dependencies
+
+    DEFAULT_TESTING_FRAMEWORK = :shoulda
+    DEFAULT_DOCUMENTATION_FRAMEWORK = :rdoc
+
+    def initialize(project_name, options = {})
+      if project_name.nil? || project_name.squeeze.strip == ""
         raise NoGitHubRepoNameGiven
       end
 
-      self.github_repo_name   = github_repo_name
+      self.development_dependencies = []
+
+      self.project_name   = project_name
 
-      self.testing_framework  = (options[:testing_framework] || :shoulda).to_sym
-      unless SUPPORTED_TESTING_FRAMEWORKS.include? self.testing_framework
+      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)
+        extend generator_mixin
+      rescue NameError => e
         raise ArgumentError, "Unsupported testing framework (#{testing_framework})"
       end
 
-      self.target_dir         = options[:directory] || self.github_repo_name
+      begin
+        generator_mixin_name = "#{self.documentation_framework.to_s.capitalize}Mixin"
+        generator_mixin = self.class.const_get(generator_mixin_name)
+        extend generator_mixin
+      rescue NameError => e
+        raise ArgumentError, "Unsupported documentation framework (#{documentation_framework})"
+      end
+
+
+      self.target_dir             = options[:directory] || self.project_name
+
+      self.should_create_repo     = options[:create_repo]
+      self.summary                = options[:summary] || 'TODO: one-line summary of your gem'
+      self.description            = options[:description] || 'TODO: longer description of your gem'
+      self.should_use_cucumber    = options[:use_cucumber]
+      self.should_use_reek        = options[:use_reek]
+      self.should_use_roodi       = options[:use_roodi]
+      self.should_setup_rubyforge = options[:rubyforge]
 
-      self.should_create_repo = options[:create_repo]
-      self.summary            = options[:summary] || 'TODO'
-      self.should_use_cucumber= options[:use_cucumber]
+      development_dependencies << "cucumber" if should_use_cucumber
 
       use_user_git_config
       
@@ -52,112 +89,49 @@ class Jeweler
     def run
       create_files
       gitify
-      $stdout.puts "Jeweler has prepared your gem in #{github_repo_name}"
+      $stdout.puts "Jeweler has prepared your gem in #{target_dir}"
       if should_create_repo
         create_and_push_repo
-        $stdout.puts "Jeweler has pushed your repo to #{github_url}"
+        $stdout.puts "Jeweler has pushed your repo to #{project_homepage}"
         enable_gem_for_repo
         $stdout.puts "Jeweler has enabled gem building for your repo"
       end
     end
 
-    # Directory where 'tests' live
-    def test_dir
-      test_or_spec
+    def git_remote
+      "git@github.com:#{github_username}/#{project_name}.git"
     end
 
-    # Default rake task to use
-    def default_task
-      case testing_framework.to_sym
-      when :shoulda, :testunit, :minitest
-        'test'
-      when :bacon, :rspec
-        'spec'
-      when :micronaut
-        'examples'
-      else
-        raise ArgumentError, "Don't know default task for #{testing_framework}"
-      end
-    end
-
-    def feature_support_require
-      case testing_framework.to_sym
-      when :testunit, :shoulda, :bacon # NOTE bacon doesn't really work inside of cucumber
-        'test/unit/assertions'
-      when :minitest
-        'mini/test'
-      when :rspec
-        'spec/expectations'
-      when :micronaut
-        'micronaut/expectations'
-      else
-        raise "Don't know what to require for #{testing_framework}"
-      end
-    end
-
-    def feature_support_extend
-      case testing_framework.to_sym
-      when :testunit, :shoulda, :bacon # NOTE bacon doesn't really work inside of cucumber
-        'Test::Unit::Assertions'
-      when :minitest
-        'Mini::Test::Assertions'
-      when :rspec
-        nil
-      when :micronaut
-        'Micronaut::Matchers'
-      else
-        raise "Don't know what to extend for #{testing_framework}"
-      end
+    def project_homepage
+      "http://github.com/#{github_username}/#{project_name}"
     end
-
-    def github_remote
-      "git@github.com:#{github_username}/#{github_repo_name}.git"
+    
+    def constant_name
+      self.project_name.split(/[-_]/).collect{|each| each.capitalize }.join
     end
 
-    def github_url
-      "http://github.com/#{github_username}/#{github_repo_name}"
+    def lib_filename
+      "#{project_name}.rb"
     end
 
-    
-    def constant_name
-      self.github_repo_name.split(/[-_]/).collect{|each| each.capitalize }.join
+    def require_name
+      self.project_name
     end
 
     def file_name_prefix
-      self.github_repo_name.gsub('-', '_')
+      self.project_name.gsub('-', '_')
     end
 
     def lib_dir
       'lib'
     end
 
-    def test_dir
-      case testing_framework.to_sym
-      when :shoulda, :testunit, :minitest
-        'test'
-      when :bacon, :rspec
-        'spec'
-      when :micronaut
-        'examples'
-      else
-        raise ArgumentError, "Don't know test dir for #{testing_framework.inspect}"
-      end
-    end
-
-    def test_filename
-      "#{file_name_prefix}_#{test_or_spec}.rb"
-    end
-
-    def test_helper_filename
-      "#{test_or_spec}_helper.rb"
-    end
-
     def feature_filename
-      "#{file_name_prefix}.feature"
+      "#{project_name}.feature"
     end
 
     def steps_filename
-      "#{file_name_prefix}_steps.rb"
+      "#{project_name}_steps.rb"
     end
 
     def features_dir
@@ -172,28 +146,11 @@ class Jeweler
       File.join(features_dir, 'step_definitions')
     end
 
-    def test_or_spec
-      case testing_framework.to_sym
-      when :shoulda, :testunit, :minitest
-        'test'
-      when :bacon, :rspec
-        'spec'
-      when :micronaut
-        'example'
-      else
-        raise ArgumentError, "Unknown test style: #{testing_framework}"
-      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
@@ -209,9 +166,10 @@ 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")
+      touch_in_target           File.join(lib_dir, lib_filename)
 
       mkdir_in_target           test_dir
       output_template_in_target File.join(testing_framework.to_s, 'helper.rb'), File.join(test_dir, test_helper_filename)
@@ -245,8 +203,10 @@ class Jeweler
         raise NoGitHubUser
       end
       
-      unless git_config.has_key? 'github.token'
-        raise NoGitHubToken
+      if should_create_repo
+        unless git_config.has_key? 'github.token'
+          raise NoGitHubToken
+        end
       end
 
       self.user_name       = git_config['user.name']
@@ -261,7 +221,7 @@ class Jeweler
       template_contents = File.read(File.join(template_dir, source))
       template = ERB.new(template_contents, nil, '<>')
 
-      template_result = template.result(binding)
+      template_result = template.result(binding).gsub(/\n\n\n+/, "\n\n")
 
       File.open(final_destination, 'w') {|file| file.write(template_result)}
 
@@ -304,13 +264,13 @@ class Jeweler
         end
 
         begin
-          @repo.commit "Initial commit to #{github_repo_name}."
+          @repo.commit "Initial commit to #{project_name}."
         rescue Git::GitExecuteError => e
           raise
         end
 
         begin
-          @repo.add_remote('origin', github_remote)
+          @repo.add_remote('origin', git_remote)
         rescue Git::GitExecuteError => e
           puts "Encountered an error while adding origin remote. Maybe you have some weird settings in ~/.gitconfig?"
           raise
@@ -325,13 +285,13 @@ class Jeweler
                                 'login' => github_username,
                                 'token' => github_token,
                                 'repository[description]' => summary,
-                                'repository[name]' => github_repo_name
+                                'repository[name]' => project_name
       # TODO do a HEAD request to see when it's ready
       @repo.push('origin')
     end
 
     def enable_gem_for_repo
-      url = "https://github.com/#{github_username}/#{github_repo_name}/update"
+      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),