swing 0.0.5 → 0.1.0

data/HISTORY

@@ -21,3 +21,7 @@
 == 0.0.5 / 2011-05-24
 
 * Ignoring IDEA module info
+
+== 0.1.0 / 2011-05-25
+
+* API changed to conform to original Swing classes

data/README.rdoc

@@ -4,18 +4,29 @@ url: http://github.com/arvicco/swing
 
 == DESCRIPTION:
 
-Straightforward wrappers for javax.swing Components that simplify Swing code in
-JRuby-based GUI applications.
-
-== FEATURES/PROBLEMS:
-
-* Library defines Ruby wrapper classes for Swing components that do NOT shadow original
-  javax.swing classes. So, javax.swing.JButton class is wrapped by Swing::Button class,
-  and you need to <b> require 'swing/button' </b> to use it.
-* Ruby wrappers define properties that are settable in constructor options, as well
-  as (optional) defaults for them that may be different from swing's original defaults:
-  Swing::Button.new 'Title', :enabled => false
-*
+Straightforward wrappers for javax.swing Components that simplify Swing code in JRuby-based GUI applications.
+
+== PROBLEMS:
+
+This code is NOT production-ready! For production-ready code, try something like Rubeus:
+[https://github.com/akm/rubeus]. Personally, I've tried to use Rubeus and its auto-magic
+worked great for some use-cases, but I had problems extending its code when I needed to
+change default Rubeus behavior. For the life of me, I cannot figure out where all this
+Rubeus magic happens and how to change ANYTHING without the whole stage with smoke and
+mirrors falling down on me.
+
+Maybe it's just me - but I'm uncomfortable with complicated code and prefer much more
+straightforward solutions. So, I intend this lib to be straightforward - even at the
+expense of performance.
+
+== FEATURES:
+
+Library adds extended functionality to original javax.swing classes, such as:
+* Ability to set attributes via constructor options:
+  Swing::JButton.new 'Title', :enabled => false
+* Ability to define settable attributes/properties via attr_setter class macro,
+  as well as (optional) defaults for them that may be different from Swing's original defaults
+* Auto adding component to parent if ops[:parent] is given to initializer
 
 == SYNOPSIS:
 

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.1.0

data/lib/awt/component.rb

@@ -0,0 +1,11 @@
+require 'swing_support/extensions/attributes'
+
+class Awt::Component
+
+  # TODO: remove from spec suite
+  def blah
+  end
+
+  include SwingSupport::Extensions::Attributes
+
+end

data/lib/awt.rb

@@ -0,0 +1,4 @@
+include Java
+Awt = java.awt
+
+require 'awt/component'

data/lib/swing/controls.rb

@@ -1,4 +1,4 @@
 # Swing-based GUI controls
-require 'swing/label'
-require 'swing/button'
-require 'swing/check_box'
+require 'swing/j_label'
+require 'swing/j_button'
+require 'swing/j_check_box'

data/lib/swing/j_button.rb

@@ -0,0 +1,12 @@
+require 'swing'
+
+class Swing::JButton
+
+  attr_setter :enabled
+
+  def initialize *args, &block
+    super *args
+
+    self.addActionListener SwingSupport::ActionListener.new &block
+  end
+end # class JButton

data/lib/swing/j_check_box.rb

@@ -0,0 +1,13 @@
+require 'swing'
+
+module Swing::JCheckBox
+
+  attr_setter :selected
+
+  def initialize *args, &block
+    super *args
+
+    # TODO: Probably need to implement ItemListener as well?
+    self.addActionListener SwingSupport::ActionListener.new &block
+  end
+end # class JCheckBox

data/lib/swing/j_frame.rb

@@ -0,0 +1,24 @@
+require 'swing'
+
+module Swing::JFrame
+#    include AttrSetter
+
+  attr_setter :layout, :background, :size, :title,
+              :default_close_operation => JFrame::EXIT_ON_CLOSE #DISPOSE_ON_CLOSE, HIDE_ON_CLOSE
+
+  def initialize *args
+
+    super *args
+
+#    setup opts
+
+    self.location_relative_to = nil
+    self.visible = true
+  end
+
+  # Method that subclasses should override to set up their contents before
+  # Frame is made visible
+  def setup opts
+  end
+
+end

data/lib/swing/j_label.rb

@@ -0,0 +1,6 @@
+require 'swing'
+
+module Swing::JLabel
+
+end # class Label
+

data/lib/swing/j_list.rb

@@ -0,0 +1,6 @@
+require 'swing'
+
+module Swing::JList
+
+end # class List
+

data/lib/swing/j_menu.rb

@@ -0,0 +1,5 @@
+require 'swing'
+
+module Swing::JMenu
+
+end

data/lib/swing/j_menu_bar.rb

@@ -0,0 +1,32 @@
+require 'swing'
+require 'swing/j_menu'
+require 'swing/j_menu_item'
+
+module Swing::JMenuBar
+
+  def initialize opts = {}
+    super opts
+
+    if opts[:structure]
+      [opts[:structure]].flatten.each do |element|
+        case element
+          when Hash # Hash defines menu structure
+            element.each do |menu_name, menu_structure|
+              menu = JMenu.new menu_name.to_s, :parent => self
+              menu_structure.each do |item_name, item_action|
+                JMenuItem.new item_name.to_s, :parent => menu, &item_action
+              end
+            end
+          else
+            self.add element
+        end
+      end
+    end
+  end
+
+  # Post-processing (non-setter) options given to initialize
+  def self.add_component component, parent
+    parent.setJMenuBar component if parent
+  end
+
+end

data/lib/swing/j_menu_item.rb

@@ -0,0 +1,9 @@
+require 'swing'
+
+module Swing::JMenuItem
+
+  def initialize text, opts = {}, &block
+    super text
+    self.addActionListener SwingHelper::ActionListener.new &block
+  end
+end

data/lib/swing/j_panel.rb

@@ -0,0 +1,6 @@
+require 'swing'
+
+module Swing::JPanel
+
+  attr_setter :layout, :background
+end # class Panel

data/lib/swing/j_scroll_pane.rb

@@ -0,0 +1,8 @@
+require 'swing'
+
+# Scroll Pane around given scrollable component
+module Swing::JScrollPane
+
+  attr_setter :horizontal_scroll_bar_policy, :vertical_scroll_bar_policy
+
+end # class JScrollPane

data/lib/swing/j_split_pane.rb

@@ -0,0 +1,11 @@
+require 'swing'
+
+module Swing::JSplitPane
+
+  attr_setter :one_touch_expandable, :orientation, :continuous_layout,
+              :divider_size, :divider_location, :resize_weight
+
+  def initialize first, second, opts = {}
+    super(HORIZONTAL_SPLIT, first, second)
+  end
+end # class JSplitPane

data/lib/swing/j_table.rb

@@ -0,0 +1,51 @@
+require 'swing'
+
+module Swing::JTable
+
+  #    autoCreateColumnsFromModel boolean � � false
+  #    autoResizeMode             int � � AUTO_RESIZE_ALL_COLUMNS
+  #    columnModel                TableColumnModel � � DefaultTableColumnModel( )
+  #    model                      TableModel � � DefaultTableModel( )
+  #    rowHeight                  int � � 16
+  #    cellSelectionEnabled       boolean � � false
+  #    columnSelectionAllowed     boolean � � false
+  #    rowSelectionAllowed        boolean � � true
+  #    selectionMode              int � MULTIPLE_INTERVAL_SELECTION
+  #    selectionModel             ListSelectionModel � � DefaultListSelectionModel
+  #    cellEditor                 TableCellEditor � � null
+  #    dragEnabled                boolean � � false
+  #    gridColor                  Color � � From L&F
+  #    intercellSpacing           Dimension � � Dimension(1, 1)
+  #    preferredScrollableViewportSize Dimension � � Dimension(450, 400)
+  #    rowMargin                  int � � 1
+  #    selectionBackground       Color � � From L&F
+  #    selectionForeground       Color � � From L&F
+  #    showGrid                   boolean  � true
+  #    showHorizontalLines        boolean � � true
+  #    showVerticalLines          boolean � � true
+  #    tableHeader                JTableHeader � � JTableHeader(column-Model)
+  #    ----Getters only - NO Setters!
+  #    columnCount          int � 0
+  #    rowCount             int � 0
+  #    selectedColumn       int � -1
+  #    selectedColumnCount  int � 0
+  #    selectedColumns      int[] � int[0]
+  #    selectedRow          int � -1
+  #    selectedRowCount     int � 0
+  #    selectedRows         int[] � int[0]
+  #    accessibleContext    AccessibleContext � JTable.AccessibleJTable
+  #    scrollableTracksViewportHeighto boolean � false
+  #    scrollableTracksViewportWidtho boolean � false
+
+  attr_setter :auto_create_columns_from_model, :auto_resize_mode, :row_height,
+              :model, :column_model, :selection_model,
+              :drag_enabled, :cell_editor, :grid_color, :intercell_spacing,
+              :preferred_scrollable_viewport_size, :row_margin,
+              :selection_background, :selection_foreground, :show_grid,
+              :show_horizontal_lines, :show_vertical_lines, :table_header,
+              :selection_mode => javax.swing.ListSelectionModel::SINGLE_SELECTION,
+              :cell_selection_enabled => true,
+              :row_selection_allowed => false,
+              :column_selection_allowed => false
+
+end # class JTable

data/lib/swing/{button.rb → old/button.rb}

@@ -1,10 +1,9 @@
+require 'swing'
 require 'swing/action_listener'
-require 'swing/attr_setter'
 
 module Swing
 
-  class Button < javax.swing.JButton
-    include AttrSetter
+  class JButton
 
     attr_setter :enabled
 

data/lib/swing/{check_box.rb → old/check_box.rb}

@@ -1,9 +1,8 @@
+require 'swing'
 require 'swing/action_listener'
-require 'swing/attr_setter'
 
 module Swing
   class CheckBox < javax.swing.JCheckBox
-    include AttrSetter
 
     attr_setter :selected
 

data/lib/swing/{menu_bar.rb → old/menu_bar.rb}

@@ -25,8 +25,12 @@ module Swing
           end
         end
       end
-      opts[:parent].setJMenuBar self if opts[:parent]
     end
   end
 
+  # Post-processing (non-setter) options given to initialize
+  def self.add_component component, parent
+    parent.setJMenuBar component if parent
+  end
+
 end

data/lib/swing.rb

@@ -1,23 +1,22 @@
-require 'version'
 require 'rubygems'
 
-module Swing
-
-  # Requires ruby source file(s), given as single filename/glob or Array of filenames/globs.
-  # Accepts following options:
-  # :*file*:: Lib(s) required relative to this file - defaults to __FILE__
-  # :*dir*:: Required lib(s) located under this dir name - defaults to gem name
-  #
-  def self.require_libs( libs, opts={} )
-    file = Pathname.new(opts[:file] || __FILE__)
-    [libs].flatten.each do |lib|
-      name = file.dirname + (opts[:dir] || file.basename('.*')) + lib.gsub(/(?<!.rb)$/, '.rb')
-      Pathname.glob(name.to_s).sort.each {|rb| require rb}
-    end
-  end
-end  # module Swing
+include Java
+Swing = javax.swing
 
-# Require all ruby source files located under directory lib/swing
-# If you need files in specific order, you should specify it here before the glob
-Swing.require_libs %W[**/*]
+require 'version'
+require 'swing_support'
+require 'awt'
 
+#
+#module Swing
+#  autoload :JButton, "swing/j_button"
+#  autoload :JCheckBox, "swing/j_check_box"
+#  autoload :JButton, "swing/j_button"
+#  autoload :JButton, "swing/j_button"
+#  autoload :JButton, "swing/j_button"
+#  autoload :JButton, "swing/j_button"
+#  autoload :JButton, "swing/j_button"
+#  autoload :Jdbc, "rubeus/jdbc"
+#  autoload :Reflection, "rubeus/reflection"
+#  autoload :Util, "rubeus/util"
+#end  # module Swing

data/lib/{swing → swing_support}/action_listener.rb

@@ -1,6 +1,6 @@
-include Java
+require 'swing_support/extensions'
 
-module Swing
+module SwingSupport
   # Class that implements ActionListener interface around a given block
   class ActionListener
     java_implements java.awt.event.ActionListener

data/lib/swing_support/extensions/attributes.rb

@@ -0,0 +1,65 @@
+import java.awt.Dimension
+
+module SwingSupport
+  module Extensions
+    # Module allows including classes to receive attribute values in an *opts* Hash
+    # and sets those attributes after object initialization
+    module Attributes
+      def self.included host
+        host.send :extend, ClassMethods
+        host.instance_eval do
+          attr_setter :font, :tool_tip_text, :enabled
+          alias :new_without_attributes :new
+          alias :new :new_with_attributes
+        end
+      end
+
+      module ClassMethods
+        def attributes
+          @attributes ||= (superclass.attributes.dup rescue {})
+        end
+
+        # Adds settable attributes for a given class, possibly with defaults
+        # If defaults are given for attributes, they should be put at the end (as opts)
+        def attr_setter *new_attributes
+          if new_attributes.last.is_a? Hash
+            # Some attributes are given with defaults
+            new_attributes_with_defaults = new_attributes.pop
+            new_attributes_with_defaults.each { |name, default| attributes[name] = default }
+          end
+          new_attributes.each { |name| attributes[name] = nil }
+        end
+
+        # Sets attributes after calling original new
+        def new_with_attributes(*args, &block)
+          opts = args.last.is_a?(Hash) ? args.pop : {}
+          component = self.new_without_attributes(*args, &block)
+
+          # Extract known attributes given in opts, or known defaults
+          attributes = attributes().map do |name, default|
+            value = opts.delete name
+            result = if default.nil? # No default, return whatever value
+                       value
+                     elsif default.respond_to? :call # Default is callable, call it with whatever value
+                       default.call *value
+                     else # Return either non-nil value or default
+                       value.nil? ? default : value
+                     end
+            [name, result] unless result.nil?
+          end.compact
+          #      yield opts if block_given?
+          attributes.each { |(name, value)| component.send "#{name}=", *value }
+
+          # Post-process non-setter opts
+          add_component component, opts[:parent]
+          component
+        end
+
+        # Post-processing (non-setter) options given to initialize
+        def add_component component, parent
+          parent.add component if parent
+        end
+      end
+    end
+  end
+end

data/lib/swing_support/extensions.rb

@@ -0,0 +1,4 @@
+module SwingSupport
+  module Extensions
+  end
+end

data/lib/swing_support.rb

@@ -0,0 +1,4 @@
+module SwingSupport
+end
+
+require 'swing_support/extensions/attributes'

data/spec/awt/component_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'awt/component'
+
+describe 'java.awt.Component' do
+  context 'defining new methods' do
+    it 'changes derived Ruby subclases' do
+      button = Swing::JButton.new 'Disconnect', :enabled => false
+      button.should_not be_enabled
+      button.should respond_to :blah
+      button.blah
+    end
+
+    it 'changes derived pure Java subclases' do
+      button = javax.swing.JButton.new 'Disconnect' #, :enabled => false
+      button.should respond_to :blah
+      button.blah
+    end
+  end
+
+  context 'with Attributes extension' do
+    it 'allows pure Java subclasses to accept options' do
+      button = javax.swing.JButton.new 'Disconnect', :enabled => false
+      button.should_not be_enabled
+    end
+  end
+end

data/spec/{button_spec.rb → swing/j_button_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe Swing::Button do
+describe Swing::JButton do
   it 'is possible to set :enabled attribute to false' do
-    button = Swing::Button.new 'Disconnect', :enabled => false
+    button = Swing::JButton.new 'Disconnect', :enabled => false
     button.should_not be_enabled
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: swing
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
   - arvicco
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 +04:00
+date: 2011-05-25 00:00:00 +04:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -49,26 +49,44 @@ extra_rdoc_files:
   - README.rdoc
 files: 
   - bin/swing
+  - lib/awt.rb
   - lib/swing.rb
+  - lib/swing_support.rb
   - lib/version.rb
-  - lib/swing/action_listener.rb
-  - lib/swing/attr_setter.rb
-  - lib/swing/button.rb
-  - lib/swing/check_box.rb
+  - lib/awt/component.rb
   - lib/swing/controls.rb
-  - lib/swing/frame.rb
-  - lib/swing/label.rb
-  - lib/swing/list.rb
-  - lib/swing/menu.rb
-  - lib/swing/menu_bar.rb
-  - lib/swing/menu_item.rb
-  - lib/swing/panel.rb
-  - lib/swing/scroll_pane.rb
-  - lib/swing/split_pane.rb
-  - lib/swing/table.rb
-  - spec/button_spec.rb
+  - lib/swing/j_button.rb
+  - lib/swing/j_check_box.rb
+  - lib/swing/j_frame.rb
+  - lib/swing/j_label.rb
+  - lib/swing/j_list.rb
+  - lib/swing/j_menu.rb
+  - lib/swing/j_menu_bar.rb
+  - lib/swing/j_menu_item.rb
+  - lib/swing/j_panel.rb
+  - lib/swing/j_scroll_pane.rb
+  - lib/swing/j_split_pane.rb
+  - lib/swing/j_table.rb
+  - lib/swing/old/button.rb
+  - lib/swing/old/check_box.rb
+  - lib/swing/old/frame.rb
+  - lib/swing/old/label.rb
+  - lib/swing/old/list.rb
+  - lib/swing/old/menu.rb
+  - lib/swing/old/menu_bar.rb
+  - lib/swing/old/menu_item.rb
+  - lib/swing/old/panel.rb
+  - lib/swing/old/scroll_pane.rb
+  - lib/swing/old/split_pane.rb
+  - lib/swing/old/table.rb
+  - lib/swing_support/action_listener.rb
+  - lib/swing_support/extensions.rb
+  - lib/swing_support/extensions/attr_setter.rb
+  - lib/swing_support/extensions/attributes.rb
   - spec/spec_helper.rb
   - spec/swing_spec.rb
+  - spec/awt/component_spec.rb
+  - spec/swing/j_button_spec.rb
   - features/swing.feature
   - features/step_definitions/swing_steps.rb
   - features/support/env.rb
@@ -119,6 +137,7 @@ signing_key:
 specification_version: 3
 summary: Straightforward wrappers for javax.swing Components
 test_files: 
-  - spec/button_spec.rb
   - spec/spec_helper.rb
   - spec/swing_spec.rb
+  - spec/awt/component_spec.rb
+  - spec/swing/j_button_spec.rb