meta_project 0.4.12 → 0.4.13

data/lib/meta_project/version_parser.rb

@@ -1,52 +1,52 @@
-module MetaProject
-  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 =~ /^==/ && state == :in_release_notes && state != :done)
-          changes_first = changes_last = n
-          state = :done
-        end
-        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("")
-      raise "Release notes for #{version} couldn't be parsed from #{changes_file}" if release_notes.strip == ""
-
-      release_changes = lines[changes_first..changes_last].collect do |line| 
-        line.length >= 2 ? line[2..-1].chomp : line
-      end
-      raise "Release changes for #{version} couldn't be parsed from #{changes_file}" if release_changes.length == 0
-
-      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)
-      @release_notes, @release_changes = release_notes, release_changes
-    end
-  end
-end
+module MetaProject
+  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 =~ /^==/ && state == :in_release_notes && state != :done)
+          changes_first = changes_last = n
+          state = :done
+        end
+        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("")
+      raise "Release notes for #{version} couldn't be parsed from #{changes_file}" if release_notes.strip == ""
+
+      release_changes = lines[changes_first..changes_last].collect do |line| 
+        line.length >= 2 ? line[2..-1].chomp : line
+      end
+      raise "Release changes for #{version} couldn't be parsed from #{changes_file}" if release_changes.length == 0
+
+      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)
+      @release_notes, @release_changes = release_notes, release_changes
+    end
+  end
+end

data/lib/rake/contrib/xforge.rb

@@ -1,3 +1,3 @@
-require 'rake/contrib/xforge/base'
-require 'rake/contrib/xforge/release'
-require 'rake/contrib/xforge/news_publisher'
+require 'rake/contrib/xforge/base'
+require 'rake/contrib/xforge/release'
+require 'rake/contrib/xforge/news_publisher'

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

@@ -1,64 +1,64 @@
-module Rake
-  module XForge
-    # Base class for XForge tasks.
-    class Base
-      # 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)
-  
-        if block_given?
-          yield self
-          set_defaults
-          execute
-        end
-      end
-      
-    protected
-      def set_defaults
-      end
-      
-      def user_name
-        unless @user_name
-          print "#{@project.host} user: "
-          @user_name = STDIN.gets.chomp
-        end
-        @user_name
-      end
-
-      def password
-        unless @password
-          print "#{@project.host} password: "
-          @password = STDIN.gets.chomp
-        end
-        @password
-      end
-    end
-  end
-end
+module Rake
+  module XForge
+    # Base class for XForge tasks.
+    class Base
+      # 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)
+  
+        if block_given?
+          yield self
+          set_defaults
+          execute
+        end
+      end
+      
+    protected
+      def set_defaults
+      end
+      
+      def user_name
+        unless @user_name
+          print "#{@project.host} user: "
+          @user_name = STDIN.gets.chomp
+        end
+        @user_name
+      end
+
+      def password
+        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,97 +1,97 @@
-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.
-    #
-    #   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
-
-      # 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
-        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
-          begin
-            vp = ::MetaProject::VersionParser.new
-            version = vp.parse(@changes_file, @version)
-            @details = version.release_notes unless @details
-          rescue => e
-            STDERR.puts("Couldn't parse release info from #{@changes_file}")
-            STDERR.puts(e.message)
-            STDERR.puts(e.backtrace.join("\n"))
-          end
-        end
-      end
-    end
-  end
-end
+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.
+    #
+    #   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
+
+      # 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
+        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
+          begin
+            vp = ::MetaProject::VersionParser.new
+            version = vp.parse(@changes_file, @version)
+            @details = version.release_notes unless @details
+          rescue => e
+            STDERR.puts("Couldn't parse release info from #{@changes_file}")
+            STDERR.puts(e.message)
+            STDERR.puts(e.backtrace.join("\n"))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,134 +1,134 @@
-module Rake
-  module XForge
-    # 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(project) {}
-    #   end
-    #
-    # 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:
-    #
-    # * #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(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
-    #
-    # This can be invoked from the command line:
-    #
-    #   rake release RUBYFORGE_USER=myuser \
-    #                RUBYFORGE_PASSWORD=mypassword
-    #
-    # If you don't like blocks, you can do like this:
-    #
-    #   project = MetaProject::Project::XForge::RubyForge.new('xforge')
-    #   task :release => [:gem] do
-    #     xf = Rake::XForge::Release.new(project)
-    #     ... # Set additional attributes
-    #     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
-
-      protected
-      def set_defaults
-        unless @files
-          if defined?(::PKG_FILE_NAME)
-            @files = ["pkg/#{PKG_FILE_NAME}.gem"]
-          else
-            @files = Dir["pkg/**/*.gem"]
-          end
-        end
-
-        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 and @version
-          begin
-            vp = ::MetaProject::VersionParser.new
-            version = vp.parse(@changes_file, @version)
-            @release_notes = version.release_notes unless @release_notes
-            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)
-            STDERR.puts(e.backtrace.join("\n"))
-          end
-        end
-      end
-    end
-  end
-end
+module Rake
+  module XForge
+    # 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(project) {}
+    #   end
+    #
+    # 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:
+    #
+    # * #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(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
+    #
+    # This can be invoked from the command line:
+    #
+    #   rake release RUBYFORGE_USER=myuser \
+    #                RUBYFORGE_PASSWORD=mypassword
+    #
+    # If you don't like blocks, you can do like this:
+    #
+    #   project = MetaProject::Project::XForge::RubyForge.new('xforge')
+    #   task :release => [:gem] do
+    #     xf = Rake::XForge::Release.new(project)
+    #     ... # Set additional attributes
+    #     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
+
+      protected
+      def set_defaults
+        unless @files
+          if defined?(::PKG_FILE_NAME)
+            @files = ["pkg/#{PKG_FILE_NAME}.gem"]
+          else
+            @files = Dir["pkg/**/*.gem"]
+          end
+        end
+
+        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 and @version
+          begin
+            vp = ::MetaProject::VersionParser.new
+            version = vp.parse(@changes_file, @version)
+            @release_notes = version.release_notes unless @release_notes
+            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)
+            STDERR.puts(e.backtrace.join("\n"))
+          end
+        end
+      end
+    end
+  end
+end