admin_assistant 1.0.0 → 1.0.1

data/lib/admin_assistant.rb

@@ -10,15 +10,23 @@ end
 require 'will_paginate'
 
 class AdminAssistant
-  attr_reader   :base_settings, :controller_class, :form_settings, 
-                :index_settings, :model_class, :show_settings
-  attr_accessor :actions, :custom_destroy
-  attr_writer   :model_class_name
+  cattr_accessor :request_start_time
 
+  def self.profile(msg)
+    if self.request_start_time
+      Rails.logger.info "#{msg}: #{Time.now - self.request_start_time}"
+    end
+  end
+  
   def self.template_file(template_name)
     "#{File.dirname(__FILE__)}/views/#{template_name}.html.erb"
   end
 
+  attr_reader   :base_settings, :controller_class, :form_settings, 
+                :index_settings, :model_class, :show_settings
+  attr_accessor :actions, :custom_destroy, :default_search_matches_on
+  attr_writer   :model_class_name
+  
   def initialize(controller_class, model_class)
     @controller_class, @model_class = controller_class, model_class
     @model = Model.new model_class
@@ -27,6 +35,7 @@ class AdminAssistant
     @index_settings = IndexSettings.new self
     @show_settings = ShowSettings.new self
     @base_settings = BaseSettings.new self
+    @default_search_matches_on = @model.searchable_columns.map &:name
   end
   
   def [](name)
@@ -34,7 +43,7 @@ class AdminAssistant
   end
     
   def accumulate_columns(names)
