ruby_mvc 0.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+######################################################################
+#
+# 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.
+#
+######################################################################

data/README.md

@@ -0,0 +1,69 @@
+
+README for Ruby MVC
+===================
+
+This project is based on previous work on [Shoes
+MVC](https://github.com/atownley/shoes_mvc), but now does not
+use the Shoes toolkit.  At the moment, it achieves a minimal set of
+cross-platform functionality based on using the wxRuby gem.  There are
+plans to make this change in the future, but right now, the goal is
+just to get something working.
+
+*NOTE:  this code is **highly experimental** and an early work
+in progress.  It may or may not ever be completed, and it may
+or may not ever be useful.*
+
+DEPENDENCIES
+============
+
+You'll need to have the following gems installed to use this library:
+
+ - activerecord (to use the Rails integration)
+ - tagz (for the HTML rendering)
+ - wxruby (use wxruby-ruby19 for Ruby 1.9)
+ - sqlite3 (to use the SQLite3 drivers)
+
+Platform Notes
+--------------
+
+There are some tweaks required using the library with various
+environments.  The known ones are highlighted below.
+
+### Ruby 1.8.7
+
+Apparently, there's a change in 1.8.7 that causes trouble with SWIG
+libraries: http://www.ruby-forum.com/topic/161876.  You may or may not
+hit this problem running 1.8.7, as it appears to be rather
+intermittent.
+
+
+### MacOS X
+
+If you're using this on a 64-bit version of OSX, you'll want to make
+sure you do the following when you're installing the dependency gems:
+
+    $ env ARCHFLAGS="-arch x86_64 -arch i686" gem install --no-ri --no-rdoc
+
+The above line will ensure that when you run in 32-bit mode for
+wxRuby, that things will all work as expected.
+
+Additionally, you might consider an alias like the following somewhere
+handy like .profile or .bashrc
+
+	$ alias wxruby="arch -i386 ruby -rubygems"
+
+This link is also useful if using rvm and ruby 1.9.x:
+http://www.ruby-forum.com/topic/212707#969982.  The magic is this
+command:
+
+	$ rvm install ruby-1.9.2-head -C --with-arch=x86_64,i386
+
+Once you do the above, you should be able to successfully install the
+wxruby-ruby19 gem using the following platform magic:
+
+	$ gem install --platform x86-darwin-9 --no-ri --no-rdoc wxruby-ruby19
+
+### Windows
+
+Amazingly enough, it seems to *just work* on Windows (Vista is the
+only tested configuration at the moment).  YMMV.

data/lib/ruby_mvc.rb

@@ -0,0 +1,33 @@
+#--
+######################################################################
+#
+# 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:     ruby_mvc.rb
+# Created:  Sat 19 Nov 2011 11:24:19 GMT
+#
+######################################################################
+#++
+
+require 'yaml'
+require 'ruby_mvc/module'
+require 'ruby_mvc/toolkit'
+require 'ruby_mvc/renderers'
+require 'ruby_mvc/controllers/app_controller'
+require 'ruby_mvc/models'
+require 'ruby_mvc/views'
+require 'ruby_mvc/application'

data/lib/ruby_mvc/application.rb

@@ -0,0 +1,53 @@
+#--
+######################################################################
+#
+# 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:     application.rb
+# Created:  Wed 23 Nov 2011 11:01:20 GMT
+#
+######################################################################
+#++
+
+module RubyMVC
+
+  # This provides the entry point for a basic application.
+  class Application
+    attr_accessor :frame
+    attr_accessor :controller
+
+    def initialize(options, &block)
+      self.frame = Toolkit::Frame.new(options)
+      if cc = options[:controller]
+        self.controller = cc
+        self.controller.app = self
+        self.controller.init
+      end
+      self.instance_eval(&block) if block
+      self.frame.show
+    end
+  end
+
+  # This method creates a default application and runs it
+  # using the active toolkit.
+  
+  def self.app(*args, &block)
+    Toolkit::App.new do
+      Application.new(*args, &block)
+    end
+  end
+end

data/lib/ruby_mvc/controllers/app_controller.rb

@@ -0,0 +1,93 @@
+#--
+######################################################################
+#
+# 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_controller.rb
+# Created:  Sat 19 Nov 2011 11:29:49 GMT
+#
+#####################################################################
+#++ 
+
+module RubyMVC
+
+  # This module takes care of dispatching links to controller
+  # classes.
+
+  module LinkDispatcher
+    # This method is a callback to allow links embedded in
+    # views to trigger controller actions in a loosely-coupled
+    # manner.
+    #
+    # The default implementation will attempt to call methods
+    # based on applying the RubyMVC#method_name
+    # transformation and checking if the controller responds
+    # to the method.  To manually dispatch the method, simply
+    # override this method in the derived class.
+
+    def link_activated(sender, link)
+      puts "#link_activated(#{sender}, #{link})"
+      m = RubyMVC.method_name(link).to_sym
+      if self.respond_to? m
+        self.send(m, sender, link)
+      end
+    end
+  end
+
+  class AppController
+    include LinkDispatcher
+
+    attr_accessor :app
+
+    # By convention, the application is configured using an
+    # app.yml file in the same directory as the application
+    # controller.
+
+    def initialize(app_file)
+      @config_file = File.expand_path(File.join(File.dirname(app_file), "../app.yml"))
+      if !File.exist? @config_file
+        @shoes.alert("Unable to locate configuration file.\nFile '#{@config_file}' not found.")
+        @shoes.exit
+      end
+
+      @config = YAML.load(File.new(@config_file))
+      setup
+      run
+    end
+
+    # This method is a placeholder for the actual
+    # initialization to be performed by the Ruby application
+    # itself.  It is called automatically by the constructor
+    # of the application controller.
+
+    def run
+    end
+
+  protected
+    def config
+      @config || {}
+    end
+
+    # This method is called prior to calling the #run method
+    # to give the derived controller classes an opportunity to
+    # perform any specific initialization.
+
+    def setup
+    end
+  end
+
+end

data/lib/ruby_mvc/controllers/rails_controller.rb

@@ -0,0 +1,71 @@
+#--
+######################################################################
+#
+# 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:     rails_controller.rb
+# Created:  Sat 19 Nov 2011 11:29:49 GMT
+#
+#####################################################################
+#++ 
+
+require 'active_record'
+
+module RubyMVC
+
+  # This controller is used to assist in writing Ruby
+  # applications for an existing Rails application.  All of
+  # the models will be automatically loaded based on the
+  # directory configuration of the Rails environment, and the
+  # database connection environment will be used.
+  #
+  # This controller uses the following configuration settings
+  # to help it initialize itself:
+  #
+  # rails_app - the location of the app directory of the Rails
+  #             application
+  #
+  # config    - the default database configuration to use by
+  #             the application
+
+  class RailsController < AppController
+    def setup
+      @rails_app = File.expand_path(File.join(
+            File.dirname(@config_file), config["rails_app"]))
+      connect_db
+      load_models
+    end
+
+  private
+    def connect_db
+      yml = File.expand_path(File.join(@rails_app, "../config/database.yml"))
+      dbconf = YAML.load(File.new(yml))
+      env = dbconf[config["config"]]
+
+      case(env["adapter"])
+      when "sqlite3"
+        env["database"] = File.join("#{@rails_app}/..", env["database"])
+      end
+      ActiveRecord::Base.establish_connection(env)
+    end
+
+    def load_models
+      Dir.glob(File.join(@rails_app, "models/*.rb")) { |m| require m }
+    end
+  end
+
+end

data/lib/ruby_mvc/models.rb

@@ -0,0 +1,28 @@
+#--
+######################################################################
+#
+# 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:     models.rb
+# Created:  Sat 19 Nov 2011 19:50:32 GMT
+#
+#####################################################################
+#++ 
+
+require 'ruby_mvc/models/table_model'
+require 'ruby_mvc/models/array_table_model'
+require 'ruby_mvc/models/keyed_array_table_model'

data/lib/ruby_mvc/models/array_table_model.rb

@@ -0,0 +1,59 @@
+#--
+######################################################################
+#
+# 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:     array_table_model.rb
+# Created:  Sat 19 Nov 2011 19:56:17 GMT
+#
+#####################################################################
+#++ 
+
+module ShoesMVC
+module Models
+
+  # This class implements the TableModel interface based on
+  # the data being stored in an array.  The elements in the
+  # array must either be a Hash, or they must respond to the
+  # [] accessors for retrieving elements by key and implement
+  # a #keys method for indicating the properties in each row
+  # instance.
+
+  class ArrayTableModel < TableModel
+    def initialize(data)
+      @data = data
+    end
+
+    def keys
+      if @data && @data.size > 0
+        @data.keys
+      else
+        {}
+      end
+    end
+
+    def each(&block)
+      @data.each(&block)
+    end
+
+    def each_with_index(&block)
+      @data.each_with_index(&block)
+    end
+  end
+
+end
+end

data/lib/ruby_mvc/models/keyed_array_table_model.rb

@@ -0,0 +1,83 @@
+#--
+######################################################################
+#
+# 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:     keyed_array_table_model.rb
+# Created:  Sat 19 Nov 2011 18:58:36 GMT
+#
+#####################################################################
+#++ 
+
+module ShoesMVC
+module Models
+
+  class KeyedArrayTableModel < TableModel
+
+    # This class provides a row adapter for each row in the
+    # array so that it behaves effectively like a Hash
+    # instance, but which still allows the underlying array to
+    # be manipulated without problem.
+
+    class Row
+      # The instance is created with an array of strings or
+      # symbols used to denote the keys of the model.  The keys
+      # MUST be specified in the order of the data elements in
+      # the data array.  When the model is asked for the value
+      # for a given key, the value is retrieved from the data
+      # array by the position of the key in the keys array.
+
+      def initialize(keys, row)
+        @keys = keys
+        @row = row
+      end
+
+      def [](key)
+        @row[@keys[key.to_sym]]
+      end
+
+      def []=(key, val)
+        @row[@keys[key.to_sym]] = val
+      end
+    end
+
+    # This method is used to initialize the mo
+    def initialize(keys, data)
+      @keys = {}
+      keys.each_with_index { |x, i| @keys[x.to_sym] = i }
+      @data = data
+    end
+
+    def keys
+      @keys.keys
+    end
+
+    def each(&block)
+      @data.each do |x|
+        block.call(Row.new(@keys, x))
+      end
+    end
+
+    def each_with_index(&block)
+      @data.each_with_index do |x, i|
+        block.call(Row.new(@keys, x), i)
+      end
+    end
+  end
+
+end
+end