fgrehm-autotestforphp 0.0.1 → 0.0.2

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Fábio Rehm
+Copyright (c) 2009 Fábio Galvão Rehm
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest.txt

@@ -20,7 +20,6 @@ script/destroy
 script/generate
 test/autotestforphp/test_autotestforphp.rb
 test/cli/test_autotestforphp_cli.rb
-test/cli/test_install_cli.rb
 test/test_helper.rb
 test/test_linux.rb
 test/test_mac.rb

data/README.rdoc

@@ -8,9 +8,13 @@
 AutotestForPHP is based off of ZenTest autotest which is a popular Ruby tool for running tests as soon as files get changed:
 * http://www.zenspider.com/ZSS/Products/ZenTest/
 
-The code for displaying notifications is based on Carlos Brando autotest-notification gem:
+Code for displaying notifications is based on Carlos Brando autotest-notification gem:
 * http://github.com/carlosbrando/autotest-notification
 
+The tool was written on Ruby but you don't need to be a Ruby programmer in order to use it, just make sure you have Ruby and RubyGems installed:
+* http://www.ruby-lang.org/
+* http://rubygems.org/read/chapter/3
+
 
 == SYNOPSYS
 
@@ -21,54 +25,59 @@ The code for displaying notifications is based on Carlos Brando autotest-notific
 
 == REQUIREMENTS:
 
-* Ruby
-* RubyGems
 * PHP5
 * PHPUnit
+* Ruby
+* RubyGems
+
+* Linux: *(TESTED ON KDE ONLY)*
+    You need to have libnotify binaries installed.
+
+    For ubuntu this means: sudo apt-get install libnotify-bin
+
+    Other distributions may package it with other names, do a search for libnotify using your distribution package
+    manager.
+
+    If you use KDE and do not have libnotify-bin installed, it will try to use kdialog which is part of KDE.
+    It also works if you have zenity installed.
 
 * Mac: *(NOT TESTED)*
     You need to have Growl and growlnotify installed on your machine.
 
