limelight 0.2.1-java → 0.3.0-java

data/lib/limelight/specs/spec_helper.rb

@@ -0,0 +1,58 @@
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + "/../../init")
+require 'limelight/scene'
+require 'limelight/producer'
+
+$producer = nil
+$with_ui = true
+
+module Spec
+  module Example
+    class ExampleGroup
+
+      def self.uses_scene(scene_name)
+        before(:each) do
+          @scene = producer.open_scene(scene_name.to_s, producer.theater["default"])
+        end
+
+        attr_reader :scene
+      end
+
+      after(:suite) do
+        $producer.theater.stages.each { |stage| stage.close } unless $producer.nil?
+      end
+
+      def producer
+        if $producer.nil?
+          if $with_ui
+            Limelight::Main.initializeContext
+          else
+            Limelight::Main.initializeTestContext
+          end
+          $producer = Limelight::Producer.new($PRODUCTION_PATH)
+          $producer.load
+        end
+        return $producer
+      end
+
+    end
+  end
+end
+
+if !$with_ui
+  module Limelight
+    module UI
+      module Model
+
+        class Frame
+
+          def open
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/limelight/stage.rb

@@ -1,9 +1,7 @@
 #- Copyright 2008 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
-require 'limelight/java_util'
-require 'limelight/menu_bar'
-require 'limelight/loaders/file_scene_loader'
+require 'limelight/dsl/menu_bar'
 require 'limelight/file_chooser'
 require 'limelight/util'
 
@@ -79,6 +77,7 @@ module Limelight
     # See load_scene
     #
     def open(scene)
+      scene.illuminate
       load_scene(scene)
       @frame.open
       scene.visible = true
@@ -98,9 +97,9 @@ module Limelight
       @frame.setJMenuBar(scene.menu_bar)
       @frame.load(scene.panel)
       scene.stage = self
-      scene.panel.snap_to_size
+#      scene.panel.snap_to_size  # What's this for?
       if(has_static_size?(scene.style))
-        @frame.set_size(scene.panel.width + @frame.getHorizontalInsetWidth, scene.panel.height + @frame.getVerticalInsetWidth)
+        @frame.set_size(scene.style.compiled_width.value + @frame.getHorizontalInsetWidth, scene.style.compiled_height.value + @frame.getVerticalInsetWidth)
       end
       @current_scene = scene
     end
@@ -124,10 +123,16 @@ module Limelight
       frame.alert(message)
     end
 
+    protected #############################################
+
+    def new_frame
+      return UI::Model::Frame.new(self)
+    end
+
     private ###############################################
     
     def build_frame
-      @frame = UI::Model::Frame.new(self)
+      @frame = new_frame
       @frame.set_size(800, 800)
       @frame.set_location(200, 25)
       @frame.title = title

data/lib/limelight/string.rb

@@ -0,0 +1,35 @@
+class String
+
+  # Converts Ruby style names to Java style camal case.
+  #
+  #   "four_score".camalized # => "FourScore"
+  #   "and_seven_years".camalized(:lower) # => "andSevenYears"
+  #
+  def camalized(starting_case = :upper)
+    value = self.downcase.gsub(/[_| ][a-z]/) { |match| match[-1..-1].upcase }
+    value = value[0..0].upcase + value[1..-1] if starting_case == :upper
+    return value
+  end
+
+  # Converts Java camel case names to ruby style underscored names.
+  #
+  #   "FourScore".underscored # => "four_score"
+  #   "andSevenYears".underscored # => "and_seven_years"
+  #
+  def underscored
+    value = self[0..0].downcase + self[1..-1]
+    value = value.gsub(/[A-Z]/) { |cap| "_#{cap.downcase}" }
+    return value
+  end
+
+
+  # Converts ruby style and camalcase strings into title strings where every word is capitalized and separated by a space.
+  #
+  #   "four_score".titleized # => "Four Score"
+  #
+  def titleized(starting_case = :upper)
+    value = self.gsub(/[a-z0-9][A-Z]/) { |match| "#{match[0..0]} #{match[-1..-1]}" }
+    value = value.gsub(/[_| ][a-z]/) { |match| " #{match[-1..-1].upcase}" }
+    return value[0..0].upcase + value[1..-1]
+  end
+end

