meta_project 0.4.3 → 0.4.4

data/CHANGES

@@ -1,12 +1,24 @@
-= XForge Changelog
+= MetaProject Changelog
+
+== Version 0.4.4
+
+This release introduces a new Domain Specific Language (DSL) for SCM commit messages similar to Trac's post-commit hook for updating tickets.
+Patois is supported in a tracker-agnostic way (although it's only half implemented for JIRA only ATM).
+There is also initial support for FreshMeat and RAA thanks to Thomas Leitner.
+
+* Added support for Patois parsing (See RubyDoc).
+* Gave the Patois DSL its name.
+* Improved the Tracker::Issue API to be more OO and uniform across trackers.
+* Adds support for FreshMeat and RAA (Fixes #2323). This is not aligned with the rest of the MetaProject API yet.
 
 == Version 0.4.3
 
-This is a bugfix release.
+This release fixes some bugs and implements some new issue tracker features.
 
 * Aligned properties between TracTracker and JiraTracker with ProjectAnalyzer.
 * Stripping leading and trailing whitespace from issue summaries (SF seems to have changed).
 * Added name to XForge projects.
+* Added create_issue to JiraTracker.
 
 == Version 0.4.2
 

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.3"
+PKG_VERSION = "0.4.4"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILES = FileList[
   '[A-Z]*',

data/lib/meta_project/patois/parser.rb

@@ -0,0 +1,99 @@
+module MetaProject
+  # Patois is a domain specific language (DSL)
+  # for configuration and release management. It was first implemented by 
+  # <a href="http://projects.edgewall.com/trac/browser/trunk/contrib/trac-post-commit-hook">Trac</a>
+  # and this class is a Ruby port of that Python code. 
+  #
+  # A similar idea was created by the DamageControl team in <a href="http://jira.codehaus.org/browse/DC-159">DC-159</a>
+  # before it was implemented in Trac, but the Trac team beat the DamageControl to implement it.
+  #
+  # Anyhow, by giving this mini DSL a name and some better profiling we hope its adoption 
+  # will increase. Patois means:
+  # 
+  # * a dialect other than the standard or literary dialect 
+  # * uneducated or provincial speech
+  # * the characteristic special language of an occupational or social group
+  #
+  # Patois' intended usage is in SCM commit messages. A patois-aware system can parse the commit
+  # messages and try to recognise patois expressions and take appropriate actions.
+  #
+  # Here is a little taste of what you can say and do with Patois.
+  #
+  # == General form
+  #
+  #   command #1
+  #   command #1, #2
+  #   command #1 & #2
+  #   command #1 and #2    # == Closing issues in an issue tracker
+  #
+  # You can have more than one command in a message. The following commands
+  # are supported. There is more than one spelling for each command, to make
+  # this as user-friendly as possible.
+  #
+  #   close, closed, closes, fix, fixed, fixes
+  #     The specified issues are closed with the contents of the
+  #     commit message being added to it.
+  #
+  #   addresses, re, ref, references, refs, see
+  #     The specified issues are left in their current status, but
+  #     the contents of the commit message are added to their notes.
+  #
+  # A fairly complicated example of what you can do is with a commit message
+  # of:
+  #
+  #    Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12.
+  #
+  # This will close #10 and #12, and add a note to #12
+  #
+  module Patois
+    
+    # Parses Patois
+    #
+    class Parser
+
+      SUPPORTED_COMMANDS = {
+        'close'      =>  ':close',
+        'closed'     =>  ':close',
+        'closes'     =>  ':close',
+        'fix'        =>  ':close',
+        'fixed'      =>  ':close',
+        'fixes'      =>  ':close',
+        'addresses'  =>  ':comment',
+        're'         =>  ':comment',
+        'ref'        =>  ':comment',
+        'references' =>  ':comment',
+        'refs'       =>  ':comment',
+        'see'        =>  ':comment'
+      }
+      
+      # Creates a new parser that will parse commands with +command_pattern+
+      # and emit individual commands with +issue_pattern+.
+      def initialize(command_pattern, issue_pattern)
+        @command_pattern = command_pattern
+        @issue_pattern = issue_pattern
+      end
+
+      # Parses a patois String and yields commands.
+      # Each operation can be executed with +execute+
+      def parse(msg)
+        msg.scan(@command_pattern) do |cmd_group|
+          cmd = SUPPORTED_COMMANDS[cmd_group[0].downcase]
+          if(cmd)
+            cmd_group[1].scan(@issue_pattern) do |issue_id_array|
+              yield Command.new(cmd, issue_id_array[0].upcase, msg)
+            end
+          end
+        end
+      end
+      
+      class Command
+        
+        attr_reader :cmd, :issue_id, :msg
+
+        def initialize(cmd, issue_id, msg)
+          @cmd, @issue_id, @msg = cmd, issue_id, msg
+        end
+      end
+    end
+  end
+end

data/lib/meta_project/patois.rb

@@ -0,0 +1 @@
+require 'meta_project/patois/parser'

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

@@ -46,7 +46,7 @@ module MetaProject
         def group_id
           unless(@group_id)
             regexp = /stats\/[?&]group_id=(\d+)/
-            html = open(xforge_project_url) { |data| data.read }
+            html = open(xforge_project_url).read
             @group_id = html[regexp, 1]
             raise "Couldn't get group_id" unless @group_id
           end
@@ -64,7 +64,7 @@ module MetaProject
         # The home page of this project
         def home_page
           unless(@home_page)
-            html = open(xforge_project_url) { |data| data.read }
+            html = open(xforge_project_url).read
             @home_page = html[home_page_regexp, 1]
             raise "Couldn't get home_page" unless @home_page
           end

data/lib/meta_project/release/freshmeat.rb

@@ -0,0 +1,267 @@
+# Copyright (C) 2005 Thomas Leitner
+#
+# See LICENCE for details
+
+require "xmlrpc/client"
+require 'yaml'
+
+module DevTools
+
+  module Freshmeat
+
+    class FreshmeatException < StandardError; end
+
+    # Describes a freshmeat project.
+    class Project
+
+      # The short name of the project
+      attr_reader :shortName
+
+      # The full name of the project
+      attr_reader :fullName
+
+      # The status of the project (alpha, beta, ...)
+      attr_reader :status
+
+      # The current version string of the project
+      attr_reader :version
+
+      def initialize( shortName, fullName, status, version )
+        @shortName, @fullName, @status, @version = shortName, fullName, status, version
+      end
+
+      def to_s
+        "Project: short name = #{@shortName}, full name = #{@fullName}, status = #{@status}, version = #{@version}"
+      end
+
+    end
+
+    # Provides information about a release.
+    class ReleaseInfo
+
+      # Version string of release
+      attr_reader :version
+
+      # Change list of release
+      attr_reader :changes
+
+      # Release focus
+      attr_reader :release_focus
+
+      # True, if hidden from frontpage
+      attr_reader :hidden
+
+      # Returns a new ReleaseInfo object
+      def initialize( version, changes, release_focus, hidden )
+        @version, @changes, @release_focus, @hidden = version, changes, release_focus, hidden
+      end
+
+      def to_s
+        "ReleaseInfo: version = #{@version}, release focus = #{ReleaseFocusID::NAMES[@release_focus]}, hidden = #{hidden}\nChanges = #{@changes}"
+      end
+
+    end
+
+    # Holds all information about a release which should be published.
+    class Release
+
+      #Project name to submit a release for
+      attr_accessor :project_name
+
+      #Branch name to submit a release for
+      attr_accessor :branch_name
+
+      #Version string of new release
+      attr_accessor :version
+
+      #Changes list, no HTML, character limit 600 chars
+      attr_accessor :changes
+
+      #Release focus ID of new release
+      attr_accessor :release_focus
+
+      #Set to 'Y' if release is to be hidden from frontpage, everything else does not hide it
+      attr_accessor :hide_from_frontpage
+
+      #Optional: Branch license
+      attr_accessor :license
+
+      #Optional: Homepage
+      attr_accessor :url_homepage
+
+      #Optional: Tar/GZ
+      attr_accessor :url_tgz
+
+      #Optional: Tar/BZ2
+      attr_accessor :url_bz2
+
+      #Optional: Zip
+      attr_accessor :url_zip
+
+      #Optional: Changelog
+      attr_accessor :url_changelog
+
+      #Optional: RPM package
+      attr_accessor :url_rpm
+
+      #Optional: Debian package
+      attr_accessor :url_deb
+
+      #Optional: OS X package
+      attr_accessor :url_osx
+
+      #Optional: BSD Ports URL
+      attr_accessor :url_bsdport
+
+      #Optional: Purchase
+      attr_accessor :url_purchase
+
+      #Optional: CVS tree (cvsweb)
+      attr_accessor :url_cvs
+
+      #Optional: Mailing list archive
+      attr_accessor :url_list
+
+      #Optional: Mirror site
+      attr_accessor :url_mirror
+
+      #Optional: Demo site
+      attr_accessor :url_demo
+
+      def self.from_data( data=nil )
+        YAML::load( data )
+      end
+
+      def to_rpc_data
+        rpc_data = {}
+        instance_variables.each do |iv|
+          rpc_data[iv[1..-1]] = eval( iv )
+        end
+        rpc_data
+      end
+
+      def to_yaml_type
+        "!thomasleitner,2005/FreshmeatRelease"
+      end
+
+      YAML::add_domain_type( 'thomasleitner,2005', 'FreshmeatRelease' ) do |type, val|
+        YAML::object_maker( Release, val )
+      end
+
+    end
+
+    # Provides constants for all release focus ids
+    module ReleaseFocusID
+      NA                   = 0
+      INITIAL_ANNOUNCEMENT = 1
+      DOCUMENTATION        = 2
+      CODE_CLEANUP         = 3
+      MINOR_FEATURES       = 4
+      MAJOR_FEATURES       = 5
+      MINOR_BUGFIXES       = 6
+      MAJOR_BUGFIXES       = 7
+      MINOR_SECFIXES       = 8
+      MAJOR_SECFIXES       = 9
+
+      NAMES = {0=>'N/A',
+               1=>'Initial freshmeat announcement',
+               2=>'Documentation',
+               3=>'Code cleanup',
+               4=>'Minor feature enhancements',
+               5=>'Major feature enhancements',
+               6=>'Minor bugfixes',
+               7=>'Major bugfixes',
+               8=>'Minor security fixes',
+               9=>'Major security fixes'
+      }
+    end
+
+
+    # Provides access to the Freshmeat XML-RPC API via a nice interface.
+    # API reference at http://freshmeat.net/faq/view/49/
+    #
+    # Example:
+    #
+    #   fm = DevTools::FreshmeatService.new( username, password )
+    #   fm.get_project_list.each do |p|
+    #     puts p
+    #     branches = fm.get_branch_list( p.shortName )
+    #     puts branches.inspect
+    #     release = fm.get_release( p.shortName, branches[0], p.version )
+    #     puts release
+    #   end
+    #   puts fm.logout
+    class FreshmeatService
+
+      # The URL for the Freshmeat RPC service
+      RPCURL = 'http://freshmeat.net/xmlrpc/'
+
+      # The major version of the freshmeat API with which this library works
+      API_VERSION_MAJOR = '1'
+
+      # The minor version of the freshmeat API with which this library works
+      API_VERSION_MINOR = '03'
+
+      # Use +username+ and +password+ to log into Freshmeat service.
+      def initialize( username, password )
+        @session = XMLRPC::Client.new2( RPCURL )
+        ret = @session.call( :login, :username=>username, :password=>password )
+        @sid = ret['SID']
+        major, minor = ret['API Version'].split( '.' )
+        if major != API_VERSION_MAJOR or minor < API_VERSION_MINOR
+          raise FreshmeatException, 'Incompatible API versions'
+        end
+      end
+
+      # Returns all available licenses
+      def self.get_licenses
+        XMLRPC::Client.new2( RPCURL ).call( :fetch_available_licenses )
+      end
+
+      # Returns all available release focus types
+      def self.get_release_focus_types
+        XMLRPC::Client.new2( RPCURL ).call( :fetch_available_release_foci )
+      end
+
+      # Returns an array of Project objects which are assigned to the logged in user
+      def get_project_list
+        ret = @session.call( :fetch_project_list, :SID=>@sid )
+        ret.collect! {|p| Project.new( p['projectname_short'], p['projectname_full'], p['project_status'], p['project_version'] ) }
+      end
+
+      # Returns an array of branch names for the project +project+.
+      def get_branch_list( project )
+        @session.call( :fetch_branch_list, :SID=>@sid, :project_name=>project )
+      end
+
+      # Returns a ReleaseInfo object which has the information about the requested release.
+      def get_release( project, branch, version )
+        ret = @session.call( :fetch_release, :SID=>@sid, :project_name=>project, :branch_name=>branch, :version=>version )
+        releaseFocus = ret['release_focus'].split( ' - ' )[0].to_i
+        hidden = (ret['hide_from_frontpage'] == 'Y' )
+        ReleaseInfo.new( ret['version'], ret['changes'], releaseFocus, hidden )
+      end
+
+      # Publishes a new release of a project. The parameter +release+ has to be a Release object!
+      def publish_release( release )
+        ret = @session.call( :publish_release, {:SID=>@sid}.update( release.to_rpc_data ) )
+        ret['OK'] == 'submission successful'
+      end
+
+      # Withdraws the specified release.
+      def withdraw_release( project, branch, version )
+        ret = @session.call( :withdraw_release, :SID=>@sid, :project_name=>project, :branch_name=>branch, :version=>version )
+        ret['OK'] == 'Withdraw successful.'
+      end
+
+      # Logs out from the Freshmeat service.
+      def logout
+        ok, ret = @session.call2( :logout, :SID=>@sid )
+        ok && ret['OK'] == 'Logout successful.'
+      end
+
+    end
+
+  end
+
+end