glimmer-dsl-swt 4.18.1.0 → 4.18.2.3

data/lib/glimmer/dsl/swt/display_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/property_expression.rb

@@ -30,7 +30,8 @@ module Glimmer
             args.size > 0 and
             parent.respond_to?(:set_attribute) and
             parent.respond_to?(:has_attribute?) and
-            parent.has_attribute?(keyword, *args)
+            parent.has_attribute?(keyword, *args) and
+            !(parent.respond_to?(:swt_widget) && parent.swt_widget.class == org.eclipse.swt.widgets.Canvas && keyword == 'image')
         end
   
         def interpret(parent, keyword, *args, &block)

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

@@ -39,7 +39,7 @@ module Glimmer
         end
         
         def interpret(parent, keyword, *args, &block)
-          Glimmer::SWT::Custom::Shape.new(parent, keyword, *args)
+          Glimmer::SWT::Custom::Shape.new(parent, keyword, *args, &block)
         end
         
         def add_content(parent, &block)

data/lib/glimmer/rake_task/list.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
@@ -57,11 +57,11 @@ module Glimmer
           lines = `gem search -d #{gem_prefix}`.split("\n")
           gems = lines.slice_before {|l| l.match(REGEX_GEM_LINE) }.to_a
           gems = gems.map do |gem|
