glimmer 0.1.0.0

data/README

@@ -0,0 +1,27 @@
+Glimmer - a JRuby DSL that enables easy and efficient authoring of user-interfaces 
+using the robust platform-independent Eclipse SWT library. Glimmer comes with built-in 
+data-binding support to greatly facilitate synchronizing UI with domain models.
+
+Copyright (C) 2007 Annas Al Maleh
+Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+Instructions for use with stand-alone SWT:
+1. Download the "SWT binary and source" archive from the Eclipse site and follow their instructions.
+   http://download.eclipse.org/eclipse/downloads/drops/R-3.3.1.1-200710231652/details.php#SWT
+2. Have your program require the swt.rb file
+3. Create a class that includes the Glimmer module and you will be able to write Glimmer syntax
+
+Instructions for use with Eclipse:
+1. Download and setup Eclipse 3.3 or 3.2
+2. Download and setup jRuby 1.0.2
+3. Modify Java launch command in jRuby script/batch file to include SWT libraries in both:
+ a. Classpath; must include %ECLIPSE_HOME%/plugins/org.eclipse.swt*.jar 
+  For example with Eclipse 3.2 on Windows, we add the following: 
+  -cp "%CLASSPATH%;%ECLIPSE_HOME%\plugins\org.eclipse.swt.win32.win32.x86_3.2.0.v3232m.jar;%ECLIPSE_HOME%\plugins\org.eclipse.swt_3.2.0.v3232o.jar"
+ b. java.library.path; must point to %ECLIPSE_HOME%/plugins/org.eclipse.swt* folder 
+  For example, with Eclipse 3.2 on Windows, we add the following:
+  -Djava.library.path="%ECLIPSE_HOME%\plugins\org.eclipse.swt.win32.win32.x86_3.2.0.v3232m" 
+4. Have your program require the glimmer.rb file
+5. Create a class that includes the Glimmer module and you will be able to write Glimmer syntax
+
+Check samples folder for examples on how to write Glimmer programs.

data/samples/contactmanager/contact.rb

@@ -0,0 +1,12 @@
+# Copyright (C) 2007-2008 Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+class Contact
+  attr_accessor :first_name, :last_name, :email
+  
+  def initialize(attribute_map)
+    @first_name = attribute_map[:first_name]
+    @last_name = attribute_map[:last_name]
+    @email = attribute_map[:email]
+  end
+end

data/samples/contactmanager/contact_manager.rb

@@ -0,0 +1,65 @@
+# Copyright (C) 2007-2008 Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+require File.dirname(__FILE__) + "/contact_manager_presenter"
+require File.dirname(__FILE__) + "/../../src/swt"
+
+class RWidget
+  include_package 'org.eclipse.jface.viewers'
+end
+
+class ContactManager
+  extend Glimmer
+
+  include_package 'org.eclipse.swt'
+  include_package 'org.eclipse.swt.widgets'
+  include_package 'org.eclipse.swt.layout'
+  include_package 'org.eclipse.jface.viewers'
+  
+  contact_manager_presenter = ContactManagerPresenter.new
+  
+  shell {
+    text "Contact Manager"
+    composite {
+      composite {
+        layout GridLayout.new(2, false)
+        label {text "First &Name: "}
+        text {
+          text bind(contact_manager_presenter, :first_name)
+        }
+        label {text "&Last Name: "}
+        text {
+          text bind(contact_manager_presenter, :last_name)
+        }
+        label {text "&Email: "}
+        text {
+          text bind(contact_manager_presenter, :email)
+        }
+      }
+      
+      table {
+        layout_data GridData.new(fill, fill, true, true)
+        table_column {
+          text "First Name"
+          width 80
+        }
+        table_column {
+          text "Last Name"
+          width 80
+        }
+        table_column {
+          text "Email"
+          width 120
+        }
+        items bind(contact_manager_presenter, :results), column_properties(:first_name, :last_name, :email)
+      }
+      
+      button {
+        text "&Find"
+        on_widget_selected {
+          contact_manager_presenter.find
+        }
+      }
+    }
+  }.open
+end

data/samples/contactmanager/contact_manager_presenter.rb

@@ -0,0 +1,23 @@
+# Copyright (C) 2007-2008 Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+require File.dirname(__FILE__) + "/contact_repository"
+
+class ContactManagerPresenter
+  attr_accessor :results
+  @@contact_attributes = [:first_name, :last_name, :email]
+  @@contact_attributes.each {|attribute_name| attr_accessor attribute_name}
+  
+  def initialize
+    @contact_repository = ContactRepository.new
+    @results = []
+  end
+  
+  def find
+    filter_map = Hash.new
+    @@contact_attributes.each do |attribute_name| 
+      filter_map[attribute_name] = self.send(attribute_name) if self.send(attribute_name)
+    end
+    self.results=@contact_repository.find(filter_map)
+  end
+end

data/samples/contactmanager/contact_repository.rb

