view_mapper 0.3.3 → 0.3.4

data/README.rdoc

@@ -45,7 +45,9 @@ This is the same as view_for, but will also generate a new model at the same tim
 
 {belongs_to}[http://patshaughnessy.net/2010/1/25/creating-associations-to-existing-data-part-1-belongs_to-scaffolding]: Generates scaffolding that allows you to select an existing, associated model.
 
-belongs_to_auto_complete: Generates scaffolding that allows you to select an existing, associated model using auto_complete.
+{belongs_to_auto_complete}[http://patshaughnessy.net/2010/2/13/creating-associations-to-existing-data-part-2-belongs_to-with-auto_complete]: Generates scaffolding that allows you to select an existing, associated model using auto_complete.
+
+{has_many_existing}[http://patshaughnessy.net/2010/4/4/creating-associations-to-existing-data-part-3-has_many-through-scaffolding]: Generates scaffolding for a complex form to edit two models that have a has_many, :through association with a third model. Use this if you have a many-many relationship with existing data.
 
 == Examples
 

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/view_mapper.rb

@@ -9,3 +9,4 @@ require 'view_mapper/views/paperclip/paperclip_view'
 require 'view_mapper/views/has_many/has_many_view'
 require 'view_mapper/views/belongs_to/belongs_to_view'
 require 'view_mapper/views/belongs_to_auto_complete/belongs_to_auto_complete_view'
+require 'view_mapper/views/has_many_existing/has_many_existing_view'

data/lib/view_mapper/belongs_to_parent_models.rb

@@ -1,20 +1,6 @@
 module ViewMapper
   module BelongsToParentModels
 
-    def manifest
-      m = super.edit do |action|
-        action unless is_model_dependency_action(action) || !valid
-      end
-      if valid
-        m.template(
-          "view_form.html.erb",
-          File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
-        )
-        add_model_actions(m) unless view_only?
-      end
-      m
-    end
-
     def add_model_actions(m)
       m.directory(File.join('test/fixtures', class_path))
       m.template   'model.erb',     File.join('app/models', class_path, "#{file_name}.rb")
@@ -70,30 +56,30 @@ module ViewMapper
         end
         return false
       end
-      parents.reject! { |parent_model| !validate_parent_model(parent_model) }
+      parents.reject! { |parent_model| !validate_parent_model(parent_model, class_name, view_only? ? model : nil) }
       @parent_models = parents
       !parents.empty?
     end
 
-    def validate_parent_model(parent_model)
+    def validate_parent_model(parent_model, child_model_name, child_model, check_setter_method = false)
       parent_model_name = parent_model.name
       if !parent_model.valid?
         logger.error parent_model.error
         return false
-      elsif view_only? && !model.belongs_to?(parent_model_name)
-        logger.warning "Model #{model.name} does not belong to model #{parent_model_name}."
+      elsif child_model && !child_model.belongs_to?(parent_model_name)
+        logger.warning "Model #{child_model.name} does not belong to model #{parent_model_name}."
         return false
-      elsif view_only? && !model.has_method?(virtual_attribute_for(parent_model))
-        logger.warning "Model #{model.name} does not have a method #{virtual_attribute_for(parent_model)}."
+      elsif child_model && !child_model.has_method?(virtual_attribute_for(parent_model))
+        logger.warning "Model #{child_model.name} does not have a method #{virtual_attribute_for(parent_model)}."
         return false
-      elsif view_only? && !model.has_method?(virtual_attribute_setter_for(parent_model))
-        logger.warning "Model #{model.name} does not have a method #{virtual_attribute_setter_for(parent_model)}."
+      elsif child_model && check_setter_method && !child_model.has_method?(virtual_attribute_setter_for(parent_model))
+        logger.warning "Model #{child_model.name} does not have a method #{virtual_attribute_setter_for(parent_model)}."
         return false
-      elsif view_only? && !model.has_foreign_key_for?(parent_model_name)
-        logger.warning "Model #{class_name} does not contain a foreign key for #{parent_model_name}."
+      elsif child_model && !child_model.has_foreign_key_for?(parent_model_name)
+        logger.warning "Model #{child_model.name} does not contain a foreign key for #{parent_model_name}."
         return false
-      elsif !parent_model.has_many?(class_name.pluralize)
-        logger.warning "Model #{parent_model_name} does not contain a has_many association for #{class_name}."
+      elsif !parent_model.has_many?(child_model_name.pluralize)
+        logger.warning "Model #{parent_model_name} does not contain a has_many association for #{child_model_name}."
         return false
       elsif !parent_model.has_method?(field_for(parent_model)) && !parent_model.has_column?(field_for(parent_model))
         logger.warning "Model #{parent_model_name} does not have a #{field_for(parent_model)} attribute."

data/lib/view_mapper/has_many_child_models.rb

@@ -82,26 +82,26 @@ module ViewMapper
         end
         return false
       end
-      cms.reject! { |child_model| !validate_child_model(child_model) }
+      cms.reject! { |child_model| !validate_child_model(child_model, class_name, view_only? ? model : nil) }
       @child_models = cms
       !cms.empty?
     end
 
-    def validate_child_model(child_model)
+    def validate_child_model(child_model, parent_model_name, parent_model)
       if !child_model.valid?
         logger.error child_model.error
         return false
-      elsif view_only? && !model.accepts_nested_attributes_for?(child_model)
-        logger.warning "Model #{model.name} does not accept nested attributes for model #{child_model.name}."
+      elsif parent_model && !parent_model.accepts_nested_attributes_for?(child_model)
+        logger.warning "Model #{parent_model.name} does not accept nested attributes for model #{child_model.name}."
         return false
       else
-        if child_model.has_many?(class_name.pluralize) || child_model.has_and_belongs_to_many?(class_name.pluralize)
+        if child_model.has_many?(parent_model_name.pluralize) || child_model.has_and_belongs_to_many?(parent_model_name.pluralize)
           true
-        elsif !child_model.belongs_to?(class_name)
-          logger.warning "Model #{child_model.name} does not contain a belongs_to association for #{class_name}."
+        elsif !child_model.belongs_to?(parent_model_name)
+          logger.warning "Model #{child_model.name} does not contain a belongs_to association for #{parent_model_name}."
           return false
-        elsif !child_model.has_foreign_key_for?(class_name)
-          logger.warning "Model #{child_model.name} does not contain a foreign key for #{class_name}."
+        elsif !child_model.has_foreign_key_for?(parent_model_name)
+          logger.warning "Model #{child_model.name} does not contain a foreign key for #{parent_model_name}."
           return false
         end
       end

data/lib/view_mapper/model_info.rb

@@ -1,10 +1,10 @@
 module ViewMapper
   class ModelInfo
 
-    attr_reader :model
-    attr_reader :name
-    attr_reader :attributes
-    attr_reader :error
+    attr_reader   :model
+    attr_accessor :through_model # has_many :through => XYZ
+    attr_reader   :name
+    attr_reader   :error
 
     def initialize(model_name)
       @model = find_model(model_name)
@@ -52,18 +52,47 @@ module ViewMapper
     end
 
     def child_models
-      model_info_array_for_association(:has_many)
+      @child_models ||= model_info_array_for_association(:has_many)
     end
 
     def parent_models
-      model_info_array_for_association(:belongs_to)
+      @parent_models ||= model_info_array_for_association(:belongs_to)
     end
 
-    def model_info_array_for_association(association_type)
-      model.reflections.select { |key, value| value.macro == association_type }.collect do |kvpair|
-        kvpair[0].to_s.singularize
-      end.sort.collect do |model_name|
-        ModelInfo.new model_name
+    def has_many_through_models
+      @has_many_through_models ||= model_info_array_for_association(:has_many, ActiveRecord::Reflection::ThroughReflection)
+    end
+
+    def find_through_model(source_model_name)
+      reflections_for_association(:has_many, ActiveRecord::Reflection::ThroughReflection).each do |kvpair|
+        reflection_model_name = kvpair[0].to_s.singularize
+        if reflection_model_name == source_model_name.underscore
+          reflection = kvpair[1]
+          return ModelInfo.new(reflection.options[:through].to_s.singularize)
+        end
+      end
+      nil
+    end
+
+    def reflections_for_association(association_type, type)
+      model.reflections.select { |key, value| value.macro == association_type && value.is_a?(type) }
+    end
+
+    def model_info_from_reflection(reflection_model_name, reflection)
+      model_info = ModelInfo.new(reflection_model_name)
+      if reflection.is_a? ActiveRecord::Reflection::ThroughReflection
+        model_info.through_model = ModelInfo.new reflection.options[:through].to_s.singularize
+      end
+      model_info
+    end
+
+    def model_info_array_for_association(association_type, type = ActiveRecord::Reflection::AssociationReflection)
+      reflections_for_association(association_type, type).collect do |kvpair|
+        reflection_model_name = kvpair[0].to_s.singularize
+        reflection = kvpair[1]
+        model_info_from_reflection(reflection_model_name, reflection)
+      end.sort do |a, b|
+        a.name <=> b.name
       end
     end
 
@@ -77,18 +106,27 @@ module ViewMapper
     end
 
     def belongs_to?(parent_model_name)
-      has_association_for? :belongs_to, parent_model_name
+      !association_for(:belongs_to, parent_model_name).nil?
     end
 
     def has_many?(child_model_name)
-      has_association_for? :has_many, child_model_name
+      !association_for(:has_many, child_model_name).nil?
     end
 
     def has_and_belongs_to_many?(model_name)
-      has_association_for? :has_and_belongs_to_many, model_name
+      !association_for(:has_and_belongs_to_many, model_name).nil?
+    end
+
+    def has_many_through?(model_name)
+      reflection = association_for(:has_many, model_name.pluralize)
+      reflection && reflection.is_a?(ActiveRecord::Reflection::ThroughReflection)
     end
 
     def has_foreign_key_for?(parent_model_name)
+      !foreign_key_for(parent_model_name).nil?
+    end
+
+    def foreign_key_for(parent_model_name)
       model.columns.detect { |col| is_foreign_key_for?(col, parent_model_name) }
     end
 
@@ -140,10 +178,10 @@ module ViewMapper
       end
     end
 
-    def has_association_for?(association, model_name)
-      !model.reflections.values.detect do |reflection|
+    def association_for(association, model_name)
+      model.reflections.values.detect do |reflection|
         reflection.name == model_name.underscore.to_sym && reflection.macro == association
-      end.nil?
+      end
     end
 
     def is_paperclip_column?(col)
@@ -161,7 +199,7 @@ module ViewMapper
     def has_column_for_attachment(attachment, paperclip_col)
       has_column = model.columns.map {|col| col.name}.include?(paperclip_col)
       if !has_column
-        @error = "Column \'#{paperclip_col}\' does not exist. First run script/generate paperclip #{name.downcase} #{attachment}."
+        @error = "Column \'#{paperclip_col}\' does not exist. First run script/generate paperclip #{name.underscore} #{attachment}."
       end
       has_column
     end

data/lib/view_mapper/views/belongs_to/belongs_to_view.rb

@@ -11,6 +11,20 @@ module ViewMapper
       [ BelongsToView.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_model_dependency_action(action) || !valid
+      end
+      if valid
+        m.template(
+          "view_form.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
+        )
+        add_model_actions(m) unless view_only?
+      end
+      m
+    end
+
     def validate
       super
       @valid &&= validate_parent_models

data/lib/view_mapper/views/belongs_to_auto_complete/belongs_to_auto_complete_view.rb

@@ -12,8 +12,15 @@ module ViewMapper
     end
 
     def manifest
-      m = super
+      m = super.edit do |action|
+        action unless is_model_dependency_action(action) || !valid
+      end
       if valid
+        m.template(
+          "view_form.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
+        )
+        add_model_actions(m) unless view_only?
         parent_models.reverse.each do |parent_model|
           m.route :name       => 'connect',
                   :path       => auto_complete_for_method(parent_model),
@@ -34,7 +41,7 @@ module ViewMapper
       @valid &&= validate_parent_models
     end
 
-    def validate_parent_model(parent_model)
+    def validate_parent_model(parent_model, child_model_name, child_model, check_setter_method = true)
       valid = super
       if valid && !parent_model.has_column?(field_for(parent_model))
         logger.warning "Model #{parent_model.name} does not have a #{field_for(parent_model)} column."

data/lib/view_mapper/views/has_many/templates/helper.rb

@@ -1,7 +1,7 @@
 module <%= controller_class_name %>Helper
 
   def remove_child_link(name, form_builder)
-    form_builder.hidden_field(:_delete) + link_to_function(name, "remove_child(this)")
+    form_builder.hidden_field(:_destroy) + link_to_function(name, "remove_child(this)")
   end
 
   def add_child_link(name, child, form_builder)

data/lib/view_mapper/views/has_many/templates/view_child_form.html.erb

@@ -6,7 +6,7 @@
   </p>
 <% end -%>
   <p>
-    <%%= f.hidden_field :_delete, :class => 'delete' %>
+    <%%= f.hidden_field :_destroy, :class => 'delete' %>
     <%%= remove_child_link 'remove', f %>
   </p>
 </div>

data/lib/view_mapper/views/has_many/templates/view_form.html.erb

@@ -15,6 +15,6 @@
 </div>
 
 <p>
-  <%%= add_child_link 'Add a <%= child_model.name %>', '<%= child_model.name.underscore %>', f %>
+  <%%= add_child_link 'Add <%= child_model.name %>', '<%= child_model.name.underscore %>', f %>
 </p>
 <% end -%>

data/lib/view_mapper/views/has_many_existing/has_many_existing_view.rb

@@ -0,0 +1,126 @@
+module ViewMapper
+  module HasManyExistingView
+
+    include BelongsToParentModels
+    include HasManyChildModels
+
+    def self.source_root
+      File.expand_path(File.dirname(__FILE__) + "/templates")
+    end
+
+    def source_roots_for_view
+      [
+        HasManyExistingView.source_root,
+        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_through_models_manifest(m)
+      m
+    end
+
+    def add_through_models_manifest(m)
+      add_child_model_actions(m) if valid && !view_only?
+      add_through_model_forms(m) if valid
+      m
+    end
+
+    def add_through_model_forms(m)
+      m.template(
+        "view_show.html.erb",
+        File.join('app/views', controller_class_path, controller_file_name, "show.html.erb"),
+        { :assigns => { :has_many_through_models => has_many_through_models } }
+      )
+      m.template(
+        "view_form.html.erb",
+        File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
+      )
+      has_many_through_models.each do |hmt_model|
+        m.template(
+          "view_child_form.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "_#{hmt_model.through_model.name.underscore}.html.erb"),
+          { :assigns => { :hmt_model => hmt_model } }
+
+        )
+      end
+      m.file('nested_attributes.js', 'public/javascripts/nested_attributes.js')
+      m
+    end
+
+    def validate
+      super
+      @valid &&= validate_hmt_models
+    end
+
+    def has_many_through_models
+      @hmt_models ||= find_hmt_models
+    end
+
+    def find_hmt_models
+      if view_param
+        view_param.split(',').collect do |param|
+          hmt_model_info_from_param(param)
+        end
+      elsif view_only?
+        model.has_many_through_models
+      else
+        []
+      end
+    end
+
+    def hmt_model_info_from_param(param)
+      if /(.*)\[(.*)\]/.match(param)
+        hmt_model = ModelInfo.new($1.singularize)
+        select_parent_by hmt_model, $2
+      else
+        hmt_model = ModelInfo.new(param.singularize)
+      end
+      hmt_model
+    end
+
+    def validate_hmt_models
+      models = has_many_through_models
+      if models.empty?
+        if view_only?
+          logger.error "No has_many through associations exist in class #{model.name}."
+        else
+          logger.error "No has_many through association specified."
+        end
+        return false
+      end
+      models.reject! { |hmt_model| !validate_hmt_model(hmt_model) }
+      @hmt_models = models
+      !models.empty?
+    end
+
+    def validate_hmt_model(hmt_model)
+      if !hmt_model.valid?
+        logger.error hmt_model.error
+        return false
+      elsif !hmt_model.has_many_through?(class_name)
+        logger.warning "Model #{hmt_model.name} does not contain a has_many through association for #{class_name}."
+        return false
+      end
+
+      hmt_model.through_model = hmt_model.find_through_model(class_name) if hmt_model.through_model.nil?
+      if !hmt_model.through_model.valid?
+        logger.error hmt_model.through_model.error
+        return false
+      elsif !validate_parent_model(hmt_model, hmt_model.through_model.name, hmt_model.through_model)
+        return false
+      elsif !validate_child_model(hmt_model.through_model, class_name, view_only? ? model : nil)
+        return false
+      elsif !validate_child_model(hmt_model.through_model, hmt_model.name, nil)
+        return false
+      end
+      true
+    end
+
+  end
+end

data/lib/view_mapper/views/has_many_existing/templates/model.rb

@@ -0,0 +1,21 @@
+class <%= class_name %> < ActiveRecord::Base
+<% has_many_through_models.each do |hmt_model| -%>
+<% attribs = Array.new(hmt_model.through_model.attributes) -%>
+<% attribs << hmt_model.through_model.foreign_key_for(hmt_model.name) -%>
+  has_many :<%= hmt_model.name.underscore.pluralize %>, :through => :<%= hmt_model.through_model.name.underscore.pluralize %>
+  has_many :<%= hmt_model.through_model.name.underscore.pluralize %>
+  accepts_nested_attributes_for :<%= hmt_model.through_model.name.underscore.pluralize %>,
+                                :allow_destroy => true<% if attribs.size > 0 %>,<% end %>
+<% if attribs.size > 0 -%>
+<% if attribs.size == 1 -%>
+                                :reject_if => proc { |attrs| attrs['<%= attribs[0].name %>'].blank? }
+<% elsif -%>
+                                :reject_if => proc { |attrs|
+<% attribs.each_with_index do |attr, i| -%>
+                                  attrs['<%= attr.name %>'].blank?<% unless i == attribs.size-1 %> &&<% end %>
+<% end -%>
+                                }
+<% end -%>
+<% end -%>
+<% end -%>
+end