view_mapper 0.2.0 → 0.3.0

data/Rakefile

@@ -5,14 +5,16 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "view_mapper"
-    gem.summary = %Q{Generate complex view code for your models}
-    gem.description = %Q{Generate complex view code for your models}
+    gem.summary = %Q{Scaffolding for your models and plugins}
+    gem.description = %Q{View_mapper will generate scaffolding for new or existing models, customized for the plugins you use in your app.}
     gem.email = "pat@patshaughnessy.net"
-    gem.homepage = "http://github.com/patshaughnessy/view_mapper"
+    gem.homepage = "http://patshaughnessy.net/view_mapper"
     gem.authors = ["Pat Shaughnessy"]
     gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "mocha"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/generators/view_for/view_for_generator.rb

@@ -7,13 +7,10 @@ class ViewForGenerator < ScaffoldGenerator
   attr_reader   :model
   attr_accessor :valid
 
-  BUILT_IN_COLUMNS = [ 'id', 'created_at', 'updated_at' ]
-
   def initialize(runtime_args, runtime_options = {})
     super
     @source_root = source_root_for_view
-    find_model @name
-    @columns = custom_columns unless model.nil?
+    @model = ModelInfo.new(@name)
     validate
   end
 
@@ -21,31 +18,6 @@ class ViewForGenerator < ScaffoldGenerator
     self.class.lookup('scaffold').path + "/templates"
   end
 
-  def find_model(model_name)
-    @model = nil
-    begin
-      @model = Object.const_get model_name.camelize
-      if !model.new.kind_of? ActiveRecord::Base
-        logger.error "Class '#{model_name}' is not an ActiveRecord::Base."
-        @model = nil
-      end
-    rescue NameError
-      logger.error "Class '#{model_name}' does not exist or contains a syntax error and could not be loaded."
-    rescue ActiveRecord::StatementInvalid
-      logger.error "Table for model '#{model_name}' does not exist - run rake db:migrate first."
-    end
-  end
-
-  def custom_columns
-    @model.columns.reject do |col|
-      built_in_columns.include? col.name
-    end
-  end
-
-  def built_in_columns
-    BUILT_IN_COLUMNS
-  end
-
   def record
     EditableManifest.new(self) { |m| yield m }
   end
@@ -69,17 +41,12 @@ class ViewForGenerator < ScaffoldGenerator
   end
 
   def attributes
-    @attributes_from_columns ||= attributes_from_columns
-  end
-
-  def attributes_from_columns
-    @columns.collect do |col|
-      Rails::Generator::GeneratedAttribute.new col.name, col.type
-    end
+    @attributes ||= model.attributes
   end
 
   def validate
-    @valid = !model.nil?
+    logger.error(model.error) if !model.valid?
+    @valid = model.valid?
   end
 
   def banner

data/lib/view_mapper/has_many_templates/controller.rb

