xforge 0.1.2 → 0.1.3

data/CHANGES

@@ -1,8 +1,15 @@
 = XForge Changelog
 
+== Version 0.1.3
+
+* Added logic for parsing of CHANGES files and include it in the release notes when publishing.
+
 == Version 0.1.2
 
+This release is a minor release with fixes in the Rake script.
+
 * Fixed RDoc for gem
+* Cleaned up documentation
 
 == Version 0.1.1
 

data/README

@@ -35,7 +35,7 @@ See XForge and Rake::XForge::Release.
 
 [<b>David Heinemeier Hansson</b>] For the HTTP POST code and the idea to parse ids from project pages.
 
-[<b>Jim Weirich</b>] For Rake, making XForge functionality more available to Ruby developers.
+[<b>Jim Weirich</b>] For Rake, making XForge easier to use from Ruby build scripts.
 
 == Support
 

data/Rakefile

@@ -1,6 +1,6 @@
-# Rakefile for XForge        -*- ruby -*-
+# Rakefile for XForge
 
-# Copyright 2003, 2004 by Jim Weirich (jim@weirichhouse.org)
+# Copyright 2005 by Aslak Hellesoy (aslak.hellesoy@gmail.org)
 # All rights reserved.
 
 # This file is may be distributed under an MIT style license.  See
@@ -14,8 +14,16 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
+task :default => [:test, :gem]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['**/*_test.rb']
+  t.verbose = true
+end
+
 # Create a task to build the RDOC documentation tree.
-rd = Rake::RDocTask.new("rdoc") { |rdoc|
+rd = Rake::RDocTask.new("rdoc") do |rdoc|
   rdoc.rdoc_dir = 'html'
 #  rdoc.template = 'kilmer'
 #  rdoc.template = 'css2'
@@ -25,14 +33,14 @@ rd = Rake::RDocTask.new("rdoc") { |rdoc|
   rdoc.rdoc_files.include('README', 'MIT-LICENSE', 'TODO', 'CHANGES')
   rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
   rdoc.rdoc_files.exclude('doc/**/*_attrs.rdoc')
-}
+end
 
 # ====================================================================
 # Create a task that will package the Rake software into distributable
 # tar, zip and gem files.
 
 PKG_NAME = "xforge"
-PKG_VERSION = "0.1.2"
+PKG_VERSION = "0.1.3"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',
@@ -40,44 +48,41 @@ PKG_FILES = FileList[
   'doc/**/*'
 ]
 
-if ! defined?(Gem)
-  puts "Package Target requires RubyGEMs"
-else
-  spec = Gem::Specification.new do |s|
-    
-    #### Basic information.
-
-    s.name = 'xforge'
-    s.version = PKG_VERSION
-    s.summary = "Ruby based make-like utility."
-    s.description = <<-EOF
-      XForge is a simple library to interact with RubyForge, SourceForge, GForge or other SourceForge clones.
-    EOF
-
-    s.files = PKG_FILES.to_a
-    s.require_path = 'lib'
-
-    #### Documentation and testing.
-
-    s.has_rdoc = true
-    s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-    s.rdoc_options <<
-      '--title' <<  'XForge' <<
-      '--main' << 'README' <<
-      '--line-numbers'
-
-    #### Author and project details.
-
-    s.author = "Aslak Hellesoy"
-    s.email = "aslak.hellesoy@gmail.com"
-    s.homepage = "http://xforge.rubyforge.org"
-    s.rubyforge_project = "xforge"
-  end
+spec = Gem::Specification.new do |s|
+  
+  #### Basic information.
 
-  Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = true
-  end
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Ruby based make-like utility."
+  s.description = <<-EOF
+    XForge is a simple library to interact with RubyForge, SourceForge, GForge or other SourceForge clones.
+  EOF
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+
+  #### Documentation and testing.
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
+  s.rdoc_options <<
+    '--title' <<  'XForge' <<
+    '--main' << 'README' <<
+    '--line-numbers'
+
+  #### Author and project details.
+
+  s.author = "Aslak Hellesoy"
+  s.email = "aslak.hellesoy@gmail.com"
+  s.homepage = "http://xforge.rubyforge.org"
+  s.rubyforge_project = "xforge"
+end
+
+desc "Build Gem"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
 end
 
 # Support Tasks ------------------------------------------------------
@@ -114,11 +119,12 @@ task :publish_files => [:gem] do
     "CHANGES"
   ]
 
-  Rake::XForge::Release.new(PKG_NAME) do |xf|
+  Rake::XForge::Release.new(PKG_NAME) do |release|
     # Never hardcode user name and password in the Rakefile!
