glimmer 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d61c8e3da07109cf0edf0df46e0937a862b3e80007a12da8050c2415481cbb6e
-  data.tar.gz: c618e4c0b024a9da219fbe78c263a442981d3d0a40f8a13bb7639edf50310e09
+  metadata.gz: f6a8921b091e770dd1acb0528bdf8dad0a63e79290ffb457325abf261b4ac8ca
+  data.tar.gz: 4d530d648577640a25943fb55f61918d352f30e2007f7426b739b877cd6a44a0
 SHA512:
-  metadata.gz: c1b3b5d7aa04427f0e1188e0cd7e3855d517c0adfb6c561160c465f043685c48a651df8fde9eb05e31b84578a1986182422e49bb329fd35b9f0cd623fac4bc77
-  data.tar.gz: 5b4177d4ae038eefd1c210e8054f92ebe716b1a7edb2b40e94466ee2ba35aaafced1320128e75603f156ed3a7cdc56db200fd4369916dc0862f44fbd7ac12760
+  metadata.gz: 68f5e3c05e2381a6f4855cec0832cc983fc74d0dcf27649efaf9e92dd8cf7aa69f9e171494ee1ab17a6a8d68ce0d71cb9ef61521290d999eaa70ad3915b989f2
+  data.tar.gz: 6b3af9b3d411bed16cc9c9f2f227394675fd255098d64729424e31dfdbf1b7e75d8e3aac102016f31c8b729978e33b44fbca1b0dbecec1d1acffea3651dbc468

data/CHANGELOG.md

@@ -3,6 +3,28 @@
 Related Change Logs:
 - [glimmer-dsl-swt/CHANGELOG.md](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/CHANGELOG.md)
 
+### 2.4.0
+
+- Support passing arbitrary options to `Observer` `#observe` (`#register`) method (not just properties, like `recursive: true` for example)
+- Make observing nested arrays within an array optional with `recursive: true` option
+- Make `Observer` `dependents` collection rely on Concurrent::Hash when available
+- Fix `Observer` cleanup of registrations and dependents on `#deregister` (was not cleaning up everything because observables were changing `#hash` value on content change and slipping through the cracks as a result)
+
+### 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

data/README.md

