admin_assistant 0.0.1

data/lib/admin_assistant/helper.rb

@@ -0,0 +1,7 @@
+class AdminAssistant
+  module Helper
+    def admin_assistant_includes
+      stylesheet_link_tag 'admin_assistant'
+    end
+  end
+end

data/lib/admin_assistant/index.rb

@@ -0,0 +1,181 @@
+require 'ar_query'
+
+class AdminAssistant
+  class Index
+    def initialize(admin_assistant, url_params = {})
+      @admin_assistant = admin_assistant
+      @url_params = url_params
+    end
+    
+    def belongs_to_sort_column
+      columns.detect { |column|
+        column.is_a?(BelongsToColumn) && column.name.to_s == @url_params[:sort]
+      }
+    end
+    
+    def columns
+      column_names = settings.column_names || model_class.columns.map { |c|
+        @admin_assistant.column_name_or_assoc_name(c.name)
+      }
+      @admin_assistant.columns column_names
+    end
+    
+    def conditions
+      settings.conditions
+    end
+    
+    def find_include
+      if by_assoc = belongs_to_sort_column
+        by_assoc.name
+      end
+    end
+    
+    def model_class
+      @admin_assistant.model_class
+    end
+    
+    def order_sql
+      if (sc = sort_column)
+        first_part = if (by_assoc = belongs_to_sort_column)
+          by_assoc.order_sql_field
+        else
+          sc.name
+        end
+        "#{first_part} #{sort_order}"
+      else
+        settings.sort_by
+      end
+    end
+    
+    def records
+      unless @records
+        ar_query = ARQuery.new(
+          :order => order_sql, :include => find_include,
+          :per_page => 25, :page => @url_params[:page]
+        )
+        search.add_to_query(ar_query)
+        if conditions
+          conditions_sql = conditions.call @url_params
+          ar_query.condition_sqls << conditions_sql if conditions_sql
+        end
+        if settings.total_entries
+          ar_query[:total_entries] = settings.total_entries.call
+        end
+        @records = model_class.paginate :all, ar_query
+      end
+      @records
+    end
+    
+    def search
+      @search ||= Search.new(@admin_assistant, @url_params['search'])
+    end
+    
+    def search_terms
+      @url_params['search']
+    end
+    
+    def settings
+      @admin_assistant.index_settings
+    end
+    
+    def sort
+      @url_params[:sort]
+    end
+    
+    def sort_column
+      if @url_params[:sort]
+        columns.detect { |c|
+          c.name.to_s == @url_params[:sort]
+        } || belongs_to_sort_column
+      end
+    end
+    
+    def sort_order
+      @url_params[:sort_order] || 'asc'
+    end
+    
+    def view(action_view)
+      View.new self, action_view
+    end
+    
+    class Search
+      def initialize(admin_assistant, search_params)
+        @admin_assistant, @search_params = admin_assistant, search_params
+        @search_params ||= {}
+      end
+      
+      def [](name)
+        @search_params[name]
+      end
+    
+      def add_to_query(ar_query)
+        columns.each do |column|
+          column.add_to_query ar_query
+        end
+      end
+      
+      def columns
+        search_field_names = settings.search_fields
+        if search_field_names.empty?
+          [DefaultSearchColumn.new(
+            default_terms, @admin_assistant.model_class
+          )]
+        else
+          columns = search_field_names.map { |column_name|
+            @admin_assistant.column column_name.to_s
+          }
+          columns.each do |c|
+            c.search_terms = @search_params[c.name]
+          end
+          columns
+        end
+      end
+      
+      def column_views(action_view)
+        columns.map { |c|
+          opts = {:search => self}
+          if c.respond_to?(:name)
+            opts[:boolean_labels] = settings.boolean_labels[c.name]
+          end
+          c.view(action_view, opts)
+        }
+      end
+      
+      def default_terms
+        @search_params if @search_params.is_a?(String)
+      end
+      
+      def id
+      end
+      
+      def method_missing(meth, *args)
+        if column = columns.detect { |c| c.name == meth.to_s }
+          column.search_value
+        else
+          super
+        end
+      end
+    
+      def settings
+        @admin_assistant.index_settings
+      end
+    end
+    
+    class View
+      def initialize(index, action_view)
+        @index, @action_view = index, action_view
+      end
+      
+      def columns
+        @index.columns.map { |c|
+          c.view(
+            @action_view,
+            :boolean_labels => @index.settings.boolean_labels[c.name],
+            :sort_order => (@index.sort_order if c.name == @index.sort),
+            :link_to_args => @index.settings.link_to_args[c.name.to_sym]
+          )
+        }
+      end
+    end
+  end
+end

data/lib/admin_assistant/request.rb

@@ -0,0 +1,183 @@
+class AdminAssistant
+  module Request
+    class Base
+      def initialize(admin_assistant, controller)
+        @admin_assistant, @controller = admin_assistant, controller
+      end
+  
+      def action
+        @controller.action_name
+      end
+      
+      def after_form_html_template
+        File.join(
+          RAILS_ROOT, 'app/views/', @controller.controller_path, 
+          '_after_form.html.erb'
+        )
+      end
+      
+      def after_form_html_template_exists?
+        File.exist? after_form_html_template
+      end
+      
+      def model_class
+        @admin_assistant.model_class
+      end
+    
+      def model_class_symbol
+        model_class.name.underscore.to_sym
+      end
+      
+      def params_for_save
+        params = {}
+        split_params = {}
+        whole_params = {}
+        @controller.params[model_class_symbol].each do |k, v|
+          k =~ /\([0-9]+i\)$/ ? (split_params[k] = v) : (whole_params[k] = v)
+        end
+        bases = split_params.map{ |k, v| k.gsub(/\([0-9]+i\)$/, '') }.uniq
+        bases.each do |b|
+          h = {}
+          split_params.each{ |k, v| h[k] = split_params.delete(k) if k =~ /#{b}\([0-9]+i\)$/ }
+          from_form_method = "#{b}_from_form".to_sym
+          if @controller.respond_to?(from_form_method)
+            params[b] = @controller.send(from_form_method, h)
+          elsif @record.respond_to?("#{b}=")
+            params.merge! h
+          end
+        end
+        whole_params.each do |k, v|  
+          from_form_method = "#{k}_from_form".to_sym
+          if @controller.respond_to?(from_form_method)
+            params[k] = @controller.send(from_form_method, v)
+          elsif @record.respond_to?("#{k}=")
+            params[k] = v
+          end
+        end
+        params
+      end
+      
+      def redirect_after_save
+        url_params = if @controller.respond_to?(:destination_after_save)
+          @controller.send(
+            :destination_after_save, @record, @controller.params
+          )
+        end
+        url_params ||= {:action => 'index'}
+        @controller.send :redirect_to, url_params
+      end
+      
+      def render_after_form
+        @controller.send(
+          :render_to_string,
+          :file => after_form_html_template, :layout => false
+        )
+      end
+      
+      def render_form
+        html = @controller.send(
+          :render_to_string, :file => template_file('form'), :layout => true
+        )
+        html << render_after_form if after_form_html_template_exists?
+        @controller.send :render, :text => html
+      end
+      
+      def render_template_file(template_name = action, options_plus = {})
+        options = {:file => template_file(template_name), :layout => true}
+        options = options.merge options_plus
+        @controller.send(:render, options)
+      end
+      
+      def save
+        if @controller.respond_to?(:before_save)
+          @controller.send(:before_save, @record)
+        end
+        @record.save
+      end
+    
+      def template_file(template_name = action)
+        "#{File.dirname(__FILE__)}/../views/#{template_name}.html.erb"
+      end
+    end
+    
+    class Create < Base
+      def call
+        @record = model_class.new
+        @record.attributes = params_for_save
+        if save
+          redirect_after_save
+        else
+          @controller.instance_variable_set :@record, @record
+          render_form
+        end
+      end
+      
+      def save
+        if @controller.respond_to?(:before_create)
+          @controller.send(:before_create, @record)
+        end
+        result = super
+        if @controller.respond_to?(:after_create)
+          @controller.send(:after_create, @record)
+        end
+        result
+      end
+    end
+    
+    class Destroy < Base
+      def call
+        @record = model_class.find @controller.params[:id]
+        @record.destroy
+        @controller.send :render, :text => ''
+      end
+    end
+    
+    class Edit < Base
+      def call
+        @record = model_class.find @controller.params[:id]
+        @controller.instance_variable_set :@record, @record
+        render_form
+      end
+    end
+    
+    class Index < Base
+      def call
+        index = AdminAssistant::Index.new(@admin_assistant, @controller.params)
+        @controller.instance_variable_set :@index, index
+        render_template_file
+      end
+      
+      def columns
+        @admin_assistant.index_settings.columns
+      end
+    end
+    
+    class New < Base
+      def call
+        @record = model_class.new
+        @controller.instance_variable_set :@record, @record
+        render_form
+      end
+    end
+    
+    class Update < Base
+      def call
+        @record = model_class.find @controller.params[:id]
+        @record.attributes = params_for_save
+        if save
+          redirect_after_save
+        else
+          @controller.instance_variable_set :@record, @record
+          render_form
+        end
+      end
+      
+      def save
+        if @controller.respond_to?(:before_update)
+          @controller.send(:before_update, @record)
+        end
+        super
+      end
+    end
+  end
+end

data/lib/admin_assistant.rb

@@ -0,0 +1,172 @@
+require 'admin_assistant/builder'
+require 'admin_assistant/column'
+require 'admin_assistant/form_view'
+require 'admin_assistant/helper'
+require 'admin_assistant/index'
+require 'admin_assistant/request'
+require 'will_paginate'
+
+class AdminAssistant
+  attr_reader :custom_column_labels, :form_settings, :index_settings, 
+              :model_class
+  attr_accessor :actions
+  
+  def initialize(controller_class, model_class)
+    @controller_class, @model_class = controller_class, model_class
+    @actions = [:index, :create, :update]
+    @form_settings = FormSettings.new self
+    @index_settings = IndexSettings.new self
+    @custom_column_labels = {}
+  end
+  
+  def belongs_to_assoc(name)
+    model_class.reflect_on_all_associations.detect { |assoc|
+      assoc.macro == :belongs_to && assoc.name.to_s == name.to_s
+    }
+  end
+  
+  def column(name)
+    column = if file_columns.include?(name)
+      FileColumnColumn.new name
+    elsif (ar_column = model_class.columns_hash[name.to_s])
+      ActiveRecordColumn.new(ar_column)
+    elsif belongs_to_assoc = belongs_to_assoc(name)
+      BelongsToColumn.new(belongs_to_assoc)
+    else
+      AdminAssistantColumn.new(name)
+    end
+    if column && (custom = custom_column_labels[name.to_s])
+      column.custom_label = custom
+    end
+    column
+  end
+  
+  def column_name_or_assoc_name(name)
+    result = name
+    ar_column = model_class.columns_hash[name.to_s]
+    if ar_column
+      associations = model_class.reflect_on_all_associations
+      if belongs_to_assoc = associations.detect { |assoc|
+        assoc.macro == :belongs_to && assoc.association_foreign_key == name
+      }
+        result = belongs_to_assoc.name.to_s
+      end
+    end
+    result
+  end
+    
+  def columns(names)
+    columns = paperclip_attachments.map { |paperclip_attachment|
+      PaperclipColumn.new paperclip_attachment
+    }
+    names.each do |column_name|
+      unless columns.any? { |column| column.contains?(column_name) }
+        column = column column_name
+        columns << column if column
+      end
+    end
+    columns
+  end
+  
+  def controller_actions
+    c_actions = actions.clone
+    c_actions << :new if c_actions.include?(:create)
+    c_actions << :edit if c_actions.include?(:update)
+    c_actions
+  end
+    
+  def controller_css_class(controller)
+    controller.controller_path.gsub(%r|/|, '_')
+  end
+  
+  def dispatch_to_request_method(request_method, controller)
+    controller.instance_variable_set :@admin_assistant, self
+    klass = Request.const_get request_method.to_s.capitalize
+    @request = klass.new(self, controller)
+    @request.call
+    @request = nil
+  end
+  
+  def file_columns
+    fc = []
+    if model_class.respond_to?(:file_column)
+      model_class.columns.each do |column|
+        suffixes = %w( relative_path dir relative_dir temp )
+        if suffixes.all? { |suffix|
+          model_class.method_defined? "#{column.name}_#{suffix}".to_sym
+        }
+          fc << column.name
+        end
+      end
+    end
+    fc
+  end
+  
+  def method_missing(meth, *args)
+    request_methods = [:create, :destroy, :edit, :index, :new, :update]
+    if request_methods.include?(meth) and args.size == 1
+      dispatch_to_request_method meth, args.first
+    else
+      if meth.to_s =~ /(.*)\?/ && request_methods.include?($1.to_sym)
+        @actions.include?($1.to_sym)
+      elsif @request.respond_to?(meth)
+        @request.send meth, *args
+      else
+        super
+      end
+    end
+  end
+    
+  def model_class_name
+    model_class.name.gsub(/([A-Z])/, ' \1')[1..-1].downcase
+  end
+    
+  def paperclip_attachments
+    pa = []
+    if model_class.respond_to?(:attachment_definitions)
+      if model_class.attachment_definitions
+        pa = model_class.attachment_definitions.map { |name, definition|
+          name
+        }
+      end
+    end
+    pa
+  end
+  
+  def url_params(a = action)
+    {:controller => @controller_class.controller_path, :action => a}
+  end
+  
+  module ControllerMethods
+    def self.included(controller)
+      controller.extend ControllerClassMethods
+      controller.class_inheritable_accessor :admin_assistant
+    end
+  end
+  
+  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)
+        end
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, AdminAssistant::ControllerMethods
+
+FileUtils.copy(
+  "#{File.dirname(__FILE__)}/stylesheets/admin_assistant.css",
+  "#{RAILS_ROOT}/public/stylesheets/admin_assistant.css"
+)
+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/stylesheets/admin_assistant.css