data/lib/limelight/studio.rb

@@ -0,0 +1,29 @@
+require 'limelight/producer'
+
+module Limelight
+
+  class Studio
+
+    include Limelight::UI::Api::Studio
+
+    class << self
+
+      def install
+        Context.instance.studio = instance  
+      end
+
+      def instance
+        @studio = self.new if @studio.nil?
+        return @studio
+      end
+
+    end
+
+    def open(production)
+      producer = Producer.new(production)
+      producer.open
+    end
+
+  end
+
+end

data/lib/limelight/templates/production_templater.rb

@@ -0,0 +1,42 @@
+require 'limelight/templates/templater'
+require 'limelight/string'
+
+module Limelight
+  module Templates
+
+    # A Templater that creates all the files and directories for a production.  When used with "love_story" as
+    # the production_path, the following will be the result.
+    #
+    #    creating directory:  ./love_story
+    #    creating file:       ./love_story/production.rb
+    #    creating file:       ./love_story/init.rb
+    #    creating file:       ./love_story/stages.rb
+    #    creating file:       ./love_story/styles.rb
+    #
+    class ProductionTemplater < Templater
+
+      attr_reader :tokens
+
+      # To create a ProductionTemplater, provide a production_path and the name of the default scene.
+      #
+      def initialize(production_path, default_scene_name)
+        super(File.dirname(production_path), Templater.source_dir)
+        @production_path = File.basename(production_path)
+        @tokens = {}
+        @tokens[:DEFAULT_SCENE_NAME] = default_scene_name
+        @tokens[:PRODUCTION_NAME] = File.basename(production_path).titleized
+      end
+
+      # Generates the files
+      #
+      def generate
+        file(File.join(@production_path, "production.rb"), "production/production.rb.template", @tokens)
+        file(File.join(@production_path, "init.rb"), "production/init.rb.template", @tokens)
+        file(File.join(@production_path, "stages.rb"), "production/stages.rb.template", @tokens)
+        file(File.join(@production_path, "styles.rb"), "production/styles.rb.template", @tokens)
+      end
+
+    end
+
+  end
+end

data/lib/limelight/templates/scene_templater.rb

@@ -0,0 +1,41 @@
+require 'limelight/templates/templater'
+require 'limelight/string'
+
+module Limelight
+  module Templates
+
+    # A derivative of Templater that generates all the files for a scene.
+    # When created with the path "midnight_romance" the following will result:
+    #
+    #    creating directory:  ./midnight_romance
+    #    creating file:       ./midnight_romance/props.rb
+    #    creating file:       ./midnight_romance/styles.rb
+    #    creating directory:  ./midnight_romance/players
+    #
+    class SceneTemplater < Templater
+
+      attr_reader :tokens
+
+      # The scene_path should be path to a desired scene inside a production directory.
+      #
+      def initialize(scene_path)
+        super(File.dirname(scene_path), Templater.source_dir)
+        @scene_path = File.basename(scene_path)
+        scene_name = File.basename(scene_path)
+        @tokens = {}
+        @tokens[:SCENE_NAME] = scene_name
+        @tokens[:SCENE_TITLE] = scene_name.titleized
+      end
+
+      # Generated the files
+      #
+      def generate
+        file(File.join(@scene_path, "props.rb"), "scene/props.rb.template", @tokens)
+        file(File.join(@scene_path, "styles.rb"), "scene/styles.rb.template", @tokens)
+        directory(File.join(@scene_path, "players"))
+      end
+
+    end
+
+  end
+end

data/lib/limelight/templates/sources/freezing/limelight_init.rb.template