@@ -210,7 +210,7 @@ end
 ### Setup
 
 Follow these steps to author a [Glimmer](https://rubygems.org/gems/glimmer) DSL:
-- Add `gem 'glimmer', '~> 2.2.0'` to `Gemfile` and run `bundle` or run `gem install glimmer -v2.2.0` and add `require 'glimmer'`
+- Add `gem 'glimmer', '~> 2.4.0'` to `Gemfile` and run `bundle` or run `gem install glimmer -v2.4.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
 
@@ -856,7 +856,7 @@ Glimmer app:
 
 ![glimmer dsl tk screenshot sample hello world](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-world.png)
 
-###### Hello, Tab!
+###### Hello, Notebook!
 
 Glimmer code (from [samples/hello/hello_tab.rb](https://github.com/AndyObtiva/glimmer-dsl-tk/blob/master/samples/hello/hello_tab.rb)):
 
@@ -864,7 +864,7 @@ Glimmer code (from [samples/hello/hello_tab.rb](https://github.com/AndyObtiva/gl
 include Glimmer
 
 root {
-  title 'Hello, Tab!'
+  title 'Hello, Notebook!'
    
   notebook {
     frame(text: 'English') {
@@ -885,13 +885,13 @@ root {
 Run (with the [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed):
 
 ```
-ruby -r glimmer-dsl-tk -e "require '../samples/hello/hello_tab.rb'"
+ruby -r glimmer-dsl-tk -e "require '../samples/hello/hello_notebook.rb'"
 ```
 
 Glimmer app:
 
-![glimmer dsl tk screenshot sample hello tab English](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-tab-english.png)
-![glimmer dsl tk screenshot sample hello tab French](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-tab-french.png)
+![glimmer dsl tk screenshot sample hello notebook English](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-notebook-english.png)
+![glimmer dsl tk screenshot sample hello notebook French](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-notebook-french.png)
 
 ###### Hello, Combo!
 
@@ -900,7 +900,7 @@ Glimmer code (from [samples/hello/hello_combo.rb](https://github.com/AndyObtiva/
 ```ruby
 # ... more code precedes
 root {
-  title 'Hello, Combo!'
+  title 'Hello, Combobox!'
   
   combobox { |proxy|
     state 'readonly'
@@ -920,13 +920,13 @@ root {
 Run (with the [glimmer-dsl-tk](https://rubygems.org/gems/glimmer-dsl-tk) gem installed):
 
 ```
-ruby -r glimmer-dsl-tk -e "require '../samples/hello/hello_combo.rb'"
+ruby -r glimmer-dsl-tk -e "require '../samples/hello/hello_combobox.rb'"
 ```
 
 Glimmer app:
 
-![glimmer dsl tk screenshot sample hello combo](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-combo.png)
-![glimmer dsl tk screenshot sample hello combo dropdown](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-combo-dropdown.png)
+![glimmer dsl tk screenshot sample hello combo](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-combobox.png)
+![glimmer dsl tk screenshot sample hello combo dropdown](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-tk/master/images/glimmer-dsl-tk-screenshot-sample-hello-combobox-dropdown.png)
 
 #### Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI Library)
 
@@ -972,10 +972,10 @@ 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 +995,161 @@ 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)
 
-###### Control Gallery
+###### 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
-  }
-
-  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
-}
-
-menu('Edit') {
-  check_menu_item('Checkable Item_')
-  separator_menu_item
-  menu_item('Disabled Item_') {
-    enabled false
-  }
-}
-
-menu('Help') {
-  menu_item('Help')
-  
-  about_menu_item # Can optionally contain an on_clicked listener
-}
+data = [
+  ['task 1', 0],
+  ['task 2', 15],
+  ['task 3', 100],
+  ['task 4', 75],
+  ['task 5', -1],
+]
 
-MAIN_WINDOW = window('Control Gallery', 600, 500) {
-  margined true
-  
-  on_closing do
-    puts 'Bye Bye'
-  end
-  
+window('Task Progress', 300, 200) {
   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
-          }
-
-          checkbox('Checkbox') {
-            stretchy false
-
-            on_toggled do |c|
-              checked = c.checked == 1
-              MAIN_WINDOW.title = "Checkbox is #{checked}"
-              c.text = "I am the checkbox (#{checked})"
-            end
-          }
-
-          label('Label') { stretchy false }
-
-          horizontal_separator { stretchy false }
-
-          date_picker { stretchy false }
-
-          time_picker { stretchy false }
-
-          date_time_picker { stretchy false }
-
-          font_button { stretchy false }
-
-          color_button { stretchy false }
-        }
-      }
-
-      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
-            }
-
-            radio_buttons {
-              items 'Radio Button 1', 'Radio Button 2', 'Radio Button 3' # also accepts a single array argument
-            }
-          }
-        }
-
-        tab {
-          tab_item('Page 1') {
-            horizontal_box {
-              entry {
-                text 'Please enter your feelings'
+    table {
+      text_column('Task')
+      progress_bar_column('Progress')
 
-                on_changed do |e|
-                  puts "Current textbox data: '#{e.text}'"
-                end
-              }
-            }
-          }
-          
-          tab_item('Page 2') {
-            horizontal_box
-          }
-          
-          tab_item('Page 3') {
-            horizontal_box
-          }
-        }
-      }
+      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
     }
   }