-    columns = paperclip_attachments.map { |paperclip_attachment|
+    columns = @model.paperclip_attachments.map { |paperclip_attachment|
       PaperclipColumn.new paperclip_attachment
     }
     names.each do |column_name|
@@ -51,34 +60,44 @@ class AdminAssistant
   end
   
   def autocomplete_actions
-    ac_actions = []
-    if [:new, :create, :edit, :update].any? { |action|
-      actions.include?(action)
-    }
-      accumulate_belongs_to_columns(default_column_names).each { |column|
-        ac_actions << "autocomplete_#{column.name}".to_sym
+    @autocomplete_actions ||= begin
+      ac_actions = []
+      if [:new, :create, :edit, :update].any? { |action|
+        actions.include?(action)
       }
-    end
-    if actions.include?(:index)
-      base_settings.all_polymorphic_types.each do |p_type|
-        ac_actions << "autocomplete_#{p_type.name.underscore.downcase}".to_sym
+        defaults = @model.default_column_names
+        accumulate_belongs_to_columns(defaults).each { |column|
+          ac_actions << "autocomplete_#{column.name}".to_sym
+        }
+      end
+      if actions.include?(:index)
+        base_settings.all_polymorphic_types.each do |p_type|
+          ac_actions << "autocomplete_#{p_type.name.underscore.downcase}".to_sym
+        end
       end
+      ac_actions.uniq
     end
-    ac_actions.uniq
+    @autocomplete_actions
   end
   
   def column(name)
-    if file_columns.include?(name.to_s)
+    if @model.file_columns.include?(name.to_s)
       FileColumnColumn.new name
-    elsif paperclip_attachments.include?(name)
+    elsif @model.paperclip_attachments.include?(name)
       PaperclipColumn.new name
-    elsif (belongs_to_assoc = belongs_to_assoc(name) or
-           belongs_to_assoc = belongs_to_assoc_by_foreign_key(name))
+    elsif (belongs_to_assoc = @model.belongs_to_assoc(name) or
+           belongs_to_assoc = @model.belongs_to_assoc_by_foreign_key(name))
       column_based_on_belongs_to_assoc name, belongs_to_assoc
-    elsif belongs_to_assoc = belongs_to_assoc_by_polymorphic_type(name)
+    elsif belongs_to_assoc = @model.belongs_to_assoc_by_polymorphic_type(name)
       # skip it, actually
     elsif (ar_column = @model_class.columns_hash[name.to_s])
       ActiveRecordColumn.new ar_column
+    elsif has_many_assoc = @model.has_many_assoc(name)
+      HasManyColumn.new(
+        has_many_assoc,
+        :match_text_fields_in_search => 
+            search_settings[name].match_text_fields_for_association?
+      )
     else
       VirtualColumn.new name, @model_class, self
     end
@@ -109,34 +128,28 @@ class AdminAssistant
     controller.controller_path.gsub(%r|/|, '_')
   end
   
-  def dispatch_to_request_method(request_class, controller)
-    controller.instance_variable_set :@admin_assistant, self
-    @request = request_class.new(self, controller)
-    @request.call
-    @request = nil
+  def crudful_request_methods
+    [:create, :destroy, :edit, :index, :new, :update, :show]
+  end
+  
+  def default_column_names
+    @model.default_column_names
+  end
+  
+  def file_columns
+    @model.file_columns
   end
   
   def method_missing(meth, *args)
-    if @model.respond_to?(meth)
-      @model.send meth, *args
+    if crudful_request_methods.include?(meth) and args.size == 1
+      self.class.request_start_time = Time.now if ENV['PROFILE_LOGGING']
+      Request.dispatch meth, self, args.first
+    elsif autocomplete_actions && autocomplete_actions.include?(meth)
+      Request.dispatch :autocomplete, self, args.first
+    elsif meth.to_s =~ /(.*)\?/ && crudful_request_methods.include?($1.to_sym)
+      supports_action? $1
     else
-      request_methods = [
-        :create, :destroy, :edit, :index, :new, :update, :show
-      ]
-      if request_methods.include?(meth) and args.size == 1
-        request_class = Request.const_get meth.to_s.capitalize
-        dispatch_to_request_method request_class, args.first
-      elsif autocomplete_actions && autocomplete_actions.include?(meth)
-        dispatch_to_request_method Request::Autocomplete, args.first
-      else
-        if meth.to_s =~ /(.*)\?/ && request_methods.include?($1.to_sym)
-          @controller_class.public_instance_methods.include?($1)
-        elsif @request.respond_to?(meth)
-          @request.send meth, *args
-        else
-          super
-        end
-      end
+      super
     end
   end
     
@@ -145,16 +158,23 @@ class AdminAssistant
         @model_class.name.gsub(/([A-Z])/, ' \1')[1..-1].downcase
   end
   
-  def profile(msg)
-    if @request_start_time
-      puts "#{msg}: #{Time.now - @request_start_time}"
-    end
+  def paperclip_attachments
+    @model.paperclip_attachments
   end
   
   def search_settings
     @index_settings.search_settings
   end
   
+  def supports_action?(action)
+    @memoized_action_booleans ||= {}
+    unless @memoized_action_booleans.has_key?(action)
+      @memoized_action_booleans[action] = 
+          @controller_class.public_instance_methods.include?(action)
+    end
+    @memoized_action_booleans[action]
+  end
+  
   def url_params(a = action)
     {:controller => @controller_class.controller_path, :action => a}
   end
@@ -168,16 +188,20 @@ class AdminAssistant
   
   module ControllerClassMethods
     def admin_assistant_for(model_class, &block)
-      self.admin_assistant = AdminAssistant.new(self, model_class)
-      builder = Builder.new self.admin_assistant
-      if block
-        block.call builder
-      end
-      self.helper AdminAssistant::Helper
-      self.admin_assistant.controller_actions.each do |action|
-        self.send(:define_method, action) do
-          self.class.admin_assistant.send(action, self)
+      begin
+        self.admin_assistant = AdminAssistant.new(self, model_class)
+        builder = Builder.new self.admin_assistant
+        if block
+          block.call builder
+        end
+        self.helper AdminAssistant::Helper
+        self.admin_assistant.controller_actions.each do |action|
+          self.send(:define_method, action) do
+            self.class.admin_assistant.send(action, self)
+          end
         end
+      rescue ActiveRecord::StatementInvalid
+        Rails.logger.info "Skipping admin_assistant_for for #{self.name} because the table doesn't exist in the DB. Hopefully that's because you're deploying with a migration."
       end
     end
   end
@@ -186,6 +210,13 @@ class AdminAssistant
     def initialize(ar_model)
       @ar_model = ar_model
     end
+    
+    def accessors
+      @ar_model.instance_methods.
+          select { |m| m =~ /=$/ }.
+          map { |m| m.gsub(/=/, '')}.
+          select { |m| @ar_model.instance_methods.include?(m) }
+    end
   
     def belongs_to_associations
       @ar_model.reflect_on_all_associations.select { |assoc|
@@ -223,26 +254,25 @@ class AdminAssistant
       unless @file_columns
         @file_columns = []
         if @ar_model.respond_to?(:file_column)
-          names_to_check = @ar_model.columns.map &:name
-          names_to_check.concat(
-            @ar_model.instance_methods.
-                select { |m| m =~ /=$/ }.
-                map { |m| m.gsub(/=/, '')}.
-                select { |m| @ar_model.instance_methods.include?(m) }
-          )
-          names_to_check.uniq.each do |name|
-            suffixes = %w( relative_path dir relative_dir temp )
-            if suffixes.all? { |suffix|
+          names_to_check = @ar_model.columns.map(&:name).concat(accessors).uniq
+          @file_columns = names_to_check.select { |name|
+            %w( relative_path dir relative_dir temp ).all? { |suffix|
               @ar_model.method_defined? "#{name}_#{suffix}".to_sym
             }
-              @file_columns << name
-            end
-          end
+          }
         end
       end
       @file_columns
     end
     
+    def has_many_assoc(association_name)
+      @ar_model.reflect_on_all_associations.select { |assoc|
+        assoc.macro == :has_many
+      }.detect { |assoc|
+        assoc.name.to_s == association_name.to_s
+      }
+    end
+    
     def paperclip_attachments
       pa = []
       if @ar_model.respond_to?(:attachment_definitions)
@@ -265,13 +295,3 @@ end
 
 ActionController::Base.send :include, AdminAssistant::ControllerMethods
 
-css_dir = "#{RAILS_ROOT}/public/stylesheets/admin_assistant"
-FileUtils.mkdir(css_dir) unless File.exist?(css_dir)
-FileUtils.cp_r(Dir.glob("#{File.dirname(__FILE__)}/stylesheets/*"), css_dir)
-FileUtils.copy(
-  "#{File.dirname(__FILE__)}/javascripts/admin_assistant.js",
-  "#{RAILS_ROOT}/public/javascripts/admin_assistant.js"
-)
-images_dir = "#{RAILS_ROOT}/public/images/admin_assistant"
-FileUtils.mkdir(images_dir) unless File.exist?(images_dir)
-FileUtils.cp_r(Dir.glob("#{File.dirname(__FILE__)}/images/*"), images_dir)

data/lib/javascripts/admin_assistant.js

@@ -152,7 +152,7 @@ AdminAssistant.RestrictedAutocompleter.prototype = {
       onHide: this.autocompleteOnHide,
       parameters: options.parameters,
       paramName: options.paramName,
-      partialChars: 1,
+      partialChars: 1
     };
     if (!options.paletteClonesInputWidth) {
       ajaxAutocompleterOptions.onShow = this.onShowWithoutCloningInputWidth;

data/lib/stylesheets/activescaffold.css

@@ -134,6 +134,7 @@ Don't edit this file: It gets re-copied every time the server starts.
 
 .admin_assistant.form label {
   font-size: 11px;
+  display: block;
 }
 
 .admin_assistant.form input[type=text] {
@@ -216,4 +217,8 @@ Don't edit this file: It gets re-copied every time the server starts.
   font-size: small;
 }
 
-
+ul.aa_filter li {
+  float: left;
+  margin: 0 10px 10px 0;
+  font-weight: bold;
+}

data/lib/stylesheets/default.css

@@ -67,6 +67,7 @@ Don't edit this file: It gets re-copied every time the server starts.
 
 .admin_assistant.form .column .description {
   font-size: small;
+  margin: 0;
 }
 
 .admin_assistant.form input {
@@ -81,6 +82,10 @@ Don't edit this file: It gets re-copied every time the server starts.
   width: 50px
 }
 
+.admin_assistant.form label {
+  display: block;
+}
+
 .admin_assistant.form select {
   font-size: large
 }
@@ -90,6 +95,18 @@ Don't edit this file: It gets re-copied every time the server starts.
   font-size: large
 }
 
+.admin_assistant.form th {
+  font-weight: normal;
+  text-align: left;
+}
+
+.admin_assistant.multi.form .errorExplanation {
+  font-size: small;
+}
+
+.admin_assistant.form .fieldWithErrors {
+  background: red;
+}
 
 .admin_assistant .autocomplete_palette {
   background: white;

data/lib/views/form.html.erb

@@ -8,20 +8,24 @@ form_view = AdminAssistant::FormView.new(@record, @admin_assistant, self)
   <div class="aa_header">
     <h2><%= h(form_view.title) %></h2>
     <div class="actions">
-    <%= link_to('Back to index', :action => 'index') %>
+    <%= link_to('Back to index', @origin) %>
     </div>
   </div>
   <% if !@record.errors.empty? %>
     <%= error_messages_for 'record' %>
   <% end %>
   <% form_for(@record, form_view.form_for_args) do |rails_form| %>
+    <% if @origin %>
+      <%= hidden_field_tag 'origin', @origin %>
+    <% end %>
+
     <% form_view.columns.each do |column| %>
       <div class="column">
-      <label><%= h(column.label) %></label>
+      <label for="<%= column.field_id %>"><%= h(column.label) %></label>
       <% if column.description %>
         <p class="description"><%= h(column.description) %></p>
       <% end %>
-      <br /><%= column.html(rails_form) %>
+      <%= column.html(rails_form) %>
       </div>
     <% end %>
       <div>

data/lib/views/index.html.erb

@@ -4,15 +4,16 @@
 %>">
 <div class="aa_header">
 <div class="actions">
-<%= link_to_function('Search', 'AdminAssistant.show_search_form()') %>
-<%= link_to(
-  "New #{@admin_assistant.model_class_name}", @admin_assistant.url_params(:new)
-) if @admin_assistant.new? %>
+<%= link_to_function('Search', 'AdminAssistant.show_search_form()') if index_view.render_search_link? %>
+<% if index_view.render_new_link? %>
+  <%= index_view.new_link %>
+<% end %>
 <% @admin_assistant.index_settings.actions.each do |action, params| %>
   <%= link_to_unless_current(action, params) %>
 <% end %>
 </div>
 <h2><%= h(index_view.header) %></h2>
+<%= index_view.render_after_index_header %>
 </div>
 
 <% form_for(
@@ -20,6 +21,9 @@
   :url => {:action => 'index'},
   :html => {:id => 'search_form', :style => 'display:none', :method => 'get'}
 ) do |form| %>
+  <% @index.hidden_fields_for_search_form.each do |name, value| -%>
+    <%= hidden_field_tag name, value %>
+  <% end -%>
   <% column_views = @index.search.column_views self %>
   <% if column_views.size > 1 %>
     Match all conditions <%= radio_button_tag(
@@ -62,12 +66,12 @@
   </thead>
   <tbody id="<%= @admin_assistant.model_class.name.underscore.pluralize %>_index_tbody">
   <% @index.records.each do |record| %>
-    <tr class="<%= cycle('odd', 'even') %>" id="<%= 
+    <tr class="<%= index_view.tr_css_classes(record) %>" id="<%= 
       @admin_assistant.model_class.name.underscore
     %>_<%= record.id %>">
-      <% @index.view(self).columns.each do |column| %>
-        <% td_class = column.td_css_class %>
-        <td<%= " class=\"#{td_class}\"" if td_class %>><%=
+      <% index_view.columns.each do |column| %>
+        <% td_class = column.td_css_classes(column, record) %>
+        <td<%= " class=\"#{td_class}\"" unless td_class.blank? %>><%=
           column.html(record)
         %></td>
       <% end %>
@@ -97,3 +101,4 @@
 %> found
 </div>
 </div>
+

data/lib/views/multi_form.html.erb

@@ -0,0 +1,71 @@
+<%
+multi_form_view = AdminAssistant::MultiFormView.new(
+  @records, @admin_assistant, self
+)
+%>
+<div class="admin_assistant form multi <%=
+  @admin_assistant.controller_css_class(controller)
+%>">
+  <div class="aa_header">
+    <h2><%= h(multi_form_view.title) %></h2>
+    <div class="actions">
+    <%= link_to('Back to index', :action => 'index') %>
+    </div>
+  </div>
+  <% form_for(*multi_form_view.form_for_args) do |rails_form| %>
+    <% if @origin %>
+      <%= hidden_field_tag 'origin', @origin %>
+    <% end %>
+    <table>
+      <thead>
+        <tr>
+        <% multi_form_view.columns.each do |column| %>
+          <th>
+            <label><%= h(column.label) %></label>
+            <% if column.description %>
+              <p class="description"><%= h(column.description) %></p>
+            <% end %>
+          </th>
+        <% end %>
+        </tr>
+      </thead>
+      <% rails_form.each_sub_form do |rails_sub_form, sub_form_view| %>
+        <% record = sub_form_view.record %>
+        <% if !sub_form_view.record.errors.empty? %>
+          <tr>
+            <% sub_form_view.columns.each do |column| %>
+              <td class="errorExplanation">
+                <% errors = column.errors(record) %>
+                <% if errors %>
+                  <% if errors.is_a?(String) %>
+                    <%= h(column.label) %> <%= h(errors) %>
+                  <% else %>
+                    <ul>
+                      <% errors.each do |error| %>
+                        <li><%= h(column.label) %> <%= h(error) %></li>
+                      <% end %>
+                    </ul>
+                  <% end %>
+                <% end %>
+              </td>
+            <% end %>
+          </tr>
+        <% end %>
+        <tr>
+        <% sub_form_view.columns.each do |column| %>
+          <td<%= " class='fieldWithErrors'" if column.errors(record) %>>
+            <%= column.html(rails_sub_form) %>
+          </td>
+        <% end %>
+        </tr>
+      <% end %>
+    </table>
+    <div>
+      <%= submit_tag(multi_form_view.submit_value) %>
+      <% multi_form_view.extra_submit_buttons.each do |extra_submit_button| %>
+        <%= submit_tag(extra_submit_button) %>
+      <% end %>
+    </div>
+  <% end %>
+</div>
+

data/lib/views/show.html.erb

@@ -1,3 +1,4 @@
+<% show_view = AdminAssistant::ShowView.new(@record, @admin_assistant, self) %>
 <div class="admin_assistant show <%=
   @admin_assistant.controller_css_class(controller)
 %>">
@@ -5,11 +6,10 @@
     <h2><%=
       h("#{request.model_class_name(@record).capitalize} #{@record.id}")
     %></h2>
-    <%= link_to 'Edit', :action => 'edit', :id => @record.id %>
+    <% if @admin_assistant.edit? %>
+      <%= link_to 'Edit', :action => 'edit', :id => @record.id %>
+    <% end %>
   </div>
-  <%
-  show_view = AdminAssistant::ShowView.new(@record, @admin_assistant, self)
-  %>
   <% show_view.columns.each do |column| %>
     <div class="column">
     <label><%= h(column.label) %></label>