-            {            
+            {
               name: gem[0].match(REGEX_GEM_LINE)[1],
               version: gem[0].match(REGEX_GEM_LINE)[2],
               author: gem[1].strip,
-              description: gem[4..-1].map(&:strip).join(' ')
+              description: gem[4..-1]&.map(&:strip)&.join(' ').to_s
             }
           end.select do |gem|
             query.nil? || "#{gem[:name]} #{gem[:author]} #{gem[:description]}".downcase.include?(query.to_s.downcase)

data/lib/glimmer/rake_task/package.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
@@ -27,7 +27,7 @@ module Glimmer
     module Package
       class << self
         attr_accessor :javapackager_extra_args
-        alias jpackage_extra_args :javapackager_extra_args
+        alias jpackage_extra_args javapackager_extra_args
         
         def clean
           require 'fileutils'
@@ -48,7 +48,7 @@ module Glimmer
           FileUtils.mkdir_p('vendor/jars')
           command = "lock_jars --vendor-dir vendor/jars"
           puts command
-          system command      
+          system command
         end
         
         def config
@@ -78,18 +78,18 @@ module Glimmer
             else
               puts 'Warbler executable "warble" is missing!'
             end
-          end      
+          end
         end
         
         def jar
           FileUtils.mkdir_p('dist')
           puts "Generating JAR with Warbler..."
           system "jruby -S gem install warbler -v2.0.5 --no-document" unless warbler_exists?
-          system('warble')      
+          system('warble')
         end
         
         def native(native_type=nil, native_extra_args)
-          puts "Generating native executable with javapackager/jpackage..."          
+          puts "Generating native executable with javapackager/jpackage..."
           java_version = `java -version`
           puts "WARNING! Glimmer Packaging Pre-Requisite Java Version 1.8.0_241 Is Not Found!" unless java_version.include?('1.8.0_241')
           require 'facets/string/titlecase'
@@ -125,7 +125,7 @@ module Glimmer
           command += " #{ENV['JAVAPACKAGER_EXTRA_ARGS']} " if ENV['JAVAPACKAGER_EXTRA_ARGS']
           command += " #{native_extra_args} " if native_extra_args
           puts command
-          system command      
+          system command
         end
         
         private

data/lib/glimmer/rake_task/scaffold.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
@@ -42,6 +42,7 @@ module Glimmer
           *.gem
           *.rbc
           /.config
+          /.mvn/
           /coverage/
           /InstalledFiles
           /pkg/
@@ -97,9 +98,9 @@ module Glimmer
           .gladiator
           
           # Glimmer
-          dist
-          packages
-          vendor/jars
+          /dist/
+          /packages/
+          /vendor/jars/
         MULTI_LINE_STRING
     
         GEMFILE = <<~MULTI_LINE_STRING
@@ -113,7 +114,6 @@ module Glimmer
           
           group :development do
             gem 'rspec', '~> 3.5.0'
-            gem 'git-glimmer', '1.7.0'
             gem 'juwelier', '2.4.9'
             gem 'warbler', '2.0.5'
             gem 'simplecov', '>= 0'
@@ -133,12 +133,12 @@ module Glimmer
           gem_summary = human_name(app_name)
           return puts("The directory '#{gem_name}' already exists. Please either remove or pick a different name.") if Dir.exist?(gem_name)
           system "jruby -S gem install juwelier -v2.4.9 --no-document" unless juwelier_exists?
-          system "jruby -r git-glimmer -S juwelier --markdown --rspec --summary '#{gem_summary}' --description '#{gem_summary}' #{gem_name}" 
+          system "jruby -S juwelier --markdown --rspec --summary '#{gem_summary}' --description '#{gem_summary}' #{gem_name}"
           return puts('Your Git user.name and/or github.user are missing! Please add in for Juwelier to help Glimmer with Scaffolding.') if `git config --get github.user`.strip.empty? && `git config --get user.name`.strip.empty?
           cd gem_name
           rm_rf 'lib'
           write '.gitignore', GITIGNORE
-          write '.ruby-version', RUBY_VERSION        
+          write '.ruby-version', RUBY_VERSION
           write '.ruby-gemset', app_name
           write 'VERSION', '1.0.0'
           write 'LICENSE.txt', "Copyright (c) #{Time.now.year} #{app_name}"
@@ -178,7 +178,7 @@ module Glimmer
             system "bundle"
             system "rspec --init"
           else
-            system "bash -c '#{RVM_FUNCTION}\n cd .\n bundle\n rspec --init\n'"          
+            system "bash -c '#{RVM_FUNCTION}\n cd .\n bundle\n rspec --init\n'"
           end
           write 'spec/spec_helper.rb', spec_helper_file
           if OS.windows?
@@ -191,7 +191,7 @@ module Glimmer
             else
               system "glimmer run"
             end
-          end        
+          end
         end
     
         def custom_shell(custom_shell_name, namespace, shell_type = nil, shell_options = {})
@@ -231,11 +231,11 @@ module Glimmer
           end
           return puts("The directory '#{gem_name}' already exists. Please either remove or pick a different name.") if Dir.exist?(gem_name)
           system "jruby -S gem install juwelier -v2.4.9 --no-document" unless juwelier_exists?
-          system "jruby -r git-glimmer -S juwelier --markdown --rspec --summary '#{gem_summary}' --description '#{gem_summary}' #{gem_name}" 
+          system "jruby -S juwelier --markdown --rspec --summary '#{gem_summary}' --description '#{gem_summary}' #{gem_name}"
           return puts('Your Git user.name and/or github.user are missing! Please add in for Juwelier to help Glimmer with Scaffolding.') if `git config --get github.user`.strip.empty? && `git config --get user.name`.strip.empty?
           cd gem_name
           write '.gitignore', GITIGNORE
-          write '.ruby-version', RUBY_VERSION        
+          write '.ruby-version', RUBY_VERSION
           write '.ruby-gemset', gem_name
           write 'VERSION', '1.0.0'
           write 'Gemfile', GEMFILE
@@ -256,7 +256,7 @@ module Glimmer
             system "rspec --init"
           else
             system "bash -c '#{RVM_FUNCTION}\n cd .\n bundle\n rspec --init\n'"
-          end      
+          end
           write 'spec/spec_helper.rb', spec_helper_file
     
           mkdir_p 'package/windows'
@@ -283,7 +283,7 @@ module Glimmer
               system "open packages/bundles/#{human_name(custom_shell_name).gsub(' ', '\ ')}.app" if OS.mac?
             else
               system "glimmer run"
-            end        
+            end
           end
           puts "Finished creating #{gem_name} Ruby gem."
           puts 'Edit Rakefile to configure gem details.'
@@ -305,11 +305,11 @@ module Glimmer
           
           return puts("The directory '#{gem_name}' already exists. Please either remove or pick a different name.") if Dir.exist?(gem_name)
           system "jruby -S gem install juwelier -v2.4.9 --no-document" unless juwelier_exists?
-          system "jruby -r git-glimmer -S juwelier --markdown --rspec --summary '#{gem_summary}' --description '#{gem_summary}' #{gem_name}" 
+          system "jruby -S juwelier --markdown --rspec --summary '#{gem_summary}' --description '#{gem_summary}' #{gem_name}"
           return puts('Your Git user.name and/or github.user are missing! Please add in for Juwelier to help Glimmer with Scaffolding.') if `git config --get github.user`.strip.empty? && `git config --get user.name`.strip.empty?
           cd gem_name
           write '.gitignore', GITIGNORE
-          write '.ruby-version', RUBY_VERSION        
+          write '.ruby-version', RUBY_VERSION
           write '.ruby-gemset', gem_name
           write 'VERSION', '1.0.0'
           write 'Gemfile', GEMFILE
@@ -397,9 +397,9 @@ module Glimmer
             class #{class_name(app_name)}
               include Glimmer
             
-              APP_ROOT = File.expand_path('../..', __FILE__)        
+              APP_ROOT = File.expand_path('../..', __FILE__)
               VERSION = File.read(File.join(APP_ROOT, 'VERSION'))
-              LICENSE = File.read(File.join(APP_ROOT, 'LICENSE.txt'))          
+              LICENSE = File.read(File.join(APP_ROOT, 'LICENSE.txt'))
                         
               def open
                 app_view.open
@@ -443,7 +443,7 @@ module Glimmer
               
               launcher = Glimmer::Launcher.new([runner] + ARGV)
               launcher.launch
-            end            
+            end
           MULTI_LINE_STRING
         end
         
@@ -482,7 +482,7 @@ module Glimmer
               
               launcher = Glimmer::Launcher.new([runner] + ARGV)
               launcher.launch
-            end                        
+            end
           MULTI_LINE_STRING
         end
     
@@ -502,15 +502,15 @@ module Glimmer
           end
           spec_pattern_line_index = lines.index(lines.detect {|l| l.include?('spec.pattern =') })
           lines.insert(spec_pattern_line_index+1, "  spec.ruby_opts = [Glimmer::Launcher.jruby_os_specific_options]")
-          lines << "\nrequire 'glimmer/rake_task'\n"       
+          lines << "\nrequire 'glimmer/rake_task'\n"
           file_content = lines.join("\n")
           if custom_shell_name
-            file_content << <<~MULTI_LINE_STRING  
+            file_content << <<~MULTI_LINE_STRING
               Glimmer::RakeTask::Package.javapackager_extra_args =
                 " -name '#{human_name(custom_shell_name)}'" +
                 " -title '#{human_name(custom_shell_name)}'" +
                 " -Bmac.CFBundleName='#{human_name(custom_shell_name)}'" +
-                " -Bmac.CFBundleIdentifier='org.#{namespace ? compact_name(namespace) : compact_name(custom_shell_name)}.application.#{compact_name(custom_shell_name).camelcase(:upper)}'" 
+                " -Bmac.CFBundleIdentifier='org.#{namespace ? compact_name(namespace) : compact_name(custom_shell_name)}.application.#{compact_name(custom_shell_name).camelcase(:upper)}'"
                 # " -BlicenseType=" +
                 # " -Bmac.category=" +
                 # " -Bmac.signing-key-developer-id-app="
@@ -575,8 +575,8 @@ module Glimmer
           if %i[gem app desktopify].include?(shell_type)
             custom_shell_file_content += <<-MULTI_LINE_STRING
         before_body {
-          Display.setAppName('#{shell_type == :gem ? human_name(custom_shell_name) : human_name(namespace)}')
-          Display.setAppVersion(VERSION)
+          Display.app_name = '#{shell_type == :gem ? human_name(custom_shell_name) : human_name(namespace)}'
+          Display.app_version = VERSION
           @display = display {
             on_about {
               display_about_dialog
@@ -600,7 +600,7 @@ module Glimmer
         ## Use after_body block to setup observers for widgets in body
         #
         # after_body {
-        # 
+        #
         # }
     
         ## Add widget content inside custom shell body
@@ -616,10 +616,10 @@ module Glimmer
           MULTI_LINE_STRING
             
           if shell_type == :desktopify
-            custom_shell_file_content += <<-MULTI_LINE_STRING            
+            custom_shell_file_content += <<-MULTI_LINE_STRING
             browser {
-              url "#{shell_options[:website]}"              
-            }            
+              url "#{shell_options[:website]}"
+            }
             MULTI_LINE_STRING
           else
             custom_shell_file_content += <<-MULTI_LINE_STRING
@@ -628,7 +628,7 @@ module Glimmer
               text bind(self, :greeting)
               font height: 40
               layout_data :fill, :center, true, true
-            }            
+            }
             MULTI_LINE_STRING
           end
           
@@ -690,7 +690,7 @@ module Glimmer
               text 'Greeting'
               font style: :bold
               [
-                'Hello, World!', 
+                'Hello, World!',
                 'Howdy, Partner!'
               ].each do |greeting_text|
                 button(:radio) {
@@ -733,19 +733,19 @@ module Glimmer
                 #
                 #
                 # before_body {
-                # 
+                #
                 # }
             
                 ## Use after_body block to setup observers for widgets in body
                 #
                 # after_body {
-                # 
+                #
                 # }
             
                 ## Add widget content under custom widget body
                 ##
-                ## If you want to add a shell as the top-most widget, 
-                ## consider creating a custom shell instead 
+                ## If you want to add a shell as the top-most widget,
+                ## consider creating a custom shell instead
                 ## (Glimmer::UI::CustomShell offers shell convenience methods, like show and hide)
                 #
                 body {

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

@@ -28,68 +28,127 @@ module Glimmer
       class Animation
         include Properties # TODO rename to Properties
         
-        attr_reader :parent, :options, :frame_index
+        class << self
+          def schedule_frame_animation(animation, &frame_animation_block)
+            frame_animation_queue(animation).prepend(frame_animation_block)
+            swt_display.async_exec do
+              frame_animation_queue(next_animation)&.pop&.call
+            end
+          end
+          
+          def next_animation
+            animation = nil
+            while frame_animation_queues.values.reduce(:+)&.any? && (animation.nil? || frame_animation_queue(animation).last.nil?)
+              animation = frame_animation_queues.keys[next_animation_index]
+              frame_animation_queues.delete(animation) if frame_animation_queues.values.reduce(:+)&.any? && !animation.nil? && frame_animation_queue(animation).empty?
+            end
+            animation
+          end
+          
+          def next_animation_index
+            next_schedule_index % frame_animation_queues.keys.size
+          end
+          
+          def next_schedule_index
+            unless defined? @@next_schedule_index
+              @@next_schedule_index = 0
+            else
+              @@next_schedule_index += 1
+            end
+          end
+          
+          def frame_animation_queues
+            unless defined? @@frame_animation_queues
+              @@frame_animation_queues = {}
+            end
+            @@frame_animation_queues
+          end
+          
+          def frame_animation_queue(animation)
+            frame_animation_queues[animation] ||= []
+          end
+          
+          def swt_display
+            unless defined? @@swt_display
+              @@swt_display = DisplayProxy.instance.swt_display
+            end
+            @@swt_display
+          end
+        end
+        
+        attr_reader :parent, :options, :frame_index, :cycle
         alias current_frame_index frame_index
-        attr_accessor :frame_block, :every, :cycle, :cycle_count, :frame_count, :started
+        attr_accessor :frame_block, :every, :cycle_count, :frame_count, :started, :duration_limit
+        alias started? started
         # TODO consider supporting an async: false option
         
         def initialize(parent)
           @parent = parent
           @started = true
           @frame_index = 0
+          @cycle_count_index = 0
+          @start_number = 0 # denotes the number of starts (increments on every start)
+          self.class.swt_display # ensures initializing variable to set from GUI thread
         end
         
         def post_add_content
           @parent.on_widget_disposed { stop }
-          start if @started
+          start if started?
         end
-    
+        
+        # Starts an animation that is indefinite or has never been started before (i.e. having `started: false` option).
+        # Otherwise, resumes a stopped animation that has not been completed.
         def start
-          swt_display = Glimmer::SWT::DisplayProxy.instance.swt_display
-          return if swt_display.is_disposed?
+          return if @start_number > 0 && started?
+          @start_number += 1
+          @started = true
+          @start_time = Time.now
+          @original_start_time = @start_time if @duration.nil?
+          # TODO track when finished in a variable for finite animations (whether by frame count, cycle count, or duration limit)
           Thread.new do
-            frame_rendering_block = lambda do
-              block_args = [@frame_index]
-              block_args << @cycle[@frame_index % @cycle.length] if @cycle.is_a?(Array)
-              swt_display.async_exec do
-                @parent.clear_shapes
-                @parent.content {
-                  frame_block.call(*block_args)
-                }
-              end
-              @frame_index += 1
-              sleep(every) if every.is_a?(Numeric)
-            end
-  
+            start_number = @start_number
             if cycle_count.is_a?(Integer) && cycle.is_a?(Array)
               (cycle_count * cycle.length).times do
-                break if break_condition?
-                begin
-                  frame_rendering_block.call
-                rescue => e
-                  Glimmer::Config.logger.error {e}
-                  break
-                end
+                break unless draw_frame(start_number)
               end
             else
               loop do
-                break if break_condition?
-                begin
-                  frame_rendering_block.call
-                rescue => e
-                  Glimmer::Config.logger.error {e}
-                  break
-                end
+                # this code has to be duplicated to break from a loop (break keyword only works when literally in a loop block)
+                break unless draw_frame(start_number)
               end
             end
-            @started = false
           end
         end
         
         def stop
+          return if stopped?
           @started = false
+          @duration = (Time.now - @start_time) + @duration.to_f if duration_limited? && !@start_time.nil?
+        end
+        
+        # Restarts an animation (whether indefinite or not and whether stopped or not)
+        def restart
+          @original_start_time = @start_time = nil
+          @duration = nil
+          @frame_index = 0
+          @cycle_count_index = 0
+          stop
+          start
+        end
+        
+        def stopped?
+          !started?
         end
         
+        def finite?
+          frame_count_limited? || cycle_limited? || duration_limited?
+        end
+        
+        def infinite?
+          !finite?
+        end
+        alias indefinite? infinite?
+        
         def has_attribute?(attribute_name, *args)
           respond_to?(ruby_attribute_setter(attribute_name)) && respond_to?(ruby_attribute_getter(attribute_name))
         end
@@ -102,11 +161,79 @@ module Glimmer
           send(ruby_attribute_getter(attribute_name))
         end
         
+        def cycle=(*args)
+          if args.size == 1
+            if args.first.is_a?(Array)
+              @cycle = args.first
+            else
+              @cycle = [args.first]
+            end
+          elsif args.size > 1
+            @cycle = args
+          end
+        end
+        
+        def cycle_enabled?
+          @cycle.is_a?(Array)
+        end
+        
+        def cycle_limited?
+          cycle_enabled? && @cycle_count.is_a?(Integer)
+        end
+        
+        def duration_limited?
+          @duration_limit.is_a?(Integer)
+        end
+        
+        def frame_count_limited?
+          @frame_count.is_a?(Integer)
+        end
+        
+        def surpassed_duration_limit?
+          duration_limited? && ((Time.now - @start_time) > (@duration_limit - @duration.to_f))
+        end
+        
+        def within_duration_limit?
+          !surpassed_duration_limit?
+        end
+        
         private
         
-        def break_condition?
-          !@started || (@frame_count.is_a?(Integer) && @frame_index == @frame_count)
+        # Returns true on success of painting a frame and false otherwise
+        def draw_frame(start_number)
+          return false if stopped? ||
+                          start_number != @start_number ||
+                          (frame_count_limited? && @frame_index == @frame_count) ||
+                          (cycle_limited? && @cycle_count_index == @cycle_count) ||
+                          surpassed_duration_limit?
+          block_args = [@frame_index]
+          block_args << @cycle[@frame_index % @cycle.length] if cycle_enabled?
+          current_frame_index = @frame_index
+          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
+            else
+              if stopped? && @frame_index > current_frame_index
+                @started = false
+                @frame_index = current_frame_index
+                @cycle_count_index = current_cycle_count_index
+              end
+            end
+          end
+          @frame_index += 1
+          @cycle_count_index += 1 if cycle_limited? && (@frame_index % @cycle&.length&.to_i) == 0
+          sleep(every) if every.is_a?(Numeric)
+          true
+        rescue => e
+          Glimmer::Config.logger.error {e}
+          false
         end
+        
       end
       
     end