ropenlaszlo 0.2.0

data/doc/CHANGES

@@ -0,0 +1,13 @@
+= Change Log
+
+== Version 0.2.0 (2006/01/11)
+* Released as gem
+* Published to rubyforge
+* Added doc directory
+* Added test directory
+* Added examples directory
+
+== Version 0.1.0 (2006/01/04)
+* Initial release
+* Published to osteele.com
+* Announced on weblog.openlaszlo.org

data/doc/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2003, 2004 Jim Weirich
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/doc/README

@@ -0,0 +1,37 @@
+= ROpenLaszlo Interface to the OpenLaszlo Platform
+
+ROpenLaszo is a Ruby interface to the OpenLaszlo[http://openlaszlo.org] platform for creating rich internet applicatons.  It allows you to compile OpenLaszlo[http://openlaszlo.org] programs from within Ruby, in order to integrate OpenLaszlo[http://openlaszlo.org] development into Rake or Rails applications.
+
+OpenLaszlo[http://openlaszlo.org] programs are written in XML with embedded JavaScript, and compiled into Flash (swf) binary files, or DHTML.  (As of this writing, the DHTML target is in pre-beta form.)  The APIs in this library make it easy for Ruby code to invoke the OpenLaszlo[http://openlaszlo.org] compiler.  For example, if hello.lzx contains the following text:
+  <canvas>
+    <window>
+      <button>Hello, World!</button>
+    </window>
+  </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'
+
+== Requirements
+
+* {OpenLaszlo 3.1}[http://openlaszlo.org]
+* Ruby -v 1.8.2 or later (untested in earlier versions)
+
+== Downloading and Installation
+
+ROpenLaszlo is distributed as a RubyGem.  You may download it from ROpenLaszlo's {RubyForge project}[http://rubyforge.org/projects/ropenlaszlo].
+
+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:
+
+  gem install ropenlaszlo
+
+== 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+.)
+
+== 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 licences is included in the
+ROpenLaszlo distribution, under the +doc+ subdirectory.

data/doc/TODO

@@ -0,0 +1,18 @@
+= ROpenLaszlo Project -- To Do List
+
+== Compiler
+* Dependency tracking
+* Detect when file is not present
+* Class for compiler configuration errors
+
+== 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

@@ -0,0 +1,217 @@
+# Author:: Oliver Steele
+# Copyright:: Copyright (c) 2005-2006 Oliver Steele.  All rights reserved.
+# License:: Ruby License.
+#
+# This module contains utility methods for compiling OpenLaszlo[http://openlaszlo.org] programs.  See the OpenLaszlo module documentation for usage information.
+# 
+#--
+# Bugs:
+# - syntax error compiles swf anyway
+#
+# Todo:
+# - unit tests
+# - doc :profile
+#
+# Wishlist:
+# - compile_string
+# - detect compiler version
+# - select compiler based on file location; or, copy files
+# - retrieve dependencies
+# - retrieve compiler warnings
+#
+# Corners:
+# - detect invalid parameters
+# - server isn't running
+# - lps-dev/foo isn't inside lps
+
+ 
+# == module OpenLaszlo
+# 
+# This module contains utility methods for compiling OpenLaszlo[http://openlaszlo.org] programs.
+#
+# Example:
+#   # Set up the environment to use the compile server.  The OpenLaszlo server
+#   # must be running in order at this location in order for this to work.
+#   ENV['OPENLASZLO_HOME'] = '/Applications/OpenLaszlo Server 3.1'
+#   ENV['OPENLASZLO_URL'] = 'http://localhost:8080/lps-3.1'
+#
+#   require 'openlaszlo'
+#   # Create a file 'hello.swf' in the current directory:
+#   OpenLaszlo::compile 'hello.lzx'
+#
+# See OpenLaszlo.compile for additional documentation.
+# 
+module OpenLaszlo
+  # This class implements a bridge to the compile server.
+  #
+  # If you don't need multiple compilers, you can use the methods in
+  # the OpenLaszlo module instead.
+  #
+  # The compile server is faster than CommandLineCompiler, but can only compile
+  # files in the same directory as the {OpenLaszlo SDK}[http://openlaszlo.org].
+  class CompileServer
+    # Options:
+    # * <tt>:openlaszlo_home</tt> - filesystem location of the OpenLaszlo SDK.  Defaults to EVN['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 params={}
+      @home = params[:home] || ENV['OPENLASZLO_HOME']
+      @base_url = params[:server_uri] || ENV['OPENLASZLO_URL'] || 'http://localhost:8080/lps-dev'
+    end
+    
+    # Invokes the OpenLaszlo server-based compiler on +source_file+.
+    # +source_file+ must be inside the home directory of the server.
+    # See OpenLaszlo.compile for a description of the +params+.
+    #
+    # Additional options:
+    # * <tt>:format</tt> - request type (default 'swf')
+    def compile source_file, params={}
+      require 'net/http'
+      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, '/')
+      output = params[:output] || "#{File.basename source_file, '.lzx'}.swf"
+      options = {
+        :lzr => params[:runtime],
+        :debug => params[:debug],
+        :lzproxied => params[:proxied] == nil ? params[:proxied] : false,
+        :lzt => params[:format] || 'swf'}
+      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|
+        case response
+        when Net::HTTPOK
+          File.open(output, 'w') do |f|
+            response.read_body do |segment|
+              f << segment
+            end
+          end
+        else
+          response.value # raises error
+        end
+      end
+      return output
+    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
+  # the OpenLaszlo module instead.
+  #
+  # The command-line compiler is slower than CompileServer, but,
+  # unlike the server, it can compile files in any location.
+  class CommandLineCompiler
+    # Creates a new compiler.
+    #
+    # Options are:
+    # * <tt>:compiler_script</tt> - the path to the shell script that
+    # invokes the compiler.  This defaults to a standard location inside
+    # the value specified by :home.
+    # * <tt>:openlaszlo_home</tt> - the home directory of the OpenLaszlo SDK.
+    # This defaults to ENV['OPENLASZLO_HOME'].
+    def initialize params={}
+      @lzc = params[:compiler_script]
+      unless @lzc
+        home = params[:openlaszlo_home] || ENV['OPENLASZLO_HOME']
+        raise ":compiler_script or :openlaszlo_home must be specified" unless home
+        search = lzc_directories.map{|f| File.join(home, f, 'lzc')}
+        found = search.select{|f| File.exists? f}
+        raise "couldn't find bin/lzc in #{search.join(' or ')}" if found.empty?
+        @lzc = found.first
+        # Adjust the name for Windows
+        @lzc += '.bat' if windows?
+      end
+    end
+    
+    # Invokes the OpenLaszlo command-line compiler on +source_file+.
+    #
+    # See OpenLaszlo.compile for a description of the +params+.
+    def compile source_file, params={}
+      default_output = File.basename(source_file, '.lzx') + '.swf'
+      output = params[:output] || default_output
+      # TODO: could handle this case by compiling to a temporary directory and
+      # renaming from there
+      raise "#{source_file} and #{output} do not have the same basename." unless File.basename(source_file, '.lzx') == File.basename(output, '.swf')
+      args = []
+      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}'`
+    end
+    
+    private
+    
+    # Locations in which to look for the lzc script, relative to OPENLASZLO_HOME
+    def lzc_directories
+      [# binary distro location
+        'bin',
+        # binary distro location
+        '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
+    return @compiler if @compiler
+    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.
+
+To use the compile server (recommended), set ENV['OPENLASZLO_URL'] and ENV['OPENLASZLO_HOME'].
+
+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[http://openlaszlo.org] source file.
+  #
+  # Examples:
+  #   require 'openlaszlo'
+  #   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', :output => 'hello-world.swf' # server only
+  #
+  # Options are:
+  # * <tt>:debug</tt> - debug mode (default false)
+  # * <tt>:output</tt> - specify the name and location for the output file (default = input_file.sub(/\.lzx$/, '.swf'))
+  # * <tt>:proxied</tt> - is application proxied (default true)
+  # * <tt>:runtime</tt> - runtime (default swf7)
+  #
+  # See CompileServer.compile and CommandLineCompiler.compile for additional options
+  # that are specific to these compilers.
+  def self.compile source_file, params={}
+    compiler.compile source_file, params
+  end
+  
+  def self.make_html source_file, params={} #:nodoc:
+    raise 'not really supported, for now'
+    params = {
+      :format => 'html-object',
+      :output => File.basename(source_file, '.lzx')+'.html'}.update(params)
+    compiler.compile source_file, params
+    source_file = params[:output]
+    s = open(source_file).read
+    open(source_file, 'w') {|f| f.write s.gsub!(/\.lzx\?lzt=swf&amp;/, '.lzx.swf?')}
+  end
+end

data/lib/ropenlaszlo.rb

@@ -0,0 +1,5 @@
+# Author:: Oliver Steele
+# Copyright:: Copyright (c) 2005-2006 Oliver Steele.  All rights reserved.
+# License:: Ruby License.
+
+require 'compiler'

data/test/compiler_test.rb

@@ -0,0 +1,131 @@
+# Author:: Oliver Steele
+# Copyright:: Copyright (c) 2005-2006 Oliver Steele.  All rights reserved.
+# License:: Ruby License.
+
+$:.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'test/unit'
+require 'ropenlaszlo'
+require 'fileutils'
+
+include FileUtils
+
+REQUIRED_ENV_VALUES = %w{OPENLASZLO_HOME OPENLASZLO_HOME}
+unless REQUIRED_ENV_VALUES.reject {|w| ENV[w]}.empty?
+  raise "These environment variables must be set: #{REQUIRED_ENV_VALUES}.join(', ')"
+end
+
+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
+
+module CompilerTestHelper
+  def super_setup
+    OpenLaszlo::compiler = nil
+    cd File.dirname(__FILE__)
+  end
+  
+  private
+  def compile file, output=nil, options={}
+    output = File.basename(file, '.lzx')+'.swf'
+    rm_f output
+    begin
+      OpenLaszlo::compile file, *options
+      assert File.exists?(output), "#{output} does not exist"
+    ensure
+      rm_f output
+    end
+  end
+end
+
+class CompileServerTest < Test::Unit::TestCase
+  include CompilerTestHelper
+  
+  def setup
+    @test_dir = File.join(ENV['OPENLASZLO_HOME'], 'ropenlaszlo-tests')
+    mkdir @test_dir
+    super_setup
+  end
+  
+  def teardown
+    rm_rf @test_dir
+  end
+    
+  def test_compilation
+    compile 'test.lzx'
+  end
+  
+  private
+  alias :saved_compile :compile
+  
+  def compile file, output=nil, options={}
+    server_local_file = File.join @test_dir, File.basename(file)
+    cp file, server_local_file
+    begin
+      saved_compile server_local_file, output, options
+    ensure
+      rm_f server_local_file
+    end
+  end
+end
+
+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
+  end
+  
+  def teardown
+    ENV.update @saved_bindings
+  end
+  
+  def test_compilation
+    compile 'test.lzx'
+  end
+end
+
+class CompilerFacadeTest < Test::Unit::TestCase
+  def setup
+    raise "ENV['OPENLASZLO_URL'] must be set" unless ENV['OPENLASZLO_URL']
+    raise "ENV['OPENLASZLO_HOME'] must be set" unless ENV['OPENLASZLO_HOME']
+    OpenLaszlo::compiler = nil
+  end
+  
+  def test_select_server
+    assert_instance_of OpenLaszlo::CompileServer, OpenLaszlo::compiler
+  end
+  
+  def test_select_commandline
+    ENV.with_bindings 'OPENLASZLO_URL' => nil do
+      assert_instance_of OpenLaszlo::CommandLineCompiler, OpenLaszlo::compiler
+    end
+  end
+  
+  def test_missing_home
+    ENV.with_bindings 'OPENLASZLO_HOME' => nil do
+      assert_raise(RuntimeError) do OpenLaszlo::compiler end
+    end
+  end
+end

data/test/test.lzx

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+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
+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: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Oliver Steele
+files: 
+- lib/compiler.rb
+- lib/ropenlaszlo.rb
+- doc/CHANGES
+- doc/MIT-LICENSE
+- doc/README
+- doc/TODO
+- test/compiler_test.rb
+- test/test.lzx
+test_files: []
+
+rdoc_options: 
+- --title
+- ROpenLaszlo -- Ruby interface to OpenLaszlo
+- --main
+- doc/README
+extra_rdoc_files: 
+- doc/CHANGES
+- doc/MIT-LICENSE
+- doc/README
+- doc/TODO
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+