glimmer 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a13439b3524a4100c7ca2a6eb8b191a9706e3f4591423fa28a30fbda690e21d
-  data.tar.gz: 13c287b39adc40c4eaefde63ab196a5771b442032a8c3ccd697cb84384ecbe77
+  metadata.gz: 425d16ab524a7ca569aad23a16f90be2d191e30f9718ccc29829eadc4d479b73
+  data.tar.gz: 5b23ea4769c1921379f6a3314a9e5496e1b339dd3ea43b12bfef58678cf17be2
 SHA512:
-  metadata.gz: 561b9b04686935229929e33dfd3af7461fadd52e2d4902be8556e42c27df3bbbb1a37323bfa74d4978d34906f7154480ccae73aad6f6c01da33f49280d6f0807
-  data.tar.gz: '08e8364b81fdd8189ed9469d6d06b0b41e2f2629329355824e96be6b7ed4ea276d31783297ca1f537c6059ce0db78d971407eb34df06351290dce5c633f5917b'
+  metadata.gz: 5415bc5431a2ea2b4368c58bb97212cf6aea9f2711df08bd7757a5ee9c6eb84931616c082b023039d59dcea8140408e870973bf0043d07607667fa9e12381de6
+  data.tar.gz: 71678e659abb1776861c6f054520be42631b72e8013f0d5c3bbf399dedf09b9a2e0681155dda4ef327a73d7298a7c4628dd98076cb286ee0a8b2054dcf055c9d

data/README.markdown

