glimmer 2.5.1 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ac1b24375105a448fda7392e89fa7308de9e36eb658f22bf4ace5fc408e8a9
-  data.tar.gz: 03e8b1c161f2113178e21485706911a07ce26eeec84cff373f26b334735709f1
+  metadata.gz: 3f5103731be03f760a5835564ba6f3be84d2861b9a9c0c6f82fb854070ae3075
+  data.tar.gz: fce2ab6404b29c93cb068a7e779c32c3a2d4f6abc209468c536acb1413e8cd39
 SHA512:
-  metadata.gz: 1cdb1f83dddda3dd0deedf52eb439413565ef73201b3c235d351309e03c6b3818c560200130a8b6bb4556451a20b2aa0ffe2a153307ac93326c6d5809aeeef7d
-  data.tar.gz: 8946ad145ca1cb3f27c30a283b159acaef35d38d415686830daad75abbc594b399d4f408593366aab3647c100119286b172b9a152371f0afde45db15bbccab0e
+  metadata.gz: 67bb9d8b80194ec1004c137bc9d5b87525428b64c94063e512a3bb9291f67694440974c496785184d0b62f0d3abac62de6a662ecdff102df17009edb7bac1dd3
+  data.tar.gz: 767ffd76f607076b4fce5edb70f130da7d777453ca1d94a79e39f5be3c1596b28b11dc29c6e3e98c9f4d2a1133e9ff70678c52cb18805b6e898c8d0d6ec02266

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 Related Change Logs:
 - [glimmer-dsl-swt/CHANGELOG.md](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/CHANGELOG.md)
 
+### 2.5.3
+
+- Provide `Observer#observe` option to tolerate not being able to extend an object for observation by silently not observing such object
+- Use `Concurrent::Hash` for `ObservableModel#property_observer_hash`
+- Use `Concurrent::Hash` for `ObservableHash#key_observer_hash`
+
 ### 2.5.1
 
 - Fix issue with referencing `OpenStruct` without 'ostruct' library being required (it now checks if `OpenStruct` is loaded first and avoids referencing otherwise).

data/README.md