-    Download the Growl [http://growl.info/index.php] and install it like any other application on your Mac
+    Download Growl[http://growl.info/index.php] and install it like any other application on your Mac.
 
     Then you must install the growlnotify.
 
     In your shell, cd to the directory on the Growl disk image containing growlnotify, and type ./install.sh.
     That script will install growlnotify to /usr/local/bin and the manpage to /usr/local/man.
 
-* Windows: *(NOT TESTED)*
+* Windows: *(TESTED ON VISTA ONLY)*
     You need to have Snarl and ruby-snarl installed on your machine.
 
-    Download Snarl [http://www.fullphat.net/] and install it like any other application on your machine.
+    Download Snarl[http://www.fullphat.net/] and install it like any other application on your machine.
 
     Run in the command prompt:
 
       $ gem install ruby-snarl
 
-* Linux: *(TESTED ON KDE ONLY)*
-    You need to have libnotify binaries installed.
 
-    For ubuntu this means: sudo apt-get install libnotify-bin
+== INSTALL:
 
-    Other distributions may package it with other names, do a search for libnotify using your distribution package
-    manager.
+  gem install fgrehm-autotestforphp --source=http://gems.github.com
 
-    If you use KDE and do not have libnotify-bin installed, it will try to use kdialog which is part of KDE.
-    It also works if you have zenity installed.
 
+== SETUP
 
-== INSTALL:
+During instalation, AutotestForPHP will create:
 
-* gem install autotestforphp --source=http://gems.github.com
+  1. An empty PHPUnit boostrap file on autotestforphp/bootstrap-autotest.php to be used when running tests
 
+  2. An empty config file on autotestforphp/config.autotest
 
-== SETUP
+  3. A PHPUnit config file on autotestforphp/phpunit-autotest.xml to will configure the bootstrap file to be used,
+     tests folder and log results to a XML file needed for displaying notifications:
 
-During instalation, AutotestForPHP will create:
-  * An empty PHPUnit boostrap file on 'test/bootstrap-autotest.php' to be used when running tests
-  * An empty config file on 'autotestforphp/config.autotest'
-  * A PHPUnit config file on 'test/phpunit-autotest.xml' to will configure the bootstrap file to be used, tests folder and log results to a XML file needed for displaying notifications:
-        <phpunit bootstrap="./test/bootstrap-autotest.php">
+        <phpunit bootstrap="./autotestforphp/bootstrap-autotest.php">
             <testsuite name="Application">
                 <directory>./test/</directory>
             </testsuite>
@@ -77,22 +86,26 @@ During instalation, AutotestForPHP will create:
             </logging>
         </phpunit>
 
-You can specify the folders / files to be watched on 'autotestforphp/config.autotest' file by setting the FOLDERS_TO_WATCH Ruby constant:
+You can specify the folders or files to be watched on <em>autotestforphp/config.autotest</em> file by setting the FOLDERS_TO_WATCH Ruby constant:
 
 Example:
+
   FOLDERS_TO_WATCH = ['./src/**/*', './app/**/*', './test/**/*', './some_specific_file.php']
 
-If no folders are specified on 'autotestforphp/config.autotest', AutotestForPHP will watch for changes on the following folders:
-  * src
-  * app
-  * lib
-  * test
+If no folders are specified in config file, AutotestForPHP will watch for changes on the following folders (if they exist):
+
+* src
+* app
+* lib
+* test
 
 
 == TODO:
 
-* Skip files to be watched
-* Check if tool was already skip file creation
+* Default <em>autotestforphp/bootstrap-autotest.php</em>
+* Write comments about config usage on <em>autotestforphp/config.autotest</em>
+* Some way to skip folders to be watched
+* Check if tool was already installed and skip file creation
 * Test on Mac and XP
 * Like ZenTest autotest, focus on running previous failures until they are fixed instead of running all tests all the time
 

data/autotestforphp.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{autotestforphp}
-  s.version = "0.0.1"
-
+  s.version = "0.0.2"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["F\303\241bio Rehm"]
   s.date = %q{2009-07-24}
@@ -11,15 +10,16 @@ Gem::Specification.new do |s|
   s.executables = ["autotestforphp"]
   s.homepage = %q{http://github.com/fgrehm/autotestforphp}
   s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
-  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "autotestforphp.gemspec", "bin/autotestforphp", "images/fail.png", "images/pass.png", "lib/autotestforphp.rb", "lib/autotestforphp/cli.rb", "lib/autotestforphp/notification.rb", "lib/autotestforphp/notification/linux.rb", "lib/autotestforphp/notification/mac.rb", "lib/autotestforphp/notification/windows.rb", "lib/autotestforphp/result.rb", "script/console", "script/destroy", "script/generate", "test/autotestforphp/test_autotestforphp.rb", "test/cli/test_autotestforphp_cli.rb", "test/cli/test_install_cli.rb", "test/test_helper.rb", "test/test_linux.rb", "test/test_mac.rb", "test/test_notification.rb", "test/test_result.rb", "test/test_windows.rb"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "autotestforphp.gemspec", "bin/autotestforphp", "images/fail.png", "images/pass.png", "lib/autotestforphp.rb", "lib/autotestforphp/cli.rb", "lib/autotestforphp/notification.rb", "lib/autotestforphp/notification/linux.rb", "lib/autotestforphp/notification/mac.rb", "lib/autotestforphp/notification/windows.rb", "lib/autotestforphp/result.rb", "script/console", "script/destroy", "script/generate", "test/autotestforphp/test_autotestforphp.rb", "test/cli/test_autotestforphp_cli.rb", "test/test_helper.rb", "test/test_linux.rb", "test/test_mac.rb", "test/test_notification.rb", "test/test_result.rb", "test/test_windows.rb"]
   s.post_install_message = %q{PostInstall.txt}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{autotestforphp}
   s.rubygems_version = %q{1.3.4}
   s.summary = %q{Autotest tool for PHP}
-  s.test_files = ["test/cli/test_autotestforphp_cli.rb", "test/cli/test_install_cli.rb", "test/test_linux.rb", "test/test_notification.rb", "test/test_helper.rb", "test/test_windows.rb", "test/test_result.rb", "test/test_mac.rb", "test/autotestforphp/test_autotestforphp.rb"]
+  s.test_files = ["test/cli/test_autotestforphp_cli.rb", "test/test_linux.rb", "test/test_notification.rb", "test/test_helper.rb", "test/test_windows.rb", "test/test_result.rb", "test/test_mac.rb", "test/autotestforphp/test_autotestforphp.rb"]
 
+  
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3

data/lib/autotestforphp.rb

@@ -34,13 +34,13 @@ class Autotestforphp
   end
 
   def base_path=(path)
-    @@base_path = path
+    @base_path = path
   end
   def base_path
-    if not defined? @@base_path
+    if @base_path.nil?
       self.base_path = File.expand_path('./') + "/"
     end
-    @@base_path
+    @base_path
   end
   def config_file_path
     "#{base_path}autotestforphp/config.autotest"
@@ -49,10 +49,10 @@ class Autotestforphp
     "#{base_path}autotestforphp/logfile.xml"
   end
   def phpunit_config_file_path
-    "#{base_path}test/phpunit-autotest.xml"
+    "#{base_path}autotestforphp/phpunit-autotest.xml"
   end
   def bootstrap_file_path
-    "#{base_path}test/bootstrap.php"
+    "#{base_path}autotestforphp/bootstrap-autotest.php"
   end
 
   def phpunit_config_file_exists?
@@ -81,9 +81,10 @@ class Autotestforphp
   end
 
   def install
+    Dir.mkdir("#{base_path}autotestforphp/") unless File.exist?("#{base_path}autotestforphp/")
     File.open(phpunit_config_file_path, 'w') do |f|
       f.puts <<-CONFIG
-<phpunit bootstrap="./test/bootstrap-autotest.php">
+<phpunit bootstrap="./autotestforphp/bootstrap-autotest.php">
     <testsuite name="Application">
         <directory>./test/</directory>
     </testsuite>
@@ -94,7 +95,6 @@ class Autotestforphp
 CONFIG
     end
     File.open(bootstrap_file_path, 'w').close
-    Dir.mkdir("#{base_path}autotestforphp/") unless File.exist?("#{base_path}autotestforphp/")
     File.open(config_file_path, 'w').close
   end
 
@@ -179,7 +179,9 @@ private
       msg = 'Tests could not be executed'
       img = Notification::Config.fail_image
     else
-      result = Result.build_from_xml(File.new(phpunit_log_file_path))
+      f = File.new(phpunit_log_file_path)
+      result = Result.build_from_xml(f)
+      f.close
       msg = result.message
       img = result.image
     end

data/lib/autotestforphp/cli.rb

@@ -3,7 +3,7 @@ require 'optparse'
 class Autotestforphp
   class CLI
     def self.execute(stdout, arguments=['--run'])
-      arguments = ['--run'] unless arguments.count > 0 # defaults to run
+      arguments = ['--run'] unless arguments.size > 0 # defaults to run
 
       OptionParser.new do |opts|
         opts.banner = <<-BANNER.gsub(/^          /,'')

data/test/autotestforphp/test_autotestforphp.rb

@@ -10,11 +10,16 @@ class TestAutotestforphp < Test::Unit::TestCase
 
   def setup
     @atp = Autotestforphp.new
+    @atp.base_path = File.dirname(__FILE__) + '/'
   end
 
   def teardown
     File.delete(File.dirname(__FILE__) + '/sample.php') if File.exist?(File.dirname(__FILE__) + '/sample.php')
     File.delete(File.dirname(__FILE__) + '/sample2.php') if File.exist?(File.dirname(__FILE__) + '/sample2.php')
+    File.delete(@atp.bootstrap_file_path) if File.exist?(@atp.bootstrap_file_path)
+    File.delete(@atp.phpunit_config_file_path) if File.exist?(@atp.phpunit_config_file_path)
+    File.delete(@atp.config_file_path) if File.exist?(@atp.config_file_path)
+    Dir.delete("#{@atp.base_path}autotestforphp/") if File.exist?("#{@atp.base_path}autotestforphp/")
   end
 
   def test_detect_file_change
@@ -44,6 +49,14 @@ class TestAutotestforphp < Test::Unit::TestCase
     assert_equal "phpunit.bat --configuration \"#{@atp.phpunit_config_file_path}\"", @atp.make_test_cmd
   end
 
+  def test_install
+    @atp.install
+
+    assert @atp.phpunit_config_file_exists?
+    assert @atp.bootstrap_file_exists?
+    assert @atp.config_file_exists?
+  end
+
 #  def test_make_test_cmd_mac
 #
 #  end

data/test/cli/test_autotestforphp_cli.rb

@@ -24,10 +24,18 @@ class TestAutotestforphpCli < Test::Unit::TestCase
     execute
   end
 
+  def test_print_message_after_installation
+    Autotestforphp.expects(:install).
+                   once
+
+    execute(['--install'])
+
+    assert_match(/Autotest for PHP was installed successfully/, @stdout)
+  end
   private
 
-  def execute
-    Autotestforphp::CLI.execute(@stdout_io = StringIO.new)
+  def execute(args = [])
+    Autotestforphp::CLI.execute(@stdout_io = StringIO.new, args)
     @stdout_io.rewind
     @stdout = @stdout_io.read
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fgrehm-autotestforphp
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "F\xC3\xA1bio Rehm"
@@ -58,7 +58,6 @@ files:
 - script/generate
 - test/autotestforphp/test_autotestforphp.rb
 - test/cli/test_autotestforphp_cli.rb
-- test/cli/test_install_cli.rb
 - test/test_helper.rb
 - test/test_linux.rb
 - test/test_mac.rb
@@ -94,7 +93,6 @@ specification_version: 3
 summary: Autotest tool for PHP
 test_files: 
 - test/cli/test_autotestforphp_cli.rb
-- test/cli/test_install_cli.rb
 - test/test_linux.rb
 - test/test_notification.rb
 - test/test_helper.rb

data/test/cli/test_install_cli.rb

@@ -1,33 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', "test_helper.rb")
-require 'autotestforphp/cli'
-
-class TestInstallCli < Test::Unit::TestCase
-  def setup
-    @atp = Autotestforphp.new
-    @atp.base_path = File.dirname(__FILE__) + '/'
-
-    Dir.mkdir("#{@atp.base_path}test/") unless File.exist?("#{@atp.base_path}test/")
-
-    Autotestforphp::CLI.execute(@stdout_io = StringIO.new, ['--install'])
-    @stdout_io.rewind
-    @stdout = @stdout_io.read
-  end
-
-  def teardown
-    File.delete(@atp.bootstrap_file_path) if File.exist?(@atp.bootstrap_file_path)
-    File.delete(@atp.phpunit_config_file_path) if File.exist?(@atp.phpunit_config_file_path)
-    File.delete(@atp.config_file_path) if File.exist?(@atp.config_file_path)
-    Dir.delete("#{@atp.base_path}autotestforphp/") if File.exist?("#{@atp.base_path}autotestforphp/")
-    Dir.delete("#{@atp.base_path}test/") if File.exist?("#{@atp.base_path}test/")
-  end
-
-  def test_print_default_output
-    assert_match(/Autotest for PHP was installed successfully/, @stdout)
-  end
-
-  def test_create_files
-    assert @atp.phpunit_config_file_exists?
-    assert @atp.bootstrap_file_exists?
-    assert @atp.config_file_exists?
-  end
-end