freightrain 0.5.9

data/README

@@ -0,0 +1,4 @@
+== freightrain
+
+DEV ALPHA
+testing

data/Rakefile

@@ -0,0 +1,33 @@
+
+require 'rubygems'
+require 'spec/rake/spectask'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'freightrain'
+  s.version = '0.5.9'
+  s.add_dependency('require_all', '>= 1.1.0')
+  s.add_dependency('needle', '>= 1.3.0')  
+  s.has_rdoc = false
+  s.summary = 'ruby desktop development made easy'
+  s.description = s.summary
+  s.author = 'Andrea Dallera'
+  s.email = 'andrea@andreadallera.com'
+  s.files = %w(README Rakefile) + Dir.glob("{bin,lib}/**/*")
+  s.require_path = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+  t.spec_files = FileList['spec/**/*.rb']
+end

data/lib/extensions/gtk/dialog_helper.rb

@@ -0,0 +1,50 @@
+
+module Freightrain
+
+  module Toolkit
+
+    module DialogHelper
+
+      def open_file_dialog(description = "Open file...")
+        raise "toplevel not implemented. If you want to use " +
+               "DialogHelper inside your class you should provide " +
+               "a toplevel widget via the toplevel method" unless respond_to? :toplevel
+        dialog = Gtk::FileChooserDialog.new(description,
+                                            toplevel,
+                                            Gtk::FileChooser::ACTION_OPEN,
+                                            nil,
+                                            [Gtk::Stock::CANCEL, Gtk::Dialog::RESPONSE_CANCEL],
+                                            [Gtk::Stock::OPEN, Gtk::Dialog::RESPONSE_ACCEPT])
+        if dialog.run == Gtk::Dialog::RESPONSE_ACCEPT
+          result = dialog.filename
+        end
+        dialog.destroy
+        return result
+      end
+
+      def yes_no_dialog(description, title = "Warning!", secondary_text = "It will not be possible to recover the deleted item")
+        raise "toplevel not implemented. If you want to use " +
+               "DialogHelper inside your class you should provide " +
+               "a toplevel widget via the toplevel method" unless respond_to? :toplevel
+          result = false
+          dialog = Gtk::MessageDialog.new(
+          toplevel,
+          Gtk::Dialog::MODAL,
+          Gtk::MessageDialog::QUESTION,
+          Gtk::MessageDialog::BUTTONS_YES_NO,
+          description)
+          dialog.title = title
+          dialog.secondary_text = secondary_text
+          dialog.run do |response|
+              result = (response == Gtk::Dialog::RESPONSE_YES)
+          end
+          dialog.destroy
+          return result
+
+      end
+
+    end #DialogHelper
+
+  end #Toolkit
+
+end #Freightrain

data/lib/extensions/gtk/gtk_bootstrapper.rb

@@ -0,0 +1,32 @@
+
+#TODO: use require all
+
+require 'libglade2'
+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__) + "/interface_builder.rb"
+require File.dirname(__FILE__) + "/dialog_helper.rb"
+
+module Freightrain
+  
+  module Toolkit
+
+    def self.start_main_loop
+      yield
+      Gtk.main
+    end
+
+    def self.quit
+      Gtk.main_quit
+    end
+
+  end
+
+end

data/lib/extensions/gtk/interface_builder.rb

@@ -0,0 +1,54 @@
+
+module Freightrain
+
+  module Toolkit
+
+    class InterfaceBuilder
+
+      def initialize
+        @builder = Gtk::Builder.new
+      end
+
+      def file_found?(file_name)
+        return get_glade_file(file_name)
+      end
+
+      def create_objects_from_file(file_name)
+        @builder.add_from_file(get_glade_file(file_name))
+        @control = @builder.objects.first.toplevel
+        return @builder.objects.select do
+          |obj| obj.respond_to?(:name)
+        end.map
+      end
+
+      def create_object_accessors(widgets, view)
+        widgets.each do |widget|
+          name = widget.name
+          view.instance_eval "def #{name}; @widgets.select { |w| w.name == '#{name}'  }.first ;end;"
+        end
+      end
+
+      def connect_signals()
+        @builder.connect_signals do |signal|
+          yield(signal)
+        end
+      end
+
+      def get_glade_file(file_name)
+        search_path = File.join(
+          Freightrain.app_path,
+          "views",
+          "**",
+          file_name.to_convention + ".glade")
+        results = Dir.glob(search_path)
+        return results.first
+      end
+
+      def control
+        return @control
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,18 @@
+
+module Gtk
+
+  class Calendar
+
+    def date
+      return DateTime.civil(self.year, self.month + 1, self.day)      
+    end
+
+    def date=(val)
+      self.day   = val.day
+      self.month = val.month - 1
+      self.year  = val.year
+    end
+    
+  end
+end
+

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

