osteele-ropenlaszlo 0.5.1 → 0.6.0

data/CHANGES

@@ -1,25 +1,33 @@
 = Change Log
 
-== Version 0.5.1 (2009/03/22)
-* update for compatibility with OpenLaszlo 4.x
-* move to github
+== Version 0.6 (2009-03-23)
+* follow symbolic links
+* reorganize directory structure
+* new rake task file
+* 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
 
-== Version 0.5 (2009/03/22)
+
+== Version 0.5 (2009-03-22)
 * update for compatibility with OpenLaszlo 4.x
 * move to github
 
-== Version 0.4.1 (2006/01/25)
+
+== Version 0.4.1 (2006-01-25)
 * bug fix: don't use popen on Windows
 * bug fix: default LPS_HOME from OPENLASZLO_HOME
 * added note about OpenLaszlo windows bug
 
-== Version 0.4.0 (2006/01/19)
+
+== Version 0.4.0 (2006-01-19)
 * new feature: command-line compiler detects compilation warnings
 * bug fix: command-line compilation in qualified directory places object in same directory
 * improve rdoc
 * refactored unit tests
 
-== Version 0.3.0 (2006/01/16)
+
+== Version 0.3.0 (2006-01-16)
 * New feature: compilation errors and warnings
 * Bug fix: --output doesn't exist; --dir does
 * refactored test case setup
@@ -28,14 +36,16 @@
 * Updated installation instructions
 * Fixed rdoc formatting errors
 
-== Version 0.2.0 (2006/01/11)
+
+== Version 0.2.0 (2006-01-11)
 * Released as gem
 * Moved to rubyforge
 * Added doc directory
 * Added test directory
 * Added examples directory
 
-== Version 0.1.0 (2006/01/04)
+
+== Version 0.1.0 (2006-01-04)
 * Initial release
 * Published to osteele.com
 * Announced on weblog.openlaszlo.org

data/README.rdoc

@@ -12,8 +12,8 @@ OpenLaszlo[openlaszlo.org] programs are written in XML with embedded JavaScript,
   </canvas>
 then the following Ruby code can be used to create a file 'hello.swf' which can be executed in a browser or placed on a web site:
   require 'rubygems'
-  require 'ropenlaszlo'
-  OpenLaszlo::compile 'hello.lzx'
+  require 'openlaszlo'
+  OpenLaszlo::compile 'hello.lzx' # creates hello.swf
 
 You can turn this snippet into a Rake task that will compile any Open<tt></tt>Laszlo source file:
   rule '.swf' => '.lzx' do |t|
@@ -21,6 +21,11 @@ You can turn this snippet into a Rake task that will compile any Open<tt></tt>La
     OpenLaszlo::compile t.source, :output => t.name
   end
 
+The following includes such a task:
+  require 'openlaszlo'
+  load 'tasks/openlaszlo.rake'
+  # defines a pattern *.lzx -> *.swf
+
 == Requirements
 
 * {OpenLaszlo 3.1 or later}[openlaszlo.org]
