sweet 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,9 +1,13 @@
-== Sweet: The SWT wrapper for JRuby
+== Sweet: The GUI wrapper for Ruby/JRuby
 
 Sweet is designed to provide the most readable and straight-forward DSL for the
-SWT toolkit while maintaining all of its flexibility. If you find any limits to
-this claim, please open a bug report or fix it on a fork if you feel
-adventurous.
+most common GUI toolkits while maintaining all of their flexibility. If you find
+any limits to this claim, please open a bug report or fix it on a fork if you
+feel adventurous.
+
+The primary and most complete toolkit right now is SWT, which requires JRuby.
+Swing, wxRuby and Gnome2 exist with rudimentary support so far. Cocoa is in
+the making. Pull requests for new widgets and toolkits are always welcome.
 
 === Install
 
@@ -11,7 +15,7 @@ Sweet is available as a gem:
 
   sudo gem install sweet
 
-To install the necessary SWT for your platform libraries, run:
+To install the necessary SWT libraries for your platform, run:
 
   sudo sweet install
 

data/bin/sweet

@@ -1,7 +1,9 @@
 #!/usr/bin/env jruby
 
+# TODO means to create distributables (jar / WebStart / InstallAnywhere / ...)
+
 require 'rubygems'
-require 'sweet/downloader'
+require 'sweet/swt/downloader'
 
 cmd = ARGV[0]
 

data/examples/fox/hello_world.rb

@@ -0,0 +1,12 @@
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/fox'
+Sweet.set_debug
+
+Sweet.app 'My first Application', :layout => :flow do
+  label 'Your name:'
+  @name = edit_line :columns => 10
+
+  button 'Push me' do
+    puts "Hello, #{@name.text}!"
+  end
+end

data/examples/gtk2/hello_world.rb

@@ -0,0 +1,14 @@
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/gtk2'
+Sweet.set_debug
+
+Sweet.app 'My first Application',  :border_width => 10 do
+  flow do
+    label 'Your name:'
+    @name = edit_line :columns => 10
+
+    button 'Push me' do
+      puts "Hello, #{@name.text}!"
+    end
+  end
+end

data/examples/swing/hello_world.rb

@@ -0,0 +1,12 @@
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/swing'
+Sweet.set_debug
+
+Sweet.app 'My first Application', :layout => :flow do
+  label 'Your name:'
+  @name = edit_line :columns => 10
+
+  button 'Push me' do
+    puts "Hello, #{@name.text}!"
+  end
+end

data/examples/swt/components.rb

@@ -0,0 +1,112 @@
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/swt'
+
+class Tab < Sweet::VarContainer
+  def self.title(title = nil)
+    title ? instances[@title = title] = self : @title
+  end
+
+  def self.instances
+    @instances ||= {}
+  end
+
+  def create
+    @style = 0
+    group :layout => :grid, :grid_data => {:align => [:fill, :fill], :grab => [true, true]} do
+      create_example_group
+    end
+    group 'Parameters', :layout => :grid, :grid_data => {:align => [:fill, :fill]} do
+      create_parameter_group
+    end
+  end
+
+  def create_example_group
+    example_layout = 
+      @example_group = group('Examples', example_layout) do
+      example_groups if respond_to? :example_group
+    end
+    @parameters_group =
+      create_example_widgets
+  end
+
+  def create_example_widgets
+    if widgets = @example_widgets
+      widgets.each { |widget| widget.dispose }
+    end
+    @example_widgets = example_widgets.flatten
+    # TODO hook listener and set state
+    @example_widgets.each do |widget|
+      widget.alignment = widget_alignment
+      widget.visible = true
+    end
+  end
+
+  def create_style_group
+    listener = proc { |event|
+      if event.widget.selection
+        self.widget_style = event.widget
+        create_example_widgets
+      end
+    }
+
+    @style_group = group('Styles', :grid_data => {:align => [:fill, :fill]}) do
+      %w{PUSH CHECK RADIO TOGGLE}.each{ |type| radio_button type, &listener}
+      %w{FLAT BORDER}.each{ |type| check_button type, &listener}
+    end
+  end
+
+  def widget_style
+    @style ||= 0
+  end
+  def widget_style=(value)
+    @style = value
+  end
+end
+
+class AlignableTab < Tab
+  def create_alignment_group
+    listener = proc { |event|
+      if event.widget.selection
+        self.widget_alignment = event.widget
+        create_example_widgets
+      end
+    }
+
+    group = @parent.append{ group('Alignment', :layout => :grid, :grid_data => {:align => [:fill, :fill]}) }
+    group.append do
+      radio_button 'Left', :selection => true, &listener
+      radio_button 'Center', &listener
+      radio_button 'Right', &listener
+    end
+
+    alignment_group(group, listener) if respond_to? :alignment_group
+  end
+
+  def widget_alignment
+    @widget_alignment ||= 0
+  end
+  def widget_alignment=(value)
+    @widget_alignment |= value.text.to_sym.swt_const
+  end
+  def widget_style
+    super | widget_alignment
+  end
+end
+
+Dir.glob(File.join(File.dirname(__FILE__), 'components/*.rb')).each{|file| load file}
+
+
+Sweet.app 'Component DEMO', :layout => :fill do
+
+  tab_folder do
+    tab_item do
+      buttons = Buttons.new(:layout => :grid.conf(:numColumns => 3), :style => swt::CLOSE)
+
+      buttons.create_alignment_group
+      buttons.create_example_group
+      buttons.create_style_group
+    end
+  end
+
+end
+

data/examples/swt/components/buttons.rb

@@ -0,0 +1,35 @@
+class Buttons < AlignableTab
+  title "Buttons"
+
+  def alignment_group(listener)
+    radio_button 'Up', &listener
+    radio_button 'Down', &listener
+  end
+
+  def example_group
+    # TODO densify with :grid_data => [:fill_both, :grab_both] or alike
+    group_layout = {:layout => :grid.conf(:numColumns => 3), :grid_data => {:align => [:fill, :fill], :grab => [true, true]}}
+
+    @text_buttons = group('Text Buttons', group_layout)
+    @image_buttons = group('Image Buttons', group_layout)
+    @image_text_buttons = group('Image Text Buttons', group_layout)
+  end
+
+  def example_widgets(style)
+    [ #returns all created widgets
+      @text_buttons.append do
+        %w{One Two Three}.map { |caption| button caption, :style => style }
+      end,
+      @image_buttons.append do
+        # TODO images
+        %w{One Two Three}.map { |type| button type, :style => style }
+      end,
+      @image_text_buttons.append do
+        # TODO images
+        %w{One Two Three}.map { |type| button type, :style => style }
+      end
+    ].map(&:children)
+  end
+
+end
+

data/examples/{hello_world.rb → swt/hello_world.rb}

@@ -1,5 +1,5 @@
-$: << File.join(__FILE__, '../lib')
-require 'sweet'
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/swt'
 
 Sweet.app 'My first Application', :layout => :fill do
   label 'Your name:'

data/examples/{snippet108.rb → swt/snippet108.rb}

@@ -1,5 +1,5 @@
-$: << File.join(__FILE__, '../lib')
-require 'sweet'
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/swt'
 
 #	Display display = new Display ();
 #	Shell shell = new Shell (display);

data/examples/{snippet128.rb → swt/snippet128.rb}

@@ -1,5 +1,5 @@
-$: << File.join(__FILE__, '../lib')
-require 'sweet'
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/swt'
 
 #   Display display = new Display();
 #		final Shell shell = new Shell(display);
@@ -36,6 +36,11 @@ Sweet.app :layout => :grid.conf(:numColumns => 3) do
     #				else if (string.equals("Go")) browser.setUrl(location.getText());
     #		   }
     #		};
+    #		itemBack.addListener(SWT.Selection, listener);
+    #		itemForward.addListener(SWT.Selection, listener);
+    #		itemStop.addListener(SWT.Selection, listener);
+    #		itemRefresh.addListener(SWT.Selection, listener);
+    #		itemGo.addListener(SWT.Selection, listener);
     %w{Back Forward Stop Refresh}.each do |caption|
       tool_item(caption) { @browser.send(caption.downcase) }
     end
@@ -140,12 +145,6 @@ Sweet.app :layout => :grid.conf(:numColumns => 3) do
     @location.text = event.location if event.top
   end
 
-  #		itemBack.addListener(SWT.Selection, listener);
-  #		itemForward.addListener(SWT.Selection, listener);
-  #		itemStop.addListener(SWT.Selection, listener);
-  #		itemRefresh.addListener(SWT.Selection, listener);
-  #		itemGo.addListener(SWT.Selection, listener);
-  #
   #		shell.open();
   #		browser.setUrl("http://eclipse.org");
   @browser.setUrl "http://eclipse.org"

