glimmer-dsl-libui 0.4.8 → 0.4.12

data/examples/snake2.rb

@@ -0,0 +1,97 @@
+require 'glimmer-dsl-libui'
+
+require_relative 'snake/presenter/grid'
+
+class Snake
+  include Glimmer
+  
+  CELL_SIZE = 15
+  SNAKE_MOVE_DELAY = 0.1
+  
+  def initialize
+    @game = Model::Game.new
+    @grid = Presenter::Grid.new(@game)
+    @game.start
+    @keypress_queue = []
+    create_gui
+    register_observers
+  end
+  
+  def launch
+    @main_window.show
+  end
+  
+  def register_observers
+    @game.height.times do |row|
+      @game.width.times do |column|
+        observe(@grid.cells[row][column], :color) do |new_color|
+          @cell_grid[row][column].fill = new_color
+        end
+      end
+    end
+    
+    observe(@game, :over) do |game_over|
+      Glimmer::LibUI.queue_main do
+        if game_over
+          msg_box('Game Over!', "Score: #{@game.score} | High Score: #{@game.high_score}")
+          @game.start
+        end
+      end
+    end
+    
+    Glimmer::LibUI.timer(SNAKE_MOVE_DELAY) do
+      unless @game.over?
+        process_queued_keypress
+        @game.snake.move
+      end
+    end
+  end
+  
+  def process_queued_keypress
+    # key press queue ensures one turn per snake move to avoid a double-turn resulting in instant death (due to snake illogically going back against itself)
+    key = @keypress_queue.shift
+    case [@game.snake.head.orientation, key]
+    in [:north, :right] | [:east, :down] | [:south, :left] | [:west, :up]
+      @game.snake.turn_right
+    in [:north, :left] | [:west, :down] | [:south, :right] | [:east, :up]
+      @game.snake.turn_left
+    else
+      # No Op
+    end
+  end
+  
+  def create_gui
+    @cell_grid = []
+    @main_window = window {
+      # data-bind window title to game score, converting it to a title string on read from the model
+      title <= [@game, :score, on_read: -> (score) {"Snake (Score: #{@game.score})"}]
+      content_size @game.width * CELL_SIZE, @game.height * CELL_SIZE
+      resizable false
+      
+      vertical_box {
+        padded false
+        
+        @game.height.times do |row|
+          @cell_grid << []
+          horizontal_box {
+            padded false
+            
+            @game.width.times do |column|
+              area {
+                @cell_grid.last << square(0, 0, CELL_SIZE) {
+                  fill Presenter::Cell::COLOR_CLEAR
+                }
+                
+                on_key_up do |area_key_event|
+                  @keypress_queue << area_key_event[:ext_key]
+                end
+              }
+            end
+          }
+        end
+      }
+    }
+  end
+end
+
+Snake.new.launch

data/examples/tic_tac_toe.rb

@@ -41,6 +41,7 @@ class TicTacToe
                 text(23, 19) {
                   string {
                     font family: 'Arial', size: OS.mac? ? 20 : 16
+                    # data-bind string property of area text attributed string to tic tac toe board cell sign
                     string <= [@tic_tac_toe_board[row + 1, column + 1], :sign] # board model is 1-based
                   }
                 }

data/examples/tic_tac_toe2.rb

@@ -0,0 +1,84 @@
+
+require 'glimmer-dsl-libui'
+
+require_relative "tic_tac_toe/board"
+
+class TicTacToe
+  include Glimmer
+
+  def initialize
+    @tic_tac_toe_board = Board.new
+  end
+  
+  def launch
+    create_gui
+    register_observers
+    @main_window.show
+  end
+  
+  def register_observers
+    observe(@tic_tac_toe_board, :game_status) do |game_status|
+      display_win_message if game_status == Board::WIN
+      display_draw_message if game_status == Board::DRAW
+    end
+    
+    3.times.map do |row|
+      3.times.map do |column|
+        observe(@tic_tac_toe_board[row + 1, column + 1], :sign) do |sign| # board model is 1-based
+          @cells[row][column].string = sign
+        end
+      end
+    end
+  end
+
+  def create_gui
+    @main_window = window('Tic-Tac-Toe', 180, 180) {
+      resizable false
+      
+      @cells = []
+      vertical_box {
+        padded false
+        
+        3.times.map do |row|
+          @cells << []
+          horizontal_box {
+            padded false
+            
+            3.times.map do |column|
+              area {
+                square(0, 0, 60) {
+                  stroke :black, thickness: 2
+                }
+                text(23, 19) {
+                  @cells[row] << string('') {
+                    font family: 'Arial', size: OS.mac? ? 20 : 16
+                  }
+                }
+                on_mouse_up do
+                  @tic_tac_toe_board.mark(row + 1, column + 1) # board model is 1-based
+                end
+              }
+            end
+          }
+        end
+      }
+    }
+  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_text)
+    Glimmer::LibUI.queue_main do
+      msg_box('Game Over', message_text)
+      @tic_tac_toe_board.reset!
+    end
+  end
+end
+
+TicTacToe.new.launch

