technicalpickles-jeweler 0.8.1 → 0.9.0

data/ChangeLog.markdown

@@ -1,8 +1,27 @@
-# jeweler 0.8.1
+# jeweler x.y.z
+
+ * 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
+# jeweler 0.8.0 2009-02-03
 
  * Generator:
   * Supports these new testing frameworks:
@@ -13,26 +32,27 @@
   * 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
+# 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
+# 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
+# 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
+# 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
+# jeweler 0.6.4 2009-01-13
 
  * Added tasks `build` and `install` as shortcuts for `gem:build` and `gem:install`

data/README.markdown

@@ -5,10 +5,16 @@ 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
+## Installing
 
-It's easy to get up and running. Update your instantiate a `Jeweler::Tasks`, and give it a block with details about your project.
+    # 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'
@@ -26,7 +32,7 @@ It's easy to get up and running. Update your instantiate a `Jeweler::Tasks`, and
 
 In this example, `s` is a Gem::Specification object. See the [GemSpec reference](http://www.rubygems.org/read/chapter/20) for values of interest.
 
-## Kicking off a new project
+## 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).
 

data/Rakefile

@@ -1,33 +1,29 @@
 require 'rake'
-require 'rake/testtask'
-begin
-  require 'hanna/rdoctask'
-rescue LoadError
-  require 'rake/rdoctask'
-end
 
-
-$:.unshift('lib')
+$LOAD_PATH.unshift('lib')
 
 begin
   require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "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'
+  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/.gitignore']
+    gem.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
 
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+end
 
-Rake::TestTask.new 
-
+require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'jeweler'
@@ -38,17 +34,27 @@ end
 
 begin
   require 'rcov/rcovtask'
-  Rcov::RcovTask.new 
+  Rcov::RcovTask.new(:rcov) do |rcov|
+    rcov.libs << 'test'
+    rcov.pattern = 'test/**/test_*.rb'
+  end
 rescue LoadError
-  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  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
-  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
 end
 
-
-task :default => [:test, :features]
+if ENV["RUN_CODE_RUN"] == "true"
+  task :default => [:test, :features]
+else
+  task :default => :test
+end

data/TODO

@@ -7,5 +7,5 @@
    * Rails generator for making a plugin that's Jeweler enabled
    * Change generated test filename (test_foo not foo_test)
  * Releasing
-  * Open hasmygembuiltyet.org
- * Enable runcoderun by default
+  * Have a way to check if the gem is built yet
+ * Option for enabling

data/VERSION.yml

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

data/bin/jeweler

@@ -5,80 +5,4 @@ require 'optparse'
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'jeweler'
 
-class JewelerOpts < Hash
-  attr_reader :opts
-  
-  def initialize(args)
-    super()
-    
-    self[:testing_framework] = :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[:testing_framework] = :bacon
-      end
-      
-      o.on('--shoulda', 'generate shoulda tests') do
-        self[:testing_framework] = :shoulda
-      end
-      
-      o.on('--testunit', 'generate test/unit tests') do
-        self[:testing_framework] = :testunit
-      end
-      
-      o.on('--minitest', 'generate minitest tests') do
-        self[:testing_framework] = :minitest
-      end
-
-      o.on('--rspec', 'generate rspec tests') do
-        self[:testing_framework] = :rspec
-      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
+Jeweler::Generator::Application.run!(*ARGV)

data/lib/jeweler/commands/build_gem.rb

@@ -0,0 +1,22 @@
+class Jeweler
+  module Commands
+    class BuildGem
+      attr_accessor :base_dir, :gemspec_helper, :file_utils
+
+      def initialize
+        self.file_utils = FileUtils
+      end
+
+      def run
+        gemspec = gemspec_helper.parse
+        gem_file_name = Gem::Builder.new(gemspec).build
+
+        pkg_dir = File.join(base_dir, 'pkg')
+        file_utils.mkdir_p pkg_dir
+
+        gem_file_name = File.join(base_dir, gem_file_name)
+        file_utils.mv gem_file_name, pkg_dir
+      end
+    end
+  end
+end

data/lib/jeweler/commands/install_gem.rb

@@ -0,0 +1,19 @@
+class Jeweler
+  module Commands
+    class InstallGem
+      attr_accessor :gemspec_helper, :output
+
+      def initialize
+        self.output = $stdout
+      end
+
+
+      def run
+        command = "sudo gem install #{gemspec_helper.gem_path}"
+        output.puts "Executing #{command.inspect}:"
+
+        sh command # TODO where does sh actually come from!?
+      end
+    end
+  end
+end

data/lib/jeweler/commands/release.rb

@@ -0,0 +1,45 @@
+class Jeweler
+  module Commands
+    class Release
+      attr_accessor :gemspec, :version, :repo, :output, :gemspec_helper, :base_dir
+
+      def initialize
+        self.output = $stdout
+      end
+
+      def run
+        repo.checkout('master')
+
+        raise "Hey buddy, try committing them files first" if any_pending_changes?
+
+        gemspec_helper.write
+
+        repo.add(gemspec_helper.path)
+        output.puts "Committing #{gemspec_helper.path}"
+        repo.commit("Regenerated gemspec for version #{version}")
+
+        output.puts "Pushing master to origin"
+        repo.push
+
+        output.puts "Tagging #{release_tag}"
+        repo.add_tag(release_tag)
+
+        output.puts "Pushing #{release_tag} to origin"
+        repo.push('origin', release_tag)
+      end
+      
+      def any_pending_changes?
+        !(@repo.status.added.empty? && @repo.status.deleted.empty? && @repo.status.changed.empty?)
+      end
+
+      def release_tag
+        "v#{version}"
+      end
+
+      def gemspec_helper
+        @gemspec_helper ||= Jeweler::GemSpecHelper.new(self.gemspec, self.base_dir)
+      end
+
+    end
+  end
+end

data/lib/jeweler/commands/validate_gemspec.rb

@@ -0,0 +1,21 @@
+class Jeweler
+  module Commands
+    class ValidateGemspec
+      attr_accessor :gemspec_helper, :output
+
+      def initialize
+        self.output = $stdout
+      end
+
+      def run
+        begin
+          gemspec_helper.parse
+          output.puts "#{gemspec_helper.path} is valid."
+        rescue Exception => e
+          output.puts "#{gemspec_helper.path} is invalid. See the backtrace for more details."
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/jeweler/commands/version/base.rb

@@ -0,0 +1,30 @@
+class Jeweler
+  module Commands
+    module Version
+      class Base
+
+        attr_accessor :repo, :version_helper, :gemspec, :commit
+
+        def run
+          update_version
+
+          self.version_helper.write
+          self.gemspec.version = self.version_helper.to_s
+
+          commit_version if self.repo && self.commit
+        end
+
+        def update_version
+          raise "Subclasses should implement this"
+        end
+
+        def commit_version
+          if self.repo
+            self.repo.add('VERSION.yml')
+            self.repo.commit("Version bump to #{self.version_helper.to_s}", 'VERSION.yml')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jeweler/commands/version/bump_major.rb

@@ -0,0 +1,13 @@
+class Jeweler
+  module Commands
+    module Version
+      class BumpMajor < Base
+
+        def update_version
+          self.version_helper.bump_major
+        end
+
+      end
+    end
+  end
+end

data/lib/jeweler/commands/version/bump_minor.rb

@@ -0,0 +1,12 @@
+class Jeweler
+  module Commands
+    module Version
+      class BumpMinor < Base
+        
+        def update_version
+          self.version_helper.bump_minor
+        end
+      end
+    end
+  end
+end

data/lib/jeweler/commands/version/bump_patch.rb

@@ -0,0 +1,14 @@
+class Jeweler
+  module Commands
+    module Version
+      class BumpPatch < Base
+
+        def update_version
+          self.version_helper.bump_patch
+        end
+
+      end
+    end
+  end
+end
+

data/lib/jeweler/commands/version/write.rb

@@ -0,0 +1,12 @@
+class Jeweler
+  module Commands
+    module Version
+      class Write < Base
+        attr_accessor :major, :minor, :patch
+        def update_version
+          version_helper.update_to major, minor, patch
+        end
+      end
+    end
+  end
+end

data/lib/jeweler/commands/write_gemspec.rb

@@ -0,0 +1,26 @@
+class Jeweler
+  module Commands
+    class WriteGemspec
+      attr_accessor :base_dir, :gemspec, :version, :output, :gemspec_helper, :version_helper
+
+      def initialize
+        self.output = $stdout
+      end
+
+      def run
+        version_helper.refresh
+        gemspec_helper.spec.version = version_helper.to_s
+        gemspec_helper.spec.date    = Time.now
+
+        gemspec_helper.write
+
+        output.puts "Generated: #{gemspec_helper.path}"  
+      end
+
+      def gemspec_helper
+        @gemspec_helper ||= GemSpecHelper.new(self.gemspec, self.base_dir)
+      end
+
+    end
+  end
+end

data/lib/jeweler/commands.rb

@@ -0,0 +1,10 @@
+require 'jeweler/commands/build_gem'
+require 'jeweler/commands/install_gem'
+require 'jeweler/commands/release'
+require 'jeweler/commands/validate_gemspec'
+require 'jeweler/commands/write_gemspec'
+require 'jeweler/commands/version/base'
+require 'jeweler/commands/version/bump_major'
+require 'jeweler/commands/version/bump_minor'
+require 'jeweler/commands/version/bump_patch'
+require 'jeweler/commands/version/write'

data/lib/jeweler/{gemspec.rb → gemspec_helper.rb}

@@ -34,7 +34,13 @@ class Jeweler
 
     def parse
       data = File.read(path)
-      Thread.new { eval("$SAFE = 3\n#{data}", binding, path) }.join 
+      parsed_gemspec = nil
+      Thread.new { parsed_gemspec = eval("$SAFE = 3\n#{data}", binding, path) }.join 
+      parsed_gemspec
+    end
+
+    def gem_path
+      File.join(@base_dir, 'pkg', parse.file_name)
     end
 
   end

data/lib/jeweler/generator/application.rb

@@ -0,0 +1,45 @@
+class Jeweler
+  class Generator
+    class Application
+      class << self
+        def run!(*arguments)
+          options = Jeweler::Generator::Options.new(arguments)
+
+          if options[:show_help]
+            $stderr.puts options.opts
+            return 1
+          end
+
+          unless arguments.size == 1
+            $stderr.puts options.opts
+            return 1
+          end
+
+          github_repo_name = arguments.first
+
+          begin
+            generator = Jeweler::Generator.new(github_repo_name, options)
+            generator.run
+            return 0
+          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"}
+            return 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}
+            return 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}
+            return 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}
+            return 1
+          rescue Jeweler::FileInTheWay
+            $stderr.puts "The directory #{github_repo_name} already exists. Maybe move it out of the way before continuing?"
+            return 1
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/jeweler/generator/options.rb

