ruby_mvc 0.0.0

data/lib/ruby_mvc/toolkit/peers/wxruby.rb

@@ -0,0 +1,31 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     wxruby.rb
+# Created:  Wed 23 Nov 2011 10:35:20 GMT
+#
+#####################################################################
+#++ 
+
+require 'wx'
+
+require 'ruby_mvc/toolkit/peers/wxruby/common'
+require 'ruby_mvc/toolkit/peers/wxruby/app'
+require 'ruby_mvc/toolkit/peers/wxruby/frame'
+require 'ruby_mvc/toolkit/peers/wxruby/web_view'

data/lib/ruby_mvc/toolkit/peers/wxruby/app.rb

@@ -0,0 +1,44 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     app.rb
+# Created:  Wed 23 Nov 2011 11:53:28 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+  module Toolkit
+    module WxRuby
+      class App < Wx::App
+        Toolkit::App.peer_class = self
+
+        def initialize(&block)
+          super
+          @block = block
+          main_loop
+        end
+    
+        def on_init
+          @block.call
+        end
+      end
+    end
+  end
+end

data/lib/ruby_mvc/toolkit/peers/wxruby/box_layout.rb

@@ -0,0 +1,48 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     box_layout.rb
+# Created:  Wed 23 Nov 2011 13:41:15 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+  module Toolkit
+    module WxRuby
+      class BoxLayout 
+        Toolkit::BoxLayout.peer_class = self
+
+        def initialize(options)
+          @options = options
+          case(options[:axis])
+          when :horizontal, :x, :x_axis
+            @widget = Wx::BoxSizer.new(Wx::HORIZONTAL)
+          else
+            @widget = Wx::BoxSizer.new(Wx::VERTICAL)
+          end
+        end
+
+        def add(child, options = {})
+          @widget.add
+        end
+      end
+    end
+  end
+end

data/lib/ruby_mvc/toolkit/peers/wxruby/common.rb

@@ -0,0 +1,72 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     common.rb
+# Created:  Wed 23 Nov 2011 10:46:35 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+  module Toolkit
+    module WxRuby
+
+      # This method is a hack to deal with the parenting
+      # issues around the way wxWindows requires a parent for
+      # all child windows, and other toolkits don't.
+
+      def self.default_parent
+        @@parent ||= 1
+        if 1 == @@parent
+          @@parent = Wx::Frame.new(nil, :size => [40, 40])
+          class << @@parent 
+            def should_prevent_app_exit
+              false
+            end
+          end
+        end
+        @@parent
+      end
+
+      # This method is used to retrieve the parent window from
+      # the options, or it will use the default parent window.
+
+      def self.parent(options = {})
+        if (p = options[:parent]) && (p = p.peer)
+          p
+        else
+          default_parent
+        end
+      end
+          
+      # This module has some common things that map between
+      # controls in the WxRuby universe
+
+      module Common
+        def title
+          get_title
+        end
+
+        def title=(title)
+          set_title(title)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_mvc/toolkit/peers/wxruby/frame.rb

@@ -0,0 +1,49 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     frame.rb
+# Created:  Wed 23 Nov 2011 10:46:44 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+  module Toolkit
+    module WxRuby
+      class Frame < Wx::Frame
+        include Common
+        Toolkit::Frame.peer_class = self
+
+        def initialize(options)
+          opts = {}
+          opts[:title] = options[:title]
+          opts[:size] = [ options[:width], options[:height] ]
+          super(options[:parent], opts)
+        end
+
+        # This method is used to add a child to the existing
+        # frame.
+
+        def add(child, options = {})
+          child.peer.reparent(self)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_mvc/toolkit/peers/wxruby/web_view.rb

@@ -0,0 +1,87 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     html_view.rb
+# Created:  Wed 23 Nov 2011 12:43:10 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+  module Toolkit
+    module WxRuby
+      class WebView < Wx::HtmlWindow
+        include Toolkit::SignalHandler
+        include Common
+        Toolkit::WebView.peer_class = self
+
+        def initialize(options = {}, &block)
+          super(WxRuby.parent(options))
+          set_background_colour(Wx::WHITE)
+        end
+
+        attr_reader :location
+
+        def can_go_back?
+          history_can_back
+        end
+
+        def can_go_forward?
+          history_can_forward
+        end
+
+        def go_back
+          history_back
+        end
+
+        def go_forward
+          history_forward
+        end
+
+        def open(uri)
+          @location = uri
+          load_page(uri)
+        end
+
+        def stop_loading
+          # apparently, we can't do this
+        end
+
+        def reload
+          open(location)
+        end
+
+        def load_html(html, base_uri = nil)
+          # FIXME: this isn't quite right...
+          set_page(html)
+          @location = base_uri
+        end
+
+        #--
+        # wxRuby event handlers
+        #++
+
+        def on_link_clicked(link)
+          signal_emit("navigation-requested", self, link.href, link.target)
+        end
+
+      end
+    end
+  end
+end

