freightrain 0.6.4 → 0.6.5

data/README.rdoc

@@ -8,10 +8,13 @@ Freightrain is a MVVM (model/view/viewmodel) framework for developing desktop ap
 == HOW DO I GET IT?
 	gem install freightrain
 
-(also make sure you have the latest ruby/gnome2 bindings installed (=> 0.19.3) ) 
+(also make sure you have the latest ruby/gnome2 bindings installed (=> 0.19.4) ) 
+WARNING! As of ruby/gnome2 0.19.4, the accessor "name", which freightrain depends on, is removed from Gtk::Widget.
+Long story short: you should get the latest version from the ruby/gnome2 svn. At the moment the problem is fixed in the ruby/gnome2 trunk. 
 
 == HOW DO I USE IT?
 For now, you should take a look at http://github.com/bolthar/rubydraulica
+(broken - callback handling doesn't work like that anymore. doc coming really really soon)
 
 Note that the project is currently in ALPHA state. Use it in production at your own risk :-) 
 

data/Rakefile

@@ -9,7 +9,7 @@ require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'freightrain'
-  s.version = '0.6.4'
+  s.version = '0.6.5'
   s.add_dependency('require_all', '>= 1.1.0')
   s.add_dependency('needle', '>= 1.3.0')  
   s.has_rdoc = false

data/lib/extensions/gtk/gtk_bootstrapper.rb

@@ -1,21 +1,19 @@
 
 #TODO: use require all
-#TODO: use File.join for god's sake!
 
 require 'libglade2'
-require File.dirname(__FILE__) + "/binding_base.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_image.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_toggle_button.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_toggle_tool_button.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_widget.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_combo_box.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_calendar.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_treeview.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_treeviewcolumn.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_layout.rb"
-require File.dirname(__FILE__) + "/widgets/gtk_statusicon.rb"
-require File.dirname(__FILE__) + "/interface_builder.rb"
-require File.dirname(__FILE__) + "/dialog_helper.rb"
+require File.join(File.dirname(__FILE__), "widgets/gtk_image.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_toggle_button.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_toggle_tool_button.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_widget.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_combo_box.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_calendar.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_treeview.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_treeviewcolumn.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_layout.rb")
+require  File.join(File.dirname(__FILE__), "widgets/gtk_statusicon.rb")
+require  File.join(File.dirname(__FILE__), "interface_builder.rb")
+require  File.join(File.dirname(__FILE__), "dialog_helper.rb")
 
 module Freightrain
   

data/lib/extensions/gtk/widgets/gtk_layout.rb

@@ -7,11 +7,6 @@ module Gtk
     attr_writer :viewmodel
     attr_reader :elements
 
-    def initialize
-      super
-      
-    end
-
     def setup
       @signals ||= {}
       selected_callback   = @signals[:selected]

data/lib/extensions/gtk/widgets/gtk_widget.rb

@@ -2,7 +2,7 @@
 module Gtk
 
   class Widget
-    include BindingBase
+    include Freightrain::BindingBase
 
     def color_from_rgb(string)
       red   = ((string[0..1].hex.to_i + 1) * 256) - 1

data/lib/extensions/qt/dialog_helper.rb

@@ -0,0 +1,19 @@
+
+
+module Freightrain
+  module Toolkit
+
+    module DialogHelper
+
+      def open_file_dialog(description = "Open file...")
+        raise "not implemented"
+      end
+
+      def yes_no_dialog(description, title = "Warning!", secondary_text = "It will not be possible to recover the deleted item")
+        raise "not implemented"
+      end
+        
+    end
+
+  end
+end

data/lib/extensions/qt/interface_builder.rb

@@ -0,0 +1,76 @@
+
+module Freightrain
+
+  module Toolkit
+
+    class InterfaceBuilder
+
+      attr_reader :toplevel
+
+      def initialize
+        @builder = Qt::UiLoader.new
+      end
+
+      def file_found?(file_name)
+        return get_ui_files(file_name)
+      end
+
+      def create_objects_from_file(file_name)
+        file = Qt::File.new(get_ui_files(file_name))
+        file.open(Qt::File::ReadOnly)
+        @toplevel = @builder.load(file)
+        file.close
+        widgets = get_all_objects(@toplevel).select do |widget|
+          widget.objectName && widget.objectName != ""
+        end.map
+        return widgets
+      end
+
+      def create_object_accessors(widgets, view)
+        widgets.each do |widget|
+          name = widget.objectName
+          view.instance_eval "def #{name}; @widgets.select { |w| w.objectName == '#{name}'  }.first ;end;"
+        end
+      end
+
+      def connect_to_callback(widget, event_name, method)
+        begin
+        decoy_class = Class.new(Qt::Widget)
+        decoy_class.slots("#{widget.name}()")
+        decoy_class.send(:define_method, widget.name) do |*args|
+          method.call(*args)
+        end
+        decoy = decoy_class.new        
+        widget.connect(SIGNAL(widget.get_event_signature(event_name)), decoy, widget.name.to_sym)
+        rescue Exception => ex
+#          p ex
+        end
+      end
+
+      def get_ui_files(file_name)
+        search_path = File.join(
+          Freightrain.app_path,
+          "views",
+          "**",
+          file_name.to_convention + ".ui")
+        results = Dir.glob(search_path)
+        return results.first
+      end
+
+      def control
+        return @toplevel
+      end
+
+      private
+      def get_all_objects(parent, objects = [])
+        objects << parent
+        parent.children.each do |child|
+          get_all_objects(child, objects)
+        end
+        return objects
+      end
+
+    end
+
+  end
+end

data/lib/extensions/qt/qt_bootstrapper.rb

@@ -0,0 +1,24 @@
+
+require 'Qt4'
+require 'qtuitools'
+require File.join(File.dirname(__FILE__), "widgets/qt_base.rb")
+require File.join(File.dirname(__FILE__), "widgets/qt_widget.rb")
+require File.join(File.dirname(__FILE__), "widgets/qt_abstract_button.rb")
+require File.join(File.dirname(__FILE__), "widgets/qt_line_edit.rb")
+require File.join(File.dirname(__FILE__), "widgets/qt_label.rb")
+require File.join(File.dirname(__FILE__), "interface_builder.rb")
+require File.join(File.dirname(__FILE__), "dialog_helper.rb")
+
+module Freightrain
+
+  module Toolkit
+
+    def self.start_main_loop
+      app = Qt::Application.new([])
+      yield
+      app.exec
+    end
+    
+  end
+
+end

data/lib/extensions/qt/widgets/qt_abstract_button.rb

@@ -0,0 +1,12 @@
+
+module Qt
+
+  class AbstractButton
+
+    def signals
+      base_list = super
+      base_list[:toggled] = "toggled(bool)"
+    end
+
+  end
+end

data/lib/extensions/qt/widgets/qt_base.rb

@@ -0,0 +1,27 @@
+
+module Qt
+
+  class Base
+    include Freightrain::BindingBase
+
+    def plug_in(region_widget)
+      region_widget.setParent(self)
+      region_widget.show
+    end
+
+    def name
+      return self.objectName
+    end
+
+    def signals
+      return {}
+    end
+
+    def get_event_signature(event_name)
+      return signals[event_name.to_sym] || "#{event_name}()"
+    end
+    
+  end
+
+end
+

data/lib/extensions/qt/widgets/qt_label.rb

@@ -0,0 +1,18 @@
+
+
+module Qt
+
+  class Label
+
+    def image=(value)
+      file = ::File.new(::File.join(::Dir.tmpdir,"tempimg#{self.object_id.to_s}"),'w')
+      file << value
+      file.close
+      image = Qt::Image.new(::File.join(::Dir.tmpdir,"tempimg#{self.object_id.to_s}"))
+      self.pixmap = image
+      self.resize(self.pixmap.size)
+    end
+    
+  end
+
+end

data/lib/extensions/qt/widgets/qt_line_edit.rb

@@ -0,0 +1,13 @@
+
+module Qt
+
+  class LineEdit
+
+    def signals
+      base_list = super
+      base_list[:textChanged] = "textChanged(QString)"
+      base_list[:textEdited] = "textEdited(QString)"
+      return base_list
+    end
+  end
+end

data/lib/extensions/qt/widgets/qt_widget.rb

@@ -0,0 +1,85 @@
+
+module Qt
+
+  class Widget
+    include Freightrain::LayoutWidget
+    
+    def setup
+      @signals ||= {}
+      selected_callback   = @signals[:selected]
+      @signals[:selected] = lambda do |value|
+                              elements.each do |item|
+                                item.set_selection(item.value == value)
+                              end
+                              selected_callback.call(value) if selected_callback
+                            end
+      @elements ||= []
+      @ready = true
+    end
+
+    def elements=(enumerable)
+      setup unless @ready
+      delta = enumerable.length - @elements.length
+      @height_factor = self.get_new_item.control.height unless @height_factor
+      height = @elements.length
+      delta.abs.times do
+        if delta > 0
+          item = self.get_new_item
+          item.control.geometry = Qt::Rect.new(
+            0,
+            item.control.height * height,
+            item.control.width,
+            item.control.height
+          )
+          item.control.setParent(self)
+          item.control.show
+          @elements << item
+          height += 1
+        else
+          item = self.children.last
+          item.control.setParent(nil)
+          @elements.delete_if {|element| element.control == item }
+          item.control = nil
+        end
+      end
+      self.setMinimumHeight(@elements.length * @height_factor)
+      self.show
+      @elements.each do |element|
+        element.value = enumerable[@elements.index(element)]
+      end
+    end
+
+    def elements()
+      return @elements
+    end
+
+    def selected
+      return @elements.select { |element| element.selected == true}.first
+    end
+
+    def selected=(val)
+      @elements.each do |element|
+        element.set_selection(val == element.value)
+      end
+    end
+
+    def get_new_item
+      item = Freightrain[@viewmodel]
+      item.signals.each do |key, signal|
+        signal.connect(@signals[key]) if @signals[key]
+      end
+      return item
+    end
+
+    def bind(options)
+      if options[:property].to_sym == :elements
+        @viewmodel          = (options[:element].to_s + "_element_view_model").to_sym
+        @signals            = options[:signals]
+        options[:force]     = true
+      end
+      super(options)
+    end
+
+  end
+
+end

