glimmer 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701abba7777511f578fbf87500a857650e1b5a50fff35ef92ea34be36548d3c4
-  data.tar.gz: 2d6d523bfef6b75de1b820321d64c0f3c3208afe0ad21c274e66f9a74d59bd93
+  metadata.gz: 01b2e0936795d4ac088a3ea7c7045c22fbe064fd7d88283af396c3239f77bb59
+  data.tar.gz: c202f93d54b4b20a96cbd5c6f493ebc3d7919d92b7b02db69e6ac8feacd9c6e7
 SHA512:
-  metadata.gz: f1d4cda6b63ee73a5ff2b068979fd79b4f2fb3a30581b7b13bb9686383a485fbe2f1e5afb6c1d486f37e8302badbfae1c14390d1f8a2f4f62031bce21e3fafb7
-  data.tar.gz: 8f1fa157a4326a6b0499584473678d45f7141b992274a64705cccd0b64ec326337c67c6165f252eb4a98872692b56ec76004e4e5372910cdb37bf08cffe23a1b
+  metadata.gz: 40669eb87ebceef14f5c397ea2d4c51d55fa7daacfab7ef3a9fc110ea0dc739e2cb7b169824bf4d0cb01c32665c794a440763d9b68be56a891bca2a93c950a02
+  data.tar.gz: ca479f2226c69678976cc51f71c8496fd24b96a4538b913bc5f976c2b0653c5538d5bc85f372b06adc593615e045d2718581585fc42cef457df480f7cb7255f0

data/README.markdown

@@ -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.4.2
+jgem install glimmer -v 0.4.3
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.4.2'
+gem 'glimmer', '~> 0.4.3'
 ```
 
 And, then run:
@@ -206,6 +206,17 @@ When building a widget-related SWT object manually (e.g. `GridData.new(...)`), y
 
 Glimmer facilitates that with `GSWT` class by allowing you to pass multiple styles as an argument array of symbols instead of dealing with BIT-OR. For example: `GSWT[:border, :v_scroll]`
 
+**Non-resizable Window**
+
+SWT Shell widget by default is resizable. To make it non-resizable, one must pass a complicated style bit concoction like `GSWT[:shell_trim] & (~GSWT[:resize]) & (~GSWT[:max])`.
+
+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) {
+  # ...
+}
+```
+
 ### 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:
@@ -415,16 +426,20 @@ label {
 }
 ```
 
-SWT also supports all standard colors available as constants under the `SWT` namespace (e.g. `SWT::COLOR_BLUE`)
+SWT also supports standard colors available as constants under the `SWT` namespace with the `COLOR_` prefix (e.g. `SWT::COLOR_BLUE`, `SWT::COLOR_WHITE`, `SWT::COLOR_RED`)
 
-Glimmer accepts these constants as Ruby symbols prefixed by `color_`.
+Glimmer accepts these constants as lowercase Ruby symbols with or without `color_` prefix.
 
 Example:
 
 ```ruby