@@ -0,0 +1,27 @@
+# Copyright (C) 2007-2008 Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+require File.dirname(__FILE__) + "/contact"
+
+class ContactRepository
+  def initialize
+    @contacts = [
+      Contact.new(:first_name => "Anne", :last_name => "Sweeney", :email => "anne@sweeny.com"),
+      Contact.new(:first_name => "Beatrice", :last_name => "Jung", :email => "beatrice@jung.com"),
+      Contact.new(:first_name => "Frank", :last_name => "Deelio", :email => "frank@deelio.com"),
+      Contact.new(:first_name => "franky", :last_name => "miller", :email => "frank@miller.com"),
+    ]
+  end
+  
+  def find(attribute_filter_map)
+    @contacts.find_all do |contact|
+      match = true
+      attribute_filter_map.keys.each do |attribute_name|
+        contact_value = contact.send(attribute_name).downcase
+        filter_value = attribute_filter_map[attribute_name].downcase
+        match = false unless contact_value.match(filter_value)
+      end
+      match
+    end
+  end
+end

data/samples/hello_world.rb

@@ -0,0 +1,26 @@
+# Copyright (C) 2007-2008 Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+require "java"
+require File.dirname(__FILE__) + "/../src/swt"
+
+class HelloWorld
+	include_package 'org.eclipse.swt'
+	include_package 'org.eclipse.swt.layout'
+	
+	include Glimmer
+
+	def launch
+		@shell = shell {
+			text "SWT"
+			composite {
+				label { 
+					text "Hello World!" 
+				}
+			}
+		}
+    @shell.open
+	end
+end
+
+HelloWorld.new.launch

data/samples/login.rb

@@ -0,0 +1,97 @@
+# Copyright (C) 2007-2008 Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+require "java"
+require "observer"
+require File.dirname(__FILE__) + "/../src/swt"
+
+#Presents login screen data
+class LoginPresenter
+  
+  attr_accessor :user_name
+  attr_accessor :password
+  attr_accessor :status
+  
+  def initialize
+    @user_name = ""
+    @password = ""
+    @status = "Logged Out"
+  end
+  
+  def status=(status)
+    @status = status
+    
+    #TODO add feature to bind dependent properties to master property
+    notify_observers("logged_in") 
+    notify_observers("logged_out")
+  end
+  
+  def logged_in
+    self.status == "Logged In"
+  end
+  
+  def logged_out
+    !self.logged_in
+  end
+  
+  def login
+    self.user_name = ""
+    self.password = ""
+    self.status = "Logged In"
+  end
+  
+  def logout
+    self.user_name = ""
+    self.password = ""
+    self.status = "Logged Out"
+  end
+  
+end
+
+#Login screen
+class Login
+  include_package 'org.eclipse.swt'
+  include_package 'org.eclipse.swt.layout'
+  
+  include Glimmer
+  
+  def launch
+    presenter = LoginPresenter.new
+    @shell = shell {
+      text "Login"
+      composite { 
+        layout GridLayout.new(2, false) #two columns with differing widths
+        
+        label { text "Username:" } # goes in column 1
+        text {                     # goes in column 2
+          text bind(presenter, :user_name) 
+          enabled bind(presenter, :logged_out)
+        } 
+        
+        label { text "Password:" } 
+        text(SWT::PASSWORD | SWT::BORDER) { 
+          text bind(presenter, :password) 
+          enabled bind(presenter, :logged_out)
+        }
+        
+        label { text "Status:" } 
+        label { text bind(presenter, :status) }
+        
+        button { 
+          text "Login"
+          enabled bind(presenter, :logged_out)
+          on_widget_selected { presenter.login }
+        }
+        
+        button { 
+          text "Logout"
+          enabled bind(presenter, :logged_in)
+          on_widget_selected { presenter.logout }
+        }
+      }
+    }
+    @shell.open
+  end
+end
+
+Login.new.launch

data/samples/tictactoe/tic_tac_toe.rb

@@ -0,0 +1,67 @@
+# Copyright (C) 2007-2008 Nick Malnick and Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+require File.dirname(__FILE__) + "/../../src/swt"
+require File.dirname(__FILE__) + "/tic_tac_toe_board"
+
+
+class TicTacToe
+  
+  include_package 'org.eclipse.swt'
+  include_package 'org.eclipse.swt.widgets'
+  include_package 'org.eclipse.swt.layout'
+  
+  include Glimmer
+
+  def initialize
+    @tic_tac_toe_board = TicTacToeBoard.new
+    @main = 
+    @shell = shell {
+      text "Tic-Tac-Toe"
+      composite {
+        layout GridLayout.new(3,true) 
+        (1..3).each { |row_number|
+          (1..3).each { |column_number|
+            button { |button_parent|
+              layout_data GridData.new(fill, fill, true, true)
+              text        bind(@tic_tac_toe_board.box(row_number, column_number), :sign)
+              enabled     bind(@tic_tac_toe_board.box(row_number, column_number), :empty)
+              on_widget_selected {
+                @tic_tac_toe_board.mark_box(row_number, column_number)
+              }
+            }
+          }
+        }
+      }
+    }
+    @tic_tac_toe_board.extend(ObservableModel) #make board an observable model
+    @tic_tac_toe_board.add_observer("game_status", self)
+  end
+  
+  def update(game_status) 
+    display_win_message if game_status == TicTacToeBoard::WIN
+    display_draw_message if game_status == TicTacToeBoard::DRAW
+  end
+  
+  def display_win_message()
+    display_game_over_message("Player #{@tic_tac_toe_board.winning_sign} has won!")
+  end
+  
+  def display_draw_message()
+    display_game_over_message("Draw!")
+  end
+  
+  def display_game_over_message(message)
+    message_box = MessageBox.new(@shell.widget)
+    message_box.setText("Game Over")
+    message_box.setMessage(message)
+    message_box.open
+    @tic_tac_toe_board.reset
+  end
+  
+  def open 
+      @main.open
+  end
+end
+
+TicTacToe.new.open

data/samples/tictactoe/tic_tac_toe_board.rb

@@ -0,0 +1,149 @@
+# Copyright (C) 2007-2008 Nick Malnick and Annas Al Maleh
+# Licensed under the LGPL. See /COPYING.LGPL for more details.
+
+class TicTacToeBox
+  EMPTY = ""
+  attr_accessor :sign, :empty
+  
+  def initialize
+    reset
+  end
+
+  def mark_box(sign)
+    self.sign = sign
+  end
+  
+  def reset
+    self.sign = EMPTY
+  end
+  
+  def sign=(sign_symbol)
+    @sign = sign_symbol
+    self.empty = sign == EMPTY
+  end
+  
+  def marked
+    ! empty
+  end
+end
+
+class TicTacToeBoard
+  DRAW = :draw
+  IN_PROGRESS = :in_progress
+  WIN = :win
+  attr :winning_sign
+  attr_accessor :game_status
+  
+  def initialize
+    @sign_state_machine = {nil => "X", "X" => "O", "O" => "X"}
+    build_grid
+    @winning_sign = TicTacToeBox::EMPTY
+    @game_status = IN_PROGRESS
+  end
+  
+  #row and column numbers are 1-based
+  def mark_box(row_number, column_number)
+    box(row_number, column_number).mark_box(current_sign)
+    game_over? #updates winning sign
+  end
+  
+  def current_sign
+    @current_sign = @sign_state_machine[@current_sign]
+  end
+  
+  def box(row_number, column_number)
+    @grid[row_number-1][column_number-1]
+  end 
+  
+  def game_over?
+     win? or draw?
+  end
+  
+  def win?
+    win = (row_win? or column_win? or diagonal_win?)
+    self.game_status=WIN if win
+    win
+  end
+  
+  def reset
+    (1..3).each do |row_number|
+      (1..3).each do |column_number|
+        box(row_number, column_number).reset
+      end
+    end
+    @winning_sign = TicTacToeBox::EMPTY
+    @current_sign = nil
+    self.game_status=IN_PROGRESS
+  end
+  
+  private
+  
+  def build_grid
+    @grid = []
+    3.times do |row_index| #0-based
+      @grid << []
+      3.times { @grid[row_index] << TicTacToeBox.new }
+    end
+  end
+  
+  def row_win?
+    (1..3).each do |row_number| 
+      if row_has_same_sign(row_number)
+        @winning_sign = box(row_number, 1).sign
+        return true
+      end
+    end
+    false
+  end
+  
+  def column_win?
+    (1..3).each do |column_number| 
+      if column_has_same_sign(column_number)
+        @winning_sign = box(1, column_number).sign
+        return true
+      end
+    end
+    false
+  end
+
+  #needs refactoring if we ever decide to make the board size dynamic
+  def diagonal_win?
+    if (box(1,1).sign == box(2,2).sign) and (box(2,2).sign == box(3,3).sign) and box(1,1).marked
+      @winning_sign = box(1,1).sign
+      return true
+    end
+    if (box(3,1).sign == box(2,2).sign) and (box(2,2).sign == box(1,3).sign) and box(3,1).marked
+      @winning_sign = box(3,1).sign
+      return true
+    end
+    false
+  end
+  
+  def draw?
+    @board_full = true
+    3.times do |x|
+      3.times do |y|
+        @board_full = false if box(x, y).empty
+      end
+    end
+    self.game_status = DRAW if @board_full
+    @board_full
+  end
+  
+  def row_has_same_sign(number) 
+    row_sign = box(number, 1).sign
+    [2, 3].each do |column|
+      return false unless row_sign == (box(number, column).sign)
+    end
+    true if box(number, 1).marked
+  end
+ 
+  def column_has_same_sign(number) 
+    column_sign = box(1, number).sign
+    [2, 3].each do |row|
+      return false unless column_sign == (box(row, number).sign)
+    end
+    true if box(1, number).marked
+  end
+ 
+end