glimmer 0.9.5 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c22f962213e82b271d67b69d910604e73ab8a257e8a797fa58feb2d97d6c199e
-  data.tar.gz: eee60acdf118d572196ef4a2c1eca7705093ea9d3db2fcea1a05bb612710f05b
+  metadata.gz: 5c67def84181cab028446e3087c2c22d091bb0b17d02aa91e3948a8d7b176113
+  data.tar.gz: a2613dc9b58d1ef2d048b93f695e2aef799b06c46ec85999a78ecb48a6c5d469
 SHA512:
-  metadata.gz: 360edce8ae04be32396a272ad947897d256c171759f3304ed4f3b521a208540a2834e05a3140fe61de166337858bbd85c13655d02b92b1cd13e60b44b78cb0d6
-  data.tar.gz: 482df9f676948f24f68e665899c15e7e14b78f40f100580771a4af943fd524b676ae140f19cf1d7b370d2ef1fb5e3c4bff9f0e2eb4a8cb1cb95884c74be6ef37
+  metadata.gz: cbab9c4d0212aa47f46dd73394c05a47ebb95d1b18afb1b76b7400c72ae188f849776f411e3808b3fbd75537d3c7ca416fe3bcf90c08aba17e3058a8bccbc228
+  data.tar.gz: f913e477fa27d42e46614470e3e9e3c18fafd08e2a8fb6eb65c579b6a5894884e61da5203fc0df1d41fd4860f5dc4b435c123c6b5822a4056f6c01bfb4854ff2

data/README.md