data/examples/{snippet169.rb → swt/snippet169.rb}

@@ -1,5 +1,5 @@
-$: << File.join(__FILE__, '../lib')
-require 'sweet'
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/swt'
 
 #	Display display = new Display ();
 #	final Shell shell = new Shell (display);

data/examples/{snippet82.rb → swt/snippet82.rb}

@@ -1,5 +1,5 @@
-$: << File.join(__FILE__, '../lib')
-require 'sweet'
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/swt'
 
 #Display display = new Display();
 #	Shell shell = new Shell(display);

data/examples/wx/hello_world.rb

@@ -0,0 +1,12 @@
+$: << File.join(File.dirname(__FILE__), '../../lib')
+require 'sweet/wxruby'
+Sweet.set_debug
+
+Sweet.app 'My first Application', :layout => :flow do
+  label 'Your name:'
+  @name = edit_line :columns => 10
+
+  button 'Push me' do
+    puts "Hello, #{@name.text}!"
+  end
+end

data/lib/sweet.rb

@@ -1 +1,22 @@
-require 'sweet/base'
+case RUBY_PLATFORM
+when /java/
+  begin
+    require 'sweet/swt'
+  rescue
+    require 'sweet/swing'
+  end
+when /linux/
+  begin
+    require 'sweet/gtk2'
+  rescue
+    begin
+      require 'sweet/fox'
+    rescue
+      require 'sweet/wx'
+    end
+  end
+when /win/i
+  require 'sweet/fox'
+else # MacOS
+  require 'sweet/fox'
+end

data/lib/sweet/base.rb

@@ -1,95 +1,7 @@
-require 'sweet/downloader'
-
-begin
-  load Sweet::SWT_JAR
-rescue LoadError => e
-  STDERR.puts "No swt.jar found. Run:"
-  STDERR.puts "  sweet install [toolkit]"
-  exit
-end
-
-require 'java'
-%w{hacks widget composite shell dialog}.each{|file| require "sweet/#{file}"}
+require 'sweet/hacks'
 
-# TODO create gemspec
-# TODO evaluate integration of jface
-# TODO enable additive and replacing :style on widget creation
 module Sweet
 
-  import 'org.eclipse.swt'
-  import 'org.eclipse.swt.widgets'
-  import 'org.eclipse.swt.custom'
-  import 'org.eclipse.swt.browser'
-
-  # TODO integrate all standard widgets
-  WIDGET_HACKS = {
-    ProgressBar => {:custom_code => proc {
-        def fraction=(value)
-          setSelection value.to_f * maximum
-        end
-        def fraction
-          selection / maximum
-        end
-      }},
-    Text => {:custom_code => proc{
-        def password=(value)
-          self.echo_char = ?* if value
-        end
-        def password
-          ! echo_char.nil?
-        end
-      }},
-    CTabFolder => {:default_listener => 'CTabFolder2'}
-  }
-
-  DEFAULT = {:init_args => :text, :block_handler => SWT::Selection}
-  WIDGET_OPTIONS = {
-    # Text components
-    :label => {:style => SWT::WRAP, :init_args => :text},
-    :edit_line => {:class => Text, :style => SWT::SINGLE | SWT::BORDER, :init_args => :text, :block_handler => :on_widget_default_selected},
-    :edit_area => {:class => Text, :style => SWT::MULTI | SWT::BORDER, :init_args => :text, :block_handler => :on_widget_default_selected},
-
-    # Buttons
-    :button => DEFAULT.merge(:style => SWT::PUSH),
-    :toggle_button => DEFAULT.merge(:class => Button, :style => SWT::TOGGLE),
-    :radio_button => DEFAULT.merge(:class => Button, :style => SWT::RADIO),
-    :check_button => DEFAULT.merge(:class => Button, :style => SWT::CHECK),
-    :arrow_button => DEFAULT.merge(:class => Button, :style => SWT::ARROW),
-
-    # Menus
-    :menubar => {:class => Menu, :style => SWT::BAR},
-    :popup => {:class => Menu, :style => SWT::POP_UP},
-    :item => {:class => MenuItem, :style => SWT::PUSH, :init_args => :text, :block_handler => :on_widget_selected},
-    :separator => {:class => MenuItem, :style => SWT::SEPARATOR},
-    :submenu => {:class => MenuItem, :style => SWT::CASCADE, :init_args => :text, :block_handler => proc{|c, opts, block|
-        sub = Menu.new(c.app, SWT::DROP_DOWN)
-        sub.sweeten(c.app, opts, &block)
-        c.menu = sub
-      }
-    },
-    
-    # Toolbars
-    :tool_item => DEFAULT.merge(:style => SWT::PUSH),
-    # TODO make CoolBar work
-#    :cool_item => {:init_args => :control, :block_handler => proc{ |c, opts, proc|
-#        c.control = proc.call
-#      }},
-
-    # Tabs
-    :tab_folder => {:class => CTabFolder, :style => SWT::BORDER},
-    :tab_item => {:class => CTabItem, :style => SWT::CLOSE, :init_args => [:text, :control], :block_handler => proc{|c, opts, proc|
-        c.control = proc.call
-      }},
-
-    # Other components
-    :tree => {:style => SWT::VIRTUAL, :block_handler => SWT::Selection},
-    :progress => {:class => ProgressBar, :style => SWT::SMOOTH},
-    :group => {:init_args => :text},
-
-    # Dialogs
-    :color_dialog => {:style => SWT::APPLICATION_MODAL, :init_args => :text}
-  }.unify
-
   WIDGETS = {}
 
   def self.app(*args, &block)
