ropenlaszlo 0.2.0 → 0.3.0

data/doc/CHANGES

@@ -1,5 +1,14 @@
 = Change Log
 
+== Version 0.3.0 (2006/01/16)
+* compilation errors and warnings
+* refactored test case setup
+* fixed test case directory
+* added rdoc task
+* --output doesn't exist; --dir does
+* Updated installation instructions
+* Fixed rdoc formatting errors
+
 == Version 0.2.0 (2006/01/11)
 * Released as gem
 * Published to rubyforge

data/doc/README

@@ -15,20 +15,23 @@ then the following Ruby code can be used to create a file 'hello.swf' which can
 
 == Requirements
 
-* {OpenLaszlo 3.1}[http://openlaszlo.org]
+* {OpenLaszlo 3.1 or later}[http://openlaszlo.org]
 * Ruby -v 1.8.2 or later (untested in earlier versions)
+* RubyGems[http://rubygems.rubyforge.org]
 
-== Downloading and Installation
+== Installation
 
-ROpenLaszlo is distributed as a RubyGem.  You may download it from ROpenLaszlo's {RubyForge project}[http://rubyforge.org/projects/ropenlaszlo].
+0:: Download and install {OpenLaszlo}[http://openlaszlo.org]
 
-Installation of ROpenLaszlo requires that you have RubyGems[http://rubygems.rubyforge.org] installed.  In that case, you can download the ROpenLaszlo .gem to your local file system, and execute:
+1: Install this gem
+  > gem install ropenlaszlo
 
-  gem install ropenlaszlo
+2:: Set your +OPENLASZLO_HOME+ environment variable to the directory that contains the {OpenLaszlo SDK}[http://openlaszlo.org].  If the following prints something, you've got it right:
+  > grep Laszlo "$OPENLASZLO_HOME/README.txt"
 
 == Documentation
 
-{This OpenLaszlo Blog entry}[http://weblog.openlaszlo.org/archives/2006/01/deploying-openlaszlo-applications-with-rake/] has additional information and some examples of using ROpenLaszlo in a Rakefile.  Where that entry says to download +openlaszlo.rb+ and require +openlaszlo+, you should instead install this ropenlaszlo gem and require +ropenlaszlo+.)
+{This OpenLaszlo Blog entry}[http://weblog.openlaszlo.org/archives/2006/01/deploying-openlaszlo-applications-with-rake/] has additional information and some examples of using ROpenLaszlo in a Rakefile.
 
 == License
 

data/doc/TODO

@@ -2,17 +2,16 @@
 
 == Compiler
 * Dependency tracking
-* Detect when file is not present
-* Class for compiler configuration errors
+* Compile server: allow use of proxy
+* Compile server: temporarily copy files into webapp directory
+* Command line: detect compilation warnings
 
 == Unit Tests
 * Compiler parameters
 * Missing source file
-* Syntax error
 * Unreachable server
 * Invalid OPENLASZLO_HOME
 
 == Packaging
 * Add rake task file
 * Add unit testing, doc generation to rakefile
-

data/lib/compiler.rb

@@ -42,6 +42,8 @@
 # See OpenLaszlo.compile for additional documentation.
 # 
 module OpenLaszlo
+  class CompilationError < StandardError; end
+  
   # This class implements a bridge to the compile server.
   #
   # If you don't need multiple compilers, you can use the methods in
@@ -65,6 +67,35 @@ module OpenLaszlo
     # Additional options:
     # * <tt>:format</tt> - request type (default 'swf')
     def compile source_file, params={}
+      mtime = File.mtime source_file
+      output = params[:output] || "#{File.basename source_file, '.lzx'}.swf"
+      compile_object source_file, output, params
+      results = request_metadata_for source_file, params
+      raise "Race condition: #{source_file} was modified during compilation" if mtime != File.mtime(source_file)
+      results[:output] = output
+      raise CompilationError.new(results[:error]) if results[:error]
+      return results
+    end
+    
+    private
+    def compile_object source_file, object, params={}
+      params = {}.update(params).update(:output => object)
+      request source_file, params
+    end
+    
+    def request_metadata_for source_file, params={}
+      results = {}
+      params = {}.update(params).update(:format => 'canvas-xml', :output => nil)
+      text = request source_file, params
+      if text =~ %r{<warnings>(.*?)</warnings>}m
+        results[:warnings] = $1.scan(%r{<error>\s*(.*?)\s*</error>}m).map{|w|w.first}
+      elsif text !~ %r{<canvas>} && text =~ %r{<pre>Error:\s*(.*?)\s*</pre>}m
+        results[:error] = $1
+      end
+      return results
+    end
+    
+    def request source_file, params={}
       require 'net/http'
       require 'uri'
       # assert that pathname is relative to LPS home:
@@ -74,7 +105,7 @@ module OpenLaszlo
       # FIXME: this doesn't handle quoting; use recursive File.split instead
       # FIXME: should encode the url, for filenames that include '/'
       server_relative_path.gsub(File::Separator, '/')
-      output = params[:output] || "#{File.basename source_file, '.lzx'}.swf"
+      output = params[:output]
       options = {
         :lzr => params[:runtime],
         :debug => params[:debug],
@@ -86,16 +117,19 @@ module OpenLaszlo
       Net::HTTP.get_response URI.parse(url) do |response|
         case response
         when Net::HTTPOK
-          File.open(output, 'w') do |f|
-            response.read_body do |segment|
-              f << segment
+          if output
+            File.open(output, 'w') do |f|
+              response.read_body do |segment|
+                f << segment
+              end
             end
+          else
+            return response.body
           end
         else
           response.value # raises error
         end
       end
-      return output
     end
   end
   
@@ -142,8 +176,18 @@ module OpenLaszlo
       args << '--runtime=#{params[:runtime]}' if params[:runtime]
       args << '--debug' if params[:debug]
       args << '--profile' if params[:profile]
-      args << "--output '#{File.basename output}'" unless File.dirname(source_file) == File.dirname(output)
-      `#{@lzc} #{args.join(' ')} '#{source_file}'`
+      args << "--dir '#{File.dirname output}'" unless File.dirname(source_file) == File.dirname(output)
+      args << source_file
+      text = `#{@lzc} #{args.join(' ')}`
+      text.gsub!(/^\d+\s+/, '') # work around a bug in OpenLaszlo 3.1
+      results = {:output => output}
+      if text =~ /^Compilation errors occurred:\n/
+        raise CompilationError.new($'.strip)
+      else
+        # FIXME: doesn't work because lzc prints errors to stderr
+        results[:warnings] = text.split("\n")
+      end
+      return results
     end
     
     private
@@ -169,7 +213,7 @@ module OpenLaszlo
     return @compiler = CompileServer.new if ENV['OPENLASZLO_URL'] and ENV['OPENLASZLO_HOME']
     return @compiler = CommandLineCompiler.new if ENV['OPENLASZLO_HOME']
     raise <<EOF
-Couldn't find an OpenLaszlo compiler.
+Couldn\'t find an OpenLaszlo compiler.
 
 To use the compile server (recommended), set ENV['OPENLASZLO_URL'] and ENV['OPENLASZLO_HOME'].
 

data/test/compilation-error.lzx

@@ -0,0 +1,2 @@
+<!-- This doesn't have a close tag, so it will fail compilation. -->
+<canvas

data/test/compilation-warning.lzx

@@ -0,0 +1 @@
+<canvas unknown-attribute="value"/>

data/test/compiler_test.rb

@@ -37,19 +37,26 @@ class << ENV
   end
 end
 
+# FIXME: should be able to put the test methods in here too
 module CompilerTestHelper
   def super_setup
     OpenLaszlo::compiler = nil
-    cd File.dirname(__FILE__)
+    #cd File.expand_path(File.dirname(__FILE__))
   end
   
   private
+  def testfile_pathname file
+    File.expand_path file, File.dirname(__FILE__)
+  end
+  
   def compile file, output=nil, options={}
+    file = testfile_pathname file
     output = File.basename(file, '.lzx')+'.swf'
     rm_f output
     begin
-      OpenLaszlo::compile file, *options
+      result = OpenLaszlo::compile file, *options
       assert File.exists?(output), "#{output} does not exist"
+      return result
     ensure
       rm_f output
     end
@@ -70,13 +77,30 @@ class CompileServerTest < Test::Unit::TestCase
   end
     
   def test_compilation
-    compile 'test.lzx'
+    result = compile 'test.lzx'
+    assert_equal 'test.swf', result[:output]
+  end
+  
+  def test_compilation_error
+    #assert_raise(OpenLaszlo::CompilationError) {compile 'compilation-error.lzx'}
+    ex = (compile 'compilation-error.lzx' rescue $!)
+    assert_instance_of OpenLaszlo::CompilationError, ex
+    assert_match /^compilation-error.lzx:3:1: XML document structures must start and end within the same entity./, ex.message
+  end
+  
+  def test_compilation_warning
+    result = compile 'compilation-warning.lzx'
+    assert_equal 'compilation-warning.swf', result[:output]
+    assert_instance_of Array, result[:warnings]
+    assert_equal 2, result[:warnings].length
+    assert_match /^compilation-warning.lzx:1:36/, result[:warnings].first
   end
   
   private
   alias :saved_compile :compile
   
   def compile file, output=nil, options={}
+    file = testfile_pathname file
     server_local_file = File.join @test_dir, File.basename(file)
     cp file, server_local_file
     begin
@@ -91,18 +115,32 @@ class CommandLineCompilerTest < Test::Unit::TestCase
   include CompilerTestHelper
   
   def setup
-    bindings = {'OPENLASZLO_URL' => nil}
-    @saved_bindings = Hash[*bindings.keys.map{|k|[k,ENV[k]]}.flatten]
-    ENV.update bindings
     super_setup
+    callcc do |exit|
+      resume = nil
+      ENV.with_bindings 'OPENLASZLO_URL' => nil do
+        resume = callcc do |continue|
+          @teardown = continue
+          exit.call
+        end
+      end
+      resume.call
+    end
   end
   
   def teardown
-    ENV.update @saved_bindings
+    callcc do |continue| @teardown.call(continue) end
   end
   
   def test_compilation
-    compile 'test.lzx'
+    result = compile 'test.lzx'
+    assert_equal 'test.swf', result[:output]
+  end
+  
+  def test_compilation_error
+    ex = (compile 'compilation-error.lzx' rescue $!)
+    assert_instance_of OpenLaszlo::CompilationError, ex
+    assert_match /^compilation-error.lzx:3:1: XML document structures must start and end within the same entity./, ex.message
   end
 end
 

data/test/utils.rb

@@ -0,0 +1,22 @@
+class << ENV
+  # Execute a block, restoring the bindings for +keys+ at the end.
+  # NOT thread-safe!
+  def with_saved_bindings keys, &block
+    saved_bindings = Hash[*keys.map {|k| [k, ENV[k]]}.flatten]
+    begin
+      block.call
+    ensure
+      ENV.update saved_bindings
+    end
+  end
+  
+  # Execute a block with the temporary bindings in +bindings+.
+  # Doesn't remove keys; simply sets them to nil.
+  def with_bindings bindings, &block
+    with_saved_bindings bindings.keys do
+      ENV.update bindings
+      return block.call
+    end
+  end
+end
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ropenlaszlo
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2006-01-11 00:00:00 -05:00
+  version: 0.3.0
+date: 2006-01-16 00:00:00 -05:00
 summary: Ruby interface to OpenLaszlo.
 require_paths: 
 - lib
@@ -34,13 +34,16 @@ files:
 - doc/MIT-LICENSE
 - doc/README
 - doc/TODO
+- test/compilation-error.lzx
+- test/compilation-warning.lzx
 - test/compiler_test.rb
 - test/test.lzx
+- test/utils.rb
 test_files: []
 
 rdoc_options: 
 - --title
-- ROpenLaszlo -- Ruby interface to OpenLaszlo
+- "ROpenLaszlo: Ruby interface to OpenLaszlo."
 - --main
 - doc/README
 extra_rdoc_files: