limelight 0.2.0-java → 0.2.1-java

data/lib/limelight/theater.rb

@@ -4,7 +4,9 @@
 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
@@ -12,26 +14,36 @@ module Limelight
     attr_reader :active_stage
     
     def initialize
-      @stages = {}
+      @__stages__ = {}
     end
-    
+
+    # Returns an Array of Stages that belong to this Theater.
+    #
     def stages
-      return @stages.values
+      return @__stages__.values
     end
-    
+
+    # Returns the Stage with the spcified name, nil if none exist with the specified name.
+    #
     def [](stage_name)
-      return @stages[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(stage)
-      raise LimelightException.new("Duplicate stage name: '#{stage.name}'") if @stages[stage.name]
-      @stages[stage.name] = stage
+      raise LimelightException.new("Duplicate stage name: '#{stage.name}'") if @__stages__[stage.name]
+      @__stages__[stage.name] = stage
     end
-    
+
+    # Lets the Theater know which stage has the limelight (currently active).
+    #
     def stage_activated(stage)
       @active_stage = stage
     end
-    
+
+    # If no Stages are added, the Theater will provide a default Stage named "Limelight".
+    #
     def default_stage
       add_stage(Stage.new(self, "Limelight")) if self["Limelight"].nil?
       return self["Limelight"]

data/lib/limelight/util.rb

@@ -2,17 +2,25 @@
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 module Limelight
-  
+
+  # Utility methods for Limelight
+  #
   module Util
-    
+
+    # Returns true if the specified file is a directory and has the structure of a Scene.
+    #
     def self.is_limelight_scene?(file)
       return is_directory_containing_file?(file, "props.rb")
     end
-    
+
+    # Returns true if the specified file is a directory and has the structure of a Production.
+    #
     def self.is_limelight_production?(file)
       return is_directory_containing_file?(file, "stages.rb")
     end
-    
+
+    # Returns true of the file is a directory containing an entry named file_name.
+    #
     def self.is_directory_containing_file?(file, file_name)
       if file.is_a? String
         return File.directory?(file) && File.exists?(File.join(file, file_name))
@@ -20,7 +28,21 @@ module Limelight
         return file.isDirectory() && File.exists?(File.join(file.absolute_path, file_name))
       end
     end
-    
+
+    # Removed all methods from a class except instance_eval and methods starting with __.
+    # This is used by the DSL Builder classes to minimize reserved keywords.
+    #
+    def self.lobotomize(klass)
+      klass.methods.each do |method_name|
+        unless method_name[0..1] == "__" || method_name == "instance_eval"
+          begin
+            klass.instance_eval "undef_method :#{method_name}"
+          rescue Exception => e
+          end
+        end
+      end
+    end
+
   end
-  
+
 end

data/lib/limelight/version.rb

@@ -6,7 +6,7 @@ module Limelight
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 2
-      TINY   = 0
+      TINY   = 1
 
       STRING = [MAJOR, MINOR, TINY].join('.')
       TAG    = "REL_" + [MAJOR, MINOR, TINY].join('_')

data/productions/startup/players/browse_button.rb

@@ -4,7 +4,7 @@
 module BrowseButton
 
   def mouse_clicked(e)
-    scene.open_chosen_scene
+    scene.open_chosen_production
   end
 
 end

data/spec/builtin/players/check_box_spec.rb

@@ -9,7 +9,7 @@ describe Limelight::Builtin::Players::CheckBox do
 
   before(:each) do
     @prop = Limelight::Prop.new
-    @prop.add_controller(Limelight::Builtin::Players::CheckBox)
+    @prop.include_player(Limelight::Builtin::Players::CheckBox)
   end
   
   it "should have a TextField" do

data/spec/builtin/players/radio_button_spec.rb

@@ -38,12 +38,12 @@ describe Limelight::Builtin::Players::RadioButton do
     
     prop2 = Limelight::Prop.new
     @scene << prop2
-    prop2.add_controller(Limelight::Builtin::Players::RadioButton)
+    prop2.include_player(Limelight::Builtin::Players::RadioButton)
     prop2.group = "group 1"
     
     prop3 = Limelight::Prop.new
     @scene << prop3
-    prop3.add_controller(Limelight::Builtin::Players::RadioButton)
+    prop3.include_player(Limelight::Builtin::Players::RadioButton)
     prop3.group = "group 2"
     
     group1 = @scene.button_groups["group 1"]

data/spec/builtin/players/text_area_spec.rb

@@ -9,7 +9,7 @@ describe Limelight::Builtin::Players::TextArea do
 
   before(:each) do
     @prop = Limelight::Prop.new
-    @prop.add_controller(Limelight::Builtin::Players::TextArea)
+    @prop.include_player(Limelight::Builtin::Players::TextArea)
   end
   
   it "should have a JTextArea" do

data/spec/builtin/players/text_box_spec.rb

@@ -9,7 +9,7 @@ describe Limelight::Builtin::Players::TextBox do
 
   before(:each) do
     @prop = Limelight::Prop.new
-    @prop.add_controller(Limelight::Builtin::Players::TextBox)
+    @prop.include_player(Limelight::Builtin::Players::TextBox)
   end
 
   it "should have a TextField" do

data/spec/commands_spec.rb

@@ -4,6 +4,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
 require 'limelight/commands'
 require 'limelight/producer'
+require 'limelight/main'
 
 describe Limelight::Commands do
 
@@ -13,13 +14,13 @@ describe Limelight::Commands do
   it "should open a production" do
     args = ["open", "production_name"]
     Limelight::Producer.should_receive(:open).with("production_name")
-    Limelight::Commands.run(args)
+    Limelight::Main.run(args)
   end
 
   it "should open the default production" do
     args = ["open"]
     Limelight::Producer.should_receive(:open).with(Limelight::DEFAULT_PRODUCTION)
-    Limelight::Commands.run(args)
+    Limelight::Main.run(args)
   end
 
   it "should pack a production" do
@@ -27,7 +28,7 @@ describe Limelight::Commands do
     Limelight::Util::Packer.should_receive(:new).and_return(mock_packer)
     mock_packer.should_receive(:pack).with("production_to_pack")
 
-    Limelight::Commands.run(["pack", "production_to_pack"])
+    Limelight::Main.run(["pack", "production_to_pack"])
   end
 
 end

data/spec/prop_builder_spec.rb

@@ -10,21 +10,21 @@ describe Limelight::SceneBuilder do
     @caster = make_mock("caster", :fill_cast => nil)
     @options = { :name => "root", :casting_director => @caster}
   end
-  
+
   it "should build root" do
     root = Limelight.build_scene(@options)
-    
+
     root.class.should == Limelight::Scene
     root.name.should == "root"
     root.panel.should_not == nil
     root.children.size.should == 0
   end
-  
+
   it "should build one child prop" do
     root = Limelight::build_scene(@options) do
       child
     end
-    
+
     root.children.size.should == 1
     child = root.children[0]
     child.class.should == Limelight::Prop
@@ -32,13 +32,13 @@ describe Limelight::SceneBuilder do
     child.panel.should_not == nil
     child.children.size.should == 0
   end
-  
+
   it "should allow multiple children" do
     root = Limelight::build_scene(@options) do
       child1
       child2
     end
-    
+
     root.children.size.should == 2
     root.children[0].name.should == "child1"
     root.children[1].name.should == "child2"
@@ -56,54 +56,54 @@ describe Limelight::SceneBuilder do
     root.children[0].children.size.should == 1
     root.children[0].children[0].name.should == "grandchild"
   end
-  
+
   it "should be able to set the id" do
     root = Limelight::build_scene(@options) do
       child :id => "child_1", :players => "x, y, z"
     end
-    
+
     child = root.children[0]
     child.id.should == "child_1"
     child.players.should == "x, y, z"
   end
-  
+
   it "should allow setting styles" do
     root = Limelight::build_scene(@options) do
       child :width => "100", :font_size => "10", :top_border_color => "blue"
     end
-    
+
     child = root.children[0]
     child.style.width.should == "100"
     child.style.font_size.should == "10"
     child.style.top_border_color.should == "blue"
   end
-  
+
   it "should allow defining events through constructor" do
     root = Limelight::build_scene(@options) do
       child :on_mouse_entered => "return [self, event]"
-    end  
-    
+    end
+
     child = root.children[0]
     child.mouse_entered("blah").should == [child, "blah"]
   end
-  
+
   it "should allow scene configuration" do
     root = Limelight::build_scene(@options) do
       __ :name => "root", :id => "123"
     end
-    
+
     root.children.size.should == 0
     root.name.should == "root"
     root.id.should == "123"
   end
-  
+
   it "should give every prop their scene" do
     root = Limelight::build_scene(@options) do
       child do
         grandchild
       end
     end
-    
+
     root.scene.should == root
     root.children[0].scene.should == root
     root.children[0].children[0].scene.should == root
@@ -112,18 +112,18 @@ describe Limelight::SceneBuilder do
   it "should install external props" do
     loader = make_mock("loader", :exists? => true)
     loader.should_receive(:load).with("external.rb").and_return("child :id => 123")
-    
+
     root = Limelight::build_scene(:id => 321, :build_loader => loader, :casting_director => @caster) do
       __install "external.rb"
-    end  
-    
+    end
+
     root.id.should == 321
     root.children.size.should == 1
     child = root.children[0]
     child.name.should == "child"
     child.id.should == 123
   end
-  
+
   it "should fail if no loader is provided" do
     begin
       root = Limelight::build_scene(@options.merge(:id => 321, :build_loader => nil)) do
@@ -134,11 +134,11 @@ describe Limelight::SceneBuilder do
       e.message.should == "Cannot install external props because no loader was provided"
     end
   end
-  
+
   it "should fail when the external file doesn't exist" do
     loader = make_mock("loader")
     loader.should_receive(:exists?).with("external.rb").and_return(false)
-    
+
     begin
       root = Limelight::build_scene(@options.merge(:id => 321, :build_loader => loader)) do
         __install "external.rb"
@@ -147,32 +147,43 @@ describe Limelight::SceneBuilder do
       e.message.should == "External prop file: 'external.rb' doesn't exist"
     end
   end
-  
+
   it "should fail with PropException when there's problem in the external file" do
     loader = make_mock("loader", :exists? => true)
     loader.should_receive(:load).with("external.rb").and_return("+")
-    
+
     begin
       root = Limelight::build_scene(@options.merge(:id => 321, :build_loader => loader)) do
         __install "external.rb"
-      end  
+      end
     rescue Limelight::BuildException => e
       e.message.should include("external.rb:1: (eval):1: , unexpected end-of-file")
     end
   end
-  
+
   it "should build onto an existing block" do
     prop = Limelight::Prop.new
     prop.set_scene(Limelight::Scene.new(:casting_director => make_mock(:casting_director, :fill_cast => nil)))
     builder = Limelight::PropBuilder.new(prop)
     block = Proc.new { one; two { three } }
     builder.instance_eval(&block)
-    
+
     prop.children.length.should == 2
     prop.children[0].name.should == "one"
     prop.children[1].name.should == "two"
     prop.children[1].children.length.should == 1
     prop.children[1].children[0].name.should == "three"
   end
-  
+
+  it "should not crash with prop named display" do
+    root = Limelight::build_scene(@options) do
+      display :id => "display"
+    end
+
+    root.children.size.should == 1
+    display = root.children[0]
+    display.name.should == "display"
+    display.id.should == "display"
+  end
+
 end

data/spec/prop_spec.rb

@@ -40,7 +40,7 @@ describe Limelight::Prop do
       end
     end
     
-    @prop.add_controller(TestController)
+    @prop.include_player(TestController)
     
     TestController.extended_prop.should == @prop
     @prop.respond_to?(:test_method).should == true
@@ -85,6 +85,10 @@ describe Limelight::Prop do
   it "should get and set text" do
     @prop.text = "blah"
     @prop.text.should == "blah"
+    @prop.text = 123
+    @prop.text.should == "123"
+    @prop.text = nil
+    @prop.text.should == ""
   end
   
   it "should have controllers" do

data/spec/stage_spec.rb

@@ -8,7 +8,7 @@ describe Limelight::Stage do
 
   before(:each) do
     @theater = make_mock("theater")
-    @stage = Limelight::Stage.new(@theater, "George")
+    @__stage__ = Limelight::Stage.new(@theater, "George")
   end
   
   it "should have a name" do
@@ -18,40 +18,40 @@ describe Limelight::Stage do
   end
   
   it "should have a title which default to it's name" do
-    @stage.title.should == "George"
+    @__stage__.title.should == "George"
     
-    @stage.title = "Once Upon a Test"
+    @__stage__.title = "Once Upon a Test"
     
-    @stage.title.should == "Once Upon a Test"
+    @__stage__.title.should == "Once Upon a Test"
   end
   
   it "should have size" do
-    @stage.size.should == [800, 800]
+    @__stage__.size.should == [800, 800]
     
-    @stage.size = 123, 456
+    @__stage__.size = 123, 456
     
-    @stage.size.should == [123, 456]
+    @__stage__.size.should == [123, 456]
   end
   
-  it "should have size" do
-    @stage.location.should == [200, 25]
+  it "should have location" do
+    @__stage__.location.should == [200, 25]
     
-    @stage.location = 123, 456
+    @__stage__.location = 123, 456
     
-    @stage.location.should == [123, 456]
+    @__stage__.location.should == [123, 456]
   end
   
   it "should not allow name changes" do
-    lambda { @stage.name = "new name" }.should raise_error
+    lambda { @__stage__.name = "new name" }.should raise_error
   end
 
   it "should call scene.scene_opened at the end of opening a scene" do
     scene = make_mock("scene", :visible= => nil)
     scene.should_receive(:scene_opened)
 
-    @stage.frame.stub!(:open)
-    @stage.stub!(:load_scene)
-    @stage.open(scene)
+    @__stage__.frame.stub!(:open)
+    @__stage__.stub!(:load_scene)
+    @__stage__.open(scene)
   end
 
 end