+label {
+  background :black
+  foreground :yellow
+}
 label {
   background :color_white
-  foreground :color_black
+  foreground :color_red
 }
 ```
 
@@ -465,21 +480,24 @@ Data-binding examples:
 - `text bind(contact, :first_name)`
 - `text bind(contact, 'address.street')`
 - `text bind(contact, 'addresses[1].street')`
+- `text bind(contact, :age, computed_by: :date_of_birth)`
 - `text bind(contact, :name, computed_by: [:first_name, :last_name])`
 - `text bind(contact, 'profiles[0].name', computed_by: ['profiles[0].first_name', 'profiles[0].last_name'])`
 
-The first example binds the text property of a widget like `label` to the first name of a contact model.
+The 1st example binds the text property of a widget like `label` to the first name of a contact model.
 
-The second example binds the text property of a widget like `label` to the nested street of
+The 2nd example binds the text property of a widget like `label` to the nested street of
 the address of a contact. This is called nested property data binding.
 
-The third example binds the text property of a widget like `label` to the nested indexed address street of a contact. This is called nested indexed property data binding.
+The 3rd example binds the text property of a widget like `label` to the nested indexed address street of a contact. This is called nested indexed property data binding.
 
-The fourth example demonstrates computed value data binding whereby the value of `name` depends on changes to both `first_name` and `last_name`.
+The 4th example demonstrates computed value data binding whereby the value of `age` depends on changes to `date_of_birth`.
 
-The fifth example demonstrates nested indexed computed value data binding whereby the value of `profiles[0].name` depends on changes to both nested `profiles[0].first_name` and `profiles[0].last_name`.
+The 5th example demonstrates computed value data binding whereby the value of `name` depends on changes to both `first_name` and `last_name`.
 
-You may learn more about Glimmer's syntax by reading the Eclipse Zone Tutorial mentioned in resources and opening up the samples under the `samples` folder.
+The 6th example demonstrates nested indexed computed value data binding whereby the value of `profiles[0].name` depends on changes to both nested `profiles[0].first_name` and `profiles[0].last_name`.
+
+You may learn more about Glimmer's syntax by reading the Eclipse Zone Tutorial mentioned in resources and opening up the samples under the [samples](https://github.com/AndyObtiva/glimmer/tree/master/samples) directory.
 
 ### Observer
 
@@ -553,15 +571,21 @@ end
 
 ## Samples
 
-Check the "[samples](https://github.com/AndyObtiva/glimmer/tree/master/samples)" folder for examples on how to write Glimmer applications. To run a sample, make sure to install the `glimmer` gem first and then use the `glimmer` command to run it (alternatively, you may clone the repo, follow contributing instructions, and run `rake install` to install the gem before running `glimmer` command).
+Check the [samples](https://github.com/AndyObtiva/glimmer/tree/master/samples) directory for examples on how to write Glimmer applications. To run a sample, make sure to install the `glimmer` gem first and then use the `glimmer` command to run it (alternatively, you may clone the repo, follow [CONTRIBUTING.md](https://github.com/AndyObtiva/glimmer/blob/master/CONTRIBUTING.md) instructions, and run samples locally with development glimmer command: `bin/glimmer --dev`).
 
-Example:
+Examples:
 
 ```
