view_mapper 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Pat Shaughnessy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,116 @@
+View_mapper: Generate complex view code for your models.
+
+See: http://patshaughnessy.net/view_mapper for more details.
+
+Two generators are provided:
+
+1. view_for: This will generate the specified view code for an existing model.
+
+   script/generate view_for model [ --view view:view_parameter ]
+
+   View_for generates HTML fields for each of the specified model's columns.
+   If no view is specified, standard Rails scaffolding code will be generated.
+
+2. scaffold_for_view: The same as view_for, except that it will also generate the
+   model code files as well. If no view is specified, this generator is identical to
+   the standard Rails scaffold generator.
+
+   script/generate scaffold_for_view model [ --view view:view_parameter ]
+
+
+
+
+Right now, one custom view is provided:
+
+1. auto_complete: Generates view code that uses the standard Rails auto_complete plugin
+                  for type ahead behavior.
+
+... more views to come!
+
+
+
+Examples:
+---------
+
+- Generate standard Rails scaffolding for an existing model called "widget":
+
+./script/generate view_for widget
+      exists  app/controllers/
+      exists  app/helpers/
+      create  app/views/widgets
+      exists  app/views/layouts/
+      exists  test/functional/
+      exists  test/unit/
+      exists  test/unit/helpers/
+      exists  public/stylesheets/
+      create  app/views/widgets/index.html.erb
+      create  app/views/widgets/show.html.erb
+      create  app/views/widgets/new.html.erb
+      create  app/views/widgets/edit.html.erb
+      create  app/views/layouts/widgets.html.erb
+   identical  public/stylesheets/scaffold.css
+      create  app/controllers/widgets_controller.rb
+      create  test/functional/widgets_controller_test.rb
+      create  app/helpers/widgets_helper.rb
+      create  test/unit/helpers/widgets_helper_test.rb
+       route  map.resources :widgets
+
+- Generate scaffolding for an existing "office" model with auto complete on the "address" field:
+
+./script/generate view_for office --view auto_complete:address
+      exists  app/controllers/
+      exists  app/helpers/
+      create  app/views/offices
+      exists  app/views/layouts/
+      exists  test/functional/
+      exists  test/unit/
+      exists  test/unit/helpers/
+      exists  public/stylesheets/
+      create  app/views/offices/index.html.erb
+      create  app/views/offices/show.html.erb
+      create  app/views/offices/new.html.erb
+      create  app/views/offices/edit.html.erb
+      create  app/views/layouts/offices.html.erb
+   identical  public/stylesheets/scaffold.css
+      create  app/controllers/offices_controller.rb
+      create  test/functional/offices_controller_test.rb
+      create  app/helpers/offices_helper.rb
+      create  test/unit/helpers/offices_helper_test.rb
+       route  map.resources :offices
+       route  map.connect 'auto_complete_for_office_address', :controller => 'offices', :action => 'auto_complete_for_office_address'
+
+- Generate a new model called "group" containing two fields "name" and "column"
+  and also implement auto complete on the "name" column:
+
+./script/generate scaffold_for_view group name:string count:integer --view auto_complete:name
+      exists  app/models/
+      exists  app/controllers/
+      exists  app/helpers/
+      create  app/views/groups
+      exists  app/views/layouts/
+      exists  test/functional/
+      exists  test/unit/
+      exists  test/unit/helpers/
+      exists  public/stylesheets/
+      create  app/views/groups/index.html.erb
+      create  app/views/groups/show.html.erb
+      create  app/views/groups/new.html.erb
+      create  app/views/groups/edit.html.erb
+      create  app/views/layouts/groups.html.erb
+   identical  public/stylesheets/scaffold.css
+      create  app/controllers/groups_controller.rb
+      create  test/functional/groups_controller_test.rb
+      create  app/helpers/groups_helper.rb
+      create  test/unit/helpers/groups_helper_test.rb
+       route  map.resources :groups
+  dependency  model
+      exists    app/models/
+      exists    test/unit/
+      exists    test/fixtures/
+      create    app/models/group.rb
+      create    test/unit/group_test.rb
+      create    test/fixtures/groups.yml
+      exists    db/migrate
+      create    db/migrate/20090930171024_create_groups.rb
+       route  map.connect 'auto_complete_for_group_name', :controller => 'groups', :action => 'auto_complete_for_group_name'
+

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+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.email = "pat@patshaughnessy.net"
+    gem.homepage = "http://github.com/patshaughnessy/view_mapper"
+    gem.authors = ["Pat Shaughnessy"]
+    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
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "view_mapper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/generators/scaffold_for_view/USAGE

@@ -0,0 +1 @@
+script/generate scaffold_for_view model [ --view view:view_parameter ]

data/generators/scaffold_for_view/scaffold_for_view_generator.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../../lib/view_mapper'
+
+class ScaffoldForViewGenerator < ScaffoldGenerator
+
+  include ViewMapper
+
+  attr_accessor :valid
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @source_root = source_root_for_view
+    validate
+  end
+
+  def source_root_for_view
+    self.class.lookup('scaffold').path + "/templates"
+  end
+
+  def validate
+    @valid = true
+  end
+
+  def record
+    EditableManifest.new(self) { |m| yield m }
+  end
+
+  def manifest
+    super.edit do |action|
+      action unless !@valid
+    end
+  end
+
+  def banner
+    "script/generate scaffold_for_view model [ --view view:view_parameter ]"
+  end
+
+end

data/generators/view_for/USAGE

@@ -0,0 +1 @@
+script/generate view_for model [ --view view:view_parameter ]

data/generators/view_for/view_for_generator.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/../../lib/view_mapper'
+
+class ViewForGenerator < ScaffoldGenerator
+
+  include ViewMapper
+
+  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?
+    validate
+  end
+
+  def source_root_for_view
+    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."
+    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 record
+    EditableManifest.new(self) { |m| yield m }
+  end
+
+  def manifest
+    super.edit do |action|
+      action unless is_model_action(action) || !valid
+    end
+  end
+
+  def is_model_action(action)
+    is_create_model_dir_action(action) || is_model_dependency_action(action)
+  end
+
+  def is_create_model_dir_action(action)
+    action[0] == :directory && action[1].include?('app/models/')
+  end
+
+  def is_model_dependency_action(action)
+    action[0] == :dependency && action[1].include?('model')
+  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
+  end
+
+  def validate
+    @valid = !model.nil?
+  end
+
+  def banner
+    "script/generate view_for model [ --view view:view_parameter ]"
+  end
+
+end

data/lib/view_mapper/auto_complete_templates/controller.rb

@@ -0,0 +1,88 @@
+class <%= controller_class_name %>Controller < ApplicationController
+
+  auto_complete_for :<%= controller_singular_name %>, :<%= auto_complete_attribute %>
+
+  # 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/auto_complete_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/auto_complete_templates/helper.rb

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

data/lib/view_mapper/auto_complete_templates/helper_test.rb

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

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

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

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

@@ -0,0 +1,21 @@
+<h1>Editing <%= singular_name %></h1>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+  <%%= f.error_messages %>
+<% for attribute in attributes -%>
+  <p>
+    <%%= f.label :<%= attribute.name %> %><br />
+<%- if auto_complete_attribute == attribute.name -%>
+    <%%= text_field_with_auto_complete :<%= singular_name %>, :<%= attribute.name %>, {}, { :method => :get } %>
+<%- else -%>
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+<%- end -%>
+  </p>
+<% end -%>
+  <p>
+    <%%= f.submit 'Update' %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Show', @<%= singular_name %> %> |
+<%%= link_to 'Back', <%= plural_name %>_path %>

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

@@ -0,0 +1,20 @@
+<h1>New <%= singular_name %></h1>
+
+<%% form_for(@<%= singular_name %>) do |f| %>
+  <%%= f.error_messages %>
+<%- for attribute in attributes -%>
+  <p>
+    <%%= f.label :<%= attribute.name %> %><br />
+<%- if auto_complete_attribute == attribute.name -%>
+    <%%= text_field_with_auto_complete :<%= singular_name %>, :<%= attribute.name %>, {}, { :method => :get } %>
+<%- else -%>
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+<%- end -%>
+  </p>
+<%- end -%>
+  <p>
+    <%%= f.submit 'Create' %>
+  </p>
+<%% end %>
+
+<%%= link_to 'Back', <%= plural_name %>_path %>

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

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

data/lib/view_mapper/auto_complete_view.rb

@@ -0,0 +1,44 @@
+module ViewMapper
+  module AutoCompleteView
+
+    def source_root_for_view
+      File.dirname(__FILE__) + "/auto_complete_templates"
+    end
+
+    def manifest
+      manifest = super
+      if @valid
+        manifest.route :name       => 'connect',
+                       :path       => auto_complete_for_method,
+                       :controller => controller_file_name,
+                       :action     => auto_complete_for_method
+      end
+      manifest
+    end
+
+    def auto_complete_for_method
+      "auto_complete_for_#{singular_name}_#{auto_complete_attribute}"
+    end
+
+    def auto_complete_attribute
+      view_param
+    end
+
+    def validate
+      super
+      @valid &&= validate_auto_complete_attribute
+    end
+
+    def validate_auto_complete_attribute
+      if auto_complete_attribute.nil?
+        logger.error "No auto_complete attribute specified."
+        return false
+      elsif attributes.find { |a| a.name == auto_complete_attribute }.nil?
+        logger.error "Field '#{auto_complete_attribute}' does not exist."
+        return false
+      end
+      true
+    end
+
+  end
+end