glimmer 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 351035b802dcf014c087c908f8481dbbf13d8479fdd1766b47e25be2177ffc98
-  data.tar.gz: 7960514819570b96106dcde2c71889feb0bd706dbe5803e3e62bf02c28f4c1f1
+  metadata.gz: 8772f56eb8991b7a79057afe8640670356862b2347a47b0e685caebb62568835
+  data.tar.gz: b53c4203d47bf66c8b3b9246d3ff96ecf82922452c6370df1637d2358b9d5dba
 SHA512:
-  metadata.gz: f127846dc71e67d3667cd738a96f11d667718d93f28494e31414a29a6e93b323f04af33bcc022bb8a4cc96e413622209589f1f2ab2ba5efc10bf5bce6baf33f7
-  data.tar.gz: 6a300696cb179c0d01173fd4a652d6ef78219ad944ff2af9ef7fbfec19e9a853365631f92bae5c7b2353946a2c2e498d178f14f96ee357f61a02b872b1e17537
+  metadata.gz: ab4149e944396d0e236b87e632996ba1b4e585291c503061686ddd2da7d49fb46f921761bf6863f8c75923501dd2ca3af3cff7eb18f4a4f42dbafaa397bbc08a
+  data.tar.gz: f8eadc4773b6b459d43f21ad9f041b5387766d4faf29111d81f364ca98bfb8fdcafdd4267f25c5c476af540de841d882a79a10261d84264346905c3d38073929

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 Related Change Logs:
 - [glimmer-dsl-swt/CHANGELOG.md](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/CHANGELOG.md)
 
+### 2.0.0
+
+- Extract Glimmer::DSL::BindExpression from Glimmer DSL for SWT
+- Make concurrent-ruby an optional dependency (automatically using its data-structure classes if present)
+
 ### 1.3.1
 
 - Use `Concurrent::Array` instead of `Array` in `Glimmer::DataBinding::ModelBinding`

data/README.md

