dia 2.2.1 → 2.2.2

data/Changelog

@@ -1,9 +1,21 @@
+2010-08-20  Robert Gleeson <rob@flowof.info> (2.2.2)
+
+	* Documented the VERSION constant.
+	  Dia has 100% documentation coverage now.
+
+	* Fixed GH Issue 3 and GH Issue 4.
+	  See http://github.com/robgleeson/dia/issues for more info.
+
+	* Document every pair of getter and setter on RubyBlock using 
+	  the @overload YARD tag. Before this change, documentation for 
+	  setters was not visible.
+
 2010-08-12  Robert Gleeson <rob@flowof.info> (v2.2.1)
 
 	* Fixed a bug that saw #e ( an alias for #exception ) always return nil.
 	  #exception itself worked properly.
 
-	* #redirect_stderr, #redirect_stdout, and #rescue_exception are 
+	* #redirect_stderr, #redirect_stdout, and #rescue_exception 
 	  have been added to the RubyBlock class and are documented as getters. 
 	  They're aliased as #redirect_stderr?, #redirect_stdout? and 
 	  #rescue_exception? respectively.

data/CodingStyle

@@ -0,0 +1,15 @@
+== Coding Style
+
+    * Soft tabs(or "spaces") with a width of two spaces should be used when
+      identing code.
+
+    * The width of a line of code shouldn't be more than 100 columns, but exceptions
+      can be made in certain circumstances such as documentation that exceeds 100 columns
+      by a single column or two.
+
+    * When a method receives arguments, parenthesis should always be used. 
+
+The usual Ruby conventions should be applied as well, such as snake_case for method names, 
+CamelCase for classes/modules, and UPPERCASE_SNAKE_CASE for constants which do not reference
+a class or module.
+

data/GitPolicy

@@ -0,0 +1,27 @@
+== Git Policy
+
+    * master is reserved for the latest stable code in the project.
+      It shouldn't ever contain code that is experimental or that
+      hasn't been thoroughly tested. 
+
+    * bug-fixes is a branch which inherits from the latest stable 
+      release of the project. 
+      This branch serves as a branch that fixes issues in the latest 
+      stable release of the project. 
+
+      Changes made in this branch should be merged into experimental, 
+      and tested thoroughly. 
+      Ideally, every bug has a test that confirms it has been fixed). 
+
+    * topic-branches(ie, feature branches) inherit from master, and are 
+      then merged into experimental to be thoroughly tested.
+
+    * After experimental has been confirmed to be stable, it is merged into
+      master.
+
+      The experimental branch is the only branch that gets merged back into 
+      master, all other branches(topic branches, bug fixes) are merged into 
+      the experimental branch for testing, before being merged into master.
+
+This workflow hasn't been set in stone yet, it might be altered and it's open 
+to discussion and possibly change, too. 

data/{README.mkd → README.md}

@@ -34,7 +34,7 @@ simple, and a joy to use. I hope you feel the same way :-)
 
 ## Documentation
 
-* [API Documentation](http://yardoc.org/docs/robgleeson-Dia/)   
+* [API Documentation](http://doc.fork-bomb.org/dia)   
   Written using YARD, the API documentation makes a great reference.  
   *The API documentation linked is for the latest stable release*
 
@@ -44,7 +44,7 @@ simple, and a joy to use. I hope you feel the same way :-)
 * Wiki documentation  
   *Work in progress*
 
-## Supported Rubies.
+## Supported Rubies
 
 The following Ruby implementations have had the test suite run against them, and
 reported a 100% success rate.
@@ -52,7 +52,9 @@ reported a 100% success rate.
 * MRI
   * 1.8.7-p299
   * 1.9.1-p378
-  * 1.9.2-rc1    
+  * 1.9.2-rc1
+  * 1.9.2-p0
+
 * REE
   * Ruby Enterprise Edition 2010.02 (1.8.7-p253)
 
@@ -60,6 +62,12 @@ MacRuby is not supported because it does not support Kernel.fork, and it won't a
 for fork anytime soon(if ever).  
 JRuby has experimental support for fork, but I haven't tried it.
  
+## Contribute
+Contributions and collaboration is welcomed with open arms, but before 
+you contribute, you should take the time to read the 
+[GitPolicy](http://github.com/robgleeson/Dia/blob/master/GitPolicy) and 
+[CodingStyle](http://github.com/robgleeson/Dia/blob/master/CodingStyle) files.
+
 ## Bugs  
 Bug reports are _very_ welcome, and can be reported through the
 [issue tracker](http://github.com/robgleeson/dia/issues).

data/dia.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.summary     = s.description
  
   s.require_paths = ["lib"]
-  s.files         = Dir["lib/**/*.rb"] + Dir["test/**/*.rb"] + %w(COPYING Changelog README.mkd 
-                                                                  dia.gemspec)
+  s.files         = Dir["lib/**/*.rb"] + Dir["test/**/*.rb"] + %w(COPYING Changelog CodingStyle 
+                                                                  GitPolicy README.md dia.gemspec)
   s.test_files    = Dir["test/**/*.rb"]
   
 
@@ -33,11 +33,14 @@ Gem::Specification.new do |s|
   The >=2.0.0 releases are not backward compatiable with the 1.0 series.
   
   Resources: 
-  * API Documentation    http://yardoc.org/docs/robgleeson-Dia/
+  * API Documentation    http://doc.fork-bomb.org/dia
   * Github               http://github.com/robgleeson/dia    
   * Mailing List         http://groups.google.com/group/ruby-dia
 
   Release notes are available at the mailing list.
+  
+  Please note the API documentation is no longer hosted at http://yardoc.org
+  See the link posted above for the new documentation link.
 
   Happy Hacking!
   --------------------------------------------------------------------------------  

data/lib/dia.rb

@@ -11,5 +11,6 @@ require(File.expand_path('dia/exception_struct' , File.dirname(__FILE__)))
 
 # The Dia module provides a namespace for all classes and modules Dia needs to operate.
 module Dia
-  VERSION = '2.2.1'
+  # The VERSION constant represents the current version of Dia.
+  VERSION = '2.2.2'
 end

data/lib/dia/ruby_block.rb

@@ -11,8 +11,79 @@ module Dia
     attr_reader :stdout
     attr_reader :exception
 
+    # @overload redirect_stderr=(boolean)
+    #   This method can enable or disable a feature that will redirect Standard Error output
+    #   in the process that is spawned to execute a sandbox.
+    #
+    #   @param  [Boolean]   Enable  Passing true will enable the redirection of Standard Error output.
+    #
+    #   @param  [Boolean]  Disable  Passing false will disable the redirection of Standard Error output.
+    #
+    #   @return [void]
+    #
+    #   @see    #stderr           Standard Error output can be accessed through #stderr.
+    #
+    #   @see    #redirect_stderr? #redirect_stderr? can tell you if Standard Error output is being
+    #                             redirected.
+    #                             
+    # @overload redirect_stderr 
+    #   This method provides access to the object passed to {#redirect_stderr=}
+    #
+    #   @return [Object]            Returns the object passed to {#redirect_stderr=}
+    #   
+    #   @return [Boolean]           Returns false if {#redirect_stderr=} has not been called.
+    # 
+    #   @see    #redirect_stderr?   #redirect_stderr?
     attr_accessor :redirect_stderr
+
+    # @overload redirect_stdout=(boolean)
+    #   This method can enable or disable a feature that will redirect Standard Output
+    #   in the process that is spawned to execute a sandbox.
+    #
+    #   @param  [Boolean]   Enable    Passing true will enable the redirection of Standard Output.
+    #
+    #   @param  [Boolean]  Disable    Passing false will disable the redirection of Standard Output.
+    #
+    #   @return [void]
+    #
+    #   @see    #stdout               Standard Output can be accessed through #stdout.
+    #
+    #   @see    #redirect_stdout?     #redirect_stdout? can tell you if Standard Output is 
+    #                                 being redirected.
+    #                               
+    # @overload redirect_stdout
+    #   This method provides access to the object passed to {#redirect_stdout=}
+    #
+    #   @return [Object]            Returns the object passed to {#redirect_stdout=}
+    #   
+    #   @return [Boolean]           Returns false if {#redirect_stdout=} has not been called.
+    # 
+    #   @see    #redirect_stdout?   #redirect_stdout?
     attr_accessor :redirect_stdout
+
+
+    # @overload rescue_exception=
+    #   This method can enable or disable a feature that will try to rescue exceptions 
+    #   that are raised in the process that is spawned to execute a sandbox.
+    #
+    #   @param  [Boolean]   Enable    Passing true will enable the capture of exceptions.
+    #
+    #   @param  [Boolean]  Disable    Passing false will disable the capture of exceptions.
+    #
+    #   @return [void]         
+    #
+    #   @see    #exception            An exception can be accessed through the #exception 
+    #                                 method.
+    #   @since 2.0.0
+    #   
+    # @overload rescue_exception
+    #   This method provides access to the object passed to {#rescue_exception=}
+    #
+    #   @return [Object]            Returns the object passed to {#rescue_exception=}
+    #   
+    #   @return [Boolean]           Returns false if {#rescue_exception=} has not been called.
+    # 
+    #   @see    #rescue_exception?  #rescue_exception?
     attr_accessor :rescue_exception
 
     # @param  [String] Profile Accepts one of five profiles which can be found
@@ -29,7 +100,7 @@ module Dia
                            "Please consult the documentation.") unless block_given?
       @profile         = profile
       @proc            = block
-      @rescue          = false
+      @rescue_exception          = false
       @redirect_stdout = false
       @redirect_stderr = false
       @pipes           = {}
@@ -61,37 +132,27 @@ module Dia
       @stdout
     end
 
-    # This method can enable or disable a feature that will redirect Standard Output
-    # in the process that is spawned to execute a sandbox.
-    #
-    # @param  [true]   Enable     Passing true will enable the redirection of Standard Output.
-    #
-    # @param  [false]  Disable    Passing false will disable the redirection of Standard Output.
-    #
-    # @return [void]
-    #
-    # @see    #stdout             Standard Output can be accessed through #stdout.
-    #
-    # @see    #redirect_stdout?   #redirect_stdout? can tell you if Standard Output is 
-    #                             being redirected.
     def redirect_stdout=(boolean)
       @redirect_stdout = boolean
     end
 
+    def redirect_stdout
+      @redirect_stdout
+    end
+
     # This method will tell you if Standard Output is being redirected in the
     # process spawned to execute a sandbox.
     #
-    # @return [true]             Returns true when Standard Output is being redirected.
+    # @return [Boolean]           Returns true when Standard Output is being redirected.
     #
-    # @return [false]            Returns false when Standard Output is not being redirected.
+    # @return [Boolean]           Returns false when Standard Output is not being redirected.
     #
-    # @see    #redirect_stdout=  Redirection of stdout can be enabled through #redirect_stdout=.  
+    # @see    #redirect_stdout=   Redirection of stdout can be enabled through #redirect_stdout=.  
     #
-    # @see    #stdout            Standard Ouput can be accessed through #stdout.
-    def redirect_stdout
+    # @see    #stdout             Standard Ouput can be accessed through #stdout.
+    def redirect_stdout?
       !!@redirect_stdout
     end
-    alias :redirect_stdout? :redirect_stdout
 
     # Provides access to the Standard Error stream of the process that was last used to execute
     # a sandbox. This feature is disabled by default. 
@@ -116,53 +177,43 @@ module Dia
       @stderr
     end
 
-    # This method can enable or disable a feature that will redirect Standard Error output
-    # in the process that is spawned to execute a sandbox.
-    #
-    # @param  [true]   Enable   Passing true will enable the redirection of Standard Error output.
-    #
-    # @param  [false]  Disable  Passing false will disable the redirection of Standard Error output.
-    #
-    # @return [void]
-    #
-    # @see    #stderr           Standard Error output can be accessed through #stderr.
-    #
-    # @see    #redirect_stderr? #redirect_stderr? can tell you if Standard Error output is being
-    #                           redirected.
     def redirect_stderr=(boolean)
       @redirect_stderr = boolean
     end
 
+    def redirect_stderr
+      @redirect_stderr
+    end
+
     # This method will tell you if Standard Error output is being redirected in the process
     # spawned to execute a sandbox.
     # 
-    # @return [true]            Returns true when Standard Error output is being redirected.
+    # @return [Boolean]           Returns true when Standard Error output is being redirected.
     #
-    # @return [false]           Returns false when Standard Error output is not being redirected.
+    # @return [Boolean]           Returns false when Standard Error output is not being redirected.
     #
-    # @see    #redirect_stderr= Redirection of stderr can be enabled through #redirect_stderr=.
+    # @see    #redirect_stderr=   Redirection of stderr can be enabled through #redirect_stderr=.
     #
-    # @see    #stderr           Standard Error output can be accessed through #stderr.
-    def redirect_stderr
+    # @see    #stderr             Standard Error output can be accessed through #stderr.
+    def redirect_stderr?
       !!@redirect_stderr
     end
-    alias :redirect_stderr? :redirect_stderr
 
     # This method will tell you if an exception has been rescued in the process that was
     # last used to execute a sandbox.   
     # 
-    # @return [true]              Returns true when an exception has been rescued.
+    # @return [Boolean]              Returns true when an exception has been rescued.
     #
-    # @return [false]             Returns false when an exception has not been rescued.
+    # @return [Boolean]              Returns false when an exception has not been rescued.
     #
-    # @return [false]             Returns false if Dia was not set to rescue exceptions
-    #                             before a call to {#run} or {#run_nonblock}. 
+    # @return [Boolean]              Returns false if Dia was not set to rescue exceptions
+    #                                before a call to {#run} or {#run_nonblock}. 
     #
-    # @see    #rescue_exception=  The rescue of exceptions can be enabled or disabled through 
-    #                             #rescue_exception=
+    # @see    #rescue_exception=     The rescue of exceptions can be enabled or disabled through 
+    #                                #rescue_exception=
     #
-    # @see    #exception          An exception can be accessed through the #exception 
-    #                             method.
+    # @see    #exception             An exception can be accessed through the #exception 
+    #                                method.
     def exception_rescued?
       !!exception
     end
@@ -180,36 +231,22 @@ module Dia
     # This method will tell you if an exception will be rescued in the process that is
     # spawned to execute a sandbox.
     #   
-    # @return [true]              Returns true when exceptions are being rescued.
+    # @return [Boolean]              Returns true when exceptions are being rescued.
     #
-    # @return [false]             Returns false when are exceptions are not being 
-    #                             rescued.
+    # @return [Boolean]              Returns false when are exceptions are not being 
+    #                                rescued.
     # @since  2.0.0
     #
-    # @see    #rescue_exception=  The rescue of exceptions can be enabled or disabled through 
-    #                             #rescue_exception=
-    def rescue_exception
-      !!@rescue
+    # @see    #rescue_exception=     The rescue of exceptions can be enabled or disabled through 
+    #                                #rescue_exception=
+    def rescue_exception?
+      !!@rescue_exception
     end
-    alias :rescue_exception? :rescue_exception
 
-    # This method can enable or disable a feature that will try to rescue exceptions 
-    # that are raised in the process that is spawned to execute a sandbox.
-    #
-    # @param  [true]   Enable     Passing true will enable the capture of exceptions.
-    #
-    # @param  [false]  Disable    Passing false will disable the capture of exceptions.
-    #
-    # @return [void]         
-    #
-    # @see    #exception          An exception can be accessed through the #exception 
-    #                             method.
-    # @since 2.0.0
     def rescue_exception=(boolean)
-      @rescue = boolean
+      @rescue_exception = boolean
     end
 
-
     # Provides access to the data of an exception object that has been rescued in the process 
     # that was last used to execute a sandbox. This feature is disabled by default.  
     #
@@ -303,7 +340,7 @@ module Dia
         @pid = fork do
           redirect(:stdout) if @redirect_stdout
           redirect(:stderr) if @redirect_stderr
-          if @rescue
+          if @rescue_exception
             begin
               initialize_sandbox
               write_return_value(@proc.call(*args))
@@ -368,7 +405,7 @@ module Dia
       # @api private
       def open_pipes_if_needed
         @pipes[:return_reader]   , @pipes[:return_writer]    = IO.pipe
-        @pipes[:exception_reader], @pipes[:exception_writer] = IO.pipe if @rescue
+        @pipes[:exception_reader], @pipes[:exception_writer] = IO.pipe if @rescue_exception
         @pipes[:stdout_reader]   , @pipes[:stdout_writer]    = IO.pipe if @redirect_stdout
         @pipes[:stderr_reader]   , @pipes[:stderr_writer]    = IO.pipe if @redirect_stderr
       end

data/test/suite/lib/dia/RubyBlock#redirect_stderr.rb

@@ -0,0 +1,29 @@
+suite('RubyBlock') do
+  suite('#redirect_stderr') do
+    suite('Return values') do
+
+      setup do 
+        @result = nil
+      end
+
+      exercise('When #redriect_stderr= is passed an object.') do
+        @dia = Dia::RubyBlock.new(Dia::Profiles::NO_INTERNET) { }
+        @dia.redirect_stderr = "test"
+      end
+
+      verify('#redirect_stderr returns that object.') do
+        @dia.redirect_stderr == "test"
+      end
+
+      exercise('When #redirect_stderr= is not passed an object.') do
+        @dia = Dia::RubyBlock.new(Dia::Profiles::NO_INTERNET) { }
+      end
+
+      verify('#redirect_stderr returns false') do
+        @dia.redirect_stderr == false
+      end
+
+    end
+  end
+end
+

data/test/suite/lib/dia/RubyBlock#redirect_stdout.rb

@@ -0,0 +1,29 @@
+suite('RubyBlock') do
+  suite('#redirect_stdout') do
+    suite('Return values') do
+
+      setup do 
+        @result = nil
+      end
+
+      exercise('When #redriect_stdout= is passed an object.') do
+        @dia = Dia::RubyBlock.new(Dia::Profiles::NO_INTERNET) { }
+        @dia.redirect_stdout = "test"
+      end
+
+      verify('#redirect_stdout returns that object.') do
+        @dia.redirect_stdout == "test"
+      end
+
+      exercise('When #redirect_stdout= is not passed an object.') do
+        @dia = Dia::RubyBlock.new(Dia::Profiles::NO_INTERNET) { }
+      end
+
+      verify('#redirect_stdout returns false') do
+        @dia.redirect_stdout == false
+      end
+
+    end
+  end
+end
+

data/test/suite/lib/dia/RubyBlock#rescue_exception.rb

@@ -0,0 +1,28 @@
+suite('RubyBlock') do
+  suite('#rescue_exception') do
+    suite('Return values') do
+
+      setup do 
+        @result = nil
+      end
+
+      exercise('When #rescue_exception= is passed an object.') do
+        @dia = Dia::RubyBlock.new(Dia::Profiles::NO_INTERNET) { }
+        @dia.rescue_exception = "test"
+      end
+
+      verify('#rescue_exception returns that object.') do
+        @dia.rescue_exception == "test"
+      end
+
+      exercise('When #rescue_exception= is not passed an object.') do
+        @dia = Dia::RubyBlock.new(Dia::Profiles::NO_INTERNET) { }
+      end
+
+      verify('#rescue_exception returns false') do
+        @dia.rescue_exception == false
+      end
+
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 2
-  - 1
-  version: 2.2.1
+  - 2
+  version: 2.2.2
 platform: ruby
 authors: 
 - Robert Gleeson
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-12 00:00:00 +01:00
+date: 2010-08-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,8 +73,11 @@ files:
 - test/suite/lib/dia/Application#run_nonblock.rb
 - test/suite/lib/dia/RubyBlock#exception.rb
 - test/suite/lib/dia/RubyBlock#exception_raised?.rb
+- test/suite/lib/dia/RubyBlock#redirect_stderr.rb
 - test/suite/lib/dia/RubyBlock#redirect_stderr?.rb
+- test/suite/lib/dia/RubyBlock#redirect_stdout.rb
 - test/suite/lib/dia/RubyBlock#redirect_stdout?.rb
+- test/suite/lib/dia/RubyBlock#rescue_exception.rb
 - test/suite/lib/dia/RubyBlock#rescue_exception?.rb
 - test/suite/lib/dia/RubyBlock#run.rb
 - test/suite/lib/dia/RubyBlock#run_nonblock.rb
@@ -87,13 +90,15 @@ files:
 - test/suite/lib/dia/SharedFeatures#terminate.rb
 - COPYING
 - Changelog
-- README.mkd
+- CodingStyle
+- GitPolicy
+- README.md
 - dia.gemspec
 has_rdoc: yard
 homepage: 
 licenses: []
 
-post_install_message: "  -------------------------------------------------------------------------------- \n  Thanks for installing Dia, 2.2.1! \n  The >=2.0.0 releases are not backward compatiable with the 1.0 series.\n  \n  Resources: \n  * API Documentation    http://yardoc.org/docs/robgleeson-Dia/\n  * Github               http://github.com/robgleeson/dia    \n  * Mailing List         http://groups.google.com/group/ruby-dia\n\n  Release notes are available at the mailing list.\n\n  Happy Hacking!\n  --------------------------------------------------------------------------------  \n"
+post_install_message: "  -------------------------------------------------------------------------------- \n  Thanks for installing Dia, 2.2.2! \n  The >=2.0.0 releases are not backward compatiable with the 1.0 series.\n  \n  Resources: \n  * API Documentation    http://doc.fork-bomb.org/dia\n  * Github               http://github.com/robgleeson/dia    \n  * Mailing List         http://groups.google.com/group/ruby-dia\n\n  Release notes are available at the mailing list.\n  \n  Please note the API documentation is no longer hosted at http://yardoc.org\n  See the link posted above for the new documentation link.\n\n  Happy Hacking!\n  --------------------------------------------------------------------------------  \n"
 rdoc_options: []
 
 require_paths: 
@@ -128,8 +133,11 @@ test_files:
 - test/suite/lib/dia/Application#run_nonblock.rb
 - test/suite/lib/dia/RubyBlock#exception.rb
 - test/suite/lib/dia/RubyBlock#exception_raised?.rb
+- test/suite/lib/dia/RubyBlock#redirect_stderr.rb
 - test/suite/lib/dia/RubyBlock#redirect_stderr?.rb
+- test/suite/lib/dia/RubyBlock#redirect_stdout.rb
 - test/suite/lib/dia/RubyBlock#redirect_stdout?.rb
+- test/suite/lib/dia/RubyBlock#rescue_exception.rb
 - test/suite/lib/dia/RubyBlock#rescue_exception?.rb
 - test/suite/lib/dia/RubyBlock#run.rb
 - test/suite/lib/dia/RubyBlock#run_nonblock.rb