view_mapper 0.1.0

data/lib/view_mapper/editable_manifest.rb

@@ -0,0 +1,10 @@
+class EditableManifest < Rails::Generator::Manifest
+
+  def edit
+    @actions = @actions.collect do |action|
+      yield action
+    end.compact
+    return self
+  end
+
+end

data/lib/view_mapper/route_action.rb

@@ -0,0 +1,32 @@
+module ViewMapper
+  module RouteAction
+
+    module Base
+      def route_code(route_options)
+        "map.#{route_options[:name]} '#{route_options[:path]}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+      end
+      def route_file
+        'config/routes.rb'
+      end
+    end
+
+    module Create
+      def route(route_options)
+        sentinel = 'ActionController::Routing::Routes.draw do |map|'
+        logger.route route_code(route_options)
+        gsub_file route_file, /(#{Regexp.escape(sentinel)})/mi do |m|
+            "#{m}\n  #{route_code(route_options)}\n"
+        end
+      end
+    end
+
+    module Destroy
+      def route(route_options)
+        logger.remove_route route_code(route_options)
+        to_remove = "\n  #{route_code(route_options)}"
+        gsub_file route_file, /(#{to_remove})/mi, ''
+      end
+    end
+
+  end
+end

data/lib/view_mapper/view_mapper.rb

@@ -0,0 +1,33 @@
+module ViewMapper
+
+  def initialize(runtime_args, runtime_options = {})
+    Rails::Generator::Commands::Base.class_eval { include RouteAction::Base }
+    Rails::Generator::Commands::Create.class_eval { include RouteAction::Create }
+    Rails::Generator::Commands::Destroy.class_eval { include RouteAction::Destroy }
+    super
+    if options[:view]
+      self.extend(view_class)
+      @source_root = source_root_for_view
+    end
+  end
+
+  def view_class
+    "ViewMapper::#{view_name.camelize}View".constantize
+  end
+
+  def view_name
+    options[:view].split(':')[0]
+  end
+
+  def view_param
+    options[:view].split(':')[1]
+  end
+
+  def add_options!(opt)
+    opt.on("--view name", String, "Specify a view to generate") do |name|
+      options[:view] = name
+    end
+    super
+  end
+
+end

data/lib/view_mapper.rb

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

data/test/auto_complete_test.rb

@@ -0,0 +1,146 @@
+require 'test_helper'
+
+class AutoCompleteViewTest < Test::Unit::TestCase
+
+  attr_reader :singular_name
+  attr_reader :plural_name
+  attr_reader :attributes
+  attr_reader :auto_complete_attribute
+  attr_reader :controller_class_name
+  attr_reader :table_name
+  attr_reader :class_name
+  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|
+
+    context "A #{gen} generator instantiated for a test model" do
+      should "return an error message without an auto_complete param" do
+        Rails::Generator::Base.logger.expects('error').with('No auto_complete attribute specified.')
+        new_generator_for_test_model(gen, ['--view', 'auto_complete'])
+      end
+
+      should "return an error message with a bad auto_complete param" do
+        Rails::Generator::Base.logger.expects('error').with('Field \'blah\' does not exist.')
+        new_generator_for_test_model(gen, ['--view', 'auto_complete:blah'])
+      end
+    end
+
+    context "A #{gen} generator instantiated for a test model with auto_complete on the first_name field" do
+      setup do
+        @gen = new_generator_for_test_model(gen, ['--view', 'auto_complete:first_name'])
+      end
+
+      should "find the auto complete column name" do
+        assert_equal 'first_name', @gen.auto_complete_attribute
+      end
+
+      should "have the correct auto_complete_for method name" do
+        assert_equal 'auto_complete_for_testy_first_name', @gen.auto_complete_for_method
+      end
+    end
+
+    context "A #{gen} generator instantiated for a test model with auto_complete on the address field" do
+      setup do
+        @gen = new_generator_for_test_model(gen, ['--view', 'auto_complete:address'])
+      end
+
+      should "return the proper source root folder" do
+        assert_equal './test/../lib/view_mapper/auto_complete_templates', @gen.source_root
+      end
+
+      view_for_templates = %w{ new edit index show }
+      view_for_templates.each do | template |
+        should "render the #{template} template as expected" do
+          @attributes = @gen.attributes
+          @singular_name = @gen.singular_name
+          @plural_name = @gen.plural_name
+          @auto_complete_attribute = @gen.auto_complete_attribute
+          template_file = File.open(File.join(File.dirname(__FILE__), "/../lib/view_mapper/auto_complete_templates/view_#{template}.html.erb"))
+          result = ERB.new(template_file.read, nil, '-').result(binding)
+          expected_file = File.open(File.join(File.dirname(__FILE__), "expected_templates/auto_complete/#{template}.html.erb"))
+          assert_equal expected_file.read, result
+        end
+      end
+
+      should "render the layout template as expected" do
+        @controller_class_name = @gen.controller_class_name
+        template_file = File.open(File.join(File.dirname(__FILE__), "/../lib/view_mapper/auto_complete_templates/layout.html.erb"))
+        result = ERB.new(template_file.read, nil, '-').result(binding)
+        expected_file = File.open(File.join(File.dirname(__FILE__), "expected_templates/auto_complete/testies.html.erb"))
+        assert_equal expected_file.read, result
+      end
+
+      should "render the controller template as expected" do
+        @controller_class_name = @gen.controller_class_name
+        @table_name = @gen.table_name
+        @class_name = @gen.class_name
+        @file_name = @gen.file_name
+        @controller_singular_name = @gen.controller_singular_name
+        @auto_complete_attribute = @gen.auto_complete_attribute
+        template_file = File.open(File.join(File.dirname(__FILE__), "/../lib/view_mapper/auto_complete_templates/controller.rb"))
+        result = ERB.new(template_file.read, nil, '-').result(binding)
+        expected_file = File.open(File.join(File.dirname(__FILE__), "expected_templates/auto_complete/testies_controller.rb"))
+        assert_equal expected_file.read, result
+      end
+    end
+
+    context "A Rails generator script" do
+      setup do
+        setup_test_model
+        @generator_script = Rails::Generator::Scripts::Generate.new
+      end
+
+      should "add the proper auto_complete route to routes.rb when run on the #{gen} generator with a valid auto_complete field" do
+        Rails::Generator::Commands::Create.any_instance.stubs(:directory)
+        Rails::Generator::Commands::Create.any_instance.stubs(:template)
+        Rails::Generator::Commands::Create.any_instance.stubs(:route_resources)
+        Rails::Generator::Commands::Create.any_instance.stubs(:file)
+        Rails::Generator::Commands::Create.any_instance.stubs(:dependency)
+        Rails::Generator::Base.logger.stubs(:route)
+
+        expected_path = File.dirname(__FILE__) + '/expected_templates/auto_complete'
+        standard_routes_file = expected_path + '/standard_routes.rb'
+        expected_routes_file = expected_path + '/expected_routes.rb'
+        test_routes_file = expected_path + '/routes.rb'
+        ViewForGenerator.any_instance.stubs(:destination_path).returns test_routes_file
+        ScaffoldForViewGenerator.any_instance.stubs(:destination_path).returns test_routes_file
+        File.copy(standard_routes_file, test_routes_file)
+        Rails::Generator::Commands::Create.any_instance.stubs(:route_file).returns(test_routes_file)
+        @generator_script.run(generator_script_cmd_line(gen, ['--view', 'auto_complete:address']))
+        assert_equal File.open(expected_routes_file).read, File.open(test_routes_file).read
+        File.delete(test_routes_file)
+      end
+
+      should "not perform any actions when run on the #{gen} generator with no auto_complete field" do
+        Rails::Generator::Commands::Create.any_instance.expects(:directory).never
+        Rails::Generator::Commands::Create.any_instance.expects(:template).never
+        Rails::Generator::Commands::Create.any_instance.expects(:route_resources).never
+        Rails::Generator::Commands::Create.any_instance.expects(:file).never
+        Rails::Generator::Commands::Create.any_instance.expects(:route).never
+        Rails::Generator::Base.logger.stubs(:error)
+        Rails::Generator::Base.logger.stubs(:route)
+        @generator_script.run(generator_script_cmd_line(gen, ['--view', 'auto_complete']))
+      end
+    end
+  end
+
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/editable_manifest_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class EditableManifestTest < Test::Unit::TestCase
+
+  def record
+    EditableManifest.new(self) { |m| yield m }
+  end
+
+  def action(param)
+    @actions_received << param
+  end
+
+  context "An editable manifest with a couple of recorded actions" do
+    setup do
+      @actions_received = []
+      @man = record do |m|
+        m.action('one')
+        m.action('two')
+      end
+    end
+
+    should "allow me to delete an action" do
+      @man.edit do |action|
+        action unless action[1].include? 'one'
+      end
+      @man.replay(self)
+      assert_does_not_contain @actions_received, 'one'
+      assert_contains @actions_received, 'two'
+    end
+
+  end
+end

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

@@ -0,0 +1,23 @@
+<h1>Editing testy</h1>
+
+<% form_for(@testy) 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 />
+    <%= text_field_with_auto_complete :testy, :address, {}, { :method => :get } %>
+  </p>
+  <p>
+    <%= f.submit 'Update' %>
+  </p>
+<% end %>
+
+<%= link_to 'Show', @testy %> |
+<%= link_to 'Back', testies_path %>

data/test/expected_templates/auto_complete/expected_routes.rb

@@ -0,0 +1,45 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect 'auto_complete_for_testy_address', :controller => 'testies', :action => 'auto_complete_for_testy_address'
+
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing the them or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/test/expected_templates/auto_complete/index.html.erb

@@ -0,0 +1,24 @@
+<h1>Listing testies</h1>
+
+<table>
+  <tr>
+    <th>First name</th>
+    <th>Last name</th>
+    <th>Address</th>
+  </tr>
+
+<% @testies.each do |testy| %>
+  <tr>
+    <td><%=h testy.first_name %></td>
+    <td><%=h testy.last_name %></td>
+    <td><%=h testy.address %></td>
+    <td><%= link_to 'Show', testy %></td>
+    <td><%= link_to 'Edit', edit_testy_path(testy) %></td>
+    <td><%= link_to 'Destroy', testy, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New testy', new_testy_path %>

data/test/expected_templates/auto_complete/new.html.erb

@@ -0,0 +1,22 @@
+<h1>New testy</h1>
+
+<% form_for(@testy) 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 />
+    <%= text_field_with_auto_complete :testy, :address, {}, { :method => :get } %>
+  </p>
+  <p>
+    <%= f.submit 'Create' %>
+  </p>
+<% end %>
+
+<%= link_to 'Back', testies_path %>

data/test/expected_templates/auto_complete/show.html.erb

@@ -0,0 +1,18 @@
+<p>
+  <b>First name:</b>
+  <%=h @testy.first_name %>
+</p>
+
+<p>
+  <b>Last name:</b>
+  <%=h @testy.last_name %>
+</p>
+
+<p>
+  <b>Address:</b>
+  <%=h @testy.address %>
+</p>
+
+
+<%= link_to 'Edit', edit_testy_path(@testy) %> |
+<%= link_to 'Back', testies_path %>

data/test/expected_templates/auto_complete/standard_routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing the them or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/test/expected_templates/auto_complete/testies.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>Testies: <%= 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/test/expected_templates/auto_complete/testies_controller.rb

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

data/test/fake/fake_generator.rb

@@ -0,0 +1,3 @@
+class FakeGenerator < ScaffoldGenerator
+  include ViewMapper
+end

data/test/fake_view.rb

@@ -0,0 +1,7 @@
+module ViewMapper
+  module FakeView
+    def source_root_for_view
+      '/some/path/templates'
+    end
+  end
+end