glimmer 0.5.9 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1c351e3623c60e0ae9e52ce1f33b1579b5a3bb1cfc161c1eb2b6883bfe905b6
-  data.tar.gz: 4bb0c04faf2a1a9c68ac58f2acb386112f3706c7fae34c2e1c7dba9c99783f60
+  metadata.gz: 07ac7dc0e7c7beab5855763da9b232037f6561b93c0b8240db5a96fc74a3e026
+  data.tar.gz: 934ff722e09b38eec4c4ede3c369f910ead8d070bbb151f42ec59feac7d66328
 SHA512:
-  metadata.gz: 42f75cb443468b0b4f9487b333882c1517803b66ce326c63b28780c9c98e809b27ce6cd2ce9928c61dc9f399c9ac2bd859a4c1910040869963e912893f87ddca
-  data.tar.gz: 5b4bed4b26bc8aed20c996bf21b24bcc26860ea06433a053faf0ad011921fb63f84f963750a5a03e64b089602a27a28b6fcee72a08f09a21a4a5d26ed29b9575
+  metadata.gz: abd9390fb32d7e5aaa099d8002527371825d7109e69adeb1fc91e2440dd8b92010691839983bcbed177ce27d5b7c469f9294a62a77261b971eba301986e0e3ae
+  data.tar.gz: c75edc6edce8909868465a75d26ba9cd054192ac256d34f2bc8f271e129326e504e91c3ca1f84b7a0be1c0079f609ab05995e21091002a4aa2d29d8f91a38d28

data/README.markdown

@@ -1,4 +1,4 @@
-# Glimmer 0.5.9 Beta (JRuby Desktop UI DSL + Data-Binding)
+# Glimmer 0.5.10 Beta (JRuby Desktop UI DSL + Data-Binding)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/glimmer/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/glimmer?branch=master)
 
 Glimmer is a native-UI cross-platform desktop development library written in Ruby. Glimmer's main innovation is a JRuby DSL that enables productive and efficient authoring of desktop application user-interfaces while relying on the robust platform-native Eclipse SWT library. Glimmer additionally innovates by having built-in data-binding support to greatly facilitate synchronizing the UI with domain models. As a result, that achieves true decoupling of object oriented components, enabling developers to solve business problems without worrying about UI concerns, or alternatively drive development UI-first, and then write clean business components test-first afterwards.
@@ -70,7 +70,7 @@ NOTE: Glimmer is in beta mode. Please help make better by adopting for small or
 ## Table of Contents
 
 <!-- TOC START min:1 max:3 link:true asterisk:false update:true -->
-- [Glimmer 0.5.9 Beta (JRuby Desktop UI DSL + Data-Binding)](#glimmer-058-beta-jruby-desktop-ui-dsl--data-binding)
+- [Glimmer 0.5.10 Beta (JRuby Desktop UI DSL + Data-Binding)](#glimmer-058-beta-jruby-desktop-ui-dsl--data-binding)
   - [Examples](#examples)
     - [Hello World](#hello-world)
     - [Tic Tac Toe](#tic-tac-toe)
@@ -163,14 +163,14 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-jgem install glimmer -v 0.5.9
+jgem install glimmer -v 0.5.10
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.5.9'
+gem 'glimmer', '~> 0.5.10'
 ```
 
 And, then run:
@@ -598,17 +598,37 @@ You may check out all available `SWT` styles here:
 
 https://help.eclipse.org/2019-12/nftopic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
 
-#### Advanced case outside of standard Glimmer DSL
+#### Explicit SWT Style Bit
 
 When building a widget-related SWT object manually (e.g. `GridData.new(...)`), you are expected to use `SWT::CONSTANT` directly or BIT-OR a few SWT constants together like `SWT::BORDER | SWT::V_SCROLL`.
 
-Glimmer facilitates that with `SWTProxy` class by allowing you to pass multiple styles as an argument array of symbols instead of dealing with BIT-OR. For example: `SWTProxy[:border, :v_scroll]`
+Glimmer facilitates that with `swt` keyword by allowing you to pass multiple styles as an argument array of symbols instead of dealing with BIT-OR. 
+Example: 
 
-#### Non-resizable Window
+```ruby
+style = swt(:border, :v_scroll)
+```
+
+#### Negative SWT Style Bits
 
-SWT Shell widget by default is resizable. To make it non-resizable, one must pass a complicated style bit concoction like `SWTProxy[:shell_trim] & (~SWTProxy[:resize]) & (~SWTProxy[:max])`.
+In rare occasions, you might need to apply & with a negative (not) style bit to negate it from another style bit that includes it. 
+Glimmer facilitates that by declaring the negative style bit via postfixing a symbol with `!`.
+
+Example:
+
+```ruby
+style = swt(:shell_trim, :max!) # creates a shell trim style without the maximize button (negated)
+```
+
+#### Extra SWT Styles 
+
+##### Non-resizable Window
+
+SWT Shell widget by default is resizable. To make it non-resizable, one must pass a complicated style bit concoction like `swt(:shell_trim, :resize!, :max!)`.
+
+Glimmer makes this easier by alternatively offering a `:no_resize` extra SWT style, added for convenience. 
+This makes declaring a non-resizable window as easy as:
 
-Glimmer makes this easier by alternatively offering `:no_resize` extra SWT style, added for convenience. This makes declaring an non-resizable window as easy as:
 ```ruby
 shell(:no_resize) {
   # ...
@@ -889,7 +909,7 @@ composite {
   grid_layout 3, false # grid layout with 3 columns not of equal width
   label {
     # layout data set explicitly via an object (helps in rare cases that break convention)
-    layout_data GridData.new(SWTProxy[:fill], SWTProxy[:end], true, false)
+    layout_data GridData.new(swt(:fill), swt(:end), true, false)
   }
 }
 # ...
@@ -1312,6 +1332,8 @@ shell {
 
 Notice how `Red::Composite` became `red__composite` with double-underscore, which is how Glimmer Custom Widgets signify namespaces by convention. Additionally, `before_body` hook was utilized to set a `@color` variable and use inside the `body`.
 
+Keep in mind that namespaces are not needed to be specified if the Custom Widget class has a unique name, not clashing with a basic SWT widget or another custom widget name.
+
 Custom Widgets have the following attributes (attribute readers) available to call from inside the `#body` method:
 - `#parent`: Glimmer object parenting custom widget
 - `#swt_style`: SWT style integer. Can be useful if you want to allow consumers to customize a widget inside the custom widget body
@@ -1711,15 +1733,31 @@ glimmer samples/gladiator.rb # demonstrates a text editor with tree/list data-bi
 
 ![Gladiator](images/glimmer-gladiator.png)
 
-Gladiator (short for Glimmer Editor) is an on-going sample project with continuous development.
-It is also used as the main text editor for coding Glimmer.
-As such, it has been made available in [Glimmer's gem](https://rubygems.org/gems/glimmer) via the `gladiator` command should others find useful too.
+Gladiator (short for Glimmer Editor) is an on-going sample project under continuous development. It is used as the main text editor for developing Glimmer.
+
+It currently supports the following text editing features:
+- File explorer navigation to open file
+- File lookup by name
+- Find & Replace
+- Show Line Numbers
+- Jump to Line
+- Remember last opened file, caret position, and top line
+- Autosave on focus out/quit/open new file
+- Watch open file for external changes to reflect in editor
+- Duplicate Line(s)
+- Kill Line(s)
+- Move up one line
+- Move down one line
+
+Gladiator has been made available in [Glimmer's gem](https://rubygems.org/gems/glimmer) via the `gladiator` command should others find useful too.
+
 If you cloned this project and followed [CONTRIBUTING.md](CONTRIBUTING.md) instructions, you may invoke via `bin/gladiator` instead. 
 
 ## In Production
 
 The following production apps have been built with Glimmer:
-- [Math Bowling](https://github.com/AndyObtiva/MathBowling): an educational math game for elementary level kids
+
+[<img alt="Math Bowling Logo" src="https://raw.githubusercontent.com/AndyObtiva/MathBowling/master/images/math-bowling-logo.png" width="40" />Math Bowling](https://github.com/AndyObtiva/MathBowling): an educational math game for elementary level kids
 
 ## SWT Reference
 

data/lib/glimmer.rb

@@ -9,6 +9,7 @@ require 'java'
 require 'set'
 require 'nested_inherited_jruby_include_package'
 require 'fileutils'
+require 'os'
 
 # Glimmer provides a JRuby Desktop UI DSL + Data-Binding functionality
 #

data/lib/glimmer/launcher.rb

@@ -69,8 +69,8 @@ module Glimmer
         if the_glimmer_lib == GLIMMER_LIB_LOCAL
           devmode_require = '-r puts_debuggerer '
         end
-        puts "#{env_vars_string} jruby #{jruby_options_string}#{jruby_os_specific_options} -r #{the_glimmer_lib} #{devmode_require}-S \"#{application}\"" if jruby_options_string.to_s.include?('--debug')
-        system "#{env_vars_string} jruby #{jruby_options_string}#{jruby_os_specific_options} -r #{the_glimmer_lib} #{devmode_require}-S \"#{application}\""
+        puts "#{env_vars_string} jruby #{jruby_options_string}#{jruby_os_specific_options} #{devmode_require}-r #{the_glimmer_lib} -S #{application}" if jruby_options_string.to_s.include?('--debug')
+        system "#{env_vars_string} jruby #{jruby_options_string}#{jruby_os_specific_options} #{devmode_require}-r #{the_glimmer_lib} -S #{application}"
       end
     end
 

data/lib/glimmer/swt/shell_proxy.rb

@@ -130,9 +130,11 @@ module Glimmer
         if observation_request.start_with?('on_')
           event_name = observation_request.sub(/^on_/, '')
           if OBSERVED_MENU_ITEMS.include?(event_name)
-            system_menu = DisplayProxy.instance.swt_display.getSystemMenu
-            menu_item = system_menu.getItems.find {|menu_item| menu_item.getID == SWTProxy["ID_#{event_name.upcase}"]}
-            menu_item.addListener(SWTProxy[:Selection], &block)
+            if OS.mac?
+              system_menu = DisplayProxy.instance.swt_display.getSystemMenu
+              menu_item = system_menu.getItems.find {|menu_item| menu_item.getID == SWTProxy["ID_#{event_name.upcase}"]}
+              menu_item.addListener(SWTProxy[:Selection], &block)
+            end
           else
             super
           end

data/lib/glimmer/swt/swt_proxy.rb

@@ -10,19 +10,24 @@ module Glimmer
         java_import 'org.eclipse.swt.SWT'
 
         ERROR_INVALID_STYLE = " is an invalid SWT style! Please choose a style from org.eclipse.swt.SWT class constants."
+        REGEX_SYMBOL_NEGATIVITY = /^([^!]+)(!)?$/
 
         # Gets SWT constants as if calling SWT::CONSTANT where constant is
         # passed in as a lower case symbol
         def [](*symbols)
           symbols = symbols.first if symbols.size == 1 && symbols.first.is_a?(Array)
-          symbols.compact.reduce(0) do |output, symbol|
-            constant_value = constant(symbol)
-            if constant_value.is_a?(Integer)
-              output | constant(symbol)
+          result = symbols.compact.map do |symbol|
+            constant(symbol).tap do |constant_value|
+              raise Error, symbol.to_s + ERROR_INVALID_STYLE unless constant_value.is_a?(Integer)
+            end
+          end.reduce do |output, constant_value|
+            if constant_value < 0
+              output & constant_value
             else
-              raise Error, symbol.to_s + ERROR_INVALID_STYLE
+              output | constant_value
             end
           end
+          result.nil? ? SWT::NONE : result
         end
 
         # Returns SWT style integer value for passed in symbol or allows
@@ -32,18 +37,43 @@ module Glimmer
         # (look into [] operator if you want an error raised on invalid values)
         def constant(symbol)
           return symbol unless symbol.is_a?(Symbol) || symbol.is_a?(String)
-          symbol_string = symbol.to_s
+          symbol_string, negative = extract_symbol_string_negativity(symbol)
           swt_constant_symbol = symbol_string.downcase == symbol_string ? symbol_string.upcase.to_sym : symbol_string.to_sym
-          SWT.const_get(swt_constant_symbol)
-        rescue
+          bit_value = SWT.const_get(swt_constant_symbol)
+          negative ? ~bit_value : bit_value
+        rescue => e
           begin
+#             Glimmer.logger&.debug(e.full_message)
             alternative_swt_constant_symbol = SWT.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s.upcase}
-            SWT.const_get(alternative_swt_constant_symbol)
-          rescue
-            EXTRA_STYLES[swt_constant_symbol] || symbol
+            bit_value = SWT.const_get(alternative_swt_constant_symbol)
+            negative ? ~bit_value : bit_value
+          rescue => e
+#             Glimmer.logger&.debug(e.full_message)
+            bit_value = Glimmer::SWT::SWTProxy::EXTRA_STYLES[swt_constant_symbol]
+            if bit_value
+              negative ? ~bit_value : bit_value
+            else
+              symbol
+            end
           end
         end
 
+        def extract_symbol_string_negativity(symbol)
+          if symbol.is_a?(Symbol) || symbol.is_a?(String)
+            symbol_negativity_match = symbol.to_s.match(REGEX_SYMBOL_NEGATIVITY)
+            symbol = symbol_negativity_match[1]
+            negative = !!symbol_negativity_match[2]
+            [symbol, negative]
+          else
+            negative = symbol < 0
+            [symbol, negative]
+          end
+         end
+
+        def negative?(symbol)
+          extract_symbol_string_negativity(symbol)[1]
+        end
+
         def has_constant?(symbol)
           return false unless symbol.is_a?(Symbol) || symbol.is_a?(String)
           constant(symbol).is_a?(Integer)
@@ -69,7 +99,7 @@ module Glimmer
       end
 
       EXTRA_STYLES = {
-        NO_RESIZE: SWTProxy[:shell_trim] & (~SWTProxy[:resize]) & (~SWTProxy[:max])
+        NO_RESIZE: self[:shell_trim, :resize!, :max!]
       }
     end
   end

data/lib/glimmer/ui/video.rb

@@ -1,7 +1,7 @@
 require 'glimmer/ui/custom_widget'
 require 'glimmer/swt/color_proxy'
 
-#TODO display progress wheel while loading video
+#TODO consider the need to display a progress wheel while loading video as an option
 
 module Glimmer
   module UI
@@ -26,7 +26,7 @@ module Glimmer
       alias fit_to_height? fit_to_height
 
       body {
-        browser {
+        browser(:no_scroll) {
           text <<~HTML
             <html>
               <head>
@@ -34,6 +34,7 @@ module Glimmer
                   body {
                     margin: 0;
                     padding: 0;
+                    overflow: hidden;
                   }
                 </style>
                 <style id="style-body-background">

data/samples/gladiator.rb

@@ -3,6 +3,7 @@ require 'filewatcher'
 require 'clipboard'
 
 Clipboard.implementation = Clipboard::Java
+Clipboard.copy(Clipboard.paste) # pre-initialize library to avoid slowdown during use
 
 # Gladiator (Glimmer Editor)
 class Gladiator
@@ -370,11 +371,11 @@ class Gladiator
     end
 
     def line_for_caret_position(caret_position)
-      lines[line_index_for_caret_position(caret_position)]
+      lines[line_index_for_caret_position(caret_position.to_i)]
     end
 
     def line_index_for_caret_position(caret_position)
-      dirty_content[0...caret_position].count("\n")
+      dirty_content[0...caret_position.to_i].count("\n")
     end
 
     def caret_position_for_line_index(line_index)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement