meta_project 0.4.10 → 0.4.11

data/CHANGES

@@ -1,5 +1,13 @@
 = MetaProject Changelog
 
+== Version 0.4.11
+
+This release fixes several bugs in the XForge release code and improves documentation.
+
+* Fixed #2398: Rake::XForge::Release doesn't allow manual setting of release_notes or release_changes
+* Fixed #2399: Net::HTTPRequestURITooLong 414 readbody=true
+* Fixed #2400: Project release always selects the *first* package
+
 == Version 0.4.10
 
 This version fixes some bugs in the JIRA and SourceForge APIs.

data/README

@@ -1,4 +1,4 @@
-= MetaProject 0.4.10
+= MetaProject 0.4.11
 
 MetaProject (formerly XForge) is a library that allows interaction with various project hosting servers, issue trackers, SCMs and SCM browsers through a common API.
 
@@ -100,7 +100,9 @@ and +release_changes+ to the task. Example:
 
 (In alphabetical order)
 
-[<b>Aslak Hellesoy</b>] Maintainer of this project.
+[<b>Aslak Hellesoy</b>] Creator and main contributor of this project.
+
+[<b>Austin Ziegler</b>] Bugfixes and documentation improvements for XForge release code.
 
 [<b>David Heinemeier Hansson</b>] For the HTTP POST code and the idea to parse XForge ids from project pages.
 

data/Rakefile

@@ -24,7 +24,7 @@ require 'rake/rdoctask'
 #
 # REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
 PKG_NAME = "meta_project"
-PKG_VERSION = "0.4.10"
+PKG_VERSION = "0.4.11"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',

data/lib/meta_project/patois/parser.rb

@@ -74,7 +74,7 @@ module MetaProject
       end
 
       # Parses a patois String and yields commands.
-      # Each operation can be executed with +execute+
+      # TODO: Each operation can be executed with +execute+
       def parse(msg)
         msg.scan(@command_pattern) do |cmd_group|
           cmd = SUPPORTED_COMMANDS[cmd_group[0].downcase]

data/lib/meta_project/project/xforge/session.rb

@@ -1,14 +1,12 @@
 module MetaProject
   module Project
     module XForge
-
-      # A Session object allows authenticated interaction with a Project, such as releasing files.
+      # A Session object allows authenticated interaction with a Project,
+      # such as releasing files.
       #
       # A Session object can be obtained via Project.login
-      #
       class Session
-
-        # Simple enumeration of processors. Used from Session.release
+        # Simple enumeration of processors. Used from Session.release.
         class Processor
           I386           = 1000
           IA64           = 6000
@@ -21,7 +19,7 @@ module MetaProject
           OTHER_PLATFORM = 9999
         end
 
-        BOUNDARY = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor"
+        BOUNDARY = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor" #:nodoc:
 
         def initialize(host, project, cookie) # :nodoc:
           @host = host
@@ -29,13 +27,31 @@ module MetaProject
           @headers = { "Cookie" => cookie }
         end
 
-        # The package_id of our project
-        def package_id
-          unless(@package_id)
+        PACKAGE_ID_PATTERN  = %r{name="package_id"
+                                 \s+
+                                 value="([^"]+)"
+                                 .*?
+                                 name="package_name"
+                                 \s+
+                                 value="([^"]+)"}mxo #:nodoc:
+
+        # This will get the +package_id+ for the project. This accepts an
+        # optional name of the package that will be searched for results. A
+        # given session will only work for one package.
+        def package_id(name = nil)
+          unless @package_id
             release_uri = "http://#{@host}/frs/admin/?group_id=#{@project.group_id}"
             release_data = better_open(release_uri, @headers).read
-            package_id_pattern = /name="package_id" value="(\d+)"/
-            @package_id = release_data[package_id_pattern, 1]
+            packages = release_data.scan(PACKAGE_ID_PATTERN)
+            first = packages[0][0]
+            packages = Hash[*packages.map { |el| el.reverse }.flatten]
+
+            if name
+              @package_id = packages[name]
+            else
+              @package_id = first
+            end
+            
             unless @package_id
               File.open("package_id.html", "w") {|io| io.write(release_data)}
               raise "Couldn't get package_id from #{release_uri}. I was looking for /#{package_id_pattern.source}/. HTML saved to package_id.html for debugging." 
@@ -44,11 +60,16 @@ module MetaProject
           @package_id
         end
 
