glimmer 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e13a3990377287df2bf023f72f4c6ab4b1cb8a58b4dad96321f4ac59e9efde11
-  data.tar.gz: 829597311c7719af97c326fd6f456038c1df94a76d8f140dd8acc430a8a951d4
+  metadata.gz: f7348e7c25e89b1300de7540833ad43ac060ecf94b8b97b897d8e946390851a5
+  data.tar.gz: a4e964bacc785ed789fe25c97c3811b39952d315428ec38e43082d5ba2bd1967
 SHA512:
-  metadata.gz: 344b90942d68a6bd994b09eb0e0848f996d57da0526cf54a6fc11f9718aae850b3e53419ba8bb418470f303fda278283ae99420d6a04bbd2cbab5b22e9ad250e
-  data.tar.gz: 486bbbf6de699a7d3985eea76a5588a83fe32c8a1484648d68b026237390427c2e14b8083b59874f0e0a87454c8d0a05449ca12016ba950c2271d7ac0da7e960
+  metadata.gz: 5348edf829a109f758e8a098d19b33dbdb6ddd27add80a5ab37afed35e426d1805742ce065ffb09f9451202ea3974312222bdd16390a47014a97dfc3cf92d399
+  data.tar.gz: dc24d11c4522f9c96d8d2fae5178a7053d9599fe5e3e0054db34e047dc519fdb1cbbb928eb8a5b16527db1ac2973224dc802802c9654096fd609e20533eba94d

data/README.markdown

@@ -1,4 +1,4 @@
-# Glimmer 0.5.4 Beta (JRuby Desktop UI DSL + Data-Binding)
+# Glimmer 0.5.5 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.
@@ -111,14 +111,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.4
+jgem install glimmer -v 0.5.5
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.5.4'
+gem 'glimmer', '~> 0.5.5'
 ```
 
 And, then run:
@@ -303,6 +303,83 @@ shell {
 }.open
 ```
 