-glimmer samples/hello_world.rb
+glimmer samples/hello_tab.rb
+glimmer samples/hello_combo.rb
+glimmer samples/hello_list_single_selection.rb
+glimmer samples/hello_list_multi_selection.rb
+glimmer samples/contactmanager/contact_manager.rb
 ```
 
-Here is also a more elaborate project (educational game) built with Glimmer:
+The last example (`contact_manager.rb`) is a good sample about how to build tables with Glimmer including data-binding, filtering, and sorting. It even comes with specs in `spec/samples/contactmanager/contact_manager_presenter_spec.rb` to demonstrate how Glimmer facilitates TDD (test-driven development) with the Model View Presenter pattern (a variation on MVC) by separating testable presentation logic from the view layer with data-binding.
+
+For a more elaborate project built with Glimmer, check out this educational game:
 
 [Math Bowling](https://github.com/AndyObtiva/MathBowling)
 

data/lib/glimmer/command_handlers/models/g_font.rb

@@ -2,6 +2,8 @@ require_relative 'g_swt'
 
 module Glimmer
   class GFont
+    ERROR_INVALID_FONT_STYLE = " is an invalid font style! Valid values are :normal, :bold, and :italic"
+    FONT_STYLES = [:normal, :bold, :italic]
     include_package 'org.eclipse.swt.graphics'
 
     extend Glimmer
@@ -51,6 +53,7 @@ module Glimmer
     end
 
     def font(font_properties)
+      detect_invalid_font_property(font_properties)
       font_properties[:style] = GSWT[*font_properties[:style]]
       font_data_args = [:name, :height, :style].map do |font_property_name|
         font_properties[font_property_name] || send(font_property_name)
@@ -58,5 +61,13 @@ module Glimmer
       font_datum = FontData.new(*font_data_args)
       Font.new(@display, font_datum)
     end
+
+    def detect_invalid_font_property(font_properties)
+      [font_properties[:style]].flatten.select do |style|
+        style.is_a?(Symbol) || style.is_a?(String)
+      end.each do |style|
+        raise style.to_s + ERROR_INVALID_FONT_STYLE if !FONT_STYLES.include?(style.to_sym)
+      end
+    end
   end
 end

data/lib/glimmer/command_handlers/models/g_shell.rb

@@ -11,7 +11,7 @@ module Glimmer
 
     attr_reader :display
 
-    # Instantiates shell with same arguments expected by SWT Shell 
+    # Instantiates shell with same arguments expected by SWT Shell
     def initialize(*args)
       if !args.first.is_a?(Display) && !args.first.is_a?(Shell)
         @display = GDisplay.instance.display

data/lib/glimmer/command_handlers/models/g_swt.rb

@@ -1,14 +1,27 @@
 module Glimmer
   class GSWT
     class << self
+      ERROR_INVALID_STYLE = " is an invalid SWT style! Please choose a style from org.eclipse.swt.SWT class constants."
       java_import 'org.eclipse.swt.SWT'
 
       # 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) }
+        symbols.compact.reduce(0) do |output, symbol|
+          constant_value = constant(symbol)
+          if constant_value.is_a?(Integer)
+            output | constant(symbol)
+          else
+            raise symbol.to_s + ERROR_INVALID_STYLE
+          end
+        end
       end
 
+      # Returns SWT style integer value for passed in symbol or allows
+      # passed in object to pass through (e.g. Integer). This makes is convenient
+      # to use symbols or actual SWT style integers in Glimmer
+      # Does not raise error for invalid values. Just lets them pass as is.
+      # (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
@@ -16,7 +29,7 @@ module Glimmer
         SWT.const_get(swt_constant_symbol)
       rescue
         begin
-          alternative_swt_constant_symbol = SWT.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s}
+          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
@@ -31,9 +44,20 @@ module Glimmer
       def constantify_args(args)
         args.map {|arg| constant(arg)}
       end
+
+      # Deconstructs a style integer into symbols
+      # Useful for debugging
+      def deconstruct(integer)
+        SWT.constants.reduce([]) do |found, c|
+          constant_value = SWT.const_get(c) rescue -1
+          is_found = constant_value.is_a?(Integer) && (constant_value & style) == constant_value
+          is_found ? found += [c] : found
+        end
+      end
     end
+
     EXTRA_STYLES = {
-      NO_RESIZE: GSWT[:shell_trim] & (~GSWT[:resize])
+      NO_RESIZE: GSWT[:shell_trim] & (~GSWT[:resize]) & (~GSWT[:max])
     }
   end
 end

data/lib/glimmer/command_handlers/models/g_widget.rb

@@ -55,10 +55,20 @@ module Glimmer
     end
 
     def property_type_converters
+      color_converter = Proc.new do |value|
+        if (value.is_a?(Symbol) || value.is_a?(String))
+          color_string = value.to_s.downcase
+          color_string.start_with?('color_') ? value : "color_#{color_string}"
+        else
+          value
+        end
+      end
       @property_type_converters ||= {
         :text => Proc.new { |value| value.to_s },
         :items => Proc.new { |value| value.to_java :string},
         :visible => Proc.new { |value| !!value},
+        :background => color_converter,
+        :foreground => color_converter,
         :font => Proc.new do |value|
           if value.is_a?(Hash)
             font_properties = value

data/lib/glimmer/command_handlers/models/model_binding.rb

@@ -74,10 +74,10 @@ module Glimmer
       @property_name_expression
     end
     def computed?
-      !!computed_by
+      !computed_by.empty?
     end
     def computed_by
-      @binding_options[:computed_by]
+      [@binding_options[:computed_by]].flatten.compact
     end
     def computed_binding_options
       @binding_options.reject {|k,v| k == :computed_by}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement