glimmer 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb4ee177a1d05942e3d76fd1af52f2d182a8141ffe70c2d15edb868d1c117f4c
-  data.tar.gz: 26302fbf093855d4c789431752d79b7bfd07e9a763538215cf8aebacbf3bb51f
+  metadata.gz: 701abba7777511f578fbf87500a857650e1b5a50fff35ef92ea34be36548d3c4
+  data.tar.gz: 2d6d523bfef6b75de1b820321d64c0f3c3208afe0ad21c274e66f9a74d59bd93
 SHA512:
-  metadata.gz: c182686702c73057df5d04454804950002a63e58f9be27aeab6142bec34ae6aad35306390ed9d4978a9d235ee1cbb7b7b465126f4986163139d2e8781127bb6e
-  data.tar.gz: 4a6137b7b492595072795dcd641d7d1c9d1e9ef5da42e66397604249ab021d24645dc73faa321d645d2d51507899235134ab3eaa2b39d342b3514f6111d30e52
+  metadata.gz: f1d4cda6b63ee73a5ff2b068979fd79b4f2fb3a30581b7b13bb9686383a485fbe2f1e5afb6c1d486f37e8302badbfae1c14390d1f8a2f4f62031bce21e3fafb7
+  data.tar.gz: 8f1fa157a4326a6b0499584473678d45f7141b992274a64705cccd0b64ec326337c67c6165f252eb4a98872692b56ec76004e4e5372910cdb37bf08cffe23a1b

data/README.markdown

