jeweler2 2.0.0

data/lib/jeweler/generator.rb

@@ -0,0 +1,295 @@
+require 'git'
+require 'erb'
+
+require 'net/http'
+require 'uri'
+
+require 'fileutils'
+require 'pathname'
+
+require_relative 'version'
+
+class Jeweler
+  class NoGitUserName < StandardError
+  end
+  class NoGitUserEmail < StandardError
+  end
+  class FileInTheWay < StandardError
+  end
+  class NoGitHubRepoNameGiven < StandardError
+  end
+  class NoGitHubUser < StandardError
+  end
+  class NoGitHubToken < StandardError
+  end
+  class GitInitFailed < StandardError
+  end    
+
+  # Generator for creating a jeweler-enabled project
+  class Generator    
+    require_relative 'generator/options'
+    require_relative 'generator/application'
+
+    require_relative 'generator/github_mixin'
+
+    require_relative 'generator/bacon_mixin'
+    require_relative 'generator/micronaut_mixin'
+    require_relative 'generator/minitest_mixin'
+    require_relative 'generator/rspec_mixin'
+    require_relative 'generator/shoulda_mixin'
+    require_relative 'generator/testspec_mixin'
+    require_relative 'generator/testunit_mixin'
+    require_relative 'generator/riot_mixin'
+    require_relative 'generator/shindo_mixin'
+
+    require_relative 'generator/rdoc_mixin'
+    require_relative 'generator/yard_mixin'
+
+    attr_accessor :target_dir, :user_name, :user_email, :summary, :homepage,
+                  :description, :project_name, :github_username, :github_token,
+                  :repo, :should_create_remote_repo, 
+                  :testing_framework, :documentation_framework,
+                  :should_use_cucumber, :should_use_bundler,
+                  :should_setup_rubyforge, :should_use_reek, :should_use_roodi,
+                  :development_dependencies,
+                  :options,
+                  :git_remote
+
+    def initialize(options = {})
+      self.options = options
+      extracted_directory = nil
+
+      self.project_name   = options[:project_name]
+      if self.project_name.nil? || self.project_name.squeeze.strip == ""
+        raise NoGitHubRepoNameGiven
+      else
+        path = File.split(self.project_name)
+
+        if path.size > 1
+          extracted_directory = File.join(path[0..-1])
+          self.project_name = path.last
+        end
+      end
+
+      self.development_dependencies = []
+      self.testing_framework  = options[:testing_framework]
+      self.documentation_framework = options[: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
+
+      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] || extracted_directory || self.project_name
+
+      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_use_bundler     = options[:use_bundler]
+
+      development_dependencies << ["cucumber", ">= 0"] if should_use_cucumber
+
+      # TODO make bundler optional?
+      development_dependencies << ["bundler", "~> 1.0.0"]
+      development_dependencies << ["jeweler", "~> #{Jeweler::Version::STRING}"]
+      development_dependencies << ["rcov", ">= 0"]
+
+      development_dependencies << ["reek", "~> 1.2.8"] if should_use_reek
+      development_dependencies << ["roodi", "~> 2.1.0"] if should_use_roodi
+
+      self.user_name       = options[:user_name]
+      self.user_email      = options[:user_email]
+      self.homepage        = options[:homepage]
+      
+      self.git_remote      = options[:git_remote]
+
+      raise NoGitUserName unless self.user_name
+      raise NoGitUserEmail unless self.user_email
+
+      extend GithubMixin
+    end
+
+    def run
+      create_files
+      create_version_control
+      $stdout.puts "Jeweler has prepared your gem in #{target_dir}"
+      if should_create_remote_repo
+        create_and_push_repo
+        $stdout.puts "Jeweler has pushed your repo to #{homepage}"
+      end
+    end
+
+    def constant_name
+      self.project_name.split(/[-_]/).collect{|each| each.capitalize }.join
+    end
+
+    def lib_filename
+      "#{project_name}.rb"
+    end
+
+    def require_name
+      self.project_name
+    end
+
+    def file_name_prefix
+      self.project_name.gsub('-', '_')
+    end
+
+    def lib_dir
+      'lib'
+    end
+
+    def feature_filename
+      "#{project_name}.feature"
+    end
+
+    def steps_filename
+      "#{project_name}_steps.rb"
+    end
+
+    def features_dir
+      'features'
+    end
+
+    def features_support_dir
+      File.join(features_dir, 'support')
+    end
+
+    def features_steps_dir
+      File.join(features_dir, 'step_definitions')
+    end
+
+  private
+
+    def create_files
+      unless File.exists?(target_dir) || File.directory?(target_dir)
+        FileUtils.mkdir target_dir
+      else
+        raise FileInTheWay, "The directory #{target_dir} already exists, aborting. Maybe move it out of the way before continuing?"
+      end
+
+
+      output_template_in_target '.gitignore'
+      output_template_in_target 'Rakefile'
+      output_template_in_target 'Gemfile' if should_use_bundler
+      output_template_in_target 'LICENSE.txt'
+      output_template_in_target 'README.rdoc'
+      output_template_in_target '.document'
+
+      mkdir_in_target           lib_dir
+      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)
+      output_template_in_target File.join(testing_framework.to_s, 'flunking.rb'),
+                                File.join(test_dir, test_filename)
+
+
+      if testing_framework == :rspec
+        output_template_in_target File.join(testing_framework.to_s, '.rspec'),
+                                  '.rspec'
+
+      end
+
+      if should_use_cucumber
+        mkdir_in_target           features_dir
+        output_template_in_target File.join(%w(features default.feature)), File.join('features', feature_filename)
+
+        mkdir_in_target           features_support_dir
+        output_template_in_target File.join(features_support_dir, 'env.rb')
+
+        mkdir_in_target           features_steps_dir
+        touch_in_target           File.join(features_steps_dir, steps_filename)
+      end
+    end
+
+    def render_template(source)
+      template_contents = File.read(File.join(template_dir, source))
+      template          = ERB.new(template_contents, nil, '<>')
+
+      # squish extraneous whitespace from some of the conditionals
+      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)}
+
+      $stdout.puts "\tcreate\t#{destination}"
+    end
+
+    def template_dir
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def mkdir_in_target(directory)
+      final_destination = File.join(target_dir, directory)
+
+      FileUtils.mkdir final_destination
+
+      $stdout.puts "\tcreate\t#{directory}"
+    end
+
+    def touch_in_target(destination)
+      final_destination = File.join(target_dir, destination)
+      FileUtils.touch  final_destination
+      $stdout.puts "\tcreate\t#{destination}"
+    end
+
+    def create_version_control
+      Dir.chdir(target_dir) do
+        begin
+          @repo = Git.init()
+        rescue Git::GitExecuteError => e
+          raise GitInitFailed, "Encountered an error during gitification. Maybe the repo already exists, or has already been pushed to?"
+        end
+
+        begin
+          @repo.add('.')
+        rescue Git::GitExecuteError => e
+          #raise GitAddFailed, "There was some problem adding this directory to the git changeset"
+          raise
+        end
+
+        begin
+          @repo.commit "Initial commit to #{project_name}."
+        rescue Git::GitExecuteError => e
+          raise
+        end
+
+        begin
+          @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
+        end
+      end
+    end
+    
+    def create_and_push_repo
+      Net::HTTP.post_form URI.parse('http://github.com/api/v2/yaml/repos/create'),
+                                'login' => github_username,
+                                'token' => github_token,
+                                'description' => summary,
+                                'name' => project_name
+      # TODO do a HEAD request to see when it's ready?
+      @repo.push('origin')
+    end
+  end
+end