@@ -17,7 +17,7 @@ Glimmer DSL gems:
 - [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (Desktop GUI)
 - [glimmer-dsl-opal](https://github.com/AndyObtiva/glimmer-dsl-opal): Glimmer DSL for Opal (Web GUI Adapter for Desktop Apps)
 - [glimmer-dsl-xml](https://github.com/AndyObtiva/glimmer-dsl-xml): Glimmer DSL for XML (& HTML)
-- [glimmer-dsl-css](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS (Cascading Style Sheets)
+- [glimmer-dsl-css](https://github.com/AndyObtiva/glimmer-dsl-css): Glimmer DSL for CSS
 
 ## Examples
 
@@ -251,7 +251,7 @@ Otherwise, Option 2 ([Bundler](#option-2-bundler)) is recommended for building G
 
 Run this command to install directly:
 ```
-jgem install glimmer-dsl-swt -v 0.3.0
+jgem install glimmer-dsl-swt -v 0.4.1
 ```
 
 `jgem` is JRuby's version of `gem` command. 
@@ -269,7 +269,7 @@ Note: if you're using activerecord or activesupport, keep in mind that Glimmer u
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer-dsl-swt', '~> 0.3.0'
+gem 'glimmer-dsl-swt', '~> 0.4.1'
 ```
 
 And, then run:
@@ -484,7 +484,10 @@ The Ruby gem name will follow the convention "glimmer-cw-customwidgetname-namesp
 
 Only official Glimmer gems created by the Glimmer project committers will have no namespace (e.g. [glimmer-cw-video](https://rubygems.org/gems/glimmer-cw-video) Ruby gem)
 
-Example: [https://github.com/AndyObtiva/glimmer-cw-video](https://github.com/AndyObtiva/glimmer-cw-video)
+Examples: 
+
+- [glimmer-cw-video](https://github.com/AndyObtiva/glimmer-cw-video): Video Widget
+- [glimmer-cw-cdatetime-nebula](https://github.com/AndyObtiva/glimmer-cw-cdatetime-nebula): Nebula CDateTime Widget
 
 ### Gem Listing
 
@@ -569,7 +572,7 @@ Output:
                                                                          
   Css    glimmer-dsl-css    0.1.0     AndyMaleh   Glimmer DSL for CSS    
   Opal   glimmer-dsl-opal   0.0.9     AndyMaleh   Glimmer DSL for Opal   
-  Swt    glimmer-dsl-swt    0.3.0     AndyMaleh   Glimmer DSL for SWT    
+  Swt    glimmer-dsl-swt    0.4.1     AndyMaleh   Glimmer DSL for SWT    
   Xml    glimmer-dsl-xml    0.1.0     AndyMaleh   Glimmer DSL for XML    
                                                                          
 ```
@@ -761,7 +764,7 @@ automatically uses the display created earlier without having to explicitly hook
 ```ruby
 @display = display {
   cursor_location 300, 300
-  on_event_keydown {
+  on_swt_keydown {
     # ...
   }
   # ...
@@ -1721,10 +1724,10 @@ Glimmer comes with `Observer` module, which is used internally for data-binding,
 
 Glimmer supports observing widgets with two main types of events:
 1. `on_{swt-listener-method-name}`: where {swt-listener-method-name} is replaced with the lowercase underscored event method name on an SWT listener class (e.g. `on_verify_text` for `org.eclipse.swt.events.VerifyListener#verifyText`).
-2. `on_event_{swt-event-constant}`: where {swt-event-constant} is replaced with an `org.eclipse.swt.SWT` event constant (e.g. `on_event_show` for `SWT.Show` to observe when widget becomes visible)
+2. `on_swt_{swt-event-constant}`: where {swt-event-constant} is replaced with an [`org.eclipse.swt.SWT`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html) event constant (e.g. `on_swt_show` for `SWT.Show` to observe when widget becomes visible)
 
 Additionally, there are two more types of events:
-- SWT `display` supports global listeners called filters that run on any widget. They are hooked via `on_event_{swt-event-constant}`
+- SWT `display` supports global listeners called filters that run on any widget. They are hooked via `on_swt_{swt-event-constant}`
 - SWT `display` supports Mac application menu item observers (`on_about` and `on_preferences`), which you can read about under [Miscellaneous](#miscellaneous).
 
 Number 1 is more commonly used in SWT applications, so make it your starting point. Number 2 covers events not found in number 1, so look into it if you don't find an SWT listener you need in number 1.
@@ -1769,21 +1772,21 @@ Note that every Tic Tac Toe grid cell has its `text` and `enabled` properties da
 
 Next however, each of these Tic Tac Toe grid cells, which are clickable buttons, have an `on_widget_selected` observer, which once triggered, marks the cell on the `TicTacToe::Board` to make a move.
 
-**Regarding number 2**, you can figure out all available events by looking at the `org.eclipse.swt.SWT` API:
+**Regarding number 2**, you can figure out all available events by looking at the [`org.eclipse.swt.SWT`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html) API:
 
 https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
 
 Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
 
-`SWT.Show` - hooks a listener for showing a widget (using `on_event_show` in Glimmer)
-`SWT.Hide` - hooks a listener for hiding a widget (using `on_event_hide` in Glimmer)
+`SWT.Show` - hooks a listener for showing a widget (using `on_swt_show` in Glimmer)
+`SWT.Hide` - hooks a listener for hiding a widget (using `on_swt_hide` in Glimmer)
 
 ```ruby
 shell {
   @button1 = button {
     text "Show 2nd Button"
     visible true
-    on_event_show {
+    on_swt_show {
       @button2.swt_widget.setVisible(false)
     }
     on_widget_selected {
@@ -1793,7 +1796,7 @@ shell {
   @button2 = button {
     text "Show 1st Button"
     visible false
-    on_event_show {
+    on_swt_show {
       @button1.swt_widget.setVisible(false)
     }
     on_widget_selected {
@@ -1803,7 +1806,7 @@ shell {
 }.open
 ```
 
-**Gotcha:** SWT.Resize event needs to be hooked using **`on_event_Resize`** because `org.eclipse.swt.SWT` has 2 constants for resize: `RESIZE` and `Resize`, so it cannot infer the right one automatically from the underscored version `on_event_resize`
+**Gotcha:** SWT.Resize event needs to be hooked using **`on_swt_Resize`** because [`org.eclipse.swt.SWT`](https://help.eclipse.org/2020-06/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html) has 2 constants for resize: `RESIZE` and `Resize`, so it cannot infer the right one automatically from the underscored version `on_swt_resize`
 
 ##### Alternative Syntax
 
@@ -2097,7 +2100,7 @@ shell { |app_shell|
   @current_step_number = 1
   @wizard_steps = 5.times.map { |n|
     wizard_step(number: n+1, step_count: 5) {
-      on_event_hide {
+      on_swt_hide {
         if @current_step_number < 5
           @current_step_number += 1
           app_shell.hide
@@ -2397,7 +2400,7 @@ Also, you may invoke `Display.setAppVersion('1.0.0')` if needed for OS app versi
 
 #### Video Widget
 
-![Video Widget](images/glimmer-video-widget.png)
+[![Video Widget](images/glimmer-video-widget.png)](https://github.com/AndyObtiva/glimmer-cw-video)
 
 Glimmer supports a [video custom widget](https://github.com/AndyObtiva/glimmer-cw-video) not in SWT. 
 
@@ -2449,17 +2452,16 @@ Glimmer configuration may be done via the `Glimmer::Config` module.
 
 ### logger
 
-Glimmer supports logging via a Ruby Logger configurable with the `Glimmer::Config.logger` config option.
-It is disabled by default to ensure not affecting desktop app performance.
-It may be enabled via `Glimmer::Config.enable_logging`
-When enabled, the Glimmer logger level defaults to `:warn` (aka `Logger::WARN`)
-It may be configured to show a different level of logging via `Glimmer::Config.logger.level` just ike with any Ruby Logger.
+Glimmer supports logging via a standard `STDOUT` Ruby `Logger` configured in the `Glimmer::Config.logger` config option.
+It is set to level Logger::ERROR by default. 
+Log level may be adjusted via `Glimmer::Config.logger.level` just like any other Ruby Logger.
+It may be replaced with a custom logger via `Glimmer::Config.logger = custom_logger`
+All logging is done lazily via blocks (e.g. `logger.debug {message}`) to avoid affecting app performance with logging when below the configured logging level threshold.
 
 Example:
 
 ```ruby
-Glimmer::Config.enable_logging
-Glimmer::Config.logger.level = Logger::DEBUG
+Glimmer::Config.logger.level = :debug
 ```
 This results in more verbose debug loggging to `STDOUT`, which is very helpful in troubleshooting Glimmer DSL syntax when needed.
 
@@ -3067,13 +3069,15 @@ Glimmer DSL Engine specific tasks are at:
 
 ## Change Log
 
+[glimmer-dsl-swt/CHANGELOG.md](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/CHANGELOG.md)
+
 [CHANGELOG.md](CHANGELOG.md)
 
 ## Contributing
 
 **Contributors Wanted!**
 
-If you would like to contribute to Glimmer, please study up on Glimmer and [SWT](#swt-reference), run all Glimmer [samples](#samples), and build a small sample app to add to [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) Hello or Elaborate samples via a Pull Request. Once done, contact me on [Chat](#chat).
+If you would like to contribute to Glimmer, please study up on Glimmer and [SWT](#swt-reference), run all Glimmer [samples](#samples), and build a small sample app (perhaps from [this TODO list](https://github.com/AndyObtiva/glimmer-dsl-swt/blob/master/TODO.md#samples)) to add to [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt) Hello or Elaborate samples via a Pull Request. Once done, contact me on [Chat](#chat).
 
 You may apply for contributing to any of these Glimmer DSL gems whether you prefer to focus on the desktop or web:
 - [glimmer-dsl-swt](https://github.com/AndyObtiva/glimmer-dsl-swt): Glimmer DSL for SWT (Desktop GUI)
@@ -3096,7 +3100,11 @@ If your company would like to invest fulltime in further development of the Glim
 
 ## License
 
-Copyright (c) 2007-2020 Andy Maleh.
-See LICENSE.txt for further details.
+[MIT](https://opensource.org/licenses/MIT)
+
+Copyright (c) 2007-2020 - Andy Maleh. 
+See [LICENSE.txt](LICENSE.txt) for further details.
+
+--
 
 Glimmer logo was made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon"> www.flaticon.com</a>

data/VERSION

@@ -1 +1 @@
-0.9.5
+0.10.0

data/lib/glimmer.rb

@@ -52,16 +52,16 @@ module Glimmer
     if method_symbol.to_s.match(REGEX_METHODS_EXCLUDED)
       raise ExcludedKeywordError, "Glimmer excluded keyword: #{method_symbol}"
     end
-    Glimmer::Config.logger&.debug "Interpreting keyword: #{method_symbol}"
+    Glimmer::Config.logger.debug {"Interpreting keyword: #{method_symbol}"}
     Glimmer::DSL::Engine.interpret(method_symbol, *args, &block)
   rescue ExcludedKeywordError => e
     # TODO add a feature to show excluded keywords optionally for debugging purposes
     super(method_symbol, *args, &block)
   rescue InvalidKeywordError => e
     if !method_symbol.to_s.match(REGEX_METHODS_EXCLUDED)
-      Glimmer::Config.logger&.error e.message
+      Glimmer::Config.logger.error {e.message}
     end
-    Glimmer::Config.logger&.debug "#{e.message}\n#{e.backtrace.join("\n")}"
+    Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
     super(method_symbol, *args, &block)
   end
 end

data/lib/glimmer/config.rb

@@ -11,20 +11,23 @@ module Glimmer
       
       # Returns Glimmer logger (standard Ruby logger)
       def logger
-        # unless defined? @@logger
-        #   @@logger = Logger.new(STDOUT).tap {|logger| logger.level = Logger::WARN}
-        # end
-        @@logger if defined? @@logger
+        reset_logger! unless defined? @@logger
+        @@logger
+      end
+      
+      def logger=(custom_logger)
+        @@logger = custom_logger
       end
   
-      def enable_logging
-        @@logger = Logger.new(STDOUT).tap {|logger| logger.level = Logger::WARN}
+      def reset_logger!
+        self.logger = Logger.new(STDOUT).tap do |logger| 
+          logger.level = Logger::ERROR
+        end
       end
     end
   end
 end
 
 if ENV['GLIMMER_LOGGER_LEVEL']
-  Glimmer::Config.enable_logging
   Glimmer::Config.logger.level = ENV['GLIMMER_LOGGER_LEVEL'].downcase
 end

data/lib/glimmer/data_binding/observable_model.rb

@@ -70,7 +70,7 @@ module Glimmer
         end
       rescue => e
         #ignore writing if no property writer exists
-        Glimmer::Config.logger&.debug "No need to observe property writer: #{property_writer_name}\n#{e.message}\n#{e.backtrace.join("\n")}"
+        Glimmer::Config.logger.debug {"No need to observe property writer: #{property_writer_name}\n#{e.message}\n#{e.backtrace.join("\n")}"}
       end
 
       def unregister_dependent_observers(property_name, old_value)

data/lib/glimmer/dsl/engine.rb

@@ -96,7 +96,7 @@ module Glimmer
           dynamic_expression_chains_of_responsibility[dsl] = expression_names.reverse.map do |expression_name|
             expression_class(dsl_namespace, expression_name).new
           end.reduce(nil) do |last_expresion_handler, expression|
-            Glimmer::Config.logger&.debug "Adding dynamic expression: #{expression.class.name}"
+            Glimmer::Config.logger.debug {"Adding dynamic expression: #{expression.class.name}"}
             expression_handler = ExpressionHandler.new(expression)
             expression_handler.next = last_expresion_handler if last_expresion_handler
             expression_handler
@@ -104,7 +104,7 @@ module Glimmer
         end
 
         def add_static_expression(static_expression)
-          Glimmer::Config.logger&.debug "Adding static expression: #{static_expression.class.name}"
+          Glimmer::Config.logger.debug {"Adding static expression: #{static_expression.class.name}"}
           keyword = static_expression.class.keyword
           static_expression_dsl = static_expression.class.dsl
           static_expressions[keyword] ||= {}
@@ -132,7 +132,7 @@ module Glimmer
                 if !static_expression.can_interpret?(Glimmer::DSL::Engine.parent, keyword, *args, &block)
                   raise Error, "Invalid use of Glimmer keyword #{keyword} with args #{args} under parent #{Glimmer::DSL::Engine.parent}"
                 else
-                  Glimmer::Config.logger&.debug "#{static_expression.class.name} will handle expression keyword #{keyword}"
+                  Glimmer::Config.logger.debug {"#{static_expression.class.name} will handle expression keyword #{keyword}"}
                   static_expression.interpret(Glimmer::DSL::Engine.parent, keyword, *args, &block).tap do |ui_object|
                     Glimmer::DSL::Engine.add_content(ui_object, static_expression, &block) unless block.nil?
                     Glimmer::DSL::Engine.dsl_stack.pop

data/lib/glimmer/dsl/expression_handler.rb

@@ -23,9 +23,9 @@ module Glimmer
       # Otherwise, it forwards to the next handler configured via `#next=` method
       # If there is no handler next, then it raises an error
       def handle(parent, keyword, *args, &block)
-        Glimmer::Config.logger&.debug "Attempting to handle #{keyword} with #{@expression.class.name.split(":").last}"
+        Glimmer::Config.logger.debug {"Attempting to handle #{keyword} with #{@expression.class.name.split(":").last}"}
         if @expression.can_interpret?(parent, keyword, *args, &block)
-          Glimmer::Config.logger&.debug "#{@expression.class.name} will handle expression keyword #{keyword}"
+          Glimmer::Config.logger.debug {"#{@expression.class.name} will handle expression keyword #{keyword}"}
           return @expression
         elsif @next_expression_handler
           return @next_expression_handler.handle(parent, keyword, *args, &block)
@@ -34,7 +34,7 @@ module Glimmer
           message = "Glimmer keyword #{keyword} with args #{args} cannot be handled"
           message += " inside parent #{parent}" if parent
           message += "! Check the validity of the code."
-          # Glimmer::Config.logger&.error message
+          # Glimmer::Config.logger.error {message}
           raise InvalidKeywordError, message
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.10.0
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement