epall-limelight 0.5.1-java → 0.5.2-java

data/lib/init.rb

@@ -1,16 +1,12 @@
 #- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
-$LIMELIGHT_LIB = File.expand_path(File.dirname(__FILE__))
-$: << $LIMELIGHT_LIB unless $:.include?($LIMELIGHT_LIB)
-$LIMELIGHT_HOME = File.expand_path(File.join($LIMELIGHT_LIB, ".."))
+
 
 require 'java'
 if File.exists?(File.dirname(__FILE__) + "/limelight.jar")
   require File.expand_path(File.dirname(__FILE__) + "/limelight.jar")
 end
 
+require File.expand_path(File.dirname(__FILE__) + "/limelight/limelight_init")
 
-# ENV["GEM_HOME"] = ENV["GEM_PATH"] = File.expand_path(File.dirname(__FILE__) + "/../../jruby/lib/ruby/gems/1.8")
-require 'rubygems'
-require 'limelight/java_couplings'

data/lib/limelight/builtin/utilities_production/alert/players/alert.rb

@@ -1,4 +1,7 @@
-module Alert
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
+#- Limelight and all included source files are distributed under terms of the GNU LGPL.
+
+module Alert #:nodoc:
 
   prop_reader :message
 

data/lib/limelight/builtin/utilities_production/production.rb

@@ -3,13 +3,17 @@
 
 require 'monitor'
 
-module Production
+module Production #:nodoc:
 
   def production_opening
     @monitor = Monitor.new
     @alert_monitor = @monitor.new_cond
   end
 
+  def allow_close?
+    return false
+  end
+
   def default_scene
     nil
   end
@@ -40,7 +44,7 @@ module Production
 
   def alert(message)
     @alert_monitor = @monitor.new_cond
-    load_alert_scene(message)
+    load_alert_scene(message.to_s)
     @monitor.synchronize{ @alert_monitor.wait }
     @alert_stage.close
     return @alert_response

data/lib/limelight/commands/create_command.rb

@@ -53,7 +53,7 @@ module Limelight
         raise "Missing template type" if @template_type.nil?
         raise "Unknown template type: #{@template_type}" if !["production", "scene"].include?(@template_type)
         self.send "parse_#{@template_type}".to_sym, args
-        @spec_path = File.join(@production_path, "spec") unless @spec_path
+        @spec_path = "spec" unless @spec_path
       end
 
       def do_requires #:nodoc:

data/lib/limelight/commands/open_command.rb

@@ -18,7 +18,7 @@ module Limelight
 
       install_as "open"
 
-      DEFAULT_PRODUCTION = File.expand_path($LIMELIGHT_HOME + "/productions/startup")
+      DEFAULT_PRODUCTION = File.expand_path($LIMELIGHT_HOME + "/productions/playbills.lll")
 
       attr_reader :drb_port
 
@@ -36,7 +36,7 @@ module Limelight
         return "<production_path>"
       end
 
-      def do_requires
+      def do_requires       
         Main.initialize_context
         require 'limelight/producer'
       end
@@ -50,8 +50,8 @@ module Limelight
       end
 
       def process
-        Studio.publish_on_drb(@drb_port.to_i) if @drb_port
-        Studio.open(@production_path)
+        Context.instance.studio.publish_on_drb(@drb_port.to_i) if @drb_port
+        Context.instance.studio.open(@production_path)
       end
 
     end

data/lib/limelight/dsl/styles_builder.rb

@@ -143,6 +143,11 @@ module Limelight
         raise StyleBuilderException.new("'#{sym}' is not a valid style") if !@__style.respond_to?(setter_sym)
         @__style.send(setter_sym, value.to_s)
       end
+
+      # Kernel.y was added by the yaml library in JRuby 1.4.  Not sure what to do about this type of problem.
+      def y(*args) #:nodoc:
+        method_missing(:y, *args)
+      end
     end
 
     # Exception thrown by StyleBuilder when an error is encountered.

data/lib/limelight/java_couplings.rb

@@ -1,11 +1,12 @@
 #- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
     
