admin_assistant 0.0.1 → 1.0.0

data/README

@@ -1,6 +1,9 @@
 admin_assistant
 ===============
 
+Documentation: http://fhwang.github.com/admin_assistant/
+Google Group: http://groups.google.com/group/admin_assistant
+
 admin_assistant is a Rails plugin that automates a lot of features typically
 needed in admin interfaces. Current features include:
 
@@ -12,32 +15,4 @@ needed in admin interfaces. Current features include:
 * Simple handling of belongs_to association via drop-down selects
 * Built-in support for Paperclip and FileColumn
 
-I'm following a few design principles in building this:
-
-* admin_assistant's specs are written through an actual Rails app: I believe
-  this is the only sensible way to test a Rails plugin that deals with lots of 
-  controller actions and views.
-* admin_assistant will support multiple versions of Rails, so I'm experimenting
-  with a spec suite that can be run against all versions with one Rake task.
-* admin_assistant will be severely hookable. If you're copying and pasting
-  something out of vendor/plugins/admin_assistant, that's a design flaw.
-* admin_assistant will be minimally invasive to the rest of the Rails app. It
-  does not require that you add strange one-off methods to an important model
-  just to do something in an admin controller. And I'll try to avoid doing
-  anything silly like alias_method_chaining anything on ActionController::Base.
-* admin_assistant will have some safe defaults, including turning off the
-  destroy action by default, and not filling in dates and times with the
-  current date or time (which is almost always useless).
-  
-There are also some features I'm skimping on right now:
-
-* Super-pretty CSS: Because I suck at CSS. Submissions of themes are welcome
-  though.
-* Super-fancy Ajax: Because I think it's easy to do this wrong. But there will
-  be some Ajax at some point I spose.
-
-Basically, this plugin should act like a really great administrative assistant
-in your office. It tries to be extremely helpful, but it won't get underfoot or 
-tell you how to do your job.
-
 Copyright (c) 2009 Francis Hwang, released under the MIT license

data/Rakefile

@@ -1,3 +1,4 @@
+require 'grancher/task'
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
@@ -6,16 +7,12 @@ require 'spec/rake/spectask'
 desc 'Default: run all specs across all supported Rails gem versions.'
 task :default => :spec
 
-desc 'Run all specs across all supported Rails gem versions.'
-task :spec do
-  %w(2.1.2 2.2.2 2.3.2).each do |rails_gem_version|
-    puts "*** RAILS #{rails_gem_version} ***"
-    cmd = "cd test_rails_app && RAILS_GEM_VERSION=#{rails_gem_version} rake"
-    puts cmd
-    puts `#{cmd}`
-    puts
-    puts
-  end
+# run with rake publish
+Grancher::Task.new do |g|
+  g.branch = 'gh-pages'
+  g.push_to = 'origin' # automatically push too
+  
+  g.directory 'website'
 end
 
 desc 'Generate documentation for the admin_assistant plugin.'
@@ -26,3 +23,14 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc 'Run all specs across all supported Rails gem versions.'
+task :spec do
+  versions = %w(2.1.0 2.1.2 2.2.2 2.3.2 2.3.3)
+  cmd = "cd test_rails_app && " + (versions.map { |version|
+    "echo '===== Testing #{version} =====' && RAILS_GEM_VERSION=#{version} rake"
+  }.join(" && "))
+  puts cmd
+  puts `#{cmd}`
+end
+

data/init.rb

@@ -0,0 +1 @@
+require "#{File.dirname(__FILE__)}/lib/admin_assistant"

data/install.rb

@@ -1 +1,5 @@
-# Install hook code here
+# Removing directories that would be spammy if you were just using this as a 
+# plugin
+FileUtils.rm_rf "#{File.dirname(__FILE__)}/doc"
+FileUtils.rm_rf "#{File.dirname(__FILE__)}/test_rails_app"
+

data/lib/admin_assistant/active_record_column.rb

@@ -0,0 +1,211 @@
+class AdminAssistant
+  class ActiveRecordColumn < Column
+    def initialize(ar_column)
+      @ar_column = ar_column
+    end
+    
+    def add_to_query_condition(ar_query_condition, search)
+      table_name = search.model_class.table_name
+      if blank?(search)
+        ar_query_condition.add_condition do |sub_cond|
+          sub_cond.boolean_join = :or
+          sub_cond.sqls << "#{table_name}.#{name} is null"
+          sub_cond.sqls << "#{table_name}.#{name} = ''"
+        end
+      else
+        value_for_query = search.send(@ar_column.name)
+        unless value_for_query.nil?
+          comp = comparator(search)
+          unless %w(< <= = >= >).include?(comp)
+            comp = nil
+          end
+          if comp
+            ar_query_condition.sqls << "#{table_name}.#{name} #{comp} ?"
+            ar_query_condition.bind_vars << value_for_query
+          else
+            case field_type
+              when :boolean, :integer
+                ar_query_condition.sqls << "#{table_name}.#{name} = ?"
+                ar_query_condition.bind_vars << value_for_query
+              else
+                ar_query_condition.sqls << "LOWER(#{table_name}.#{name}) like LOWER(?)"
+                ar_query_condition.bind_vars << "%#{value_for_query}%"
+            end
+          end
+        end
+      end
+    end
+      
+    def attributes_for_search_object(search_params)
+      terms = search_params[@ar_column.name]
+      value = unless terms.blank?
+        case field_type
+          when :boolean
+            terms.blank? ? nil : (terms == 'true')
+          else
+            terms
+        end
+      end
+      {name => value}
+    end
+    
+    def contains?(column_name)
+      column_name.to_s == @ar_column.name
+    end
+    
+    def field_type
+      @ar_column.type
+    end
+    
+    def name
+      @ar_column.name
+    end
+    
+    class FormView < AdminAssistant::Column::View
+      include AdminAssistant::Column::FormViewMethods
+      
+      def check_box_html(form)
+        form.check_box name
+      end
+      
+      def date_select_html(form)
+        form.date_select(
+          name, {:include_blank => true}.merge(@date_select_options)
+        )
+      end
+      
+      def datetime_select_html(form)
+        opts = {:include_blank => true}.merge @datetime_select_options
+        h = form.datetime_select name, opts
+        if opts[:include_blank]
+          js_name = "#{form.object.class.name.underscore}_#{name}"
+          name = @clear_link || "Clear"
+          h << @action_view.send(
+            :link_to_function, name,
+            "AdminAssistant.clear_datetime_select('#{js_name}')"
+          )
+        end
+        h
+      end
+      
+      def default_html(form)
+        input = @input || default_input
+        self.send("#{input}_html", form)
+      end
+      
+      def default_input
+        case @column.field_type
+          when :boolean
+            :check_box
+          when :date
+            :date_select
+          when :datetime
+            :datetime_select
+          when :text
+            :text_area
+          else
+            :text_field
+          end
+      end
+      
+      def ordered_us_state_names_and_codes
+        {
+          'Alabama' => 'AL', 'Alaska' => 'AK', 'Arizona' => 'AZ',
+          'Arkansas' => 'AR', 'California' => 'CA', 'Colorado' => 'CO', 
+          'Connecticut' => 'CT', 'Delaware' => 'DE',
+          'District of Columbia' => 'DC', 'Florida' => 'FL', 'Georgia' => 'GA',
+          'Hawaii' => 'HI', 'Idaho' => 'ID', 'Illinois' => 'IL',
+          'Indiana' => 'IN', 'Iowa' => 'IA', 'Kansas' => 'KS',
+          'Kentucky' => 'KY', 'Louisiana' => 'LA', 'Maine' => 'ME',
+          'Maryland' => 'MD', 'Massachusetts' => 'MA', 'Michigan' => 'MI', 
+          'Minnesota' => 'MN', 'Mississippi' => 'MS', 'Missouri' => 'MO', 
+          'Montana' => 'MT', 'Nebraska' => 'NE', 'Nevada' => 'NV',
+          'New Hampshire' => 'NH', 'New Jersey' => 'NJ', 'New Mexico' => 'NM', 
+          'New York' => 'NY', 'North Carolina' => 'NC', 'North Dakota' => 'ND',
+          'Ohio' => 'OH', 'Oklahoma' => 'OK', 'Oregon' => 'OR',
+          'Pennsylvania' => 'PA', 'Puerto Rico' => 'PR',
+          'Rhode Island' => 'RI', 'South Carolina' => 'SC',
+          'South Dakota' => 'SD', 'Tennessee' => 'TN', 'Texas' => 'TX',
+          'Utah' => 'UT', 'Vermont' => 'VT', 'Virginia' => 'VA',
+          'Washington' => 'WA', 'West Virginia' => 'WV', 'Wisconsin' => 'WI', 
+          'Wyoming' => 'WY'
+        }.sort_by { |name, code| name }
+      end
+
+      def select_html(form)
+        # for now only used for boolean fields
+        value = form.object.send name
+        selected = if value
+          '1'
+        elsif value == false
+          '0'
+        end
+        form.select(
+          name, [[true, '1'], [false, '0']],
+          @select_options.merge(:selected => selected)
+        )
+      end
+      
+      def text_area_html(form)
+        form.text_area name, @text_area_options
+      end
+      
+      def text_field_html(form)
+        form.text_field name
+      end
+      
+      def us_state_html(form)
+        form.select(
+          name, ordered_us_state_names_and_codes, :include_blank => true
+        )
+      end
+    end
+    
+    class IndexView < AdminAssistant::Column::View
+      include AdminAssistant::Column::IndexViewMethods
+
+      def ajax_toggle?
+        @column.field_type == :boolean && @ajax_toggle_allowed
+      end
+      
+      def ajax_toggle_div_id(record)
+        "#{record.class.name.underscore}_#{record.id}_#{name}"
+      end
+      
+      def ajax_toggle_html(record)
+        <<-HTML
+        <div id="#{ ajax_toggle_div_id(record) }">
+        #{ajax_toggle_inner_html(record)}
+        </div>
+        HTML
+      end
+      
+      def ajax_toggle_inner_html(record)
+        div_id = ajax_toggle_div_id record
+        @action_view.link_to_remote(
+          string(record),
+          :update => div_id,
+          :url => {
+            :action => 'update', :id => record.id, :from => div_id,
+            record.class.name.underscore.to_sym => {
+              name => (!value(record) ? '1' : '0')
+            }
+          },
+          :success => "$(#{div_id}).hide(); $(#{div_id}).appear()"
+        )
+      end
+      
+      def unconfigured_html(record)
+        if ajax_toggle?
+          ajax_toggle_html(record)
+        else
+          @action_view.send(:h, string(record))
+        end
+      end
+    end
+    
+    class SearchView < AdminAssistant::Column::View
+      include AdminAssistant::Column::SimpleColumnSearchViewMethods
+    end
+  end
+end