@@ -0,0 +1,85 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  # GET /<%= table_name %>
+  # GET /<%= table_name %>.xml
+  def index
+    @<%= table_name %> = <%= class_name %>.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @<%= table_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/1
+  # GET /<%= table_name %>/1.xml
+  def show
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/new
+  # GET /<%= table_name %>/new.xml
+  def new
+    @<%= file_name %> = <%= class_name %>.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/1/edit
+  def edit
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+  end
+
+  # POST /<%= table_name %>
+  # POST /<%= table_name %>.xml
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+
+    respond_to do |format|
+      if @<%= file_name %>.save
+        flash[:notice] = '<%= class_name %> was successfully created.'
+        format.html { redirect_to(@<%= file_name %>) }
+        format.xml  { render :xml => @<%= file_name %>, :status => :created, :location => @<%= file_name %> }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /<%= table_name %>/1
+  # PUT /<%= table_name %>/1.xml
+  def update
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      if @<%= file_name %>.update_attributes(params[:<%= file_name %>])
+        flash[:notice] = '<%= class_name %> was successfully updated.'
+        format.html { redirect_to(@<%= file_name %>) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @<%= file_name %>.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /<%= table_name %>/1
+  # DELETE /<%= table_name %>/1.xml
+  def destroy
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+    @<%= file_name %>.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(<%= table_name %>_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/lib/view_mapper/has_many_templates/fixtures.yml

@@ -0,0 +1,19 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+<% unless attributes.empty? -%>
+one:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+
+two:
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+<% else -%>
+# one:
+#   column: value
+#
+# two:
+#   column: value
+<% end -%>

data/lib/view_mapper/has_many_templates/functional_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class <%= controller_class_name %>ControllerTest < ActionController::TestCase
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:<%= table_name %>)
+  end
+
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+
+  test "should create <%= file_name %>" do
+    assert_difference('<%= class_name %>.count') do
+      post :create, :<%= file_name %> => { }
+    end
+
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  test "should show <%= file_name %>" do
+    get :show, :id => <%= table_name %>(:one).to_param
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, :id => <%= table_name %>(:one).to_param
+    assert_response :success
+  end
+
+  test "should update <%= file_name %>" do
+    put :update, :id => <%= table_name %>(:one).to_param, :<%= file_name %> => { }
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  test "should destroy <%= file_name %>" do
+    assert_difference('<%= class_name %>.count', -1) do
+      delete :destroy, :id => <%= table_name %>(:one).to_param
+    end
+
+    assert_redirected_to <%= table_name %>_path
+  end
+end

data/lib/view_mapper/has_many_templates/helper.rb

@@ -0,0 +1,18 @@
+module <%= controller_class_name %>Helper
+
+  def remove_child_link(name, form_builder)
+    form_builder.hidden_field(:_delete) + link_to_function(name, "remove_child(this)")
+  end
+
+  def add_child_link(name, child, form_builder)
+    fields = escape_javascript(new_child_fields(child, form_builder))
+    link_to_function(name, h("add_child(this, \"#{child}\", \"#{fields}\")"))
+  end
+
+  def new_child_fields(child, form_builder)
+    form_builder.fields_for(child.pluralize.to_sym, child.camelize.constantize.new, :child_index => 'NEW_RECORD') do |f|
+      render(:partial => child.underscore, :locals => { :f => f })
+    end
+  end
+
+end

data/lib/view_mapper/has_many_templates/helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class <%= controller_class_name %>HelperTest < ActionView::TestCase
+end

data/lib/view_mapper/has_many_templates/layout.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title><%= controller_class_name %>: <%%= controller.action_name %></title>
+  <%%= stylesheet_link_tag 'scaffold' %>
+  <%%= javascript_include_tag 'prototype.js' %>
+  <%%= javascript_include_tag 'nested_attributes.js' %>
+</head>
+<body>
+
+<p style="color: green"><%%= flash[:notice] %></p>
+
+<%%= yield %>
+
+</body>
+</html>

data/lib/view_mapper/has_many_templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% for attribute in attributes -%>
+      t.<%= attribute.type %>   :<%= attribute.name %>
+<% end -%>
+<% unless options[:skip_timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/view_mapper/has_many_templates/model.rb

@@ -0,0 +1,23 @@
+class <%= class_name %> < ActiveRecord::Base
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+<% child_models.each do |child_model| -%>
+  has_many :<%= child_model.name.underscore.pluralize %>
+<% end -%>
+<% child_models.each do |child_model| -%>
+  accepts_nested_attributes_for :<%= child_model.name.underscore.pluralize %>,
+                                :allow_destroy => true<% if child_model.attributes.size > 0 %>,<% end %>
+<% if child_model.attributes.size > 0 -%>
+<% if child_model.attributes.size == 1 -%>
+                                :reject_if => proc { |attrs| attrs['<%= child_model.attributes[0].name %>'].blank? }
+<% elsif -%>
+                                :reject_if => proc { |attrs|
+<% child_model.attributes.each_with_index do |attr, i| -%>
+                                  attrs['<%= attr.name %>'].blank?<% unless i == child_model.attributes.size-1 %> &&<% end %>
+<% end -%>
+                                }
+<% end -%>
+<% end -%>
+<% end -%>
+end

data/lib/view_mapper/has_many_templates/nested_attributes.js

@@ -0,0 +1,13 @@
+function add_child(element, child_name, new_child) {
+  $(child_name + '_children').insert({
+    bottom: new_child.replace(/NEW_RECORD/g, new Date().getTime())
+  });
+}
+
+function remove_child(element) {
+  var hidden_field = $(element).previous("input[type=hidden]");
+  if (hidden_field) {
+    hidden_field.value = '1';
+  }
+  $(element).up(".child").hide();
+}

data/lib/view_mapper/has_many_templates/style.css

@@ -0,0 +1,58 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+.fieldWithErrors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#errorExplanation {
+  width: 400px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 12px;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#errorExplanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#errorExplanation p {
+  color: #333;
+  margin-bottom: 0;
+  padding: 5px;
+}
+
+#errorExplanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+.child {
+  border-left: 10px solid #eee;
+  padding-left:10px;
+}

data/lib/view_mapper/has_many_templates/unit_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/lib/view_mapper/has_many_templates/view_child_form.html.erb

@@ -0,0 +1,12 @@
+<div class="child">
+<% for attribute in child_model.attributes -%>
+  <p>
+    <%= child_model.name %> <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+<% end -%>
+  <p>
+    <%%= f.hidden_field :_delete, :class => 'delete' %>
+    <%%= remove_child_link 'remove', f %>
+  </p>
+</div>

data/lib/view_mapper/has_many_templates/view_edit.html.erb

@@ -0,0 +1,11 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+  <%%= render :partial => 'form', :locals => { :f => f } %>
+  <p>
+    <%%= f.submit 'Update' %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Show', @<%= singular_name %> %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/lib/view_mapper/has_many_templates/view_form.html.erb

