dima-jeweler 0.9.2 → 1.2.0

data/.gitignore

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

data/ChangeLog.markdown

@@ -1,4 +1,57 @@
-# jeweler x.y.z
+# 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

data/README.markdown

@@ -5,32 +5,37 @@ 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
 
-    # 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
+    sudo gem install 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.
+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 |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"]
+      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
 
-In this example, `s` is a Gem::Specification object. See the [GemSpec reference](http://www.rubygems.org/read/chapter/20) for values of interest.
+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
 
@@ -48,6 +53,13 @@ It supports a number of options:
  * --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
+ * --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
 
@@ -74,7 +86,7 @@ Initially, your project starts out at 0.0.0. Jeweler provides Rake tasks for bum
     rake version:bump:minor
     rake version:bump:patch
 
-## Releasing
+## Releasing to GitHub
 
 Jeweler handles releasing your gem into the wild:
 
@@ -86,18 +98,75 @@ It does the following for you:
  * Push to GitHub (which results in a gem being build)
  * Tag the version and push to GitHub
 
-Jeweler also handles releasing your gem to RubyForge.  Assuming you've configured ~/.ruby_forge properly and included :rubyforge_project in your Jeweler::Tasks block, the following will release your gem to RubyForge:
+## 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
 
-    rake rubyforge:release:gem
+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
- * Go to [Has My Gem Built Yet](http://hasmygembuiltyet.org) and wait for your gem to be built
+ * 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/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

@@ -2,6 +2,9 @@ require 'rake'
 
 $LOAD_PATH.unshift('lib')
 
+gem 'git'
+require 'git'
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
@@ -11,28 +14,49 @@ begin
     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/.gitignore']
-    gem.add_dependency 'schacon-git'
+    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::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 technicalpickles-jeweler -s http://gems.github.com"
+  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.pattern = 'test/**/test_*.rb'
+  test.test_files = FileList.new('test/**/test_*.rb') do |list|
+    list.exclude 'test/test_helper.rb'
+  end
   test.libs << 'test'
+  test.verbose = true
 end
 
-require 'rake/rdoctask'
-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')
+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|
@@ -47,11 +71,23 @@ end
 
 begin
   require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
+  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"
@@ -59,3 +95,7 @@ if ENV["RUN_CODE_RUN"] == "true"
 else
   task :default => :test
 end
+
+
+task :test => :check_dependencies
+task :features => :check_dependencies

data/VERSION.yml

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

data/features/generator/cucumber.feature

@@ -0,0 +1,83 @@
+Feature: generating cucumber stories
+  In order to get started using cucumber in a project
+  A user should be able to
+  generate a project setup for their testing framework of choice
+
+  Scenario: sans cucumber setup
+    Given a working directory
+    And I have configured git sanely
+    And I do not want cucumber stories
+    When I generate a project named 'the-perfect-gem' that is 'zomg, so good'
+
+    And a file named 'the-perfect-gem/features/the-perfect-gem.feature' is not created
+    And a file named 'the-perfect-gem/features/support/env.rb' is not created
+    And a file named 'the-perfect-gem/features/steps/the-perfect-gem_steps.rb' is not created
+    
+  Scenario: basic cucumber setup
+    Given a working directory
+    And I have configured git sanely
+    And I want cucumber stories
+    When I generate a project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then cucumber directories are created
+
+    And a file named 'the-perfect-gem/features/the-perfect-gem.feature' is created
+    And a file named 'the-perfect-gem/features/support/env.rb' is created
+    And a file named 'the-perfect-gem/features/step_definitions/the-perfect-gem_steps.rb' is created
+
+    And 'features/support/env.rb' requires 'the-perfect-gem'
+
+  Scenario: cucumber setup for bacon
+    Given a working directory
+    And I have configured git sanely
+    And I want cucumber stories
+    When I generate a bacon project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then 'features/support/env.rb' requires 'test/unit/assertions'
+    And cucumber world extends "Test::Unit::Assertions"
+
+  Scenario: cucumber setup for shoulda
+    Given a working directory
+    And I have configured git sanely
+    And I want cucumber stories
+    When I generate a shoulda project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then 'features/support/env.rb' requires 'test/unit/assertions'
+    And cucumber world extends "Test::Unit::Assertions"
+
+  Scenario: cucumber setup for testunit
+    Given a working directory
+    And I have configured git sanely
+    And I want cucumber stories
+    When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then 'features/support/env.rb' requires 'test/unit/assertions'
+    And cucumber world extends "Test::Unit::Assertions"
+
+  Scenario: cucumber setup for minitest
+    Given a working directory
+    And I have configured git sanely
+    And I want cucumber stories
+    When I generate a minitest project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then 'features/support/env.rb' requires 'mini/test'
+    And cucumber world extends "Mini::Test::Assertions"
+
+  Scenario: cucumber setup for rspec
+    Given a working directory
+    And I have configured git sanely
+    And I want cucumber stories
+    When I generate a rspec project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then 'features/support/env.rb' requires 'the-perfect-gem'
+    And 'features/support/env.rb' requires 'spec/expectations'
+
+  Scenario: cucumber setup for mirconaut
+    Given a working directory
+    And I have configured git sanely
+    And I want cucumber stories
+    When I generate a micronaut project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then 'features/support/env.rb' requires 'the-perfect-gem'
+    And 'features/support/env.rb' requires 'micronaut/expectations'
+    And cucumber world extends "Micronaut::Matchers"

data/features/generator/directory_layout.feature

@@ -0,0 +1,76 @@
+Feature: generated directory layout
+  In order to start a new gem
+  A user should be able to
+  generate a directory layout
+
+  Scenario: shared
+    Given a working directory
+    And I have configured git sanely
+    When I generate a project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then a directory named 'the-perfect-gem' is created
+    And a directory named 'the-perfect-gem/lib' is created
+
+    And a file named 'the-perfect-gem/README.rdoc' is created
+    And a file named 'the-perfect-gem/.document' is created
+    And a file named 'the-perfect-gem/lib/the-perfect-gem.rb' is created
+
+  Scenario: bacon
+    Given a working directory
+    And I have configured git sanely
+    When I generate a bacon project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then a directory named 'the-perfect-gem/spec' is created
+
+    And a file named 'the-perfect-gem/spec/spec_helper.rb' is created
+    And a file named 'the-perfect-gem/spec/the-perfect-gem_spec.rb' is created
+
+  Scenario: minitest
+    Given a working directory
+    And I have configured git sanely
+    When I generate a minitest project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then a directory named 'the-perfect-gem/test' is created
+
+    And a file named 'the-perfect-gem/test/test_helper.rb' is created
+    And a file named 'the-perfect-gem/test/the-perfect-gem_test.rb' is created
+
+  Scenario: rspec
+    Given a working directory
+    And I have configured git sanely
+    When I generate a rspec project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then a directory named 'the-perfect-gem/spec' is created
+
+    And a file named 'the-perfect-gem/spec/spec_helper.rb' is created
+    And a file named 'the-perfect-gem/spec/the-perfect-gem_spec.rb' is created
+
+  Scenario: shoulda
+    Given a working directory
+    And I have configured git sanely
+    When I generate a shoulda project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then a directory named 'the-perfect-gem/test' is created
+
+    And a file named 'the-perfect-gem/test/test_helper.rb' is created
+    And a file named 'the-perfect-gem/test/the-perfect-gem_test.rb' is created
+
+  Scenario: testunit
+    Given a working directory
+    And I have configured git sanely
+    When I generate a testunit project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then a directory named 'the-perfect-gem/test' is created
+
+    And a file named 'the-perfect-gem/test/test_helper.rb' is created
+    And a file named 'the-perfect-gem/test/the-perfect-gem_test.rb' is created
+
+  Scenario: micronaut
+    Given a working directory
+    And I have configured git sanely
+    When I generate a micronaut project named 'the-perfect-gem' that is 'zomg, so good'
+
+    Then a directory named 'the-perfect-gem/examples' is created
+
+    And a file named 'the-perfect-gem/examples/example_helper.rb' is created
+    And a file named 'the-perfect-gem/examples/the-perfect-gem_example.rb' is created