data/lib/jeweler/rubyforge_tasks.rb

@@ -0,0 +1,95 @@
+require 'rake'
+require 'rake/tasklib'
+
+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}/
+  #
+  # See also http://wiki.github.com/technicalpickles/jeweler/rubyforge
+  class RubyforgeTasks < ::Rake::TaskLib
+    # 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
+      yield self if block_given?
+
+      $stderr.puts "Releasing gems to Rubyforge is deprecated. See details at http://wiki.github.com/technicalpickles/jeweler/migrating-from-releasing-gems-to-rubyforge"
+
+      define
+    end
+
+    def jeweler
+      @jeweler ||= Rake.application.jeweler
+    end
+
+    def remote_doc_path
+      @remote_doc_path ||= jeweler.gemspec.name
+    end
+
+    def project
+      @project ||= jeweler.gemspec.rubyforge_project
+    end
+
+    def define
+      namespace :rubyforge do
+        namespace :release do
+          desc "Release the current gem version to RubyForge."
+          task :gem do
+            $stderr.puts "DEPRECATION: Releasing gems to RubyForge is deprecated. You should see about releasing to Gemcutter instead: http://wiki.github.com/technicalpickles/jeweler/gemcutter"
+          end
+
+          if publish_documentation?
+            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 = case self.doc_task.to_sym
+                          when :rdoc then 'rdoc'
+                          when :yardoc then 'doc'
+                          when 'doc:app'.to_sym then 'doc/app' 
+                          else
+                            raise "Unsure what to run to generate documentation. Please set doc_task and re-run."
+                          end
+
+              sh %{rsync --archive --verbose --delete #{local_dir}/ #{host}:#{remote_dir}}
+            end
+          end
+        end
+
+        if publish_documentation?
+          desc "Release RDoc documentation to RubyForge"
+          task :release => "rubyforge:release:docs"
+        end
+      end
+
+      task :release => 'rubyforge:release'
+    end
+
+    def publish_documentation?
+      ! (doc_task == false || doc_task == :none)
+    end
+  end
+end

data/lib/jeweler/rubygems_dot_org_tasks.rb

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/tasklib'
+
+class Jeweler
+  # Rake tasks for putting a Jeweler gem on Gemcutter.
+  #
+  # Jeweler::Tasks.new needs to be used before this.
+  #
+  # Basic usage:
+  #
+  #     Jeweler::RubygemsDotOrgTasks.new
+  #
+  # Easy enough, right?
+  class RubygemsDotOrgTasks < ::Rake::TaskLib
+    attr_accessor :jeweler
+
+    def initialize
+      yield self if block_given?
+
+      define
+    end
+
+    def jeweler
+      @jeweler ||= Rake.application.jeweler
+    end
+
+    def define
+      namespace :gemcutter do
+        desc "Release gem to Gemcutter"
+        task :release => [:gemspec, :build] do
+          jeweler.release_gem_to_rubygems
+        end
+      end
+
+      task :release => 'gemcutter:release'
+    end
+  end
+end

data/lib/jeweler/rubygems_tasks.rb

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/tasklib'
+
+class Jeweler
+  # Rake tasks for putting a Jeweler gem on Gemcutter.
+  #
+  # Jeweler::Tasks.new needs to be used before this.
+  #
+  # Basic usage:
+  #
+  #     Jeweler::RubygemsDotOrgTasks.new
+  #
+  # Easy enough, right?
+  class RubygemsDotOrgTasks < ::Rake::TaskLib
+    attr_accessor :jeweler
+
+    def initialize
+      yield self if block_given?
+
+      define
+    end
+
+    def jeweler
+      @jeweler ||= Rake.application.jeweler
+    end
+
+    def define
+      namespace :rubygems do
+        desc "Release gem to Gemcutter"
+        task :release => [:gemspec, :build] do
+          jeweler.release_gem_to_rubygems
+        end
+      end
+
+      task :release => 'rubygems:release'
+    end
+  end
+end

data/lib/jeweler/specification.rb

@@ -0,0 +1,110 @@
+
+require 'rubygems/specification'
+
+class Jeweler
+  # Extend a Gem::Specification instance with this module to give it Jeweler
+  # super-cow powers.
+  #
+  # [files] a Rake::FileList of anything that is in git and not gitignored. You can include/exclude this default set, or override it entirely
+  # [extra_rdoc_files] a Rake::FileList including files like README*, ChangeLog*, and LICENSE*
+  # [executables] uses anything found in the bin/ directory.
+  module Specification
+    def self.filelist_attribute(name)
+      code = %{
+        def #{name}
+          if @#{name} && @#{name}.class != FileList
+            @#{name} = FileList[@#{name}]
+          end
+          @#{name} ||= FileList[]
+        end
+        def #{name}=(value)
+          @#{name} = FileList[value]
+        end
+      }
+
+      module_eval code, __FILE__, __LINE__ - 9
+    end
+
+    filelist_attribute :files
+    filelist_attribute :extra_rdoc_files
+
+    # Assigns the Jeweler defaults to the Gem::Specification
+    def set_jeweler_defaults(base_dir, git_base_dir = nil)
+      base_dir = File.expand_path(base_dir)
+      git_base_dir = if git_base_dir
+                       File.expand_path(git_base_dir)
+                     else
+                       base_dir
+                     end
+      can_git = git_base_dir && base_dir.include?(git_base_dir) && File.directory?(File.join(git_base_dir, '.git'))
+
+      Dir.chdir(git_base_dir) do
+        repo = if can_git
+                 require 'git'
+                 Git.open(git_base_dir)
+               end
+
+        if blank?(files) && repo
+          base_dir_with_trailing_separator = File.join(base_dir, "")
+
+          ignored_files = repo.lib.ignored_files + [".gitignore"]
+          self.files = (repo.ls_files(base_dir).keys - ignored_files).compact.map do |file|
+            File.expand_path(file).sub(base_dir_with_trailing_separator, "")
+          end
+        end
+
+        if blank?(executables) && repo
+          self.executables = (repo.ls_files(File.join(base_dir, 'bin')).keys - repo.lib.ignored_files).map do |file|
+            File.basename(file)
+          end
+        end
+
+        if blank?(extensions)
+          self.extensions = FileList['ext/**/{extconf,mkrf_conf}.rb']
+        end
+
+        if blank?(extra_rdoc_files)
+          self.extra_rdoc_files = FileList['README*', 'ChangeLog*', 'LICENSE*', 'TODO']
+        end
+
+        if File.exist?('Gemfile')
+          require 'bundler'
+          bundler = Bundler.load
+          bundler.dependencies_for(:default, :runtime).each do |dependency|
+            self.add_dependency dependency.name, *dependency.requirement.as_list
+          end
+          bundler.dependencies_for(:development).each do |dependency|
+            self.add_development_dependency dependency.name, *dependency.requirement.as_list
+          end
+        end
+        
+      end
+    end
+
+    # Used by Specification#to_ruby to generate a ruby-respresentation of a Gem::Specification
+    def ruby_code(obj)
+      case obj
+      when Rake::FileList then obj.uniq.to_a.inspect
+      else super
+      end
+    end
+
+  private
+
+    def blank?(value)
+      value.nil? || value.empty?
+    end
+  end
+end
+
+
+# Workaround for cloning/duping a Gem::Specification
+# documented in http://github.com/technicalpickles/jeweler/issues#issue/73
+Gem::Specification.class_eval do
+  def initialize_copy(original)
+    super
+
+    self.files = original.files.to_a
+    self.extra_rdoc_files = original.extra_rdoc_files.to_a
+  end
+end