@@ -0,0 +1,20 @@
+<%%= f.error_messages %>
+<% for attribute in attributes -%>
+
+<p>
+  <%%= f.label :<%= attribute.name %> %><br />
+  <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+</p>
+<% end -%>
+<% child_models.each do |child_model| -%>
+
+<div id='<%= child_model.name.underscore %>_children'>
+  <%% f.fields_for :<%= child_model.name.underscore.pluralize %> do |<%= child_model.name.underscore %>_form| %>
+    <%%= render :partial => '<%= child_model.name.underscore %>', :locals => { :f => <%= child_model.name.underscore %>_form } %>
+  <%% end %>
+</div>
+
+<p>
+  <%%= add_child_link 'Add a <%= child_model.name %>', '<%= child_model.name.underscore %>', f %>
+</p>
+<% end -%>

data/lib/view_mapper/has_many_templates/view_index.html.erb

@@ -0,0 +1,24 @@
+<h1>Listing <%= plural_name %></h1>
+
+<table>
+  <tr>
+<% for attribute in attributes -%>
+    <th><%= attribute.column.human_name %></th>
+<% end -%>
+  </tr>
+
+<%% @<%= plural_name %>.each do |<%= singular_name %>| %>
+  <tr>
+<% for attribute in attributes -%>
+    <td><%%=h <%= singular_name %>.<%= attribute.name %> %></td>
+<% end -%>
+    <td><%%= link_to 'Show', <%= singular_name %> %></td>
+    <td><%%= link_to 'Edit', edit_<%= singular_name %>_path(<%= singular_name %>) %></td>
+    <td><%%= link_to 'Destroy', <%= singular_name %>, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<%% end %>
+</table>
+
+<br />
+
+<%%= link_to 'New <%= singular_name %>', new_<%= singular_name %>_path %>

data/lib/view_mapper/has_many_templates/view_new.html.erb

@@ -0,0 +1,10 @@
+<h1>New <%= singular_name %></h1>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+  <%%= render :partial => 'form', :locals => { :f => f } %>
+  <p>
+    <%%= f.submit 'Create' %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/lib/view_mapper/has_many_templates/view_show.html.erb

@@ -0,0 +1,22 @@
+<% for attribute in attributes -%>
+<p>
+  <b><%= attribute.column.human_name %>:</b>
+  <%%=h @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+<% child_models.each do |child_model| -%>
+<%% @<%= singular_name %>.<%= child_model.name.underscore.pluralize %>.each do |<%= child_model.name.underscore %>| %>
+  <div class="child">
+<% for attribute in child_model.attributes -%>
+    <p>
+      <b><%= child_model.name %> <%= attribute.column.human_name %>:</b>
+      <%%=h <%= child_model.name.underscore%>.<%= attribute.name %> %>
+    </p>
+<% end -%>
+  </div>
+<%% end %>
+
+<% end -%>
+<%%= link_to 'Edit', edit_<%= singular_name %>_path(@<%= singular_name %>) %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/lib/view_mapper/has_many_view.rb

@@ -0,0 +1,124 @@
+module ViewMapper
+  module HasManyView
+
+    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
+    end
+
+    def is_model_dependency_action(action)
+      action[0] == :dependency && action[1].include?('model')
+    end
+
+    def is_view_show(action)
+      action[0] == :template && action[1].include?('view_show.html.erb')
+    end
+
+    def add_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")
+      unless options[:skip_fixture]
+        m.template 'fixtures.yml', File.join('test/fixtures', "#{table_name}.yml")
+      end
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb',
+                             'db/migrate',
+                             :assigns => { :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}" },
+                             :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+      end
+    end
+
+    def child_models
+      @child_models ||= find_child_models
+    end
+
+    def find_child_models
+      if view_param
+        view_param.split(',').collect { |param| ModelInfo.new(param.singularize) }
+      elsif view_only?
+        model.child_models
+      else
+        []
+      end
+    end
+
+    def validate
+      super
+      @valid &&= validate_child_models
+    end
+
+    def validate_child_models
+      cms = child_models
+      if cms.empty?
+        if view_only?
+          logger.error "No has_many associations exist in class #{model.name}."
+        else
+          logger.error "No has_many association specified."
+        end
+        return false
+      end
+      cms.reject! { |child_model| !validate_child_model(child_model) }
+      @child_models = cms
+      !cms.empty?
+    end
+
+    def validate_child_model(child_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}."
+        return false
+      else
+        if child_model.has_many?(class_name.pluralize) || child_model.has_and_belongs_to_many?(class_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}."
+          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}."
+          return false
+        end
+      end
+      true
+    end
+
+    def validate_child_model_associations(child_model)
+      if child_model.belongs_to?(class_name)
+        true
+      else
+        child_model.has_many?(class_name.pluralize) || child_model.has_and_belongs_to_many?(class_name.pluralize)
+      end
+    end
+  end
+end