ropenlaszlo 0.6.3 → 0.7.0

data/CHANGES.rdoc

@@ -1,5 +1,9 @@
 = Change Log
 
+== Version 0.7 (2009-03-30)
+* add method to create a symbolic from the OpenLaszlo directory
+
+
 == Version 0.6.3 (2009-03-23)
 * unquote html entities in errors and warnings
 

data/README.rdoc

@@ -1,10 +1,12 @@
 = ROpenLaszlo: Interface to the OpenLaszlo compiler
 
-ROpenLaszo is a Ruby interface to the OpenLaszlo[openlaszlo.org] compiler.  It allows you to compile Open<tt></tt>Laszlo programs from within Ruby, in order to integrate Open<tt></tt>Laszlo development into Rake or Rails applications.
+ROpenLaszo is a Ruby interface to the OpenLaszlo[openlaszlo.org] compiler.  It allows you to compile Open<tt></tt>Laszlo programs from within Ruby, in order to integrate Open<tt></tt>Laszlo development into Rake files or Rails applications.
 
-If you are using Open<tt></tt>Laszlo with Ruby on Rails, you probably want the {OpenLaszlo Rails plugin}[laszlo-plugin.rubyforge.org] as well.
+If you are using Open<tt></tt>Laszlo with Ruby on Rails, you want the {OpenLaszlo Rails plugin}[laszlo-plugin.rubyforge.org] too.  That page contains instructions for installing both the gem and the plugin; you can read those instructions instead of these.
 