data/lib/glimmer/dsl/libui/control_expression.rb

@@ -39,8 +39,9 @@ module Glimmer
         end
         
         def add_content(parent, keyword, *args, &block)
+          options = args.last.is_a?(Hash) ? args.last : {post_add_content: true}
           super
-          parent&.post_add_content
+          parent&.post_add_content if options[:post_add_content]
         end
       end
     end

data/lib/glimmer/dsl/libui/shape_expression.rb

@@ -47,10 +47,10 @@ module Glimmer
         end
         
         def add_content(parent, keyword, *args, &block)
+          options = args.last.is_a?(Hash) ? args.last : {post_add_content: true}
           super
-          parent.post_add_content
+          parent&.post_add_content if options[:post_add_content]
         end
-        
       end
     end
   end

data/lib/glimmer/dsl/libui/string_expression.rb

@@ -46,7 +46,8 @@ module Glimmer
         end
         
         def add_content(parent, keyword, *args, &block)
-          parent.post_add_content(block)
+          options = args.last.is_a?(Hash) ? args.last : {post_add_content: true}
+          parent&.post_add_content(block) if options[:post_add_content]
         end
       end
     end

data/lib/glimmer/libui/attributed_string.rb

@@ -30,8 +30,9 @@ module Glimmer
     class AttributedString
       include DataBindable
       
-      attr_reader :keyword, :parent_proxy, :args
+      attr_reader :keyword, :parent_proxy, :args, :content_added
       attr_accessor :block
+      alias content_added? content_added
     
       def initialize(keyword, parent_proxy, args, &block)
         @keyword = keyword
@@ -205,7 +206,7 @@ module Glimmer
       end
       
       def content(&block)
-        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::StringExpression.new, @keyword, &block)
+        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::StringExpression.new, @keyword, {post_add_content: true}, &block)
       end
     end
   end

data/lib/glimmer/libui/control_proxy/checkbox_proxy.rb

@@ -30,8 +30,7 @@ module Glimmer
       class CheckboxProxy < ControlProxy
         DEFAULT_TEXT = ''
       
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_toggled') { model_binding.call(checked) } if property == 'checked'
         end
         

data/lib/glimmer/libui/control_proxy/color_button_proxy.rb

@@ -114,8 +114,7 @@ module Glimmer
           super
         end
         
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(color) } if property == 'color'
         end
       end

data/lib/glimmer/libui/control_proxy/column/background_color_column_proxy.rb

@@ -31,6 +31,10 @@ module Glimmer
         # Follows the Proxy Design Pattern
         class BackgroundColorColumnProxy < ControlProxy
           include Column
+          
+          def name
+            'Background Color'
+          end
         end
       end
     end

data/lib/glimmer/libui/control_proxy/combobox_proxy.rb

@@ -64,8 +64,7 @@ module Glimmer
         alias set_selected_item selected_item
         alias selected_item= selected_item
         
-        def data_bind(property, model_binding)
-          super # model to view data-binding
+        def data_bind_write(property, model_binding)
           case property
           when 'selected'
             handle_listener('on_selected') { model_binding.call(selected) }

data/lib/glimmer/libui/control_proxy/date_time_picker_proxy.rb

@@ -65,8 +65,7 @@ module Glimmer
           super
         end
         
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(time) } if property == 'time'
         end
       end

data/lib/glimmer/libui/control_proxy/editable_combobox_proxy.rb

@@ -40,8 +40,7 @@ module Glimmer
         alias set_items items
         alias items= items
         
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(text) } if property == 'text'
         end
       end

data/lib/glimmer/libui/control_proxy/entry_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class EntryProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(text) } if property == 'text'
         end
         

data/lib/glimmer/libui/control_proxy/font_button_proxy.rb

@@ -65,7 +65,11 @@ module Glimmer
           super
         end
         
-        def data_bind(property, model_binding)
+        def data_bind_read(property, model_binding)
+          # No Op
+        end
+        
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(font) } if property == 'font'
         end
       end

data/lib/glimmer/libui/control_proxy/menu_item_proxy/check_menu_item_proxy.rb

@@ -29,8 +29,7 @@ module Glimmer
         #
         # Follows the Proxy Design Pattern
         class CheckMenuItemProxy < MenuItemProxy
-          def data_bind(property, model_binding)
-            super
+          def data_bind_write(property, model_binding)
             handle_listener('on_clicked') { model_binding.call(checked) } if property == 'checked'
           end
         

data/lib/glimmer/libui/control_proxy/menu_item_proxy/radio_menu_item_proxy.rb

@@ -65,8 +65,7 @@ module Glimmer
             end
           end
         
-          def data_bind(property, model_binding)
-            super
+          def data_bind_write(property, model_binding)
             handle_listener('on_clicked') { model_binding.call(checked) } if property == 'checked'
           end
         

data/lib/glimmer/libui/control_proxy/multiline_entry_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class MultilineEntryProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(text) } if property == 'text'
         end
         

data/lib/glimmer/libui/control_proxy/radio_buttons_proxy.rb

@@ -50,8 +50,7 @@ module Glimmer
         alias set_selected_item selected_item
         alias selected_item= selected_item
         
-        def data_bind(property, model_binding)
-          super # model to view data-binding
+        def data_bind_write(property, model_binding)
           case property
           when 'selected'
             handle_listener('on_selected') { model_binding.call(selected) }

data/lib/glimmer/libui/control_proxy/slider_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class SliderProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(value) } if property == 'value'
         end
       end

data/lib/glimmer/libui/control_proxy/spinbox_proxy.rb

@@ -28,8 +28,7 @@ module Glimmer
       #
       # Follows the Proxy Design Pattern
       class SpinboxProxy < ControlProxy
-        def data_bind(property, model_binding)
-          super
+        def data_bind_write(property, model_binding)
           handle_listener('on_changed') { model_binding.call(value) } if property == 'value'
         end
       end

data/lib/glimmer/libui/control_proxy/table_proxy.rb

@@ -38,7 +38,7 @@ module Glimmer
         
         LISTENERS = ['on_changed', 'on_edited']
         
-        attr_reader :model_handler, :model, :table_params, :columns
+        attr_reader :model_handler, :model, :table_params, :columns, :column_attributes
       
         def initialize(keyword, parent, args, &block)
           @keyword = keyword
@@ -75,6 +75,7 @@ module Glimmer
         
         def destroy
           super
+          @cell_rows_observer&.unobserve(self, :cell_rows, recursive: true)
           @destroyed = true
         end
         
@@ -82,10 +83,11 @@ module Glimmer
           if rows.nil?
             @cell_rows
           else
-            @cell_rows = rows
-            @cell_rows.tap do
-              @last_cell_rows = array_deep_clone(@cell_rows)
-              Glimmer::DataBinding::Observer.proc do |new_cell_rows|
+            if rows != @cell_rows
+              @cell_rows = rows
+              @cell_rows = @cell_rows.to_a if @cell_rows.is_a?(Enumerator)
+              @last_cell_rows ||= array_deep_clone(@cell_rows)
+              @cell_rows_observer ||= Glimmer::DataBinding::Observer.proc do |new_cell_rows|
                 if @cell_rows.size < @last_cell_rows.size && @last_cell_rows.include_all?(*@cell_rows)
                   @last_cell_rows.array_diff_indexes(@cell_rows).reverse.each do |row|
                     ::LibUI.table_model_row_deleted(model, row)
@@ -106,8 +108,11 @@ module Glimmer
                 end
                 @last_last_cell_rows = array_deep_clone(@last_cell_rows)
                 @last_cell_rows = array_deep_clone(@cell_rows)
-              end.observe(self, :cell_rows, recursive: true)
+              end.tap do |cell_rows_observer|
+                cell_rows_observer.observe(self, :cell_rows, recursive: true)
+              end
             end
+            @cell_rows
           end
         end
         alias cell_rows= cell_rows
@@ -119,6 +124,7 @@ module Glimmer
         
         def expand(cell_rows)
           cell_rows.to_a.map do |row|
+            row = @column_attributes.map {|attribute| row.send(attribute) } if @column_attributes&.any? && !row.is_a?(Array)
             row.flatten(1)
           end
         end
@@ -134,6 +140,46 @@ module Glimmer
         alias set_editable editable
         alias editable? editable
         
+        def data_bind_read(property, model_binding)
+          if model_binding.binding_options[:column_attributes].is_a?(Array)
+            @column_attributes = model_binding.binding_options[:column_attributes]
+          else
+            column_attribute_mapping = model_binding.binding_options[:column_attributes].is_a?(Hash) ? model_binding.binding_options[:column_attributes] : {}
+            @column_attributes = columns.select {|column| column.is_a?(Column)}.map(&:name).map {|column_name| column_attribute_mapping[column_name] || column_name.underscore}
+          end
+          model_attribute_observer = model_attribute_observer_registration = nil
+          model_attribute_observer = Glimmer::DataBinding::Observer.proc do
+            new_value = model_binding.evaluate_property
+            new_value = new_value.to_a if new_value.is_a?(Enumerator)
+            if model_binding.binding_options[:column_attributes] || (!new_value.empty? && !new_value.first.is_a?(Array))
+              @model_attribute_array_observer_registration&.deregister
+              @model_attribute_array_observer_registration = model_attribute_observer.observe(new_value, @column_attributes)
+              model_attribute_observer.add_dependent(model_attribute_observer_registration => @model_attribute_array_observer_registration)
+            end
+            # TODO look if multiple notifications are happening as a result of observing array and observing model binding
+            send("#{property}=", new_value) unless @last_cell_rows == new_value
+          end
+          model_attribute_observer_registration = model_attribute_observer.observe(model_binding)
+          model_attribute_observer.call # initial update
+          data_binding_model_attribute_observer_registrations << model_attribute_observer_registration
+          model_attribute_observer
+        end
+        
+        def data_bind_write(property, model_binding)
+          # TODO ensure writing is happening to models if rows are not arrays
+          handle_listener('on_edited') { model_binding.call(cell_rows) } if property == 'cell_rows'
+        end
+        
+        def array_deep_clone(array_or_object)
+          if array_or_object.is_a?(Array)
+            array_or_object.map do |element|
+              array_deep_clone(element)
+            end
+          else
+            array_or_object.clone
+          end
+        end
+        
         private
         
         def build_control
@@ -162,11 +208,13 @@ module Glimmer
             when Column::TextColumnProxy, Column::ButtonColumnProxy, Column::TextColorColumnProxy, :text
               ::LibUI.new_table_value_string((expanded_cell_rows[row] && expanded_cell_rows[row][column]).to_s)
             when Column::ImageColumnProxy, Column::ImageTextColumnProxy, Column::ImageTextColorColumnProxy
-              if OS.windows? && row == cell_rows.count
-                ::LibUI.new_table_value_image((expanded_cell_rows[row - 1] && (expanded_cell_rows[row - 1][column].respond_to?(:libui) ? expanded_cell_rows[row - 1][column].libui : expanded_cell_rows[row - 1][column])))
-              else
-                ::LibUI.new_table_value_image((expanded_cell_rows[row] && (expanded_cell_rows[row][column].respond_to?(:libui) ? expanded_cell_rows[row][column].libui : expanded_cell_rows[row][column])))
-              end
+              # TODO refactor to eliminate redundancy and share similar code
+              row = row - 1 if OS.windows? && row == cell_rows.count
+              img = expanded_cell_rows[row][column]
+              img = ControlProxy::ImageProxy.new('image', nil, img) if img.is_a?(Array)
+              img = ControlProxy::ImageProxy.new('image', nil, [img]) if img.is_a?(String)
+              img = img.respond_to?(:libui) ? img.libui : img
+              ::LibUI.new_table_value_image(img)
             when Column::CheckboxColumnProxy, Column::CheckboxTextColumnProxy, Column::CheckboxTextColorColumnProxy
               ::LibUI.new_table_value_int(((expanded_cell_rows[row] && (expanded_cell_rows[row][column] == 1 || expanded_cell_rows[row][column].to_s.strip.downcase == 'true' ? 1 : 0))) || 0)
             when Column::ProgressBarColumnProxy
@@ -193,28 +241,56 @@ module Glimmer
             when Column::TextColumnProxy
               column = @columns[column].index
               @cell_rows[row] ||= []
-              @cell_rows[row][column] = ::LibUI.table_value_string(val).to_s
+              if @cell_rows[row].is_a?(Array)
+                @cell_rows[row][column] = ::LibUI.table_value_string(val).to_s
+              else
+                attribute = @column_attributes[column]
+                @cell_rows[row].send("#{attribute}=", ::LibUI.table_value_string(val).to_s)
+              end
             when Column::TextColorColumnProxy
               column = @columns[column].index
               @cell_rows[row] ||= []
-              @cell_rows[row][column] ||= []
-              @cell_rows[row][column][0] = ::LibUI.table_value_string(val).to_s
+              if @cell_rows[row].is_a?(Array)
+                @cell_rows[row][column] ||= []
+                @cell_rows[row][column][0] = ::LibUI.table_value_string(val).to_s
+              else
+                attribute = @column_attributes[column]
+                @cell_rows[row].send("#{attribute}=", []) unless @cell_rows[row].send(attribute)
+                @cell_rows[row].send(attribute)[0] = ::LibUI.table_value_string(val).to_s
+              end
             when :text
               column = @columns[column - 1].index
               @cell_rows[row] ||= []
-              @cell_rows[row][column] ||= []
-              @cell_rows[row][column][1] = ::LibUI.table_value_string(val).to_s
+              if @cell_rows[row].is_a?(Array)
+                @cell_rows[row][column] ||= []
+                @cell_rows[row][column][1] = ::LibUI.table_value_string(val).to_s
+              else
+                attribute = @column_attributes[column]
+                @cell_rows[row].send("#{attribute}=", []) unless @cell_rows[row].send(attribute)
+                @cell_rows[row].send(attribute)[1] = ::LibUI.table_value_string(val).to_s
+              end
             when Column::ButtonColumnProxy
               @columns[column].notify_listeners(:on_clicked, row)
             when Column::CheckboxColumnProxy
               column = @columns[column].index
               @cell_rows[row] ||= []
-              @cell_rows[row][column] = ::LibUI.table_value_int(val).to_i == 1
+              if @cell_rows[row].is_a?(Array)
+                @cell_rows[row][column] = ::LibUI.table_value_int(val).to_i == 1
+              else
+                attribute = @column_attributes[column]
+                @cell_rows[row].send("#{attribute}=", ::LibUI.table_value_int(val).to_i == 1)
+              end
             when Column::CheckboxTextColumnProxy
               column = @columns[column].index
               @cell_rows[row] ||= []
-              @cell_rows[row][column] ||= []
-              @cell_rows[row][column][0] = ::LibUI.table_value_int(val).to_i == 1
+              if @cell_rows[row].is_a?(Array)
+                @cell_rows[row][column] ||= []
+                @cell_rows[row][column][0] = ::LibUI.table_value_int(val).to_i == 1
+              else
+                attribute = @column_attributes[column]
+                @cell_rows[row].send("#{attribute}=", []) unless @cell_rows[row].send(attribute)
+                @cell_rows[row].send(attribute)[0] = ::LibUI.table_value_int(val).to_i == 1
+              end
             end
             on_edited.each {|listener| listener.call(row, @cell_rows[row])}
           end
@@ -238,16 +314,6 @@ module Glimmer
           @next_column_index ||= -1
           @next_column_index += 1
         end
-        
-        def array_deep_clone(array_or_object)
-          if array_or_object.is_a?(Array)
-            array_or_object.map do |element|
-              array_deep_clone(element)
-            end
-          else
-            array_or_object.clone
-          end
-        end
       end
     end
   end

data/lib/glimmer/libui/control_proxy.rb

@@ -126,7 +126,8 @@ module Glimmer
       ]
       
       # libui returns the contained LibUI object
-      attr_reader :parent_proxy, :libui, :args, :keyword, :block
+      attr_reader :parent_proxy, :libui, :args, :keyword, :block, :content_added
+      alias content_added? content_added
       
       def initialize(keyword, parent, args, &block)
         @keyword = keyword
@@ -288,6 +289,7 @@ module Glimmer
       end
       
       def destroy
+        data_binding_model_attribute_observer_registrations.each(&:deregister)
         if parent_proxy.nil?
           default_destroy
         else
@@ -337,7 +339,7 @@ module Glimmer
       alias visible= visible
       
       def content(&block)
-        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::ControlExpression.new, @keyword, &block)
+        Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::ControlExpression.new, @keyword, {post_add_content: @content_added}, &block)
       end
       
       private