shoes_mvc 0.0.1 → 0.0.2

data/README.md

@@ -6,12 +6,48 @@ This project provides a basic MVC framework on top of the Shoes
 environment for those of us strange people who have done MVC so long
 it's extremely difficult to think about applications other ways.
 
+*NOTE: this code is **highly experimental** and an early work in
+progress.  It wouldn't be wise to rely on it right now for anything
+other than experiments, prototypes and proofs of concept.*
+
 Installation
 ============
 
-At the moment, you have to build the gem from source and then install
-into the local Shoes gem dir.  I'm hoping to get this published on
-rubygems.org as soon as I have something that kinda works.
+The normal way to ensure this gem is installed is to add it to the
+Shoes.setup block, e.g.
+
+	Shoes.setup do
+		gem 'shoes_mvc'
+	end
+
+As of version 0.0.0, it's available as a gem from rubygems.org, so
+this should just work.  If you're using the Rails integration, you'll
+also need to have a version of ActiveRecord installed.
+
+If you're building it manually (because you're hacking on it), then
+you'll need to install it yourself in the local Shoes gem directory
+for your user.  On MacOS X, you can do it like this:
 
     $ gem build shoes_mvc.gemspec
     $ gem install --install-dir $HOME/.shoes/+gem ./*.gem
+
+Known Issues
+============
+
+The following issues are related to getting this gem actually
+installed and working as expected:
+
+ * http://librelist.com/browser/shoes/2011/11/18/a-tangled-web-mess-of-dependencies-encoding-vs-sqlite3-vs-activerecord/
+ * https://github.com/shoes/shoes/issues/163
+ * https://github.com/shoes/shoes/issues/164
+
+Additional Encoding Hack
+------------------------
+
+With Policeman, the Encoding class doesn't seem to actually be defined
+completely.  As a result, anything to do with Encoding and
+ActiveRecord chokes fairly hard.  The "solution" is to hack the
+encoding.rb file in activesupport so that it 
+defines #encoding_supported? as false.  Neat, huh?
+
+Hopefully, this will all get fixed with the next release of Shoes. :(

data/lib/shoes_mvc.rb

@@ -24,6 +24,7 @@
 #++
 
 require 'yaml'
+require 'shoes_mvc/module'
 require 'shoes_mvc/controllers/app_controller'
 require 'shoes_mvc/models'
 require 'shoes_mvc/views'

data/lib/shoes_mvc/controllers/app_controller.rb

@@ -25,6 +25,30 @@
 
 module ShoesMVC
 
+  # 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 ShoesMVC#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)
+      @shoes.debug("#link_activated(#{sender}, #{link}")
+      m = ShoesMVC.method_name(link).to_sym
+      if self.respond_to? m
+        @shoes.debug("dispatching to ##{m}")
+        self.send(m, sender, link)
+      end
+    end
+  end
+
   # This controller is used to assist in writing Shoes
   # applications for an existing Rails application.  All of
   # the models will be automatically loaded based on the
@@ -32,6 +56,8 @@ module ShoesMVC
   # database connection environment will be used.
 
   class AppController
+    include LinkDispatcher
+
     # The controller is instantiated by an
     # application-specific controller instance that passes
     # through the location of the appication controller source

data/lib/shoes_mvc/module.rb

@@ -0,0 +1,35 @@
+#--
+######################################################################
+#
+# 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:     module.rb
+# Created:  Sat 19 Nov 2011 11:24:19 GMT
+#
+######################################################################
+#++
+
+module ShoesMVC
+  # This method is used to convert a name to a method name.
+  # It is borrowed and adapted from shoes.rb:538-540.
+
+  def self.method_name(str)
+    str.to_s.gsub("/", "").gsub("::", "_").
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+  end
+end

data/lib/shoes_mvc/views.rb

@@ -23,5 +23,25 @@
 #####################################################################
 #++ 
 
-require 'shoes_mvc/views/ar_model_editor'
+module ShoesMVC
+  module Views
+    
+    # This is the base view class that provides integration
+    # with the controllers
+
+    class View < Shoes::Widget
+      attr_accessor :controller
+
+      def initialize(*args)
+        if(options = args.last).is_a? Hash
+          self.controller = options[:controller]
+        end
+      end
+    end
+  end
+end
+
 require 'shoes_mvc/views/table_view'
+require 'shoes_mvc/views/ar_model_editor'
+require 'shoes_mvc/views/ar_type_list'
+require 'shoes_mvc/views/ar_type_editor'

data/lib/shoes_mvc/views/ar_model_editor.rb

@@ -52,18 +52,38 @@ module Views
       stack :width => "100%" do
         flow :width => "100%" do
           model.attributes.keys.sort.each do |key|
+            # FIXME: I can't believe that you have to do this
+            # this way with AR.  I'm surely missing
+            # something...
+            m = "#{key}=".to_sym
             value = model.attributes[key]
             flow :width => lwidth, :margin_top => 2 do
               para key, :weight => 'bold', :align => "right"
             end
             flow :width => 1 - lwidth do
               edit_line model.attributes[key] do |e|
-                model.attributes[key] = e.text
+                model.send(m, e.text)
               end
             end
           end
         end
       end
+
+      @model = model
+      @options = options
+    end
+
+    def save
+      debug("model: #{@model.inspect}")
+      @model.save!
+    end
+
+    def create
+      if @model
+        load(@model.class.new, options)
+      else
+        alert("No template model.\nUse the #load method instead.")
+      end
     end
   end
 

data/lib/shoes_mvc/views/ar_type_editor.rb

@@ -0,0 +1,65 @@
+#--
+######################################################################
+#
+# 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:     ar_type_editor.rb
+# Created:  Mon 21 Nov 2011 18:00:49 GMT
+#
+#####################################################################
+#++ 
+
+module ShoesMVC
+module Views
+
+  class ActiveRecordTypeEditor < View
+    include ShoesMVC::LinkDispatcher
+
+    def initialize(type, options = {}, &block)
+      ctrl = options[:controller] = options[:controller] || self
+      super(options, &block)
+      @type = type
+      @list = active_record_type_list type
+      para link("New...") {
+        ctrl.link_activated(self, "/create_instance")
+      }
+    end
+
+    def create_instance(sender, link)
+      debug("create instance of type #{@type}")
+      obj = @type.new
+      window do
+        stack do
+          obj.description = "Some text"
+          editor = active_record_model_editor obj
+          flow :margin_left => 0, :left => "-25%" do
+            button "Cancel", :align => "right" do 
+              close 
+            end
+            button "Save", :align => "right" do
+              editor.save
+              close
+            end
+            debug("created buttons")
+          end
+        end
+      end
+    end
+  end
+
+end
+end

data/lib/shoes_mvc/views/ar_type_list.rb

@@ -0,0 +1,45 @@
+#--
+######################################################################
+#
+# 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:     ar_type_list.rb
+# Created:  Mon 21 Nov 2011 15:57:27 GMT
+#
+#####################################################################
+#++ 
+
+module ShoesMVC
+module Views
+
+  class ActiveRecordTypeList < TableView
+    def load(model, options = {}, &block)
+      @entity_type = model
+      super(model.find(options[:query] || :all), options, &block)
+    end
+
+    def columns(model, options)
+      cols = []
+      @entity_type.attribute_names.each do |key|
+        cols << { :key => key, :label => key.capitalize }
+      end
+      cols
+    end
+  end
+
+end
+end

data/lib/shoes_mvc/views/table_view.rb

@@ -31,7 +31,7 @@ module Views
   # requires that the data to be displayed be supplied as a
   # TableModel instance.
 
-  class TableView < Shoes::Widget
+  class TableView < View
     def initialize(model, options = {}, &block)
       super(options, &block)
       load(model, options, &block)
@@ -81,7 +81,11 @@ module Views
       flow do
         cols.each do |col|
           flow(:width => defw) do
-            para row[col[:key]], col[:style]
+            if(r = col[:renderer])
+              r.render(self, row, col)
+            else
+              para row[col[:key]], col[:style]
+            end
           end
         end
       end

data/shoes_mvc.gemspec

@@ -27,8 +27,7 @@ require 'rake'
 
 Gem::Specification.new do |s|
   s.name        = "shoes_mvc"
-  s.version     = "0.0.1"
-  s.date        = "2011-11-19"
+  s.version     = "0.0.2"
   s.summary     = "Shoes MVC"
   s.description = "A basic MVC framework for the Shoes toolkit"
   s.authors     = [ "Andrew S. Townley" ]

data/test/unit/test_array_table_model.rb

@@ -0,0 +1,38 @@
+#--
+######################################################################
+#
+# 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:     test_shoes_mvc.rb
+# Created:  Mon 21 Nov 2011 18:10:45 GMT
+#
+######################################################################
+#++
+
+require 'testy'
+require 'shoes_mvc/module'
+
+Testy.testing "Core module tests" do
+  test "Basic functionality" do |result|
+    data = %w( some_path some_path module_klass )
+    %w( /some_path /somePath Module::Klass ).each_with_index do |uri, i|
+      result.check "uri to method_name #{uri}",
+          :expect => data[i],
+          :actual => ShoesMVC.method_name(uri)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shoes_mvc
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Andrew S. Townley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-19 00:00:00 +00:00
+date: 2011-11-21 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -34,12 +34,16 @@ files:
 - lib/shoes_mvc/models/keyed_array_table_model.rb
 - lib/shoes_mvc/models/table_model.rb
 - lib/shoes_mvc/models.rb
+- lib/shoes_mvc/module.rb
 - lib/shoes_mvc/views/ar_model_editor.rb
+- lib/shoes_mvc/views/ar_type_editor.rb
+- lib/shoes_mvc/views/ar_type_list.rb
 - lib/shoes_mvc/views/table_view.rb
 - lib/shoes_mvc/views.rb
 - lib/shoes_mvc.rb
 - test/unit/models/test_array_table_model.rb
 - test/unit/models/test_keyed_array_table_model.rb
+- test/unit/test_array_table_model.rb
 - LICENSE
 - README.md
 - shoes_mvc.gemspec