view_mapper 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,6 +1,6 @@
 =View Mapper
 
-View Mapper will generate scaffolding code and map it to your existing models.
+View_mapper will generate scaffolding for new or existing models, customized for the plugins or Rails features you use in your application.
 
 When you run the "view_for" generator, View Mapper will generate the view scaffolding code for your model, enhanced to use the specified plugin or feature with your model's attributes. For example:
 
@@ -12,7 +12,7 @@ When you run the "view_for" generator, View Mapper will generate the view scaffo
 
 ...will generate a "paperclip view" for your existing song model. This is scaffolding that will support viewing and editing your song model and its Paperclip attachments. It's a good way to learn how to use Paperclip if you aren't familiar with it yet.
 
-Currently View Mapper supports views for the auto_complete and paperclip plugins. If you don't specify any view then View Mapper by default will generate standard Rails scaffolding.
+Currently View Mapper supports views for the auto_complete and paperclip plugins, and views that contain complex forms for editing multiple associated models. If you don't specify any view then View Mapper by default will generate standard Rails scaffolding.
 
 If you also want to create a new model at the same time, then use a second View Mapper generator called "scaffold_for_view" and provide the model's attributes in the usual way:
 
@@ -39,6 +39,8 @@ This is the same as view_for, but will also generate a new model at the same tim
 
 {paperclip}[http://patshaughnessy.net/2009/10/16/paperclip-scaffolding]: Generates scaffolding that uses Paperclip to upload and download files.
 
+{has_many}[http://patshaughnessy.net/2009/11/9/scaffolding-for-complex-forms-using-nested-attributes]: Generates scaffolding for a complex form to edit two or more associated models.
+
 == Examples
 
 For detailed examples and more information see: http://patshaughnessy.net/view_mapper

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/generators/scaffold_for_view/scaffold_for_view_generator.rb

@@ -8,14 +8,10 @@ class ScaffoldForViewGenerator < ScaffoldGenerator
 
   def initialize(runtime_args, runtime_options = {})
     super
-    @source_root = source_root_for_view
+    @source_root = self.class.lookup('scaffold').path + '/templates'
     validate
   end
-
-  def source_root_for_view
-    self.class.lookup('scaffold').path + "/templates"
-  end
-
+  
   def validate
     @valid = true
   end

data/generators/view_for/view_for_generator.rb

@@ -9,15 +9,11 @@ class ViewForGenerator < ScaffoldGenerator
 
   def initialize(runtime_args, runtime_options = {})
     super
-    @source_root = source_root_for_view
+    @source_root = self.class.lookup('scaffold').path + "/templates"
     @model = ModelInfo.new(@name)
     validate
   end
 
-  def source_root_for_view
-    self.class.lookup('scaffold').path + "/templates"
-  end
-
   def record
     EditableManifest.new(self) { |m| yield m }
   end

data/lib/view_mapper/{has_many_view.rb → has_many_child_models.rb}

@@ -1,38 +1,10 @@
 module ViewMapper
-  module HasManyView
+  module HasManyChildModels
 
     attr_reader :child_models
 
-    def source_root_for_view
-      File.dirname(__FILE__) + "/has_many_templates"
-    end
-
-    def manifest
-      m = super.edit do |action|
-        action unless is_model_dependency_action(action) || is_view_show(action) || !valid
-      end
-      add_model_actions(m) if valid && !view_only?
-      if valid
-        m.template(
-          "view_show.html.erb",
-          File.join('app/views', controller_class_path, controller_file_name, "show.html.erb"),
-          { :assigns => { :child_models => child_models } }
-        )
-        m.template(
-          "view_form.html.erb",
-          File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
-        )
-        child_models.each do |child_model|
-          m.template(
-            "view_child_form.html.erb",
-            File.join('app/views', controller_class_path, controller_file_name, "_#{child_model.name.underscore}.html.erb"),
-            { :assigns => { :child_model => child_model } }
-
-          )
-        end
-        m.file('nested_attributes.js', 'public/javascripts/nested_attributes.js')
-      end
-      m
+    def is_child_model_action?(action)
+      is_model_dependency_action(action) || is_view_show(action)
     end
 
     def is_model_dependency_action(action)
@@ -43,7 +15,35 @@ module ViewMapper
       action[0] == :template && action[1].include?('view_show.html.erb')
     end
 
-    def add_model_actions(m)
+    def add_child_models_manifest(m)
+      add_child_model_actions(m) if valid && !view_only?
+      add_child_model_forms(m) if valid
+      m
+    end
+
+    def add_child_model_forms(m)
+      m.template(
+        "view_show.html.erb",
+        File.join('app/views', controller_class_path, controller_file_name, "show.html.erb"),
+        { :assigns => { :child_models => child_models } }
+      )
+      m.template(
+        "view_form.html.erb",
+        File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
+      )
+      child_models.each do |child_model|
+        m.template(
+          "view_child_form.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "_#{child_model.name.underscore}.html.erb"),
+          { :assigns => { :child_model => child_model } }
+
+        )
+      end
+      m.file('nested_attributes.js', 'public/javascripts/nested_attributes.js')
+      m
+    end
+
+    def add_child_model_actions(m)
       m.directory(File.join('test/fixtures', class_path))
       m.template   'model.rb',     File.join('app/models', class_path, "#{file_name}.rb")
       m.template   'unit_test.rb', File.join('test/unit',  class_path, "#{file_name}_test.rb")
@@ -72,11 +72,6 @@ module ViewMapper
       end
     end
 
-    def validate
-      super
-      @valid &&= validate_child_models
-    end
-
     def validate_child_models
       cms = child_models
       if cms.empty?
@@ -122,3 +117,4 @@ module ViewMapper
     end
   end
 end
+

data/lib/view_mapper/model_info.rb

@@ -23,6 +23,14 @@ module ViewMapper
       @attributes ||= active_record_columns.collect { |col| Rails::Generator::GeneratedAttribute.new col.name, col.type }
     end
 
+    def self.is_text_field_attrib_type?(type)
+      [:integer, :float, :decimal, :string].include? type
+    end
+
+    def text_fields
+      attributes.reject { |attrib| !ModelInfo.is_text_field_attrib_type? attrib.type }.collect { |attrib| attrib.name }
+    end
+
     def attachments
       @attachments = find_attachments
     end

data/lib/view_mapper/view_mapper.rb

@@ -5,12 +5,25 @@ module ViewMapper
     Rails::Generator::Commands::Create.class_eval { include RouteAction::Create }
     Rails::Generator::Commands::Destroy.class_eval { include RouteAction::Destroy }
     super
+    self.extend(view_module) if options[:view]
+  end
+
+  def source_path(relative_source)
     if options[:view]
-      self.extend(view_module)
-      @source_root = source_root_for_view
+      source_roots_for_view.map do |source_root|
+        File.join(File.expand_path(source_root), relative_source)
+      end.detect do |path|
+        File.exists? path
+      end
+    else
+      super
     end
   end
 
+  def source_roots_for_view
+    [ view_module.source_root, File.expand_path(source_root) ]
+  end
+
   def view_module
     "ViewMapper::#{view_name.camelize}View".constantize
   end

data/lib/view_mapper/views/auto_complete/auto_complete_view.rb

@@ -0,0 +1,77 @@
+module ViewMapper
+  module AutoCompleteView
+
+    def self.source_root
+      File.expand_path(File.dirname(__FILE__) + "/templates")
+    end
+
+    def manifest
+      manifest = super
+      if @valid
+        auto_complete_attributes.each do |attrib|
+          manifest.route :name       => 'connect',
+                         :path       => auto_complete_for_method(attrib),
+                         :controller => controller_file_name,
+                         :action     => auto_complete_for_method(attrib)
+        end
+      end
+      manifest
+    end
+
+    def auto_complete_for_method(attrib)
+      "auto_complete_for_#{singular_name}_#{attrib}"
+    end
+
+    def auto_complete_attributes
+      if view_param
+        parse_auto_complete_attributes_from_param
+      elsif view_only?
+        model.text_fields
+      else
+        []
+      end
+    end
+
+    def parse_auto_complete_attributes_from_param
+      view_param.split(',')
+    end
+
+    def validate
+      super
+      @valid &&= validate_auto_complete_attributes
+    end
+
+    def validate_auto_complete_attributes
+      if !auto_complete_installed
+        logger.error "The auto_complete plugin does not appear to be installed."
+        return false
+      elsif auto_complete_attributes.empty?
+        if view_only?
+          logger.error "No text fields exist in the specified class."
+        else
+          logger.error "No auto_complete attribute specified."
+        end
+        return false
+      else
+        !auto_complete_attributes.detect { |a| !validate_auto_complete_attribute(a) }
+      end
+    end
+
+    def validate_auto_complete_attribute(attrib_name)
+      attrib = attributes.find { |a| a.name == attrib_name }
+      if attrib.nil?
+        logger.error "Field '#{attrib_name}' does not exist."
+        return false
+      elsif !ModelInfo.is_text_field_attrib_type? attrib.type
+        logger.error "Field '#{attrib_name}' is not a text field."
+        return false
+      end
+      true
+    end
+
+    def auto_complete_installed
+      ActionController::Base.methods.include? 'auto_complete_for'
+    end
+
+  end
+end

data/lib/view_mapper/{auto_complete_templates → views/auto_complete/templates}/controller.rb

@@ -1,6 +1,8 @@
 class <%= controller_class_name %>Controller < ApplicationController
 
-  auto_complete_for :<%= controller_singular_name %>, :<%= auto_complete_attribute %>
+<% auto_complete_attributes.each do |attrib| -%>
+  auto_complete_for :<%= controller_singular_name %>, :<%= attrib %>
+<% end -%>
 
   # GET /<%= table_name %>
   # GET /<%= table_name %>.xml

data/lib/view_mapper/{auto_complete_templates → views/auto_complete/templates}/view_edit.html.erb

@@ -5,7 +5,7 @@
 <% for attribute in attributes -%>
   <p>
     <%%= f.label :<%= attribute.name %> %><br />
-<%- if auto_complete_attribute == attribute.name -%>
+<%- if auto_complete_attributes.include? attribute.name -%>
     <%%= text_field_with_auto_complete :<%= singular_name %>, :<%= attribute.name %>, {}, { :method => :get } %>
 <%- else -%>
     <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>

data/lib/view_mapper/{auto_complete_templates → views/auto_complete/templates}/view_new.html.erb

@@ -5,7 +5,7 @@
 <%- for attribute in attributes -%>
   <p>
     <%%= f.label :<%= attribute.name %> %><br />
-<%- if auto_complete_attribute == attribute.name -%>
+<%- if auto_complete_attributes.include? attribute.name -%>
     <%%= text_field_with_auto_complete :<%= singular_name %>, :<%= attribute.name %>, {}, { :method => :get } %>
 <%- else -%>
     <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>

data/lib/view_mapper/views/has_many/has_many_view.rb

@@ -0,0 +1,28 @@
+module ViewMapper
+  module HasManyView
+
+    include HasManyChildModels
+
+    def self.source_root
+      File.expand_path(File.dirname(__FILE__) + "/templates")
+    end
+
+    def source_roots_for_view
+      [ HasManyView.source_root, File.expand_path(source_root), File.join(self.class.lookup('model').path, 'templates') ]
+    end
+
+    def manifest
+      m = super.edit do |action|
+        action unless is_child_model_action?(action)
+      end
+      add_child_models_manifest(m)
+      m
+    end
+
+    def validate
+      super
+      @valid &&= validate_child_models
+    end
+
+  end
+end

data/lib/view_mapper/{paperclip_view.rb → views/paperclip/paperclip_view.rb}

@@ -1,8 +1,12 @@
 module ViewMapper
   module PaperclipView
 
-    def source_root_for_view
-      File.dirname(__FILE__) + "/paperclip_templates"
+    def self.source_root
+      File.expand_path(File.dirname(__FILE__) + "/templates")
+    end
+
+    def source_roots_for_view
+      [ PaperclipView.source_root, File.expand_path(source_root), File.join(self.class.lookup('model').path, 'templates') ]
     end
 
     def manifest

data/lib/view_mapper/{paperclip_templates → views/paperclip/templates}/migration.rb

@@ -2,7 +2,7 @@ class <%= migration_name %> < ActiveRecord::Migration
   def self.up
     create_table :<%= table_name %> do |t|
 <% for attribute in attributes -%>
-      t.<%= attribute.type %>   :<%= attribute.name %>
+      t.<%= attribute.type %> :<%= attribute.name %>
 <% end -%>
 <% for attachment in attachments -%>
       t.string   :<%= attachment %>_file_name

data/lib/view_mapper.rb

@@ -1,7 +1,8 @@
-require 'view_mapper/auto_complete_view'
-require 'view_mapper/paperclip_view'
-require 'view_mapper/has_many_view'
 require 'view_mapper/route_action'
 require 'view_mapper/editable_manifest'
 require 'view_mapper/model_info'
+require 'view_mapper/has_many_child_models'
 require 'view_mapper/view_mapper'
+require 'view_mapper/views/auto_complete/auto_complete_view'
+require 'view_mapper/views/paperclip/paperclip_view'
+require 'view_mapper/views/has_many/has_many_view'

data/test/generators/fake/templates/fake_template1.html.erb

@@ -0,0 +1 @@
+This is fake.

data/test/generators/fake/templates/fake_template2.html.erb

@@ -0,0 +1 @@
+This is fake.

data/test/{scaffold_for_view_generator_test.rb → generators/scaffold_for_view/scaffold_for_view_generator_test.rb}

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.dirname(__FILE__) + '/../../test_helper'
 
 class ScaffoldForViewGeneratorTest < Test::Unit::TestCase
 
@@ -69,7 +69,7 @@ class ScaffoldForViewGeneratorTest < Test::Unit::TestCase
     end
 
     should "return the source root folder for the Rails scaffold generator" do
-      assert_equal './test/rails_generator/generators/components/scaffold/templates', @scaffold_for_view_gen.source_root
+      assert_equal @scaffold_for_view_gen.class.lookup('scaffold').path + '/templates', @scaffold_for_view_gen.source_root
     end
 
   end

data/test/model_info_test.rb

@@ -17,11 +17,12 @@ class ModelInfoTest < Test::Unit::TestCase
     end
 
     should "return the model's columns and not the primary key or time stamp columns" do
-      assert_equal [ 'first_name', 'last_name', 'address' ], @model_info.columns
+      assert_equal [ 'first_name', 'last_name', 'address', 'some_flag' ], @model_info.columns
     end
 
     should "return the model's Rails Generator attributes" do
       attribs = @model_info.attributes
+      assert_equal 4, attribs.size
       assert_kind_of Rails::Generator::GeneratedAttribute, attribs[0]
       assert_kind_of Rails::Generator::GeneratedAttribute, attribs[1]
       assert_kind_of Rails::Generator::GeneratedAttribute, attribs[2]
@@ -29,6 +30,14 @@ class ModelInfoTest < Test::Unit::TestCase
       assert_equal 'last_name',  attribs[1].name
       assert_equal 'address',    attribs[2].name
     end
+
+    should "return the model's text fields" do
+      text_fields = @model_info.text_fields
+      assert_equal 3, text_fields.size
+      assert_equal 'first_name', text_fields[0]
+      assert_equal 'last_name',  text_fields[1]
+      assert_equal 'address',    text_fields[2]
+    end
   end
 
   context "Child and parent model info objects" do
@@ -40,7 +49,7 @@ class ModelInfoTest < Test::Unit::TestCase
     end
 
     should "not include the parent foreign key column in the child model's columns" do
-      assert_equal [ 'first_name', 'last_name', 'address' ], @child_model.columns
+      assert_equal [ 'first_name', 'last_name', 'address', 'some_flag' ], @child_model.columns
     end
 
     should "determine that the child model belongs to the parent model" do
@@ -75,7 +84,7 @@ class ModelInfoTest < Test::Unit::TestCase
     end
 
     should "not include the Paperclip columns in the model's columns" do
-      assert_equal [ 'first_name', 'last_name', 'address' ], @model_info.columns
+      assert_equal [ 'first_name', 'last_name', 'address', 'some_flag' ], @model_info.columns
     end
   end
 end

data/test/test_helper.rb

@@ -5,32 +5,29 @@ require 'shoulda'
 require 'mocha'
 require 'activerecord'
 
-config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
-ActiveRecord::Base.establish_connection(config['test'])
+ActiveRecord::Base.establish_connection({ :adapter => 'sqlite3', :database => ':memory:' })
 
 require 'rails_generator'
 require 'rails_generator/scripts'
 require 'rails_generator/scripts/generate'
 
-Rails::Generator::Base.reset_sources
 def add_source(path)
   Rails::Generator::Base.append_sources(Rails::Generator::PathSource.new(:builtin, path))
 end
-
 add_source(File.dirname(__FILE__) + '/../generators')
-add_source(File.dirname(__FILE__) + '/rails_generator/generators/components')
-add_source(File.dirname(__FILE__))
+add_source(File.dirname(__FILE__) + '/generators')
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'view_mapper'
-require 'fake_view'
+require 'views/fake/fake_view'
 
 def setup_test_table(paperclip_columns = false)
   ActiveRecord::Base.connection.create_table :testies, :force => true do |table|
     table.column :first_name, :string
     table.column :last_name,  :string
     table.column :address,    :string
+    table.column :some_flag,  :boolean
     if paperclip_columns
       table.column :avatar_file_name,     :string
       table.column :avatar_content_type,  :string
@@ -116,11 +113,18 @@ class Rails::Generator::NamedBase
   public :attributes
 end
 
+module ActionController
+  class Base
+    def self.auto_complete_for
+    end
+  end
+end
+
 def generator_cmd_line(gen, args, model)
   if gen == 'view_for'
     cmd_line = [model]
   else
-    cmd_line = [model, 'first_name:string', 'last_name:string', 'address:string']
+    cmd_line = [model, 'first_name:string', 'last_name:string', 'address:string', 'some_flag:boolean']
   end
   (cmd_line << args).flatten
 end

data/test/view_mapper_test.rb

@@ -11,8 +11,19 @@ class ViewMapperTest < Test::Unit::TestCase
       assert_equal 'fake', @gen.view_name
     end
 
-    should "use the templates for the specified view" do
-      assert_equal '/some/path/templates', @gen.source_root
+    should "have the proper default value for source_roots_for_view" do
+      assert_equal [
+        '/Users/pat/rails-apps/view_mapper/test/views/fake/templates',
+        '/Users/pat/rails-apps/view_mapper/test/generators/fake/templates'
+      ], @gen.source_roots_for_view
+    end
+
+    should "use the correct source path for a template file that is overridden in the view" do
+      assert_equal '/Users/pat/rails-apps/view_mapper/test/views/fake/templates/fake_template1.html.erb', @gen.source_path('fake_template1.html.erb')
+    end
+
+    should "use the correct source path for a template file that is not overridden in the view" do
+      assert_equal '/Users/pat/rails-apps/view_mapper/test/generators/fake/templates/fake_template2.html.erb', @gen.source_path('fake_template2.html.erb')
     end
   end