@@ -0,0 +1,5 @@
+# This file was generated by Limelight.
+# It is automtically added to frozen gems.  When Limelight loads a production, it will load all 'limelight_init.rb'
+# files, like this one, in each of the frozen gems.
+
+Limelight::Gems.install('!-GEM_NAME-!', !-PATHS-!)

data/lib/limelight/templates/sources/production/init.rb.template

@@ -0,0 +1,15 @@
+# This file (init.rb) is the second file loaded (after production.rb) when a production is loaded.
+# Initialization code for the production should go here.
+
+# If your production is using external ruby source code that will be required in player modules, you may
+# add the path to $: here.
+#$: << File.expand_path(File.dirname(__FILE__) + "/lib")
+
+# Acquires a reference to the production.
+production = Limelight::Production["!-PRODUCTION_NAME-!"]
+
+# Require any source code that will be used by the production.
+#require 'seomthing'
+
+# This is the ideal place to assign values to production attributes.
+#production.something = MySource::Something.new

data/lib/limelight/templates/sources/production/production.rb.template

@@ -0,0 +1,9 @@
+# This file (production.rb) configures the production. It is the first file loaded when production is opened.
+
+# The name of the production.  If not present, the production's name will default to the name of the root directory.
+name "!-PRODUCTION_NAME-!"
+
+# Attributes.  Defining attributes on the production will create getters/setters on the production object.
+# Create attributes for any model objects or resources that need to accessible to props or players within the production
+
+#attribute :attribute_name

data/lib/limelight/templates/sources/production/stages.rb.template

@@ -0,0 +1,17 @@
+# This file (stages.rb) is used to define the stages within your production.
+#
+# Below is an example statge configuration.
+#
+#  stage "center_stage" do
+#    default_scene "main"
+#    title "Limelight Center Stage"
+#    location [0, 0]
+#    size [300, 800]
+#  end
+
+stage "default" do
+  default_scene "!-DEFAULT_SCENE_NAME-!"
+  title "Limelight"
+  location [200, 25]
+  size [800, 800]
+end

data/lib/limelight/templates/sources/production/styles.rb.template

@@ -0,0 +1,12 @@
+# This file, (styles.rb) in the root directory of the production, should define any styles that are used in multiple
+# scenes.  It makes use of the StyleBuilder DSL.
+#
+# For more information see: http://limelightwiki.8thlight.com/index.php/A_Cook%27s_Tour_of_Limelight#Styling_with_styles.rb
+# For a complete listing of style attributes see: http://limelightwiki.8thlight.com/index.php/Style_Attributes
+
+# An example style definition
+#foo {
+#  width 100
+#  height 100
+#  background_color :blue
+#}

data/lib/limelight/templates/sources/scene/props.rb.template

@@ -0,0 +1,6 @@
+# This file (props.rb) defines all the props that appear in a scene when loaded.  It makes use of the
+# PropBuilder DSL.
+#
+# For more information see: http://limelightwiki.8thlight.com/index.php/A_Cook%27s_Tour_of_Limelight#PropBuilder_DSL
+
+root :text => "This is the !-SCENE_TITLE-! scene."

data/lib/limelight/templates/sources/scene/styles.rb.template

@@ -0,0 +1,18 @@
+# This file, (styles.rb) inside a scene, should define any styles specific to the containing scene.
+# It makes use of the StyleBuilder DSL.
+#
+# For more information see: http://limelightwiki.8thlight.com/index.php/A_Cook%27s_Tour_of_Limelight#Styling_with_styles.rb
+# For a complete listing of style attributes see: http://limelightwiki.8thlight.com/index.php/Style_Attributes
+
+!-SCENE_NAME-! {
+  background_color :black
+  horizontal_alignment :center
+  vertical_alignment :center
+  width "100%"
+  height "100%"
+}
+
+root {
+  text_color :white
+  font_size 18
+}

data/lib/limelight/templates/templater.rb