-        # Creates a new release containing the files specified by +filenames+ (Array) and named +release_name+.
-        # 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(release_name, filenames, release_notes="", release_changes="", preformatted=true, processor=Processor::ANY)
+        # Creates a new release containing the files specified by
+        # +filenames+ (Array) and named +release_name+. 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. The
+        # +package_name+ parameter will help choose from the possible
+        # multiple packages for a release.
+        def release(release_name, filenames, release_notes = "",
+                    release_changes = "", package_name = nil,
+                    preformatted = true, processor = Processor::ANY)
           release_date = Time.now.strftime("%Y-%m-%d %H:%M")
           release_id = nil
 
@@ -56,9 +77,9 @@ module MetaProject
           puts "Files:"
           puts "  " + filenames.join("\n  ")
           puts "\nRelease Notes:\n"
-          puts release_notes
+          puts release_notes.split(/\n/)[0..10].join("\n")
           puts "\nRelease Changes:\n"
-          puts release_changes
+          puts release_changes.split(/\n/)[0..10].join("\n")
           puts "\nRelease Settings:\n"
           puts "Preformatted: #{preformatted}"
           puts "Processor: #{processor}"
@@ -66,13 +87,13 @@ module MetaProject
 
           xfiles = filenames.collect{|filename| XFile.new(filename)}      
           xfiles.each_with_index do |xfile, i|