-    xf.user_name = ENV['RUBYFORGE_USER']
-    xf.password = ENV['RUBYFORGE_PASSWORD']
-    xf.files = release_files.to_a
-    xf.release_name = "XForge #{PKG_VERSION}"
-  end
+    release.user_name = ENV['RUBYFORGE_USER']
+    release.password = ENV['RUBYFORGE_PASSWORD']
+    release.files = release_files.to_a
+    release.release_name = "XForge #{PKG_VERSION}"
+    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
+  end
 end

data/lib/rake/contrib/xforge/release.rb

@@ -1,4 +1,4 @@
-require 'rake/contrib/xforge/release'
+require 'xforge/version_parser'
 
 module Rake
   module XForge
@@ -36,7 +36,7 @@ module Rake
     #     end
     #   end
     #
-    # This can be invoked with
+    # This can be invoked from the command line:
     #
     #   rake release RUBYFORGE_USER=aslak_hellesoy RUBYFORGE_PASSWORD=nahnotreal
     #
@@ -57,13 +57,24 @@ module Rake
       def set_defaults
         @files = ["pkg/#{PKG_FILE_NAME}.gem"] if defined? PKG_FILE_NAME
         @release_name = "#{PKG_NAME}-#{PKG_VERSION}" if (defined? PKG_NAME && defined? PKG_VERSION)
+        
+        begin
+          vp = ::XForge::VersionParser.new
+          version = vp.parse("CHANGES", PKG_VERSION)
+          @release_notes = version.release_notes
+          @release_changes = version.release_changes.join("\n")
+        rescue => e
+          STDERR.puts("Couldn't parse release info from CHANGES")
+          STDERR.puts(e.message)
+          STDERR.puts(e.backtrace.join("\n"))
+        end
       end
       
       def execute
         project = @host.project(@project_name)
         u = user_name
         session = project.login(u, password)
-        session.release(@files, @release_name)
+        session.release(@release_name, @files, @release_notes, @release_changes)
       end
   
     end

data/lib/xforge.rb

@@ -101,10 +101,22 @@ module XForge
     # Optional parameters are +processor+ (which should be one of the Processor constants), +release_notes+,
     # +release_changes+ and +preformatted+ which will appear on the releas page of the associated project.
     #
-    def release(filenames, release_name, processor=Processor::ANY, release_notes="", release_changes="", preformatted=true)
+    def release(release_name, filenames, release_notes="", release_changes="", preformatted=true, processor=Processor::ANY)
       release_date = Time.now.strftime("%Y-%m-%d %H:%M")
       release_id = nil
 
+      puts "About to release '#{release_name}'"
+      puts "=== Files ==="
+      puts "  " + filenames.join("\n  ")
+      puts "=== Release Notes ==="
+      puts release_notes
+      puts "=== Release Changes ==="
+      puts release_changes
+      puts "=== Release Settings ==="
+      puts "Preformatted: #{preformatted}"
+      puts "Processor: #{processor}"
+      puts "\nStarting release..."
+
       xfiles = filenames.collect{|filename| XFile.new(filename)}      
       xfiles.each_with_index do |xfile, i|
         first_file = i==0

data/lib/xforge/version_parser.rb

@@ -0,0 +1,43 @@
+module XForge
+  class VersionParser
+    def parse(changes_file, version)
+      release_notes_first = nil
+      changes_first = nil
+      changes_last = nil
+      
+      lines = File.open(changes_file).readlines
+      state = nil
+      lines.each_with_index do |line, n|
+        # parse state
+        if line =~ /#{version}/ && state.nil?
+          state = :in_release_notes
+          release_notes_first = n+1
+        end
+        if (line =~ /\*/ && (state == :in_release_notes))
+          state = :in_changes
+          changes_first = changes_last = n
+        end
+        if (line =~ /\*/ && (state == :in_changes))
+          changes_last = n
+        end
+        if line =~ /^==/ && state == :in_changes
+          state = :done
+        end
+      end
+      
+      release_notes = lines[release_notes_first..changes_first-1].join("")
+      release_changes = lines[changes_first..changes_last].collect{|line| line[2..-1].chomp}
+      Version.new(release_notes, release_changes)
+    end
+  end
+  
+  class Version
+    attr_reader :release_notes # String
+    attr_reader :release_changes # Array of String
+    
+    def initialize(release_notes, release_changes)
+      puts release_notes
+      @release_notes, @release_changes = release_notes, release_changes
+    end
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.8
 specification_version: 1
 name: xforge
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2005-07-18
+  version: 0.1.3
+date: 2005-08-11
 summary: Ruby based make-like utility.
 require_paths: 
   - lib
@@ -37,6 +37,7 @@ files:
   - lib/rake/contrib/xforge.rb
   - lib/rake/contrib/xforge/base.rb
   - lib/rake/contrib/xforge/release.rb
+  - lib/xforge/version_parser.rb
   - doc/base_attrs.rdoc
 test_files: []
 rdoc_options: