glimmer-dsl-swt 4.18.4.3 → 4.18.4.8

data/docs/reference/GLIMMER_STYLE_GUIDE.md

@@ -0,0 +1,14 @@
+## Glimmer Style Guide
+
+- Widgets are declared with underscored lowercase versions of their SWT names minus the SWT package name.
+- Widget declarations may optionally have arguments and be followed by a block (to contain properties and content)
+- Widget blocks are always declared with curly braces
+- Widget arguments are always wrapped inside parentheses
+- Widget properties are declared with underscored lowercase versions of the SWT properties
+- Widget property declarations always have arguments and never take a block
+- Widget property arguments are never wrapped inside parentheses
+- Widget listeners are always declared starting with `on_` prefix and affixing listener event method name afterwards in underscored lowercase form
+- Widget listeners are always followed by a block using curly braces (Only when declared in DSL. When invoked on widget object directly outside of GUI declarations, standard Ruby conventions apply)
+- Data-binding is done via `bind` keyword, which always takes arguments wrapped in parentheses
+- Custom widget body, before_body, and after_body blocks open their blocks and close them with curly braces.
+- Custom widgets receive additional arguments to SWT style called options. These are passed as the last argument inside the parentheses, a hash of option names pointing to values.

data/glimmer-dsl-swt.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-swt 4.18.4.3 ruby lib
+# stub: glimmer-dsl-swt 4.18.4.8 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-swt".freeze
-  s.version = "4.18.4.3"
+  s.version = "4.18.4.8"
 
   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-02-07"
+  s.date = "2021-02-11"
   s.description = "Glimmer DSL for SWT (JRuby Desktop Development GUI Framework) is a native-GUI cross-platform desktop development library written in JRuby, an OS-threaded faster JVM version of Ruby. Glimmer's main innovation is a declarative Ruby DSL that enables productive and efficient authoring of desktop application user-interfaces by relying on the robust Eclipse SWT library. Glimmer additionally innovates by having built-in data-binding support, which greatly facilitates synchronizing the GUI with domain models, thus achieving true decoupling of object oriented components and enabling developers to solve business problems (test-first) without worrying about GUI concerns, or alternatively drive development GUI-first, and then write clean business models (test-first) afterwards. Not only does Glimmer provide a large set of GUI widgets, but it also supports drawing Canvas Graphics like Shapes and Animations. To get started quickly, Glimmer offers scaffolding options for Apps, Gems, and Custom Widgets. Glimmer also includes native-executable packaging support, sorely lacking in other libraries, thus enabling the delivery of desktop apps written in Ruby as truly native DMG/PKG/APP files on the Mac + App Store, MSI/EXE files on Windows, and Gem Packaged Shell Scripts on Linux.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.executables = ["glimmer".freeze, "girb".freeze]
@@ -28,6 +28,13 @@ Gem::Specification.new do |s|
     "bin/girb",
     "bin/girb_runner.rb",
     "bin/glimmer",
+    "docs/reference/GLIMMER_COMMAND.md",
+    "docs/reference/GLIMMER_CONFIGURATION.md",
+    "docs/reference/GLIMMER_GIRB.md",
+    "docs/reference/GLIMMER_GUI_DSL_SYNTAX.md",
+    "docs/reference/GLIMMER_PACKAGING_AND_DISTRIBUTION.md",
+    "docs/reference/GLIMMER_SAMPLES.md",
+    "docs/reference/GLIMMER_STYLE_GUIDE.md",
     "glimmer-dsl-swt.gemspec",
     "icons/scaffold_app.icns",
     "icons/scaffold_app.ico",
@@ -72,6 +79,7 @@ Gem::Specification.new do |s|
     "lib/glimmer/dsl/swt/message_box_expression.rb",
     "lib/glimmer/dsl/swt/multiply_expression.rb",
     "lib/glimmer/dsl/swt/observe_expression.rb",
+    "lib/glimmer/dsl/swt/pixel_expression.rb",
     "lib/glimmer/dsl/swt/property_expression.rb",
     "lib/glimmer/dsl/swt/radio_group_selection_data_binding_expression.rb",
     "lib/glimmer/dsl/swt/rgb_expression.rb",
@@ -82,6 +90,7 @@ Gem::Specification.new do |s|
     "lib/glimmer/dsl/swt/sync_exec_expression.rb",
     "lib/glimmer/dsl/swt/tab_item_expression.rb",
     "lib/glimmer/dsl/swt/table_items_data_binding_expression.rb",
+    "lib/glimmer/dsl/swt/timer_exec_expression.rb",
     "lib/glimmer/dsl/swt/transform_expression.rb",
     "lib/glimmer/dsl/swt/tree_items_data_binding_expression.rb",
     "lib/glimmer/dsl/swt/tree_properties_expression.rb",