-module Limelight #:nodoc:
+module Limelight
 
   Main = Java::limelight.Main
   ResourceLoader = Java::limelight.ResourceLoader
   Context = Java::limelight.Context
+  Studio = Java::limelight.Studio
 
   module Background
     Animation = Java::limelight.background.Animation
@@ -50,7 +51,7 @@ module Limelight #:nodoc:
       Prop = Java::limelight.ui.api.Prop
       Stage = Java::limelight.ui.api.Stage
       Theater = Java::limelight.ui.api.Theater
-      Studio = Java::limelight.ui.api.Studio
+      Production = Java::limelight.ui.api.Production
     end
 
     module Painting #:nodoc:

data/lib/limelight/limelight_init.rb

@@ -0,0 +1,12 @@
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
+#- Limelight and all included source files are distributed under terms of the GNU LGPL.
+
+$LIMELIGHT_LIB = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+$: << $LIMELIGHT_LIB unless $:.include?($LIMELIGHT_LIB)
+$LIMELIGHT_HOME = File.expand_path(File.join($LIMELIGHT_LIB, ".."))
+
+if Java::java.lang.System.getProperty("limelight.home").nil?
+  Java::java.lang.System.setProperty("limelight.home", $LIMELIGHT_HOME)
+end
+
+require 'limelight/java_couplings'

data/lib/limelight/main.rb

@@ -5,31 +5,59 @@ require 'limelight/commands/command'
 
 module Limelight
 
-  # Used to open and manage Limelight Productions.
+  # Limelight::Main is used, when installed as a gem, to work with Limelight production.  It provides
+  # a handful of utilities to create, bundle, and develop with Limelight.
   #
-  # Productions may have a single scene or multiple scenes.
+  # For example, running the following command will generate a new Limelight production for you.
   #
-  # Single-Scene Production Directory Structure:
+  #   jruby -S limelight create production <production name>
   #
-  #   - calculator
-  #   | - props.rb
-  #   | - styles.rb
-  #   | - players
-  #     | - <player_name>.rb
-  #     | - *
+  # Assuming you used "sandbox" as the name or your production, you'd end up with the following directory structure
+  # generated for you.
+  #
+  #   - sandbox
   #   | - stages.rb
+  #   | - styles.rb
   #   | - production.rb
+  #   | - default_scene
+  #     | - props.rb
+  #     | - styles.rb
+  #     | - players
+  #       | - <player_name>.rb
+  #   | - spec
+  #     | - spec_helper.rb
+  #     | - default_scene
+  #       | - default_scene_spec.rb
   #
-  # In a Single-Scene production, the scene name and production name are the same.  As seen above, both names are 'calculator'.
-  # Inside the scene there are three files and one directory, all of which are options.
+  # In this case, you've just created a production called "Sandbox".  By convention, the name of the production matches the name of the root directory.
+  # Notice that there are 3 files and 2 directories.  Let's start by talking about the files.
+  #
+  # == stages.rb
+  # This file uses a DSL to configure the stages that will be used in the production.
+  # See Limelight::StagesBuilder
+  #
+  # == styles.rb
+  # This file defines production level styles. Each scene may have their own styles but styles defined here will be avaiable to all scenes.
+  # See Limelight::StylesBuilder
+  #
+  # == production.rb
+  # This file defines a module names Production where you can defined hooks and behavior for your production.
+  # See Limelight::Production
+  #
+  # For the most part, each directory inside the root directory is a scene.  This production has one scene named "default_scene" (this is the default name).
+  # Each scene starts out containing 2 file and a directory.  Let's look at those..
   #
   # == props.rb
-  # This file defines the props contained in the scene
+  # This file defines the structure of your scene.  Scenes are composed of Props.  In this file you use the Prop DSL to
+  # specify all the components of your scene.
   # See Limelight::PropBuilder
+  # See Limelight::Prop
   #
   # == styles.rb
-  # This file defines the styles used in the scene
+  # Similar to the styles.rb file located in the root directory, this file contains definitions of styles.  However,
+  # all styles defined here are only available to the containgin scene.  Styles define the look and feel of your scenes.
   # See Limelight::StylesBuilder
