glimmer 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01b2e0936795d4ac088a3ea7c7045c22fbe064fd7d88283af396c3239f77bb59
-  data.tar.gz: c202f93d54b4b20a96cbd5c6f493ebc3d7919d92b7b02db69e6ac8feacd9c6e7
+  metadata.gz: cec5986595dd78ec9811f6a717e689834b5808757932488751393047d58b62a1
+  data.tar.gz: 73cd3972ef8d0b637a1fdeed9a7f8117da2afec2dffeedc9f9b3cc2e4fc971b9
 SHA512:
-  metadata.gz: 40669eb87ebceef14f5c397ea2d4c51d55fa7daacfab7ef3a9fc110ea0dc739e2cb7b169824bf4d0cb01c32665c794a440763d9b68be56a891bca2a93c950a02
-  data.tar.gz: ca479f2226c69678976cc51f71c8496fd24b96a4538b913bc5f976c2b0653c5538d5bc85f372b06adc593615e045d2718581585fc42cef457df480f7cb7255f0
+  metadata.gz: efa303ce11d71e9b7b9864de4c6edac9431e0a85905d2bf74a3d1c6b8b36131cf84a17a7e32977b4f1421aa1bc558da7a392dbc5814201928034fc98b2f158c5
+  data.tar.gz: 8fd39a5f47a9d10d6c6b00e2c14925579f3817e803c7e1fdd71e69b7d9a7c0fc70c04b9db034822bd7e1ab002d96c8f998f412561111cee21dcd985d3fa887f3

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.3
+jgem install glimmer -v 0.4.4
 ```
 
 ### Option 2: Bundler
 
 Add the following to `Gemfile`:
 ```
-gem 'glimmer', '~> 0.4.3'
+gem 'glimmer', '~> 0.4.4'
 ```
 
 And, then run:
@@ -569,6 +569,113 @@ class TicTacToe
 end
 ```
 
