mattknox-jeweler 0.7.0

data/ChangeLog.markdown

@@ -0,0 +1,14 @@
+# jeweler 0.6.6
+
+ * 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
+
+ * `jeweler --create-repo foo` now enables gem creation in addition to creating the repository
+
+# jeweler 0.6.4
+
+ * 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,90 @@
+# 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
+
+## Setting up 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 documentation for what possible values you can set on it. 
+
+## Kicking off 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
+ * --shoulda: generate test_helper.rb and empty test ready for shoulda (this is the default)
+ * --bacon: generate spec_helper.rb and empty spec ready for bacon
+
+## 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
+
+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
+
+## Workflow
+
+ * Hack, commit, hack, commit, etc, etc
+ * `rake version:bump:patch release` to do the actual version bump and release
+ * Have a delicious scotch
+ * Go to [Has My Gem Built Yet](http://hasmygembuiltyet.org) and wait for your gem to be built
+
+## Links
+
+ * [Bugs](http://technicalpickles.lighthouseapp.com/projects/23560-jeweler/overview)
+ * [Donate](http://pledgie.org/campaigns/2604)

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'rake/testtask'
+begin
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake/rdoctask'
+end
+
+require 'rcov/rcovtask'
+
+$:.unshift('lib')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "jeweler"
+    s.executables = "jeweler"
+    s.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+    s.email = "josh@technicalpickles.com"
+    s.homepage = "http://github.com/technicalpickles/jeweler"
+    s.description = "Simple and opinionated helper for creating Rubygem projects on GitHub"
+    s.authors = ["Josh Nichols"]
+    s.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
+    s.add_dependency 'schacon-git'
+  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
+
+
+Rake::TestTask.new 
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'jeweler'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rcov::RcovTask.new 
+
+task :default => :rcov

data/TODO

@@ -0,0 +1,13 @@
+ * 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
+   * Support rspec?
+   * Support test/unit
+   * Change generated test filename (test_foo not foo_test)
+ * Releasing
+  * Open hasmygembuiltyet.org
+ * enable runcoderun by default

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 7

data/bin/jeweler

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'jeweler'
+
+class JewelerOpts < Hash
+  attr_reader :opts
+  
+  def initialize(args)
+    super()
+    
+    self[:test_style] = :shoulda
+    
+    @opts = OptionParser.new do |o|
+      o.banner = "Usage: #{File.basename($0)} [options] reponame\ne.g. #{File.basename($0)} the-perfect-gem"
+      
+      o.on('--bacon', 'generate bacon specs') do
+        self[:test_style] = :bacon
+      end
+      
+      o.on('--shoulda', 'generate shoulda tests') do
+        self[:test_style] = :shoulda
+      end
+      
+      o.on('--create-repo', 'create the repository on GitHub') do
+        self[:create_repo] = true
+      end
+
+      o.on('--summary [SUMMARY]', 'specify the summary of the project') do |summary|
+        self[:summary] = summary
+      end
+      
+      o.on_tail('-h', '--help', 'display this help and exit') do
+        puts o
+        exit
+      end
+    end
+    
+    @opts.parse!(args)
+  end
+end
+
+options = JewelerOpts.new(ARGV)
+
+unless ARGV.size == 1
+  puts options.opts
+  exit 1
+end
+
+github_repo_name = ARGV.first
+
+begin
+  generator = Jeweler::Generator.new github_repo_name, options
+  generator.run
+rescue Jeweler::NoGitUserName
+  $stderr.puts %Q{No user.name found in ~/.gitconfig. Please tell git about yourself (see http://github.com/guides/tell-git-your-user-name-and-email-address for details). For example: git config --global user.name "mad voo"}
+  exit 1
+rescue Jeweler::NoGitUserEmail
+  $stderr.puts %Q{No user.email found in ~/.gitconfig. Please tell git about yourself (see http://github.com/guides/tell-git-your-user-name-and-email-address for details). For example: git config --global user.email mad.vooo@gmail.com}
+  exit 1
+rescue Jeweler::NoGitHubUser
+  $stderr.puts %Q{No github.user found in ~/.gitconfig. Please tell git about your GitHub account (see http://github.com/blog/180-local-github-config for details). For example: git config --global github.user defunkt}
+  exit 1
+rescue Jeweler::NoGitHubToken
+  $stderr.puts %Q{No github.token found in ~/.gitconfig. Please tell git about your GitHub account (see http://github.com/blog/180-local-github-config for details). For example: git config --global github.token 6ef8395fecf207165f1a82178ae1b984}
+  exit 1
+rescue Jeweler::FileInTheWay
+  $stderr.puts "The directory #{github_repo_name} already exists. Maybe move it out of the way before continuing?"
+  exit 1
+end

data/lib/jeweler.rb

@@ -0,0 +1,231 @@
+require 'date'
+require 'rubygems/builder'
+
+require 'jeweler/version'
+require 'jeweler/gemspec'
+require 'jeweler/errors'
+require 'jeweler/generator'
+
+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
+  attr_accessor :base_dir
+
+  def initialize(gemspec, base_dir = '.')
+    raise(GemspecError, "Can't create a Jeweler with a nil gemspec") if gemspec.nil?
+    @gemspec = gemspec
+    @base_dir = base_dir
+    
+    if @gemspec.files.nil? || @gemspec.files.empty?
+      @gemspec.files = FileList["[A-Z]*.*", "{bin,generators,lib,test,spec}/**/*"]
+    end
+
+    @gemspec.has_rdoc = true
+    @gemspec.rdoc_options << '--inline-source' << '--charset=UTF-8'
+    @gemspec.extra_rdoc_files ||=  FileList["[A-Z]*.*"]
+
+    if File.exists?(File.join(base_dir, '.git'))
+      @repo = Git.open(base_dir)
+    end
+
+    @version = Jeweler::Version.new(@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.major
+  end
+
+  # Minor version, as defined by the gemspec's Version module.
+  # For 1.5.3, this would return 5.
+  def minor_version
+    @version.minor
+  end
+
+  # Patch version, as defined by the gemspec's Version module.
+  # For 1.5.3, this would return 5.
+  def patch_version
+    @version.patch
+  end
+
+  # Human readable version, which is used in the gemspec.
+  def version
+    @version.to_s
+  end
+
+  # Writes out the gemspec
+  def write_gemspec
+    self.refresh_version
+
+    helper = gemspec_helper do |s|
+      s.version = self.version
+      s.date = Time.now
+    end
+
+    helper.write
+
+    puts "Generated: #{helper.path}"
+  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
+    begin
+      gemspec_helper.parse
+      puts "#{gemspec_path} is valid."
+    rescue Exception => e
+      puts "#{gemspec_path} is invalid. See the backtrace for more details."
+      raise
+    end
+  end
+
+
+  # is the project's gemspec from disk valid?
+  def valid_gemspec?
+    gemspec_helper.valid?
+  end
+
+  # parses the project's gemspec from disk without extra sanity checks
+  def unsafe_parse_gemspec(data = nil)
+    data ||= File.read(gemspec_path)
+    eval(data, binding, gemspec_path)
+  end
+
+  def build_gem
+    parsed_gemspec = unsafe_parse_gemspec()
+    Gem::Builder.new(parsed_gemspec).build
+
+    pkg_dir = File.join(@base_dir, 'pkg')
+    FileUtils.mkdir_p pkg_dir
+
+    gem_filename = File.join(@base_dir, parsed_gemspec.file_name)
+    FileUtils.mv gem_filename, pkg_dir
+  end
+
+  def install_gem
+    command = "sudo gem install #{gem_path}"
+    $stdout.puts "Executing #{command.inspect}:"
+    sh command
+  end
+
+  # Bumps the patch version.
+  #
+  # 1.5.1 -> 1.5.2
+  def bump_patch_version(options = {})
+    options = version_writing_options(options)
+
+    @version.bump_patch
+    @version.write
+
+    commit_version if options[:commit]
+  end
+
+  # Bumps the minor version.
+  #
+  # 1.5.1 -> 1.6.0
+  def bump_minor_version(options = {})
+    options = version_writing_options(options)
+
+    @version.bump_minor
+    @version.write
+
+    commit_version if options[:commit]
+  end
+
+  # Bumps the major version.
+  #
+  # 1.5.1 -> 2.0.0
+  def bump_major_version(options = {})
+    options = version_writing_options(options)
+
+    @version.bump_major
+    @version.write
+
+    commit_version if options[:commit]
+  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 = {})
+    options = version_writing_options(options)
+
+    @version.update_to major, minor, patch
+    @version.write
+
+    @gemspec.version = @version.to_s
+
+    commit_version if options[:commit]
+  end
+
+
+  def release
+    @repo.checkout('master')
+
+    raise "Hey buddy, try committing them files first" if any_pending_changes?
+
+    write_gemspec()
+
+    @repo.add(gemspec_path)
+    $stdout.puts "Committing #{gemspec_path}"
+    @repo.commit("Regenerated gemspec for version #{version}")
+
+    $stdout.puts "Pushing master to origin"
+    @repo.push
+
+    $stdout.puts "Tagging #{release_tag}"
+    @repo.add_tag(release_tag)
+
+    $stdout.puts "Pushing #{release_tag} to origin"
+    @repo.push('origin', release_tag)
+  end
+
+  def release_tag
+    @release_tag ||= "v#{version}"
+  end
+
+  protected
+
+  def version_writing_options(options)
+    {:commit => true}.merge(options)
+  end
+
+  def commit_version
+    if @repo
+      @repo.add('VERSION.yml')
+      @repo.commit("Version bump to #{version}", 'VERSION.yml')
+    end
+  end
+
+  def refresh_version
+    @version.refresh
+  end
+
+  def gemspec_helper(&block)
+    GemSpecHelper.new(@gemspec, @base_dir, &block)
+  end
+
+  def gemspec_path
+    gemspec_helper.path
+  end
+
+  def gem_path
+    parsed_gemspec = unsafe_parse_gemspec()
+    File.join(@base_dir, 'pkg', parsed_gemspec.file_name)
+  end
+
+  def any_pending_changes?
+    unless ENV['JEWELER_DEBUG'].nil? || ENV['JEWELER_DEBUG'].squeeze == ''
+      require 'ruby-debug'; breakpoint
+    end
+    !(@repo.status.added.empty? && @repo.status.deleted.empty? && @repo.status.changed.empty?)
+  end
+
+  protected
+    def any_pending_changes?
+      !(@repo.status.added.empty? && @repo.status.deleted.empty? && @repo.status.changed.empty?)
+    end
+end
+