data/lib/freightrain/binding/binding_base.rb

@@ -0,0 +1,19 @@
+
+module Freightrain
+  module BindingBase
+
+    def bind(binding_options)
+      @bindings ||= {}
+      binding = FreightBinding.new(self, binding_options)
+      #TODO: send out warning on override?
+      @bindings[binding_options[:property]] = binding
+      return binding
+    end
+
+    def bindings
+      @bindings ||= {}
+      return @bindings.values
+    end
+
+  end
+end

data/lib/freightrain/binding/binding_host.rb

@@ -14,7 +14,7 @@ module Freightrain
     def data_source=(source)
       bindings.each do |binding|
         binding.data_source = source
-        binding.update
+        binding.update #TODO: is this necessary?
       end
     end
     
@@ -27,9 +27,9 @@ module Freightrain
     end
 
     def update
-      bindings.each { |binding| binding.update}
+      bindings.each { |binding| binding.update }
     end
 
   end
-
+  
 end

data/lib/freightrain/binding/binding_loader.rb

@@ -17,6 +17,7 @@ module Freightrain
       return result[0] || nil
     end
 
+    #TODO: refactor, this needs a little cleanup, method does too much
     def each_binding
       return nil unless filename
       binding_collection = YAML.load_file(filename) || []

data/lib/freightrain/binding/freight_binding.rb

@@ -6,11 +6,11 @@ module Freightrain
     attr_accessor :data_source
 
     def initialize(widget, options)
-      @cache          = :__NOVALUE
+      @cache          = :__NOVALUE #TODO: this is necessary but really ugly - evaluate a possible replacement
       @widget         = widget
       @property       = options[:property].to_s.split('.')
       @path           = options[:path].to_s.split('.')
-      @converter      = ConverterFactory.create(options[:converter]) || DefaultConverter.new
+      @converter      = ConverterFactory.create(options[:converter]) || DefaultConverter.new #TODO: if in converterfactory?
       @force          = options[:force]
     end
 
@@ -21,10 +21,10 @@ module Freightrain
           set(@property, @converter.from(value), @widget)
           @cache = value
         end
-      rescue Exception => ex
-#        p "#{@widget.name} - update"
-#        p ex.message
-#        p @path
+      rescue Exception => ex #TODO: logger...
+        p "#{@widget.name} - update"
+        p ex.message
+        p @path
       end
     end
 
@@ -32,13 +32,14 @@ module Freightrain
       begin
         value = get(@widget, @property)
         set(@path, @converter.to(value), data_source)
-      rescue Exception => ex
+      rescue Exception => ex #TODO: logger...
 #        p "#{@widget.name} - commit"
 #        p ex.message
 #        p @path
       end
     end
 
+    #TODO: find a way not to raise except when absolutely necessary
     private
     def get(source, path)
       my_path = path.clone
@@ -47,6 +48,7 @@ module Freightrain
       get(source.send(target), my_path)
     end
 
+    #TODO: find a way not to raise except when absolutely necessary
     def set(path, value, source)
       my_path = path.clone
       return source.send(my_path[0].to_s + "=",value) if my_path.length == 1

data/lib/freightrain/elements/freight_element_view.rb

@@ -1,6 +1,7 @@
 
 module Freightrain
 
+  #TODO: make this an extension or even remove it
   class FreightElementView < FreightView
     extend ContainerHookable
 

data/lib/freightrain/elements/freight_element_view_model.rb

@@ -1,6 +1,7 @@
 
 module Freightrain
 
+  #TODO: make this an extension
   class FreightElementViewModel < FreightViewModel
     extend ContainerHookable
 

data/lib/freightrain/elements/layout_widget.rb

@@ -1,4 +1,5 @@
 
+#TODO: remove this
 module Freightrain
   module LayoutWidget
     

data/lib/freightrain/regions/region_host.rb

@@ -5,6 +5,7 @@ module RegionHost
 
     klass.class_eval do
 
+      #TODO: too much stuff here
       def build_regions
         region_definitions = self.class.instance_variable_get(:@regions)
         region_definitions ||= []

data/lib/freightrain/services/freight_service.rb

@@ -8,6 +8,7 @@ module Freightrain
     #SINGLETONS by default. That means if you consume
     #the same service from two different hosts, the LAST
     #host hooking to the callback will actually get the calls.
+    #TODO: make it transient?
     extend SignalHost
 
     def initialize

data/lib/freightrain/services/service_host.rb

@@ -1,5 +1,4 @@
 
-
 module Freightrain
 
   module ServiceHost

data/lib/freightrain/signals/freight_signal.rb

@@ -1,6 +1,7 @@
 
 module Freightrain
 
+  #TODO: give this more responsibility
   class FreightSignal
 
     def fire(*args)

data/lib/freightrain/signals/signal_host.rb

@@ -1,5 +1,4 @@
 
-
 module Freightrain
 
   module SignalHost

data/lib/freightrain/string_patch.rb

@@ -1,6 +1,7 @@
 
 class String
 
+  #TODO: maybe activesupport has something like this
   def to_convention
     return "" if self.empty?
     clone = self.clone

data/lib/freightrain/views/callback_wrapper.rb

@@ -1,4 +1,5 @@
 
+#TODO: is this really necessary?
 class CallbackWrapper
 
   attr_reader :method

data/lib/freightrain/views/freight_view.rb

@@ -9,6 +9,7 @@ module Freightrain
 
 #    attr_reader :widgets
 
+    #TODO: CRITICAL make it toolkit-agnostic
     def widgets
       return @widgets.select { |widget| widget.kind_of? BindingBase }
     end

data/lib/scaffolding/scaffolding.rb

@@ -1,4 +1,5 @@
 
+#TODO: find a good templating system to import and ditch this hack
 require "rubygems"
 require "require_all"
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: freightrain
 version: !ruby/object:Gem::Version 
-  version: 0.6.4
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 5
+  version: 0.6.5
 platform: ruby
 authors: 
 - Andrea Dallera
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-11 00:00:00 +02:00
+date: 2010-05-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: require_all
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: needle
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: ruby desktop development made easy
 email: andrea@andreadallera.com
 executables: 
@@ -62,6 +75,7 @@ files:
 - lib/freightrain/binding/converters/default_converter.rb
 - lib/freightrain/binding/converters/converter_factory.rb
 - lib/freightrain/binding/freight_binding.rb
+- lib/freightrain/binding/binding_base.rb
 - lib/freightrain/binding/binding_loader.rb
 - lib/freightrain/binding/binding_host.rb
 - lib/freightrain/views/interface_builder.rb
@@ -84,8 +98,15 @@ files:
 - lib/freightrain/services/freight_service.rb
 - lib/freightrain/elements/freight_element_view.rb
 - lib/freightrain/elements/freight_element_view_model.rb
-- lib/freightrain/elements/element_extension.rb
 - lib/freightrain/elements/layout_widget.rb
+- lib/extensions/qt/widgets/qt_label.rb
+- lib/extensions/qt/widgets/qt_base.rb
+- lib/extensions/qt/widgets/qt_line_edit.rb
+- lib/extensions/qt/widgets/qt_abstract_button.rb
+- lib/extensions/qt/widgets/qt_widget.rb
+- lib/extensions/qt/interface_builder.rb
+- lib/extensions/qt/dialog_helper.rb
+- lib/extensions/qt/qt_bootstrapper.rb
 - lib/extensions/gtk/gtk_bootstrapper.rb
 - lib/extensions/gtk/widgets/gtk_calendar.rb
 - lib/extensions/gtk/widgets/gtk_toggle_button.rb
@@ -99,7 +120,6 @@ files:
 - lib/extensions/gtk/widgets/gtk_combo_box.rb
 - lib/extensions/gtk/interface_builder.rb
 - lib/extensions/gtk/dialog_helper.rb
-- lib/extensions/gtk/binding_base.rb
 - lib/freightrain.rb
 has_rdoc: true
 homepage: http://github.com/bolthar/freightrain
@@ -114,18 +134,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: ruby desktop development made easy

data/lib/extensions/gtk/binding_base.rb

@@ -1,17 +0,0 @@
-
-module BindingBase
-
-  def bind(binding_options)
-    @bindings ||= {}
-    binding = FreightBinding.new(self, binding_options)
-    #TODO: send out warning on override?
-    @bindings[binding_options[:property]] = binding
-    return binding
-  end
-
-  def bindings
-    @bindings ||= {}
-    return @bindings.values
-  end
-
-end

data/lib/freightrain/elements/element_extension.rb

@@ -1 +0,0 @@
-