@@ -0,0 +1,41 @@
+
+module Gtk
+
+  class ComboBox
+
+    def elements=(enumerable)
+      list_store = Gtk::ListStore.new(::Object, String)
+      enumerable.each do |item|
+        iterator = list_store.append        
+        iterator[0] = item
+        iterator[1] = item.send(@text)
+      end
+      self.model = list_store
+    end
+
+    def selected
+      iter = self.active_iter
+      return iter[0] if iter
+    end
+
+    def selected=(object)
+      if self.model
+        self.model.each do |model, path, iter|
+          self.active_iter = iter if iter[0] == object
+        end
+      end
+    end
+
+    def bind(options)
+      if options[:property].to_sym == :elements
+        @path = options[:path]
+        @text = options[:text] || "to_s"
+        renderer = Gtk::CellRendererText.new
+        self.pack_start(renderer, true)
+        self.add_attribute(renderer,:text, 1)
+      end
+      super(options)
+    end
+
+  end
+end

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

@@ -0,0 +1,14 @@
+
+module Gtk
+
+  class Image
+
+    def image=(value)
+      file = File.new(File.join(Dir.tmpdir,"tempimg#{self.object_id.to_s}"),'w')
+      file << value
+      file.close
+      self.pixbuf = Gdk::Pixbuf.new(File.join(Dir.tmpdir,"tempimg#{self.object_id.to_s}"))
+    end
+    
+  end
+end

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

@@ -0,0 +1,99 @@
+
+module Gtk
+
+  class Layout
+    include Freightrain::LayoutWidget
+
+    attr_writer :viewmodel
+    attr_reader :elements
+
+    def initialize
+      super
+      
+    end
+
+    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
+
+    #TODO:remove
+    def default_display_logic(elements, enumerable)
+      #TODO: clean this mess        
+      height = elements.length
+      delta = enumerable.length - elements.length
+      delta.abs.times do
+        if delta > 0
+          item = self.get_new_item
+          self.put(item.control, 0, item.control.height_request * height)
+          elements << item
+          height += 1
+        else
+          item = self.children.last
+          self.remove(item)
+          elements.delete_if {|element| element.control == item }
+        end
+      end
+      height_factor = self.get_new_item.control.height_request
+      self.height = elements.length * height_factor
+      (0...elements.length).each do |index|
+        elements[index].value = enumerable[index]
+      end
+    end
+
+    def display_logic(enumerable)
+      if @display_logic
+        @display_logic.call(self, @elements, enumerable)
+      else
+        default_display_logic(@elements, enumerable)
+      end
+    end
+
+    def set_display_logic
+      @display_logic = lambda do |widget, elements, enumerable|
+        yield(widget, elements, enumerable)
+      end
+    end
+
+    def elements=(enumerable)
+      setup unless @ready      
+      display_logic(enumerable)      
+    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 bind(options)
+      if options[:property].to_s == "elements"
+        @viewmodel          = (options[:element].to_s + "_element_view_model").to_sym
+        options[:force]     = true
+      end
+      super(options)
+    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
+      
+  end
+
+end

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

@@ -0,0 +1,13 @@
+
+#HACK: think of a better way to do this
+
+module Gtk
+
+  class ToggleButton
+
+    def active
+      return active?
+    end
+
+  end
+end

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

@@ -0,0 +1,11 @@
+
+module Gtk
+
+  class ToggleToolButton
+
+    def active
+      return active?
+    end
+    
+  end
+end

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

@@ -0,0 +1,80 @@
+
+module Gtk
+
+  class TreeView
+
+    def create_column(column_definition)
+      renderer   = Gtk::CellRendererText.new
+      title      = column_definition.keys.first
+      attributes = {}
+      column_definition.values.first.each do |binding|
+        attributes[binding["property"]] = @paths[binding["path"]]
+      end
+      column     = Gtk::TreeViewColumn.new(title, renderer, attributes)
+      self.append_column column
+    end
+
+    def bind(options)
+      if options[:property].to_sym == :elements
+        columns = normalize_column_bindings(options[:columns])
+        @paths  = get_paths(columns)
+        columns.each do |column|
+          create_column(column)
+        end
+      end
+      super(options)
+    end
+
+    def elements=(enumerable)
+      types = [::Object]
+      @paths.length.times do
+        types << String #TODO: allow for different types
+      end
+      list_store = Gtk::ListStore.new(*types)
+      enumerable.each do |item|
+        iterator = list_store.append
+        iterator[0] = item
+        @paths.each do |key, index|
+          iterator[index] = item.send(key).to_s
+        end
+      end
+      self.model = list_store
+    end
+
+    private
+    def normalize_column_bindings(columns)
+      result = []
+      #step 1 : turn name/values only into arrays with 1 path
+      columns.each do |col|
+        unless col.values.first.kind_of?(Array)
+          result << {col.keys.first => [{"path" => col.values.first}]}
+        else
+          result << col
+        end
+      end
+      #step 2 : add property key if not present
+      result.each do |col|
+        col.values.first.each do |bindings|
+          unless bindings["property"]
+            bindings["property"] = "text"
+          end
+        end
+      end
+      return result
+    end
+
+    def get_paths(columns)
+      paths = {}
+      columns.each do |column|
+        column.values.each do |binding|
+          binding.each do |definition|
+            paths[definition["path"]] = paths.length + 1 unless paths[definition["path"]]
+          end
+        end
+      end
+      return paths
+    end
+
+  end
+  
+end

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

@@ -0,0 +1,29 @@
+
+
+module Gtk
+
+  class TreeViewColumn
+
+    attr_accessor :path
+
+    attr_writer   :property
+    attr_writer   :type
+
+    def type
+      return @type if @type
+      return String
+    end
+
+    def property
+      return @property if @property
+      return :text
+    end
+
+
+
+
+
+
+  end
+
+end

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

@@ -0,0 +1,47 @@
+
+module Gtk
+
+  class Widget
+
+    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
+
+    def color_from_rgb(string)
+      red   = ((string[0..1].hex.to_i + 1) * 256) - 1
+      green = ((string[2..3].hex.to_i + 1) * 256) - 1
+      blue  = ((string[4..5].hex.to_i + 1) * 256) - 1
+      return Gdk::Color.new(red, green, blue)
+    end
+
+    def background=(color)
+      self.modify_bg(Gtk::STATE_NORMAL, color_from_rgb(color))
+    end
+
+    def foreground=(color)
+      self.modify_fg(Gtk::STATE_NORMAL, color_from_rgb(color))
+    end
+
+    def base_background=(color)
+      self.modify_base(Gtk::STATE_NORMAL, color_from_rgb(color))
+    end
+
+    def plug_in(region_widget)
+      self.remove(self.children.first) unless self.children.empty?
+      self << region_widget
+    end
+
+
+  end
+
+
+end

data/lib/freightrain/auto_requirer.rb

@@ -0,0 +1,24 @@
+
+module Freightrain
+
+  def self.auto_require!
+
+    views_folder      = self.views_path
+    viewmodels_folder = File.join(self.app_path, "viewmodels")
+    services_folder   = File.join(self.app_path, "services")
+    domain_folder     = File.join(self.app_path, "domain")
+
+    require_all views_folder
+    require_all viewmodels_folder
+
+    if File.directory?(services_folder) && Dir.entries(services_folder).length > 2
+      require_all services_folder
+    end
+    
+    if File.directory?(domain_folder) && Dir.entries(domain_folder).length > 2
+      require_all domain_folder
+    end
+    
+  end
+  
+end

data/lib/freightrain/binding/binding_host.rb

@@ -0,0 +1,35 @@
+
+module Freightrain
+
+  module BindingHost
+
+    def load_bindings_from_file(widgets)      
+      loader = BindingLoader.new(self.class.name)      
+      loader.each_binding do |widget_name, options|
+        widget = widgets.select { |widget| widget.name == widget_name }.first
+        widget.bind(options) if widget
+      end
+    end
+    
+    def data_source=(source)
+      bindings.each do |binding|
+        binding.data_source = source
+        binding.update
+      end
+    end
+    
+    def bindings
+      return widgets.each.map { |widget| widget.bindings }.flatten
+    end
+
+    def commit
+      bindings.each { |binding| binding.commit }
+    end
+
+    def update
+      bindings.each { |binding| binding.update}
+    end
+
+  end
+
+end

data/lib/freightrain/binding/binding_loader.rb

@@ -0,0 +1,36 @@
+
+require 'yaml'
+
+module Freightrain
+
+  class BindingLoader
+    
+    def initialize(class_name)      
+      @search_path = File.join(
+        Freightrain.views_path,
+        "**",
+        class_name.to_convention + ".bnd.yml")      
+    end
+
+    def filename
+      result = Dir.glob(@search_path)
+      return result[0] || nil
+    end
+
+    def each_binding
+      return nil unless filename
+      binding_collection = YAML.load_file(filename) || []
+      binding_collection.each do |widget, binding|
+        binding = [binding] if binding.kind_of? Hash #needed if only 1 binding declared
+        binding.each do |binding_options|
+          options = {}
+          binding_options.each do |key, value|
+            options[key.to_sym] = value
+          end
+          yield(widget, options)
+        end        
+      end
+    end
+
+  end
+end

data/lib/freightrain/binding/converters/boolean_converter.rb

@@ -0,0 +1,15 @@
+
+module Freightrain
+
+  class BooleanConverter
+
+    def from(val)
+      return val != nil
+    end
+
+    def to(val)
+      return val == true #dummy
+    end
+
+  end
+end

data/lib/freightrain/binding/converters/converter_factory.rb

@@ -0,0 +1,22 @@
+
+module Freightrain
+
+  class ConverterFactory
+
+    def self.create(converter_name)
+      name = converter_name.to_s.capitalize
+      #first try to get one of the standard converters
+      if Freightrain.const_defined? "#{name}Converter"
+        return Freightrain.const_get("#{name}Converter").new
+      end
+      #then, if not found, try to get a registered custom converter
+      begin
+        return Freightrain["#{name}Converter".to_convention_sym]
+      rescue
+        return nil
+      end
+    end
+
+  end
+
+end

data/lib/freightrain/binding/converters/default_converter.rb

@@ -0,0 +1,16 @@
+
+module Freightrain
+  
+  class DefaultConverter
+
+      def from(value)
+        return value
+      end
+
+      def to(value)
+        return value
+      end
+
+  end
+
+end