cerberus 0.3.5 → 0.3.6

data/CHANGES

@@ -1,129 +1,159 @@
-= Cerberus Changelog
-
-== Version 0.3.5
-Bug fixing
-
-* Use smpt_settings config option instead of server_settings for ActionMailer
-* Fixed problem with incorrect state for output messages [cerberus bug #8682]
-
-== Version 0.3.4
-Added Cerberus hooks that allow running custom tasks on build finish
-
-* Fixed bug with Cerberus::Util spotted by Mohamemd Alvi
-
-* Added possibility to add hooks on Cerberus executions. Configuration file format for it is
-
-hook:
-  HOOK_NAME:
-    on_event: successful, setup #by default - run hook for any state
-    action: 'export CERBERUS_HOME=/home/anatol && sudo chown www-data -R /home/anatol/cerberus && rcov' #Add here any hook you want
-
-== Version 0.3.3
-Major changes
-
-* Fix Const load problem with Rails 1.2RC1
-* Correctly implement Jabber publisher using XMPP4R library
-* Upgrade Webgen to 0.4.1
-* Added 'getting better/worse' to build messages' subject
-* Added possibility to configure events on what you would like to receive messages. 
-  By default used 'default' events. It means all except 'successful' state.
-  You could set to this options list of any valid states such as [broken, failed, revival, successful, setup] or predefined sets as
-  [all, default, none].
-
-  You could configure by setting :on_event option to :publisher options branch, or to concrete publisher configuration.
-  In case if this option added both to :publisher and :publisher,<PUBLISHER> then concrete configurations wins.
-
-  Examples of configuration
-
-publisher:
-  on_event: broken, revival
-  mail:
-    on_event: all
-  jabber:
-    #nothing here
-
-  In given example we would send messages about ALL events by mail and only messages about brokeness and revivalness by Jabber.
-
-== Version 0.3.2
-Added Perforce SCM support
-
-* Added support of Perforce
-
-== Version 0.3.1
-Added BJam builder support
-
-* Use lazy loading of cerberus components (publishers, vcs, builder)
-* Show Cerberus home in Help
-* Added 'list' command that shows names of all *active* projects
-* Added BJam building tool http://www.boost.org/tools/build/v2/index.html
-
-== Version 0.3.0
-Fix release
-
-* Added support of Campfire publisher
-* Added changeset_url option that adds quick link to browsable chanelist view
-* Added possibility to specify user_name and password for Subversion commands
-* Added support of Darcs VCS
-
-== Version 0.2.4
-Features release
-
-* Fix problem with TLS hack. Now possible to send to SSL and vanilla mailservers without modifying code.
-* Added rant support (http://make.rubyforge.org) [Xavier Shay]
-* Fixed escaping of code in RSS publisher [Xavier Shay]
-* If we have only builder or publisher in configuration then use it. Param :type made mandatory.
-
-== Version 0.2.3
-Features release
-
-* Added Lock files that prevent from mutiply build of the same project by several different processes
-* Added multythread build for 'buildall' command. Now if one of threads froses (for example because of SVN repo is broken) then other threads would continue execution.
-* Added possibility to send to gmail host using GMailer library
-* Added --force oprion that would be helpful if you want to rebuild project even if there are no changes in VSC.
-  Use 'cerberus build --force my_project'
-* Added site for Cerberus project. http://cerberus.rubyforge.org/
-* From now all builds logs their build data. It would be switched off by :log/:enable => false in configuration file
-
-== Version 0.2.2
-Minor fix release
-
-* Make rake executable recongnition process less verbose
-* Refactored builder mecahnism in Cerberus. Now adding new Builder possible in much more easiest way
-* Added Maven2 builder
-* Add possibility to specify Builder type on application creation by BUILDER=xxx option
-* Process correctly folders locked by SVN
-
-== Version 0.2.1
-Minor fix release
-
-* publisher -> active flag now not mandatory. Use 'mail' publisher as active if not set any
-
-== Version 0.2.0
-Config file was changed since 0.1.1 and you need regenerate config files.
-Or change it by hands: see doc/OPTIONS file to list of all avalable options.
-
-Changing required by advanced publishing mechanism. Now it is possible to add several published to one project.
-
-Also added 3 new publishers.
-  Jabber Publisher - all notification sended via Jabber server
-  IRC publisher - messages sent to IRC channel
-  RSS Publisher - result of build Cerberus writes to file in RSS format.
-    This feature would be useful for big open project when many users would like to see results of test-run.
-    If you publish results as RSS - then any user could subscribe to channel.
-
-
-* Added automatic subversion cleanup to avoid repository locking after Cedrberus process termination
-* Added Jabber publisher
-* Added IRC publisher
-* Added RSS publisher
-
-== Version 0.1.1
-Minor improvements
-
-* Added 'buildall' command that build all projects added to Cerberus repository.
-* Fixed tests on *nix
-
-== Version 0.1.0
-Initial version of Cerberus tool
-
-* Implemented basic functionality required by Continuous Integration.
+= Cerberus Changelog
+
+== Version 0.3.6
+RSpec, Gmailer support
+
+* Added out of box support of RSpec tests. 
+  Usage: add to your project configuration following config
+
+  builder:
+    rspec:
+      task: test
+
+* Config files now preprocessed by ERB, so it is possible to use dynamic configuration like below
+  publisher:
+    mail:
+      username: <%= ENV['MY_MAIL_ACCOUNT'] %>
+      password: <%= IO.read('~/.secret_password') %>
+
+* Added support of sending mails using gmailer (http://rubyforge.org/projects/gmailutils) instead of plain mailer sender.
+  It would be helpful if you are in corporate environment with proxy and only 80 port is open for communication.
+  Usage is standart
+
+  publisher:
+    gmailer:
+      recipients: hello@world.com
+
+  Configuration options for gmailer are:
+    :username, :password, :proxy_host, :proxy_port, :proxy_user, :proxy_pass
+
+* Remove to_xs helper. Using one from actionsuport
+      
+
+== Version 0.3.5
+Bug fixing
+
+* Use smpt_settings config option instead of server_settings for ActionMailer
+* Fixed problem with incorrect state for output messages [cerberus bug #8682]
+
+== Version 0.3.4
+Added Cerberus hooks that allow running custom tasks on build finish
+
+* Fixed bug with Cerberus::Util spotted by Mohamemd Alvi
+
+* Added possibility to add hooks on Cerberus executions. Configuration file format for it is
+
+hook:
+  HOOK_NAME:
+    on_event: successful, setup #by default - run hook for any state
+    action: 'export CERBERUS_HOME=/home/anatol && sudo chown www-data -R /home/anatol/cerberus && rcov' #Add here any hook you want
+
+== Version 0.3.3
+Major changes
+
+* Fix Const load problem with Rails 1.2RC1
+* Correctly implement Jabber publisher using XMPP4R library
+* Upgrade Webgen to 0.4.1
+* Added 'getting better/worse' to build messages' subject
+* Added possibility to configure events on what you would like to receive messages. 
+  By default used 'default' events. It means all except 'successful' state.
+  You could set to this options list of any valid states such as [broken, failed, revival, successful, setup] or predefined sets as
+  [all, default, none].
+
+  You could configure by setting :on_event option to :publisher options branch, or to concrete publisher configuration.
+  In case if this option added both to :publisher and :publisher,<PUBLISHER> then concrete configurations wins.
+
+  Examples of configuration
+
+publisher:
+  on_event: broken, revival
+  mail:
+    on_event: all
+  jabber:
+    #nothing here
+
+  In given example we would send messages about ALL events by mail and only messages about brokeness and revivalness by Jabber.
+
+== Version 0.3.2
+Added Perforce SCM support
+
+* Added support of Perforce
+
+== Version 0.3.1
+Added BJam builder support
+
+* Use lazy loading of cerberus components (publishers, vcs, builder)
+* Show Cerberus home in Help
+* Added 'list' command that shows names of all *active* projects
+* Added BJam building tool http://www.boost.org/tools/build/v2/index.html
+
+== Version 0.3.0
+Fix release
+
+* Added support of Campfire publisher
+* Added changeset_url option that adds quick link to browsable chanelist view
+* Added possibility to specify user_name and password for Subversion commands
+* Added support of Darcs VCS
+
+== Version 0.2.4
+Features release
+
+* Fix problem with TLS hack. Now possible to send to SSL and vanilla mailservers without modifying code.
+* Added rant support (http://make.rubyforge.org) [Xavier Shay]
+* Fixed escaping of code in RSS publisher [Xavier Shay]
+* If we have only builder or publisher in configuration then use it. Param :type made mandatory.
+
+== Version 0.2.3
+Features release
+
+* Added Lock files that prevent from mutiply build of the same project by several different processes
+* Added multythread build for 'buildall' command. Now if one of threads froses (for example because of SVN repo is broken) then other threads would continue execution.
+* Added possibility to send to gmail host using GMailer library
+* Added --force oprion that would be helpful if you want to rebuild project even if there are no changes in VSC.
+  Use 'cerberus build --force my_project'
+* Added site for Cerberus project. http://cerberus.rubyforge.org/
+* From now all builds logs their build data. It would be switched off by :log/:enable => false in configuration file
+
+== Version 0.2.2
+Minor fix release
+
+* Make rake executable recongnition process less verbose
+* Refactored builder mecahnism in Cerberus. Now adding new Builder possible in much more easiest way
+* Added Maven2 builder
+* Add possibility to specify Builder type on application creation by BUILDER=xxx option
+* Process correctly folders locked by SVN
+
+== Version 0.2.1
+Minor fix release
+
+* publisher -> active flag now not mandatory. Use 'mail' publisher as active if not set any
+
+== Version 0.2.0
+Config file was changed since 0.1.1 and you need regenerate config files.
+Or change it by hands: see doc/OPTIONS file to list of all avalable options.
+
+Changing required by advanced publishing mechanism. Now it is possible to add several published to one project.
+
+Also added 3 new publishers.
+  Jabber Publisher - all notification sended via Jabber server
+  IRC publisher - messages sent to IRC channel
+  RSS Publisher - result of build Cerberus writes to file in RSS format.
+    This feature would be useful for big open project when many users would like to see results of test-run.
+    If you publish results as RSS - then any user could subscribe to channel.
+
+
+* Added automatic subversion cleanup to avoid repository locking after Cedrberus process termination
+* Added Jabber publisher
+* Added IRC publisher
+* Added RSS publisher
+
+== Version 0.1.1
+Minor improvements
+
+* Added 'buildall' command that build all projects added to Cerberus repository.
+* Fixed tests on *nix
+
+== Version 0.1.0
+Initial version of Cerberus tool
+
+* Implemented basic functionality required by Continuous Integration.

data/LICENSE

@@ -1,21 +1,21 @@
-Copyright (c) 2006 Anatol Pomozov
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
+Copyright (c) 2006 Anatol Pomozov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README

@@ -1,75 +1,75 @@
-Cerberus is a Continuous Builder software. Cerberus could be periodically run from scheduler and check if application tests are broken. If it happens then Cerberus will send notification to developers. Cerberus perfectly works both on Windows and *nix platforms.
-
-For more CI theory read this document from Martin Fowler 
-http://www.martinfowler.com/articles/continuousIntegration.html.
-
-Requirements: 
-  ruby - 1.8.2 or higher
-  rake - 0.7 or higher
-  svn client - 1.2 or higher
-
-What 'Cerberus' name means?
-Quote from Wikipedia (http://en.wikipedia.org/wiki/Cerberus)
-
-Cerberus or Kerberos (Kerberos, demon of the pit), was the hound of Hades-a monstrous three-headed dog (sometimes said to have 50 or 100 heads) with a snake for a tail and innumerable snake heads on his back.
-He guarded the gate to Hades (the Greek underworld) and ensured that the dead could not leave and the living could not enter. His brother was Orthrus. He is the offspring of Echidna and Typhon.
-
-
-So Cerberus will guard your tests and not allow your project to go to the world of dead. 
-
-There are several CI solutions already present, why do you need to use Cerberus?
-Main advantages of Cerberus over other solutions are:
- 1) Cerberus could be installed on any machine not only where SVN repository located.
- 2) Cerberus works not only for Rails projects, but for any other Ruby projects as well as for other platforms (Maven2 for Java)
- 3) Cerberus multiplatform solution: it runs excellent both on *nix and Windows.
- 4) Cerberus distributed via RubyGems, so it is very easy to install and very easy to update to the latest stable version
- 5) Cerberus very easy to start using. Just type 'cerberus add PROJECT_URL|PROJECT_DIR'
- 6) Cerberus is lightweight solution: most of the time ruby process even not runs - Rake runs only in case if changes in project sources are found.
-
- 
-To use Cerberus it is very easy. First install it. Easiest way to do it through RubyGems package manager.
-
-'gem install cerberus'
-
-or get Cerberus distribution package right from download page http://rubyforge.org/frs/?group_id=1794&release_id=6442
-
-then you need to add project that will be watched by Cerberus. Do it by
-
-cerberus add (DIR|SVN_URL) APPLICATION_NAME=some_app RECIPIENTS=dev1@project.com,dev2@project.com
-
-as second parameter you could pass URL to subversion repository or directory with working SVN folder.
-
-Go to ~/.cerberus and edit config.yml file (only once after installing Cerberus). Enter your configuration options here like email server, password, user_name and other options. See ActiveMailer description - Cerberus uses it as notification layer. My config file looks like this
-
-publisher:
-  mail:
-    address: mail.somesever.com
-    user_name: anatol
-    password: anatol
-    domain: somesever.com
-    authentication: login
-
-Also check ~/.cerberus/config/<APPLICATION_NAME>.yml and make sure that you have right options.
-
-And then run Cerberus 
-
-cerberus build APPLICATION_NAME    #Run project
-
-or
-
-cerberus buildall     #Run all available projects
-
-
-It will check out latest sources and run tests for your application. If tests are broken - recipients will receive notifications.
-
-But of course better run Cerberus automatically from Cron. Run Cerberus for project each 10 minutes would be ok.
-
-== License
-
-This plugin is licensed under the MIT license. Complete license text
-is included in the LICENSE file.
-
-== Author
-
-This software was created by Anatol Pomozov <anatol.pomozov@gmail.com> and is
-located at http://cerberus.rubyforge.org.
+Cerberus is a Continuous Builder software. Cerberus could be periodically run from scheduler and check if application tests are broken. If it happens then Cerberus will send notification to developers. Cerberus perfectly works both on Windows and *nix platforms.
+
+For more CI theory read this document from Martin Fowler 
+http://www.martinfowler.com/articles/continuousIntegration.html.
+
+Requirements: 
+  ruby - 1.8.2 or higher
+  rake - 0.7 or higher
+  svn client - 1.2 or higher
+
+What 'Cerberus' name means?
+Quote from Wikipedia (http://en.wikipedia.org/wiki/Cerberus)
+
+Cerberus or Kerberos (Kerberos, demon of the pit), was the hound of Hades-a monstrous three-headed dog (sometimes said to have 50 or 100 heads) with a snake for a tail and innumerable snake heads on his back.
+He guarded the gate to Hades (the Greek underworld) and ensured that the dead could not leave and the living could not enter. His brother was Orthrus. He is the offspring of Echidna and Typhon.
+
+
+So Cerberus will guard your tests and not allow your project to go to the world of dead. 
+
+There are several CI solutions already present, why do you need to use Cerberus?
+Main advantages of Cerberus over other solutions are:
+ 1) Cerberus could be installed on any machine not only where SVN repository located.
+ 2) Cerberus works not only for Rails projects, but for any other Ruby projects as well as for other platforms (Maven2 for Java)
+ 3) Cerberus multiplatform solution: it runs excellent both on *nix and Windows.
+ 4) Cerberus distributed via RubyGems, so it is very easy to install and very easy to update to the latest stable version
+ 5) Cerberus very easy to start using. Just type 'cerberus add PROJECT_URL|PROJECT_DIR'
+ 6) Cerberus is lightweight solution: most of the time ruby process even not runs - Rake runs only in case if changes in project sources are found.
+
+ 
+To use Cerberus it is very easy. First install it. Easiest way to do it through RubyGems package manager.
+
+'gem install cerberus'
+
+or get Cerberus distribution package right from download page http://rubyforge.org/frs/?group_id=1794&release_id=6442
+
+then you need to add project that will be watched by Cerberus. Do it by
+
+cerberus add (DIR|SVN_URL) APPLICATION_NAME=some_app RECIPIENTS=dev1@project.com,dev2@project.com
+
+as second parameter you could pass URL to subversion repository or directory with working SVN folder.
+
+Go to ~/.cerberus and edit config.yml file (only once after installing Cerberus). Enter your configuration options here like email server, password, user_name and other options. See ActiveMailer description - Cerberus uses it as notification layer. My config file looks like this
+
+publisher:
+  mail:
+    address: mail.somesever.com
+    user_name: anatol
+    password: anatol
+    domain: somesever.com
+    authentication: login
+
+Also check ~/.cerberus/config/<APPLICATION_NAME>.yml and make sure that you have right options.
+
+And then run Cerberus 
+
+cerberus build APPLICATION_NAME    #Run project
+
+or
+
+cerberus buildall     #Run all available projects
+
+
+It will check out latest sources and run tests for your application. If tests are broken - recipients will receive notifications.
+
+But of course better run Cerberus automatically from Cron. Run Cerberus for project each 10 minutes would be ok.
+
+== License
+
+This plugin is licensed under the MIT license. Complete license text
+is included in the LICENSE file.
+
+== Author
+
+This software was created by Anatol Pomozov <anatol.pomozov@gmail.com> and is
+located at http://cerberus.rubyforge.org.