@@ -42,7 +42,7 @@ shell {
     (1..3).each { |row|
       (1..3).each { |column|
         button {
-          layout_data GridData.new(:fill.swt_constant, :fill.swt_constant, true, true)
+          layout_data GridData.new(RSwt[:fill], RSwt[:fill], true, true)
           text        bind(@tic_tac_toe_board.box(row, column), :sign)
           enabled     bind(@tic_tac_toe_board.box(row, column), :empty)
           on_widget_selected {
@@ -102,14 +102,14 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-jgem install glimmer -v 0.3.4
+jgem install glimmer -v 0.3.5
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.3.4'
+gem 'glimmer', '~> 0.3.5'
 ```
 
 And, then run:
@@ -200,6 +200,12 @@ You may check out all available `SWT` styles here:
 
 https://help.eclipse.org/2019-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
 
+**Final Note** (advanced case outside of standard Glimmer DSL):
+
+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 `RSwt` class by allowing you to pass multiple styles as an argument array of symbols instead of dealing with BIT-OR. For example: `RSwt[:border, :v_scroll]`
+
 ### Widget Properties
 
 Widget properties such as value, enablement, and layout details are set within the widget block using methods matching SWT widget property names in lower snakecase. You may refer to SWT widget guide for details on available widget properties:
@@ -225,9 +231,9 @@ button {
 
 In the above example, the `text` widget `enabled` property was data-bound to `#empty` method on `@tic_tac_toe_board.box(row, column)` (learn more about data-binding below)
 
-### Color
+### Colors
 
-Color makes up a subset of widget properties. SWT accepts color objects created with RGB (Red Green Blue) or RGBA (Red Green Blue Alpha). Glimmer supports constructing color objects using the `rgb` and `rgba` DSL methods.
+Colors make up a subset of widget properties. SWT accepts color objects created with RGB (Red Green Blue) or RGBA (Red Green Blue Alpha). Glimmer supports constructing color objects using the `rgb` and `rgba` DSL methods.
 
 Example:
 
@@ -255,6 +261,31 @@ You may check out all available standard colors in `SWT` over here:
 
 https://help.eclipse.org/2019-12/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/SWT.html
 
+### Fonts
+
+Fonts are represented in Glimmer as a hash of name, height, and style keys.
+
+The style can be one (or more) of 3 values: `:normal`, `:bold`, and `:italic`
+
+Example:
+
+```ruby
+label {
+  font name: 'Arial', height: 36, style: :normal
+}
+```
+
+Keys are optional, so some of them may be left off.
+When passing multiple styles, they are included in an array.
+
+Example:
+
+```ruby
+label {
+  font style: [:bold, :italic]
+}
+```
+
 ### Data-Binding
 
 Data-binding is done with `bind` command following widget property to bind and taking model and bindable attribute as arguments.
@@ -428,6 +459,8 @@ a new component and extend the DSL with it
 - Provide a display builder method to use independently of shell
 - Supported a single computed data binding as a string (not array)
 - Disallow use of SWT::CONSTANTs with ORing since it's not intuitive at all
+- Support data binding translator option via a block
+- Center windows upon launching
 
 ## Contributors
 

data/lib/command_handlers/models/model_binding.rb

@@ -121,7 +121,7 @@ class ModelBinding
       @computed_model_bindings.each do |computed_model_binding|
         computed_observer_for(observer).unobserve(computed_model_binding)
       end
-      @computed_observer_collection[observer] = nil
+      @computed_observer_collection.delete(observer)
     elsif nested_property?
       nested_property_observers_for(observer).clear
     else

data/lib/command_handlers/models/r_color.rb

@@ -1,3 +1,5 @@
+require_relative 'r_swt'
+
 class RColor
   attr_reader :display, :red, :green, :blue, :alpha
 
@@ -7,8 +9,7 @@ class RColor
     include_package 'org.eclipse.swt'
 
     def for(display, standard_color)
-      standard_color_swt_constant = SWT.const_get(standard_color.to_s.upcase.to_sym)
-      display.getSystemColor(standard_color_swt_constant)
+      display.getSystemColor(RSwt[standard_color])
     end
   end
 

data/lib/command_handlers/models/r_font.rb

@@ -0,0 +1,60 @@
+require_relative 'r_swt'
+
+class RFont
+  include_package 'org.eclipse.swt.graphics'
+
+  extend Glimmer
+
+  attr_reader :r_widget
+  attr_accessor :display
+
+  class << self
+    def for(r_widget)
+      @instances ||= {}
+      unless @instances[r_widget]
+        @instances[r_widget] = new(r_widget)
+        add_contents(r_widget) {
+          on_widget_disposed { |dispose_event|
+            @instances.delete(r_widget)
+          }
+        }
+      end
+      @instances[r_widget]
+    end
+  end
+
+  def initialize(r_widget, display = nil)
+    @r_widget = r_widget
+    @display = display || @r_widget.widget.display
+  end
+
+  def r_widget=(a_widget)
+    @r_widget = a_widget
+    @font_datum = nil
+  end
+
+  def font_datum
+    @font_datum ||= @r_widget.widget.getFont.getFontData[0]
+  end
+
+  def name
+    font_datum.getName
+  end
+
+  def height
+    font_datum.getHeight
+  end
+
+  def style
+    font_datum.getStyle
+  end
+
+  def font(font_properties)
+    font_properties[:style] = RSwt[*font_properties[:style]]
+    font_data_args = [:name, :height, :style].map do |font_property_name|
+      font_properties[font_property_name] || send(font_property_name)
+    end
+    font_datum = FontData.new(*font_data_args)
+    Font.new(@display, font_datum)
+  end
+end

data/lib/command_handlers/models/r_shell.rb

@@ -1,17 +1,17 @@
-require File.dirname(__FILE__) + "/r_widget"
+require_relative 'r_widget'
 
 class RShell < RWidget
   include_package 'org.eclipse.swt.layout'
   include_package 'org.eclipse.swt.widgets'
-  
+
   attr_reader :display
-  
+
   def initialize(display = Display.new)
     @display = display
     @widget = Shell.new(@display)
     @widget.setLayout(FillLayout.new)
   end
-  
+
   def open
     @widget.pack
     @widget.open
@@ -20,5 +20,5 @@ class RShell < RWidget
     end
     @display.dispose
   end
-  
-end
+
+end

data/lib/command_handlers/models/r_swt.rb

@@ -0,0 +1,18 @@
+class RSwt
+  class << self
+    # Gets SWT constants as if calling SWT::CONSTANT where constant is
+    # passed in as a lower case symbol
+    def [](*symbols)
+      symbols.compact.reduce(0) { |output, symbol| output | constant(symbol) }
+    end
+
+    def constant(symbol)
+      return symbol if symbol.is_a?(Integer)
+      swt_constant_symbol = symbol.to_s.upcase.to_sym
+      org.eclipse.swt.SWT.const_get(swt_constant_symbol)
+    rescue
+      swt_constant_symbol = org.eclipse.swt.SWT.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s}
+      org.eclipse.swt.SWT.const_get(swt_constant_symbol)
+    end
+  end
+end

data/lib/command_handlers/models/r_widget.rb

@@ -1,22 +1,25 @@
 require_relative "r_widget_listener"
 require_relative "r_runnable"
 require_relative "r_color"
+require_relative "r_font"
+require_relative "r_swt"
 
 class RWidget
   include_package 'org.eclipse.swt'
   include_package 'org.eclipse.swt.widgets'
   include_package 'org.eclipse.swt.layout'
+  include_package 'org.eclipse.swt.graphics'
   include Parent
 
   attr_reader :widget
 
   #TODO externalize
   @@default_styles = {
-    "text" => SWT::BORDER,
-    "table" => SWT::BORDER,
-    "spinner" => SWT::BORDER,
-    "list" => SWT::BORDER | SWT::V_SCROLL,
-    "button" => SWT::PUSH,
+    "text" => RSwt[:border],
+    "table" => RSwt[:border],
+    "spinner" => RSwt[:border],
+    "list" => RSwt[:border, :v_scroll],
+    "button" => RSwt[:push],
   }
 
   #TODO externalize
@@ -30,12 +33,6 @@ class RWidget
     "group" => Proc.new {|group| group.setLayout(GridLayout.new) },
   }
 
-  @@property_type_converters = {
-    :text => Proc.new { |value| value.to_s },
-    :items => Proc.new { |value| value.to_java :string},
-    :visible => Proc.new { |value| !!value},
-  }
-
   #styles is a comma separate list of symbols representing SWT styles in lower case
   def initialize(underscored_widget_name, parent, styles, &contents)
     @widget = underscored_widget_name.swt_widget.new(parent, style(underscored_widget_name, styles))
@@ -47,14 +44,30 @@ class RWidget
   end
 
   def set_attribute(attribute_name, *args)
-    apply_property_type_converters(attribute_name, args)    
+    apply_property_type_converters(attribute_name, args)
     @widget.send(attribute_setter(attribute_name), *args)
   end
 
+  def property_type_converters
+    @property_type_converters ||= {
+      :text => Proc.new { |value| value.to_s },
+      :items => Proc.new { |value| value.to_java :string},
+      :visible => Proc.new { |value| !!value},
+      :font => Proc.new do |value|
+        if value.is_a?(Hash)
+          font_properties = value
+          RFont.for(self).font(font_properties)
+        else
+          value
+        end
+      end,
+    }
+  end
+
   def apply_property_type_converters(attribute_name, args)
     if args.count == 1
       value = args.first
-      converter = @@property_type_converters[attribute_name.to_sym]
+      converter = property_type_converters[attribute_name.to_sym]
       args[0] = converter.call(value) if converter
     end
     if args.count == 1 && args.first.is_a?(Symbol) && args.first.to_s.start_with?('color_')
@@ -148,29 +161,21 @@ class RWidget
   end
 
   def has_style?(style)
-    (widget.style & style.swt_constant) == style.swt_constant
+    (widget.style & RSwt[style]) == RSwt[style]
   end
 
   private
 
   def style(underscored_widget_name, styles)
-    styles.empty? ? default_style(underscored_widget_name) : swt_style(styles)
+    styles.empty? ? default_style(underscored_widget_name) : RSwt[*styles]
   end
 
   def default_style(underscored_widget_name)
     style = @@default_styles[underscored_widget_name] if @@default_styles[underscored_widget_name]
-    style = SWT::NONE unless style
+    style = RSwt[:none] unless style
     style
   end
 
-  def swt_style(styles)
-    swt_styles(styles).inject(0) { |combined_style, style| combined_style | style }
-  end
-
-  def swt_styles(styles)
-    styles.map(&:swt_constant)
-  end
-
   def attribute_setter(attribute_name)
     "set#{attribute_name.to_s.camelcase(:upper)}"
   end

data/lib/command_handlers/models/table_items_binding.rb

@@ -33,7 +33,7 @@ class TableItemsBinding
   def populate_table(model_collection, parent, column_properties)
     parent.widget.removeAll
     model_collection.each do |model|
-      table_item = TableItem.new(parent.widget, SWT::NONE)
+      table_item = TableItem.new(parent.widget, RSwt[:none])
       for index in 0..(column_properties.size-1)
         table_item.setText(index, model.send(column_properties[index]).to_s)
       end

data/lib/command_handlers/models/tree_items_binding.rb

@@ -36,7 +36,7 @@ class TreeItemsBinding
     populate_tree_node(model_tree_root_node, parent.widget, tree_properties)
   end
   def populate_tree_node(model_tree_node, parent, tree_properties)
-    table_item = TreeItem.new(parent, SWT::NONE)
+    table_item = TreeItem.new(parent, RSwt[:none])
     table_item.setText((model_tree_node && model_tree_node.send(tree_properties[:text])).to_s)
       [model_tree_node && model_tree_node.send(tree_properties[:children])].flatten.to_a.compact.each do |child|
       observe(child, @tree_properties[:text])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -168,8 +168,10 @@ files:
 - lib/command_handlers/models/observable_model.rb
 - lib/command_handlers/models/observer.rb
 - lib/command_handlers/models/r_color.rb
+- lib/command_handlers/models/r_font.rb
 - lib/command_handlers/models/r_runnable.rb
 - lib/command_handlers/models/r_shell.rb
+- lib/command_handlers/models/r_swt.rb
 - lib/command_handlers/models/r_tab_item_composite.rb
 - lib/command_handlers/models/r_widget.rb
 - lib/command_handlers/models/r_widget_listener.rb