+  # See Limelight::Style
   #
   # == players
   # A directory containing all the players used in the scene.  Players are modules that are included by Prop objects.
@@ -37,40 +65,9 @@ module Limelight
   # Inside 'wall.rb' you would define a module named 'Wall'.  All behavior defined in the Wall modules will automatically be included
   # in every prop named 'wall'.
   #
-  # == stages.rb
-  # This file uses a DSL to configure the stages that will be used in the production.
-  # See Limelight::StagesBuilder
-  #
-  # == production.rb
-  # This file uses a DSL to configure the current Production.
-  # See Limelight::ProductionBuilder
-  #
-  # Multiple-Scene Production Directory Structure:
-  #
-  #   - sandbox
-  #   | - stages.rb
-  #   | - production.rb
-  #   | - styles.rb
-  #   | - players
-  #     | - <player_name>.rb
-  #   | - fader
-  #     | - props.rb
-  #     | - styles.rb
-  #     | - players
-  #       | - <player_name>.rb
-  #   | - floater
-  #     | - props.rb
-  #     | - styles.rb
-  #     | - players
-  #       | - <player_name>.rb
-  #
-  # In a Multiple-Scene production, the production acquires that name of the root directory.  In this case the production is named 'sandbox'.
-  # Each directory inside the root directory is a scene.  This production has two scenes named 'fader' and 'floater'.  Each scene is structured
-  # the same as in a Single-Scene production with the exception of the 'stages.rb' file.  This file is specific to the production.  The production
-  # may contain a 'styles.rb' which contains styles used by multiple scenes.  If some players are used in multiple Scenes, then it is useful to
-  # to create a players directory in the Production root to hold the common players. Other files may exist in the directory structure and they will not
-  # conflict with Limelight.
+  # So there's a brief overview for you.  Besure to check out the Limelight Docs production.  You can find it by installing Limelight and starting it up.
   #
+  # For more info on available commands: 
   # See Limelight::Commands
   #
   class Main

data/lib/limelight/producer.rb

@@ -23,15 +23,27 @@ module Limelight
   #
   class Producer
 
-    # Creates a new Producer and has it open a Production by specified name.
-    #
-    def self.open(production_name, options={})
-      producer = new(production_name)
-      begin
-        producer.open(options)
-      rescue Exception => e
-        puts e
-        puts e.backtrace
+    class << self
+      # Creates a new Producer and has it open a Production by specified name.
+      #
+      def open(production_name, options={})
+        producer = new(production_name)
+        begin
+          producer.open(options)
+        rescue Exception => e
+          puts e
+          puts e.backtrace
+        end
+      end
+
+      # Returns a hash of all the built-in Limglight Styles
+      #
+      def builtin_styles
+        unless @builtin_styles
+          builtin_styles_file = File.join($LIMELIGHT_LIB, "limelight", "builtin", "styles.rb")
+          @builtin_styles = Limelight.build_styles_from_file(builtin_styles_file)
+        end
+        return @builtin_styles
       end
     end
 
@@ -50,7 +62,7 @@ module Limelight
         root_path = unpack_production(root_path)
       end
       @production = production || Production.new(root_path)
-      @theater = theater.nil? ? Theater.new : theater
+      @theater = theater.nil? ? Theater.new(@production) : theater
       establish_production
     end
 
@@ -77,15 +89,23 @@ module Limelight
       load_stages if File.exists?(@production.stages_file)
     end
 
+    # Returns true if the production is compatible with the current version of Limelight or if the user proceeds
+    # despite the incompatible warning.
+    #
+    def can_proceed_with_compatibility?
+      return true if version_compatible?
+      return true if Context.instance.studio.utilities_production.should_proceed_with_incompatible_version(@production.name, @production.minimum_limelight_version)
+      return false
+    end
+
     # Opens the Production.
     #
     def open(options = {})
-      return unless version_compatible? || Studio.utilities_production.proceed_with_incompatible_version?(@production.name, @production.minimum_limelight_version)
       @production.production_opening
       load
       @production.production_loaded
       if @theater.has_stages?