@@ -0,0 +1,64 @@
+class Jeweler
+  class Generator
+    class Options < Hash
+      attr_reader :opts
+
+      def initialize(args)
+        super()
+
+        self[:testing_framework] = :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 specifications') do
+            self[:testing_framework] = :bacon
+          end
+
+          o.on('--shoulda', 'generate shoulda tests') do
+            self[:testing_framework] = :shoulda
+          end
+
+          o.on('--testunit', 'generate test/unit tests') do
+            self[:testing_framework] = :testunit
+          end
+
+          o.on('--minitest', 'generate minitest tests') do
+            self[:testing_framework] = :minitest
+          end
+
+          o.on('--rspec', 'generate rspec code examples') do
+            self[:testing_framework] = :rspec
+          end
+
+          o.on('--micronaut', 'generate micronaut examples') do
+            self[:testing_framework] = :micronaut
+          end
+
+          o.on('--cucumber', 'generate cucumber stories in addition to the other tests') do
+            self[:use_cucumber] = true
+          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('--directory [DIRECTORY]', 'specify the directory to generate into') do |directory|
+            self[:directory] = directory
+          end
+
+          o.on_tail('-h', '--help', 'display this help and exit') do
+            self[:show_help] = true
+          end
+        end
+
+        @opts.parse!(args)
+      end
+
+    end
+  end
+end