redcar 0.3.2dev → 0.3.3

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/scm_web.rb

@@ -0,0 +1,2 @@
+require 'meta_project/scm_web/browser'
+require 'meta_project/scm_web/pathname'

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/scm_web/browser.rb

@@ -0,0 +1,112 @@
+module MetaProject
+  module ScmWeb
+
+    # A Browser instance is capable of generating URLs to various files and diffs
+    # in an online scm web interface.
+    #
+    class Browser
+
+      attr_accessor :dir_spec, :history_spec, :raw_spec, :html_spec, :diff_spec
+
+      # The variables to use in +uri_specs+ are:
+      #
+      # * path
+      # * revision
+      # * previous_revision
+      #
+      def initialize(dir_spec=nil, history_spec=nil, raw_spec=nil, html_spec=nil, diff_spec=nil, child_dirs_pattern=nil, child_files_pattern=nil)
+        self.dir_spec     = dir_spec     unless dir_spec.nil?
+        self.history_spec = history_spec unless history_spec.nil?
+        self.raw_spec     = raw_spec     unless raw_spec.nil?
+        self.html_spec    = html_spec    unless html_spec.nil?
+        self.diff_spec    = diff_spec    unless diff_spec.nil?
+
+        @child_dirs_pattern    = child_dirs_pattern
+        @child_files_pattern   = child_files_pattern
+      end
+      
+      def dir_spec=(spec)
+        validate_presence_of("dir_spec", spec, "path")
+        @dir_spec = spec
+      end
+
+      def history_spec=(spec)
+        validate_presence_of("history_spec", spec, "path")
+        @history_spec = spec
+      end
+
+      def raw_spec=(spec)
+        validate_presence_of("raw_spec", spec, "path")
+        validate_presence_of("raw_spec", spec, "revision")
+        @raw_spec = spec
+      end
+
+      def html_spec=(spec)
+        validate_presence_of("html_spec", spec, "path")
+        validate_presence_of("html_spec", spec, "revision")
+        @html_spec = spec
+      end
+
+      def diff_spec=(spec)
+        validate_presence_of("diff_spec", spec, "revision")
+        # Can't assume path and previous_revision to be present (Trac doesn't use them)
+        #validate_presence_of("diff_spec", @diff_spec, "path")
+        #validate_presence_of("diff_spec", @diff_spec, "previous_revision")
+        @diff_spec = spec
+      end
+
+      def dir(path)
+        file_uri(path, nil, @dir_spec, nil)
+      end
+
+      def history(path)
+        file_uri(path, nil, @history_spec, nil)
+      end
+
+      def raw(path, revision)
+        file_uri(path, revision, @raw_spec, nil)
+      end
+
+      def html(path, revision)
+        file_uri(path, revision, @html_spec, nil)
+      end
+
+      def diff(path, revision, previous_revision)
+        file_uri(path, revision, @diff_spec, previous_revision)
+      end
+      
+      # The regexp used to determine child directories of a directory
+      def child_dirs_pattern
+        @child_dirs_pattern
+      end
+
+      # The regexp used to determine child files of a directory
+      def child_files_pattern
+        @child_files_pattern
+      end
+
+      # Returns a Pathname representing the root directory of this browser.
+      # NOTE: The root of the browser may be at a lower level than
+      # the toplevel of the online scm web interface; It depends
+      # on the configuration of this instance.
+      def root
+        Pathname.new(self, nil, "", nil, true)
+      end
+
+    private
+
+      def validate_presence_of(spec_name, spec, var)
+        raise "Missing \#{#{var}} in #{spec_name}: '#{spec}'" unless spec =~ /\#\{#{var}\}/
+      end
+
+      def file_uri(path, revision, spec, previous_revision)
+        begin
+          eval("\"#{spec}\"", binding)
+        rescue NameError
+          raise "Couldn't evaluate '#{spec}'"
+        end
+      end
+
+    end
+  end
+end

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/scm_web/pathname.rb