data/lib/admin_assistant/association_target.rb

@@ -0,0 +1,35 @@
+class AdminAssistant
+  class AssociationTarget
+    def initialize(associated_class)
+      @associated_class = associated_class
+    end
+    
+    def assoc_value(assoc_value)
+      if assoc_value.respond_to?(:name_for_admin_assistant)
+        assoc_value.name_for_admin_assistant
+      elsif assoc_value && default_name_method
+        assoc_value.send default_name_method
+      end
+    end
+      
+    def default_name_method
+      [:name, :title, :login, :username].detect { |m|
+        @associated_class.columns.any? { |column| column.name.to_s == m.to_s }
+      }
+    end
+    
+    def name
+      @associated_class.name.gsub(/([A-Z])/, ' \1')[1..-1].downcase
+    end
+      
+    def options_for_select
+      records = @associated_class.find(:all)
+      if default_name_method
+        records.sort_by { |model| model.send(default_name_method) }.
+                map { |model| [model.send(default_name_method), model.id] }
+      else
+        records.map &:id
+      end
+    end
+  end
+end

data/lib/admin_assistant/belongs_to_column.rb

@@ -0,0 +1,186 @@
+class AdminAssistant
+  class BelongsToColumn < Column
+    attr_reader :match_text_fields_in_search
+    
+    def initialize(belongs_to_assoc, opts)
+      @belongs_to_assoc = belongs_to_assoc
+      @match_text_fields_in_search = opts[:match_text_fields_in_search]
+      @sort_by = opts[:sort_by]
+      @association_target = AssociationTarget.new associated_class
+    end
+    
+    def add_to_query_condition(ar_query_condition, search)
+      if @match_text_fields_in_search
+        add_to_query_condition_by_matching_text_fields(
+          ar_query_condition, search
+        )
+      elsif value = search.send(association_foreign_key)
+        ar_query_condition.sqls << "#{association_foreign_key} = ?"
+        ar_query_condition.bind_vars << value
+      end
+    end
+    
+    def add_to_query_condition_by_matching_text_fields(
+          ar_query_condition, search
+        )
+      if (value = search.send(name)) and !value.blank?
+        ar_query_condition.ar_query.joins << name.to_sym
+        searchable_columns = Model.new(associated_class).searchable_columns
+        ar_query_condition.add_condition do |sub_cond|
+          sub_cond.boolean_join = :or
+          searchable_columns.each do |column|
+            sub_cond.sqls <<
+                "LOWER(#{associated_class.table_name}.#{column.name}) like LOWER(?)"
+            sub_cond.bind_vars << "%#{value}%"
+          end
+        end
+      end
+    end
+
+    def associated_class
+      @belongs_to_assoc.klass
+    end
+    
+    def association_foreign_key
+      @belongs_to_assoc.options[:foreign_key] ||
+          @belongs_to_assoc.association_foreign_key
+    end
+      
+    def attributes_for_search_object(search_params)
+      atts = {}
+      if @match_text_fields_in_search
+        atts[name.to_sym] = search_params[name]
+      else
+        terms = search_params[association_foreign_key]
+        associated_id = terms.to_i unless terms.blank?
+        atts[association_foreign_key.to_sym] = associated_id
+        atts[name.to_sym] = if associated_id
+          associated_class.find associated_id
+        end
+      end
+      atts
+    end
+    
+    def contains?(column_name)
+      column_name.to_s == name
+    end
+    
+    def default_name_method
+      @association_target.default_name_method
+    end
+    
+    def name
+      @belongs_to_assoc.name.to_s
+    end
+    
+    def order_sql_field
+      if @sort_by
+        "#{@belongs_to_assoc.table_name}.#{@sort_by}"
+      elsif default_name_method
+        "#{@belongs_to_assoc.table_name}.#{default_name_method.to_s}"
+      else
+        "#{@belongs_to_assoc.active_record.table_name}.#{@belongs_to_assoc.association_foreign_key}"
+      end
+    end
+      
+    def value_for_search_object(search_params)
+      if @match_text_fields_in_search
+        search_params[name]
+      else
+        terms = search_params[association_foreign_key]
+        associated_id = terms.to_i unless terms.blank?
+        if associated_id
+          associated_class.find(associated_id)
+        end
+      end
+    end
+    
+    class View < AdminAssistant::Column::View
+      def initialize(column, action_view, admin_assistant, opts = {})
+        super
+        @association_target = AssociationTarget.new associated_class
+      end
+      
+      def assoc_value(assoc_value)
+        @association_target.assoc_value assoc_value
+      end
+      
+      def associated_class
+        @column.associated_class
+      end
+      
+      def association_foreign_key
+        @column.association_foreign_key
+      end
+      
+      def value(record)
+        assoc_value record.send(name)
+      end
+    
+      def options_for_select
+        @association_target.options_for_select
+      end
+    end
+    
+    class FormView < View
+      include AdminAssistant::Column::FormViewMethods
+      
+      def default_html(form)
+        if associated_class.count > 15
+          @action_view.send(
+            :render,
+            :file => AdminAssistant.template_file('_restricted_autocompleter'),
+            :use_full_path => false,
+            :locals => {
+              :form => form, :column => @column,
+              :select_options => @select_options
+            }
+          )
+        else
+          form.select(
+            association_foreign_key, options_for_select, @select_options
+          )
+        end
+      end
+    end
+
+    class IndexView < View
+      include AdminAssistant::Column::IndexViewMethods
+    end
+    
+    class SearchView < View
+      include AdminAssistant::Column::SearchViewMethods
+      
+      def html(form)
+        input = if @column.match_text_fields_in_search
+          form.text_field(name)
+        elsif associated_class.count > 15
+          render_autocompleter form
+        else
+          form.select(
+            association_foreign_key, options_for_select,
+            :include_blank => true
+          )
+        end
+        "<p><label>#{label}</label> <br/>#{input}</p>"
+      end
+      
+      def render_autocompleter(form)
+        @action_view.send(
+          :render,
+          :file => AdminAssistant.template_file('_restricted_autocompleter'),
+          :use_full_path => false,
+          :locals => {
+            :form => form, :column => @column,
+            :select_options => {:include_blank => true},
+            :palette_clones_input_width => false
+          }
+        )
+      end
+    end
+    
+    class ShowView < View
+      include AdminAssistant::Column::ShowViewMethods
+    end
+  end
+end