burke 0.3.5 → 0.3.6

data/History.rdoc

@@ -0,0 +1,12 @@
+=== Version 0.3.6 / 2010-11-17
+
+* Fixed Ruby 1.9 issues
+* Stripped whitespace from burke:tasks disabled reasons
+* Handled case where tag for previous version does not exist
+* Fixed typo
+* changed to 'gem' method for verifying task dependencies
+* Made release task more informative
+* Made the relationship between release task operations and questions more logical
+* Added automatic history file building to release task
+* restructured specs, fixed up rcov integration
+

data/Rakefile

@@ -1,4 +1,4 @@
-$LOAD_PATH << File.join(File.dirname(File.expand_path(__FILE__)), 'lib')
+$:.unshift File.join(File.dirname(File.expand_path(__FILE__)), 'lib')
 require 'burke'
 
 Burke.setup do
@@ -11,6 +11,6 @@ Burke.setup do
   clean     %w[.yardoc]
   clobber   %w[pkg doc html coverage]
   
-  rspec.rcov.failure_threshold = 70
+  rspec.rcov.failure_threshold = 65
 end
 

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/lib/burke.rb

@@ -113,12 +113,12 @@ module Burke
     field(:rakefile_file) { find_file('rakefile').freeze }
     field(:version_file) { find_file('version{.*,}').freeze }
     
-    field(:version) { File.read(version_file).strip.freeze if version_file }
+    field(:version) { File.read(version_file).strip if version_file }
     
     field :files do
-      fs = Dir['{lib,spec,bin}/**/*']
+      fs = Dir['{lib,spec,bin,test}/**/*']
       fs << docs.readme_file
-      fs << docs.license_file
+      fs.concat docs.extra_files
       fs << version_file
       fs << rakefile_file
       fs.compact.freeze
@@ -176,7 +176,7 @@ module Burke
             td.execute(settings)
             enabled << [name, nil]
           rescue Exception => ex
-            disabled << [name, ex.message]
+            disabled << [name, ex.message.strip]
           end
         else
           disabled << [name, "disabled by project developer(s)"]
@@ -190,9 +190,8 @@ module Burke
           puts '  Enabled '
           puts ' ---------'
           width = enabled.map {|a| a[0].length}.sort.last
-          enabled.sort_by {|a| a[0]}.each do |name, reason|
+          enabled.sort_by {|a| a[0]}.each do |name, _|
             line = "+ #{name.ljust(width)}"
-            line << " (#{reason})" if reason
             puts line
           end
           puts

data/lib/burke/holder.rb

@@ -143,7 +143,7 @@ module Burke
         end
       when '='
         if field_exists? key
-          self[key] = *args
+          self[key] = args[0]
         else
           super
         end
@@ -160,7 +160,7 @@ module Burke
             end
             v
           else
-            self[key] = *args
+            self[key] = args[0]
           end
         else
           super

data/lib/burke/tasks/docs.rb

@@ -14,7 +14,7 @@ module Burke
     end
     
     field 'extra_files' do
-      [license_file].compact.freeze
+      [license_file, history_file].compact.freeze
     end
     
     field 'readme_file' do
@@ -25,6 +25,10 @@ module Burke
       find_file('{licen{c,s}e,copying}{.*,}').freeze
     end
     
+    field 'history_file' do
+      find_file('{history,changelog}{.*,}').freeze
+    end
+    
     field 'markup' do
       case File.extname(readme_file).downcase
       when '.rdoc'

data/lib/burke/tasks/release.rb

@@ -1,13 +1,12 @@
 module Burke
   define_task 'release' do |s|
-    begin
-      require 'git'
-    rescue LoadError
-      raise "'git' gem is not available"
-    end
+    gem 'git'
+    require 'git'
+    
     if s.key? 'version'
       raise "version is managed in an unknown way"
     end
+    
     desc 'Release a new version of this project'
     task 'release' do |t|
       g = Git.open '.'
@@ -49,20 +48,75 @@ module Burke
           new_version = Gem::Version.new(segments.join('.'))
         end
         
-        print "The VERSION file will be changed from containing '#{old_version}' "
-        print "to '#{new_version}'. The changes will be commited to the Git "
-        print "repository and tagged with 'v#{new_version}'."
+        case settings.docs.markup
+        when 'rdoc'
+          settings.docs.history_file ||= "History.rdoc"
+        when 'markdown'
+          settings.docs.history_file ||= "History.md"
+        when 'textile'
+          settings.docs.history_file ||= "History.textile"
+        else
+          settings.docs.history_file ||= "History.txt"
+        end
+        
+        puts "Would you like the history file '#{settings.docs.history_file}' to be updated? [Y]es, [N]o"
+        update_changelog = nil
+        until %w[y n yes no].include? update_changelog
+          print "> "
+          update_changelog = $stdin.gets.strip.downcase
+          puts
+        end
+        update_changelog = %w[yes y].include? update_changelog
+        
+        puts "The VERSION file will be changed from containing '#{old_version}' "
+        puts "to '#{new_version}'. The changes will be commited to the Git "
+        puts "repository and tagged with 'v#{new_version}'."
+        if update_changelog
+          puts "A new entry will be made in the history file '#{settings.docs.history_file}'."
+        end
         puts
         
         continue = nil