-OpenLaszlo[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 Open<tt></tt>Laszlo compiler.  For example, if hello.lzx contains the following text:
+== Overview
+
+Open<tt></tt>Laszlo programs are written in XML with embedded JavaScript, and compiled into either Flash (swf) binary files, or DHTML.  The APIs in this library make it easy for Ruby code to invoke the Open<tt></tt>Laszlo compiler.  For example, if hello.lzx contains the following text:
   <canvas>
     <window>
       <button>Hello, World!</button>
@@ -37,37 +39,47 @@ The following includes such a task:
 0:: Download and install the {OpenLaszlo SDK}[openlaszlo.org]
 
 1: Install this gem
-  $ gem install osteele-ropenlaszlo -s http://gems.github.com
+  $ sudo gem install ropenlaszlo
 
 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+.
 
 <b>Note:</b> The command-line compiler is broken in the Windows version of Open<tt></tt>Laszlo 3.1.1.  If you are running Windows, step (3) is required.  ({OpenLaszlo bug 1428}[http://www.openlaszlo.org/jira/browse/LPP-1428])
 
-== Additional Resources
+== Tips
 
-* The {OpenLaszlo web site}[openlaszlo.org] is a rich source of information about the Open<tt></tt>Laszlo platform.  It includes links to the wiki, mailing lists, and forums.
+The Ruby front end to the compiler uses two compilation methods.  If OPENLASZLO_URL is set, and the source file is in a subdirectory of the OpenLaszlo servlet directory, then the compiler will request the URL that corresponds to the source location.  Otherwise, the OpenLaszlo command-line compiler is used.
+
+If the compiler is going to be invoked more than once (because several files are being compiled, or because the compiler is being used in an edit/compile/run cycle), the compile server is faster.
+
+You can place a symbolic link to a source directory in the OpenLaszlo servlet directory thus:
+  require 'openlaszlo/utils'
+  OpenLaszlo::symlink_to '.'
 
-* The {Laszlo on Rails}[groups.google.com/group/laszlo-on-rails] news group discusses the integration of Open<tt></tt>Laszlo with Ruby on Rails.
 
-* The {OpenLaszlo Rails plugin}[laszlo-plugin.rubyforge.org] provides generators and scaffolding for using Open<tt></tt>Laszlo with Ruby on Rails.
+== Additional Resources
+
+* The {OpenLaszlo Rails plugin}[laszlo-plugin.rubyforge.org] provides generators, view tasks, and rake tasks for using Open<tt></tt>Laszlo with Ruby on Rails.
+
+* The {OpenLaszlo web site}[openlaszlo.org] is a rich source of information about the Open<tt></tt>Laszlo platform.  It includes links to the wiki, mailing lists, and forums.
 
 * {This OpenLaszlo Blog entry}[weblog.openlaszlo.org/archives/2006/01/deploying-openlaszlo-applications-with-rake/] has additional information and some examples of using ROpenLaszlo in a Rakefile.
 
-* The RubyForge project page is here[http://rubyforge.org/projects/ropenlaszlo/].
+* {ROpenLaszlo RubyForge project page}[http://rubyforge.org/projects/ropenlaszlo/]
+
+* {ROpenLaszlo git repository}[http://github.com/osteele/ropenlaszlo]
 
 
 == Author
 
-Oliver Steele
-steele@osteele.com
+Oliver Steele <steele@osteele.com>
 
 
 == License
 
-ROpenLaszlo is copyright (c) 2006 - 2009 by Oliver Steele.  It is
+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
+MIT license. The text of this license is included in the ROpenLaszlo
 distribution.

data/lib/openlaszlo/applet.rb

@@ -1,6 +1,3 @@
-# Author:: Oliver Steele
-# Copyright:: Copyright (c) 2005-2008 Oliver Steele.  All rights reserved.
-# License:: MIT License
 module OpenLaszlo
   class Applet
     attr_reader :source
@@ -16,13 +13,13 @@ module OpenLaszlo
 
     def compile(target=nil, options={})
       target ||= source + '.swf'
-      return if up2date?(target) unless options[:force]
+      return if uptodate?(target) unless options[:force]
 
       puts "Compiling #{source} -> #{target}" if options[:verbose]
       OpenLaszlo::compile(source, options)
     end
 
-    def up2date?(target=nil)
+    def uptodate?(target=nil)
       target ||= source + '.swf'
       return false unless File.exists?(target)
       sources = Dir["#{source_dir}/**/*"].reject { |fname| fname =~ /\.lzx\.swf/ } -

data/lib/openlaszlo/utils.rb

@@ -0,0 +1,21 @@
+module OpenLaszlo
+  # Create a symbolic link to +source+ from the OpenLaszlo directory, so that
+  # (if allowLinks[http://wiki.github.com/osteele/openlaszlo-plugin/using-the-compile-server]
+  # is enabled) the server compiler can be used on files in this directory.
+  # The link will have the same name as the source directory, if +name+ is nil.
+  def self.symlink_to(source, name=nil)
+    home = ENV['OPENLASZLO_HOME']
+    raise "OPENLASZLO_HOME isn't set" unless home
+    source = File.expand_path(source)
+    name ||= File.basename(source)
+    target_dir = Dir[File.join(home, 'Server', 'lps-*')][0]
+    raise "Can't find LPS subdirectory in #{home}" unless File.directory?(target_dir)
+    target = File.join(target_dir, name)
+    if File.exists?(target)
+      return if File.ftype(target) == 'link' and File.readlink(target) == source
+      raise "#{target} already exists"
+    end
+    File.symlink source, target
+    return target
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ropenlaszlo
 version: !ruby/object:Gem::Version 
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors: 
 - Oliver Steele
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-23 00:00:00 -04:00
+date: 2009-03-30 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +28,7 @@ files:
 - lib/openlaszlo
 - lib/openlaszlo/applet.rb
 - lib/openlaszlo/compiler.rb
+- lib/openlaszlo/utils.rb
 - lib/openlaszlo.rb
 - lib/ropenlaszlo.rb
 - lib/tasks
@@ -53,6 +54,8 @@ rdoc_options:
 - "ROpenLaszlo: Ruby interface to the OpenLaszlo compiler"
 - --exclude
 - test/.*
+- --main
+- README.rdoc
 - --inline-source
 - --charset=UTF-8
 require_paths: