jeweler2 2.0.0

data/lib/jeweler/tasks.rb

@@ -0,0 +1,224 @@
+require 'rake'
+require 'rake/tasklib'
+
+class Rake::Application
+  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
+  # Rake tasks for managing your gem.
+  #
+  # Here's a basic usage example:
+  #
+  #   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
+  #
+  # In addition, it provides reasonable defaults for several values. See Jeweler::Specification for more details.
+  class Tasks < ::Rake::TaskLib
+    attr_accessor :gemspec, :jeweler, :gemspec_building_block
+
+    def initialize(gemspec = nil, &gemspec_building_block)
+      @gemspec = gemspec || Gem::Specification.new
+      self.gemspec_building_block = gemspec_building_block
+
+      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.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
+        if jeweler.expects_version_file? && !jeweler.version_file_exists?
+          abort "Expected VERSION or VERSION.yml to exist. Use 'rake version:write' to create an initial one."
+        end
+      end
+
+      task :gemspec_required do
+        if ! File.exist?(jeweler.gemspec_helper.path)
+          abort "Expected #{jeweler.gemspec_helper.path} to exist. See 'rake gemspec:write' to create it"
+        end
+      end
+
+
+      desc "Build gem into pkg/"
+      task :build do
+        jeweler.build_gem
+      end
+
+      desc "Build and install gem using `gem install`"
+      task :install => [:build] do
+        jeweler.install_gem
+      end
+
+      desc "Displays the current version"
+      task :version => :version_required do
+        $stdout.puts "Current version: #{jeweler.version}"
+      end
+
+      desc "Release gem"
+      task :release do
+      end
+
+      desc "Generate and validate gemspec"
+      task :gemspec => ['gemspec:generate', 'gemspec:validate']
+
+      namespace :gemspec do
+        desc "Validates the gemspec on the filesystem"
+        task :validate => :gemspec_required do
+          jeweler.validate_gemspec
+        end
+
+        desc "Regenerate the gemspec on the filesystem"
+        task :generate => :version_required do
+          jeweler.write_gemspec
+        end
+
+        desc "Display the gemspec for debugging purposes, as jeweler knows it (not from the filesystem)"
+        task :debug do
+          # TODO move to a command
+          jeweler.gemspec_helper.spec.version ||= begin
+                                                    jeweler.version_helper.refresh
+                                                    jeweler.version_helper.to_s
+                                                  end
+
+          puts jeweler.gemspec_helper.to_ruby
+        end
+
+        desc "Regenerate and validate gemspec, and then commits and pushes to git"
+        task :release do
+          jeweler.release_gemspec
+        end
+      end
+
+      task :release => 'gemspec:release'
+
+
+      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
+
+          namespace :bump do
+            desc "Bump the major version by 1"
+            task :major => [:version_required, :version] do
+              jeweler.bump_major_version
+              $stdout.puts "Updated version: #{jeweler.version}"
+            end
+
+            desc "Bump the a minor version by 1"
+            task :minor => [:version_required, :version] do
+              jeweler.bump_minor_version
+              $stdout.puts "Updated version: #{jeweler.version}"
+            end
+
+            desc "Bump the patch version by 1"
+            task :patch => [:version_required, :version] do
+              jeweler.bump_patch_version
+              $stdout.puts "Updated version: #{jeweler.version}"
+            end
+          end
+        end
+      end
+
+
+      namespace :git do
+        desc "Tag and push release to git. (happens by default with `rake release`)"
+        task :release do
+          jeweler.release_to_git
+        end
+      end
+
+      task :release => 'git:release'
+
+      unless File.exist?('Gemfile')
+        desc "Check that runtime and development dependencies are installed"
+        task :check_dependencies do
+          jeweler.check_dependencies
+        end
+
+        namespace :check_dependencies do
+          desc "Check that runtime dependencies are installed"
+          task :runtime  do
+            jeweler.check_dependencies(:runtime)
+          end
+
+          desc"Check that development dependencies are installed"
+          task :development do
+            jeweler.check_dependencies(:development)
+          end
+        end
+      end
+
+      desc "Start IRB with all runtime dependencies loaded"
+      task :console, [:script] do |t,args|
+        # TODO move to a command
+        dirs = ['ext', 'lib'].select { |dir| File.directory?(dir) }
+
+        original_load_path = $LOAD_PATH
+
+        cmd = if File.exist?('Gemfile')
+                require 'bundler'
+                Bundler.setup(:default)
+              end
+
+        # add the project code directories
+        $LOAD_PATH.unshift(*dirs)
+
+        # clear ARGV so IRB is not confused
+        ARGV.clear
+
+        require 'irb'
+
+        # set the optional script to run
+        IRB.conf[:SCRIPT] = args.script
+        IRB.start
+
+        # return the $LOAD_PATH to it's original state
+        $LOAD_PATH.reject! { |path| !(original_load_path.include?(path)) }
+      end
+
+    end
+  end
+end

data/lib/jeweler/templates/.document

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

data/lib/jeweler/templates/.gitignore

@@ -0,0 +1,48 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/lib/jeweler/templates/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+<% development_dependencies.each do |name, version| %>
+  gem "<%= name %>", "<%= version %>"
+<% end %>
+end

data/lib/jeweler/templates/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) <%= Time.now.year %> <%= user_name %>
+
+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/lib/jeweler/templates/README.rdoc

@@ -0,0 +1,19 @@
+= <%= project_name %>
+
+Description goes here.
+
+== Contributing to <%= project_name %>
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) <%= Time.now.year %> <%= user_name %>. See LICENSE.txt for
+further details.
+

data/lib/jeweler/templates/Rakefile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'rubygems'
+<%= render_template 'bundler_setup.erb' %>
+require 'rake'
+
+<%= render_template 'jeweler_tasks.erb' %>
+
+<%= render_template 'other_tasks.erb' %>

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

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "<%= constant_name %>" do
+  it "fails" do
+    should.flunk "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'rubygems'
+<%= render_template 'bundler_setup.erb' %>
+require 'bacon'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require '<%= require_name %>'
+
+Bacon.summary_on_exit

data/lib/jeweler/templates/bundler_setup.erb

@@ -0,0 +1,10 @@
+<% if should_use_bundler %>
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+<% end %>

data/lib/jeweler/templates/features/default.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/jeweler/templates/features/support/env.rb

@@ -0,0 +1,10 @@
+<%= render_template 'bundler_setup.erb' %>
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require '<%= require_name %>'
+
+require '<%= feature_support_require %>'
+<% if feature_support_extend %>
+
+World(<%= feature_support_extend %>)
+<% end %>

data/lib/jeweler/templates/jeweler_tasks.erb

@@ -0,0 +1,31 @@
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "<%= project_name %>"
+  gem.homepage = "<%= homepage %>"
+  gem.license = "MIT"
+  gem.summary = %Q{<%= summary %>}
+  gem.description = %Q{<%= description %>}
+  gem.email = "<%= user_email %>"
+  gem.authors = ["<%= user_name %>"]
+<% if should_setup_rubyforge %>
+  gem.rubyforge_project = "<%= project_name %>"
+<% end %>
+<% if should_use_bundler %>
+  # dependencies defined in Gemfile
+<% else %>
+<% development_dependencies.each do |name, version| %>
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency "<%= name %>", "<%= version %>"
+<% end %>
+<% end %>
+end
+Jeweler::RubygemsDotOrgTasks.new
+<% if should_setup_rubyforge %>
+Jeweler::RubyforgeTasks.new do |rubyforge|
+  rubyforge.doc_task = "<%= doc_task %>"
+end
+<% end %>

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

@@ -0,0 +1,7 @@
+require 'example_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/micronaut/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+<%= render_template 'bundler_setup.erb' %>
+require 'micronaut'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require '<%= require_name %>'
+
+def not_in_editor?
+  !(ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM'))
+end
+
+Micronaut.configure do |c|
+  c.color_enabled = not_in_editor?
+  c.filter_run :focused => true
+end
+

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

@@ -0,0 +1,7 @@
+require 'helper'
+
+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
+end

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

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

data/lib/jeweler/templates/other_tasks.erb

@@ -0,0 +1,86 @@
+<% case testing_framework %>
+<% when :rspec %>
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:<%= test_task %>) do |<%= test_task %>|
+  <%= test_task %>.pattern = FileList['<%= test_pattern %>']
+end
+<% when :micronaut %>
+require 'micronaut/rake_task'
+Micronaut::RakeTask.new(:<%= test_task %>) do |<%= test_task %>|
+  <%= test_task %>.pattern = '<%= test_pattern %>'
+  <%= test_task %>.ruby_opts << '-Ilib -I<%= test_dir %>'
+end
+<% when :shindo %>
+require 'shindo/rake'
+Shindo::Rake.new
+<% else %>
+require 'rake/testtask'
+Rake::TestTask.new(:<%= test_task %>) do |<%= test_task %>|
+  <%= test_task %>.libs << 'lib' << '<%= test_dir %>'
+  <%= test_task %>.pattern = '<%= test_pattern %>'
+  <%= test_task %>.verbose = true
+end
+<% end %>
+
+<% case testing_framework %>
+<% when :rspec %>
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = '<%= test_pattern %>'
+  spec.rcov = true
+end
+<% when :micronaut %>
+Micronaut::RakeTask.new(:rcov) do |examples|
+  examples.pattern = '<%= test_pattern %>'
+  examples.rcov_opts = '-Ilib -I<%= test_dir %>'
+  examples.rcov = true
+end
+<% else %>
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |<%= test_task %>|
+  <%= test_task %>.libs << '<%= test_dir %>'
+  <%= test_task %>.pattern = '<%= test_pattern %>'
+  <%= test_task %>.verbose = true
+  <%= test_task %>.rcov_opts << '--exclude "gems/*"'
+end
+<% end %>
+
+<% if should_use_cucumber %>
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+<% end %>
+
+<% if should_use_reek %>
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+<% end %>
+
+<% if should_use_roodi %>
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+<% end %>
+
+task :default => :<%= default_task %>
+
+<% case documentation_framework %>
+<% when :rdoc %>
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "<%= project_name %> #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+<% when :yard %>
+require 'yard'
+YARD::Rake::YardocTask.new
+<% end %>

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,4 @@
+require 'rubygems'
+<%= render_template 'bundler_setup.erb' %>
+require 'riot'
+require '<%= require_name %>'

data/lib/jeweler/templates/rspec/.rspec

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

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

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_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/rspec/helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require '<%= require_name %>'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

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

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/tests_helper')
+
+Shindo.tests("<%= constant_name %>") do
+  test("fails") do
+    "hey buddy, you should probably rename this file and start specing for real"
+    false
+  end
+end

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

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require '<%= require_name %>'
+require 'rubygems'
+<%= render_template 'bundler_setup.erb' %>
+require 'shindo'

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

@@ -0,0 +1,7 @@
+require 'helper'
+
+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
+end

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

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