jeweler 1.2.1 → 1.3.0

data/lib/jeweler/specification.rb

@@ -3,6 +3,11 @@ 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
+  # [test_files] Similar to gem.files, except it's only things under the spec, test, or examples directory.
+  # [extra_rdoc_files] a Rake::FileList including files like README*, ChangeLog*, and LICENSE*
+  # [executables] uses anything found in the bin/ directory. You can override this.
   module Specification
 
     def self.filelist_attribute(name)
@@ -22,13 +27,14 @@ class Jeweler
     filelist_attribute :test_files
     filelist_attribute :extra_rdoc_files
 
-
     # Assigns the Jeweler defaults to the Gem::Specification
-    def set_jeweler_defaults(base_dir)
+    def set_jeweler_defaults(base_dir, git_base_dir = nil)
       Dir.chdir(base_dir) do
-        if blank?(files) && File.directory?(File.join(base_dir, '.git'))
-          repo = Git.open(base_dir)
-          self.files = repo.ls_files.keys - repo.lib.ignored_files
+        require 'git'
+        if blank?(files) && git_base_dir
+          git_subdir = File.expand_path(base_dir).sub(File.join(File.expand_path(git_base_dir), ""), "")          
+          repo = Git.open(git_base_dir)
+          self.files = (repo.ls_files.keys - repo.lib.ignored_files).map {|fn| fn.sub(File.join(git_subdir, ""), "")}
         end
 
         if blank?(test_files) && File.directory?(File.join(base_dir, '.git'))

data/lib/jeweler/tasks.rb

@@ -2,7 +2,14 @@ require 'rake'
 require 'rake/tasklib'
 
 class Rake::Application
-  attr_accessor :jeweler
+  attr_accessor :jeweler_tasks
+
+  # The jeweler instance that has be instantiated in the current Rakefile.
+  #
+  # This is usually useful if you want to get at info like version from other files.
+  def jeweler
+    jeweler_tasks.jeweler
+  end
 end
 
 class Jeweler
@@ -19,31 +26,43 @@ class Jeweler
   #     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.
-  #
+  # 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 . In addition, it has a defaults set for you. See Jeweler::Specification for more details.
   class Tasks < ::Rake::TaskLib
-    attr_accessor :gemspec, :jeweler
+    attr_accessor :gemspec, :jeweler, :gemspec_building_block
 
-    def initialize(gemspec = nil, &block)
+    def initialize(gemspec = nil, &gemspec_building_block)
       @gemspec = gemspec || Gem::Specification.new
-      @jeweler = Jeweler.new(@gemspec)
-      yield @gemspec if block_given?
+      self.gemspec_building_block = gemspec_building_block
 
-      Rake.application.jeweler = @jeweler
+      Rake.application.jeweler_tasks = self
       define
     end
 
+    def jeweler
+      if @jeweler.nil?
+        @jeweler = Jeweler.new(gemspec)
+        gemspec_building_block.call gemspec if gemspec_building_block
+      end
+      @jeweler
+    end
+
   private
+
+    def yield_gemspec_set_version?
+      yielded_gemspec = @gemspec.dup
+      yielded_gemspec.extend(Jeweler::Specification)
+      yielded_gemspec.files = FileList[]
+      yielded_gemspec.test_files = FileList[]
+      yielded_gemspec.extra_rdoc_files = FileList[]
+
+      gemspec_building_block.call(yielded_gemspec) if gemspec_building_block
+
+      ! yielded_gemspec.version.nil?
+    end
+
     def define
       task :version_required do
-        unless jeweler.version_exists?
+        if jeweler.expects_version_file? && !jeweler.version_file_exists?
           abort "Expected VERSION or VERSION.yml to exist. See version:write to create an initial one."
         end
       end
@@ -54,7 +73,7 @@ class Jeweler
       end
 
       desc "Install gem using sudo"
-      task :install => :build do
+      task :install => ['check_dependencies:runtime', :build] do
         jeweler.install_gem
       end
 
@@ -71,6 +90,11 @@ class Jeweler
         task :generate => :version_required do
           jeweler.write_gemspec
         end
+
+        desc "Display the gemspec for debugging purposes"
+        task :debug do
+          puts jeweler.gemspec_helper.to_ruby
+        end
       end
 
       desc "Displays the current version"
@@ -78,40 +102,53 @@ class Jeweler
         $stdout.puts "Current version: #{jeweler.version}"
       end
 
-      namespace :version do
-        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
-          jeweler.write_version(major, minor, patch, :announce => false, :commit => false)
-          $stdout.puts "Updated version: #{jeweler.version}"
-        end
-
-        namespace :bump do
-          desc "Bump the gemspec by a major version."
-          task :major => [:version_required, :version] do
-            jeweler.bump_major_version
+      unless yield_gemspec_set_version?
+        namespace :version do
+          desc "Writes out an explicit version. Respects the following environment variables, or defaults to 0: MAJOR, MINOR, PATCH. Also recognizes BUILD, which defaults to nil"
+          task :write do
+            major, minor, patch, build = ENV['MAJOR'].to_i, ENV['MINOR'].to_i, ENV['PATCH'].to_i, (ENV['BUILD'] || nil )
+            jeweler.write_version(major, minor, patch, build, :announce => false, :commit => false)
             $stdout.puts "Updated version: #{jeweler.version}"
           end
 
