ropenlaszlo 0.5 → 0.6.3

data/{CHANGES → CHANGES.rdoc}

@@ -1,14 +1,26 @@
 = Change Log
 
-== Version 0.5 (2008-04-01)
-* compatible with OpenLaszlo 4.0
+== Version 0.6.3 (2009-03-23)
+* unquote html entities in errors and warnings
+
+== Version 0.6.2 (2009-03-23)
+* return which compiler was used
+
+== Version 0.6.1 (2009-03-23)
+* rename command-line compiler output file
+
+== Version 0.6 (2009-03-23)
+* follow symbolic links
 * reorganize directory structure
 * new rake task file
-* follow symbolic links
 * fall back to cmd-line compiler if source file is not in web path
 * raise error when lzc is not executable
 * change default runtime to swf8
-* switch to echoe for packaging
+
+
+== Version 0.5 (2009-03-22)
+* update for compatibility with OpenLaszlo 4.x
+* move to github
 
 
 == Version 0.4.1 (2006-01-25)

data/{LICENSE → MIT-LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2005-2008 Oliver Steele
+Copyright (c) 2006-2009 by Oliver Steele
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README → README.rdoc}

@@ -15,7 +15,7 @@ then the following Ruby code can be used to create a file 'hello.swf' which can
   require 'openlaszlo'
   OpenLaszlo::compile 'hello.lzx' # creates hello.swf
 
-You can turn this into a Rake task that will compile any Open<tt></tt>Laszlo source file:
+You can turn this snippet into a Rake task that will compile any Open<tt></tt>Laszlo source file:
   rule '.swf' => '.lzx' do |t|
     puts "Compiling #{t.source} => #{t.name}" if verbose
     OpenLaszlo::compile t.source, :output => t.name
@@ -37,10 +37,10 @@ The following includes such a task:
 0:: Download and install the {OpenLaszlo SDK}[openlaszlo.org]
 
 1: Install this gem
-  > gem install ropenlaszlo
+  $ gem install osteele-ropenlaszlo -s http://gems.github.com
 
 2:: Set your +OPENLASZLO_HOME+ environment variable to the directory that contains the {OpenLaszlo SDK}[openlaszlo.org].  If the following prints something, you've got it right:
-  > grep Laszlo "$OPENLASZLO_HOME/README.txt"
+  grep Laszlo "$OPENLASZLO_HOME/README.txt"
 
 3:: (Optional)  Set your +OPENLASZLO_URL+ environment variable to the web location of the Open<tt></tt>Laszlo server; for example, <tt>http</tt><tt>://localhost:8080/lps-3.1</tt>.  If you omit this step, the module will use the command line compiler, which is slower but is not limited to compiling files inside of +OPENLASZLO_HOME+.
 
@@ -67,6 +67,7 @@ steele@osteele.com
 
 == License
 
-ROpenLaszlo is copyright (c) 2006 Oliver Steele.  It is open-source software, and may be redistributed
-under the terms of the MIT license. The text of this licence is included in the
-ROpenLaszlo distribution, under the +doc+ subdirectory.
+ROpenLaszlo is copyright (c) 2006 - 2009 by Oliver Steele.  It is
+open-source software, and may be redistributed under the terms of the
+MIT license. The text of this licence is included in the ROpenLaszlo
+distribution.

data/lib/openlaszlo/compiler.rb

@@ -1,6 +1,5 @@
-# Author:: Oliver Steele
-# Copyright:: Copyright (c) 2005-2008 Oliver Steele.  All rights reserved.
-# License:: MIT License
+require 'net/http'
+require 'uri'
 
 # == module OpenLaszlo
 #
@@ -32,10 +31,12 @@ module OpenLaszlo
   # files in the same directory as the Open<tt></tt>Laszlo SDK.
   class CompileServer
     # Options:
-    # * <tt>:openlaszlo_home</tt> - filesystem location of the Open<tt></tt>Laszlo SDK.  Defaults to EVN['OPENLASZLO_HOME']
+    # * <tt>:openlaszlo_home</tt> - filesystem location of the Open<tt></tt>Laszlo SDK.  Defaults to ENV['OPENLASZLO_HOME']
     # * <tt>:server_uri</tt> - the URI of the server.  Defaults to ENV['OPENLASZLO_URL'] if this is specified, otherwise to 'http://localhost:8080/lps-dev'.
     def initialize(options={})
       @home = options[:home] || ENV['OPENLASZLO_HOME']