-        @theater.stages.each do |stage|          
+        @theater.stages.each do |stage|
           open_scene(stage.default_scene.to_s, stage) if stage.default_scene
         end
       elsif @production.default_scene
@@ -144,12 +164,33 @@ module Limelight
     # Loads the specified 'styles.rb' file and created a Hash of Styles.
     #
     def load_styles(context)
-      extendable_styles = Studio.builtin_styles.merge(@production.root_styles)
+      extendable_styles = Producer.builtin_styles.merge(@production.root_styles)
       return extendable_styles.dup if not File.exists?(context.styles_file)
       new_styles = Limelight.build_styles_from_file(context.styles_file, extendable_styles)
       return extendable_styles.merge(new_styles)
     end
 
+    # Closes the specified production.  The producer will trigger the hook, production_closing and production_closed,
+    # to keep the production aware of it's status.  The Studio will also be informed of the closure.  If no
+    # production remain opened, then the Limelight runtine will exit.
+    #
+    def close(production)
+      return if production.closed?
+      production.closed = true
+      return Thread.new do
+        begin
+          Thread.pass
+          production.production_closing
+          production.theater.close
+          production.production_closed
+          Context.instance.studio.production_closed(production)
+        rescue StandardError => e
+          puts e
+          puts e.backtrace
+        end
+      end
+    end
+
     def establish_production #:nodoc:
       @production.producer = self
       @production.theater = @theater

data/lib/limelight/production.rb

@@ -3,9 +3,10 @@
 
 require 'limelight/limelight_exception'
 require 'limelight/file_loader'
-require 'limelight/studio'
+require 'limelight/dsl/styles_builder'
 require 'drb'
 
+
 module Limelight
 
   # The root object of Limelight Production.  Every Prop in a production has access to its Production object.
@@ -15,6 +16,8 @@ module Limelight
   #
   class Production
 
+    include UI::Api::Production
+
     class << self
 
       def [](name) #:nodoc:
@@ -25,6 +28,8 @@ module Limelight
 
     attr_reader :name, :root
     attr_accessor :producer, :theater
+    attr_accessor :closed #:nodoc:
+
 
     # Users typically need not create Production objects.
     #
@@ -36,7 +41,7 @@ module Limelight
     # Sets the name of the Production.  The name must be unique amongst all Productions in memory.
     #
     def name=(value)
-      Studio.error_if_duplicate_name(value)
+      Context.instance.studio.error_if_duplicate_name(value)
       @name = value
     end
 
@@ -75,7 +80,7 @@ module Limelight
     def gems_directory
       return @root.path_to("__resources/gems/gems")
     end
-    
+
     # Returns the path to the productions gems root
     #
     def gems_root
@@ -86,7 +91,7 @@ module Limelight
     #
     def scene_directory(name)
       return @root.root if name == :root
-        return @root.path_to(name)
+      return @root.path_to(name)
     end
 
     # Returns the minimum version of limelight required to run this production.  Default: "0.0.0"
@@ -135,12 +140,24 @@ module Limelight
     def production_closed
     end
 
+    # returns true if the production has been closed.
+    #
+    def closed?
+      return @closed
+    end
+
     # Closes the production. If there are no more productions open, the Limelight runtime will shutdown.
+    # The production will actually delegate to it's producer and the producer will close the production down.
     #
     def close
-      self.production_closing
-      Studio.production_closed(self)
-      self.production_closed
+      @producer.close(self)
+    end
+
+    # Called when the last stage in this production's theater is closed.  If the allow_close? returns true
+    # this production will be closed.
+    #
+    def theater_empty!
+      close if allow_close? && !closed?
     end
 
     # Returned the name of the default scene.  This is only used when there are not stages defined in the production.
@@ -164,6 +181,16 @@ module Limelight
       return @root_styles
     end
 
+    alias :getName :name #:nodoc:
+    alias :setName :name= #:nodoc:
+    alias :allowClose :allow_close? #:nodoc: 
+
+    def callMethod(name, java_obj_array) #:nodoc:
+      args = []
+      java_obj_array.length.times { |i| args << java_obj_array[i] }
+      send(name.to_sym, *args)
+    end
+
   end
 
 end