-          desc "Bump the gemspec by a minor version."
-          task :minor => [:version_required, :version] do
-            jeweler.bump_minor_version
-            $stdout.puts "Updated version: #{jeweler.version}"
+          namespace :bump do
+            desc "Bump the gemspec by a major version."
+            task :major => [:version_required, :version] do
+              jeweler.bump_major_version
+              $stdout.puts "Updated version: #{jeweler.version}"
+            end
+
+            desc "Bump the gemspec by a minor version."
+            task :minor => [:version_required, :version] do
+              jeweler.bump_minor_version
+              $stdout.puts "Updated version: #{jeweler.version}"
+            end
+
+            desc "Bump the gemspec by a patch version."
+            task :patch => [:version_required, :version] do
+              jeweler.bump_patch_version
+              $stdout.puts "Updated version: #{jeweler.version}"
+            end
           end
+        end
+      end
 
-          desc "Bump the gemspec by a patch version."
-          task :patch => [:version_required, :version] do
-            jeweler.bump_patch_version
-            $stdout.puts "Updated version: #{jeweler.version}"
-          end
+      namespace :github do
+        task :release do
+          jeweler.release_gem_to_github
         end
       end
 
-      desc "Release the current version. Includes updating the gemspec, pushing, and tagging the release"
-      task :release do
-        jeweler.release
+      task :release => 'github:release'
+
+      namespace :git do
+        task :release do
+          jeweler.release_to_git
+        end
       end
 
+      task :release => 'git:release'
+
       desc "Check that runtime and development dependencies are installed" 
       task :check_dependencies do
         jeweler.check_dependencies

data/lib/jeweler/templates/.gitignore

@@ -1,5 +1,21 @@
-*.sw?
+## MAC OS
 .DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
 coverage
 rdoc
 pkg
+
+## PROJECT::SPECIFIC

data/lib/jeweler/templates/Rakefile

@@ -8,13 +8,13 @@ begin
     gem.summary = %Q{<%= summary %>}
     gem.description = %Q{<%= description %>}
     gem.email = "<%= user_email %>"
-    gem.homepage = "<%= project_homepage %>"
+    gem.homepage = "<%= homepage %>"
     gem.authors = ["<%= user_name %>"]
 <% if should_setup_rubyforge %>
     gem.rubyforge_project = "<%= project_name %>"
 <% end %>
-<% development_dependencies.each do |dependency| %>
-    gem.add_development_dependency "<%= dependency %>"
+<% development_dependencies.each do |name, version| %>
+    gem.add_development_dependency "<%= name %>", "<%= version %>"
 <% end %>
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -130,11 +130,7 @@ task :default => :<%= default_task %>
 <% when :rdoc %>
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "<%= project_name %> #{version}"

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

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

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

@@ -1,11 +1,11 @@
 require 'rubygems'
-require 'mini/test'
+require 'minitest/unit'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require '<%= require_name %>'
 
-class Mini::Test::TestCase
+class MiniTest::Unit::TestCase
 end
 
-Mini::Test.autorun
+MiniTest::Unit.autorun

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

@@ -0,0 +1,11 @@
+require 'teststrap'
+
+context "<%= require_name %>" do
+  setup do
+    false
+  end
+
+  asserts "i'm a failure :(" do
+    topic
+  end
+end

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

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'riot'
+require '<%= require_name %>'

data/lib/jeweler/templates/rspec/spec.opts

@@ -0,0 +1 @@
+--color

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

@@ -1,6 +1,6 @@
-require 'test_helper'
+require 'helper'
 
-class <%= constant_name %>Test < Test::Unit::TestCase
+class Test<%= constant_name %> < 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

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

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+describe "<%= constant_name %>" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

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

@@ -0,0 +1,7 @@
+
+require 'rubygems'
+require 'test/spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require '<%= require_name %>'

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

@@ -1,6 +1,6 @@
-require 'test_helper'
+require 'helper'
 
-class <%= constant_name %>Test < Test::Unit::TestCase
+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

data/lib/jeweler/version_helper.rb

@@ -3,7 +3,7 @@ require 'yaml'
 class Jeweler
   class VersionHelper
     attr_accessor :base_dir
-    attr_reader :major, :minor, :patch
+    attr_reader :major, :minor, :patch, :build
 
     module YamlExtension
       def write
@@ -16,7 +16,8 @@ class Jeweler
         {
           :major => major,
           :minor => minor,
-          :patch => patch
+          :patch => patch,
+          :build => build
         }
       end
 
@@ -29,6 +30,7 @@ class Jeweler
         @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
@@ -53,10 +55,13 @@ class Jeweler
 
       def parse_plaintext
         plaintext = read_plaintext.chomp
-        if plaintext =~ /^(\d+)\.(\d+)\.(\d+)$/
+        # 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
 
@@ -91,25 +96,29 @@ class Jeweler
       @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)
+    def update_to(major, minor, patch, build=nil)
       @major = major
       @minor = minor
       @patch = patch
+      @build = build
     end
 
     def to_s
-      "#{major}.#{minor}.#{patch}"
+      [major, minor, patch, build].compact.join('.')
     end
 
     def yaml_path

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

@@ -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.