-        until ['y', 'n', 'yes', 'no'].include? continue
+        until %w[y n yes no].include? continue
           puts "Continue? [Y]es, [N]o"
           print "> "
           continue = $stdin.gets.strip.downcase
           puts
         end
+        continue = %w[yes y].include? continue
         
-        if %w[yes y].include? continue
+        if continue
+          if update_changelog
+            log_entries = nil
+            begin
+              log_entries = g.log.between("v#{old_version}", '.').to_a
+            rescue
+              log_entries = g.log.to_a
+            end
+            messages = log_entries.map {|c| c.message}.uniq
+            str = ""
+            time = Time.now
+            date_str = "%.4d-%.2d-%.2d" % [time.year, time.month, time.day]
+            heading = "Version #{new_version} / #{date_str}"
+            case settings.docs.markup
+            when 'rdoc'
+              str << "=== #{heading}\n\n"
+            when 'markdown'
+              str << "### #{heading}\n\n"
+            when 'textile'
+              str << "h3. #{heading}\n\n"
+            else
+              str << "#{heading}\n\n"
+            end
+            str << messages.map {|m| "* " + m}.join("\n")
+            
+            old_log = File.read(settings.docs.history_file) rescue ""
+            new_log = [str, old_log].join("\n\n")
+            open(settings.docs.history_file, 'w') do |f|
+              f.write new_log
+            end
+          end
+          
           open 'VERSION', 'w' do |f|
             f.puts new_version.to_s
           end

data/lib/burke/tasks/rspec.rb

@@ -2,11 +2,8 @@ module Burke
   Settings.field(:rspec) { self.rspec = RSpecSettings.new }
   
   define_task 'spec' do |s|
-    begin
-      require 'rspec/core/rake_task'
-    rescue LoadError
-      raise "'rspec' gem is not available"
-    end
+    gem 'rspec-core', '~> 2'
+    require 'rspec/core/rake_task'
     
     RSpec::Core::RakeTask.new 'spec' do |t|
       build_spec_task t, s.rspec
@@ -14,35 +11,33 @@ module Burke
   end
   
   define_task 'spec:rcov' do |s|
-    begin
-      require 'rspec/core/rake_task'
-    rescue LoadError
-      raise "'rspec' gem is not available"
-    end
+    gem 'rcov'
+    gem 'rspec-core', '~> 2'
+    require 'rspec/core/rake_task'
     
     desc "Run RSpec code examples and generate full RCov report"
     RSpec::Core::RakeTask.new('spec:rcov') do |t|
+      require 'shellwords'
       t.rcov = true
       t.rcov_opts = [
-        '-Ilib',
+        "-I#{%w[lib spec].map {|e| File.expand_path(e).shellescape }.join ':'}",
         '--exclude', "'spec/,#{s.rakefile_file}'",
       ]
     end
   end
   
   define_task 'spec:rcov:verify' do |s|
-    begin
-      require 'rspec/core/rake_task'
-    rescue LoadError
-      raise "'rspec' gem is not available"
-    end
+    gem 'rcov'
+    gem 'rspec-core', '~> 2'
+    require 'rspec/core/rake_task'
     
     desc "Run RSpec code examples and verify RCov percentage"
     RSpec::Core::RakeTask.new('spec:rcov:verify') do |t|
+      require 'shellwords'
       t.rcov = true
       t.rcov_opts = [
         '--failure-threshold', s.rspec.rcov.failure_threshold,
-        '-Ilib',
+        "-I#{%w[lib spec].map {|e| File.expand_path(e).shellescape }.join ':'}",
         '--exclude', "'spec/,#{s.rakefile_file}'",
         '--no-html'
       ]

data/lib/burke/tasks/yard.rb

@@ -1,10 +1,7 @@
 module Burke
   define_task 'yard' do |s|
-    begin
-      require 'yard'
-    rescue LoadError
-      raise "'yard' gem is not available"
-    end
+    gem 'yard'
+    require 'yard'
     
     opts = []
     d = s.docs

data/spec/helpers/projects.rb

@@ -0,0 +1,32 @@
+module Helpers
+  module Projects
+    def project_dir(name)
+      File.join(File.dirname(__FILE__), 'projects', name)
+    end
+    
+    def mock_burke_project(name, &block)
+      Dir.chdir project_dir(name) do
+        # Stow away current Burke settings and mock out the `settings` method
+        Burke.module_eval do
+          class << self
+            alias :old_settings :settings
+            def settings
+              @_settings ||= Burke::Settings.new
+            end
+          end
+        end
+        
+        load 'Rakefile'
+        block.call
+        
+        # Restore Burke to how it was
+        Burke.module_eval do
+          class << self
+            alias :settings :old_settings
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/helpers/projects/conventional/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'burke'
+
+Burke.setup do
+  name    'conventional'
+  summary 'A conventional project'
+end
+