@@ -0,0 +1,128 @@
+require 'limelight/templates/templater_logger'
+
+module Limelight
+  module Templates
+
+    # A class to create directories and file templates.  An instance of Templater must be provided with
+    # a target_root and a source_root.  The target_root designates a root directory in which all directories and
+    # files will be created.  The source_root designated a directory where all the file template can be found.
+    #
+    # A file template is a plain text file.  It may optionally contain token markers in the format !-TOKEN_NAME-!.
+    # When a file template is installed by the templater, all the token margers will be replaced by tokens provided
+    # in a hash.
+    #
+    class Templater
+
+      # Return the default source_root for Limelight related file templates.
+      #
+      # $LIMELIGHT_LIB$/limelight/templates/sources
+      #
+      def self.source_dir
+        return File.join(File.dirname(__FILE__), "sources")
+      end
+
+      # Carifies a path as relative or absolute.  Essentially if makes sure a path begins with a . if it's not
+      # an absolute path.
+      #
+      #   Templater.clarity('some/path') -> './some/path'
+      #   Templater.clarity('/root/path') -> '/root/path'
+      #
+      def self.clarify(path)
+        return path if path[0..0] == '.'
+        return path if path == File.expand_path(path)
+        return File.join(".", path)
+      end
+
+      attr_reader :target_root, :source_root
+
+      # See TemplaterLogger 
+      #
+      attr_accessor :logger
+
+      # New instances Templater require a target_root.  The source_root may optionally be provided.  source_root
+      # defaults to Templater.source_dir
+      #
+      # The logger is initializes as a TemplaterLogger
+      #
+      def initialize(target_root, source_root=Templater.source_dir)
+        @logger = TemplaterLogger.new
+        @target_root = Templater.clarify(target_root)
+        @source_root = source_root
+      end
+
+      # Creates a deirectory.  If the specified directory's parent directory is missing, it will be created as will its
+      # parent directory, and so on.
+      #
+      # After the following call,
+      #
+      #   templater.directory("dir1/dir2/dir3/dir4")
+      #
+      # The following directories will exist, inside the target_root, whether they existed prior to the call or not.
+      #
+      #   dir1
+      #   dir1/dir2
+      #   dir1/dir2/dir3
+      #   dir1/dir2/dir3/dir4
+      #
+      def directory(path)
+        full_path = File.join(@target_root, path)
+        establish_directory(full_path)
+      end
+
+      # Creates the specified file from the specified file template.  The file will be created withint the target_root.
+      # All parent diretories will be created if needed.  The source paramter should be a path pointing to a
+      # file template in the source_root directory.
+      #
+      # Assume the the file <code>src/default.txt.template</code> exists in the source_root with the following content.
+      #
+      #   !-SCORES-! score and !-YEARS-! years ago, ...
+      #
+      # When the following command is executed,
+      #
+      #   templater.file('dir/foo.txt', 'src/default.txt.template', :SCORES => "Four", :YEARS => "seven")
+      #
+      # The file <code>dir/foo.txt</code> will exist in the target_root with the following content.
+      #
+      #   Four score and seven years ago, ...
+      #
+      def file(target, source, tokens = {})
+        target_path = File.join(@target_root, target)
+        source_source = File.join(@source_root, source)
+
+        establish_directory(File.dirname(target_path))
+
+        if File.exists?(target_path)
+          @logger.file_already_exists(target_path)
+        else
+          @logger.creating_file(target_path)
+          content = IO.read(source_source)
+          content = replace_tokens(content, tokens)
+          File.open(target_path, 'w') { |file| file.write content }
+        end
+      end
+
+      private
+
+      def establish_directory(full_path)
+        return if File.exists?(full_path)
+        parent_path = File.dirname(full_path)
+        while (!File.exists?(parent_path))
+          establish_directory(parent_path)
+        end
+
+        @logger.creating_directory(full_path)
+        Dir.mkdir(full_path)
+      end
+
+      def replace_tokens(content, tokens)
+        return content.gsub(/!-(\w+)-!/) do |value|
+          token_name = value[2...-2]
+          token = tokens[token_name] || tokens[token_name.to_sym] || "UNKNOWN TOKEN"
+          token
+        end
+      end
+
+    end
+
+  end
+end