-            first_file = i==0
+            first_file = (i == 0)
             puts "Releasing #{xfile.basename}..."
             release_response = Net::HTTP.start(@host, 80) do |http|
               query_hash = if first_file then
                 {
                   "group_id" => @project.group_id,
-                  "package_id" => package_id,
+                  "package_id" => package_id(package_name),
                   "type_id" => xfile.bin_type_id,
                   "processor_id" => processor,
 
@@ -86,7 +107,7 @@ module MetaProject
               else
                 {
                   "group_id" => @project.group_id,
-                  "package_id" => package_id,
+                  "package_id" => package_id(package_name),
                   "type_id" => xfile.bin_type_id,
                   "processor_id" => processor,
 
@@ -96,22 +117,22 @@ module MetaProject
                 }
               end
 
-              query = query(query_hash)
-
-              data = [
-                "--" + BOUNDARY,
-                "Content-Disposition: form-data; name=\"userfile\"; filename=\"#{xfile.basename}\"",
+              form = [
+                "--#{BOUNDARY}",
+                %Q(Content-Disposition: form-data; name="userfile"; ) +
+                  %Q(filename="#{xfile.basename}"),
                 "Content-Type: application/octet-stream",
                 "Content-Transfer-Encoding: binary",
                 "", xfile.data, ""
-                ].join("\x0D\x0A")
+              ]
+
+              data = post_data(form, query_hash)
+
+              headers = @headers.merge("Content-Type" => "multipart/form-data; boundary=#{BOUNDARY}")
 
-              headers = @headers.merge(
-                "Content-Type" => "multipart/form-data; boundary=#{BOUNDARY}"
-              )
 
               target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php"
-              http.post(target + query, data, headers)
+              http.post(target, data, headers)
             end
 
             if first_file then
@@ -122,6 +143,7 @@ module MetaProject
           puts "Done!"
         end
     
+        # Publish news relating to a project and a package.
         def publish_news(subject, details)
           puts "About to publish news"
           puts "Subject: '#{subject}'"
@@ -132,31 +154,38 @@ module MetaProject
           release_response = Net::HTTP.start(@host, 80) do |http|
             query_hash = {
               "group_id" => @project.group_id,
-              "package_id" => package_id,
               "post_changes" => "y",
               "summary" => subject,
               "details" => details
             }
       
             target = "/news/submit.php"
-            headers = @headers.merge(
-              "Content-Type" => "multipart/form-data"
-            )
-            http.post(target + query(query_hash), "", headers)
+            headers = @headers.merge("Content-Type" => "multipart/form-data; boundary=#{BOUNDARY}")
 
+            http.post(target, post_data(query_hash), headers)
           end
           puts "Done!"
         end
 
       private
-  
-        def query(query_hash)
-          "?" + query_hash.map do |(name, value)|
-            [name, URI.encode(value.to_s)].join("=")
-          end.join("&")
+        def post_data(*args)
+          form = []
+          args.each do |arg|
+            case arg
+            when Array
+              form << arg
+            when Hash
+              arg.each do |key, value|
+                form <<
+                  "--#{BOUNDARY}" <<
+                  %Q(Content-Disposition: form-data; name="#{key}") <<
+                  "" << value
+              end
+            end
+          end
+          form.flatten.join("\r\n")
         end
-
       end
     end
   end
-end
+end

data/lib/meta_project/project/xforge/xforge_base.rb

@@ -76,4 +76,4 @@ module MetaProject
       end
     end
   end
-end
+end

data/lib/meta_project/tracker/digit_issues.rb

@@ -1,16 +1,17 @@
 module MetaProject
   module Tracker
-    # This module should be included by trackers that follow a digit-based issue scheme
+    # This module should be included by trackers that follow a digit-based issue scheme.
+    # TODO: Make issue_pattern and command_pattern attributes so they can be modified. Provide examples.
     module DigitIssues
       # Patois issue pattern
       def issue_pattern
-        /\#([\d]+)/
+        @issue_pattern ||= /\#([\d]+)/
       end
       module_function :issue_pattern
 
       # Patois command pattern
       def command_pattern
-        /([A-Za-z]*).?(\#[\d]+(?:(?:[, &]*|\s?and\s?)\#[\d]+)*)/
+        @command_pattern ||= /([A-Za-z]*).?(\#[\d]+(?:(?:[, &]*|\s?and\s?)\#[\d]+)*)/
       end
       module_function :command_pattern
 

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

@@ -1,17 +1,39 @@
 module Rake
   module XForge
-  
-    # Base class for XForge tasks
+    # Base class for XForge tasks.
     class Base
-      attr_accessor :user_name, :password, :changes_file
+      # The user name for the xForge login of a release administrator of the
+      # project being released. This should NOT be stored in the Rakefile.
+      attr_accessor :user_name
+      # The password for the xForge login of a release administrator of the
+      # project being released. This should NOT be stored in the Rakefile.
+      attr_accessor :password
+      # The CHANGES file. If this file exists, it is parsed according to the
+      # standard CHANGES version parsing routines. See CHANGES FORMAT below
+      # for more information. Defaults to CHANGES if unset. #version must
+      # also be set.
+      #
+      # === CHANGES FORMAT
+      # The CHANGES file is essentially an RDoc-format changelog in the
+      # form:
+      #
+      #   == Version VERSION-Pattern
+      #
+      #   RELEASE NOTES
+      #
+      #   * Change 1
+      #   * Change 2
+      attr_accessor :changes_file
+      # Modifies the release version and affects CHANGES file parsing.
+      attr_accessor :version
 
       def initialize(project)
         @project = project
 
         @changes_file = "CHANGES"
-        @version = PKG_VERSION if defined? PKG_VERSION
+        @version = ::PKG_VERSION if defined?(::PKG_VERSION)
   
-        if(block_given?)
+        if block_given?
           yield self
           set_defaults
           execute
@@ -19,12 +41,11 @@ module Rake
       end
       
     protected
-    
       def set_defaults
       end
       
       def user_name
-        if(@user_name.nil?)
+        unless @user_name
           print "#{@project.host} user: "
           @user_name = STDIN.gets.chomp
         end
@@ -32,13 +53,12 @@ module Rake
       end
 
       def password
-        if(@password.nil?)
+        unless @password
           print "#{@project.host} password: "
           @password = STDIN.gets.chomp
         end
         @password
       end
-  
     end
   end
 end

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

@@ -1,19 +1,86 @@
 module Rake
   module XForge
-
-    # This Rake task publishes news entries for a project.
-    # Publishing news is a good way to make your project visible
-    # on the main RubyForge page.
+    # This Rake task publishes news entries for a project. Publishing news
+    # is a good way to make your project visible on the main RubyForge page.
+    #
+    #   project = MetaProject::Project::XForge::RubyForge.new('xforge')
+    #   # Create a new news item for the xforge project on Rubyforge.
+    #   task :news => [:gem] do
+    #     Rake::XForge::NewsPublisher.new(project) {}
+    #   end
+    #
+    # The previous example will use defaults where it can. It will prompt
+    # you for your xForge user name and password before it posts a news item
+    # about the project with a default subject and news details.
+    #
+    # While defaults are nice, you may want a little more control. You can
+    # specify additional attributes:
+    #
+    # * #user_name
+    # * #password
+    # * #changes_file
+    # * #version
+    # * #subject
+    # * #details
+    #
+    # Example:
+    #   project = MetaProject::Project::XForge::RubyForge.new('xforge')
+    #   task :news => [:gem] do
+    #     Rake::XForge::NewsPublisher.new(project) do |xf|
+    #       # Never hardcode user name and password in the Rakefile!
+    #       xf.user_name = ENV['RUBYFORGE_USER']
+    #       xf.password = ENV['RUBYFORGE_PASSWORD']
+    #       xf.subject = "XForge 0.1 Released"
+    #       xf.details = "Today, XForge 0.1 was released to the ..."
+    #     end
+    #   end
+    #
+    # This can be invoked from the command line:
+    #
+    #   rake news RUBYFORGE_USER=myuser \
+    #             RUBYFORGE_PASSWORD=mypassword
+    #
+    # If you don't like blocks, you can do like this:
+    #
+    #   task :news => [:gem] do
+    #     xf = Rake::XForge::NewsPublisher.new(project)
+    #     ... # Set additional attributes
+    #     xf.execute
+    #   end
     class NewsPublisher < Base
+      # A plain-text headline for the news byte to be published.
+      attr_accessor :subject
+      # The plain-text news to be published. Hyperlinks are usually
+      # converted to hyperlinks by the xForge software.
+      attr_accessor :details
 
-      attr_accessor :subject, :details
+      # Runs the news publisher task.
+      def execute
+        raise "'details' not defined." unless @details
+        raise "'subject' not defined." unless @subject
+        session = @project.login(user_name, password)
+        session.publish_news(@subject, @details)
+      end
 
     protected
-
       def set_defaults
-        @subject = "#{PKG_NAME}-#{PKG_VERSION} released" unless @subject
+        unless @subject
+          if defined?(::PKG_NAME)
+            if defined?(::PKG_VERSION)
+              @subject = "#{::PKG_NAME} #{::PKG_VERSION} released"
+            elsif defined?(@version)
+              @subject = "#{::PKG_NAME} #{@version} released"
+            end
+          else
+            if defined?(::PKG_VERSION)
+              @subject = "#{@project.name} #{::PKG_VERSION} released"
+            elsif defined?(@version)
+              @subject = "#{@project.name} #{@version} released"
+            end
+          end
+        end
 
-        if(@changes_file && @version)
+        if @changes_file && @version
           begin
             vp = ::MetaProject::VersionParser.new
             version = vp.parse(@changes_file, @version)
@@ -25,14 +92,6 @@ module Rake
           end
         end
       end
-
-      def execute
-        raise "'details' not defined." unless @details
-        raise "'subject' not defined." unless @subject
-        session = @project.login(user_name, password)
-        session.publish_news(@subject, @details)
-      end
-
     end
   end
 end

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

@@ -1,72 +1,127 @@
 module Rake
   module XForge
-
-    # This Rake task releases files to RubyForge or other SourceForge clones. In its most simple usage it looks like:
+    # This Rake task releases files to RubyForge and other GForge instaces
+    # or SourceForge clones. In its most simple usage it looks like:
     #
+    #   project = MetaProject::Project::XForge::RubyForge.new('xforge')
     #   # Create a new release of the xforge project on Rubyforge.
-    #   task :release => [:gem] do
-    #     Rake::XForge::Release.new('xforge') {}
+    #   task :release => [:gem] do
+    #     Rake::XForge::Release.new(project) {}
     #   end
     #
-    # The previous example will use defaults where it can. It will prompt you for your RubyForge user name 
-    # and password before it uploads all gems under the pkg folder and creates a RubyForge release.
+    # The previous example will use defaults where it can. It will prompt
+    # you for your xForge user name and password before it uploads all
+    # gems under the pkg folder and creates a RubyForge release.
     #
-    # While defaults are nice, you may want a little more control. You can specify additional attributes:
+    # While defaults are nice, you may want a little more control. You can
+    # specify additional attributes:
     #
-    # :include: /doc/base_attrs.rdoc
-    # * files - an array of files that should go into the release
-    # * release_name - name of the release
+    # * #user_name
+    # * #password
+    # * #changes_file
+    # * #version
+    # * #files
+    # * #release_name
+    # * #release_notes
+    # * #release_changes
+    # * #package_name
     #
     # Example:
-    #
+    #   project = MetaProject::Project::XForge::RubyForge.new('xforge')
     #   task :release => [:gem] do
-    #     release_files = FileList[
-    #       'pkg/*.gem', 
-    #       'CHANGES'
-    #     ]
-    #
-    #     Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('xforge')) do |xf|
-    #       # Never hardcode user name and password in the Rakefile!
-    #       xf.user_name = ENV['RUBYFORGE_USER']
+    #     release_files = FileList[ 'pkg/*.gem', 'CHANGES' ]
+    #
+    #     Rake::XForge::Release.new(project) do |xf|
+    #       # 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 0.1"
-    #     end
+    #       xf.release_name = "XForge 0.1"
     #   end
     #
     # This can be invoked from the command line:
     #
-    #   rake release RUBYFORGE_USER=aslak_hellesoy RUBYFORGE_PASSWORD=nahnotreal
+    #   rake release RUBYFORGE_USER=myuser \
+    #                RUBYFORGE_PASSWORD=mypassword
     #
     # If you don't like blocks, you can do like this:
     #
-    #   task :release => [:gem] do
-    #     xf = Rake::XForge::Release.new('xforge')
+    #   project = MetaProject::Project::XForge::RubyForge.new('xforge')
+    #   task :release => [:gem] do
+    #     xf = Rake::XForge::Release.new(project)
     #     ... # Set additional attributes
-    #     xf.execute
+    #     xf.execute
     #   end
-    #
     class Release < Base
+      # An array of files that should be uploaded to xForge. If this is not
+      # provided, the Rake task will default to one of two values. If the
+      # constant ::PKG_FILE_NAME is defined, then @files is
+      # ["pkg/#{PKG_FILE_NAME}.gem"]. Otherwise, it is all .gem files under
+      # the pkg directory.
+      attr_accessor :files
+      # The name of the release. If this is unset, MetaProject will try to
+      # set it with the values of ::PKG_NAME and ::PKG_VERSION, #version, or
+      # the project name.
+      attr_accessor :release_name
+      # Optional unless the CHANGES file is in a format different than
+      # expected. You can set the release notes with this value.
+      attr_accessor :release_notes
+      # Optional unless the CHANGES file is in a format different than
+      # expected. You can set the change notes with this value.
+      attr_accessor :release_changes
+      # Optional package name. This is *necessary* for projects that have
+      # more than one released package. If not defined, then the *first*
+      # package ID that is found on the xForge release page will be used.
+      attr_accessor :package_name
+
+      # Runs the release task.
+      def execute
+        raise "'release_name' not defined." unless @release_name
+        raise "'files' not defined." unless @files
+        raise "'release_notes' not defined." unless @release_notes
+        raise "'release_changes' not defined." unless @release_changes
+        session = @project.login(user_name, password)
+        session.release(@release_name, @files, @release_notes,
+                        @release_changes, @package_name)
+      end
 
-      attr_accessor :files, :release_name
-  
-    protected
-    
+      protected
       def set_defaults
-        if(@files.nil?)
-          @files = ["pkg/#{PKG_FILE_NAME}.gem"] if defined? PKG_FILE_NAME 
+        unless @files
+          if defined?(::PKG_FILE_NAME)
+            @files = ["pkg/#{PKG_FILE_NAME}.gem"]
+          else
+            @files = Dir["pkg/**/*.gem"]
+          end
         end
-        
-        if(@release_name.nil?)
-          @release_name = "#{PKG_NAME}-#{PKG_VERSION}" if (defined? PKG_NAME && defined? PKG_VERSION)
+
+        unless @release_name
+          if defined?(::PKG_NAME)
+            if defined?(::PKG_VERSION)
+              @release_name = "#{::PKG_NAME}-#{::PKG_VERSION}"
+            elsif @version
+              @release_name = "#{::PKG_NAME}-#{@version}"
+            end
+          else
+            if defined?(::PKG_VERSION)
+              @release_name = "#{@package.name}-#{::PKG_VERSION}"
+            elsif @version
+              @release_name = "#{@package.name}-#{@version}"
+            end
+          end
+          unless @release_name
+            raise "Cannot set release name. There is no version set."
+          end
         end
-        
-        if(@changes_file && @version)
+
+        if @changes_file and @version
           begin
             vp = ::MetaProject::VersionParser.new
             version = vp.parse(@changes_file, @version)
             @release_notes = version.release_notes unless @release_notes
-            @release_changes = "* " + version.release_changes.join("\n* ") unless @release_changes
+            unless @release_changes
+              @release_changes = %Q[* #{version.release_changes.join("\n* ")}]
+            end
           rescue => e
             STDERR.puts("Couldn't parse release info from #{@changes_file}")
             STDERR.puts(e.message)
@@ -74,16 +129,6 @@ module Rake
           end
         end
       end
-      
-      def execute
-        raise "'release_name' not defined." unless @release_name
-        raise "'files' not defined." unless @files
-        raise "'release_notes' not defined." unless @release_notes
-        raise "'release_changes' not defined." unless @release_changes
-        session = @project.login(user_name, password)
-        session.release(@release_name, @files, @release_notes, @release_changes)
-      end
-  
     end
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: meta_project
 version: !ruby/object:Gem::Version 
-  version: 0.4.10
-date: 2005-09-08 00:00:00 -04:00
+  version: 0.4.11
+date: 2005-09-09 00:00:00 -04:00
 summary: Ruby based make-like utility.
 require_paths: 
   - lib