data/spec/holder_spec.rb

@@ -1,4 +1,3 @@
-($LOAD_PATH << File.dirname(File.expand_path(__FILE__))).uniq!
 require 'spec_helper'
 
 describe Burke::Holder do

data/spec/projects/conventional_project_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'helpers/projects'
+
+describe "conventional project" do
+  include Helpers::Projects
+  
+  around do |example|
+    mock_burke_project('conventional', &example) 
+  end
+  
+  let(:settings) { Burke.settings }
+  subject { settings }
+  
+  its(:name) { should eql 'conventional' }
+  
+  its(:version_file) { should eql 'VERSION' }
+  its(:rakefile_file) { should eql 'Rakefile' }
+  its(:version) { should eql '1.2.3' }
+  
+  describe 'docs' do
+    subject { settings.docs }
+    its(:readme_file) { should eql 'README.md' }
+    its(:license_file) { should eql 'COPYING' }
+    its(:markup) { should eql 'markdown' }
+  end
+  
+  describe 'test' do
+    subject { settings.test }
+    its(:files) { should eql ['test/foo_test.rb'] }
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -1,24 +1,4 @@
-$LOAD_PATH << File.join(File.dirname(File.expand_path(__FILE__)), 'lib')
+$:.unshift File.join(File.dirname(File.expand_path(__FILE__)), 'lib')
 require 'burke'
 require 'rspec/core'
 
-def mock_burke_setup
-  Burke.module_eval do
-    class << self
-      alias :old_settings :settings
-      
-      def settings
-        @settings ||= Burke::Settings.new
-      end
-    end
-  end
-end
-
-def unmock_burke_setup
-  Burke.module_eval do
-    class << self
-      alias :settings :old_settings
-    end
-  end
-end
-

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: burke
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Aiden Nibali
@@ -14,31 +15,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-24 00:00:00 +11:00
+date: 2010-11-17 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: rake
   version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 8
         - 7
         version: 0.8.7
-  requirement: *id001
   prerelease: false
+  requirement: *id001
   type: :development
-  name: rake
 description: 
 email: dismal.denizen@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- History.rdoc
 files: 
 - lib/burke/tasks/rdoc.rb
 - lib/burke/tasks/yard.rb
@@ -51,14 +54,17 @@ files:
 - lib/burke/holder.rb
 - lib/burke.rb
 - spec/holder_spec.rb
+- spec/projects/conventional_project_spec.rb
+- spec/helpers/projects.rb
+- spec/helpers/projects/conventional/lib/main.rb
+- spec/helpers/projects/conventional/test/foo_test.rb
+- spec/helpers/projects/conventional/Rakefile
+- spec/helpers/projects/conventional/README.md
+- spec/helpers/projects/conventional/COPYING
+- spec/helpers/projects/conventional/VERSION
 - spec/spec_helper.rb
-- spec/simple_project/lib/main.rb
-- spec/simple_project/Rakefile
-- spec/simple_project/README.md
-- spec/simple_project/COPYING
-- spec/simple_project/VERSION
-- spec/burke_spec.rb
 - README.rdoc
+- History.rdoc
 - VERSION
 - Rakefile
 has_rdoc: true
@@ -68,29 +74,33 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- burke 0.3.5
+- burke 0.3.6
 - --main
 - README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Helper for creating nice, clean Rake files

data/spec/burke_spec.rb

@@ -1,39 +0,0 @@
-($LOAD_PATH << File.dirname(File.expand_path(__FILE__))).uniq!
-require 'spec_helper'
-
-DIR = File.dirname(File.expand_path(__FILE__))
-
-describe Burke do
-  describe 'settings' do
-    context 'for example of a simple project' do
-      before do
-        @old_pwd = Dir.pwd
-        Dir.chdir File.join(DIR, 'simple_project')
-        mock_burke_setup
-        load 'Rakefile'
-        @settings = Burke.settings
-      end
-      
-      subject { @settings }
-      
-      its(:name) { should eql 'simple_project' }
-      
-      its(:version_file) { should eql 'VERSION' }
-      its(:rakefile_file) { should eql 'Rakefile' }
-      its(:version) { should eql '1.2.3' }
-      
-      describe 'docs' do
-        subject { @settings.docs }
-        its(:readme_file) { should eql 'README.md' }
-        its(:license_file) { should eql 'COPYING' }
-        its(:markup) { should eql 'markdown' }
-      end
-      
-      after do
-        unmock_burke_setup
-        Dir.chdir @old_pwd
-      end
-    end
-  end
-end
-

data/spec/simple_project/Rakefile

@@ -1,8 +0,0 @@
-require 'rubygems'
-require 'burke'
-
-Burke.setup do
-  name    'simple_project'
-  summary 'A simple project which follows conventions'
-end
-