+## Custom Widgets
+
+Glimmer supports creating custom widgets with minimal code, which automatically extends Glimmer's DSL syntax with an underscored lowercase keyword.
+
+Simply create a new class that includes `Glimmer::SWT::CustomWidget` and put Glimmer DSL code in its `#body` method (its return value is stored in `#body_root` attribute). Glimmer will then automatically recognize this class by convention when it encounters a keyword matching the class name converted to underscored lowercase (and namespace double-colons `::` replaced with double-underscores `__`)
+
+**Example:**
+
+Definition:
+```ruby
+class RedLabel
+  include Glimmer::SWT::CustomWidget
+  def body
+    label(swt_style) {
+      background :red
+    }
+  end
+end
+```
+
+Usage:
+```ruby
+shell {
+  red_label {
+    text 'Red Label'
+  }
+}
+```
+
+As you can see, `RedLabel` became Glimmer DSL keyword: `red_label`
+
+**Another Example:**
+
+Definition:
+```ruby
+module Red
+  class Composite
+    include Glimmer::SWT::CustomWidget
+    def body
+      composite(swt_style) {
+        background :red
+      }
+    end
+  end
+```
+
+Usage:
+```ruby
+shell {
+  red__composite {
+    label {
+      foreground :white
+      text 'This is showing inside a Red Composite'
+    }
+  }
+}
+```
+
+Notice how `Red::Composite` became `red__composite` with double-underscore, which is how Glimmer Custom Widgets signify namespaces by convention.
+
+Custom Widgets have the following attributes 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
+- `#options`: a hash of options passed in parentheses when declaring a custom widget (useful for passing in model data) (e.g. `calendar(events: events)`). Custom widget class can declare option names (array) with `.options` method as shown below (not to be confused with `#options` instance method for retrieving options hash containing names & values)
+- `#content`: nested block underneath custom widget. It will be automatically called at the end of processing the custom widget body. Alternatively, the custom widget body may call `content.call` at the place where the content is needed to show up as shown in the following example.
+
+**Content/Options Example:**
+
+Definition:
+```ruby
+class Sandwich
+  include Glimmer::SWT::CustomWidget
+  options :orientation, :bg_color
+  def body
+    composite(swt_style) { # gets custom widget style
+      fill_layout orientation # using orientation option
+      background container_background # using container_background option
+      label {
+        text 'SANDWICH TOP'
+      }
+      content.call # this is where content block is called
+      label {
+        text 'SANDWICH BOTTOM'
+      }
+    }
+  end
+end
+```
+
+Usage:
+```ruby
+shell {
+  sandwich(:no_focus, orientation: :horizontal, bg_color: :white) {
+    label {
+      text 'SANDWICH CONTENT'
+    }
+  }
+}
+```
+
+Notice how `:no_focus` was the `swt_style` value, followed by the `options` hash `{orientation: :horizontal, bg_color: :white}`, and finally the `content` block containing the label with `'SANDWICH CONTENT'`
+
+The following additional attributes may be called from outside a custom widget in addition to the attributes mentioned above, assuming it's been captured in a variable:
+- `#body_root`: top-most root Glimmer widget returned in `#body` method
+- `#widget`: actual SWT widget for `body_root`
+
+
 ## Samples
 
 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`).

data/bin/girb

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

data/bin/glimmer

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 
-require_relative File.join('..', 'lib', 'glimmer_application')
-GlimmerApplication.new(ARGV).start
+require_relative '../lib/glimmer/launcher'
+
+Glimmer::Launcher.new(ARGV).launch

data/lib/glimmer.rb

@@ -5,10 +5,13 @@
 
 require "rubygems"
 require "facets"
+require "super_module"
 require "logger"
 require "java"
 require_relative "glimmer/parent"
-require_relative "glimmer/swt_packages"
+require_relative "glimmer/swt_packages" #TODO move into SWT namespace
+require_relative "glimmer/swt/custom_widget"
+require_relative "glimmer/ext/module"
 
 module Glimmer
    #TODO make it configurable to include or not include
@@ -62,5 +65,5 @@ module Glimmer
 end
 
 # Command handlers may rely on Glimmer, so this is put here to avoid an infinite loop.
-require File.dirname(__FILE__) + "/glimmer/xml_command_handlers"
-require File.dirname(__FILE__) + "/glimmer/command_handlers"
+require File.dirname(__FILE__) + "/glimmer/xml_command_handlers" #TODO move into namespace
+require File.dirname(__FILE__) + "/glimmer/command_handlers" #TODO move into namespace

data/lib/glimmer/command_handlers.rb

@@ -1,41 +1,44 @@
 require_relative "command_handler_chain_factory"
-require_relative "command_handlers/color_command_handler"
-require_relative "command_handlers/display_command_handler"
-require_relative "command_handlers/shell_command_handler"
-require_relative "command_handlers/layout_command_handler"
-require_relative "command_handlers/layout_data_command_handler"
-require_relative "command_handlers/widget_listener_command_handler"
-require_relative "command_handlers/bind_command_handler"
-require_relative "command_handlers/tab_item_command_handler"
-require_relative "command_handlers/combo_selection_data_binding_command_handler"
-require_relative "command_handlers/list_selection_data_binding_command_handler"
-require_relative "command_handlers/tree_items_data_binding_command_handler"
-require_relative "command_handlers/tree_properties_data_binding_command_handler"
-require_relative "command_handlers/table_items_data_binding_command_handler"
-require_relative "command_handlers/table_column_properties_data_binding_command_handler"
-require_relative "command_handlers/data_binding_command_handler"
-require_relative "command_handlers/property_command_handler"
-require_relative "command_handlers/widget_command_handler"
+require_relative "swt/command_handlers/color_command_handler"
+require_relative "swt/command_handlers/display_command_handler"
+require_relative "swt/command_handlers/shell_command_handler"
+require_relative "swt/command_handlers/layout_command_handler"
+require_relative "swt/command_handlers/layout_data_command_handler"
+require_relative "swt/command_handlers/widget_listener_command_handler"
+require_relative "swt/command_handlers/bind_command_handler"
+require_relative "swt/command_handlers/tab_item_command_handler"
+require_relative "swt/command_handlers/combo_selection_data_binding_command_handler"
+require_relative "swt/command_handlers/list_selection_data_binding_command_handler"
+require_relative "swt/command_handlers/tree_items_data_binding_command_handler"
+require_relative "swt/command_handlers/tree_properties_data_binding_command_handler"
+require_relative "swt/command_handlers/table_items_data_binding_command_handler"
+require_relative "swt/command_handlers/table_column_properties_data_binding_command_handler"
+require_relative "swt/command_handlers/data_binding_command_handler"
+require_relative "swt/command_handlers/property_command_handler"
+require_relative "swt/command_handlers/widget_command_handler"
+require_relative "swt/command_handlers/custom_widget_command_handler"
 
+# TODO move into SWT namespace
 module Glimmer
   # edit to add more command handlers and extend Glimmer
   CommandHandlerChainFactory.def_dsl(:swt,
-    DisplayCommandHandler.new,
-    ShellCommandHandler.new,
-    LayoutDataCommandHandler.new,
-    LayoutCommandHandler.new,
-    WidgetListenerCommandHandler.new,
-    BindCommandHandler.new,
-    TabItemCommandHandler.new,
-    ComboSelectionDataBindingCommandHandler.new,
-    ListSelectionDataBindingCommandHandler.new,
-    TreeItemsDataBindingCommandHandler.new,
-    TreePropertiesDataBindingCommandHandler.new,
-    TableItemsDataBindingCommandHandler.new,
-    TableColumnPropertiesDataBindingCommandHandler.new,
-    DataBindingCommandHandler.new,
-    ColorCommandHandler.new,
-    PropertyCommandHandler.new,
-    WidgetCommandHandler.new
+    SWT::CommandHandlers::DisplayCommandHandler.new,
+    SWT::CommandHandlers::ShellCommandHandler.new,
+    SWT::CommandHandlers::LayoutDataCommandHandler.new,
+    SWT::CommandHandlers::LayoutCommandHandler.new,
+    SWT::CommandHandlers::WidgetListenerCommandHandler.new,
+    SWT::CommandHandlers::BindCommandHandler.new,
+    SWT::CommandHandlers::TabItemCommandHandler.new,
+    SWT::CommandHandlers::ComboSelectionDataBindingCommandHandler.new,
+    SWT::CommandHandlers::ListSelectionDataBindingCommandHandler.new,
+    SWT::CommandHandlers::TreeItemsDataBindingCommandHandler.new,
+    SWT::CommandHandlers::TreePropertiesDataBindingCommandHandler.new,
+    SWT::CommandHandlers::TableItemsDataBindingCommandHandler.new,
+    SWT::CommandHandlers::TableColumnPropertiesDataBindingCommandHandler.new,
+    SWT::CommandHandlers::DataBindingCommandHandler.new,
+    SWT::CommandHandlers::ColorCommandHandler.new,
+    SWT::CommandHandlers::PropertyCommandHandler.new,
+    SWT::CommandHandlers::WidgetCommandHandler.new,
+    SWT::CommandHandlers::CustomWidgetCommandHandler.new
   )
 end

data/lib/glimmer/ext/module.rb

@@ -0,0 +1,20 @@
+class Module
+  # TODO improve this (make it work dynamically per DSL loaded)
+  begin
+    instance_method(:const_missing_without_glimmer)
+  rescue
+    alias const_missing_without_glimmer const_missing
+
+    def const_missing(constant)
+      return const_missing_without_glimmer(constant) if @const_missing_without_glimmer_constant
+      @const_missing_without_glimmer_constant = constant
+      ::Glimmer::SWT.const_get(constant)
+    rescue LoadError => e
+      const_missing_without_glimmer(constant)
+    rescue => e
+      const_missing_without_glimmer(constant)
+    ensure
+      @const_missing_without_glimmer_constant = nil
+    end
+  end
+end

data/lib/glimmer/launcher.rb

@@ -0,0 +1,75 @@
+require 'os'
+
+module Glimmer
+  class Launcher
+    OPERATING_SYSTEMS_SUPPORTED = ["mac", "windows", "linux"]
+    TEXT_USAGE = <<-MULTILINE
+  Usage: glimmer application.rb
+
+  Runs a Glimmer application using JRuby, automatically preloading
+  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
+        OPERATING_SYSTEMS_SUPPORTED.detect {|os| OS.send("#{os}?")}
+      end
+
+      def swt_jar_file
+        @swt_jar_file ||= File.expand_path(File.join(__FILE__, '..', '..', '..', 'vendor', 'swt', platform_os, 'swt.jar'))
+      end
+
+      def jruby_os_specific_options
+        OS.mac? ? "-J-XstartOnFirstThread" : ""
+      end
+
+      def jruby_swt_options
+        "#{jruby_os_specific_options} -J-classpath \"#{swt_jar_file}\""
+      end
+
+      def launch(application, dev_mode = false, debug_mode = false)
+        glimmer_lib = GLIMMER_LIB_GEM
+        if dev_mode
+          glimmer_lib = GLIMMER_LIB_LOCAL
+          puts "[DEVELOPMENT MODE] (#{glimmer_lib})"
+        end
+        debug_option = ''
+        if debug_mode
+          debug_option = '--debug '
+          puts "[DEBUG MODE]"
+        end
+        system "jruby #{debug_option}#{jruby_swt_options} -r #{glimmer_lib} -S #{application}"
+      end
+    end
+
+    def initialize(options)
+      @dev_mode = !!options.delete('--dev')
+      @debug_mode = !!options.delete('--debug')
+      @application_path = options.first
+    end
+
+    def launch
+      if @application_path
+        launch_application
+      else
+        display_usage
+      end
+    end
+
+    private
+
+    def launch_application
+      puts "Launching Glimmer Application: #{@application_path}" unless @application_path == 'irb'
+      self.class.launch(@application_path, @dev_mode, @debug_mode)
+    end
+
+    def display_usage
+      puts TEXT_USAGE
+    end
+  end
+end

data/lib/glimmer/swt/command_handlers/bind_command_handler.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + "/../../command_handler"
+require File.dirname(__FILE__) + "/../g_widget"
+require File.dirname(__FILE__) + "/../model_binding"
+
+module Glimmer
+  module SWT
+    module CommandHandlers
+      # Responsible for setting up the return value of the bind keyword (command symbol)
+      # as a ModelBinding. It is then used by another command handler like
+      # DataBindingCommandHandler for text and selection properties on Text and Spinner
+      # or TableItemsDataBindingCommandHandler for items in a Table
+      class BindCommandHandler
+        include CommandHandler
+
+        include_package 'org.eclipse.swt.widgets'
+
+        def can_handle?(parent, command_symbol, *args, &block)
+          # TODO refactor this long condition below
+          (
+            parent.is_a?(GWidget) and
+            command_symbol.to_s == "bind" and
+            (
+              (
+                (args.size == 2) and
+                  (
+                    args[1].is_a?(Symbol) or
+                    args[1].is_a?(String)
+                  )
+              ) or
+                (
+                  (args.size == 3) and
+                  (args[1].is_a?(Symbol) or args[1].is_a?(String)) and
+                  (args[2].is_a?(Symbol) or args[2].is_a?(String) or args[2].is_a?(Hash))
+                ) or
+                (
+                  (args.size == 4) and
+                  (args[1].is_a?(Symbol) or args[1].is_a?(String)) and
+                  (args[2].is_a?(Symbol) or args[2].is_a?(String)) and
+                  (args[3].is_a?(Hash))
+                )
+            ) and
+              block == nil
+          )
+        end
+
+        def do_handle(parent, command_symbol, *args, &block)
+          property_type = args[2] if (args.size == 3) && !args[2].is_a?(Hash)
+          binding_options = args[2] if args[2].is_a?(Hash)
+          binding_options = args[3] if args[3].is_a?(Hash)
+          ModelBinding.new(args[0], args[1].to_s, property_type, binding_options)
+        end
+      end
+    end
+  end
+end

data/lib/glimmer/swt/command_handlers/color_command_handler.rb

@@ -0,0 +1,30 @@
+require_relative '../../command_handler'
+require_relative '../g_color'
+
+module Glimmer
+  module SWT
+    module CommandHandlers
+      class ColorCommandHandler
+        include CommandHandler
+
+        include_package 'org.eclipse.swt.widgets'
+
+        def can_handle?(parent, command_symbol, *args, &block)
+          ['rgba', 'rgb'].include?(command_symbol.to_s) and
+          (3..5).include?(args.count)
+        end
+
+        def do_handle(parent, command_symbol, *args, &block)
+          if args.first.is_a?(Display) || args.first.nil?
+            display = args.delete_at(0)
+          elsif parent.is_a?(GWidget)
+            display = parent.widget.display
+          else
+            display = GDisplay.instance.display
+          end
+          GColor.new(display, *args)
+        end
+      end
+    end
+  end
+end