damagecontrol 0.5.0 → 0.5.0.1391

data/README

@@ -2,13 +2,39 @@
 
 = Feature overview
 
-* Supports all SCMs supported by RSCM.
+* Builds projects of any kind:
+  * Java
+  * .NET
+  * Ruby
+  * C/C++
+  * (This is getting boring, you can build projects in any language)
+* Supports any kind of build tools:
+  * Ant
+  * Nant
+  * Make
+  * Rake
+  * Maven
+  * Bash/Sh/Bat scripts
+  * (You get the picture)
+* Several notification channels
+  * Email
+  * IRC
+  * RSS
+  * Growl
+* Supports all SCMs supported by RSCM:
+  * CVS
+  * Subversion
+  * Perforce
+  * Monotone
+  * ClearCase
+  * (See http://rscm.codehaus.org for details)
+* Trend graphs and statistics (soming soon)
 * Web interface based on RoR (http://www.rubyonrails.org/)
+* No funny config files, all web based configuration (you can use config files if you wish)
 * Colourised HTML diffs.
-* RSS feeds for changesets and builds.
-* Generation of URL links to diffs for several popular SCM web front-ends.
-* Generation of URL links to bugs/issues for several popular bug/issue trackers.
-* Uses UTC times according to the SCM server's clock, not the machine running RSCM. No NTP needed!
+* Integration with several SCM web front-ends.
+* Integration with several issue trackers.
+* Uses UTC times according to the SCM server's clock, not the machine running RSCM. No NTP needed!
 
 == DamageControl Server
 
@@ -59,17 +85,47 @@ Planned:
 
 * RT - http://fsck.com/projects/rt/
 
-== SCM web front-ends - diffs
+== SCM web front-ends
 
-DamageControl's web interface features colourised diffs for all changes in a changeset.
-It can also generate links to individual diff pages in other SCM web frontends:
+DamageControl's web interface features colourised diffs for all changes in a changeset (for any supported SCM).
+It can also generate links to individual diff pages in other SCM web frontends, provided it's compatible with
+the given project's SCM:
 
-* RSCM Built-in HTML diffs.
 * Fisheye - http://www.cenqua.com/fisheye/
 * ViewCVS - http://viewcvs.sourceforge.net/
+* Trac - http://www.edgewall.com/trac/
 
 Planned:
 
-* Trac - http://www.edgewall.com/trac/
-* Chora - http://horde.org/chora/
+* Chora - http://horde.org/chora/
+
+= Extending DamageControl
+
+== SourceControl
+
+See http://rscm.rubyforge.org for instructions about how to add support for new SCMs
+
+== Build Publishers
+
+If you have an idea for a new publisher it's very easy to hook in. Just drop your class into the lib/publisher directory. Your publisher class
+must implement the following methods:
+
+  # This method will be called when a build is complete.
+  def publish(build)
+    ...
+  end
+
+  # This is the display name of the publisher
+  def name
+    ...
+  end
 
+You must also make sure your publisher class registers with the Project class. Put this in the class body:
+
+  Project.available_publisher_classes << self
+
+If your publisher requires some sort of configuration, just make an attr_accessor for each configuration option. DamageControl will automatically
+pick up your publisher, render it under the Publishers tab on the project configuration page.
+
+If you want to share your publisher with the rest of the world, just upload it to DamageControl's JIRA. If you include a unit test for it,
+we'll be extra happy.

data/Rakefile

@@ -16,11 +16,16 @@ task :default => [ :all ]
 
 # Run the unit tests
 # To run a specific test: rake test TEST=path/to/test
-fl = FileList.new('test/**/*_test.rb')
+fl = FileList.new('test/**/*_test.rb')
+# Work around annoying LoadError - run this test alone
+fl.exclude('test/**/email_test.rb')
+fl.exclude('test/functional/*')
 # TODO: figure out how to add all the stuff in app.
 Rake::TestTask.new { |t|
-  # We need some of the test utils from rscm
-  t.libs << "test" << File.expand_path(File.dirname(__FILE__) + "/../rscm/test") << File.expand_path(File.dirname(__FILE__) + "/../rscm/lib")
+  t.libs << "test" 
+  # We need some of the test utils from rscm. add them in 2 ways so they can be found when built by dc too.
+  t.libs << File.expand_path(File.dirname(__FILE__) + "/../rscm/test") << File.expand_path(File.dirname(__FILE__) + "/../rscm/lib")
+  t.libs << File.expand_path(File.dirname(__FILE__) + "/../../RSCM/checkout/test") << File.expand_path(File.dirname(__FILE__) + "/../../RSCM/checkout/lib")
   t.test_files = fl
   t.verbose = true
 }
@@ -65,9 +70,13 @@ else
 
     #### Dependencies and requirements.
 
-    s.add_dependency('log4r', '> 1.0.4')
-    s.add_dependency('rscm')
-    s.add_dependency('needle')
+    s.add_dependency('rscm', '0.2.0')
+    s.add_dependency('rails', '0.10.0')
+    s.add_dependency('log4r', '1.0.5')
+    s.add_dependency('needle', '1.2.0')
+    s.add_dependency('jabber4r', '0.7.0')
+    s.add_dependency('rake', '0.4.5')
+    s.add_dependency('ruby-growl', '1.0.0')
 #    s.add_dependency('rgl')
     #s.requirements << ""
 

data/app/controllers/admin_controller.rb

@@ -1,6 +1,3 @@
-#require 'rscm'
-#require 'rscm/tracker'
-
 class AdminController < ApplicationController
 
   def new_project

data/app/controllers/application.rb

@@ -1,163 +1,42 @@
-# The filters added to this controller will be run for all controllers in the application.
-# Likewise will all the methods added be available for all controllers.
-
-require 'rubygems'
-require_gem 'rscm'
-require 'damagecontrol/project'
-require 'damagecontrol/build'
-require 'damagecontrol/tracker'
-require 'damagecontrol/scm_web'
-
-# Start Drb - this is how we communicate with the daemon.
-DRb.start_service()
-Rscm = DRbObject.new(nil, 'druby://localhost:9000')
-
-class ApplicationController < ActionController::Base
-
-  layout 'rscm'
-
-  def initialize
-    @sidebar_links = [
-      {
-        :controller => "project", 
-        :action     => "new", 
-        :image      => "/images/24x24/box_new.png",
-        :name       => "New project"
-      }
-    ]
-    @controller = self
-  end
-
-  # Loads the project specified by the +id+ parameter and places it into the @project variable  
-  def load_project
-    project_name = @params["id"]
-    @project = DamageControl::Project.load(project_name)
-  end
-
-  def breadcrumbs
-    subpaths = @request.path.split(/\//)
-#    subpaths.collect { |p| link_to_unless_current(p) }.links.join(" ")
-  end
-  
-protected
-
-  # Sets the links to display in the sidebar. Override this method in other controllers
-  # To change what to display.
-  def set_sidebar_links
-
-  end
-  
-end
-
-module ActionView
-  module Helpers
-    module UrlHelper
-      # Modify the original behaviour of +link_to+ so that the link
-      # includes the client's timezone as URL param +timezone+ in the request.
-      # Can be used by server to adjust formatting of UTC dates so they match the client's time zone.
-      def convert_confirm_option_to_javascript!(html_options)
-        # We're adding this JS call to add the timezone info as a URL param.
-        html_options["onclick"] = "intercept(this);"
-        if html_options.include?(:confirm)
-          html_options["onclick"] += "return confirm('#{html_options[:confirm]}');"
-          html_options.delete(:confirm)
-        end
-      end
-    end
-  end
-  
-  class Base
-    def text_or_input(input, options)
-      if(input)
-        options[:class] = "setting-input" unless options[:class]
-        tag("input", options)
-      elsif(options[:value] =~ /^http?:\/\//)
-        content_tag("a", options[:value], "href" => options[:value])
-      else
-        options[:value]
-      end
-    end
-    
-    def text_or_select(input, options)
-      values = options.delete(:values)
-      if(input)
-        options[:class] = "setting-input" unless options[:class]
-        
-        option_tags = ""
-        values.each do |value|
-          option_attrs = {:value => value.class.name}
-          option_attrs[:selected] = "true" if value.selected?
-          option_tag = content_tag("option", value.name, option_attrs)
-          option_tags << option_tag
-        end
-        content_tag("select", option_tags, options)
-      else
-        values.find {|v| v.selected?}.name
-      end
-    end
-    
-    # Creates an image with a tooltip that will show on mouseover.
-    #
-    # Options:
-    # * <tt>:txt</tt> - The text to put in the tooltip. Can be HTML.
-    # * <tt>:img</tt> - The image to display on the page. Defaults to '/images/16x16/about.png'
-    def tip(options)
-      tip = options.delete(:txt)
-      options[:src] = options.delete(:img) || "/images/16x16/about.png"
-      options[:onmouseover] = "Tooltip.show(event,#{tip})"
-      options[:onmouseout] = "Tooltip.hide()"
-
-      tag("img", options)
-    end
-  end
-end
-
-module DamageControl
-
-  # Add some generic web capabilities to the RSCM classes
-  module Web
-    module Configuration
-
-      def selected?
-        false
-      end
-
-      # Returns the short lowercase name. Used for javascript and render_partial.
-      def short
-        $1.downcase if self.class.name =~ /.*::(.*)/
-      end
-
-    end
-  end
-end
-
-class RSCM::AbstractSCM
-  include DamageControl::Web::Configuration
-end
-
-class DamageControl::Tracker::Base
-  include DamageControl::Web::Configuration
-end
-
-class DamageControl::Project
-  include DamageControl::Web::Configuration
-end
-
-class DamageControl::Build
-  def small_image
-    exit_code == 0 ? "/images/green-16.gif" : "/images/red-16.gif"
-  end
-end
-
-class RSCM::Change
-  ICONS = {
-    MODIFIED => "/images/16x16/document_edit.png",
-    DELETED => "/images/16x16/document_delete.png",
-    ADDED => "/images/16x16/document_add.png",
-    MOVED => "/images/16x16/document_exchange.png",
-  }
-    
-  def icon
-    ICONS[@status] || "/images/16x16/document_warning.png"
-  end
-end
+# The filters added to this controller will be run for all controllers in the application.
+# Likewise will all the methods added be available for all controllers.
+
+require 'damagecontrol/project'
+require 'damagecontrol/build'
+require 'damagecontrol/tracker'
+require 'damagecontrol/scm_web'
+require 'damagecontrol/publisher/base'
+require 'rscm_ext'
+require 'rails_ext'
+
+class ApplicationController < ActionController::Base
+
+  layout 'default'
+
+  def initialize
+    @sidebar_links = [
+      {
+        :controller => "project", 
+        :action     => "new", 
+        :image      => "/images/24x24/box_new.png",
+        :name       => "New project"
+      }
+    ]
+    @controller = self
+  end
+
+  # Loads the project specified by the +id+ parameter and places it into the @project variable  
+  def load_project
+    project_name = @params["id"]
+    @project = DamageControl::Project.load(project_name)
+  end
+
+protected
+
+  # Sets the links to display in the sidebar. Override this method in other controllers
+  # To change what to display.
+  def set_sidebar_links
+
+  end
+  
+end

data/app/controllers/build_controller.rb

@@ -0,0 +1,33 @@
+class BuildController < ApplicationController
+
+  def status
+  end
+
+  def stdout
+    load_build
+    send_log(@build.stdout)
+  end
+
+  def stderr
+    load_build
+    send_log(@build.stderr)
+  end
+
+  def tests
+  end
+
+private
+
+  def send_log(file)
+    # see application.rb for :no_disposition
+    send_file(file, :stream => true, :type => "text/plain", :no_disposition => true)
+  end
+
+  def load_build
+    load_project
+    changeset_identifier = @params["changeset"].to_identifier
+    build_time = @params["build"].to_identifier
+    @build = @project.build(changeset_identifier, build_time)
+  end
+
+end

data/app/controllers/files_controller.rb

@@ -1,4 +1,4 @@
-require 'rscm/directories'
+require 'damagecontrol/directories'
 
 class FilesController < ApplicationController
 

data/app/controllers/project_controller.rb

@@ -3,58 +3,38 @@ require 'damagecontrol/project'
 require 'damagecontrol/directories'
 require 'damagecontrol/diff_parser'
 require 'damagecontrol/diff_htmlizer'
+require 'damagecontrol/publisher/base'
 
 class ProjectController < ApplicationController
 
   # TODO: check if the various SCMs are installed and disable them with a warning if not.
   # Each SCM class should have an available? method
 
-  SCMS = [
-# Uncomment this to see Mooky in action in the web interface!
-#    RSCM::Mooky,
-    RSCM::CVS, 
-    RSCM::SVN, 
-    RSCM::StarTeam
-  ]
-
-  TRACKERS = [
-    DamageControl::Tracker::Null, 
-    DamageControl::Tracker::Bugzilla, 
-    DamageControl::Tracker::JIRA,
-    DamageControl::Tracker::RubyForge,
-    DamageControl::Tracker::SourceForge,
-    DamageControl::Tracker::Scarab,
-    DamageControl::Tracker::Trac
-  ]
-
-  SCM_WEBS = [
-#    SCMWeb::Null.new, 
-#    SCMWeb::ViewCVS.new, 
-#    SCMWeb::Fisheye.new
-  ]
-
   def initialize
     super
     @navigation_name = "changesets_list"
   end
 
   def index
-    @projects = DamageControl::Project.find_all
+    @projects = ::DamageControl::Project.find_all
     @navigation_name = "null"
   end
 
   def new
     @project = DamageControl::Project.new
-    @scms = SCMS.collect {|o| o.new}
+
+    @scms = RSCM::AbstractSCM.classes.collect {|cls| cls.new}
     first_scm = @scms[0]
     def first_scm.selected?
       true
     end
-    @trackers = TRACKERS.collect {|o| o.new}
+    
+    @trackers = DamageControl::Tracker::Base.classes.collect {|cls| cls.new}
     first_tracker = @trackers[0]
     def first_tracker.selected?
       true
     end
+
     @edit = true
     @new_project = true
     render_action("view")
@@ -88,25 +68,21 @@ class ProjectController < ApplicationController
   end
 
   def save
-    project         = instantiate_from_params("project")
-    project.scm     = instantiate_from_params("scm")
-    project.tracker = instantiate_from_params("tracker")
-    
-    begin
-      Rscm.save_project(project)
-    rescue => e
-      $stderr.puts(e.backtrace.join("\n"))
-      return render_text("Couldn't connect to RSCM server. Please make sure it's running.<br>" + e.message)
-    end
+    project = instantiate_from_hash(DamageControl::Project, @params[DamageControl::Project.name])
+    project.scm = find_selected("scms")
+    project.tracker = find_selected("trackers")
+    project.publishers = instantiate_array_from_hashes(@params["publishers"])
+
+    project.save
 
     redirect_to(:action => "view", :id => project.name)
   end
   
-  def changesets
+  def changeset
     load
-    last_changeset_identifier = @params["changeset"]
-    @changesets = @project.changesets(last_changeset_identifier.to_identifier, 1)    
-    @changesets.accept(HtmlDiffVisitor.new(@project))
+    changeset_identifier = @params["changeset"]
+    @changeset = @project.changeset(changeset_identifier.to_identifier)
+    @changeset.accept(HtmlDiffVisitor.new(@project))
   end
   
 protected
@@ -117,9 +93,6 @@ protected
       @project = project
     end
     
-    def visit_changesets(changesets)
-    end
-
     def visit_changeset(changeset)
       @changeset = changeset
     end
@@ -173,7 +146,7 @@ protected
 #      }
 #    end
 
-    if(@project.exists? && @project.scm && !@project.scm.exists? && @project.scm.can_create?)
+    if(@project.exists? && @project.scm && @project.scm.can_create? && !@project.scm.exists?)
       @sidebar_links << {
         :controller => "scm", 
         :action     => "create", 
@@ -213,7 +186,7 @@ protected
       }
     end
 
-    if(@project.exists?)
+    if(@project.exists? && @project.tracker)
       @sidebar_links << {
         :href       => @project.tracker.url, 
         :image      => "/images/24x24/scroll_information.png",
@@ -250,17 +223,15 @@ private
     def scm.selected?
       true
     end
+    # Make a dupe of the scm/tracker lists and substitute with project's value
+    @scms = RSCM::AbstractSCM.classes.collect {|cls| $stderr.puts "CLASS: #{cls.name}" ;cls.new}
+    @scms.each_index {|i| @scms[i] = @project.scm if @scms[i].class == @project.scm.class}
 
     tracker = @project.tracker
     def tracker.selected?
       true
     end
-
-    # Make a dupe of the scm/tracker lists and substitute with project's value
-    @scms = SCMS.collect {|o| o.new}
-    @scms.each_index {|i| @scms[i] = @project.scm if @scms[i].class == @project.scm.class}
-
-    @trackers = TRACKERS.collect {|o| o.new}
+    @trackers = DamageControl::Tracker::Base.classes.collect {|cls| cls.new}
     @trackers.each_index {|i| @trackers[i] = @project.tracker if @trackers[i].class == @project.tracker.class}
 
     @linkable_changesets = @project.changesets(@project.latest_changeset_identifier, 10)
@@ -268,17 +239,4 @@ private
 
     set_sidebar_links
   end
-
-  # Instantiates an object from parameters
-  def instantiate_from_params(param)
-    class_name = @params[param]
-    clazz = eval(class_name)
-    ob = clazz.new
-    attribs = @params[class_name] || {}
-    attribs.each do |k,v|
-      ob.send("#{k}=", v)
-    end
-    ob
-  end
-
 end