-}
-
-MAIN_WINDOW.show
+}.show
 ```
 
 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-table-progress-bar.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-mac-basic-table-progress-bar.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-table-progress-bar.png](https://raw.githubusercontent.com/AndyObtiva/glimmer-dsl-libui/master/images/glimmer-dsl-libui-linux-basic-table-progress-bar.png)
 
-###### Basic Table
+###### Area Gallery
 
 ```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('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)
 
-window('Animal sounds', 300, 200) {
-  horizontal_box {
-    table {
-      text_column('Animal')
-      text_column('Description')
+        closed true
+      }
 
-      cell_rows data
+      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)
+
+        closed true
+      }
+
+      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)
+
+      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
   }
-  
-  on_closing do
-    puts 'Bye Bye'
-  end
 }.show
 ```
 
 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)
+![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
 
@@ -1225,8 +1163,8 @@ These are the main classes concerning data-binding:
 - `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`)
-- `Glimmer::DataBinding::ObservableHash`: Mixin module for any observable hash that automatically handles notifying observers upon performing array mutation operation (e.g. `hash[key]=value`)
+- `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). Accepts `recursive: true` option in `add_observer` method to recursively observe nested arrays all the way down.
+- `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 `<=`
 

data/VERSION

@@ -1 +1 @@
-2.2.0
+2.4.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.2.0 ruby lib
+# stub: glimmer 2.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer".freeze
-  s.version = "2.2.0"
+  s.version = "2.4.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-28"
-  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-15"
+  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",

data/lib/glimmer/data_binding/model_binding.rb

@@ -101,6 +101,10 @@ module Glimmer
       def computed_by
         Concurrent::Array.new([@binding_options[:computed_by]].flatten.compact)
       end
+      
+      def observation_options
+        @binding_options.slice(:recursive)
+      end
 
       def nested_property_observers_for(observer)
         @nested_property_observers_collection ||= Concurrent::Hash.new
@@ -121,7 +125,7 @@ module Glimmer
         @nested_property_observers_collection[observer]
       end
 
-      def add_observer(observer)
+      def add_observer(observer, extra_options = {})
         if computed?
           add_computed_observers(observer)
         elsif nested_property?
@@ -133,19 +137,20 @@ module Glimmer
               apply_processor(@binding_options[:after_read], converted_value)
             end
           end
-          observer_registration = model_binding_observer.observe(model, property_name)
+          observer_registration = model_binding_observer.observe(model, property_name, observation_options)
           my_registration = observer.registration_for(self)
           observer.add_dependent(my_registration => observer_registration)
         end
       end
 
-      def remove_observer(observer)
+      def remove_observer(observer, extra_options = {})
         if computed?
           @computed_model_bindings.each do |computed_model_binding|
             computed_observer_for(observer).unobserve(computed_model_binding)
           end
           @computed_observer_collection.delete(observer)
         elsif nested_property?
+          # No need to call remove_nested_observers(observer) (cleanup happens automatically indirectly when invoked through observer.unobserve(model_binding))
           nested_property_observers_for(observer).clear
         else
           observer.unobserve(model, property_name)
@@ -167,7 +172,7 @@ module Glimmer
 
       def add_computed_observers(observer)
         @computed_model_bindings.each do |computed_model_binding|
-          observer_registration = computed_observer_for(observer).observe(computed_model_binding)
+          observer_registration = computed_observer_for(observer).observe(computed_model_binding, observation_options)
           my_registration = observer.registration_for(self)
           observer.add_dependent(my_registration => observer_registration)
         end
@@ -191,13 +196,13 @@ module Glimmer
           parent_property_name = nil if parent_property_name.to_s.start_with?('[')
           unless model.nil?
             # TODO figure out a way to deal with this more uniformly
-            observer_registration = property_indexed?(property_name) ? nested_property_observer.observe(model) : nested_property_observer.observe(model, property_name)
-            parent_registration = parent_observer.registration_for(parent_model, parent_property_name)
+            observer_registration = property_indexed?(property_name) ? nested_property_observer.observe(model, observation_options) : nested_property_observer.observe(model, property_name, observation_options)
+            parent_registration = parent_observer.registration_for(parent_model, *[parent_property_name].compact)
             parent_observer.add_dependent(parent_registration => observer_registration)
           end
         end
       end
-
+      
       def call(value, *extra_args)
         return if model.nil?
         converted_value = value

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,29 +30,64 @@ 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)
+      def add_observer(observer, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        element_properties = args
         element_properties = element_properties.flatten.compact.uniq
         return observer if has_observer?(observer) && has_observer_element_properties?(observer, element_properties)
         property_observer_list << observer
         observer_element_properties[observer] = element_properties_for(observer) + Concurrent::Set.new(element_properties)
-        each { |element| add_element_observer(element, observer) }
+        each { |element| add_element_observer(element, observer, options) }
         observer
       end
       
-      def add_element_observers(element)
+      def add_element_observers(element, options = {})
         property_observer_list.each do |observer|
-          add_element_observer(element, observer)
+          add_element_observer(element, observer, options)
         end
       end
 
-      def add_element_observer(element, observer)
+      def add_element_observer(element, observer, options = {})
         element_properties_for(observer).each do |property|
-          observer.observe(element, property)
+          observer.observe(element, property, options)
         end
+        ensure_array_object_observer(element, options) if options[:recursive] && element.is_a?(Array)
+      end
+      
+      def ensure_array_object_observer(object, options)
+        return unless object&.is_a?(Array)
+        array_object_observer = array_object_observer_for(object)
+        array_observer_registration = array_object_observer.observe(object, options)
+        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)
+      def remove_observer(observer, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        element_properties = args
         element_properties = element_properties.flatten.compact.uniq
         if !element_properties.empty?
           old_element_properties = element_properties_for(observer)
@@ -76,6 +112,13 @@ 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.respond_to?(:observable_array) && o.observable_array == self}.each do |o|
+            o.deregister_all_observables
+            @array_object_observers.reject! {|k, v| v == o}
+          end
+        end
       end
 
       def has_observer?(observer)
@@ -99,7 +142,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)
@@ -204,6 +247,7 @@ module Glimmer
       alias map! collect!
 
       def compact!
+        # TODO consider checking which exact indices changed and only notifying if there is a change
         super.tap { notify_observers }
       end
 
@@ -237,6 +281,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 +353,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

@@ -62,14 +62,19 @@ module Glimmer
         end
       end
 
-      def add_observer(observer, key = nil)
+      def add_observer(observer, key = nil, options = {})
+        if key.is_a?(Hash)
+          options = key
+          key = nil
+        end
         return observer if has_observer?(observer, key)
         key_observer_list(key) << observer
-        add_key_writer_observer(key)
+        add_key_writer_observer(key, options)
         observer
       end
 
-      def remove_observer(observer, key = nil)
+      def remove_observer(observer, key = nil, options = {})
+        old_value = self[key]
         if has_observer?(observer, key)
           key_observer_list(key).delete(observer)
           observer.unobserve(self, key)
@@ -115,12 +120,12 @@ module Glimmer
       
       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_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])
+      def add_key_writer_observer(key = nil, options)
+        ensure_array_object_observer(key, self[key], nil, options)
+        ensure_hash_object_observer(key, self[key], nil, options)
         begin
           method('__original__store')
         rescue
@@ -143,10 +148,11 @@ module Glimmer
       end
       alias deregister_dependent_observers unregister_dependent_observers
 
-      def ensure_array_object_observer(key, object, old_object = nil)
+      def ensure_array_object_observer(key, object, old_object = nil, options = {})
+        options ||= {}
         return unless object&.is_a?(Array)
         array_object_observer = array_object_observer_for(key)
-        array_observer_registration = array_object_observer.observe(object)
+        array_observer_registration = array_object_observer.observe(object, options)
         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)
@@ -160,10 +166,11 @@ module Glimmer
         @array_object_observers[key]
       end
       
-      def ensure_hash_object_observer(key, object, old_object = nil)
+      def ensure_hash_object_observer(key, object, old_object = nil, options = {})
+        options ||= {}
         return unless object&.is_a?(Hash)
         hash_object_observer = hash_object_observer_for(key)
-        hash_observer_registration = hash_object_observer.observe(object)
+        hash_observer_registration = hash_object_observer.observe(object, options)
         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)
@@ -176,6 +183,200 @@ module Glimmer
         @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

@@ -52,14 +52,14 @@ module Glimmer
         end
       end
 
-      def add_observer(observer, property_name)
+      def add_observer(observer, property_name, options = {})
         return observer if has_observer?(observer, property_name)
         property_observer_list(property_name) << observer
-        add_property_writer_observers(property_name)
+        add_property_writer_observers(property_name, options)
         observer
       end
 
-      def remove_observer(observer, property_name)
+      def remove_observer(observer, property_name, options = {})
         if has_observer?(observer, property_name)
           property_observer_list(property_name).delete(observer)
           observer.unobserve(self, property_name)
@@ -103,11 +103,11 @@ module Glimmer
         property_observer_list(property_name).to_a.each { |observer| observer.call(send(property_name)) }
       end
 
-      def add_property_writer_observers(property_name)
+      def add_property_writer_observers(property_name, options)
         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))
+        ensure_array_object_observer(property_name, send(property_name), nil, options)
+        ensure_hash_object_observer(property_name, send(property_name), nil, options)
         begin
           method("__original__#{property_writer_name}")
         rescue
@@ -130,10 +130,11 @@ module Glimmer
       end
       alias deregister_dependent_observers unregister_dependent_observers
 
-      def ensure_array_object_observer(property_name, object, old_object = nil)
+      def ensure_array_object_observer(property_name, object, old_object = nil, options = {})
+        options ||= {}
         return unless object&.is_a?(Array)
         array_object_observer = array_object_observer_for(property_name)
-        array_observer_registration = array_object_observer.observe(object)
+        array_observer_registration = array_object_observer.observe(object, options)
         property_observer_list(property_name).each do |observer|
           my_registration = observer.registration_for(self, property_name) # TODO eliminate repetition
           observer.add_dependent(my_registration => array_observer_registration)
@@ -143,14 +144,15 @@ 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)
+      def ensure_hash_object_observer(property_name, object, old_object = nil, options)
+        options ||= {}
         return unless object&.is_a?(Hash)
         hash_object_observer = hash_object_observer_for(property_name)
-        hash_observer_registration = hash_object_observer.observe(object)
+        hash_observer_registration = hash_object_observer.observe(object, options)
         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)
@@ -160,7 +162,7 @@ module Glimmer
 
       def hash_object_observer_for(property_name)
         @hash_object_observers ||= Concurrent::Hash.new
-        @hash_object_observers[property_name] = ObservableModel::Notifier.new(self, property_name) unless @hash_object_observers.has_key?(property_name)
+        @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

data/lib/glimmer/data_binding/observer.rb

@@ -46,9 +46,9 @@ module Glimmer
         end
       end
 
-      class Registration < Struct.new(:observer, :observable, :property, keyword_init: true)
+      class Registration < Struct.new(:observer, :observable, :args, keyword_init: true)
         def unregister
-          observer.unobserve(observable, property)
+          observer.unobserve(observable, *args)
         end
         alias unobserve unregister
         alias deregister unregister
@@ -61,29 +61,31 @@ module Glimmer
       end
 
       def registrations
-        @registrations ||= Concurrent::Set.new
+        @registrations ||= Concurrent::Hash.new
       end
 
-      def registration_for(observable, property = nil)
-        Registration.new(observer: self, observable: observable, property: property)
+      def registration_for(observable, *args)
+        args = compact_args(args)
+        registrations[[observable.object_id, args]] ||= Registration.new(observer: self, observable: observable, args: args)
       end
+      alias ensure_registration_for! registration_for
 
       # mapping of registrations to dependents
       # {[observable, property] => [[dependent, dependent_observable, dependent_property], ...]}
       def dependents
-        @dependents ||= Hash.new
+        @dependents ||= Concurrent::Hash.new
       end
 
       def dependents_for(registration)
-        dependents[registration] ||= Concurrent::Set.new
+        dependents[registration.object_id] ||= Concurrent::Set.new
       end
 
-      # registers observer in an observable on a property (optional)
+      # registers observer in an observable on args usually containing a property and options (optional)
       # observer maintains registration list to unregister later
-      def register(observable, property = nil)
+      def register(observable, *args)
         return if observable.nil?
         unless observable.is_a?(Observable)
-          # TODO refactor code to be more smart/polymorphic/automated and honor open/closed principle
+          # TODO refactor code to be more smart/polymorphic/automated and honor open/closed principle (e.g. for SomeClass, search if there is ObservableSomeClass)
           if observable.is_a?(Array)
             observable.extend(ObservableArray)
           elsif observable.is_a?(Hash)
@@ -92,23 +94,23 @@ module Glimmer
             observable.extend(ObservableModel)
           end
         end
-        observable.add_observer(*[self, property].compact)
-        registration_for(observable, property).tap do |registration|
-          self.registrations << registration
-        end
+        args = compact_args(args)
+        observable.add_observer(self, *args)
+        ensure_registration_for!(observable, *args)
       end
       alias observe register
 
-      def unregister(observable, property = nil)
+      def unregister(observable, *args)
         return unless observable.is_a?(Observable)
-        # TODO optimize performance in the future via indexing and/or making a registration official object/class
-        registration = registration_for(observable, property)
-        dependents_for(registration).each do |dependent|
-          dependent.unregister
-          remove_dependent(registration => dependent)
-        end
-        registrations.delete(registration).tap do |registration|
-          observable.remove_observer(*[self, property].compact)
+        args = compact_args(args)
+        registration = registration_for(observable, *args)
+        registrations.delete([observable.object_id, args])
+        registration.tap do |registration|
+          dependents_for(registration).each do |dependent|
+            remove_dependent(registration => dependent)
+            dependent.deregister if dependent != registration
+          end
+          observable.remove_observer(self, *args)
         end
       end
       alias unobserve unregister
@@ -118,14 +120,17 @@ module Glimmer
         thedependents = dependents_for(registration).select do |thedependent|
           thedependent.observable == dependent_observable
         end
-        thedependents.each(&:unregister)
+        thedependents.each(&:deregister)
       end
       alias unobserve_dependents_with_observable unregister_dependents_with_observable
       alias deregister_dependents_with_observable unregister_dependents_with_observable
 
       # cleans up all registrations in observables
       def unregister_all_observables
-        registrations.each(&:unregister)
+        registrations.values.dup.each do |registration|
+          registration.deregister
+          registrations.delete([registration.observable.object_id, registration.args])
+        end
       end
       alias unobserve_all_observables unregister_all_observables
       alias deregister_all_observables unregister_all_observables
@@ -140,12 +145,20 @@ module Glimmer
       def remove_dependent(parent_to_dependent_hash)
         registration = parent_to_dependent_hash.keys.first
         dependent = parent_to_dependent_hash.values.first
-        dependents_for(registration).delete(dependent)
+        dependents_for(registration).delete(dependent).tap do
+          dependents.delete([registration.object_id]) if dependents_for(registration).empty?
+        end
       end
 
       def call(new_value = nil, *extra_args)
         raise Error, 'Not implemented!'
       end
+      
+      def compact_args(args)
+        args = args[0...-1] if args.last == {}
+        args = args[0...-1] if args.last == []
+        args.compact
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-10-15 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: []