@@ -135,8 +144,8 @@ Gem::Specification.new do |s|
     "samples/elaborate/contact_manager/contact_manager_presenter.rb",
     "samples/elaborate/contact_manager/contact_repository.rb",
     "samples/elaborate/login.rb",
+    "samples/elaborate/mandelbrot_fractal.rb",
     "samples/elaborate/meta_sample.rb",
-    "samples/elaborate/meta_sample/meta_sample_logo.png",
     "samples/elaborate/tetris.rb",
     "samples/elaborate/tetris/model/block.rb",
     "samples/elaborate/tetris/model/game.rb",
@@ -156,7 +165,6 @@ Gem::Specification.new do |s|
     "samples/hello/hello_canvas.rb",
     "samples/hello/hello_canvas_animation.rb",
     "samples/hello/hello_canvas_transform.rb",
-    "samples/hello/hello_canvas_transform/hello_canvas_transform_image.png",
     "samples/hello/hello_checkbox.rb",
     "samples/hello/hello_checkbox_group.rb",
     "samples/hello/hello_code_text.rb",
@@ -201,7 +209,7 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<glimmer>.freeze, ["~> 1.0.11"])
+      s.add_runtime_dependency(%q<glimmer>.freeze, ["~> 1.1.1"])
       s.add_runtime_dependency(%q<super_module>.freeze, [">= 1.4.1", "< 2.0.0"])
       s.add_runtime_dependency(%q<nested_inherited_jruby_include_package>.freeze, [">= 0.3.0", "< 2.0.0"])
       s.add_runtime_dependency(%q<puts_debuggerer>.freeze, [">= 0.11.0", "< 2.0.0"])
@@ -220,7 +228,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.16.1"])
       s.add_development_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
     else
-      s.add_dependency(%q<glimmer>.freeze, ["~> 1.0.11"])
+      s.add_dependency(%q<glimmer>.freeze, ["~> 1.1.1"])
       s.add_dependency(%q<super_module>.freeze, [">= 1.4.1", "< 2.0.0"])
       s.add_dependency(%q<nested_inherited_jruby_include_package>.freeze, [">= 0.3.0", "< 2.0.0"])
       s.add_dependency(%q<puts_debuggerer>.freeze, [">= 0.11.0", "< 2.0.0"])
@@ -240,7 +248,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov-lcov>.freeze, ["~> 0.7.0"])
     end
   else
-    s.add_dependency(%q<glimmer>.freeze, ["~> 1.0.11"])
+    s.add_dependency(%q<glimmer>.freeze, ["~> 1.1.1"])
     s.add_dependency(%q<super_module>.freeze, [">= 1.4.1", "< 2.0.0"])
     s.add_dependency(%q<nested_inherited_jruby_include_package>.freeze, [">= 0.3.0", "< 2.0.0"])
     s.add_dependency(%q<puts_debuggerer>.freeze, [">= 0.11.0", "< 2.0.0"])

data/lib/glimmer/dsl/swt/custom_widget_expression.rb

@@ -1,5 +1,5 @@
 # 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
@@ -7,10 +7,10 @@
 # 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

data/lib/glimmer/dsl/swt/exec_expression.rb

@@ -41,7 +41,7 @@ module Glimmer
         end
   
         def interpret(parent, keyword, *args, &block)
-          Glimmer::SWT::DisplayProxy.instance.swt_display.send(exec_operation) do |*args|
+          Glimmer::SWT::DisplayProxy.instance.swt_display.send(exec_operation, *args) do |*args|
             begin
               block.call(*args)
             rescue => e

data/lib/glimmer/dsl/swt/image_expression.rb

@@ -20,7 +20,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'glimmer/dsl/expression'
+require 'glimmer/dsl/top_level_expression'
 require 'glimmer/swt/image_proxy'
+require 'glimmer/swt/widget_proxy'
 
 module Glimmer
   module DSL
@@ -28,6 +30,7 @@ module Glimmer
       # image expression
       # Note: Cannot be a static expression because it clashes with image property expression
       class ImageExpression < Expression
+        include TopLevelExpression
         include ParentExpression
         
         def can_interpret?(parent, keyword, *args, &block)

data/lib/glimmer/dsl/swt/observe_expression.rb

@@ -1,5 +1,5 @@
 # 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
@@ -7,10 +7,10 @@
 # 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
@@ -23,6 +23,7 @@ require 'glimmer/dsl/static_expression'
 require 'glimmer/dsl/top_level_expression'
 require 'glimmer/data_binding/observer'
 require 'glimmer/data_binding/model_binding'