@@ -38,13 +38,13 @@ Glimmer code (from `samples/tictactoe/tic_tac_toe.rb`):
 shell {
   text "Tic-Tac-Toe"
   composite {
-    layout GridLayout.new(3,true)
+    grid_layout 3, true
     (1..3).each { |row|
       (1..3).each { |column|
         button {
-          layout_data GridData.new(GSWT[:fill], GSWT[:fill], true, true)
-          text        bind(@tic_tac_toe_board.box(row, column), :sign)
-          enabled     bind(@tic_tac_toe_board.box(row, column), :empty)
+          layout_data :fill, :fill, true, true
+          text        bind(@tic_tac_toe_board[row, column], :sign)
+          enabled     bind(@tic_tac_toe_board[row, column], :empty)
           on_widget_selected {
             @tic_tac_toe_board.mark_box(row, column)
           }
@@ -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.1
+jgem install glimmer -v 0.4.2
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.4.1'
+gem 'glimmer', '~> 0.4.2'
 ```
 
 And, then run:
@@ -141,7 +141,7 @@ Glimmer UIs (user interfaces) are modeled with widgets (wrappers around the SWT
 
 In Glimmer DSL, widgets are declared with lowercase underscored naming (you may look at usage examples in the `samples` directory).
 
-The `shell` widget is always the outermost widget containing all others in a desktop windowed application.
+The `shell` widget is always the outermost widget containing all others in a desktop windowed application. It is centered upon initial display and has a minimum width of 130 (can be re-centered when needed with `@shell.center` method)
 
 Other widget examples:
 - `button`: wrapper for `org.eclipse.swt.widgets.Button`
@@ -200,7 +200,7 @@ 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
 
-**Final Note** (advanced case outside of standard Glimmer DSL):
+**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`.
 
@@ -236,11 +236,11 @@ In the above example, the `text` widget `enabled` property was data-bound to `#e
 Glimmer lays widgets out visually using SWT layouts, which can only be set on composite widget and subclasses.
 
 The most common SWT layouts are:
-- `FillLayout`: lays widgets out in equal proportion horizontally or vertically with spacing/margin options
+- `FillLayout`: lays widgets out in equal proportion horizontally or vertically with spacing/margin options. This is the ***default*** layout for ***shell*** (with `:horizontal` option) in Glimmer.
 - `RowLayout`: lays widgets out horizontally or vertically in varying proportions with advanced spacing/margin/justify options
-- `GridLayout`(**default**): lays widgets out in a grid with advanced spacing/margin/alignment/indentation options. This is the **default** layout in Glimmer. It is important to master.
+- `GridLayout`: lays widgets out in a grid with advanced spacing/margin/alignment/indentation options. This is the **default** layout for **composite** in Glimmer. It is important to master.
 
-In Glimmer DSL, just like widgets, layouts can be specified with lowercase underscored names followed by a block containing properties (e.g. `RowLayout` is `row_layout`).
+In Glimmer DSL, just like widgets, layouts can be specified with lowercase underscored names followed by a block containing properties, also lowercase underscored names (e.g. `RowLayout` is `row_layout`).
 
 Example:
 
@@ -261,15 +261,70 @@ composite {
 }
 ```
 
-Alternatively, a layout may be constructed by following the SWT API for the layout object. For example, a `RowLayout` can be constructed by passing it an SWT style constant.
+Alternatively, a layout may be constructed by following the SWT API for the layout object. For example, a `RowLayout` can be constructed by passing it an SWT style constant (Glimmer automatically accepts symbols (e.g. `:horizontal`) for SWT style arguments like `SWT::HORIZONTAL`.)
 
 ```ruby
 composite {
-  row_layout(:horizontal)
+  row_layout :horizontal
   # ... widgets follow
 }
 ```
 
+Here is a more sophisticated example taken from [hello_computed.rb](https://github.com/AndyObtiva/glimmer/blob/master/samples/hellocomputed/hello_computed.rb) sample:
+```ruby
+shell {
+  text "Hello Computed"
+  composite {
+    grid_layout {
+      num_columns 2
+      make_columns_equal_width true
+      horizontal_spacing 20
+      vertical_spacing 10
+    }
+    label {text "First &Name: "}
+    text {
+      text bind(@contact, :first_name)
+      layout_data {
+        horizontalAlignment :fill
+        grabExcessHorizontalSpace true
+      }
+    }
+    label {text "&Last Name: "}
+    text {
+      text bind(@contact, :last_name)
+      layout_data {
+        horizontalAlignment :fill
+        grabExcessHorizontalSpace true
+      }
+    }
+    label {text "&Year of Birth: "}
+    text {
+      text bind(@contact, :year_of_birth)
+      layout_data {
+        horizontalAlignment :fill
+        grabExcessHorizontalSpace true
+      }
+    }
+    label {text "Name: "}
+    label {
+      text bind(@contact, :name, computed_by: [:first_name, :last_name])
+      layout_data {
+        horizontalAlignment :fill
+        grabExcessHorizontalSpace true
+      }
+    }
+    label {text "Age: "}
+    label {
+      text bind(@contact, :age, :fixnum, computed_by: [:year_of_birth])
+      layout_data {
+        horizontalAlignment :fill
+        grabExcessHorizontalSpace true
+      }
+    }
+  }
+}.open
+```
+
 Check out the samples directory for more advanced examples of layouts in Glimmer.
 
 **Defaults**:
@@ -296,13 +351,17 @@ By convention, SWT layouts expect widgets to set layout data with a class matchi
 
 Not all layouts support layout data to further customize widget layouts. For example, `FillLayout` supports no layout data.
 
-Unlike widgets and layouts in Glimmer DSL, layout data is simply specified with `layout_data` keyword nested inside a widget block body, and followed by arguments and/or a block of its own properties. Glimmer automatically deduces layout data class name by convention as per rule above, with the assumption that the layout data class lives under the same exact Java package as the layout (one can set custom layout data that breaks convention if needed in rare cases. See code below for an example)
+Unlike widgets and layouts in Glimmer DSL, layout data is simply specified with `layout_data` keyword nested inside a widget block body, and followed by arguments and/or a block of its own properties (lowercase underscored names).
+
+Glimmer automatically deduces layout data class name by convention as per rule above, with the assumption that the layout data class lives under the same exact Java package as the layout (one can set custom layout data that breaks convention if needed in rare cases. See code below for an example)
+
+Glimmer also automatically accepts symbols (e.g. `:fill`) for SWT style arguments like `SWT::FILL`.
 
 Examples:
 
 ```ruby
 composite {
-  row_layout(:horizontal)
+  row_layout :horizontal
   label {
     layout_data { # followed by properties
       width 50
@@ -315,17 +374,17 @@ composite {
 
 ```ruby
 composite {
-  grid_layout(3, false) # grid layout with 3 columns not of equal width
+  grid_layout 3, false # grid layout with 3 columns not of equal width
   label {
-    # layout data followed by arguments passed to SWT constructor
-    layout_data(GSWT[:fill], GSWT[:end], true, false)
+    # layout data followed by arguments passed to SWT GridData constructor
+    layout_data :fill, :end, true, false
   }
 }
 ```
 
 ```ruby
 composite {
-  grid_layout(3, false) # grid layout with 3 columns not of equal width
+  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(GSWT[:fill], GSWT[:end], true, false)
@@ -437,7 +496,7 @@ class TicTacToe
 
   def initialize
     # ...
-    observe(@tic_tac_toe_board, "game_status")
+    observe(@tic_tac_toe_board, :game_status)
   end
 
   def call(game_status)
@@ -448,10 +507,10 @@ class TicTacToe
 end
 ```
 
-Alternatively, one can use a default Observer::Proc implementation via Observer#proc method:
+Alternatively, one can use a default Observer::Proc implementation via Observer.proc method:
 ```ruby
 observer = Observer.proc { |new_value| puts new_value }
-observer.observe(@tic_tac_toe_board, "game_status")
+observer.observe(@tic_tac_toe_board, :game_status)
 ```
 
 Observers can be a good mechanism for displaying dialog messages with Glimmer (using SWT's `MessageBox`).
@@ -465,7 +524,7 @@ class TicTacToe
 
   def initialize
     # ...
-    observe(@tic_tac_toe_board, "game_status")
+    observe(@tic_tac_toe_board, :game_status)
   end
 
   def call(game_status)
@@ -494,7 +553,7 @@ end
 
 ## Samples
 
-Check the "samples" folder for examples on how to write Glimmer applications. To run them, make sure to install the `glimmer` gem first and then use the `glimmer` command.
+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).
 
 Example:
 
@@ -502,6 +561,10 @@ Example:
 glimmer samples/hello_world.rb
 ```
 
+Here is also a more elaborate project (educational game) built with Glimmer:
+
+[Math Bowling](https://github.com/AndyObtiva/MathBowling)
+
 ## SWT Reference
 
 https://www.eclipse.org/swt/docs.php

data/bin/girb

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require_relative '../lib/glimmer_application'
-GlimmerApplication.launch('irb')
+GlimmerApplication.new(ARGV + ['irb']).start

data/bin/glimmer

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require_relative File.join('..', 'lib', 'glimmer_application')
-GlimmerApplication.new(ARGV.first).start
+GlimmerApplication.new(ARGV).start

data/lib/glimmer.rb

@@ -35,6 +35,7 @@ module Glimmer
     return return_value
   end
 
+  # TODO come up with a better public name for this and put on gwidgets directly
   def self.add_contents(parent, &block)
     @@parent_stack.push(parent) if parent.is_a?(Parent)
     @@parent_stack.last.process_block(block) if block and @@parent_stack.last

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

@@ -39,7 +39,7 @@ module Glimmer
     def initialize(underscored_layout_name, composite, args)
       @underscored_layout_name = underscored_layout_name
       @composite = composite
-      args = args.map {|arg| GSWT.constant(arg)}
+      args = GSWT.constantify_args(args)
       @layout = self.class.swt_layout_class_for(underscored_layout_name).new(*args)
       @composite.setLayout(@layout)
     end

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

@@ -12,7 +12,7 @@ module Glimmer
 
     def initialize(widget, args)
       @widget = widget
-      args = args.map {|arg| GSWT.constant(arg)}
+      args = GSWT.constantify_args(args)
       begin
         @layout_data = swt_layout_data_class.new(*args)
       rescue => e

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

@@ -3,19 +3,41 @@ require_relative 'g_display'
 
 module Glimmer
   class GShell < GWidget
+    WIDTH_MIN = 130
+    HEIGHT_MIN = 0
+
     include_package 'org.eclipse.swt.layout'
     include_package 'org.eclipse.swt.widgets'
 
     attr_reader :display
 
-    def initialize(display = GDisplay.instance.display)
-      @display = display
-      @widget = Shell.new(@display)
+    # 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
+        args = [@display] + args
+      end
+      args = GSWT.constantify_args(args)
+      @widget = Shell.new(*args)
+      @display ||= @widget.getDisplay
       @widget.setLayout(FillLayout.new)
+      @widget.setMinimumSize(WIDTH_MIN, HEIGHT_MIN)
+    end
+
+    # Centers shell within screen
+    def center
+      primary_monitor = @display.getPrimaryMonitor()
+      monitor_bounds = primary_monitor.getBounds()
+      shell_bounds = @widget.getBounds()
+      location_x = monitor_bounds.x + (monitor_bounds.width - shell_bounds.width) / 2
+      location_y = monitor_bounds.y + (monitor_bounds.height - shell_bounds.height) / 2
+      @widget.setLocation(location_x, location_y)
     end
 
+    # Opens shell and starts SWT's UI thread event loop
     def open
       @widget.pack
+      center
       @widget.open
       until @widget.isDisposed
         @display.sleep unless @display.readAndDispatch

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

@@ -11,19 +11,29 @@ module Glimmer
 
       def constant(symbol)
         return symbol unless symbol.is_a?(Symbol) || symbol.is_a?(String)
-        swt_constant_symbol = symbol.to_s.upcase.to_sym
+        symbol_string = symbol.to_s
+        swt_constant_symbol = symbol_string.downcase == symbol_string ? symbol_string.upcase.to_sym : symbol_string.to_sym
         SWT.const_get(swt_constant_symbol)
       rescue
-        swt_constant_symbol = SWT.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s}
-        SWT.const_get(swt_constant_symbol)
+        begin
+          alternative_swt_constant_symbol = SWT.constants.find {|c| c.to_s.upcase == swt_constant_symbol.to_s}
+          SWT.const_get(alternative_swt_constant_symbol)
+        rescue
+          EXTRA_STYLES[swt_constant_symbol] || symbol
+        end
       end
 
       def has_constant?(symbol)
         return false unless symbol.is_a?(Symbol) || symbol.is_a?(String)
-        !!constant(symbol)
-      rescue
-        false
+        constant(symbol).is_a?(Integer)
+      end
+
+      def constantify_args(args)
+        args.map {|arg| constant(arg)}
       end
     end
+    EXTRA_STYLES = {
+      NO_RESIZE: GSWT[:shell_trim] & (~GSWT[:resize])
+    }
   end
 end

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

@@ -41,6 +41,10 @@ module Glimmer
       @@default_initializers[underscored_widget_name].call(@widget) if @@default_initializers[underscored_widget_name]
     end
 
+    def has_style?(swt_style)
+      pd(pd(@widget.getStyle) & swt_style) == pd(swt_style)
+    end
+
     def has_attribute?(attribute_name, *args)
       @widget.respond_to?(attribute_setter(attribute_name), args)
     end

data/lib/glimmer_application.rb

@@ -11,6 +11,8 @@ the glimmer ruby gem and SWT jar dependency.
 Example: glimmer hello_world.rb
 This runs the Glimmer application hello_world.rb
   MULTILINE
+  GLIMMER_LIB_LOCAL = File.expand_path(File.join(__FILE__, '..', 'glimmer.rb'))
+  GLIMMER_LIB_GEM = 'glimmer'
 
   class << self
     def platform_os
@@ -29,13 +31,19 @@ This runs the Glimmer application hello_world.rb
       "#{jruby_os_specific_options} -J-classpath \"#{swt_jar_file}\""
     end
 
-    def launch(application)
-      system "jruby #{jruby_command_options} -r glimmer -S #{application}"
+    def launch(application, dev_mode = false)
+      glimmer_lib = GLIMMER_LIB_GEM
+      if dev_mode
+        glimmer_lib = GLIMMER_LIB_LOCAL
+        puts "[DEVELOPMENT MODE] (#{glimmer_lib})"
+      end
+      system "jruby #{jruby_command_options} -r #{glimmer_lib} -S #{application}"
     end
   end
 
-  def initialize(application_path)
-    @application_path = application_path
+  def initialize(options)
+    @dev_mode = !!options.delete('--dev')
+    @application_path = options.first
   end
 
   def start
@@ -47,8 +55,8 @@ This runs the Glimmer application hello_world.rb
   end
 
   def launch_application
-    puts "Launching Glimmer Application: #{@application_path}"
-    self.class.launch(@application_path)
+    puts "Launching Glimmer Application: #{@application_path}" unless @application_path == 'irb'
+    self.class.launch(@application_path, @dev_mode)
   end
 
   def display_usage

metadata

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