glimmer 2.1.5 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c73b637dd451b7033852edb1490cf02f68ac49cdfbaa364ba14f4427a5d35253
-  data.tar.gz: 3c6a2cd64bdf17087150a39427da632912c5c8f2d8a839bb8c6beda90efc1433
+  metadata.gz: 04a3036ea66bf774c6c27cf8b248e5658df35ccc3a69998159e43a013d3489e0
+  data.tar.gz: 4241bfc406e54c13bbc4357918bf2bfed5a353f63f5200eea6ed60e0f7c84281
 SHA512:
-  metadata.gz: 2678b5f34362a5e63de8bfd6951966322b909de0a667e6bf6004d3c78792ea7a9f514cc1159eb84bc257d6152d83f184fb028a718cc6ea5dc8008a777525efdb
-  data.tar.gz: 7b96445440558cf0a2c97ee2b5b2a55ee9d1a1466d54bc849537d7ca73568faf348f21dfba358a4b8d0722ad629e4462952499c58ded0a99b33eceda16542727
+  metadata.gz: ff74a70f8137ce7967d36e47a191ebdf8efbd67e15724449dd9c5b3a9db04d526a3ab00f4ba484d89af71430ed0543217ac7a0722427b47d735baf3ca4adc524
+  data.tar.gz: f854ebfc523130f308b289fcf575d782776057f4f2d212332d38eeb719444e0d8d7790d0f7e2824059a9bccea1f22be532e1bd55619ba2e66dd585930d4574f5

data/CHANGELOG.md

@@ -3,6 +3,27 @@
 Related Change Logs:
 - [glimmer-dsl-swt/CHANGELOG.md](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/CHANGELOG.md)
 
+### 2.3.0
+
+- Have observing `ObservableArray` automatically notice if any values are nested arrays and observe them for micro-changes (recursively all the way down)
+
+### 2.2.2
+
+- Support auto-notifying on `ObservableArray#replace` observed changes
+- Support auto-notifying on `ObservableArray#filter!` observed changes explicitly (even if `filter!` aliases `select!`)
+- Support auto-notifying on `ObservableHash#filter!` observed changes explicitly (even if `filter!` aliases `select!`)
+
+### 2.2.1
+
+- Have `ObservableHash` call `notify_observers(key)` upon performing all mutation operations (as expected): `delete`, `delete_if`, `filter!`, `select!`, `keep_if`, `reject!`, `merge!`, `replace`, `shift`, `transform_keys!`, `transform_values!`
+- Fix issue with `Glimmer::DataBinding::Observer.proc {|new_value| ...}.observe(array)` resulting in new_value coming across as `nil when the array is updated
+
+### 2.2.0
+
+- New `Glimmer::DataBinding::ObservableHash` support for observing `hash[key]=value` mutations
+- Ensure observed ObservableHash values are enhanced with ObservableHash if they were of type Hash
+- Ensure observed ObservableModel values are enhanced with ObservableHash if they were of type Hash
+
 ### 2.1.5
 
 - Upgrade array_include_methods gem to version 1.4.0 (and fix minor version)

data/README.md

@@ -1,4 +1,4 @@
-2.1.5mg src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 style="position: relative; top: 20px;" />](https://rubygems.org/gems/glimmer) Glimmer - DSL Framework for Ruby GUI and More
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 style="position: relative; top: 20px;" />](https://rubygems.org/gems/glimmer) Glimmer - DSL Framework for Ruby GUI and More
 [![Gem Version](https://badge.fury.io/rb/glimmer.svg)](http://badge.fury.io/rb/glimmer)
 [![rspec](https://github.com/AndyObtiva/glimmer/workflows/rspec/badge.svg)](https://github.com/AndyObtiva/glimmer/actions?query=workflow%3Arspec)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer?branch=master)
@@ -210,7 +210,7 @@ end
 ### Setup
 
 Follow these steps to author a [Glimmer](https://rubygems.org/gems/glimmer) DSL:
-- Add `gem 'glimmer', '~> 2.1.5'` to `Gemfile` and run `bundle` or run `gem install glimmer -v2.1.5` and add `require 'glimmer'`
+- Add `gem 'glimmer', '~> 2.3.0'` to `Gemfile` and run `bundle` or run `gem install glimmer -v2.3.0` and add `require 'glimmer'`
 - Create `glimmer/dsl/[dsl_name]/dsl.rb`, which requires and adds all dynamic expressions for the [dsl_name] Glimmer DSL module as per the code shown in the previous section (or [Official DSLs](#official-dsls) as examples)
 - Create `glimmer/dsl/[dsl_name]/[expresion_name]_expresion.rb` for every [expresion_name] expression needed, whether dynamic or static
 
@@ -949,14 +949,6 @@ The main trade-off in using [Glimmer DSL for LibUI](https://rubygems.org/gems/gl
 
 ###### Hello, World!
 
-Mac
-
-![glimmer-dsl-libui-mac-basic-window.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-window.png)
-
-Linux
-
-![glimmer-dsl-libui-linux-basic-window.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-window.png)
-
 ```ruby
 require 'glimmer-dsl-libui'
 
@@ -965,27 +957,25 @@ include Glimmer
 window('hello world').show
 ```
 
-###### Basic Button
-
 Mac
 
-![glimmer-dsl-libui-mac-basic-button.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-button.png)
-![glimmer-dsl-libui-mac-basic-button-msg-box.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-button-msg-box.png)
+![glimmer-dsl-libui-mac-basic-window.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-window.png)
 
 Linux
 
-![glimmer-dsl-libui-linux-basic-button.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-button.png)
-![glimmer-dsl-libui-linux-basic-button-msg-box.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-button-msg-box.png)
+![glimmer-dsl-libui-linux-basic-window.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-window.png)
+
+###### Basic Button
 
 ```ruby
 require 'glimmer-dsl-libui'
 
 include Glimmer
 
-window('hello world', 300, 200) { |w|
+window('hello world', 300, 200) {
   button('Button') {
     on_clicked do
-      msg_box(w, 'Information', 'You clicked the button')
+      msg_box('Information', 'You clicked the button')
     end
   }
   
@@ -995,223 +985,171 @@ window('hello world', 300, 200) { |w|
 }.show
 ```
 
-###### Control Gallery
-
 Mac
 
-![glimmer-dsl-libui-mac-control-gallery.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-control-gallery.png)
+![glimmer-dsl-libui-mac-basic-button.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-button.png)
+![glimmer-dsl-libui-mac-basic-button-msg-box.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-button-msg-box.png)
 
 Linux
 
-![glimmer-dsl-libui-linux-control-gallery.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-control-gallery.png)
+![glimmer-dsl-libui-linux-basic-button.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-button.png)
+![glimmer-dsl-libui-linux-basic-button-msg-box.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-button-msg-box.png)
+
+###### Basic Table Progress Bar
 
 ```ruby
 require 'glimmer-dsl-libui'
 
 include Glimmer
 
-menu('File') {
-  menu_item('Open') {
-    on_clicked do
-      file = open_file(MAIN_WINDOW)
-      puts file unless file.nil?
-    end
-  }
+data = [
+  ['task 1', 0],
+  ['task 2', 15],
+  ['task 3', 100],
+  ['task 4', 75],
+  ['task 5', -1],
+]
 
-  menu_item('Save') {
-    on_clicked do
-      file = save_file(MAIN_WINDOW)
-      puts file unless file.nil?
-    end
-  }
-  
-  quit_menu_item {
-    on_clicked do
-      puts 'Bye Bye'
-    end
-  }
-  
-  preferences_menu_item # Can optionally contain an on_clicked listener
-}
+window('Task Progress', 300, 200) {
+  vertical_box {
+    table {
+      text_column('Task')
+      progress_bar_column('Progress')
 
-menu('Edit') {
-  check_menu_item('Checkable Item_')
-  separator_menu_item
-  menu_item('Disabled Item_') {
-    enabled false
+      cell_rows data # implicit data-binding
+    }
+    
+    button('Mark All As Done') {
+      stretchy false
+      
+      on_clicked do
+        data.each_with_index do |row_data, row|
+          data[row] = [row_data[0], 100] # automatically updates table due to implicit data-binding
+        end
+      end
+    }
   }
-}
-
-menu('Help') {
-  menu_item('Help')
-  
-  about_menu_item # Can optionally contain an on_clicked listener
-}
-
-MAIN_WINDOW = window('Control Gallery', 600, 500) {
-  margined true
-  
-  on_closing do
-    puts 'Bye Bye'
-  end
-  
-  vertical_box {
-    horizontal_box {
-      group('Basic Controls') {
-        vertical_box {
-          button('Button') {
-            stretchy false
-
-            on_clicked do
-              msg_box(MAIN_WINDOW, 'Information', 'You clicked the button')
-            end
-          }
+}.show
+```
 
-          checkbox('Checkbox') {
-            stretchy false
+Mac
 
-            on_toggled do |c|
-              checked = c.checked == 1
-              MAIN_WINDOW.title = "Checkbox is #{checked}"
-              c.text = "I am the checkbox (#{checked})"
-            end
-          }
+![glimmer-dsl-libui-mac-basic-table-progress-bar.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-table-progress-bar.png)
 
-          label('Label') { stretchy false }
+Linux
 
-          horizontal_separator { stretchy false }
+![glimmer-dsl-libui-linux-basic-table-progress-bar.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-table-progress-bar.png)
 
-          date_picker { stretchy false }
+###### Area Gallery
 
-          time_picker { stretchy false }
+```ruby
+require 'glimmer-dsl-libui'
 
-          date_time_picker { stretchy false }
+include Glimmer
 
-          font_button { stretchy false }
+window('Area Gallery', 400, 400) {
+  area {
+    path { # declarative stable path
+      square(0, 0, 100)
+      square(100, 100, 400)
+      
+      fill r: 102, g: 102, b: 204
+    }
+    path { # declarative stable path
+      rectangle(0, 100, 100, 400)
+      rectangle(100, 0, 400, 100)
+      
+      fill r: 204, g: 102, b: 204
+    }
+    path { # declarative stable path
+      figure(100, 100) {
+        line(100, 400)
+        line(400, 100)
+        line(400, 400)
 
-          color_button { stretchy false }
-        }
+        closed true
       }
 
-      vertical_box {
-        group('Numbers') {
-          stretchy false
-
-          vertical_box {
-            spinbox(0, 100) {
-              stretchy false
-              value 42
-
-              on_changed do |s|
-                puts "New Spinbox value: #{s.value}"
-              end
-            }
-
-            slider(0, 100) {
-              stretchy false
-
-              on_changed do |s|
-                v = s.value
-                puts "New Slider value: #{v}"
-                @progress_bar.value = v
-              end
-            }
-
-            @progress_bar = progress_bar { stretchy false }
-          }
-        }
-
-        group('Lists') {
-          stretchy false
-
-          vertical_box {
-            combobox {
-              stretchy false
-              items 'combobox Item 1', 'combobox Item 2', 'combobox Item 3' # also accepts a single array argument
-
-              on_selected do |c|
-                puts "New combobox selection: #{c.selected}"
-              end
-            }
-
-            editable_combobox {
-              stretchy false
-              items 'Editable Item 1', 'Editable Item 2', 'Editable Item 3' # also accepts a single array argument
-            }
+      fill r: 202, g: 102, b: 104, a: 0.5
+      stroke r: 0, g: 0, b: 0
+    }
+    path { # declarative stable path
+      figure(0, 0) {
+        bezier(200, 100, 100, 200, 400, 100)
+        bezier(300, 100, 100, 300, 100, 400)
+        bezier(100, 300, 300, 100, 400, 400)
 
-            radio_buttons {
-              items 'Radio Button 1', 'Radio Button 2', 'Radio Button 3' # also accepts a single array argument
-            }
-          }
-        }
+        closed true
+      }
 
-        tab {
-          tab_item('Page 1') {
-            horizontal_box {
-              entry {
-                text 'Please enter your feelings'
+      fill r: 202, g: 102, b: 204, a: 0.5
+      stroke r: 0, g: 0, b: 0, thickness: 2, dashes: [50, 10, 10, 10], dash_phase: -50.0
+    }
+    path { # declarative stable path
+      arc(200, 200, 90, 0, 360, false)
 
-                on_changed do |e|
-                  puts "Current textbox data: '#{e.text}'"
-                end
-              }
-            }
-          }
-          
-          tab_item('Page 2') {
-            horizontal_box
-          }
-          
-          tab_item('Page 3') {
-            horizontal_box
-          }
-        }
-      }
+      fill r: 202, g: 102, b: 204, a: 0.5
+      stroke r: 0, g: 0, b: 0, thickness: 2
     }
+    
+    on_mouse_event do |area_mouse_event|
+      p area_mouse_event
+    end
+    
+    on_mouse_moved do |area_mouse_event|
+      puts 'moved'
+    end
+    
+    on_mouse_down do |area_mouse_event|
+      puts 'mouse down'
+    end
+    
+    on_mouse_up do |area_mouse_event|
+      puts 'mouse up'
+    end
+    
+    on_mouse_drag_started do |area_mouse_event|
+      puts 'drag started'
+    end
+    
+    on_mouse_dragged do |area_mouse_event|
+      puts 'dragged'
+    end
+    
+    on_mouse_dropped do |area_mouse_event|
+      puts 'dropped'
+    end
+    
+    on_mouse_entered do
+      puts 'entered'
+    end
+    
+    on_mouse_exited do
+      puts 'exited'
+    end
+    
+    on_key_event do |area_key_event|
+      p area_key_event
+    end
+    
+    on_key_up do |area_key_event|
+      puts 'key up'
+    end
+    
+    on_key_down do |area_key_event|
+      puts 'key down'
+    end
   }
-}
-
-MAIN_WINDOW.show
+}.show
 ```
 
-###### Basic Table
-
 Mac
 
-![glimmer-dsl-libui-mac-basic-table.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-table.png)
+![glimmer-dsl-libui-mac-area-gallery.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-area-gallery.png)
 
 Linux
 
-![glimmer-dsl-libui-linux-basic-table.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-table.png)
-
-```ruby
-require 'glimmer-dsl-libui'
-
-include Glimmer
-
-data = [
-  %w[cat meow],
-  %w[dog woof],
-  %w[chicken cock-a-doodle-doo],
-  %w[hourse neigh],
-  %w[cow moo]
-]
-
-window('Animal sounds', 300, 200) {
-  horizontal_box {
-    table {
-      text_column('Animal')
-      text_column('Description')
-
-      cell_rows data
-    }
-  }
-  
-  on_closing do
-    puts 'Bye Bye'
-  end
-}.show
-```
+![glimmer-dsl-libui-linux-area-gallery.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-area-gallery.png)
 
 ## Data-Binding Library
 
@@ -1222,12 +1160,13 @@ Glimmer enhances observed models automatically (including array operations like
 This relies mainly on the Observer Design Pattern and the MVP (Model-View-Presenter) Architectural Pattern (a variation on MVC)
 
 These are the main classes concerning data-binding:
-- `Observer`: Provides general observer support including unique registration and deregistration for cleanup and prevention of memory leaks. Main methods concerned are: `call`, `register` (alias: `observe`), and `unregister` (alias: `unobserve` or `deregister`)
-- `Observable`: General super-module for all observables. Main methods concerned are: `add_observer` and `remove_observer`
-- `ObservableModel`: Mixin module for any observable model with observable attributes. In addition to `Observable` methods, it has a `notify_observers` method to be called when changes occur. It automatically enhances all attribute setters (ending with `=`) to notify observers on changes. Also, it automatically handles observing array attributes using `ObservableArray` appropriately so they would notify observers upon array mutation changes.
-- `ObservableArray`: Mixin module for any observable array collection that automatically handles notifying observers upon performing array mutation operations (e.g. `push` or `delete`)
-- `ModelBinding`: a higher-level abstraction that relies on all the other observer/observable classes to support basic data-binding, nested data-binding, and computed data-binding
-- `Shine`: enables highly intuitive and visually expressive syntax to perform bidirectional (two-way) data-binding with `<=>` and unidirectional (one-way) data-binding with `<=`
+- `Glimmer::DataBinding::Observer`: Provides general observer support including unique registration and deregistration for cleanup and prevention of memory leaks. Main methods concerned are: `call`, `register` (alias: `observe`), and `unregister` (alias: `unobserve` or `deregister`)
+- `Glimmer::DataBinding::Observable`: General super-module for all observables. Main methods concerned are: `add_observer` and `remove_observer`
+- `Glimmer::DataBinding::ObservableModel`: Mixin module for any observable model with observable attributes. In addition to `Observable` methods, it has a `notify_observers` method to be called when changes occur. It automatically enhances all attribute setters (ending with `=`) to notify observers on changes. Also, it automatically handles observing array attributes using `ObservableArray` appropriately so they would notify observers upon array mutation changes.
+- `Glimmer::DataBinding::ObservableArray`: Mixin module for any observable array collection that automatically handles notifying observers upon performing array mutation operations (e.g. `push`, `select!`, or `delete`) recursively (meaning if an array contained arrays and they changed, observers are notified)
+- `Glimmer::DataBinding::ObservableHash`: Mixin module for any observable hash that automatically handles notifying observers upon performing hash mutation operations (e.g. `hash[key]=value`, `select!`, `merge!`)
+- `Glimmer::DataBinding::ModelBinding`: a higher-level abstraction that relies on all the other observer/observable classes to support basic data-binding, nested data-binding, and computed data-binding
+- `Glimmer::DataBinding::Shine`: enables highly intuitive and visually expressive syntax to perform bidirectional (two-way) data-binding with `<=>` and unidirectional (one-way) data-binding with `<=`
 
 You may learn more from [Data-Binding](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md#data-binding) and [Observer](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/docs/reference/GLIMMER_GUI_DSL_SYNTAX.md#observer) usage in [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt)
 

data/VERSION

@@ -1 +1 @@
-2.1.5
+2.3.0

data/glimmer.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer 2.1.5 ruby lib
+# stub: glimmer 2.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer".freeze
-  s.version = "2.1.5"
+  s.version = "2.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["AndyMaleh".freeze]
-  s.date = "2021-09-26"
-  s.description = "Glimmer is a Ruby DSL Framework for Ruby GUI and More, consisting of a DSL Engine and an Observable/Observer/Data-Binding Library. Used in the Glimmer DSL for SWT (JRuby Desktop Development GUI Framework), the Glimmer DSL for Tk (Ruby Desktop Development GUI Library), the Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps), the Glimmer DSL for XML (& HTML), and the Glimmer DSL for CSS.".freeze
+  s.date = "2021-10-07"
+  s.description = "Glimmer is a Ruby DSL Framework for Ruby GUI and More, consisting of a DSL Engine and an Observable / Observer / Data-Binding Library (including Observable Model, Observable Array, and Observable Hash). Used in Glimmer DSL for SWT (JRuby Desktop Development GUI Framework), Glimmer DSL for Tk (Ruby Desktop Development GUI Library), Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI Library), Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps), Glimmer DSL for XML (& HTML), and Glimmer DSL for CSS.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
     "CHANGELOG.md",
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "lib/glimmer/data_binding/model_binding.rb",
     "lib/glimmer/data_binding/observable.rb",
     "lib/glimmer/data_binding/observable_array.rb",
+    "lib/glimmer/data_binding/observable_hash.rb",
     "lib/glimmer/data_binding/observable_model.rb",
     "lib/glimmer/data_binding/observer.rb",
     "lib/glimmer/data_binding/shine.rb",
@@ -50,7 +51,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/AndyObtiva/glimmer".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.2.22".freeze
+  s.rubygems_version = "3.2.28".freeze
   s.summary = "Glimmer - DSL Engine for Ruby GUI and More".freeze
 
   if s.respond_to? :specification_version then

data/lib/glimmer/data_binding/model_binding.rb

@@ -198,7 +198,7 @@ module Glimmer
         end
       end
 
-      def call(value)
+      def call(value, *extra_args)
         return if model.nil?
         converted_value = value
         invoke_property_writer(model, "#{property_name}=", converted_value) unless converted_value == evaluate_property

data/lib/glimmer/data_binding/observable_array.rb

@@ -21,6 +21,7 @@
 
 require 'set'
 require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
 require 'array_include_methods'
 
 using ArrayIncludeMethods
@@ -29,6 +30,20 @@ module Glimmer
   module DataBinding
     module ObservableArray
       include Observable
+      
+      class Notifier
+        include Observer
+        
+        attr_reader :observable_array
+        
+        def initialize(observable_array)
+          @observable_array = observable_array
+        end
+        
+        def call(new_value=nil, *extra_args)
+          @observable_array.notify_observers
+        end
+      end
 
       def add_observer(observer, *element_properties)
         element_properties = element_properties.flatten.compact.uniq
@@ -49,6 +64,23 @@ module Glimmer
         element_properties_for(observer).each do |property|
           observer.observe(element, property)
         end
+        ensure_array_object_observer(element) if element.is_a?(Array)
+      end
+      
+      def ensure_array_object_observer(object)
+        return unless object&.is_a?(Array)
+        array_object_observer = array_object_observer_for(object)
+        array_observer_registration = array_object_observer.observe(object)
+        property_observer_list.each do |observer|
+          my_registration = observer.registration_for(self)
+          observer.add_dependent(my_registration => array_observer_registration)
+        end
+      end
+      
+      def array_object_observer_for(object)
+        @array_object_observers ||= Concurrent::Hash.new
+        @array_object_observers[object] = Notifier.new(self) unless @array_object_observers.has_key?(object)
+        @array_object_observers[object]
       end
 
       def remove_observer(observer, *element_properties)
@@ -76,6 +108,15 @@ module Glimmer
         element_properties_for(observer).each do |property|
           observer.unobserve(element, property)
         end
+        if element.is_a?(ObservableArray)
+          array_object_observer_for(element).unobserve(element)
+          element.property_observer_list.select {|o| o.observable_array == self}.each do |o|
+            o.registrations.each do |registration|
+              registration.deregister
+            end
+            @array_object_observers.reject! {|k, v| v == o}
+          end
+        end
       end
 
       def has_observer?(observer)
@@ -99,7 +140,7 @@ module Glimmer
       end
 
       def notify_observers
-        property_observer_list.to_a.each(&:call)
+        property_observer_list.to_a.each { |o| o.call(self) }
       end
       
       def <<(element)
@@ -237,6 +278,21 @@ module Glimmer
         end
       end
 
+      def filter!(&block)
+        if block_given?
+          old_array = Array.new(self)
+          super(&block).tap do
+            (old_array - self).each do |old_value|
+              unregister_dependent_observers(old_value)
+              remove_element_observers(old_value)
+            end
+            notify_observers
+          end
+        else
+          super
+        end
+      end
+
       def shuffle!(hash = nil)
         (hash.nil? ? super() : super(random: hash[:random])).tap { notify_observers }
       end
@@ -294,6 +350,17 @@ module Glimmer
         end
       end
       
+      def replace(other_array)
+        old_array = Array.new(self)
+        super(other_array).tap do
+          (old_array - self).each do |old_value|
+            unregister_dependent_observers(old_value)
+            remove_element_observers(old_value)
+          end
+          notify_observers
+        end
+      end
+      
       def unregister_dependent_observers(old_value)
         return unless old_value.is_a?(ObservableModel) || old_value.is_a?(ObservableArray)
         property_observer_list.each { |observer| observer.unregister_dependents_with_observable(observer.registration_for(self), old_value) }

data/lib/glimmer/data_binding/observable_hash.rb

@@ -0,0 +1,375 @@
+# Copyright (c) 2007-2021 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'glimmer/data_binding/observable'
+require 'glimmer/data_binding/observer'
+
+module Glimmer
+  module DataBinding
+    module ObservableHash
+      include Observable
+
+      class Notifier
+        include Observer
+        
+        def initialize(observable_model, key)
+          @observable_model = observable_model
+          @key = key
+        end
+        
+        def call(new_value=nil, *extra_args)
+          @observable_model.notify_observers(@key)
+        end
+      end
+      
+      OBSERVED_STORE_METHOD = lambda do |key, value|
+        if key_observer_list(key).empty?
+          if all_key_observer_list.empty?
+            self.send('__original__store', key, value)
+          else
+            old_value = self[key]
+            unregister_dependent_observers(nil, old_value) # remove dependent observers previously installed in ensure_array_object_observer and ensure_hash_object_observer
+            self.send('__original__store', key, value)
+            notify_observers(key)
+            ensure_array_object_observer(nil, value, old_value)
+            ensure_hash_object_observer(nil, value, old_value)
+          end
+        else
+          old_value = self[key]
+          unregister_dependent_observers(key, old_value) # remove dependent observers previously installed in ensure_array_object_observer and ensure_hash_object_observer
+          self.send('__original__store', key, value)
+          notify_observers(key)
+          ensure_array_object_observer(key, value, old_value)
+          ensure_hash_object_observer(key, value, old_value)
+        end
+      end
+
+      def add_observer(observer, key = nil)
+        return observer if has_observer?(observer, key)
+        key_observer_list(key) << observer
+        add_key_writer_observer(key)
+        observer
+      end
+
+      def remove_observer(observer, key = nil)
+        if has_observer?(observer, key)
+          key_observer_list(key).delete(observer)
+          observer.unobserve(self, key)
+        end
+      end
+
+      def remove_observers(key)
+        key_observer_hash[key].each do |observer|
+          remove_observer(observer, key)
+        end
+        key_observer_hash.delete(key)
+      end
+
+      def remove_all_observers
+        all_observers = key_observer_hash.clone
+        key_observer_hash.keys.each do |key|
+          remove_observers(key)
+        end
+        key_observer_hash.clear
+        all_observers
+      end
+
+      def has_observer?(observer, key = nil)
+        key_observer_list(key).include?(observer)
+      end
+
+      def has_observer_for_any_key?(observer)
+        key_observer_hash.values.map(&:to_a).reduce(:+).include?(observer)
+      end
+
+      def key_observer_hash
+        @key_observers ||= Hash.new
+      end
+
+      def key_observer_list(key)
+        key_observer_hash[key] = Concurrent::Set.new unless key_observer_hash[key]
+        key_observer_hash[key]
+      end
+      
+      def all_key_observer_list
+        key_observer_list(nil)
+      end
+      
+      def notify_observers(key)
+        all_key_observer_list.to_a.each { |observer| observer.call(self[key], key) }
+        (key_observer_list(key).to_a - all_key_observer_list.to_a).each { |observer| observer.call(self[key], key) }
+      end
+
+      def add_key_writer_observer(key = nil)
+        ensure_array_object_observer(key, self[key])
+        ensure_hash_object_observer(key, self[key])
+        begin
+          method('__original__store')
+        rescue
+          define_singleton_method('__original__store', store_method)
+          define_singleton_method('[]=', &OBSERVED_STORE_METHOD)
+        end
+      rescue => e
+        #ignore writing if no key writer exists
+        Glimmer::Config.logger.debug {"No need to observe store method: '[]='\n#{e.message}\n#{e.backtrace.join("\n")}"}
+      end
+      
+      def store_method
+        self.class.instance_method('[]=') rescue self.method('[]=')
+      end
+
+      def unregister_dependent_observers(key, old_value)
+        # TODO look into optimizing this
+        return unless old_value.is_a?(ObservableModel) || old_value.is_a?(ObservableArray) || old_value.is_a?(ObservableHash)
+        key_observer_list(key).each { |observer| observer.unregister_dependents_with_observable(observer.registration_for(self, key), old_value) }
+      end
+      alias deregister_dependent_observers unregister_dependent_observers
+
+      def ensure_array_object_observer(key, object, old_object = nil)
+        return unless object&.is_a?(Array)
+        array_object_observer = array_object_observer_for(key)
+        array_observer_registration = array_object_observer.observe(object)
+        key_observer_list(key).each do |observer|
+          my_registration = observer.registration_for(self, key) # TODO eliminate repetition
+          observer.add_dependent(my_registration => array_observer_registration)
+        end
+        array_object_observer_for(key).unregister(old_object) if old_object.is_a?(ObservableArray)
+      end
+
+      def array_object_observer_for(key)
+        @array_object_observers ||= Concurrent::Hash.new
+        @array_object_observers[key] = ObservableModel::Notifier.new(self, key) unless @array_object_observers.has_key?(key)
+        @array_object_observers[key]
+      end
+      
+      def ensure_hash_object_observer(key, object, old_object = nil)
+        return unless object&.is_a?(Hash)
+        hash_object_observer = hash_object_observer_for(key)
+        hash_observer_registration = hash_object_observer.observe(object)
+        key_observer_list(key).each do |observer|
+          my_registration = observer.registration_for(self, key) # TODO eliminate repetition
+          observer.add_dependent(my_registration => hash_observer_registration)
+        end
+        hash_object_observer_for(key).unregister(old_object) if old_object.is_a?(ObservableHash)
+      end
+
+      def hash_object_observer_for(key)
+        @hash_object_observers ||= Concurrent::Hash.new
+        @hash_object_observers[key] = ObservableModel::Notifier.new(self, key) unless @hash_object_observers.has_key?(key)
+        @hash_object_observers[key]
+      end
+      
+      def delete(key, &block)
+        old_value = self[key]
+        unless old_value.nil?
+          unregister_dependent_observers(key, old_value)
+          unregister_dependent_observers(nil, old_value)
+        end
+        super(key, &block).tap do
+          notify_observers(key) unless old_value.nil?
+        end
+      end
+      
+      def delete_if(&block)
+        if block_given?
+          old_hash = self.dup
+          super(&block).tap do |new_hash|
+            deleted_keys = old_hash.keys - new_hash.keys
+            deleted_keys.each do |deleted_key|
+              deleted_value = old_hash[deleted_key]
+              unless deleted_value.nil?
+                unregister_dependent_observers(deleted_key, deleted_value)
+                unregister_dependent_observers(nil, deleted_value)
+                notify_observers(deleted_key)
+              end
+            end
+          end
+        else
+          super
+        end
+      end
+      
+      def select!(&block)
+        if block_given?
+          old_hash = self.dup
+          super(&block).tap do |new_hash|
+            deleted_keys = old_hash.keys - new_hash.keys
+            deleted_keys.each do |deleted_key|
+              deleted_value = old_hash[deleted_key]
+              unless deleted_value.nil?
+                unregister_dependent_observers(deleted_key, deleted_value)
+                unregister_dependent_observers(nil, deleted_value)
+                notify_observers(deleted_key)
+              end
+            end
+          end
+        else
+          super
+        end
+      end
+      
+      def filter!(&block)
+        if block_given?
+          old_hash = self.dup
+          super(&block).tap do |new_hash|
+            deleted_keys = old_hash.keys - new_hash.keys
+            deleted_keys.each do |deleted_key|
+              deleted_value = old_hash[deleted_key]
+              unless deleted_value.nil?
+                unregister_dependent_observers(deleted_key, deleted_value)
+                unregister_dependent_observers(nil, deleted_value)
+                notify_observers(deleted_key)
+              end
+            end
+          end
+        else
+          super
+        end
+      end
+      
+      def keep_if(&block)
+        if block_given?
+          old_hash = self.dup
+          super(&block).tap do |new_hash|
+            deleted_keys = old_hash.keys - new_hash.keys
+            deleted_keys.each do |deleted_key|
+              deleted_value = old_hash[deleted_key]
+              unless deleted_value.nil?
+                unregister_dependent_observers(deleted_key, deleted_value)
+                unregister_dependent_observers(nil, deleted_value)
+                notify_observers(deleted_key)
+              end
+            end
+          end
+        else
+          super
+        end
+      end
+      
+      def reject!(&block)
+        if block_given?
+          old_hash = self.dup
+          super(&block).tap do |new_hash|
+            deleted_keys = old_hash.keys - new_hash.keys
+            deleted_keys.each do |deleted_key|
+              deleted_value = old_hash[deleted_key]
+              unless deleted_value.nil?
+                unregister_dependent_observers(deleted_key, deleted_value)
+                unregister_dependent_observers(nil, deleted_value)
+                notify_observers(deleted_key)
+              end
+            end
+          end
+        else
+          super
+        end
+      end
+      
+      def shift
+        old_hash = self.dup
+        super.tap do
+          new_hash = self
+          deleted_keys = old_hash.keys - new_hash.keys
+          deleted_keys.each do |deleted_key|
+            deleted_value = old_hash[deleted_key]
+            unless deleted_value.nil?
+              unregister_dependent_observers(deleted_key, deleted_value)
+              unregister_dependent_observers(nil, deleted_value)
+              notify_observers(deleted_key)
+            end
+          end
+        end
+      end
+      
+      def merge!(*other_hashes, &block)
+        if other_hashes.empty?
+          super
+        else
+          old_hash = self.dup
+          super(*other_hashes, &block).tap do |new_hash|
+            changed_keys = other_hashes.map(&:keys).reduce(:+)
+            changed_keys.each do |changed_key|
+              old_value = old_hash[changed_key]
+              if new_hash[changed_key] != old_value
+                unregister_dependent_observers(changed_key, old_value)
+                unregister_dependent_observers(nil, old_value)
+                notify_observers(changed_key)
+              end
+            end
+          end
+        end
+      end
+      
+      def replace(other_hash)
+        old_hash = self.dup
+        super(other_hash).tap do |new_hash|
+          changed_keys = old_hash.keys + new_hash.keys
+          changed_keys.each do |changed_key|
+            old_value = old_hash[changed_key]
+            if new_hash[changed_key] != old_value
+              unregister_dependent_observers(changed_key, old_value)
+              unregister_dependent_observers(nil, old_value)
+              notify_observers(changed_key)
+            end
+          end
+        end
+      end
+      
+      def transform_keys!(hash2 = nil, &block)
+        if hash2.nil? && block.nil?
+          super
+        else
+          old_hash = self.dup
+          result = hash2.nil? ? super(&block) : super(hash2, &block)
+          result.tap do |new_hash|
+            changed_keys = old_hash.keys + new_hash.keys
+            changed_keys.each do |changed_key|
+              old_value = old_hash[changed_key]
+              if new_hash[changed_key] != old_value
+                unregister_dependent_observers(changed_key, old_value)
+                unregister_dependent_observers(nil, old_value)
+                notify_observers(changed_key)
+              end
+            end
+          end
+        end
+      end
+      
+      def transform_values!(&block)
+        if block_given?
+          old_hash = self.dup
+          super(&block).tap do |new_hash|
+            new_hash.keys.each do |changed_key|
+              old_value = old_hash[changed_key]
+              if new_hash[changed_key] != old_value
+                unregister_dependent_observers(changed_key, old_value)
+                unregister_dependent_observers(nil, old_value)
+                notify_observers(changed_key)
+              end
+            end
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/data_binding/observable_model.rb

@@ -35,7 +35,7 @@ module Glimmer
           @property_name = property_name
         end
         
-        def call(new_value=nil)
+        def call(new_value=nil, *extra_args)
           @observable_model.notify_observers(@property_name)
         end
       end
@@ -44,10 +44,11 @@ module Glimmer
         property_writer_name = "#{property_name}="
         lambda do |value|
           old_value = self.send(property_name)
-          unregister_dependent_observers(property_name, old_value)
+          unregister_dependent_observers(property_name, old_value) # remove dependent observers previously installed in ensure_array_object_observer and ensure_hash_object_observer
           self.send("__original__#{property_writer_name}", value)
           notify_observers(property_name)
           ensure_array_object_observer(property_name, value, old_value)
+          ensure_hash_object_observer(property_name, value, old_value)
         end
       end
 
@@ -106,6 +107,7 @@ module Glimmer
         property_writer_name = "#{property_name}="
         method(property_writer_name)
         ensure_array_object_observer(property_name, send(property_name))
+        ensure_hash_object_observer(property_name, send(property_name))
         begin
           method("__original__#{property_writer_name}")
         rescue
@@ -141,9 +143,26 @@ module Glimmer
 
       def array_object_observer_for(property_name)
         @array_object_observers ||= Concurrent::Hash.new
-        @array_object_observers[property_name] = ObservableModel::Notifier.new(self, property_name) unless @array_object_observers.has_key?(property_name)
+        @array_object_observers[property_name] = Notifier.new(self, property_name) unless @array_object_observers.has_key?(property_name)
         @array_object_observers[property_name]
       end
+      
+      def ensure_hash_object_observer(property_name, object, old_object = nil)
+        return unless object&.is_a?(Hash)
+        hash_object_observer = hash_object_observer_for(property_name)
+        hash_observer_registration = hash_object_observer.observe(object)
+        property_observer_list(property_name).each do |observer|
+          my_registration = observer.registration_for(self, property_name) # TODO eliminate repetition
+          observer.add_dependent(my_registration => hash_observer_registration)
+        end
+        hash_object_observer_for(property_name).unregister(old_object) if old_object.is_a?(ObservableHash)
+      end
+
+      def hash_object_observer_for(property_name)
+        @hash_object_observers ||= Concurrent::Hash.new
+        @hash_object_observers[property_name] = Notifier.new(self, property_name) unless @hash_object_observers.has_key?(property_name)
+        @hash_object_observers[property_name]
+      end
     end
   end
 end

data/lib/glimmer/data_binding/observer.rb

@@ -41,8 +41,8 @@ module Glimmer
         end
 
         # Called by observables once updates occur sending in the new_value if any
-        def call(new_value=nil)
-          @observer_block.call(new_value)
+        def call(new_value=nil, *extra_args)
+          @observer_block.call(new_value, *extra_args)
         end
       end
 
@@ -86,6 +86,8 @@ module Glimmer
           # TODO refactor code to be more smart/polymorphic/automated and honor open/closed principle
           if observable.is_a?(Array)
             observable.extend(ObservableArray)
+          elsif observable.is_a?(Hash)
+            observable.extend(ObservableHash)
           else
             observable.extend(ObservableModel)
           end
@@ -141,7 +143,7 @@ module Glimmer
         dependents_for(registration).delete(dependent)
       end
 
-      def call(new_value)
+      def call(new_value = nil, *extra_args)
         raise Error, 'Not implemented!'
       end
     end
@@ -150,3 +152,4 @@ end
 
 require 'glimmer/data_binding/observable_model'
 require 'glimmer/data_binding/observable_array'
+require 'glimmer/data_binding/observable_hash'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.3.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: array_include_methods
@@ -203,11 +203,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Glimmer is a Ruby DSL Framework for Ruby GUI and More, consisting of
-  a DSL Engine and an Observable/Observer/Data-Binding Library. Used in the Glimmer
-  DSL for SWT (JRuby Desktop Development GUI Framework), the Glimmer DSL for Tk (Ruby
-  Desktop Development GUI Library), the Glimmer DSL for Opal (Pure Ruby Web GUI and
-  Auto-Webifier of Desktop Apps), the Glimmer DSL for XML (& HTML), and the Glimmer
-  DSL for CSS.
+  a DSL Engine and an Observable / Observer / Data-Binding Library (including Observable
+  Model, Observable Array, and Observable Hash). Used in Glimmer DSL for SWT (JRuby
+  Desktop Development GUI Framework), Glimmer DSL for Tk (Ruby Desktop Development
+  GUI Library), Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development
+  GUI Library), Glimmer DSL for Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop
+  Apps), Glimmer DSL for XML (& HTML), and Glimmer DSL for CSS.
 email: andy.am@gmail.com
 executables: []
 extensions: []
@@ -228,6 +229,7 @@ files:
 - lib/glimmer/data_binding/model_binding.rb
 - lib/glimmer/data_binding/observable.rb
 - lib/glimmer/data_binding/observable_array.rb
+- lib/glimmer/data_binding/observable_hash.rb
 - lib/glimmer/data_binding/observable_model.rb
 - lib/glimmer/data_binding/observer.rb
 - lib/glimmer/data_binding/shine.rb
@@ -262,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: Glimmer - DSL Engine for Ruby GUI and More