data/lib/ruby_mvc/toolkit/web_view.rb

@@ -0,0 +1,60 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     web_view.rb
+# Created:  Wed 23 Nov 2011 12:54:26 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+  module Toolkit
+ 
+    # This class provides a web/HTML view whose API is
+    # modelled on WebKit
+
+    class WebView < Widget
+      api_method :load_html
+      api_methods :can_go_back?, :go_back
+      api_methods :can_go_forward?, :go_forward
+      api_methods :open, :reload, :go_home, :location
+      api_methods :stop_loading, :is_loading?
+
+      # This signal is emitted when the user requests
+      # navigation to another web resource.
+
+      signal "navigation-requested", :vetoable => true
+
+      # This signal is emitted when the title of the content
+      # in the view changes
+
+      signal "title-changed"
+
+      # This signal is emitted when the page begins to load
+
+      signal "load-started"
+
+      # This signal is emitted when the page load has
+      # completed.
+
+      signal "load-finished"
+    end
+
+  end
+end

data/lib/ruby_mvc/toolkit/widget.rb

@@ -0,0 +1,108 @@
+#--
+######################################################################
+#
+# Copyright 2011 Andrew S. Townley
+#
+# Permission to use, copy, modify, and disribute this software for
+# any purpose with or without fee is hereby granted, provided that
+# the above copyright notices and this permission notice appear in
+# all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL
+# WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL THE
+# AUTHORS BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT OR
+# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+# CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+# File:     widget.rb
+# Created:  Wed 23 Nov 2011 10:34:52 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+  module Toolkit
+  
+    # This class defines the base toolkit widget class.  Each
+    # widget has one - and only one - UI peer that is
+    # registered automatically when the UI peer is loaded.
+
+    class Widget
+      include SignalHandler
+      extend SignalHandler::ClassMethods
+
+      class << self
+        attr_accessor :peer_class
+
+        # This method is used to manage the API methods
+        # available to the toolkit widgets.  Methods listed
+        # here will be forwarded to the peer class if they
+        # aren't defined by the toolkit widget subclass.
+
+        def api_methods(*args)
+          if !@api
+            @api = []
+            if self.superclass.respond_to? :api_methods
+              @api.concat(self.superclass.api_methods)
+            end
+          end
+          @api.concat(args) if args.size > 0
+          @api
+        end
+        alias :api_method :api_methods
+      end
+
+      attr_reader :peer
+      api_methods :show, :hide
+
+      def initialize(*args, &block)
+        if pc = self.class.peer_class
+          @peer = pc.new(*args, &block)
+          connect_peer_signals
+        else
+          raise RuntimeError, "no peer class registered for #{self.class}"
+        end
+      end
+
+      # This method will forward only those registered API
+      # methods to the peer class.  Doing it this way ensures
+      # that we don't leak APIs from the peers into
+      # applications, but that we can still be efficient in
+      # how we manage the implementations.
+      #
+      # FIXME: there may be performance implications...
+
+      def method_missing(method, *args, &block)
+        if (self.class.api_methods || []).include? method
+          @peer.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+    protected
+
+      # This method is used to ensure that the signals defined
+      # for the widget are appropriately connected to the new
+      # peer instance when it's created.
+      #
+      # The normal mechanism is to simply forward the signal
+      # to the registered listeners on the toolkit widget.  It
+      # is assumed that the peer classes send the appropriate
+      # arguments to the signal handlers.
+
+      def connect_peer_signals
+        self.class.signals.each do |s, opts|
+          puts "connecting signal '#{s}' to #{peer}"
+          peer.signal_connect(s) do |*args|
+            args[0] = self
+            signal_emit(s, *args)
+          end
+        end
+      end
+    end
+  end
+end