+require 'glimmer/ui/custom_widget'
 
 module Glimmer
   module DSL
@@ -42,10 +43,12 @@ module Glimmer
         def interpret(parent, keyword, *args, &block)
           observer = DataBinding::Observer.proc(&block)
           if args[1].to_s.match(REGEX_NESTED_OR_INDEXED_PROPERTY)
-            observer.observe(DataBinding::ModelBinding.new(args[0], args[1]))
+            observer_registration = observer.observe(DataBinding::ModelBinding.new(args[0], args[1]))
           else
-            observer.observe(args[0], args[1])
+            observer_registration = observer.observe(args[0], args[1])
           end
+          Glimmer::UI::CustomWidget.current_custom_widgets.last&.observer_registrations&.push(observer_registration)
+          observer_registration
         end
       end
     end

data/lib/glimmer/dsl/swt/pixel_expression.rb

@@ -0,0 +1,38 @@
+# 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/swt/swt_proxy'
+require 'glimmer/swt/custom/shape'
+require 'glimmer/swt/custom/drawable'
+
+module Glimmer
+  module DSL
+    module SWT
+      class PixelExpression < StaticExpression
+
+        def interpret(parent, keyword, *args, &block)
+          Glimmer::SWT::Custom::Shape.new(parent, 'point', *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/swt/timer_exec_expression.rb

@@ -0,0 +1,35 @@
+# 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/dsl/swt/exec_expression'
+
+module Glimmer
+  module DSL
+    module SWT
+      # Asynchronously executes code block against the SWT Event Loop
+      # after a certain time elapsed
+      class TimerExecExpression < StaticExpression
+        include ExecExpression
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/swt/widget_expression.rb

@@ -46,6 +46,7 @@ module Glimmer
         def add_content(parent, &block)
           super
           parent.post_add_content
+          parent.finish_add_content!
         end
 
       end

data/lib/glimmer/swt/color_proxy.rb

@@ -59,8 +59,10 @@ module Glimmer
       # rgba is 4 arguments representing Red, Green, Blue, and Alpha numeric values
       #
       def initialize(*args)
+        @options = args.last.is_a?(Hash) ? args.pop : {}
         @args = args
-        ensure_arg_values_within_valid_bounds
+        @args = @args.first if @args.first.is_a?(Array)
+        ensure_arg_values_within_valid_bounds unless @options[:ensure_bounds] == false
       end
 
       def swt_color
@@ -75,8 +77,7 @@ module Glimmer
               @swt_color = @args.first
             end
           when 3..4
-            red, green, blue, alpha = @args
-            @swt_color = Color.new(*[red, green, blue, alpha].compact)
+            @swt_color = Color.new(*@args)
           end
         end
         @swt_color

data/lib/glimmer/swt/custom/animation.rb

@@ -26,7 +26,7 @@ module Glimmer
     module Custom
       # Represents an animation declaratively
       class Animation
-        include Properties # TODO rename to Properties
+        include Properties
         
         class << self
           def schedule_frame_animation(animation, &frame_animation_block)
@@ -84,6 +84,7 @@ module Glimmer
         
         def initialize(parent)
           @parent = parent
+          @parent.requires_shape_disposal = true
           @started = true
           @frame_index = 0
           @cycle_count_index = 0
@@ -92,8 +93,10 @@ module Glimmer
         end
         
         def post_add_content
-          @parent.on_widget_disposed { stop }
-          start if started?
+          if @dispose_listener_registration.nil?
+            @dispose_listener_registration = @parent.on_widget_disposed { stop }
+            start if started?
+          end
         end
         
         # Starts an animation that is indefinite or has never been started before (i.e. having `started: false` option).
@@ -212,11 +215,10 @@ module Glimmer
           current_cycle_count_index = @cycle_count_index
           self.class.schedule_frame_animation(self) do
             if started? && start_number == @start_number && within_duration_limit?
-              @parent.clear_shapes
-              @parent.content {
-                frame_block.call(*block_args)
-              }
-              @parent.redraw
+              unless @parent.isDisposed
+                @parent.clear_shapes # TODO adjust this to clear only the shapes of this animation (not all shapes) to allow simultaneous animations to occur on the same parent
+                @parent.content { frame_block.call(*block_args) }
+              end
             else
               if stopped? && @frame_index > current_frame_index
                 @started = false

data/lib/glimmer/swt/custom/code_text.rb

@@ -22,8 +22,6 @@ module Glimmer
         REGEX_COLOR_HEX6 = /^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/
         
         # TODO support auto language detection
-        # TODO support end of line via CMD+E and beginning of line via CMD+A
-        # TODO support select all via CMD+A
               
         option :language, default: 'ruby'
         # TODO consider supporting data-binding of language
@@ -31,6 +29,9 @@ module Glimmer
         # TODO support method for redrawing the syntax highlighting
         option :theme, default: 'glimmer'
         option :lines, default: false
+
+        # This option indicates if default keyboard handlers/menus should be activated
+        option :default_behavior, default: true
       
         alias lines? lines
         attr_accessor :styled_text_proxy_text, :styled_text_proxy_top_pixel
@@ -42,6 +43,7 @@ module Glimmer
             args.pop if args.last.is_a?(Hash) && args.last[:dsl]
             super(method_name, *args, &block)
           elsif @styled_text_proxy&.respond_to?(method_name, *args, &block)
+            @line_numbers_styled_text_proxy&.send(method_name, *args, &block) if method_name.to_s == 'font='
             @styled_text_proxy&.send(method_name, *args, &block)
           else
             super
@@ -88,28 +90,29 @@ module Glimmer
         }
         
         body {
-          # TODO enable this once fully implemented
           if lines
             composite {
               grid_layout(2, false)
               
               @line_numbers_styled_text_proxy = styled_text(swt(swt(swt_style), :h_scroll!, :v_scroll!)) {
                 layout_data(:right, :fill, false, true)
-                text bind(self, :styled_text_proxy_text, read_only: true) { |text_value|
-                  line_count = "#{text_value} ".split("\n").count
-                  line_count = 1 if line_count == 0
-                  lines_text_size = [line_count.to_s.size, @lines_width].max
-                  if lines_text_size > @lines_width
-                    async_exec {
-                      swt_widget.layout
-                    }
-                    @lines_width = lines_text_size
-                  end
-                  async_exec {
+                top_pixel_before_read = nil
+                text bind(self,
+                  :styled_text_proxy_text,
+                  read_only: true,
+                  on_read: lambda { |text_value|
+                    line_count = "#{text_value} ".split("\n").count
+                    line_count = 1 if line_count == 0
+                    lines_text_size = [line_count.to_s.size, @lines_width].max
+                    if lines_text_size > @lines_width
+                      @lines_width = lines_text_size
+                    end
+                    line_count.times.map {|n| (' ' * (lines_text_size - (n+1).to_s.size)) + (n+1).to_s }.join("\n") + "\n"
+                  },
+                  after_read: lambda {
                     @line_numbers_styled_text_proxy&.top_pixel = styled_text_proxy_top_pixel
                   }
-                  line_count.times.map {|n| (' ' * (lines_text_size - (n+1).to_s.size)) + (n+1).to_s }.join("\n") + "\n"
-                }
+                )
                 top_pixel bind(self, :styled_text_proxy_top_pixel, read_only: true)
                 font name: @font_name, height: OS.mac? ? 15 : 12
                 background color(:widget_background)
@@ -144,22 +147,22 @@ module Glimmer
             layout_data :fill, :fill, true, true if lines
             text bind(self, :styled_text_proxy_text) if lines
             top_pixel bind(self, :styled_text_proxy_top_pixel) if lines
-            font name: @font_name, height: 15
+            font name: @font_name, height: OS.mac? ? 15 : 12
             foreground rgb(75, 75, 75)
             left_margin 5
             top_margin 5
             right_margin 5
             bottom_margin 5
             
-            if lines
+            if default_behavior
               on_key_pressed { |event|
                 character = event.keyCode.chr rescue nil
                 case [event.stateMask, character]
                 when [(OS.mac? ? swt(:command) : swt(:ctrl)), 'a']
                   @styled_text_proxy.swt_widget.selectAll
-                when [(swt(:ctrl) unless OS.windows?), 'a']
+                when [(swt(:ctrl) if OS.mac?), 'a']
                   jump_to_beginning_of_line
-                when [(swt(:ctrl) unless OS.windows?), 'e']
+                when [(swt(:ctrl) if OS.mac?), 'e']
                   jump_to_end_of_line
                 end
               }
@@ -228,6 +231,7 @@ module Glimmer
           @lexer ||= Rouge::Lexer.find_fancy('ruby') # default to Ruby if no lexer is found
         end
         
+        # TODO extract this to ColorProxy
         def hex_color_to_swt_color(color_data, default_color)
           color_data = "##{color_data.chars.drop(1).map {|c| c*2}.join}" if color_data.is_a?(String) && color_data.start_with?('#') && color_data&.size == 4
           color_data = color_data.match(REGEX_COLOR_HEX6).to_a.drop(1).map {|c| "0x#{c}".hex}.to_a if color_data.is_a?(String) && color_data.start_with?('#')