dia 1.5.pre.2 → 1.5

data/NEWS.md

@@ -1,14 +1,13 @@
 ## NEWS
 
 ### 1.5
-* Added Dia::Sandbox#exception() for inspecting an exception raised in a sandbox
-  from the parent process.
+* Added Dia::Sandbox#exit_status() 
+* Added Dia::Sandbox#exception_raised?().
+* Added Dia::Sandbox#exception() 
 * Fixed a small bug introduced in 1.5.pre - a typo, only encountered if
   Dia::SandboxException was raised.
 * Dia::Sandbox#running?, Dia::Sandbox#exit_status, and Dia::Sandbox#terminate 
   will return nil if you call them before calling Dia::Sandbox#run().
-* Added Dia::Sandbox#exit_status for collecting the exit status of a child 
-  process running under a sandbox.
 * Dia::Sandbox#run was not returning the PID of the process running under a 
   sandbox like told in the documentation - it is now.
 

data/README.md

@@ -121,6 +121,32 @@ capturing it so Dia can forward the exception to the parent process.
 
     puts sandbox.exception().class # prints "RuntimeError"
 
+**Checking if an exception has been raised in a sandbox**
+
+Since 1.5, Sandbox#exception_raised?() is available for checking if a block of
+ruby code running under a sandbox has raised an exception.
+
+    require 'rubygems'
+    require 'dia'
+
+    require 'rubygems'
+    require 'dia'
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do
+      raise()
+    end
+
+    sandbox.run()
+    sleep(0.1) # Let the parent receive the exception.
+               # Only neccesary for scenarios where an exception is raised
+               # rather quickly.
+
+    sandbox.exception_raised?() # => true
+
+`#exception()` & `#exception_raised?()` can only be applied to Ruby blocks. For 
+the 2.0 release, a redesign is planned that will fix this issue, as well as 
+data encapsulation issues(ie: @app shouldn't belong to a class that doesn't make
+use of it, which is the case if you're sandboxing a ruby block).
+
 .. Please see the yardoc [documentation](http://yardoc.org/docs/robgleeson-Dia) for more in-depth coverage of these methods, 
 in particular the documentation for the `Dia::Sandbox` class.
 

data/lib/dia.rb

@@ -5,7 +5,7 @@ require File.join(File.dirname(__FILE__), 'dia/commonapi.rb')
 require File.join(File.dirname(__FILE__), 'dia/sandbox.rb')
 
 module Dia
-  VERSION = '1.5.pre.2'
+  VERSION = '1.5'
   class SandboxException < StandardError; end
 end
 

data/lib/dia/sandbox.rb

@@ -53,8 +53,21 @@ module Dia
       initialize_streams()
     end
 
-    # The exception() method returns an instance or subclass instance of 
-    # Exception which has been raised in a sandbox. 
+    # The #exception_raised?() method returns true if an exception has been 
+    # raised in the last call to #run(), and false otherwise.
+    #
+    # @return [Boolean] Returns true or false.
+    # @since  1.5
+    def exception_raised?()
+      !!exception()
+    end
+
+    # The exception() method returns the last exception raised after a 
+    # a call to #run(), or nil.
+    #
+    # Every call to #run() resets the variable storing the exception object
+    # to nil, and it will only be a non-nil value if the last call to #run()
+    # raised an exception.
     #
     # This method can be used if you need access(from the parent process)
     # to an exception raised in your sandbox.
@@ -70,13 +83,11 @@ module Dia
     def exception()
       @write.close()
       if @read.ready?()
-        ret = Marshal.load(@read.gets())
-      else
-        ret = nil
+        @e = Marshal.load(@read.readlines().join())
       end
       @read.close()
       initialize_streams()
-      ret
+      @e
     end
 
     # The run method will spawn a child process and run the application _or_
@@ -102,6 +113,7 @@ module Dia
     # @return [Fixnum]                The Process ID(PID) that the sandboxed 
     #                                 application is being run under.
     def run(*args)
+      @e = nil
       initialize_streams()      
       @pid = fork do
         begin

data/test/suite/exception()_test.rb

@@ -0,0 +1,55 @@
+BareTest.suite('Dia::Sandbox#exception()') do
+  assert('#exception() will return an exception raised in the sandbox') do
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do
+      raise()
+    end
+  
+    sandbox.run()
+    sleep(0.1)
+    equal(RuntimeError, sandbox.exception.class())
+  end
+
+  assert('#exception() returns nil if called before ' \
+         'Dia::Sandbox#run()') do
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do
+                # ...
+              end
+    equal(nil, sandbox.exception())
+  end
+
+  assert('#exception() returns an exception object the first' \
+          ' and second time it is called after a single call to #run()') do
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do 
+      raise()
+    end
+  
+    sandbox.run()
+    sleep(0.1)
+    equal(RuntimeError, sandbox.exception().class)
+    equal(RuntimeError, sandbox.exception().class)
+  end
+
+  assert('#exception() will be set to nil after the first call to ' \
+         '#run raises an exception, and the second does not') do
+
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do 
+      raise()
+    end
+    
+    sandbox.run()
+    sleep(0.1)
+    equal(RuntimeError, sandbox.exception().class)
+    sandbox.instance_variable_set("@blk", proc { })
+    sandbox.run()
+    equal(nil, sandbox.exception())
+  end
+
+  assert('#exception() can marshal data containing one or more \n') do
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do 
+      fork {}
+    end
+    sandbox.run()
+    sleep(0.5)
+    equal(Errno::EPERM, sandbox.exception().class)
+  end
+end

data/test/suite/exception_raised?_test.rb

@@ -0,0 +1,22 @@
+BareTest.suite('Dia::Sandbox#exception_raised?()', 
+               :tags => [ :exception_raised] ) do
+  assert('#exception_raised?() returns false when no exception has been ' \
+         'raised') do
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do
+      # ...
+    end 
+    sandbox.run()
+    sleep(0.1)
+    equal(false, sandbox.exception_raised?())
+  end
+
+  assert('#exception_raised?() returns true when an exception has been ' \
+         'raised') do
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do
+      raise(StandardError, 'Exception')
+    end
+    sandbox.run()
+    sleep(0.1)
+    equal(true, sandbox.exception_raised?())
+  end
+end

data/test/suite/exceptions_test.rb

@@ -0,0 +1,12 @@
+BareTest.suite('Exceptions', :tags => [ :sandbox_init_exception ]) do
+  assert('Dia::SandboxException is raised if a call to sandbox_init() fails') do
+    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do 
+      # ...
+    end
+    sandbox.instance_variable_set("@profile", "i am going to break")
+    sandbox.run
+    sleep(0.1)
+    equal(Dia::SandboxException, sandbox.exception().class)
+  end
+end
+

metadata

@@ -1,13 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: dia
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 1
   - 5
-  - pre
-  - 2
-  version: 1.5.pre.2
+  version: "1.5"
 platform: ruby
 authors: 
 - Robert Gleeson
@@ -15,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 +01:00
+date: 2010-05-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,11 +78,11 @@ files:
 - lib/dia.rb
 - .yardopts
 - LICENSE
-has_rdoc: yard
+has_rdoc: true
 homepage: 
 licenses: []
 
-post_install_message: "  ********************************************************************\n  Dia (1.5.pre.2)\n  \n  Thanks for installing Dia, 1.5.pre.2! \n  \n  Keep up with the latest @ GitHub:\n  http://github.com/robgleeson/dia\n  ********************************************************************\n"
+post_install_message: "  ********************************************************************\n  Dia (1.5)\n  \n  Thanks for installing Dia, 1.5! \n  \n  Keep up with the latest @ GitHub:\n  http://github.com/robgleeson/dia\n  ********************************************************************\n"
 rdoc_options: []
 
 require_paths: 
@@ -98,13 +96,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -115,7 +111,9 @@ summary: Dia allows you to sandbox application(s) or block(s) of rubyon the OSX
 test_files: 
 - test/setup.rb
 - test/suite/check_if_sandbox_is_alive_test.rb
-- test/suite/exceptions_text.rb
+- test/suite/exception()_test.rb
+- test/suite/exception_raised?_test.rb
+- test/suite/exceptions_test.rb
 - test/suite/exit_status_test.rb
 - test/suite/passing_parameters_to_constructer_test.rb
 - test/suite/run_block_in_sandbox_test.rb

data/test/suite/exceptions_text.rb

@@ -1,41 +0,0 @@
-BareTest.suite('Exceptions', :tags => [ :exception ]) do
-  assert('Dia::SandboxException is raised if a call to sandbox_init() fails') do
-    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do 
-      # ...
-    end
-    sandbox.instance_variable_set("@profile", "i am going to break")
-    sandbox.run
-    sleep(0.1)
-    equal(Dia::SandboxException, sandbox.exception().class)
-  end
-
-  assert('Dia::Sandbox#exception() will return an exception raised in the sandbox') do
-    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do
-      raise()
-    end
-  
-    sandbox.run()
-    sleep(0.1)
-    equal(RuntimeError, sandbox.exception.class())
-  end
-
-  assert('Dia::Sandbox#exception() returns nil if called before ' \
-         'Dia::Sandbox#run()') do
-    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do
-                # ...
-              end
-    equal(nil, sandbox.exception())
-  end
-
-  assert('Dia::Sandbox#exception() returns nil after a second call') do
-    sandbox = Dia::Sandbox.new(Dia::Profiles::NO_OS_SERVICES) do 
-      raise()
-    end
-  
-    sandbox.run()
-    sleep(0.1)
-    equal(RuntimeError, sandbox.exception().class)
-    equal(nil, sandbox.exception())
-  end
-
-end