@@ -99,25 +11,11 @@ module Sweet
     raise ArgumentError.new(count, 2) if args.size > 1
     opts = args.first || {}
 
-    # build the UI
-    Display.setAppName(name)
-    display = Display.new
-
-    # TODO allow multiple shells
-    shell = Shell.new(display)
-    shell.sweeten(display, name, opts, &block)
-    shell.open
-
-    # dispatch loop
-    while (!shell.isDisposed) do
-      display.sleep unless display.readAndDispatch
-    end
-
-    display.dispose
+    create_app(name, opts, &block)
   end
 
   def self.create_widget(parent, name, *args, &block)
-    init = WIDGET_OPTIONS[name] || {}
+    init = WIDGET_DEFAULTS[name] || {}
 
     unless cls = WIDGETS[name]
       #      puts "Loading widget #{name}"
@@ -125,99 +23,175 @@ module Sweet
       #      begin
       #        require filename
       #      rescue LoadError
-      cls = create_widget_class(name, init)
+      class_name = init[:class] || name
+      class_name = class_name.to_s.camelize(:upper) if class_name.is_a?(Symbol)
+      cls = create_widget_class(class_name, init)
+
+      unless WIDGETS.values.member? cls
+        delegate_events(cls)
+        if hacks = WIDGET_HACKS[cls]
+          if custom_code = hacks[:custom_code]
+            cls.class_eval &custom_code
+          end
+        end
+      end
+
       #      end
     end
 
     opts = args.last.is_a?(Hash) ? args.pop.dup : {}
-
-    style = opts.delete(:style) || init[:style] || SWT::NONE
-    style = Array(style).inject(0) do |result, value|
-      value = value.swt_const if value.is_a? Symbol
-      result | value
-    end
-
-    Sweet.debug "Creating #{cls.java_class.simple_name}(#{parent}, #{style})"
-    result = cls.new(parent, style)
-    result.instance_variable_set(:@block_handler, init[:block_handler])
-
     if init_args = init[:init_args]
-      Hash[Array(init_args).zip(args)].each do |k, v|
-        opts.merge! k => v if v
+      Array(init_args).zip(args).each do |(k, v)|
+        opts.merge!(k => v) if v
       end
     end
-    result.sweeten(parent.app, opts, &block)
 
-    result
+    widget = initialize_widget(parent, cls, opts, init)
+    widget.instance_variable_set(:@block_handler, init[:block_handler])
+
+    widget.sweeten(parent.app, opts, &block)
+
+    widget
+  end
+
+  @debug = ARGV.delete('--debug')
+  def self.set_debug(value = true)
+    @debug = value
+  end
+  def self.debug(text)
+    # TODO add a decent logging mechanism
+    puts text if @debug
   end
 
-  def self.create_widget_class(name, init)
-    # build widget with default accessors
-    class_name = init[:class] || name
-    class_name = class_name.to_s.camelize(:upper) if class_name.is_a?(Symbol)
-    cls = class_name.is_a?(Class) ? class_name : const_get(class_name)
-
-    unless WIDGETS.values.member? cls
-      delegate_events(cls)
-      if hacks = WIDGET_HACKS[cls]
-        if custom_code = hacks[:custom_code]
-          cls.class_eval &custom_code
+  module Component
+
+    def self.included(cls)
+      puts "extending #{cls}"
+      cls.extend(ClassMethods)
+    end
+
+    attr_reader :app
+
+    def sweeten(app, opts, &block)
+      @app = app
+      self.options = opts
+
+      if block
+        case handler = @block_handler
+        when nil
+          handle_container &block
+        when Symbol
+          handle_event handler, &block
+        when Proc
+          instance_eval do
+            handler.call self, opts, block
+          end
+        else
+          raise("Invalid :block_handler ",handler) unless sweet_block_handler(handler, &block)
         end
       end
+
+      puts "Unknown properties for class #{self.class}: #{opts.keys.inspect}" unless opts.empty?
     end
+    alias handle_event send
 
-    cls
-  end
+    def app(&block)
+      return @app unless block
+      @app.var_containers.last.instance_eval(&block)
+    end
 
-  def self.delegate_events(cls)
-    hacks = WIDGET_HACKS[cls]
-    default_listener = (hacks[:default_listener] || '').underscore if hacks
-
-    methods = cls.java_class.java_instance_methods
-    methods.each do |m|
-      next unless m.name =~ /(add(.*)Listener)/
-      j = $1
-      n = $2.underscore
-      p = m.parameter_types[0]
-      evts = p.declared_instance_methods
-
-      if evts.size == 1
-        s = "on_#{n}"
-        cls.send(:alias_method, s, j) unless cls.respond_to?(s)
-      else
-        evts.each do |evt|
-          s = evt.name.underscore
-          if s.split(/_/).size == 1 && n != default_listener
-            s = n + "_" + s
+    def append(&block)
+      raise "Append called without block" unless block
+      handle_container &block
+    end
+
+    def meta(&block)
+      @meta ||= class << self
+        self
+      end
+      block ? @meta.class_eval(&block) : @meta
+    end
+
+    def options=(opts)
+      # TODO reader method
+      opts.each_pair do |k, v|
+        case k
+        when :hidden
+          setVisible !v
+        else
+          name = k.to_s + "="
+          next unless respond_to? name
+          if v
+            classname = respond_to?(:java_class) ? self.java_class.simple_name : self.class.name
+            Sweet.debug "#{classname}.#{k} = #{v.inspect}"
+            send name, *v
           end
-          # TODO provide addListener SWT::Xxx option
-          unused_events = evts.select{ |e| e.name != evt.name }.map{ |e| "def #{e.name.underscore}(e)\nend" }.join("\n")
-          cls.class_eval <<-EOF
-              def on_#{s}(&block)
-                l = Class.new do
-                  include Java.#{p}
-                  def initialize(&block)
-                    @block = block
-                  end
-                  def #{evt.name}(e)
-                    @block.call e
-                  end
-                  #{unused_events}
-                end
-                #{j} l.new(&block)
-              end
-          EOF
+          opts.delete(k)
+        end
+      end
+    end
+
+    def perform(&block)
+      app.perform &block
+    end
+
+    def method_missing(name, *args, &block)
+      app.send(name, *args, &block) rescue super
+    end
+
+    private
+    def handle_container(&block)
+      app.sweet_containers.push self
+      app &block
+    ensure
+      app.sweet_containers.pop
+    end
+
+    module ClassMethods
+      def alias_property(aliases = {})
+        aliases.each do |from, to|
+          alias_method from, to unless respond_to? to
+          alias_method "#{from}=", "#{to}=" unless respond_to? "#{to}="
         end
       end
     end
+
   end
 
-  def self.set_debug
-    @debug = true
+  module Application
+    def initialize_app(root)
+      sweet_containers << root
+      var_containers << root
+    end
+    def sweet_containers
+      @sweet_containers ||= []
+    end
+    def var_containers
+      @var_containers ||= []
+    end
+    # TODO find suitable exception
+    def perform(&block)
+      raise 'perform is not implemented'
+    end
+
+    def busy(&block)
+      raise 'busy is not implemented'
+    end
+    def method_missing(name, *args, &block)
+      Sweet.create_widget(sweet_containers.last, name, *args, &block) || super
+    end
   end
-  def self.debug(text)
-    # TODO add a decent logging mechanism
-    puts text if @debug
+
+  class VarContainer
+    include Component
+
+    private
+    def handle_container(&block)
+      app.var_containers.push self
+      app &block
+    ensure
+      app.var_containers.pop
+    end
   end
-end
 
+end