jeweler2 2.0.0

data/lib/jeweler/templates/testunit/flunking.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class Test<%= constant_name %> < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/lib/jeweler/templates/testunit/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+<%= render_template 'bundler_setup.erb' %>
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require '<%= require_name %>'
+
+class Test::Unit::TestCase
+end

data/lib/jeweler/version.rb

@@ -0,0 +1,10 @@
+class Jeweler
+  module Version
+    MAJOR = 2
+    MINOR = 0
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/lib/jeweler/version_helper.rb

@@ -0,0 +1,141 @@
+begin
+  require 'psych'
+rescue ::LoadError
+end
+
+require 'yaml'
+
+class Jeweler
+  class VersionHelper
+    attr_accessor :base_dir
+    attr_reader :major, :minor, :patch, :build
+
+    module YamlExtension
+      def write
+        File.open(yaml_path, 'w+') do |f|
+          YAML.dump(self.to_hash, f)
+        end
+      end
+
+      def to_hash
+        {
+          :major => major,
+          :minor => minor,
+          :patch => patch,
+          :build => build
+        }
+      end
+
+      def refresh
+        parse_yaml
+      end
+
+      def parse_yaml
+        yaml = read_yaml
+        @major = (yaml['major'] || yaml[:major]).to_i
+        @minor = (yaml['minor'] || yaml[:minor]).to_i
+        @patch = (yaml['patch'] || yaml[:patch]).to_i
+        @build = (yaml['build'] || yaml[:build])
+      end
+
+      def read_yaml
+        if File.exists?(yaml_path)
+          YAML.load_file(yaml_path)
+        else
+          raise VersionYmlError, "#{yaml_path} does not exist!"
+        end
+      end
+
+      def path
+        yaml_path
+      end
+    end
+
+    module PlaintextExtension
+      def write
+        File.open(plaintext_path, 'w') do |file|
+          file.write to_s
+        end
+      end
+
+      def parse_plaintext
+        plaintext = read_plaintext.chomp
+        # http://rubular.com/regexes/10467 -> 3.5.4.a1
+        # http://rubular.com/regexes/10468 -> 3.5.4
+        if plaintext =~ /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/
+          @major = $1.to_i
+          @minor = $2.to_i
+          @patch = $3.to_i
+          @build = $4
+        end
+      end
+
+      def read_plaintext
+        File.read(plaintext_path)
+      end
+
+      def refresh
+        parse_plaintext
+      end
+
+      def path
+        plaintext_path
+      end
+    end
+
+    def initialize(base_dir)
+      self.base_dir = base_dir
+
+      if File.exists?(yaml_path)
+        extend YamlExtension
+        parse_yaml
+      else
+        extend PlaintextExtension
+        if File.exists?(plaintext_path)
+          parse_plaintext
+        end
+      end
+    end
+
+    def bump_major
+      @major += 1
+      @minor = 0
+      @patch = 0
+      @build = nil
+    end
+
+    def bump_minor
+      @minor += 1
+      @patch = 0
+      @build = nil
+    end
+
+    def bump_patch
+      @patch += 1
+      @build = nil
+    end
+
+    def update_to(major, minor, patch, build=nil)
+      @major = major
+      @minor = minor
+      @patch = patch
+      @build = build
+    end
+
+    def to_s
+      [major, minor, patch, build].compact.join('.')
+    end
+
+    def yaml_path
+      denormalized_path = File.join(@base_dir, 'VERSION.yml')
+      absolute_path = File.expand_path(denormalized_path)
+      absolute_path.gsub(Dir.getwd + File::SEPARATOR, '')
+    end
+
+    def plaintext_path
+      denormalized_path = File.join(@base_dir, 'VERSION')
+      absolute_path = File.expand_path(denormalized_path)
+      absolute_path.gsub(Dir.getwd + File::SEPARATOR, '')
+    end
+  end
+end

data/lib/jeweler.rb

@@ -0,0 +1,177 @@
+require 'pathname'
+require 'date'
+require_relative 'jeweler/version'
+
+# A Jeweler helps you craft the perfect Rubygem. Give him a gemspec, and he takes care of the rest.
+#
+# See Jeweler::Tasks for examples of how to get started. Additionally, resources are available on the wiki:
+#
+# * http://wiki.github.com/technicalpickles/jeweler/create-a-new-project
+# * http://wiki.github.com/technicalpickles/jeweler/configure-an-existing-project
+class Jeweler
+  require_relative 'jeweler/errors'
+  require 'rubygems/user_interaction'
+
+  require_relative  'jeweler/generator'
+
+  require_relative       'jeweler/commands'
+  
+  require_relative 'jeweler/version_helper'
+  require_relative 'jeweler/gemspec_helper'
+
+  require_relative         'jeweler/tasks'
+  require_relative 'jeweler/rubygems_dot_org_tasks'
+  require_relative 'jeweler/gemcutter_tasks'
+  require_relative 'jeweler/rubyforge_tasks'
+  require_relative  'jeweler/specification'
+
+  attr_reader :gemspec, :gemspec_helper, :version_helper
+  attr_accessor :base_dir, :output, :repo, :commit
+
+  def initialize(gemspec, base_dir = '.')
+    raise(GemspecError, "Can't create a Jeweler with a nil gemspec") if gemspec.nil?
+
+    @gemspec = gemspec
+    @gemspec.extend(Specification)
+    @gemspec.set_jeweler_defaults(base_dir, git_base_dir)
+
+    @base_dir       = base_dir
+    @repo           = Git.open(git_base_dir) if in_git_repo?
+    @version_helper = Jeweler::VersionHelper.new(base_dir)
+    @output         = $stdout
+    @commit         = true
+    @gemspec_helper = GemSpecHelper.new(gemspec, base_dir)
+  end
+
+  # Major version, as defined by the gemspec's Version module.
+  # For 1.5.3, this would return 1.
+  def major_version
+    @version_helper.major
+  end
+
+  # Minor version, as defined by the gemspec's Version module.
+  # For 1.5.3, this would return 5.
+  def minor_version
+    @version_helper.minor
+  end
+
+  # Patch version, as defined by the gemspec's Version module.
+  # For 1.5.3, this would return 5.
+  def patch_version
+    @version_helper.patch
+  end
+
+  # Human readable version, which is used in the gemspec.
+  def version
+    @gemspec.version || @version_helper.to_s
+  end
+
+  # Writes out the gemspec
+  def write_gemspec
+    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
+    Jeweler::Commands::ValidateGemspec.build_for(self).run
+  end
+
+  # is the project's gemspec from disk valid?
+  def valid_gemspec?
+    gemspec_helper.valid?
+  end
+
+  # Build a gem using the project's latest Gem::Specification
+  def build_gem
+    Jeweler::Commands::BuildGem.build_for(self).run
+  end
+
+  # Install a previously built gem
+  def install_gem
+    Jeweler::Commands::InstallGem.build_for(self).run
+  end
+
+  # Bumps the patch version.
+  #
+  # 1.5.1 -> 1.5.2
+  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()
+    Jeweler::Commands::Version::BumpMinor.build_for(self).run
+  end
+
+  # Bumps the major version.
+  #
+  # 1.5.1 -> 2.0.0
+  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, build, options = {})
+    command = Jeweler::Commands::Version::Write.build_for(self)
+    command.major = major
+    command.minor = minor
+    command.patch = patch
+    command.build = build
+
+    command.run
+  end
+
+  def release_gemspec
+    Jeweler::Commands::ReleaseGemspec.build_for(self).run
+  end
+
+  def release_to_git
+    Jeweler::Commands::ReleaseToGit.build_for(self).run
+  end
+
+  def release_gem_to_rubygems
+    Jeweler::Commands::ReleaseToRubygems.build_for(self).run
+  end
+
+  def release_gem_to_rubyforge
+    # no-op
+  end
+
+  def setup_rubyforge
+    # no-op
+  end
+
+  def check_dependencies(type = nil)
+    command = Jeweler::Commands::CheckDependencies.build_for(self)
+    command.type = type
+
+    command.run
+  end
+
+  def git_base_dir(base_dir = nil)
+    if base_dir
+      base_dir = File.dirname(base_dir)
+    else
+      base_dir = File.expand_path(self.base_dir || ".")
+    end
+    return nil if base_dir==File.dirname("/")
+    return base_dir if File.exists?(File.join(base_dir, '.git'))
+    return git_base_dir(base_dir)
+  end    
+
+  def in_git_repo?
+    git_base_dir
+  end
+
+  def version_file_exists?
+    File.exists?(@version_helper.plaintext_path) || File.exists?(@version_helper.yaml_path)
+  end
+
+  def expects_version_file?
+    gemspec.version.nil?
+  end
+
+end

data/test/fixtures/bar/VERSION.yml

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

data/test/fixtures/bar/bin/foo_the_ultimate_bin

@@ -0,0 +1 @@
+# You betcha!

data/test/fixtures/bar/lib/foo_the_ultimate_lib.rb

@@ -0,0 +1 @@
+# Uhuh

data/test/fixtures/existing-project-with-version-constant/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/test/fixtures/existing-project-with-version-constant/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/test/fixtures/existing-project-with-version-constant/LICENSE.txt

@@ -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-constant/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-constant/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.version = "1.0.0"
+    gem.name = "existing-project-with-version"
+    gem.summary = %Q{Summarize your gem}
+    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: 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: gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    require 'yaml'
+    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
+        require 'yaml'
+        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-constant/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{Summarize your gem}
+
+  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-constant/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-constant/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/fixtures/existing-project-with-version-plaintext/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/test/fixtures/existing-project-with-version-plaintext/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/test/fixtures/existing-project-with-version-plaintext/LICENSE.txt

@@ -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-plaintext/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-plaintext/Rakefile

@@ -0,0 +1,84 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "existing-project-with-version"
+    gem.summary = %Q{Summarize your gem}
+    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: 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: gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    require 'yaml'
+    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
+        require 'yaml'
+        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-plaintext/VERSION

@@ -0,0 +1 @@
+1.5.3