@@ -0,0 +1,89 @@
+module MetaProject
+  module ScmWeb
+    # A subset of the 
+    # <a href="http://www.ruby-doc.org/stdlib/libdoc/pathname/rdoc/index.html">Pathname</a> 
+    # API which is suitable for slurping SCM contents off the web.
+    #
+    class Pathname
+            
+      def initialize(browser, parent, basename, revision_identifier, directory)
+        @browser, @parent, @basename, @revision_identifier, @directory = browser, parent, basename, revision_identifier, directory
+      end
+      
+      # The relative path from the root of the browser instance
+      #
+      # ""
+      # "var"
+      # "var/spool"
+      def path_from_root
+        parent_path_from_root = @parent ? @parent.path_from_root : ""
+        parent_path_from_root == "" ? @basename : "#{parent_path_from_root}/#{@basename}"
+      end
+
+      # The revision of this file or nil if this is a directory
+      def revision_identifier
+        @revision_identifier
+      end
+
+      # Returns a Pathname at the +relative_path+ from this directory.
+      # Note: This only works if this instance is a +directory?+
+      def child(basename, revision_identifier=nil, directory=true)
+        raise "Can't create children for files" unless @directory
+        Pathname.new(@browser, self, basename, revision_identifier, directory)
+      end
+
+      # Stlib Pathname methods
+      
+      # The parent of this instance
+      def parent
+        @parent
+      end
+
+      # The basename of this instance
+      def basename
+        @basename
+      end
+
+      # Returns the full path on the web (to the dir page for directories, history page for files)
+      def cleanpath
+        directory? ? @browser.dir(path_from_root) : @browser.history(path_from_root)
+      end
+
+      def children
+        result = []
+        html = better_open(cleanpath).read
+
+        html.scan(@browser.child_dirs_pattern) do |child_basename_rev_array|
+          child_basename = child_basename_rev_array[0]
+          child_revision_identifier = child_basename_rev_array[1] # nil for most browsers
+#puts "DIR:#{child_basename}:#{child_revision_identifier}"
+          result << child(child_basename, child_revision_identifier, true)
+        end
+
+        html.scan(@browser.child_files_pattern) do |child_basename_rev_array|
+          child_basename = child_basename_rev_array[0]
+          child_revision_identifier = child_basename_rev_array[1]
+#puts "FILE:#{child_basename}:#{child_revision_identifier}"
+          result << child(child_basename, child_revision_identifier, false)
+        end
+        result
+      end
+      
+      def open(&block)
+        url = @browser.raw(path_from_root, revision_identifier)
+        begin
+          better_open(url, &block)
+        rescue Errno::ECONNREFUSED => e
+          # TODO: retry 2-3 times
+          e.message += "(URL:#{url})"
+          raise e
+        end
+      end
+      
+      def directory?
+        @directory
+      end
+      
+    end
+  end
+end

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/tracker.rb

@@ -0,0 +1,6 @@
+require 'meta_project/tracker/base'
+require 'meta_project/tracker/digit_issues'
+require 'meta_project/tracker/issue'
+require 'meta_project/tracker/trac'
+require 'meta_project/tracker/xforge'
+require 'meta_project/tracker/jira'

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/tracker/base.rb

@@ -0,0 +1,24 @@
+module MetaProject
+  module Tracker
+
+    # Tracker objects are responsible for interacting with issue trackers (bug trackers).
+    # They know how to recognise issue identifiers in strings (typically from SCM commit
+    # messages) and turn these into HTML links that point to the associated issue on an
+    # issue tracker installation running somewhere else.
+    class Base
+      def self.classes
+        [
+          Jira::JiraTracker,
+          Trac::TracTracker,
+          XForge::RubyForgeTracker,
+          XForge::SourceForgeTracker,
+        ]
+      end
+
+      def issue(issue_identifier)
+        Issue.new(self, :identifier => issue_identifier)
+      end
+
+    end
+  end
+end

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/tracker/digit_issues.rb

