technicalpickles-jeweler 0.0.7 → 0.1.1

data/README.markdown

@@ -6,18 +6,18 @@ Trouble is when developing your Rubygems on GitHub, you generally do one of the
 
  * Manage the gemspec by hand
   * ... why bother doing something by hand when you can automate it?
- * Write your own rake stuff to manage the gemspec, and deal with managing the version somehow
+ * Write your own Rake stuff to create the Gem::Specification and output it to a gemspec file, and deal with keeping the Rakefile and gemspec in sync
   * ... why keep reinventing the wheel?
- * use hoe or echoe for generating the gemspec
+ * Use hoe or echoe for generating the gemspec
   * ... why use utilities made for the days before GitHub existed?
   * ... why have extra stuff you aren't going to use?
  
-Jeweler was created with some simple goals:
+Jeweler was created with a few intentions:
 
  * The only configuration should be providing a Gem::Specification to Jeweler
  * Version bumping should only be one command away
- * Authoritative version information should stored in one place, a Version module in your project
- * Jeweler should only concern itself with versioning and gems (and one day, git)
+ * Authoritative version information should stored in one place
+ * Jeweler should only concern itself with versioning and gems
  * Your Rakefile should be usable when Jeweler isn't installed (you just wouldn't be able to version bump or generate a gemspec)
  * Jeweler should use Jeweler. Oh the meta!
  
@@ -58,38 +58,20 @@ Install the gem:
         s.files =  FileList["[A-Z]*", "{generators,lib,test}/**/*"]
       end
     rescue LoadError
-      puts "Jeweler not available. Try installing technicalpickles-jeweler."
+      puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
     end
 
 Note, we don't include 'date', or 'version'. Jeweler handles filing these in when it needs them.
 
-If you don't specify `s.files`, it will use `s.files = FileList["[A-Z]*", "{generators,lib,test,spec}/**/*"]`.
-
-For now, `s.name` should be lower-cased and underscored, without hyphens. That's because Jeweler camelizes and constantizes this value internally. For example, `ruby-debug` would be camelized/constanized to `Ruby-debug`, which isn't a valid constant. Use `ruby_debug` instead (for now).
+If you don't specify `s.files`, it will use `s.files = FileList["[A-Z]*.*", "{generators,lib,test,spec}/**/*"]`.
 
 ### Create a version file
 
-Stick it in `lib/(spec_name_here)/version.rb`, and start it out at some version, like 0.0.0:
+Create an initial `VERSION.yml`. It will by default to 0.0.0, but you can specify MAJOR, MINOR, and PATCH to tweak it:
 
-    class Jeweler
-      module Version
-        MAJOR = 0
-        MINOR = 0
-        PATCH = 0
-      end
-    end
-
-OR
-
-    module Jeweler
-      module Version
-        MAJOR = 0
-        MINOR = 0
-        PATCH = 0
-      end
-    end
-
-Which you use depends on how you want to organize your gem. If you have a top-level class, like Jeweler, use the first. If you have a top level module, like ActiveRecord, use the latter.
+    $ rake version:write MAJOR=1 MINOR=5 PATCH=2
+    (in /Users/nichoj/Projects/jeweler)
+    Wrote to VERSION.yml: 1.5.2
 
 ### Generate the gemspec
 
@@ -122,6 +104,10 @@ You have a few rake tasks for doing the version bump:
     $ rake version:bump:minor # 1.5.1 -> 1.6.0
     $ rake version:bump:major # 1.5.1 -> 2.0.0
 
+If you need to do an arbitrary bump, use the same task you used to create `VERSION.yml`:
+
+    $ rake version:write MAJOR=6 MINOR=0 PATCH=3
+
 After that, commit and push it:
 
     $ git commit -a -m "Version bump, yo."
@@ -130,3 +116,51 @@ After that, commit and push it:
 ### Play the waiting game
 
 Wander over to [Has My Gem Built Yet](http://hasmygembuiltyet.org/) to play the waiting game.
+
+## Extra stuff you might want to for your RubyGem project
+
+As was mentioned, Jeweler tries to only do versioning and gem stuff. Most projects have a few other needs:
+
+ * Testing
+ * RDoc
+ * Default task
+
+Jeweler doesn't provide these. But it's easy enough to use Rake's built in tasks:
+
+    require 'rake'
+    require 'rake/testtask'
+    require 'rake/rdoctask'
+
+    begin
+      require 'rubygems'
+      require 'jeweler'
+      Jeweler.gemspec = Gem::Specification.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", "Dan Croak"]
+        s.files =  FileList["[A-Z]*", "{generators,lib,test}/**/*"]
+      end
+    rescue LoadError
+      puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+    end
+
+    Rake::TestTask.new do |t|
+      t.libs << 'lib'
+      t.pattern = 'test/**/*_test.rb'
+      t.verbose = false
+    end
+
+    desc 'Generate documentation for the safety_valve plugin.'
+    Rake::RDocTask.new(:rdoc) do |rdoc|
+      rdoc.rdoc_dir = 'rdoc'
+      rdoc.title    = 'Jeweler'
+      rdoc.options << '--line-numbers' << '--inline-source'
+      rdoc.rdoc_files.include('README.*')
+      rdoc.rdoc_files.include('lib/**/*.rb')
+    end
+
+    desc "Run the test suite"
+    task :default => :test

data/Rakefile

@@ -16,7 +16,7 @@ begin
     s.files =  FileList["[A-Z]*", "{generators,lib,test}/**/*"]
   end
 rescue LoadError
-  puts "Jeweler not available. Try installing technicalpickles-jeweler."
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
 Rake::TestTask.new do |t|

data/TODO

@@ -1,8 +1,7 @@
- * Support dashes in spec names
-  * ruby-debug -> Ruby::Debug
-  * safety_valve -> SafetyValve
+ * Move away from having a version module to having version.yml in top level directory
  * Generator for making new Jeweler projects
  * Rails generator for making a plugin that's Jeweler enabled
  * Git tagging/branching
  * Make sure everything is pushed/committed before bumping (controlled by a Jeweler.strict perhaps)
- * Have version:bump:xxx do a commit with an appropriate message 
+ * Have version:bump:xxx do a commit with an appropriate message 
+ * Capture stdout during testing

data/VERSION.yml

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

data/lib/jeweler.rb

@@ -24,10 +24,8 @@ class Jeweler
     @gemspec = gemspec
     @base_dir = base_dir
     
-    load_version()
-    
-    @gemspec.version = version
-    @gemspec.files ||= FileList["[A-Z]*", "{generators,lib,test,spec}/**/*"]
+    # @gemspec.version = version
+    @gemspec.files ||= FileList["[A-Z]*.*", "{generators,lib,test,spec}/**/*"]
   end
   
 private  

data/lib/jeweler/bumping.rb

@@ -4,65 +4,48 @@ class Jeweler
     #
     # 1.5.1 -> 1.5.2
     def bump_patch_version()
-      patch = self.patch_version + 1
+      patch = self.patch_version.to_i + 1
 
-      bump_version(major_version, minor_version, patch)
-      write_gemspec
+      write_version(major_version, minor_version, patch)
     end
 
     # Bumps the minor version.
     #
     # 1.5.1 -> 1.6.0
     def bump_minor_version()
-      minor = minor_version + 1
+      minor = minor_version.to_i + 1
 
-      bump_version(major_version, minor, 0)
-      write_gemspec
+      write_version(major_version, minor)
     end
 
     # Bumps the major version.
     #
     # 1.5.1 -> 2.0.0
     def bump_major_version()
-      major = major_version + 1
+      major = major_version.to_i + 1
 
-      bump_version(major, 0, 0)
-      write_gemspec
+      write_version(major)
     end
 
     # Bumps the version, to the specific major/minor/patch version, writing out the appropriate version.rb, and then reloads it.
-    def bump_version(major, minor, patch)
-      main_module_or_class = constantize(main_module_name)
-      keyword = top_level_keyword()
-
-      File.open(version_module_path, 'w') do |file|
-        file.write <<-END
-#{keyword} #{main_module_name}
-  module Version
-    MAJOR = #{major}
-    MINOR = #{minor}
-    PATCH = #{patch}
-  end
-end
-END
+    def write_version(major = 0, minor = 0, patch = 0)
+      major ||= 0
+      minor ||= 0
+      patch ||= 0
+      
+      File.open(version_yaml_path, 'w+') do |f|
+        version_hash = {
+          'major' => major.to_i,
+          'minor' => minor.to_i,
+          'patch' => patch.to_i
+        }
+        YAML.dump(version_hash, f)
       end
-      @gemspec.version = "#{major}.#{minor}.#{patch}"
       refresh_version
-    end
-    
-  protected
-    # Tries to figure out the Ruby keyword of what is containing the Version
-    # module. This should be 'module' or 'class', and is used for rewriting the version.rb.
-    def top_level_keyword
-      main_module_or_class = constantize(main_module_name)
-      case main_module_or_class
-      when Class
-        'class'
-      when Module
-        'module'
-      else
-        raise "Uh, main_module_name should be a class or module, but was a #{main_module_or_class.class}"
-      end
+      
+      @gemspec.version = version
+      
+      puts "Wrote to #{version_yaml_path}: #{version}"
     end
   end
 end

data/lib/jeweler/errors.rb

@@ -2,4 +2,7 @@ class Jeweler
   # Gemspec related error
    class GemspecError < StandardError
    end
+   
+   class VersionYmlError < StandardError
+   end
 end

data/lib/jeweler/gemspec.rb

@@ -1,34 +1,21 @@
 class Jeweler
   module Gemspec
-    # Generates a date for stuffing in the gemspec
-    def date
-      date = DateTime.now
-      "#{date.year}-#{date.month}-#{date.day}"
-    end
-
-
     # Writes out the gemspec
     def write_gemspec
-      @gemspec.date = self.date
+      @gemspec.version = self.version
+      @gemspec.date = Time.now
       File.open(gemspec_path, 'w') do |f|
         f.write @gemspec.to_ruby
       end
-      puts "Generated #{gemspec_path}."
+      puts "Generated: #{gemspec_path}"
     end
     
     # Validates the gemspec in an environment similar to how GitHub would build
     # it. See http://gist.github.com/16215
     def validate_gemspec
       begin
-        # Snippet borrowed from http://gist.github.com/16215
         data = File.read(gemspec_path)
-      
-        spec = nil
-        if data !~ %r{!ruby/object:Gem::Specification}
-          Thread.new { spec = eval("$SAFE = 3\n#{data}", binding, gemspec_path) }.join
-        else
-          spec = YAML.load(data)
-        end
+        Thread.new { spec = parse_gemspec(data) }.join
         
         puts "#{gemspec_path} is valid."
       rescue Exception => e
@@ -37,9 +24,29 @@ class Jeweler
       end
     end
     
+    
+    def valid_gemspec?
+      # gah, so wet...
+      begin
+        data = File.read(gemspec_path)
+      
+        Thread.new { spec = parse_gemspec(data) }.join
+        true
+      rescue Exception => e
+        false
+      end
+    end
+    
+    def parse_gemspec(data = nil)
+      data ||= File.read(gemspec_path)
+      eval("$SAFE = 3\n#{data}", binding, gemspec_path)
+    end
+    
   protected
     def gemspec_path
-      File.join(@base_dir, "#{@gemspec.name}.gemspec")
+      denormalized_path = File.join(@base_dir, "#{@gemspec.name}.gemspec")
+      absolute_path = File.expand_path(denormalized_path)
+      absolute_path.gsub(Dir.getwd + File::SEPARATOR, '')
     end
   end
 end

data/lib/jeweler/tasks.rb

@@ -1,3 +1,4 @@
+require 'ruby-debug'
 desc "Generate and validates gemspec"
 task :gemspec => ['gemspec:generate', 'gemspec:validate']
 
@@ -14,36 +15,57 @@ namespace :gemspec do
 end
 
 desc "Displays the current version"
-task :version do
-  puts Jeweler.instance.version
-end
+task :version => 'version:display'
 
 namespace :version do
+
+  desc "Creates an initial version file"
+  task :write do
+    jeweler = Jeweler.instance
+    jeweler.write_version(ENV['MAJOR'], ENV['MINOR'], ENV['PATCH'])
+  end
+  
+  def ensure_version_yml(&block)
+    if File.exists? 'VERSION.yml'
+      block.call
+    else
+      abort "VERSION.yml is needed for this operation, but it doesn't exist. Try running 'rake version:write' first."
+    end
+  end
+  
+  desc "Displays the current version"
+  task :display do
+    ensure_version_yml do
+      puts "Current version: #{Jeweler.instance.version}"
+    end
+  end
+  
   namespace :bump do
     desc "Bump the gemspec by a major version."
-    task :major do
-      jeweler = Jeweler.instance
-      
-      jeweler.bump_major_version
-      
-      jeweler.bump_version(major, 0, 0)
-      jeweler.write_gemspec
-      
-      puts "Version bumped to #{jeweler.version}"
+    task :major => 'version:display' do
+      ensure_version_yml do
+        jeweler = Jeweler.instance
+        jeweler.bump_major_version
+        jeweler.write_gemspec
+      end
     end
     
     desc "Bump the gemspec by a minor version."
-    task :minor do
-      jeweler = Jeweler.instance
-      jeweler.bump_minor_version
-      puts "Version bumped to #{jeweler.version}"
+    task :minor => 'version:display' do
+      ensure_version_yml do
+        jeweler = Jeweler.instance
+        jeweler.bump_minor_version
+        jeweler.write_gemspec
+      end
     end
     
     desc "Bump the gemspec by a patch version."
-    task :patch do
-      jeweler = Jeweler.instance
-      jeweler.bump_patch_version
-      puts "Version bumped to #{jeweler.version}"
+    task :patch => 'version:display' do
+      ensure_version_yml do
+        jeweler = Jeweler.instance
+        jeweler.bump_patch_version
+        jeweler.write_gemspec
+      end
     end
   end
 end

data/lib/jeweler/versioning.rb

@@ -1,21 +1,22 @@
+require 'yaml'
 class Jeweler
   module Versioning
     # Major version, as defined by the gemspec's Version module.
     # For 1.5.3, this would return 1.
     def major_version
-      version_module.const_get(:MAJOR)
+      version_yaml['major']
     end
 
     # Minor version, as defined by the gemspec's Version module.
     # For 1.5.3, this would return 5.
     def minor_version
-      version_module.const_get(:MINOR)
+      version_yaml['minor']
     end
 
     # Patch version, as defined by the gemspec's Version module.
     # For 1.5.3, this would return 5.
     def patch_version
-      version_module.const_get(:PATCH)
+      version_yaml['patch']
     end
 
     # Human readable version, which is used in the gemspec.
@@ -24,31 +25,26 @@ class Jeweler
     end
     
   protected
-    def version_module_path
-      File.join(@base_dir, 'lib', @gemspec.name, 'version.rb')
+    def version_yaml_path
+      denormalized_path = File.join(@base_dir, 'VERSION.yml')
+      absolute_path = File.expand_path(denormalized_path)
+      absolute_path.gsub(Dir.getwd + File::SEPARATOR, '')
     end
-  
-    def version_module
-      constantize("#{main_module_name}::Version")
-    end
-  
-    # 
-    def refresh_version
-      undefine_versions()
-      load_version()
+    
+    def version_yaml
+      @version_yaml ||= read_version_yaml
     end
-
-    # Undefines version constants, so we can +load+ the version.rb again.
-    def undefine_versions
-      version_module.module_eval do
-        remove_const(:MAJOR) if const_defined?(:MAJOR)
-        remove_const(:MINOR) if const_defined?(:MINOR)
-        remove_const(:PATCH) if const_defined?(:PATCH)
+    
+    def read_version_yaml
+      if File.exists?(version_yaml_path)
+        YAML.load_file(version_yaml_path)
+      else
+        raise VersionYmlError, "#{version_yaml_path} does not exist!"
       end
     end
-
-    def load_version
-      load(version_module_path)
+    
+    def refresh_version
+      @version_yaml = read_version_yaml
     end
   end
 end

data/test/jeweler_test.rb

@@ -2,26 +2,11 @@ require File.dirname(__FILE__) + '/test_helper'
 
 class JewelerTest < Test::Unit::TestCase
   
-  def write_version_file(name, keyword, const_name, major, minor, patch)
-    dir = "#{File.dirname(__FILE__)}/lib/#{name}"
-    FileUtils.mkdir_p(dir)
-    File.open("#{dir}/version.rb", 'w+') do |file|
-      file.write <<-END
-#{keyword} #{const_name}
-  module Version
-    MAJOR = #{major}
-    MINOR = #{minor}
-    PATCH = #{patch}
-  end
-end
-      END
-    end
-  end
-  
   def teardown
     FileUtils.rm_rf("#{File.dirname(__FILE__)}/lib")
     FileUtils.rm_f("#{File.dirname(__FILE__)}/foo.gemspec")
     FileUtils.rm_f("#{File.dirname(__FILE__)}/bar.gemspec")
+    FileUtils.rm_f("#{File.dirname(__FILE__)}/VERSION.yml")
   end
   
   class << self
@@ -48,18 +33,11 @@ end
         assert_equal version, @jeweler.version
       end
     end
-    
-    def should_have_toplevel_keyword(keyword)
-      should "have '#{keyword}' top level keyword" do
-        assert_equal keyword, @jeweler.send(:top_level_keyword)
-      end
-    end
   end
   
   context 'A jeweler (with a gemspec with top level module)' do
     setup do
-      write_version_file('foo', 'module', 'Foo', 0, 1, 0)
-      @spec = Gem::Specification.new do |s|
+      spec = Gem::Specification.new do |s|
         s.name = 'foo'
         s.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
         s.email = "josh@technicalpickles.com"
@@ -68,11 +46,12 @@ end
         s.authors = ["Josh Nichols", "Dan Croak"]
         s.files =  FileList["[A-Z]*", "{generators,lib,test}/**/*"]
       end
-      @jeweler = Jeweler.new(@spec, File.dirname(__FILE__))
-    end
-    
-    teardown do
-      @jeweler.send(:undefine_versions) if @jeweler
+      @jeweler = Jeweler.new(spec, File.dirname(__FILE__))
+      
+      catch_out do
+        @jeweler.write_version(0, 1, 0)
+      end
+      @jeweler = Jeweler.new(spec, File.dirname(__FILE__))
     end
     
     should_have_major_version 0
@@ -80,11 +59,9 @@ end
     should_have_patch_version 0
     should_be_version '0.1.0'
     
-    should_have_toplevel_keyword 'module'
-    
     context "bumping the patch version" do
       setup do
-        @jeweler.bump_patch_version
+        @output = catch_out { @jeweler.bump_patch_version }
       end
       
       should_have_major_version 0
@@ -99,7 +76,7 @@ end
     
     context "bumping the minor version" do
       setup do
-        @jeweler.bump_minor_version
+        @output = catch_out { @jeweler.bump_minor_version }
       end
       
       should_have_major_version 0
@@ -114,7 +91,7 @@ end
     
     context "bumping the major version" do
       setup do
-        @jeweler.bump_major_version
+        @output = catch_out { @jeweler.bump_major_version }
       end
       
       should_have_major_version 1
@@ -131,9 +108,7 @@ end
   
   context "A Jeweler (with a gemspec with top level class)" do
     setup do
-      write_version_file('bar', 'class', 'Bar', 1, 5, 2)
-      
-      @spec = Gem::Specification.new do |s|
+      spec = Gem::Specification.new do |s|
         s.name = "bar"
         s.summary = "Simple and opinionated helper for creating Rubygem projects on GitHub"
         s.email = "josh@technicalpickles.com"
@@ -142,31 +117,59 @@ end
         s.authors = ["Josh Nichols", "Dan Croak"]
         s.files =  FileList["[A-Z]*", "{generators,lib,test}/**/*"]
       end
-      @jeweler = Jeweler.new(@spec, File.dirname(__FILE__))
-    end
-    
-    teardown do
-      @jeweler.send(:undefine_versions) if @jeweler
-    end
+      @jeweler = Jeweler.new(spec, File.dirname(__FILE__))
+
+      @now = Time.now
+      Time.stubs(:now).returns(@now)
+
+      @output = catch_out { @jeweler.write_version(1, 5, 2) }
+      @jeweler = Jeweler.new(spec, File.dirname(__FILE__))
+    end  
     
     should_have_major_version 1
     should_have_minor_version 5
     should_have_patch_version 2
     should_be_version '1.5.2'
-    should_have_toplevel_keyword 'class'
     
     context "bumping the patch version" do
       setup do
-        @jeweler.bump_patch_version
+        @output = catch_out { @jeweler.bump_patch_version }
       end
       
       should_have_major_version 1
       should_have_minor_version 5
       should_have_patch_version 3
       should_be_version '1.5.3'
+    end
+    
+    context "writing the gemspec" do
+      setup do
+        @output = catch_out { @jeweler.write_gemspec }
+      end
       
-      should_eventually "still have class Bar" do
-        # do some regexp of version.rb
+      should "create bar.gemspec" do
+        assert File.exists?(File.join(File.dirname(__FILE__), 'bar.gemspec'))
+      end
+
+      should "have created a valid gemspec" do
+        assert @jeweler.valid_gemspec?
+      end
+    
+      
+      context "re-reading the gemspec" do
+        setup do
+          data = File.read(File.join(File.dirname(__FILE__), 'bar.gemspec'))
+
+          @parsed_spec = eval("$SAFE = 3\n#{data}", binding, File.join(File.dirname(__FILE__), 'bar.gemspec'))
+        end
+
+        should "have version 1.5.2" do
+          assert_equal '1.5.2', @parsed_spec.version.version
+        end
+        
+        should "have date filled in" do
+          assert_equal Time.local(@now.year, @now.month, @now.day), @parsed_spec.date
+        end
       end
     end
   end

data/test/test_helper.rb

@@ -5,6 +5,13 @@ gem 'thoughtbot-shoulda'
 require 'shoulda'
 gem 'ruby-debug'
 require 'ruby-debug'
+gem 'mocha'
+require 'mocha'
+
+gem 'mhennemeyer-output_catcher'
+require 'output_catcher'
+
+require 'time'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -14,4 +21,13 @@ require 'jeweler'
 class FileList
   def self.[](*args)
   end
+end
+
+class Test::Unit::TestCase
+  
+  def catch_out(&block)
+     OutputCatcher.catch_out do
+       block.call
+     end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: technicalpickles-jeweler
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.1.1
 platform: ruby
 authors: 
 - Josh Nichols
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-12 00:00:00 -07:00
+date: 2008-10-14 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,7 @@ files:
 - Rakefile
 - README.markdown
 - TODO
+- VERSION.yml
 - lib/jeweler
 - lib/jeweler/active_support.rb
 - lib/jeweler/bumping.rb
@@ -33,7 +34,6 @@ files:
 - lib/jeweler/gemspec.rb
 - lib/jeweler/singleton.rb
 - lib/jeweler/tasks.rb
-- lib/jeweler/version.rb
 - lib/jeweler/versioning.rb
 - lib/jeweler.rb
 - test/jeweler_test.rb

data/lib/jeweler/version.rb

@@ -1,7 +0,0 @@
-class Jeweler
-  module Version
-    MAJOR = 0
-    MINOR = 0
-    PATCH = 7
-  end
-end