glimmer 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c30ea530add452134bdbe1b691612d1cbc1df62e9d96d934aba1b8208ac1bf
-  data.tar.gz: 2e54d62f536bd132379c195032e62b82e5f6f973f3aa95df002464c99ed39ce1
+  metadata.gz: bc60f9fe9c141b35fe836c661860faf448bccccad9f4bfe14c885301e393e75d
+  data.tar.gz: 994743aae8636eea4f89fbad60850942854f2d7388bf7f13ce465e4cbe1a809e
 SHA512:
-  metadata.gz: 2793b625f74e8fcbd17e1463aa87f4f5cdd7e63d9219f55d9a749f18ce56acef87a86147d227d4246251accc48d7bd451eef170d0e0c34fa4be1a1fa251a6bdb
-  data.tar.gz: 596cfae4c4545bb7d2bfcb8a6ef4c3be243f70f1dd129e27b16b718ed7b234ab9e5d685075cd6720c8459960c5966f4bd93f494a46d9a0adf7fba5902542d818
+  metadata.gz: 777b7ce413bec3f1cf75accdedcb905e393a9b94e2be4572c590f6e3108d2cee7923f83c02e0753ba2f2bb21427b77116da37d8af1a86e477da5821be9d4e5d5
+  data.tar.gz: baa2ed05d9cd5759b08a8555ceba26f2672be40f28d868c975e5286a5daf484a7128709093332e7f3f69dc99a5a43cde8550ebe472891cee65c20882751defa0

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 Related Change Logs:
 - [glimmer-dsl-swt/CHANGELOG.md](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/CHANGELOG.md)
 
+### 1.3.0
+
+- Support the `Expression#around` hook, which executes code around both `interpret` and `add_content`
+
 ## 1.2.0
 
 - Alter `Engine`/`Expression`/`ParentExpression` API to pass `keyword` and `args` to `#add_content` method. This enables consumers to vary behavior based on `keyword` and `args`, not just `parent` and presence of `block`.

data/README.md

@@ -102,6 +102,9 @@ Every `Expression` sublcass must specify two methods at least:
 
 For example, some parent widgets use their block for other reasons or process their children at very specific times, so they may override that method and disable it, or otherwise call `super` and do additional work.
 
+Otherwise, all expressions support the `around` hook method:
+- `around(parent, keyword, args, block, &interpret_and_add_content)`: a hook for executing code around both `interpret` and `add_content`. Clients may invoke `interpret_and_add_content.call` or `yield` when ready for interpretation. `parent`, `keyword`, `args`, and `block` are supplied in case they are needed in the `around` logic.
+
 Example of a dynamic expression:
 
 ```ruby
@@ -201,7 +204,7 @@ end
 ### Setup
 
 Follow these steps to author a [Glimmer](https://rubygems.org/gems/glimmer) DSL:
-- Add `gem 'glimmer', '~> 1.2.0'` to `Gemfile` and run `bundle` or run `gem install glimmer -v1.2.0` and add `require 'glimmer'`
+- Add `gem 'glimmer', '~> 1.3.0'` to `Gemfile` and run `bundle` or run `gem install glimmer -v1.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
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.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.2.0 ruby lib
+# stub: glimmer 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer".freeze
-  s.version = "1.2.0"
+  s.version = "1.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-03-03"
+  s.date = "2021-03-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 = [

data/lib/glimmer/dsl/engine.rb

@@ -176,10 +176,14 @@ module Glimmer
         end
         
         def interpret_expression(expression, keyword, *args, &block)
-          expression.interpret(parent, keyword, *args, &block).tap do |ui_object|
-            add_content(ui_object, expression, keyword, *args, &block)
-            dsl_stack.pop
+          new_parent = nil
+          expression.around(parent, keyword, args, block) do
+            new_parent = expression.interpret(parent, keyword, *args, &block).tap do |new_parent|
+              add_content(new_parent, expression, keyword, *args, &block)
+              dsl_stack.pop
+            end
           end
+          new_parent
         end
 
         # Adds content block to parent UI object
@@ -187,12 +191,12 @@ module Glimmer
         # This allows evaluating parent UI object properties and children
         #
         # For example, a shell widget would get properties set and children added
-        def add_content(parent, expression, keyword, *args, &block)
+        def add_content(new_parent, expression, keyword, *args, &block)
           if block_given? && expression.is_a?(ParentExpression)
             dsl_stack.push(expression.class.dsl)
-            parent_stack.push(parent)
+            parent_stack.push(new_parent)
             begin
-              expression.add_content(parent, keyword, *args, &block)
+              expression.add_content(new_parent, keyword, *args, &block)
             ensure
               parent_stack.pop
               dsl_stack.pop

data/lib/glimmer/dsl/expression.rb

@@ -47,13 +47,23 @@ module Glimmer
         raise Error, "#interpret must be implemented by an Expression subclass"
       end
 
-      # Adds block content to specified parent UI object (Optional)
+      # Adds block content to newly interpreted parent object (Optional)
       #
       # Only expressions that receive a content block should implement
-      def add_content(parent, keyword, *args, &block)
+      def add_content(new_parent, keyword, *args, &block)
         # No Op by default
       end
-
+      
+      # Executes code around the `interpret_and_add_content` block,
+      # which invokes `interpret` and `add_content` when called without args
+      # (parent, keyword, args, block are supplied automatically).
+      # Clients may invoke yield as an alternative to calling `interpret_and_add_content` directly.
+      # This method takes parent, keyword, args, block in case they are needed
+      # in its around logic.
+      def around(parent, keyword, args, block, &interpret_and_add_content)
+        interpret_and_add_content.call
+      end
+      
       # Checks if object is a Symbol or a String
       def textual?(object)
         object.is_a?(Symbol) or object.is_a?(String)

data/lib/glimmer/dsl/parent_expression.rb

@@ -25,8 +25,11 @@ module Glimmer
   module DSL
     # Mixin that represents expressions that always have a content block
     module ParentExpression
-      def add_content(parent, keyword, *args, &block)
-        block.call(parent)
+      # Default implementation that simply invokes block content with newly interpreted parent object as an argument
+      #
+      # Only expressions that receive a content block should implement
+      def add_content(new_parent, keyword, *args, &block)
+        block.call(new_parent)
       end
     end
   end

data/lib/glimmer/dsl/static_expression.rb

@@ -50,7 +50,8 @@ module Glimmer
         end
       end
 
-      # Subclasses may optionally implement
+      # Subclasses may optionally implement, but by default it only ensures that
+      # the keyword matches lower case static expression class name minus `Expression`
       def can_interpret?(parent, keyword, *args, &block)
         true
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: array_include_methods