@@ -53,6 +58,13 @@ You can turn this snippet into a Rake task that will compile any Open<tt></tt>La
 
 * The RubyForge project page is here[http://rubyforge.org/projects/ropenlaszlo/].
 
+
+== Author
+
+Oliver Steele
+steele@osteele.com
+
+
 == License
 
 ROpenLaszlo is copyright (c) 2006 - 2009 by Oliver Steele.  It is

data/TODO

@@ -1,21 +1,20 @@
 = ROpenLaszlo Project -- To Do List
 
 == Features
-* Add rake task file
-* Compile server: allow use of proxy?
-* Compile server: temporarily copy files into webapp directory
+* Compiler server: test whether allow_links=true
+* Compile server: add alias to source directory
+* Dependency tracking: switch to hpricot
 * compile_string
-* Dependency tracking
 * query compiler version
 
 == Unit Tests
+* "Runtime" option
+* Fallback to command-line compiler
 * Compiler parameters
 * Missing source file
 * Unreachable server
 * Invalid OPENLASZLO_HOME
 
 == Corners
-* invalid parameters
 * server isn't running
 * thinks lps-dev/foo is in lps/ directory
-

data/lib/openlaszlo.rb

@@ -0,0 +1 @@
+require 'ropenlaszlo'

data/lib/openlaszlo/applet.rb

@@ -0,0 +1,81 @@
+# Author:: Oliver Steele
+# Copyright:: Copyright (c) 2005-2008 Oliver Steele.  All rights reserved.
+# License:: MIT License
+module OpenLaszlo
+  class Applet
+    attr_reader :source
+
+    def initialize(source)
+      source = source + '.lzx' unless source =~ /\.lzx$/
+      @source = source
+    end
+
+    def source_dir
+      File.dirname(source)
+    end
+
+    def compile(target=nil, options={})
+      target ||= source + '.swf'
+      return if up2date?(target) unless options[:force]
+
+      puts "Compiling #{source} -> #{target}" if options[:verbose]
+      OpenLaszlo::compile(source, options)
+    end
+
+    def up2date?(target=nil)
+      target ||= source + '.swf'
+      return false unless File.exists?(target)
+      sources = Dir["#{source_dir}/**/*"].reject { |fname| fname =~ /\.lzx\.swf/ } -
+        Dir["#{source_dir}/build/**/*"]
+      source_mtime = sources.
+        # the 'rescue' ignores symbolic links without targets
+        map { |f| File.mtime(f) rescue nil }.
+        compact.
+        max
+      source_mtime < File.mtime(target)
+    end
+
+    def runtime_assets
+      dir = File.dirname(source)
+      includes = `grep -h http: #{dir}/*.lzx`.scan(/http:(.*?)['"]/).
+        map(&:first)
+      includes += `grep -h http: #{dir}/*/*.lzx`.scan(/http:(.*?)['"]/).
+        map(&:first).
+        map { |s| s.sub(/^\.\.\//, '') }
+      return includes.
+        uniq.
+        map { |f| File.join(dir, f) }.
+        select { |src| File.exists?(src) && File.ftype(src) != 'directory' }
+    end
+
+    def preprocess_to(dir, options={})
+      files = Dir[File.join(source_dir, '**/*.js')] - Dir[File.join(source_dir, '.hg')]
+      files.each do |src|
+        dst = File.join(dir, src.sub(source_dir, ''))
+        next if File.exists?(dst) and (!options[:force] and File.mtime(dst) > File.mtime(src))
+        puts "Copy #{src} #{dst}"
+        content = preprocess_string(open(src).read)
+        open(dst, 'w') do |fo| fo << content end
+      end.length
+    end
+
+    def preprocess_string(content)
+      re = /^\s*([a-zA-Z][a-zA-Z0=9]*)\.each\(function\(([a-zA-Z][a-zA-Z0-9]*)\)\{(.*?)}\);/m
+      content.gsub!(re) do |s|
+        target, var, body = s.match(re).captures
+        "var $0=#{target}, $1=$0.length;for(var $2=0; $1--;){var #{var}=$0[$2++];#{body}}"
+      end
+      return content
+    end
+
+    #
+    # Class methods
+    #
+
+    def self.compile(basename, target, options={})
+      source = "lzx/#{basename}"
+      target = "public/#{target}"
+      self.new(source).compile(target, options)
+    end
+  end
+end

data/lib/{compiler.rb → openlaszlo/compiler.rb}

@@ -1,9 +1,9 @@
 # Author:: Oliver Steele
-# Copyright:: Copyright (c) 2005-2006 Oliver Steele.  All rights reserved.
-# License:: Ruby License.
- 
+# Copyright:: Copyright (c) 2005-2008 Oliver Steele.  All rights reserved.
+# License:: MIT License
+
 # == module OpenLaszlo
-# 
+#
 # This module contains utility methods for compiling
 # OpenLaszlo[openlaszlo.org] programs.
 #
@@ -18,10 +18,11 @@
 #   OpenLaszlo::compile 'hello.lzx'
 #
 # See OpenLaszlo.compile for additional documentation.
-# 
+#
 module OpenLaszlo
   class CompilationError < StandardError; end
-  
+  class InvalidSourceLocation < StandardError; end
+
   # This class implements a bridge to the compile server.
   #
   # If you don't need multiple compilers, you can use the methods in
@@ -39,7 +40,7 @@ module OpenLaszlo
       @home = File.dirname(dirs.first) if dirs.any?
       @base_url = options[:server_uri] || ENV['OPENLASZLO_URL'] || 'http://localhost:8080/lps-dev'
     end
-    
+
     # Invokes the Open<tt></tt>Laszlo server-based compiler on
     # +source_file+.  +source_file+ must be inside the home directory
     # of the server.
@@ -58,7 +59,7 @@ module OpenLaszlo
       raise CompilationError.new(results[:error]) if results[:error]
       return results
     end
-    
+
     private
     def compile_object(source_file, object, options={})
       options = {}.update(options).update(:output => object)
@@ -70,7 +71,7 @@ module OpenLaszlo
       options = {}.update(options).update(:format => 'canvas-xml', :output => nil)
       text = request(source_file, options)
       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 }
       elsif text !~ %r{<canvas>} && text =~ %r{<pre>Error:\s*(.*?)\s*</pre>}m
         results[:error] = $1
       end
@@ -83,20 +84,32 @@ module OpenLaszlo
       require 'uri'
       # assert that pathname is relative to LPS home:
       absolute_path = File.expand_path(source_file)
-      raise "#{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, '/')
+      server_relative_path = nil
+      begin
+        # follow links
+        server_relative_path = Dir[File.join(@home, '*')].map do |file|
+          next unless File.ftype(file) == 'link'
+          dir = File.readlink(file)
+          next unless absolute_path.index(dir) == 0
+          File.join('/', File.basename(file), absolute_path[dir.length..-1])
+        end.compact.first
+      end
+      unless server_relative_path
+        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, '/')
+      end
       options = {
         :lzr => options[:runtime],
         :debug => options[:debug],
         :lzproxied => options.fetch(:proxied, false),
         :lzt => options[:format] || 'swf'}
-      query = options.map{|k,v|"#{k}=#{v}" unless v.nil?}.compact.join('&')
+      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
@@ -114,7 +127,7 @@ module OpenLaszlo
       end
     end
   end
-  
+
   # This class implements a bridge to the command-line compiler.
   #
   # If you don't need multiple compilers, you can use the methods in
@@ -136,14 +149,26 @@ module OpenLaszlo
       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}
+        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={})
+      home = options[:openlaszlo_home] || ENV['OPENLASZLO_HOME']
+      raise ":compiler_script or OPENLASZLO_HOME must be specified" unless home
+      path = bin_directories.
+        map { |f| File.join(home, f, 'lzc') }.
+        select { |f| File.exists? f }.
+        first
+      raise "couldn't find bin/lzc in #{bin_directories.join(' or ')}" unless path
+      path += '.bat' if windows?
+      return path
+    end
+    
     # Invokes the OpenLaszlo command-line compiler on +source_file+.
     #
     # See OpenLaszlo.compile for a description of +options+.
@@ -155,10 +180,11 @@ module OpenLaszlo
       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, output_suffix)
       args = []
-      args << '--runtime=#{options[:runtime]}' if options[:runtime]
+      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']
@@ -182,9 +208,9 @@ module OpenLaszlo
       results = {:output => output, :warnings => warnings}
       return results
     end
-    
+
     private
-    
+
     # Locations in which to look for the lzc script, relative to OPENLASZLO_HOME
     def bin_directories
       [# binary distro location
@@ -193,12 +219,12 @@ module OpenLaszlo
         'WEB-INF/lps/server/bin'
       ]
     end
-    
+
     def windows?
       RUBY_PLATFORM =~ /win/ and not RUBY_PLATFORM =~ /darwin/
     end
   end
-  
+
   # Returns the default compiler.  Use the server-based compiler if it's
   # available, since it's so much faster.
   def self.compiler
@@ -213,12 +239,12 @@ To use the compile server (recommended), set ENV['OPENLASZLO_URL'] and ENV['OPEN
 To use the command-line compiler, set ENV['OPENLASZLO_HOME'].
 EOF
   end
-  
+
   # Sets the default compiler for future invocations of OpenLaszlo.compile.
   def self.compiler=(compiler)
     @compiler = compiler
   end
-  
+
   # Compile an OpenLaszlo source file.
   #
   # Examples:
@@ -226,20 +252,24 @@ EOF
   #   OpenLaszlo::compile 'hello.lzx'
   #   OpenLaszlo::compile 'hello.lzx', :debug => true
   #   OpenLaszlo::compile 'hello.lzx', :runtime => 'swf8'
-  #   OpenLaszlo::compile 'hello.lzx', {:runtime => 'swf8', :debug => true}
+  #   OpenLaszlo::compile 'hello.lzx', :runtime => 'swf8', :debug => true
   #   OpenLaszlo::compile 'hello.lzx', :output => 'hello-world.swf'
   #
   # Options are:
   # * <tt>:debug</tt> - debug mode (default false)
   # * <tt>:output</tt> - specify the name and location for the output file (default = <tt>input_file.sub(/\.lzx$/, '.swf')</tt>)
   # * <tt>:proxied</tt> - is application proxied (default true)
-  # * <tt>:runtime</tt> - runtime (default swf7)
+  # * <tt>:runtime</tt> - runtime (default swf8)
   #
   # See CompileServer.compile and CommandLineCompiler.compile for
   # additional options that are specific to the compilation methods in
   # those classes.
   def self.compile(source_file, options={})
-    return compiler.compile source_file, options
+    options = options.clone
+    options[:runtime] ||= 'swf8'
+    compiler.compile(source_file, options)
+  rescue InvalidSourceLocation
+    CommandLineCompiler.new.compile(source_file, options)
   end
   
   def self.make_html(source_file, options={}) #:nodoc:
@@ -250,6 +280,8 @@ EOF
     compiler.compile(source_file, options)
     source_file = options[:output]
     s = open(source_file).read
-    open(source_file, 'w') {|f| f.write s.gsub!(/\.lzx\?lzt=swf&amp;/, '.lzx.swf?')}
+    open(source_file, 'w') do |f|
+      f << s.gsub!(/\.lzx\?lzt=swf&amp;/, '.lzx.swf?')
+    end
   end
 end

data/lib/ropenlaszlo.rb

@@ -2,4 +2,4 @@
 # Copyright:: Copyright (c) 2005-2006 Oliver Steele.  All rights reserved.
 # License:: Ruby License.
 
-require 'compiler'
+require 'openlaszlo/compiler'

data/lib/tasks/openlaszlo.rake

@@ -0,0 +1,6 @@
+require 'openlaszlo'
+
+rule '.swf' => '.lzx' do |t|
+  puts "Compiling #{t.source} => #{t.name}" if verbose
+  OpenLaszlo::compile t.source, :output => t.name
+end

data/test/compiler_test.rb

@@ -7,7 +7,7 @@ require File.join(File.dirname(__FILE__), 'test_utils.rb')
 
 include FileUtils
 
-REQUIRED_ENV_VALUES = %w{OPENLASZLO_HOME OPENLASZLO_HOME}
+REQUIRED_ENV_VALUES = %w{OPENLASZLO_HOME OPENLASZLO_URL}
 unless REQUIRED_ENV_VALUES.reject {|w| ENV[w]}.empty?
   raise "These environment variables must be set: #{REQUIRED_ENV_VALUES}.join(', ')"
 end

data/test/tasks/Rakefile

@@ -0,0 +1,2 @@
+require 'openlaszlo'
+load 'tasks/openlaszlo.rake'

data/test/tasks/test.lzx

@@ -0,0 +1 @@
+<canvas/>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: osteele-ropenlaszlo
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Oliver Steele
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-22 00:00:00 -07:00
+date: 2009-03-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,11 +25,21 @@ extra_rdoc_files:
 - CHANGES
 - TODO
 files: 
-- lib/compiler.rb
+- lib/openlaszlo
+- lib/openlaszlo/applet.rb
+- lib/openlaszlo/compiler.rb
+- lib/openlaszlo/compiler.rb.orig
+- lib/openlaszlo.rb
 - lib/ropenlaszlo.rb
+- lib/tasks
+- lib/tasks/openlaszlo.rake
 - 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
 - README.rdoc