mcornick-jeweler 1.2.0

data/.gitignore

@@ -0,0 +1,9 @@
+coverage
+pkg
+doc
+rdoc
+tags
+test/tmp
+test/version_tmp
+tmp
+.yardoc

data/ChangeLog.markdown

@@ -0,0 +1,111 @@
+# jeweler 1.2.0 2009-08-06
+ * Generator now adds development dependencies appropriate to your testing framework
+ * Added check_dependencies tasks for verifying gem dependencies are installed
+ * Fixed typo in generated yard task
+ * Fixed generator from having a lot of extra newlines
+
+# jeweler 1.1.0 2009-08-05
+
+ * Support for generating a project that uses yard instead of rdoc
+ * Generated gemspec now includes comments about it being generated by jeweler
+ * Only use sudo for installing on non-windows platforms [#1]
+ * Fixed rake release to be repeatable on the same version [#16]
+ * Fixed rake rubyforge:setup to not create duplicate packages
+ * Use a more recent version of ruby-git
+  * Fixes various issues with reading values out of ~/.gitconfig [#26] [#21] [#19]
+ * Experimenting with a rake task to check development time dependencies [#22]
+ * Fixed generated rdoc task to load from VERSION instead of VERSION.yml
+
+# jeweler 1.0.2 2009-07-29
+
+ * Don't include git ignored files for default gemspec's files and test_files
+ * Fixed rspec generator to allow specs to be run directly
+ * Removed misleading docstring for version_required rake task [#17]
+ * Includes some notes about contributed in generated README
+ * Added support for generating a project to use reek and roodi
+
+# jeweler 1.0.1 2009-05-15
+
+# jeweler 0.11.1
+
+ * Lots of internal refactorings to how project generation happens
+ * Fixed missing dependency on rubyforge
+ * Depend on a recent version of schacon-git which works on ruby 1.9
+ * Updated cucumber support for 0.3.x
+ * Tested on Ruby 1.9
+
+# jeweler 0.11.0 2009-04-05
+
+ * generator will respect JEWELER_OPTS, as a way to provide default options
+ (pat-maddox)
+ * Include 'examples' and 'rails' directories by default in gemspec files
+ * generated gemspec now will only include files (not directories). also, they are listed one per line, and sorted.
+ * Jeweler::Tasks's intializer has been improved:
+  * You can now pass it an existing gemspec (othewise a new one will be created)
+  * Jeweler sets its defaults before yielding the gemspec to you. This allows you to append to its defaults, so you aren't forced to entirely overwrite them just to add one value.
+ * Managing a gemspec's files, test_files, and extra_rdoc_files is now more flexible. They are now wrapped in a FileList, so you can easily 'include' or 'exclude' patterns.
+
+# jeweler 0.10.2 2009-03-26
+ 
+ * '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,185 @@
+# 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
+
+## Quick Links
+
+ * [Wiki](http://wiki.github.com/technicalpickles/jeweler)
+ * [Bugs](http://github.com/technicalpickles/jeweler/issues)
+ * [Donate](http://pledgie.org/campaigns/2604)
+
+## Installing
+
+    # Install the gem:
+    sudo gem install jeweler
+    
+## Using in an existing project
+
+It's easy to get up and running. Update your Rakefile to instantiate a `Jeweler::Tasks`, and give it a block with details about your project.
+
+    begin
+      require 'jeweler'
+      Jeweler::Tasks.new do |gemspec|
+        gemspec.name = "the-perfect-gem"
+        gemspec.summary = "Summarize your gem"
+        gemspec.description = "Describe your gem"
+        gemspec.email = "josh@technicalpickles.com"
+        gemspec.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+        gemspec.description = "TODO"
+        gemspec.authors = ["Josh Nichols"]
+      end
+    rescue LoadError
+      puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+    end
+
+The yield object here, `gemspec`, is a `Gem::Specification` object. See the [Customizing your project's gem specification](http://wiki.github.com/technicalpickles/jeweler/customizing-your-projects-gem-specification) for more details about how you can customize your gemspec.
+
+## 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
+ * --gemcutter: setup releasing to gemcutter
+ * --rubyforge: setup releasing to rubyforge
+
+### Default options
+
+Jeweler respects the JEWELER_OPTS environment variable. Want to always use RSpec, and you're using bash? Add this to ~/.bashrc:
+
+    export JEWELER_OPTS="--rspec"
+
+## 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 Gemcutter
+
+Jeweler can also handle releasing to [Gemcutter](http://gemcutter.org). There are a few steps you need to do before doing any Gemcutter releases with Jeweler:
+
+ * [Create an account on Gemcutter](http://gemcutter.org/sign_up)
+ * Install the Gemcutter gem: sudo gem install gemcutter
+ * Run 'gemcutter tumble' to set up gemcutter
+
+With all that setup out of the way, you can now release to Gemcutter with impunity. This would release the current version of your gem.
+
+    $ rake gemcutter:release
+
+## 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.description = "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 jeweler"
+    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.
+

data/ROADMAP

@@ -0,0 +1,12 @@
+= 1.0
+
+ * Improve documentation on wiki/readme
+
+= Unscheduled, or waiting for contributions
+
+ * Add command to output the Jeweler::Tasks to help with upgrading/migrating
+ * Support github user/token on generator command line
+ * Support C extensions
+ * Support JRuby gems
+ * Support thor
+ * Dealing with version bumps in other remotes

data/Rakefile

@@ -0,0 +1,103 @@
+require 'rake'
+
+$LOAD_PATH.unshift('lib')
+
+gem 'git'
+require 'git'
+
+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.include %w(lib/jeweler/templates/.document lib/jeweler/templates/.gitignore)
+
+    gem.add_dependency "git", ">= 1.2.1"
+    gem.add_dependency "rubyforge"
+
+    gem.rubyforge_project = "pickles"
+
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "mhennemeyer-output_catcher"
+    gem.add_development_dependency "rr"
+    gem.add_development_dependency "mocha"
+    gem.add_development_dependency "redgreen"
+  end
+
+  Jeweler::GemcutterTasks.new
+
+  Jeweler::RubyforgeTasks.new do |t|
+    t.doc_task = :yardoc
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList.new('test/**/test_*.rb') do |list|
+    list.exclude 'test/test_helper.rb'
+  end
+  test.libs << 'test'
+  test.verbose = true
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new(:yardoc) do |t|
+    t.files   = FileList['lib/**/*.rb'].exclude('lib/jeweler/templates/**/*.rb')
+  end
+rescue LoadError
+  task :yardoc do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+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) do |features|
+    features.cucumber_opts = "features --format progress"
+  end
+  namespace :features do
+    Cucumber::Rake::Task.new(:pretty) do |features|
+      features.cucumber_opts = "features --format progress"
+    end
+  end
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+  namespace :features do
+    task :pretty do
+      abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+    end
+  end
+end
+
+if ENV["RUN_CODE_RUN"] == "true"
+  task :default => [:test, :features]
+else
+  task :default => :test
+end
+
+
+task :test => :check_dependencies
+task :features => :check_dependencies

data/VERSION.yml

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