@@ -16,7 +16,7 @@ Featured in JRuby Cookbook](http://shop.oreilly.com/product/9780596519650.do) an
 
 [**Glimmer**](https://rubygems.org/gems/glimmer) is a DSL (Domain-Specific Language) Framework that consists of two things:
 - [DSL Engine](#dsl-engine): enables building internal DSLs embedded in Ruby (e.g. for GUI, XML, or CSS).
-- [Data-Binding Library](#data-binding-library): enables synchronizing GUI with Model Attributes bidirectionally.
+- [Data-Binding Library](#data-binding-library): enables synchronizing GUI with Model Attributes bidirectionally **(now with Shine syntax support in v2)**.
 
 [**Glimmer**](https://rubygems.org/gems/glimmer) is ***the cream of the crop*** when it comes to building DSLs in Ruby:
 - Supports building the tersest most concise domain specific language syntax in Ruby.
@@ -157,6 +157,9 @@ module Glimmer
 end
 ```
 
+An extra convenience expression module is included called `BindExpression`. It builds a `Glimmer::DataBinding::ModelBinding` object for [data-binding](#data-binding) purposes.
+You may learn more about it by looking at how [Glimmer DSL for SWT](https://github.com/AndyObtiva/glimmer-dsl-swt) uses it.
+
 DSL expressions go into the `glimmer/dsl/{dsl_name}` namespace directory.
 
 Also, every DSL requires a `glimmer/dsl/{dsl_name}/dsl.rb` file, which configures the DSL into Glimmer via a call to:
@@ -206,7 +209,7 @@ end
 ### Setup
 
 Follow these steps to author a [Glimmer](https://rubygems.org/gems/glimmer) DSL:
-- Add `gem 'glimmer', '~> 1.3.1'` to `Gemfile` and run `bundle` or run `gem install glimmer -v1.3.1` and add `require 'glimmer'`
+- Add `gem 'glimmer', '~> 2.0.0'` to `Gemfile` and run `bundle` or run `gem install glimmer -v2.0.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
 
@@ -938,6 +941,7 @@ These are the main classes concerning data-binding:
 - `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 `<=`
 
 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 @@
-1.3.1
+2.0.0

data/glimmer.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer 1.3.1 ruby lib
+# stub: glimmer 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer".freeze
-  s.version = "1.3.1"
+  s.version = "2.0.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-03-23"
+  s.date = "2021-07-08"
   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.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -34,6 +34,8 @@ Gem::Specification.new do |s|
     "lib/glimmer/data_binding/observable_array.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",
@@ -42,11 +44,12 @@ Gem::Specification.new do |s|
     "lib/glimmer/dsl/top_level_expression.rb",
     "lib/glimmer/error.rb",
     "lib/glimmer/ext/module.rb",
-    "lib/glimmer/invalid_keyword_error.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.3".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
@@ -56,10 +59,9 @@ Gem::Specification.new do |s|
   if s.respond_to? :add_runtime_dependency then
     s.add_runtime_dependency(%q<array_include_methods>.freeze, [">= 1.0.4", "< 2.0.0"])
     s.add_runtime_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
-    s.add_runtime_dependency(%q<concurrent-ruby>.freeze, [">= 1.1.7", "< 2.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.10.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"])
@@ -70,10 +72,9 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<array_include_methods>.freeze, [">= 1.0.4", "< 2.0.0"])
     s.add_dependency(%q<facets>.freeze, [">= 3.1.0", "< 4.0.0"])
-    s.add_dependency(%q<concurrent-ruby>.freeze, [">= 1.1.7", "< 2.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.10.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"])

data/lib/glimmer.rb

@@ -22,18 +22,10 @@
 require 'logger'
 require 'set'
 require 'array_include_methods'
-if RUBY_ENGINE == 'opal'
-  module Concurrent
-    Array = ::Array
-    Hash = ::Hash
-    Set = ::Set
-  end
-else
-  require 'concurrent-ruby'
-end
 
 $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
+require 'glimmer/shim/concurrent'
 require 'glimmer/config'
 require 'glimmer/ext/module'
 

data/lib/glimmer/data_binding/model_binding.rb

@@ -242,7 +242,12 @@ module Glimmer
 
       def invoke_proc_with_exact_parameters(proc_object, *args)
         return if proc_object.nil?
-        args = Concurrent::Array.new(args[0...proc_object.parameters.size])
+        if RUBY_ENGINE == 'opal'
+          # opal doesn't support proc_object.parameters.size properly it seems
+          args = Concurrent::Array.new(args[0...1])
+        else
+          args = Concurrent::Array.new(args[0...proc_object.parameters.size])
+        end
         proc_object.call(*args)
       end
 

data/lib/glimmer/data_binding/shine.rb

@@ -0,0 +1,56 @@
+# 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.
+
+module Glimmer
+  module DataBinding
+    class Shine
+      include Glimmer
+      
+      def initialize(parent, parent_attribute)
+        @parent = parent
+        @parent_attribute = parent_attribute
+      end
+    
+      def <=>(other)
+        if other.is_a?(Array)
+          args_clone = other.clone
+          @parent.content {
+            send(@parent_attribute, bind(*args_clone))
+          }
+        end
+      end
+    
+      def <=(other)
+        if other.is_a?(Array)
+          args_clone = other.clone
+          if args_clone.last.is_a?(Hash)
+            args_clone.last[:read_only] = true
+          else
+            args_clone << {read_only: true}
+          end
+          @parent.content {
+            send(@parent_attribute, bind(*args_clone))
+          }
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/bind_expression.rb

@@ -0,0 +1,54 @@
+# 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/dsl/static_expression'
+require 'glimmer/data_binding/model_binding'
+
+module Glimmer
+  module DSL
+    # Responsible for setting up the return value of the bind keyword (command symbol)
+    # as a ModelBinding. It is to be used as the argument of another data-binding expression.
+    module BindExpression
+      def can_interpret?(parent, keyword, *args, &block)
+        (
+          keyword == 'bind' and
+            (
+              (
+                (args.size == 2) and
+                  textual?(args[1])
+              ) ||
+                (
+                  (args.size == 3) and
+                    textual?(args[1]) and
+                    (args[2].is_a?(Hash))
+                )
+            )
+        )
+      end
+
+      def interpret(parent, keyword, *args, &block)
+        binding_options = args[2] || {}
+        binding_options[:on_read] = binding_options.delete(:on_read) || binding_options.delete('on_read') || block
+        DataBinding::ModelBinding.new(args[0], args[1].to_s, binding_options)
+      end
+    end
+  end
+end

data/lib/glimmer/ext/module.rb

@@ -1,11 +1,13 @@
-class Module
-  alias append_features_without_glimmer append_features
-  def append_features(mod)
-    if self == Glimmer && mod == Object
-      Glimmer::Config.logger.debug { 'Appending Glimmer to Singleton Class of main object (not appending to Object everywhere to avoid method pollution)' }
-      TOPLEVEL_BINDING.receiver.singleton_class.include(self)
-    else
-      append_features_without_glimmer(mod)
+unless RUBY_ENGINE == 'opal'
+  class Module
+    alias append_features_without_glimmer append_features
+    def append_features(mod)
+      if self == Glimmer && mod == Object
+        Glimmer::Config.logger.debug { 'Appending Glimmer to Singleton Class of main object (not appending to Object everywhere to avoid method pollution)' }
+        TOPLEVEL_BINDING.receiver.singleton_class.include(self)
+      else
+        append_features_without_glimmer(mod)
+      end
     end
   end
 end

data/lib/glimmer/shim/concurrent.rb

@@ -0,0 +1,10 @@
+require 'set'
+
+# Accommadate libraries that do not need or support concurrent-ruby (e.g. Glimmer DSL for Opal)
+if !Object.constants.include?(:Concurrent)
+  module Concurrent
+    Array = ::Array
+    Hash = ::Hash
+    Set = ::Set
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: array_include_methods
@@ -50,26 +50,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.7
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -104,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -256,6 +236,8 @@ files:
 - lib/glimmer/data_binding/observable_array.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
@@ -265,6 +247,7 @@ files:
 - lib/glimmer/error.rb
 - lib/glimmer/ext/module.rb
 - lib/glimmer/invalid_keyword_error.rb
+- lib/glimmer/shim/concurrent.rb
 homepage: http://github.com/AndyObtiva/glimmer
 licenses:
 - MIT
@@ -284,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Glimmer - DSL Engine for Ruby GUI and More