@@ -0,0 +1,34 @@
+module MetaProject
+  module Tracker
+    # 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
+        @issue_pattern ||= /\#([\d]+)/
+      end
+      module_function :issue_pattern
+
+      # Patois command pattern
+      def command_pattern
+        @command_pattern ||= /([A-Za-z]*).?(\#[\d]+(?:(?:[, &]*|\s?and\s?)\#[\d]+)*)/
+      end
+      module_function :command_pattern
+
+      def identifier_examples
+        ["#1926", "#1446"]
+      end
+
+      # TODO: find a way to extract just the issue summaries so they can be stored in dc as an array
+      # embedded in the revision object. that way we don't alter the original commit message
+      def markup(text)
+        text.gsub(issue_pattern) do |match|
+          issue_identifier = $1
+          issue = issue(issue_identifier)
+          link_text = (issue && issue.summary && issue.summary.strip! != "") ? "#{issue_identifier}: #{issue.summary}" : issue_identifier
+          (issue && issue.url) ? "<a href=\"#{issue.url}\">\##{link_text}</a>" : "\##{issue_identifier}"
+        end
+      end
+    end
+  end
+end

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/tracker/issue.rb

@@ -0,0 +1,57 @@
+module MetaProject
+  module Tracker
+    
+    # An issue represents an entry in an issue tracker such as a bug report or
+    # feature request.
+    class Issue
+      attr_reader :attributes
+    
+      def initialize(tracker, attributes={})
+        @tracker = tracker
+        @attributes = attributes
+      end
+      
+      # An URL pointing to the issue in the associated tracker, or nil if
+      # the issue doesn't exist.
+      def url
+        @tracker.materialize(self) unless @attributes[:url]
+        @attributes[:url]
+      end
+
+      # The id of the issue in the tracker
+      def identifier
+        @tracker.materialize(self) unless @attributes[:identifier]
+        @attributes[:identifier]
+      end
+
+      # The summary of the issue (typically a one-liner)
+      def summary
+        @tracker.materialize(self) unless @attributes[:summary]
+        @attributes[:summary]
+      end
+
+      # The details of the issue (typically several lines)
+      def detail
+        @tracker.materialize(self) unless @attributes[:detail]
+        @attributes[:detail]
+      end
+
+      # Adds a comment (consisting of the +detail+) to the issue
+      def update(user_name, password)
+        @tracker.update(self, user_name, password)
+      end
+
+      # Creates a new issue (consisting of the +summary+ and +detail+)
+      def create(user_name, password)
+        raise "Summary not set" unless summary
+        raise "Detail not set" unless detail
+        @tracker.create(self, user_name, password)
+      end
+
+      # Closes the issue (adding a comment consisting of the +detail+)
+      def close(user_name, password)
+        @tracker.close(self, user_name, password)
+      end
+    end
+  end
+end

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/tracker/jira.rb

@@ -0,0 +1,2 @@
+require 'meta_project/tracker/jira/jira_issues'
+require 'meta_project/tracker/jira/jira_tracker'

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/tracker/jira/jira_issues.rb

@@ -0,0 +1,35 @@
+module MetaProject
+  module Tracker
+    module Jira
+      # This module should be included by trackers that follow a digit-based issue scheme
+      module JiraIssues
+
+        # Patois issue pattern
+        def issue_pattern
+          /([A-Za-z]+-[\d]+)/
+        end
+        module_function :issue_pattern
+
+        # Patois command pattern
+        def command_pattern
+          /([A-Za-z]*).?([A-Za-z]+-[\d]+(?:(?:[, &]*|\s?and\s?)[A-Za-z]+-[\d]+)*)/
+        end
+        module_function :command_pattern
+
+        def identifier_examples
+          ["DC-420", "pico-12"]
+        end
+
+        def markup(text)
+          text.gsub(issue_pattern) do |match|
+            issue_identifier = $1.upcase
+            issue = issue(issue_identifier)
+            link_text = (issue.summary && issue.summary.strip! != "") ? "#{issue_identifier}: #{issue.summary}" : issue_identifier
+            issue.url ? "<a href=\"#{issue.url}\">#{link_text}</a>" : issue_identifier
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/openssl/mocha/vendor/meta_project-0.4.15/lib/meta_project/tracker/jira/jira_tracker.rb

@@ -0,0 +1,149 @@
+require 'xmlrpc/client'
+
+module MetaProject
+  module Tracker
+    module Jira
+      
+      # Interface to JIRA. Uses the XML-RPC API defined at:
+      #
+      # http://www.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/com/atlassian/jira/rpc/xmlrpc/XmlRpcService.html
+      # http://confluence.atlassian.com/pages/viewpage.action?pageId=9623
+      # http://confluence.atlassian.com/pages/viewpage.action?pageId=1035
+      class JiraTracker < Base
+        
+        include JiraIssues
+        JIRA_API = "jira1"
+      
+        attr_accessor :jira_base_url, :jira_project_id
+      
+        # Creates a new JiraTracker. In order to successfully get issue info (via XMLRPC),
+        # two env vars must be defined. Example:
+        #
+        #   JiraTracker.new("http://jira.codehaus.org", "DC")
+        #
+        # Then the following must be defined:
+        #
+        #   JIRA_CODEHAUS_ORG_JIRA_USER
+        #   JIRA_CODEHAUS_ORG_JIRA_PASSWORD
+        #   TODO: pass in to ctor instead. do this somewhere else!
+        def initialize(jira_base_url=nil, jira_project_id=nil)
+          @jira_base_url, @jira_project_id = jira_base_url, jira_project_id
+        end
+
+        def overview
+          "#{@jira_base_url}/browse/#{@jira_project_id}"
+        end
+
+        def create(issue)
+          issue_struct = {
+            "project" => @jira_project_id,
+            "summary" => issue.summary,
+            "description" => issue.detail,
+            "type" => 2, # magic number!
+            "priority" => 1
+          }
+          login do |session|
+            issue_struct = session.createIssue(issue_struct)
+            issue.attributes[:identifier] = issue_struct["key"]
+            issue
+          end
+        end
+        
+        def close(issue)
+          begin
+            issue_struct = {
+              "project" => @jira_project_id,
+              "summary" => issue.summary,
+              "description" => issue.detail,
+              "type" => 2, # magic number!
+              "priority" => 1,
+              "status" => 6 # magic number for closed? do we have to look it up?
+            }
+            login do |session|
+              # TODO: Can't close JIRA issue.
+              # The following method:
+              # http://www.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/com/atlassian/jira/rpc/xmlrpc/XmlRpcService.html#updateIssue(java.lang.String,%20java.lang.String,%20java.util.Hashtable)
+              # doesn't seem to exist on the JIRA on Codehaus (older version probably)
+              issue_struct = session.updateIssue(issue.identifier, issue_struct)
+              issue.attributes[:identifier] = issue_struct["key"]
+              issue
+            end
+          rescue XMLRPC::FaultException => e
+            # Probably bad issue number. Don't set URL.
+            STDERR.puts("WARNING: Exception from JIRA while closing issue #{issue.identifier}: #{e.faultCode}, #{e.faultString}")
+          end
+        end
+        
+        def materialize(issue)
+          issue.attributes[:identifier] = issue.attributes[:identifier].upcase
+
+          # Getting summary and detail requires login
+          begin
+            login do |session|
+              issue_struct = session.getIssue(issue.identifier)            
+              issue.attributes[:url] = "#{@jira_base_url}/browse/#{issue.identifier}"
+              issue.attributes[:summary] = issue_struct["summary"] ? issue_struct["summary"].strip : nil
+              issue.attributes[:detail] = issue_struct["description"] ? issue_struct["description"].strip : nil
+            end
+          rescue JiraEnvVarException => e
+            # Couldn't log in because of missing login info. Assume issue exists
+            issue.attributes[:url] = "#{@jira_base_url}/browse/#{issue.identifier}"
+            STDERR.puts("WARNING: #{e.message}")
+          rescue XMLRPC::FaultException => e
+            # Probably bad issue number. Don't set URL.
+            STDERR.puts("WARNING: Exception from JIRA while loading issue details for #{issue.identifier}: #{e.faultCode}, #{e.faultString}")
+          end
+          issue
+        end
+        
+      private
+            
+        def login
+          client = XMLRPC::Client.new2("#{@jira_base_url}/rpc/xmlrpc")
+          token = client.call("#{JIRA_API}.login", user, password)
+          yield Session.new(client, token)
+        end
+        
+        def user
+          var = "#{login_env_var_prefix}_JIRA_USER"
+          ENV[var] || missing_env_var(var)
+        end
+
+        def password
+          var = "#{login_env_var_prefix}_JIRA_PASSWORD"
+          ENV[var] || missing_env_var(var)
+        end
+        
+        def login_env_var_prefix
+          if(jira_base_url =~ /http:\/\/([^\/]+)/)
+            $1.gsub(/\./, "_").upcase
+          else
+            raise "Bad jira_base_url: #{jira_base_url}"
+          end
+        end
+
+        def missing_env_var(var)
+          raise JiraEnvVarException.new("Couldn't log in to JIRA at #{@rooturl}: The " +
+          "#{var} environment variable must be set in order to communicate with JIRA")
+        end
+        
+        class JiraEnvVarException < Exception
+        end
+        
+        # This wrapper around XMLRPC::Client that allows simpler method calls
+        # via method_missing and doesn't require to manage the token
+        class Session
+          def initialize(client, token)
+            @client, @token = client, token
+          end
+
+          def method_missing(sym, *args, &block)
+            token_args = [@token] + args
+            xmlrpc_method = "#{JIRA_API}.#{sym.to_s}"
+            @client.call(xmlrpc_method, *token_args)
+          end
+        end
+      end
+    end
+  end
+end