epall-limelight 0.5.0-java

data/lib/limelight/templates/production_templater.rb

@@ -0,0 +1,49 @@
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
+#- Limelight and all included source files are distributed under terms of the GNU LGPL.
+
+require 'limelight/templates/templater'
+require 'limelight/string'
+require 'limelight/version'
+
+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/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(options)
+        production_path = options[:production_path]
+        default_scene_name = options[:scene_path]
+        super(File.dirname(production_path), Templater.source_dir)
+        @production_path = File.basename(production_path)
+        @spec_path = File.join(@production_path, options[:spec_path])
+        @tokens = {}
+        @tokens[:DEFAULT_SCENE_NAME] = default_scene_name
+        @tokens[:PRODUCTION_NAME] = File.basename(production_path).titleized
+        @tokens[:CURRENT_VERSION] = Limelight::VERSION::STRING
+      end
+
+      # Generates the files
+      #
+      def generate
+        file(File.join(@production_path, "production.rb"), "production/production.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)
+        file(File.join(@spec_path, "spec_helper.rb"), "production/spec/spec_helper.rb.template", @tokens)
+      end
+
+    end
+
+  end
+end

data/lib/limelight/templates/scene_templater.rb

@@ -0,0 +1,47 @@
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
+#- Limelight and all included source files are distributed under terms of the GNU LGPL.
+
+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(options)
+        @production_path = options[:production_path]
+        @scene_path = options[:scene_path]
+        @spec_path = options[:spec_path]
+        super(@production_path, Templater.source_dir)
+        @scene_name = File.basename(@scene_path)
+        @tokens = {}
+        @tokens[:SCENE_NAME] = @scene_name
+        @tokens[:SCENE_TITLE] = @scene_name.titleized
+      end
+
+      # Generates 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"))
+        file(File.join(@spec_path, @scene_path, "#{@scene_name}_spec.rb"), "scene_spec/scene_spec.rb.template", @tokens)
+      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,49 @@
+# This file (production.rb) is the first file loaded opening a production.  It must define a module named 'Production'.
+# The containing production will acquire all the behavior defined in this module.
+# You may define serveral hooks and initialization steps here.
+
+module Production
+
+#  # Define this method if you want the production name to be different from the default, directory name.
+#  def name
+#    return !-PRODUCTION_NAME-!
+#  end
+#
+#  # Returns the minimum version of limelight required to run this production.  Default: "0.0.0"
+#  # If the version of limelight used to open this production is less than the minimum, 
+#  # an error will be displayed (starting with version 0.4.0).
+#  #
+#  def minimum_limelight_version
+#    return "!-CURRENT_VERSION-!"
+#  end
+#
+#  # Hook #1.  Called when the production is newly created, before any loading has been done.
+#  # This is a good place to require needed files and instantiate objects in the business layer.
+#  def production_opening
+#  end
+#
+#  # Hook #2.  Called after internal gems have been loaded and stages have been instantiated, yet before
+#  # any scenes have been opened.
+#  def production_loaded
+#  end
+#
+#  # Hook #3.  Called when the production, and all the scenes, have fully opened.
+#  def production_opened
+#  end
+#
+#  # The system will call this methods when it wishes to close the production, perhaps when the user quits the
+#  # application.  By default the production will always return true. You may override this behavior by re-implenting
+#  # the methods here.
+#  def allow_close?
+#    return true
+#  end
+#
+#  # Called when the production is about to be closed.
+#  def production_closing
+#  end
+#
+#  # Called when the production is fully closed.
+#  def production_closed
+#  end
+
+end

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

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'spec'
+require 'limelight/specs/spec_helper'
+
+# Set the Gem home to the frozen gems
+$PRODUCTION_PATH = File.expand_path(File.dirname(__FILE__) + "/../")
+Gem.use_paths(File.join($PRODUCTION_PATH , "__resources", "gems"), Gem.default_path)
+
+
+Dir.glob(File.join("__resources", "gems", "gems", "**", "lib")).each do |dir|
+  $: << dir
+end

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/sources/scene_spec/scene_spec.rb.template

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "!-SCENE_TITLE-!" do
+
+  uses_scene "!-SCENE_NAME-!", :hidden => true
+
+  it "should have default text" do
+    scene.children.size.should == 1
+    root = scene.children[0]
+    root.text.should == "This is the !-SCENE_TITLE-! scene."
+  end
+
+end

data/lib/limelight/templates/templater.rb

@@ -0,0 +1,131 @@
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
+#- Limelight and all included source files are distributed under terms of the GNU LGPL.
+
+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 within 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

data/lib/limelight/templates/templater_logger.rb

@@ -0,0 +1,39 @@
+#- 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
+  module Templates
+
+    # Templaters uses this class to log activity.  
+    #
+    class TemplaterLogger
+
+      # An accessor to the output IO. Defaults to STDOUT
+      #
+      attr_accessor :output
+
+      def initialize
+        @output = STDOUT
+      end
+
+      def creating_directory(name)
+        @output.puts "\tcreating directory:  #{name}"
+      end
+
+      def creating_file(name)
+        @output.puts "\tcreating file:       #{name}"
+      end
+
+      def file_already_exists(name)
+        @output.puts "\tfile already exists: #{name}"
+      end
+
+      def log(message, name)
+        spaces = 21 - message.length - 1
+        @output.puts "\t#{message}:#{' '*spaces}#{name}"
+      end
+
+    end
+    
+  end
+end

data/lib/limelight/theater.rb

@@ -0,0 +1,77 @@
+#- Copyright � 2008-2009 8th Light, Inc. All Rights Reserved.
+#- Limelight and all included source files are distributed under terms of the GNU LGPL.
+
+require 'limelight/limelight_exception'
+
+module Limelight
+
+  # A Theater represents a group of Stages.  Productions require a Theater in which to open.
+  #
+  class Theater
+    
+    include UI::Api::Theater
+
+    # Returns the theater's active stage.  i.e. the stage most recently used.
+    #
+    attr_reader :active_stage
+    
+    def initialize
+      @stages = {}
+    end
+
+    # Returns an Array of Stages that belong to this Theater.
+    #
+    def stages
+      return @stages.values
+    end
+
+    # Returns true if the theater has at least one stage
+    #
+    def has_stages?
+      return stages.length > 0
+    end
+
+    # Returns the Stage with the spcified name, nil if none exist with the specified name.
+    #
+    def [](stage_name)
+      return @stages[stage_name]
+    end
+
+    # Adds a Stage to the Theater.  Raises an exception is the name of the Stage is duplicated.
+    #
+    def add_stage(name, options = {})
+      raise LimelightException.new("Duplicate stage name: '#{name}'") if @stages[name]
+      stage = build_stage(name, options)
+      @stages[name] = stage
+      return stage
+    end
+
+    # Lets the Theater know which stage has the limelight (currently active).
+    #
+    def stage_activated(stage)
+      @active_stage = stage
+    end
+
+    # Removes the stage from this theater.
+    #
+    def stage_closed(stage)
+      @stages.delete(stage.name)
+      @active_stage = nil if @active_stage == stage
+    end
+
+    # If no Stages are added, the Theater will provide a default Stage named "Limelight".
+    #
+    def default_stage
+      add_stage("Limelight") if self["Limelight"].nil?
+      return self["Limelight"]
+    end
+
+    protected #############################################
+
+    def build_stage(name, options)
+      return Limelight::Stage.new(self, name, options)
+    end
+    
+  end
+  
+end