@@ -0,0 +1,75 @@
+/******************************************************************************
+Don't edit this file: It gets re-copied every time the server starts.
+******************************************************************************/
+
+#admin_assistant { font-family: "Verdana","Arial", sans-serif }
+#admin_assistant h2 { font-size: large; font-weight: bold }
+#admin_assistant .actions {
+  position: absolute; right: 5px; top: 5px; text-align: right
+}
+#admin_assistant #header { position: relative }
+
+/***** Index stuff ***********************************************************/
+
+#admin_assistant.index table {
+  width: 100%; margin: 0px 0px 10px 0px; padding: 0px
+}
+#admin_assistant.index th {
+  background: #666; color: white; padding: 5px 20px 5px 5px
+}
+#admin_assistant.index th a {
+  color: white
+}
+#admin_assistant.index th.sort.asc {
+  background: #000 url(/images/admin_assistant/sort-asc.png) no-repeat right
+}
+#admin_assistant.index th.sort.desc {
+  background: #000 url(/images/admin_assistant/sort-desc.png) no-repeat right
+}
+#admin_assistant.index td {
+  background: white;
+  border-bottom: 1px solid #ccc;
+  border-right: 1px solid #ccc;
+  padding: 5px
+}
+#admin_assistant.index tbody tr td:first-child {
+  border-left: 1px solid #ccc;
+}
+#admin_assistant.index tbody tr.even td {
+  background: #eee;
+}
+
+#admin_assistant.index tbody tr td.sort {
+  background: #ddd
+}
+#admin_assistant.index tbody tr.even td.sort {
+  background: #ccc
+}
+
+/***** Form stuff ************************************************************/
+
+#admin_assistant.form .column {
+  margin-bottom: 10px;
+}
+
+#admin_assistant.form label {
+/*  font-size: small;*/
+}
+
+#admin_assistant.form input {
+  font-size: large
+}
+
+#admin_assistant.form input[type=text] {
+  width: 100%
+}
+
+#admin_assistant.form select {
+  font-size: large
+}
+
+#admin_assistant.form textarea {
+  width: 100%;
+  font-size: large
+}
+

data/lib/views/form.html.erb

@@ -0,0 +1,31 @@
+<%
+form_view = AdminAssistant::FormView.new(@record, @admin_assistant, self)
+%>
+<div id="admin_assistant" class="form <%=
+  @admin_assistant.controller_css_class(controller)
+%>">
+  <% id = nil unless defined?(id) %>
+  <div id="header">
+    <h2><%= h(form_view.title) %></h2>
+    <div class="actions">
+    <%= link_to('Back to index', :action => 'index') %>
+    </div>
+  </div>
+  <% if !@record.errors.empty? %>
+    <%= error_messages_for 'record' %>
+  <% end %>
+  <% form_for(@record, form_view.form_for_args) do |rails_form| %>
+    <% form_view.columns.each do |column| %>
+      <div class="column">
+      <label><%= h(column.label) %></label>
+      <br /><%= form_view.column_html(column, rails_form) %>
+      </div>
+    <% end %>
+      <div>
+        <%= submit_tag(form_view.submit_value) %>
+        <% form_view.extra_submit_buttons.each do |extra_submit_button| %>
+          <%= submit_tag(extra_submit_button) %>
+        <% end %>
+      </div>
+  <% end %>
+</div>