+      dirs = Dir[File.join(@home, 'Server', 'lps-*', 'WEB-INF')]
+      @home = File.dirname(dirs.first) if dirs.any?
       @base_url = options[:server_uri] || ENV['OPENLASZLO_URL'] || 'http://localhost:8080/lps-dev'
     end
 
@@ -47,40 +48,42 @@ module OpenLaszlo
     # * <tt>:format</tt> - request type (default 'swf')
     # See OpenLaszlo.compile for a description of +options+.
     def compile(source_file, options={})
-      mtime = File.mtime source_file
-      output = options[:output] || "#{File.expand_path(File.join(File.dirname(source_file), File.basename(source_file, '.lzx')))}.swf"
-      compile_object source_file, output, options
-      results = request_metadata_for source_file, options
+      mtime = File.mtime(source_file)
+      runtime = options[:runtime] || 'swf8'
+      default_output = source_file.sub(/\.lzx/, '') + '.swf'
+      output = options[:output] || default_output
+      compile_object(source_file, output, options)
+      results = request_metadata_for(source_file, options)
       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]
+      results[:output] = output
       return results
     end
 
     private
     def compile_object(source_file, object, options={})
       options = {}.update(options).update(:output => object)
-      request source_file, options
+      request(source_file, options)
     end
-
+    
     def request_metadata_for(source_file, options={})
-      results = {}
       options = {}.update(options).update(:format => 'canvas-xml', :output => nil)
-      text = request source_file, options
+      results = {:compiler => self}
+      text = request(source_file, options)
+      entities = {'lt' => '<', 'gt' => '>', 'quot' => '"', 'amp' => '&'}
       if text =~ %r{<warnings>(.*?)</warnings>}m
-        results[:warnings] = $1.scan(%r{<error>\s*(.*?)\s*</error>}m).map { |w| w.first }
+        results[:warnings] = $1.scan(%r{<error>\s*(.*?)\s*</error>}m).
+          map { |w| w.first.gsub(/&(\w+);/) { |s| entities[$0] || s } }
       elsif text !~ %r{<canvas>} && text =~ %r{<pre>Error:\s*(.*?)\s*</pre>}m
-        results[:error] = $1
+        results[:error] = $1.gsub(/&(\w+);/) { |s| entities[$0] || s }
       end
       return results
     end
-
+    
     def request(source_file, options={})
       output = options[:output]
-      require 'net/http'
-      require 'uri'
       # assert that pathname is relative to LPS home:
-      absolute_path = File.expand_path source_file
+      absolute_path = File.expand_path(source_file)
       server_relative_path = nil
       begin
         # follow links
@@ -95,8 +98,8 @@ module OpenLaszlo
         raise InvalidSourceLocation.new("#{absolute_path} isn't inside #{@home}") unless absolute_path.index(@home) == 0
         server_relative_path = absolute_path[@home.length..-1]
         # 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, '/')