@@ -230,7 +230,7 @@ end
 ### Setup
 
 Follow these steps to author a [Glimmer](https://rubygems.org/gems/glimmer) DSL:
-- Add `gem 'glimmer', '~> 2.5.1'` to `Gemfile` and run `bundle` or run `gem install glimmer -v2.5.1` and add `require 'glimmer'`
+- Add `gem 'glimmer', '~> 2.5.3'` to `Gemfile` and run `bundle` or run `gem install glimmer -v2.5.3` 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
 
@@ -1185,7 +1185,7 @@ 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:
-- `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::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`). Passing the option `ignore_frozen: true` at the end of the args of `register` (alias: `observe`) method results in silently ignoring any passed frozen observable without raising an error (it raises an error otherwise for frozen/immutable objects).
 - `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 (`Object`, `Struct` or `OpenStruct`) with observable attributes (observes attribute writers and `Struct`/`OpenStruct` `:[]=` method). 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). Accepts `recursive: true` option in `add_observer` method to recursively observe nested arrays all the way down. Alternatively, pass `recursive: [integer]` to limit recursion in `Array` observation to a specific number of levels beyond the first level (which is always included).

data/VERSION

@@ -1 +1 @@
-2.5.1
+2.5.3

data/glimmer.gemspec

@@ -1,90 +1,90 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: glimmer 2.5.1 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "glimmer".freeze
-  s.version = "2.5.1"
-
-  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-11-20"
-  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 Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps), Glimmer DSL for Tk (Ruby Desktop Development GUI Library), Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI Library), Glimmer DSL for GTK (Ruby-GNOME Desktop Development GUI Library), Glimmer DSL for XML (& HTML), and Glimmer DSL for CSS.".freeze
-  s.email = "andy.am@gmail.com".freeze
-  s.extra_rdoc_files = [
-    "CHANGELOG.md",
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    "CHANGELOG.md",
-    "CONTRIBUTING.md",
-    "LICENSE.txt",
-    "PROCESS.md",
-    "README.md",
-    "VERSION",
-    "glimmer.gemspec",
-    "lib/glimmer.rb",
-    "lib/glimmer/config.rb",
-    "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_hashable.rb",
-    "lib/glimmer/data_binding/observable_model.rb",
-    "lib/glimmer/data_binding/observer.rb",
-    "lib/glimmer/data_binding/shine.rb",
-    "lib/glimmer/dsl/bind_expression.rb",
-    "lib/glimmer/dsl/engine.rb",
-    "lib/glimmer/dsl/expression.rb",
-    "lib/glimmer/dsl/expression_handler.rb",
-    "lib/glimmer/dsl/observe_expression.rb",
-    "lib/glimmer/dsl/parent_expression.rb",
-    "lib/glimmer/dsl/static_expression.rb",
-    "lib/glimmer/dsl/top_level_expression.rb",
-    "lib/glimmer/error.rb",
-    "lib/glimmer/ext/module.rb",
-    "lib/glimmer/invalid_keyword_error.rb",
-    "lib/glimmer/shim/concurrent.rb"
-  ]
-  s.homepage = "http://github.com/AndyObtiva/glimmer".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.2.31".freeze
-  s.summary = "Glimmer - DSL Engine for Ruby GUI and More".freeze
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
-
-  if s.respond_to? :add_runtime_dependency then
-    s.add_runtime_dependency(%q<array_include_methods>.freeze, ["~> 1.4.0"])
-    s.add_runtime_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
-    s.add_development_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
-    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
-    s.add_development_dependency(%q<puts_debuggerer>.freeze, ["~> 0.13"])
-    s.add_development_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
-    s.add_development_dependency(%q<jeweler>.freeze, [">= 2.0.0", "< 3.0.0"])
-    s.add_development_dependency(%q<rdoc>.freeze, [">= 6.2.1", "< 7.0.0"])
-    s.add_development_dependency(%q<coveralls>.freeze, [">= 0"])
-    s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
-    s.add_development_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
-    s.add_development_dependency(%q<rake-tui>.freeze, ["> 0"])
-  else
-    s.add_dependency(%q<array_include_methods>.freeze, ["~> 1.4.0"])
-    s.add_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
-    s.add_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
-    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
-    s.add_dependency(%q<puts_debuggerer>.freeze, ["~> 0.13"])
-    s.add_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
-    s.add_dependency(%q<jeweler>.freeze, [">= 2.0.0", "< 3.0.0"])
-    s.add_dependency(%q<rdoc>.freeze, [">= 6.2.1", "< 7.0.0"])
-    s.add_dependency(%q<coveralls>.freeze, [">= 0"])
-    s.add_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
-    s.add_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
-    s.add_dependency(%q<rake-tui>.freeze, ["> 0"])
-  end
-end
-
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: glimmer 2.5.3 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "glimmer".freeze
+  s.version = "2.5.3"
+
+  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-12-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 Opal (Pure Ruby Web GUI and Auto-Webifier of Desktop Apps), Glimmer DSL for Tk (Ruby Desktop Development GUI Library), Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI Library), Glimmer DSL for GTK (Ruby-GNOME Desktop Development GUI Library), Glimmer DSL for XML (& HTML), and Glimmer DSL for CSS.".freeze
+  s.email = "andy.am@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "CHANGELOG.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "CONTRIBUTING.md",
+    "LICENSE.txt",
+    "PROCESS.md",
+    "README.md",
+    "VERSION",
+    "glimmer.gemspec",
+    "lib/glimmer.rb",
+    "lib/glimmer/config.rb",
+    "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_hashable.rb",
+    "lib/glimmer/data_binding/observable_model.rb",
+    "lib/glimmer/data_binding/observer.rb",
+    "lib/glimmer/data_binding/shine.rb",
+    "lib/glimmer/dsl/bind_expression.rb",
+    "lib/glimmer/dsl/engine.rb",
+    "lib/glimmer/dsl/expression.rb",
+    "lib/glimmer/dsl/expression_handler.rb",
+    "lib/glimmer/dsl/observe_expression.rb",
+    "lib/glimmer/dsl/parent_expression.rb",
+    "lib/glimmer/dsl/static_expression.rb",
+    "lib/glimmer/dsl/top_level_expression.rb",
+    "lib/glimmer/error.rb",
+    "lib/glimmer/ext/module.rb",
+    "lib/glimmer/invalid_keyword_error.rb",
+    "lib/glimmer/shim/concurrent.rb"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/glimmer".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.2.22".freeze
+  s.summary = "Glimmer - DSL Engine for Ruby GUI and More".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<array_include_methods>.freeze, ["~> 1.4.0"])
+    s.add_runtime_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
+    s.add_development_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
+    s.add_development_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_development_dependency(%q<puts_debuggerer>.freeze, ["~> 0.13"])
+    s.add_development_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
+    s.add_development_dependency(%q<jeweler>.freeze, [">= 2.0.0", "< 3.0.0"])
+    s.add_development_dependency(%q<rdoc>.freeze, [">= 6.2.1", "< 7.0.0"])
+    s.add_development_dependency(%q<coveralls>.freeze, [">= 0"])
+    s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
+    s.add_development_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
+    s.add_development_dependency(%q<rake-tui>.freeze, ["> 0"])
+  else
+    s.add_dependency(%q<array_include_methods>.freeze, ["~> 1.4.0"])
+    s.add_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
+    s.add_dependency(%q<rspec-mocks>.freeze, ["~> 3.5.0"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.5.0"])
+    s.add_dependency(%q<puts_debuggerer>.freeze, ["~> 0.13"])
+    s.add_dependency(%q<rake>.freeze, [">= 10.1.0", "< 14.0.0"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 2.0.0", "< 3.0.0"])
+    s.add_dependency(%q<rdoc>.freeze, [">= 6.2.1", "< 7.0.0"])
+    s.add_dependency(%q<coveralls>.freeze, [">= 0"])
+    s.add_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
+    s.add_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
+    s.add_dependency(%q<rake-tui>.freeze, ["> 0"])
+  end
+end
+

data/lib/glimmer/data_binding/observable_array.rb

@@ -51,7 +51,7 @@ module Glimmer
         element_properties = element_properties.flatten.compact.uniq
         return observer if has_observer?(observer) && has_observer_element_properties?(observer, element_properties)
         property_observer_list[observer] = options
-        observer_element_properties[observer] = element_properties_for(observer) + Concurrent::Set.new(element_properties)
+        observer_element_properties[observer] = Concurrent::Set.new(Concurrent::Array.new(element_properties_for(observer).to_a) + Concurrent::Array.new(element_properties)) # converting to Array as a workaround to jruby-9.3.2.0 issue TODO remove this workaround when no longer needed
         if !options.empty? && options[:recursive].is_a?(Integer)
           options = options.clone
           options[:recursive] = options[:recursive] - 1
@@ -97,7 +97,7 @@ module Glimmer
         element_properties = element_properties.flatten.compact.uniq
         if !element_properties.empty?
           old_element_properties = element_properties_for(observer)
-          observer_element_properties[observer] = element_properties_for(observer) - Concurrent::Set.new(element_properties)
+          observer_element_properties[observer] = Concurrent::Set.new(Concurrent::Array.new(element_properties_for(observer).to_a) - Concurrent::Array.new(element_properties)) # TODO remove this workaround when no longer needed (it is for jruby-9.3.2.0 issue)
           each { |element| element_properties.each { |property| observer.unobserve(element, property) } }
         end
         if element_properties_for(observer).empty?

data/lib/glimmer/data_binding/observable_hash.rb

@@ -84,7 +84,7 @@ module Glimmer
       end
 
       def key_observer_hash
-        @key_observers ||= Hash.new
+        @key_observers ||= Concurrent::Hash.new
       end
 
       def key_observer_list(key)

data/lib/glimmer/data_binding/observable_model.rb

@@ -93,7 +93,7 @@ module Glimmer
       end
 
       def property_observer_hash
-        @property_observers ||= Hash.new
+        @property_observers ||= Concurrent::Hash.new
       end
 
       def property_observer_list(property_name)

data/lib/glimmer/data_binding/observer.rb

@@ -83,7 +83,9 @@ module Glimmer
       # registers observer in an observable on args usually containing a property and options (optional)
       # observer maintains registration list to unregister later
       def observe(observable, *args)
+        options = args.last.is_a?(Hash) ? args.last : {}
         return if observable.nil?
+        return if options[:ignore_frozen] && observable.frozen?
         unless observable.is_a?(Observable)
           # 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.3
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: array_include_methods
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Glimmer - DSL Engine for Ruby GUI and More