jeweler 0.10.2

data/ChangeLog.markdown

@@ -0,0 +1,64 @@
+# jeweler x.y.z
+ 
+ * 'rake install' now will 'rake build' first
+ * Support for releasing to RubyForge, thanks to jtrupiano
+ * Steps towards Ruby 1.9 support, thanks to rsanheim
+
+# jeweler 0.9.1 2009-03-05
+
+ * Tasks:
+  * Fixed populating default spec's extra_rdoc_files
+  * Removed redudant gem building/installing tasks. Use rake build and rake install
+ * Generator:
+  * Added support for micronaut
+  * Generate nicer block variable names in Rakefile
+  * Cucumber generation now places steps in features/step_features, to follow cucumber standards
+
+  * shoulda and test/unit test_helpers no longers require mocha 
+  * Rakefile uses more readable block variable names
+  * .gitignore now includes pkg and coverage directories
+  * Avoid puts'ing in Rakefile when LoadError occurs. Instead, define a task that aborts with instructions to install.
+  * Cucumber is now optional. Generate stories using --cucumber
+  * Bacon's 'test' task is now 'spec'
+  * Generate README.rdoc instead of just a plain text README 
+  * Updated year in README.rdoc and COPYRIGHT to be based on the current year instead of hardcoded
+
+# jeweler 0.8.1 2009-02-03
+
+ * Fixed minitest generator
+
+# jeweler 0.8.0 2009-02-03
+
+ * Generator:
+  * Supports these new testing frameworks:
+   * test/unit
+   * minitest
+   * rspec
+  * Added support for cucumber
+  * Creating a new gem is now more verbose, and will show files/directories created
+ * Binaries will now be automatically detected in 'bin'
+  
+# jeweler 0.7.2 2009-01-29
+
+ * Added rake task 'version:bump' which is shorthand for 'version:bump:patch'
+ * Generated projects no longer assume RCov is installed.
+
+# jeweler 0.7.1 2009-01-26
+
+ * Fixed yaml not being required
+ * Automatically add files in bin as executables in gemspec
+
+# jeweler 0.7.0 2009-01-19
+
+ * Added support to generator for specifying a description
+ * Condensed README.markdown to be less novel-like
+ * RDoc is now included in your gemspec
+ * Rescue errors that raise in the generator, and display better error message, and exit with a non-zero exit status
+
+# jeweler 0.6.5 2009-01-14
+
+ * `jeweler --create-repo foo` now enables gem creation in addition to creating the repository
+
+# jeweler 0.6.4 2009-01-13
+
+ * Added tasks `build` and `install` as shortcuts for `gem:build` and `gem:install`

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 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/README.markdown

@@ -0,0 +1,164 @@
+# Jeweler: Craft the perfect RubyGem
+
+Jeweler provides two things:
+
+ * Rake tasks for managing gems and versioning of a <a href="http://github.com">GitHub</a> project
+ * A generator for creating kickstarting a new project
+
+## Installing
+
+    # Run the following if you haven't done so before:
+    gem sources -a http://gems.github.com
+    # Install the gem:
+    sudo gem install technicalpickles-jeweler
+    
+## Using in an existing project
+
+It's easy to get up and running. Update your instantiate a `Jeweler::Tasks`, and give it a block with details about your project.
+
+    begin
+      require 'jeweler'
+      Jeweler::Tasks.new do |s|
+        s.name = "the-perfect-gem"
+        s.summary = "TODO"
+        s.email = "josh@technicalpickles.com"
+        s.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+        s.description = "TODO"
+        s.authors = ["Josh Nichols"]
+      end
+    rescue LoadError
+      puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+    end
+
+In this example, `s` is a Gem::Specification object. See the [GemSpec reference](http://www.rubygems.org/read/chapter/20) for values of interest.
+
+## Using to start a new project
+
+Jeweler provides a generator. It requires you to [setup your name and email for git](http://github.com/guides/tell-git-your-user-name-and-email-address) and [your username and token for GitHub](http://github.com/guides/local-github-config).
+
+    jeweler the-perfect-gem
+
+This will prepare a project in the 'the-perfect-gem' directory, setup to use Jeweler.
+
+It supports a number of options:
+
+ * --create-repo: in addition to preparing a project, it create an repo up on GitHub and enable RubyGem generation
+ * --testunit: generate test_helper.rb and test ready for test/unit
+ * --minitest: generate test_helper.rb and test ready for minitest 
+ * --shoulda: generate test_helper.rb and test ready for shoulda (this is the default)
+ * --rspec: generate spec_helper.rb and spec ready for rspec
+ * --bacon: generate spec_helper.rb and spec ready for bacon
+ * --rubyfoge: setup releasing to rubyforge
+
+## Gemspec
+
+Jeweler handles generating a gemspec file for your project:
+
+    rake gemspec
+
+This creates a gemspec for your project. It's based on the info you give `Jeweler::Tasks`, the current version of your project, and some defaults that Jeweler provides.
+
+## Gem
+
+Jeweler gives you tasks for building and installing your gem:
+
+    rake build
+    rake install
+
+## Versioning
+
+Jeweler tracks the version of your project. It assumes you will be using a version in the format `x.y.z`. `x` is the 'major' version, `y` is the 'minor' version, and `z` is the patch version.
+
+Initially, your project starts out at 0.0.0. Jeweler provides Rake tasks for bumping the version:
+
+    rake version:bump:major
+    rake version:bump:minor
+    rake version:bump:patch
+
+## Releasing to GitHub
+
+Jeweler handles releasing your gem into the wild:
+
+    rake release
+
+It does the following for you:
+
+ * Regenerate the gemspec to the latest version of your project
+ * Push to GitHub (which results in a gem being build)
+ * Tag the version and push to GitHub
+
+## Releasing to RubyForge
+
+Jeweler can also handle releasing to [RubyForge](http://rubyforge.org). There are a few steps you need to do before doing any RubyForge releases with Jeweler:
+
+ * [Create an account on RubyForge](http://rubyforge.org/account/register.php)
+ * Request a project on RubyForge. This involves waiting for a project approval, which can take any amount of time from a few hours to a week
+   * You might want to create an umbrella project where you can publish your gems, instead of one project per gem
+ * Install the RubyForge gem: sudo gem install rubyforge
+ * Run 'rubyforge setup' and fill in your username and password for RubyForge
+ * Run 'rubyforge config' to pull down information about your projects
+ * Run 'rubyforge login' to make sure you are able to login
+
+With this in place, you now update your Jeweler::Tasks to setup `rubyforge_project` with the RubyForge project you've just created. (Note, using `jeweler --rubyforge` when generating the project does this for you automatically.)
+
+    begin
+      require 'jeweler'
+      Jeweler::Tasks.new do |s|
+        s.name = "the-perfect-gem"
+        s.summary = "TODO"
+        s.email = "josh@technicalpickles.com"
+        s.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+        s.description = "TODO"
+        s.authors = ["Josh Nichols"]
+        s.rubyforge_project = 'the-perfect-gem' # This line would be new
+      end
+    rescue LoadError
+      puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+    end
+
+    # These are new tasks
+    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
+            config = YAML.load(
+                File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+            )
+    
+            host = "#{config['username']}@rubyforge.org"
+            remote_dir = "/var/www/gforge-projects/the-perfect-gem/"
+            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
+
+Now you must initially create a 'package' for your gem in your 'project':
+
+    $ rake rubyforge:setup
+
+With all that setup out of the way, you can now release to RubyForge with impunity. This would release the current version of your gem, and upload the rdoc as your project's webpage.
+
+    $ rake rubyforge:release
+
+## Workflow
+
+ * Hack, commit, hack, commit, etc, etc
+ * `rake version:bump:patch release` to do the actual version bump and release
+ * Have a delicious scotch
+ * Install [gemstalker](http://github.com/technicalpickles/gemstalker), and use it to know when gem is built. It typically builds in a few minutes, but won't be installable for another 15 minutes.
+
+## Links
+
+ * [Bugs](http://technicalpickles.lighthouseapp.com/projects/23560-jeweler/overview)
+ * [Donate](http://pledgie.org/campaigns/2604)

data/Rakefile

@@ -0,0 +1,89 @@
+require 'rake'
+
+$LOAD_PATH.unshift('lib')
+
+begin
+  require 'jeweler'
+  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"]
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.document', 'lib/jeweler/templates/.gitignore']
+    gem.add_dependency "peterwald-git"
+    gem.rubyforge_project = "pickles"
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.pattern = 'test/**/test_*.rb'
+  test.libs << 'test'
+  test.verbose = true
+  #test.ruby_opts << '-rtest_helper'
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'jeweler'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new(:rcov) do |rcov|
+    rcov.libs << 'test'
+    rcov.pattern = 'test/**/test_*.rb'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+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
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/pickles"
+        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
+
+if ENV["RUN_CODE_RUN"] == "true"
+  task :default => [:test, :features]
+else
+  task :default => :test
+end

data/TODO

@@ -0,0 +1,11 @@
+ * use some sort of logger instead of stdout and stderr
+ * jeweler --delete-repo 
+ * output gemspec as yaml
+ * move interactions with github into separate class
+ * use Net::HTTP.post_form instead of `` for enabling gem creation
+ * Generators
+   * Rails generator for making a plugin that's Jeweler enabled
+   * Change generated test filename (test_foo not foo_test)
+ * Releasing
+  * Have a way to check if the gem is built yet
+ * Option for enabling

data/VERSION.yml

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

data/bin/jeweler

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'jeweler'
+
+Jeweler::Generator::Application.run!(*ARGV)

data/lib/jeweler.rb

@@ -0,0 +1,154 @@
+require 'date'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+require 'rubyforge'
+
+require 'jeweler/errors'
+require 'jeweler/version_helper'
+require 'jeweler/gemspec_helper'
+require 'jeweler/generator'
+require 'jeweler/generator/options'
+require 'jeweler/generator/application'
+
+require 'jeweler/commands'
+
+require 'jeweler/tasks'
+
+# A Jeweler helps you craft the perfect Rubygem. Give him a gemspec, and he takes care of the rest.
+class Jeweler
+
+  attr_reader :gemspec, :gemspec_helper, :version_helper
+  attr_accessor :base_dir, :output, :repo, :commit, :rubyforge
+
+  def initialize(gemspec, base_dir = '.')
+    raise(GemspecError, "Can't create a Jeweler with a nil gemspec") if gemspec.nil?
+
+    @base_dir       = base_dir
+    @gemspec        = fill_in_gemspec_defaults(gemspec)
+    @repo           = Git.open(base_dir) if in_git_repo?
+    @version_helper = Jeweler::VersionHelper.new(@base_dir)
+    @output         = $stdout
+    @commit         = true
+    @gemspec_helper = GemSpecHelper.new(@gemspec, base_dir)
+    @rubyforge      = RubyForge.new
+  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
+    @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
+
+  def build_gem
+    Jeweler::Commands::BuildGem.build_for(self).run
+  end
+
+  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, options = {})
+    command = Jeweler::Commands::Version::Write.build_for(self)
+    command.major = major
+    command.minor = minor
+    command.patch = patch
+
+    command.run
+  end
+
+  def release
+    Jeweler::Commands::Release.build_for(self).run
+  end
+  
+  def release_gem_to_rubyforge
+    Jeweler::Commands::ReleaseToRubyforge.build_for(self).run
+  end
+
+  def setup_rubyforge
+    Jeweler::Commands::SetupRubyforge.build_for(self).run
+  end
+
+
+  def in_git_repo?
+    File.exists?(File.join(self.base_dir, '.git'))
+  end
+
+  protected
+
+  def fill_in_gemspec_defaults(gemspec)
+    if gemspec.files.nil? || gemspec.files.empty?
+      gemspec.files = FileList["[A-Z]*.*", "{bin,generators,lib,test,spec}/**/*"]
+    end
+
+    if gemspec.executables.nil? || gemspec.executables.empty?
+      gemspec.executables = Dir["#{@base_dir}/bin/*"].map do |f|
+        File.basename(f)
+      end
+    end
+
+    gemspec.has_rdoc = true
+    gemspec.rdoc_options << '--inline-source' << '--charset=UTF-8'
+
+    if gemspec.extra_rdoc_files.nil? || gemspec.extra_rdoc_files.empty?
+      gemspec.extra_rdoc_files = FileList["README*", "ChangeLog*", "LICENSE*"]
+    end
+
+    gemspec
+  end
+end
+