+        # FIXME: encode the url
+        server_relative_path.gsub!(File::Separator, '/')
       end
       options = {
         :lzr => options[:runtime],
@@ -106,7 +109,7 @@ module OpenLaszlo
       query = options.map { |k,v| "#{k}=#{v}" unless v.nil? }.compact.join('&')
       url = "#{@base_url}#{server_relative_path}"
       url += "?#{query}" unless query.empty?
-      Net::HTTP.get_response URI.parse(url) do |response|
+      Net::HTTP.get_response(URI.parse(url)) do |response|
         case response
         when Net::HTTPOK
           if output
@@ -142,7 +145,16 @@ module OpenLaszlo
     # * <tt>:openlaszlo_home</tt> - the home directory of the Open<tt></tt>Laszlo SDK.
     # This defaults to ENV['OPENLASZLO_HOME'].
     def initialize(options={})
-      @lzc = options[:compiler_script] || self.class.executable_path(options)
+      @lzc = options[:compiler_script]
+      unless @lzc
+        home = options[:openlaszlo_home] || ENV['OPENLASZLO_HOME']
+        raise ":compiler_script or :openlaszlo_home must be specified" unless home
+        search = bin_directories.map {|f| File.join(home, f, 'lzc')}
+        found = search.select {|f| File.exists? f}
+        raise "couldn't find bin/lzc in #{bin_directories.join(' or ')}" if found.empty?
+        @lzc = found.first
+        @lzc += '.bat' if windows?
+      end
     end
     
     def self.executable_path(options={})
@@ -161,15 +173,16 @@ module OpenLaszlo
     #
     # See OpenLaszlo.compile for a description of +options+.
     def compile(source_file, options={})
+      runtime = options[:runtime] || 'swf8'
       default_output = File.join(File.dirname(source_file),
                                  File.basename(source_file, '.lzx') + '.swf')
       output = options[:output] || default_output
-      raise "#{source_file} and #{output} do not have the same basename." unless File.basename(source_file, '.lzx') == File.basename(output, '.swf')
       args = []
       args << "--runtime=#{options[:runtime]}" if options[:runtime]
       args << '--debug' if options[:debug]
       args << '--profile' if options[:profile]
-      args << "--dir '#{File.dirname output}'" unless File.dirname(source_file) == File.dirname(output)
+      args << "--dir '#{File.dirname output}'" unless
+        File.dirname(source_file) == File.dirname(output)
       args << source_file
       command = "\"#{@lzc}\" #{args.join(' ')}"
       ENV['LPS_HOME'] ||= ENV['OPENLASZLO_HOME']
@@ -180,11 +193,12 @@ module OpenLaszlo
         stdin, stdout, stderr = Open3.popen3(command)
         errors = stdout.read
         warnings = stderr.readlines
-        raise warnings.join("\n") if warnings.first =~ /^sh:/
-        # OpenLaszlo 4.0:
-        if warnings.first =~ /Compiling:.* to (\S+)/
+        # OpenLaszlo >= 4.0
+        if warnings.first and warnings.first =~ /^Compiling:.* to (.+)/
+          real_output = $1
           warnings.shift
-          File.rename($1, output) if File.exists?($1)
+          FileUtils.mv(real_output, output) if
+            File.exists?(real_output) and real_output != output
         end
       rescue NotImplementedError
         # Windows doesn't have popen
@@ -195,14 +209,14 @@ module OpenLaszlo
       if errors =~ /^Compilation errors occurred:\n/
         raise CompilationError.new($'.strip)
       end
-      results = {:output => output, :warnings => warnings}
+      results = {:output => output, :warnings => warnings, :compiler => self}
       return results
     end
 
     private
 
     # Locations in which to look for the lzc script, relative to OPENLASZLO_HOME
-    def self.bin_directories
+    def bin_directories
       [# binary distro location
         'bin',
         # source distro location
@@ -210,7 +224,7 @@ module OpenLaszlo
       ]
     end
 
-    def self.windows?
+    def windows?
       RUBY_PLATFORM =~ /win/ and not RUBY_PLATFORM =~ /darwin/
     end
   end
@@ -231,7 +245,7 @@ EOF
   end
 
   # Sets the default compiler for future invocations of OpenLaszlo.compile.
-  def self.compiler= compiler
+  def self.compiler=(compiler)
     @compiler = compiler
   end
 
@@ -261,17 +275,4 @@ EOF
   rescue InvalidSourceLocation
     CommandLineCompiler.new.compile(source_file, options)
   end
-
-  def self.make_html(source_file, options={}) #:nodoc:
-    raise 'not really supported, for now'
-    options = {
-      :format => 'html-object',
-      :output => File.basename(source_file, '.lzx')+'.html'}.update(options)
-    compiler.compile source_file, options
-    source_file = options[:output]
-    s = open(source_file).read
-    open(source_file, 'w') do |f|
-      f << s.gsub!(/\.lzx\?lzt=swf&amp;/, '.lzx.swf?')
-    end
-  end
 end

data/test/compiler_test.rb

@@ -18,21 +18,21 @@ module CompilerTestHelper
   end
   
   private
-  def testfile_pathname file
-    File.expand_path file, File.dirname(__FILE__)
+  def testfile_pathname(file)
+    return File.expand_path(file, File.dirname(__FILE__))
   end
   
-  def assert_same_file a, b
+  def assert_same_file(a, b)
     assert_equal File.expand_path(a), File.expand_path(b)
   end
   
-  def compile file, output=nil, options={}
-    file = testfile_pathname file
+  def compile(file, output=nil, options={})
+    file = testfile_pathname(file)
     output ||= File.join(File.dirname(file), File.basename(file, '.lzx')+'.swf')
     rm_f output
     raise "Unable to remove output file: #{output}" if File.exists?(output)
     begin
-      result = OpenLaszlo::compile file, *options
+      result = OpenLaszlo::compile(file, *options)
       assert_same_file output, result[:output]
       assert File.exists?(output), "#{output} does not exist"
       return result
@@ -51,14 +51,14 @@ module CompilerTestHelper
     def test_compilation_warning
       result = compile 'compilation-warning.lzx'
       assert_instance_of Array, result[:warnings]
-      assert_equal 2, result[:warnings].length
+      assert_equal 1, result[:warnings].length
       assert_match /^compilation-warning.lzx:1:36/, result[:warnings].first
     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
+      assert_match /^compilation-error.lzx:3:1: XML document structures must start and end within the same entity\./, ex.message
     end
   end
 end
@@ -68,7 +68,10 @@ class CompileServerTest < Test::Unit::TestCase
   
   def setup
     OpenLaszlo::compiler = nil
-    @test_dir = File.join(ENV['OPENLASZLO_HOME'], 'tmp/ropenlaszlo-tests')
+    home = ENV['OPENLASZLO_HOME']
+    dirs = Dir[File.join(home, 'Server', 'lps-*', 'WEB-INF')]
+    home = File.dirname(dirs.first) if dirs.any?
+    @test_dir = File.join(home, 'tmp/ropenlaszlo-tests')
     mkdir_p @test_dir
   end
   
@@ -80,13 +83,13 @@ class CompileServerTest < Test::Unit::TestCase
   private
   alias :saved_compile :compile
   
-  def compile file, output=nil, options={}
+  def compile(file, output=nil, options={})
     raise "unimplemented" if output
     file = testfile_pathname file
-    server_local_file = File.join @test_dir, File.basename(file)
+    server_local_file = File.join(@test_dir, File.basename(file))
     cp file, server_local_file
     begin
-      saved_compile server_local_file, output, options
+      saved_compile(server_local_file, output, options)
     ensure
       rm_f server_local_file
     end

metadata

@@ -1,74 +1,80 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: ropenlaszlo
 version: !ruby/object:Gem::Version 
-  version: "0.5"
-date: 2008-04-01 00:00:00 -04:00
-summary: Ruby interface to OpenLaszlo.
-require_paths: 
-- lib
-email: steele@osteele.com
-homepage: http://ropenlaszlo.rubyforge.org
-rubyforge_project: ropenlaszlo
-description: ROpenLaszlo is an interface to the OpenLaszlo compiler.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.6.3
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Oliver Steele
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-23 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: ROpenLaszlo is an interface to the OpenLaszlo compiler.
+email: steele@osteele.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+- CHANGES.rdoc
+- TODO.rdoc
 files: 
-- CHANGES
-- examples/compile_hello.rb
-- examples/hello.lzx
-- install.rb
+- lib/openlaszlo
 - lib/openlaszlo/applet.rb
 - lib/openlaszlo/compiler.rb
 - lib/openlaszlo.rb
 - lib/ropenlaszlo.rb
+- lib/tasks
 - lib/tasks/openlaszlo.rake
-- LICENSE
-- Manifest
-- README
 - test/compilation-error.lzx
 - test/compilation-warning.lzx
 - test/compiler_test.rb
+- test/tasks
 - test/tasks/Rakefile
 - test/tasks/test.lzx
+- test/tasks/test.swf
 - test/test.lzx
 - test/test_utils.rb
-- TODO
-- ropenlaszlo.gemspec
-test_files: 
-- test/compiler_test.rb
+- README.rdoc
+- MIT-LICENSE
+- CHANGES.rdoc
+- TODO.rdoc
+has_rdoc: true
+homepage: http://github.com/osteele/ropenlaszlo
+post_install_message: 
 rdoc_options: 
 - --title
-- "ROpenLaszlo: Ruby interface to OpenLaszlo"
-- --main
-- README
+- "ROpenLaszlo: Ruby interface to the OpenLaszlo compiler"
 - --exclude
 - test/.*
-extra_rdoc_files: 
-- README
-- CHANGES
-- TODO
-- LICENSE
-executables: []
-
-extensions: []
-
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: ropenlaszlo
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Ruby interface to the OpenLaszlo compiler.
+test_files: []
 

data/Manifest

@@ -1,20 +0,0 @@
-CHANGES
-examples/compile_hello.rb
-examples/hello.lzx
-install.rb
-lib/openlaszlo/applet.rb
-lib/openlaszlo/compiler.rb
-lib/openlaszlo.rb
-lib/ropenlaszlo.rb
-lib/tasks/openlaszlo.rake
-LICENSE
-Manifest
-README
-test/compilation-error.lzx
-test/compilation-warning.lzx
-test/compiler_test.rb
-test/tasks/Rakefile
-test/tasks/test.lzx
-test/test.lzx
-test/test_utils.rb
-TODO

data/examples/compile_hello.rb

@@ -1,4 +0,0 @@
-require 'ropenlaszlo'
-
-OpenLaszlo::compile 'hello.lzx'
-# Now view hello.swf in a browser.

data/examples/hello.lzx

@@ -1,5 +0,0 @@
-<canvas>
-  <window>
-    <button>Hello, World!</button>
-  </window>
-</canvas>

data/ropenlaszlo.gemspec

@@ -1,53 +0,0 @@
-
-# Gem::Specification for Ropenlaszlo-0.5
-# Originally generated by Echoe
-
-Gem::Specification.new do |s|
-  s.name = %q{ropenlaszlo}
-  s.version = "0.5"
-  s.date = %q{2008-04-01}
-  s.summary = %q{Ruby interface to OpenLaszlo.}
-  s.email = %q{steele@osteele.com}
-  s.homepage = %q{http://ropenlaszlo.rubyforge.org}
-  s.rubyforge_project = %q{ropenlaszlo}
-  s.description = %q{ROpenLaszlo is an interface to the OpenLaszlo compiler.}
-  s.has_rdoc = true
-  s.authors = ["Oliver Steele"]
-  s.files = ["CHANGES", "examples/compile_hello.rb", "examples/hello.lzx", "install.rb", "lib/openlaszlo/applet.rb", "lib/openlaszlo/compiler.rb", "lib/openlaszlo.rb", "lib/ropenlaszlo.rb", "lib/tasks/openlaszlo.rake", "LICENSE", "Manifest", "README", "test/compilation-error.lzx", "test/compilation-warning.lzx", "test/compiler_test.rb", "test/tasks/Rakefile", "test/tasks/test.lzx", "test/test.lzx", "test/test_utils.rb", "TODO", "ropenlaszlo.gemspec"]
-  s.test_files = ["test/compiler_test.rb"]
-  s.rdoc_options = ["--title", "ROpenLaszlo: Ruby interface to OpenLaszlo", "--main", "README", "--exclude", "test/.*"]
-  s.extra_rdoc_files = ["README", "CHANGES", "TODO", "LICENSE"]
-end
-
-
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# require 'rubygems'
-# require 'echoe'
-# 
-# PKG_VERSION = '0.5'
-# 
-# Echoe.new('ropenlaszlo', PKG_VERSION) do |p|
-#   p.summary       = "Ruby interface to OpenLaszlo."
-#   p.url           = 'http://ropenlaszlo.rubyforge.org'
-#   p.description    = <<-EOF
-#     ROpenLaszlo is an interface to the OpenLaszlo compiler.
-# EOF
-#   p.author         = 'Oliver Steele'
-#   p.email          = 'steele@osteele.com'
-#   p.ignore_pattern = /^(.git|.*\.swf|.*#.*#)$/
-#   p.test_pattern   = 'test/*_test.rb'
-#   p.rdoc_pattern   = /^(lib|bin|tasks|ext)|^README|^CHANGES|^TODO|^LICENSE$/
-#   p.eval = proc do |s|
-#     s.rdoc_options <<
-#       '--title' << "ROpenLaszlo: #{s.summary.sub(/.$/,'')}" <<
-#       '--main' << 'README' <<
-#       '--exclude' << 'test/.*'
-#     s.extra_rdoc_files = ['README', 'CHANGES', 'TODO', 'LICENSE']
-#   end
-# end
-# 
-# desc "Really a replacement for echoe's 'install', which bombs on my machine"
-# task :reinstall => [:clean, :package, :uninstall] do
-#   system "sudo gem install pkg/*.gem"
-# end