+#### Menus
+
+Glimmer DSL provides support for SWT Menu and MenuItem widgets.
+
+There are 2 main types of menus in SWT:
+- Menu Bar (shows up on top)
+- Pop Up Menu (shows up when right-clicking a widget)
+
+Underneath both types, there can be a 3rd menu type called Drop Down.
+
+Glimmer provides special support for Drop Down menus as it automatically instantiates associated Cascade menu items and wires together with proper parenting, swt styles, and calling setMenu.
+
+Example [Menu Bar] (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+
+```ruby
+shell {
+  menu_bar {
+    menu {
+      text "&File"
+      menu_item {
+        text "E&xit"
+      }
+      menu_item(0) {
+        text "&New"
+      }
+      menu(1) {
+        text "&Options"
+        menu_item(:radio) {
+          text "Option 1"
+        }
+        menu_item(:separator)
+        menu_item(:check) {
+          text "Option 3"
+        }
+      }
+    }
+    menu {
+      text "&History"
+      menu {
+        text "&Recent"
+        menu_item {
+          text "File 1"
+        }
+        menu_item {
+          text "File 2"
+        }
+      }
+    }
+  }
+}.open
+```
+
+Example [Pop Up Menu] (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+
+```ruby
+shell {
+  label {
+    text 'Right-Click Me'
+    menu {
+      menu {
+        text '&History'
+        menu {
+          text "&Recent"
+          menu_item {
+            text "File 1"
+          }
+          menu_item {
+            text "File 2"
+          }
+        }
+      }
+    }
+  }
+}.open
+```
+
+
 #### SWT Proxies
 
 Glimmer follows Proxy Design Pattern by having Ruby proxy wrappers for all SWT objects:
@@ -450,6 +527,23 @@ shell(:no_resize) {
 }
 ```
 
+#### Shell extra attributes
+
+Shell widget can receive a hash of extra attributes as the last argument (or alone):
+- app_name: name to show for app (especially on the Mac)
+- app_version: version to have OS recognize app by
+
+Example (you may copy/paste in [`girb`](#girb-glimmer-irb-command)):
+
+```ruby
+shell(:no_resize, app_name: 'Glimmer Demo', app_version: '1.0') {
+  text "Glimmer"
+  label {
+    text "Hello, World!"
+  }
+}.open
+```
+
 ### Widget Properties
 
 Widget properties such as text value, enablement, visibility, 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:

data/lib/glimmer/dsl/color_expression.rb

@@ -2,8 +2,7 @@ require 'glimmer/dsl/expression'
 require 'glimmer/swt/color_proxy'
 require 'glimmer/swt/display_proxy'
 
-# TODO consider turning static keywords like rgba/rgb into methods
-# Support color keyword
+# TODO consider turning in static expressions rgb/rgba/color
 
 module Glimmer
   module DSL
@@ -16,11 +15,6 @@ module Glimmer
       end
 
       def interpret(parent, keyword, *args, &block)
-        if args.first.is_a?(Display) or args.first.nil?
-          display = args.delete_at(0)
-        else
-          display = SWT::DisplayProxy.instance.swt_display
-        end
         SWT::ColorProxy.new(*args)
       end
     end

data/lib/glimmer/dsl/menu_bar_expression.rb

@@ -0,0 +1,31 @@
+require 'glimmer'
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/swt/menu_proxy'
+
+module Glimmer
+  module DSL
+    class MenuBarExpression < StaticExpression
+      include ParentExpression
+
+      include_package 'org.eclipse.swt.widgets'
+
+      def can_interpret?(parent, keyword, *args, &block)
+        initial_condition = (keyword == 'menu_bar')
+        if initial_condition
+          if parent.swt_widget.is_a?(Shell)
+            return true
+          else
+            raise Glimmer::Error, "menu_bar may only be nested under a shell!"
+          end
+        end
+        false
+      end
+
+      def interpret(parent, keyword, *args, &block)
+        args = args.unshift(:bar)
+        SWT::MenuProxy.new(parent, args)
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/menu_expression.rb

@@ -0,0 +1,30 @@
+require 'glimmer'
+require 'glimmer/dsl/static_expression'
+require 'glimmer/dsl/parent_expression'
+require 'glimmer/swt/menu_proxy'
+
+module Glimmer
+  module DSL
+    class MenuExpression < StaticExpression
+      include ParentExpression
+
+      include_package 'org.eclipse.swt.widgets'
+
+      def can_interpret?(parent, keyword, *args, &block)
+        initial_condition = (keyword == 'menu')
+        if initial_condition
+          if widget?(parent)
+            return true
+          else
+            raise Glimmer::Error, "menu may only be nested under a widget (like shell or another menu)!"
+          end
+        end
+        false
+      end
+
+      def interpret(parent, keyword, *args, &block)
+        SWT::MenuProxy.new(parent, args)
+      end
+    end
+  end
+end

data/lib/glimmer/dsl/shell_expression.rb

@@ -8,6 +8,7 @@ module Glimmer
       include ParentExpression
 
       def interpret(parent, keyword, *args, &block)
+        args = [parent] + args unless parent.nil?
         SWT::ShellProxy.send(:new, *args)
       end
     end

data/lib/glimmer/swt/color_proxy.rb

@@ -11,8 +11,6 @@ module Glimmer
     class ColorProxy
       include_package 'org.eclipse.swt.graphics'
 
-      attr_reader :swt_color
-
       # Initializes a proxy for an SWT Color object
       #
       # Takes a standard color single argument, rgba 3 args, or rgba 4 args
@@ -29,19 +27,26 @@ module Glimmer
       # rgba is 4 arguments representing Red, Green, Blue, and Alpha numeric values
       #
       def initialize(*args)
-        case args.size
-        when 1
-          if args.first.is_a?(String) || args.first.is_a?(Symbol)
-            standard_color = args.first
-            standard_color = "color_#{standard_color}".to_sym unless standard_color.to_s.downcase.include?('color_')
-            @swt_color = DisplayProxy.instance.swt_display.getSystemColor(SWTProxy[standard_color])
-          else
-            @swt_color = args.first
+        @args = args
+      end
+
+      def swt_color
+        unless @swt_color
+          case @args.size
+          when 1
+            if @args.first.is_a?(String) || @args.first.is_a?(Symbol)
+              standard_color = @args.first
+              standard_color = "color_#{standard_color}".to_sym unless standard_color.to_s.downcase.include?('color_')
+              @swt_color = DisplayProxy.instance.swt_display.getSystemColor(SWTProxy[standard_color])
+            else
+              @swt_color = @args.first
+            end
+          when 3..4
+            red, green, blue, alpha = @args
+            @swt_color = Color.new(DisplayProxy.instance.swt_display, *[red, green, blue, alpha].compact)
           end
-        when 3..4
-          red, green, blue, alpha = args
-          @swt_color = Color.new(DisplayProxy.instance.swt_display, *[red, green, blue, alpha].compact)
         end
+        @swt_color
       end
     end
   end

data/lib/glimmer/swt/menu_proxy.rb

@@ -0,0 +1,84 @@
+require 'glimmer/swt/widget_proxy'
+
+module Glimmer
+  module SWT
+    # Proxy for org.eclipse.swt.widgets.Menu
+    #
+    # Functions differently from other widget proxies.
+    #
+    # Glimmer automatically detects if this is a drop down menu
+    # or pop up menu from its parent if no SWT style is passed in.
+    #
+    # There are 3 possibilities:
+    # - SWT :bar style is passed in: Menu Bar
+    # - Parent is ShellProxy: Pop Up Menu (having style :pop_up)
+    # - Parent is another Menu: Drop Down Menu (having style :drop_down)
+    #
+    # In order to get the SWT Menu object, one must call `#swt_widget`.
+    #
+    # In the case of a Drop Down menu, this automatically creates an
+    # SWT MenuItem object with style :cascade
+    #
+    # In order to retrieve the menu item widget proxy, one must call `#menu_item_proxy`
+    #
+    # Follows the Proxy Design Pattern
+    class MenuProxy < WidgetProxy
+      include_package 'org.eclipse.swt.widgets'
+
+      attr_reader :menu_item_proxy, :swt_menu_item, :menu_parent
+
+      def initialize(parent, args)
+        index = args.delete(args.last) if args.last.is_a?(Numeric)
+        styles = args.map(&:to_sym)
+        if !styles.include?(:bar) && !parent.swt_widget.is_a?(Menu)
+          styles = styles.unshift(:pop_up)
+        end
+
+        swt_widget_class = self.class.swt_widget_class_for('menu')
+        if parent.swt_widget.is_a?(Menu)
+          @menu_item_proxy = SWT::WidgetProxy.new('menu_item', parent, [:cascade] + [index].compact)
+          @swt_menu_item = @menu_item_proxy.swt_widget
+          @swt_widget = swt_widget_class.new(@menu_item_proxy.swt_widget)
+          @swt_menu_item.setMenu(swt_widget)
+        elsif parent.swt_widget.is_a?(Shell)
+          @swt_widget = swt_widget_class.new(parent.swt_widget, style('menu', styles))
+        else
+          @swt_widget = swt_widget_class.new(parent.swt_widget)
+        end
+        DEFAULT_INITIALIZERS['menu']&.call(swt_widget)
+
+        if styles.include?(:bar)
+          parent.swt_widget.setMenuBar(swt_widget)
+        elsif styles.include?(:pop_up)
+          parent.swt_widget.setMenu(swt_widget)
+        end
+      end
+
+      def has_attribute?(attribute_name, *args)
+        if attribute_name.to_s == "text"
+          true
+        else
+          super(attribute_name, *args)
+        end
+      end
+
+      def set_attribute(attribute_name, *args)
+        attribute_name
+        if attribute_name.to_s == "text"
+          text_value = args[0]
+          @swt_menu_item.setText text_value
+        else
+          super(attribute_name, *args)
+        end
+      end
+
+      def get_attribute(attribute_name)
+        if attribute_name.to_s == "text"
+          @swt_menu_item.getText
+        else
+          super(attribute_name)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swt/shell_proxy.rb

@@ -14,13 +14,22 @@ module Glimmer
 
       WIDTH_MIN = 130
       HEIGHT_MIN = 0
+      CUSTOM_ATTRIBUTES = %w[app_name app_version]
 
       attr_reader :opened_before
       alias opened_before? opened_before
 
       # Instantiates ShellProxy with same arguments expected by SWT Shell
       def initialize(*args)
-        if args.first.nil? || !args.first.is_a?(Display) && !args.first.is_a?(Shell)
+        if args.last.is_a?(Hash)
+          app_attributes = args.delete(args.last)
+          Display.setAppName(app_attributes[:app_name])
+          Display.setAppVersion(app_attributes[:app_version])
+        end
+        if args.first.is_a?(ShellProxy)
+          args[0] = args[0].swt_widget
+        end
+        if args.first.nil? || (!args.first.is_a?(Display) && !args.first.is_a?(Shell))
           @display = DisplayProxy.instance.swt_display
           args = [@display] + args
         end

data/lib/glimmer/swt/tab_item_proxy.rb

@@ -11,7 +11,7 @@ module Glimmer
     #
     # In order to get the SWT TabItem object, one must call `#swt_tab_item`.
     #
-    # Behinds the scenes, this creates a tab item widget proxy separately from a composite that
+    # Behind the scenes, this creates a tab item widget proxy separately from a composite that
     # is set as the control of the tab item and `#swt_widget`.
     #
     # In order to retrieve the tab item widget proxy, one must call `#widget_proxy`

data/lib/glimmer/swt/widget_proxy.rb

@@ -22,11 +22,12 @@ module Glimmer
       include DataBinding::ObservableWidget
 
       DEFAULT_STYLES = {
-        "text"    => [:border],
-        "table"   => [:border],
-        "spinner" => [:border],
-        "list"    => [:border, :v_scroll],
-        "button"  => [:push],
+        "text"        => [:border],
+        "table"       => [:border],
+        "spinner"     => [:border],
+        "list"        => [:border, :v_scroll],
+        "button"      => [:push],
+        "menu_item"   => [:push],
       }
 
       DEFAULT_INITIALIZERS = {
@@ -50,12 +51,29 @@ module Glimmer
       # Initializes a new SWT Widget
       #
       # Styles is a comma separate list of symbols representing SWT styles in lower case
-      def initialize(underscored_widget_name, parent, styles, &contents)
+      def initialize(underscored_widget_name, parent, args)
+        styles, extra_options = extract_args(underscored_widget_name, args)
         swt_widget_class = self.class.swt_widget_class_for(underscored_widget_name)
-        @swt_widget = swt_widget_class.new(parent.swt_widget, style(underscored_widget_name, styles))
+        @swt_widget = swt_widget_class.new(parent.swt_widget, style(underscored_widget_name, styles), *extra_options)
         DEFAULT_INITIALIZERS[underscored_widget_name]&.call(@swt_widget)
       end
 
+      def extract_args(underscored_widget_name, args)
+        @arg_extractor_mapping ||= {
+          'menu_item' => lambda do |args|
+            index = args.delete(args.last) if args.last.is_a?(Numeric)
+            extra_options = [index].compact
+            styles = args
+            [styles, extra_options]
+          end,
+        }
+        if @arg_extractor_mapping[underscored_widget_name]
+          @arg_extractor_mapping[underscored_widget_name].call(args)
+        else
+          [args, []]
+        end
+      end
+
       def has_attribute?(attribute_name, *args)
         widget_custom_attribute = widget_custom_attribute_mapping[attribute_name.to_s]
         if widget_custom_attribute

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - AndyMaleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -237,6 +237,8 @@ files:
 - lib/glimmer/dsl/layout_data_expression.rb
 - lib/glimmer/dsl/layout_expression.rb
 - lib/glimmer/dsl/list_selection_data_binding_expression.rb
+- lib/glimmer/dsl/menu_bar_expression.rb
+- lib/glimmer/dsl/menu_expression.rb
 - lib/glimmer/dsl/observe_expression.rb
 - lib/glimmer/dsl/parent_expression.rb
 - lib/glimmer/dsl/property_expression.rb
@@ -259,6 +261,7 @@ files:
 - lib/glimmer/swt/font_proxy.rb
 - lib/glimmer/swt/layout_data_proxy.rb
 - lib/glimmer/swt/layout_proxy.rb
+- lib/glimmer/swt/menu_proxy.rb
 - lib/glimmer/swt/packages.rb
 - lib/glimmer/swt/shell_proxy.rb
 - lib/glimmer/swt/swt_proxy.rb