view_mapper 0.1.0 → 0.2.0

data/README.rdoc

@@ -0,0 +1,44 @@
+=View Mapper
+
+View Mapper will generate scaffolding code and map it to your existing models.
+
+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:
+
+  script/generate view_for office --view auto_complete:address
+
+...will generate an "auto_complete view" for your existing office model. This is scaffolding that uses the attributes for your office model, and with code added to use the auto_complete plugin for the address field.
+
+  script/generate view_for song --view paperclip
+
+...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.
+
+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:
+
+  script/generate scaffold_for_view office address:string code:string --view auto_complete:address
+
+== Installation:
+
+  gem sources -a http://gemcutter.org
+  sudo gem install view_mapper
+
+== Usage:
+
+  script/generate view_for model [ --view view_name[:param] ]
+
+This will generate scaffolding for an existing model. If you provide a view parameter, then View Mapper will enhance the scaffolding to use the specified plugin or feature with your model.
+
+  script/generate scaffold_for_view model attributes [ --view view_name[:param] ]
+
+This is the same as view_for, but will also generate a new model at the same time.
+
+== Views
+
+{auto_complete}[http://patshaughnessy.net/2009/10/1/auto_complete-scaffolding]: Generates scaffolding that uses the standard Rails auto_complete plugin for type ahead behavior.
+
+{paperclip}[http://patshaughnessy.net/2009/10/16/paperclip-scaffolding]: Generates scaffolding that uses Paperclip to upload and download files.
+
+== Examples
+
+For detailed examples and more information see: http://patshaughnessy.net/view_mapper

data/Rakefile

@@ -13,7 +13,6 @@ begin
     gem.add_development_dependency "thoughtbot-shoulda"
     # 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.1.0
+0.2.0

data/generators/view_for/view_for_generator.rb

@@ -30,7 +30,7 @@ class ViewForGenerator < ScaffoldGenerator
         @model = nil
       end
     rescue NameError
-      logger.error "Class '#{model_name}' does not exist."
+      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
@@ -38,10 +38,14 @@ class ViewForGenerator < ScaffoldGenerator
 
   def custom_columns
     @model.columns.reject do |col|
-      BUILT_IN_COLUMNS.include? col.name
+      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

data/lib/view_mapper/paperclip_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/paperclip_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/paperclip_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/paperclip_templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= controller_class_name %>Helper
+end

data/lib/view_mapper/paperclip_templates/helper_test.rb

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

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

@@ -0,0 +1,17 @@
+<!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' %>
+</head>
+<body>
+
+<p style="color: green"><%%= flash[:notice] %></p>
+
+<%%= yield %>
+
+</body>
+</html>

data/lib/view_mapper/paperclip_templates/migration.rb

@@ -0,0 +1,22 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% for attribute in attributes -%>
+      t.<%= attribute.type %>   :<%= attribute.name %>
+<% end -%>
+<% for attachment in attachments -%>
+      t.string   :<%= attachment %>_file_name
+      t.string   :<%= attachment %>_content_type
+      t.integer  :<%= attachment %>_file_size
+      t.datetime :<%= attachment %>_updated_at
+<% end -%>
+<% unless options[:skip_timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/view_mapper/paperclip_templates/model.rb

@@ -0,0 +1,8 @@
+class <%= class_name %> < ActiveRecord::Base
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+<% for attachment in attachments -%>
+  has_attached_file :<%= attachment %>
+<% end -%>
+end

data/lib/view_mapper/paperclip_templates/style.css

@@ -0,0 +1,54 @@
+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;
+}
+

data/lib/view_mapper/paperclip_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/paperclip_templates/view_edit.html.erb

@@ -0,0 +1,23 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%% form_for(@<%= singular_name %>, :html => { :multipart => true }) do |f| %>
+  <%%= f.error_messages %>
+<% for attribute in attributes -%>
+  <p>
+    <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+<% end -%>
+<% for attachment in attachments -%>
+  <p>
+    <%%= f.label :<%= attachment%> %><br />
+    <%%= f.file_field :<%= attachment%> %>
+  </p>
+<% end -%>
+  <p>
+    <%%= f.submit 'Update' %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Show', @<%= singular_name %> %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/lib/view_mapper/paperclip_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/paperclip_templates/view_new.html.erb

@@ -0,0 +1,22 @@
+<h1>New <%= singular_name %></h1>
+
+<%% form_for(@<%= singular_name %>, :html => { :multipart => true }) do |f| %>
+  <%%= f.error_messages %>
+<% for attribute in attributes -%>
+  <p>
+    <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </p>
+<%- end -%>
+<% for attachment in attachments -%>
+  <p>
+    <%%= f.label :<%= attachment%> %><br />
+    <%%= f.file_field :<%= attachment%> %>
+  </p>
+<% end -%>
+  <p>
+    <%%= f.submit 'Create' %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Back', <%= plural_name %>_path %>

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

@@ -0,0 +1,17 @@
+<% for attribute in attributes -%>
+<p>
+  <b><%= attribute.column.human_name %>:</b>
+  <%%=h @<%= singular_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+<% for attachment in attachments -%>
+<p>
+  <b><%= attachment.capitalize %>:</b>
+  <%%= link_to @<%= singular_name %>.<%= attachment%>_file_name, @<%= singular_name %>.<%= attachment%>.url %><br>
+</p>
+
+<% end -%>
+
+<%%= link_to 'Edit', edit_<%= singular_name %>_path(@<%= singular_name %>) %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

data/lib/view_mapper/paperclip_view.rb

@@ -0,0 +1,125 @@
+module ViewMapper
+  module PaperclipView
+
+    def source_root_for_view
+      File.dirname(__FILE__) + "/paperclip_templates"
+    end
+
+    def manifest
+      m = super.edit do |action|
+        action unless is_model_dependency_action(action) || !valid
+      end
+      unless view_only? || !valid
+        add_model_actions(m)
+      end
+      m
+    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 is_model_dependency_action(action)
+      action[0] == :dependency && action[1].include?('model')
+    end
+
+    def attachments
+      if view_param
+        parse_attachments_from_param
+      elsif view_only?
+        inspect_model_for_attachments
+      else
+        []
+      end
+    end
+
+    def parse_attachments_from_param
+      view_param.split(',')
+    end
+
+    def inspect_model_for_attachments
+      if model.respond_to?('attachment_definitions') && model.attachment_definitions
+        model.attachment_definitions.keys.collect { |name| name.to_s }.sort
+      else
+        []
+      end
+    end
+
+    def validate
+      @valid = validate_attachments
+      @valid &&= super
+    end
+
+    def validate_attachments
+      if !paperclip_installed
+        logger.error "The Paperclip plugin does not appear to be installed."
+        return false
+      elsif attachments == []
+        if view_only?
+          logger.warning "No paperclip attachments exist on the specified class."
+        else
+          logger.warning "No paperclip attachments specified."
+        end
+        return false
+      else
+        !attachments.detect { |a| !validate_attachment(a) }
+      end
+    end
+
+    def validate_attachment(attachment)
+      if view_only?
+        if !has_attachment(attachment.to_sym)
+          logger.error "Attachment '#{attachment}' does not exist."
+          return false
+        elsif !has_columns_for_attachment(attachment)
+          return false
+        end
+      end
+      true
+    end
+
+    def has_attachment(attachment)
+      model.attachment_definitions && model.attachment_definitions.has_key?(attachment)
+    end
+
+    def has_columns_for_attachment(attachment)
+      !paperclip_columns_for_attachment(attachment).detect { |paperclip_col| !has_column_for_attachment(attachment, paperclip_col) }
+    end
+
+    def has_column_for_attachment(attachment, paperclip_col)
+      has_column = model.columns.collect { |col| col.name }.include?(paperclip_col)
+      if !has_column
+        logger.error "Column \'#{paperclip_col}\' does not exist. First run script/generate paperclip #{name} #{attachment}."
+      end
+      has_column
+    end
+
+    def built_in_columns
+      attachments.inject(super) do |result, element|
+        result + paperclip_columns_for_attachment(element)
+      end
+    end
+
+    def paperclip_columns_for_attachment(attachment)
+      %w{ file_name content_type file_size updated_at }.collect do |col|
+        "#{attachment}_#{col}"
+      end
+    end
+
+    def paperclip_installed
+      ActiveRecord::Base.methods.include? 'has_attached_file'
+    end
+
+  end
+end

data/lib/view_mapper/view_mapper.rb

@@ -23,6 +23,10 @@ module ViewMapper
     options[:view].split(':')[1]
   end
 
+  def view_only?
+    self.respond_to?(:model)
+  end
+
   def add_options!(opt)
     opt.on("--view name", String, "Specify a view to generate") do |name|
       options[:view] = name

data/lib/view_mapper.rb

@@ -1,4 +1,5 @@
 require 'view_mapper/auto_complete_view'
+require 'view_mapper/paperclip_view'
 require 'view_mapper/route_action'
 require 'view_mapper/editable_manifest'
 require 'view_mapper/view_mapper'

data/test/auto_complete_test.rb

@@ -12,23 +12,6 @@ class AutoCompleteViewTest < Test::Unit::TestCase
   attr_reader :file_name
   attr_reader :controller_singular_name
 
-  def generator_cmd_line(gen, args)
-    if gen == 'view_for'
-      cmd_line = ['testy']
-    else
-      cmd_line = ['testy', 'first_name:string', 'last_name:string', 'address:string']
-    end
-    (cmd_line << args).flatten
-  end
-
-  def generator_script_cmd_line(gen, args)
-    ([gen] << generator_cmd_line(gen, args)).flatten
-  end
-
-  def new_generator_for_test_model(gen, args)
-    Rails::Generator::Base.instance(gen, generator_cmd_line(gen, args))
-  end
-
   generators = %w{ view_for scaffold_for_view }
   generators.each do |gen|
 

data/test/expected_templates/paperclip/create_testies.rb

@@ -0,0 +1,23 @@
+class CreateTesties < ActiveRecord::Migration
+  def self.up
+    create_table :testies do |t|
+      t.string   :first_name
+      t.string   :last_name
+      t.string   :address
+      t.string   :avatar_file_name
+      t.string   :avatar_content_type
+      t.integer  :avatar_file_size
+      t.datetime :avatar_updated_at
+      t.string   :avatar2_file_name
+      t.string   :avatar2_content_type
+      t.integer  :avatar2_file_size
+      t.datetime :avatar2_updated_at
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :testies
+  end
+end

data/test/expected_templates/paperclip/edit.html.erb

@@ -0,0 +1,31 @@
+<h1>Editing testy</h1>
+
+<% form_for(@testy, :html => { :multipart => true }) do |f| %>
+  <%= f.error_messages %>
+  <p>
+    <%= f.label :first_name %><br />
+    <%= f.text_field :first_name %>
+  </p>
+  <p>
+    <%= f.label :last_name %><br />
+    <%= f.text_field :last_name %>
+  </p>
+  <p>
+    <%= f.label :address %><br />
+    <%= f.text_field :address %>
+  </p>
+  <p>
+    <%= f.label :avatar %><br />
+    <%= f.file_field :avatar %>
+  </p>
+  <p>
+    <%= f.label :avatar2 %><br />
+    <%= f.file_field :avatar2 %>
+  </p>
+  <p>
+    <%= f.submit 'Update' %>
+  </p>
+<% end %>
+
+<%= link_to 'Show', @testy %> |
+<%= link_to 'Back', testies_path %>