Module: AjaxScaffold::ClassMethods

Defined in:

lib/ajax_scaffold_plugin.rb

Instance Method Summary

• #ajax_scaffold(model_id, options = {}) ⇒ Object

  Adds a swath of actions to the controller.

Instance Method Details

#ajax_scaffold(model_id, options = {}) ⇒ Object

Adds a swath of actions to the controller.

# File 'lib/ajax_scaffold_plugin.rb', line 127

def ajax_scaffold(model_id, options = {})
  options.assert_valid_keys(:class_name, :except, :rows_per_page, :suffix, :totals, :width, :rel_width)

  # set up a few variables for use in the code generation
  singular_name   = model_id.to_s
  class_name      = options[:class_name] || singular_name.camelize
  plural_name     = eval("#{class_name}.table_name") || singular_name.pluralize
  rows_per_page   = options[:rows_per_page] || 25
  suffix          = options[:suffix] ? "_#{singular_name}" : ""
  prefix          = options[:suffix] ? "#{plural_name}_" : ""
  totals          = options[:totals].nil? ? nil : options[:totals].join(',').to_s
  width           = options[:width].nil? ? (options[:rel_width].nil? ? nil : options[:rel_width]*100 ) : options[:width]

  if (!width.nil?)
    dimensions = options[:width].nil? ? "%" : "px"
    width = width.to_s + dimensions
  end

  no_create, no_edit, no_delete = false, false, false
  if (options[:except])
    no_create     = options[:except].include?('create')
    no_edit       = options[:except].include?('edit')
    no_delete     = options[:except].include?('delete')
  end

  module_eval "    include AjaxScaffold::Common\n    include AjaxScaffold::Controller\n\n    verify :method => :post, :only => [ :destroy\#{suffix}, :create\#{suffix}, :update\#{suffix} ],\n           :redirect_to => { :action => :\#{prefix}table }\n\n    after_filter :clear_flashes\n\n    @@\#{prefix}scaffold_columns = nil\n    @@\#{prefix}scaffold_total_columns = nil\n    @@\#{prefix}scaffold_columns_hash = nil\n\n    def \#{prefix}scaffold_total_columns\n      csv_array = \"\#{totals}\".length >= 1 ? CSV.parse_line(\"\#{totals}\") : []\n      @@\#{prefix}scaffold_total_columns ||= csv_array\n    end\n\n    def \#{prefix}scaffold_columns\n      @@\#{prefix}scaffold_columns ||= build_\#{prefix}scaffold_columns\n    end\n\n    def \#{prefix}scaffold_columns_hash\n      @@\#{prefix}scaffold_columns_hash ||= build_\#{prefix}scaffold_columns_hash\n    end\n\n    def \#{prefix}table\n      self.\#{prefix}table_setup\n\n      render\#{suffix}_template(:action => 'table')\n    end\n\n    def \#{prefix}table_setup\n      update_params :default_scaffold_id => \"\#{singular_name}\", :default_sort => nil, :default_sort_direction => default_\#{prefix}sort_direction\n\n      @show_wrapper = true if @show_wrapper.nil?\n      @width = \"\#{width}\"\n      sort_sql = \#{prefix}scaffold_columns_hash[current_sort(params)].sort_sql rescue default_\#{prefix}sort\n      sort = \#{prefix}scaffold_columns_hash[current_sort(params)].sort rescue nil\n      sort_direction = current_sort_direction(params)\n\n      klass = Inflector.camelize(\"\#{singular_name}\").constantize\n      order = sort.nil? ? sort_sql : sort\n      order += \" \" + sort_direction\n      options = { :order => order,\n                  :conditions => conditions_for_\#{plural_name}_collection,\n                  :direction => current_sort_direction(params),\n                  :per_page => \#{rows_per_page} }\n\n      count = count_\#{plural_name}_collection(klass, options)\n      @paginator = Paginator.new(self, count, \#{rows_per_page}, current_page(params))\n\n      if (sort.nil?)\n        @collection = page_and_sort_\#{plural_name}_collection(klass, options, @paginator)\n      else\n        @collection = page_and_sort_\#{plural_name}_collection_with_method(klass, options, @paginator)\n      end\n    end\n\n    # if multiple tables (suffix) then return to index (can be changed by overriding)\n    # if single table return to list\n    def \#{prefix}return_to_main\n      action = \"\#{suffix}\" == \"\" ? \"\#{prefix}list\" : \"index\"\n      redirect_to :action => action\n    end\n\n    def update_\#{prefix}table\n      @show_wrapper = false # don't show the outer wrapper elements if we are just updating an existing scaffold\n      if request.xhr?\n        \#{prefix}table_setup\n        render\#{suffix}_template(:action => 'table')\n      else\n        \#{prefix}return_to_main\n      end\n    end\n\n    def \#{prefix}list\n      render\#{suffix}_template(:action => 'list.rhtml', :layout => true)\n    end\n  end_eval\n\n  if(suffix==\"\")\n    module_eval <<-\"end_eval\", __FILE__, __LINE__\n      def index\n        redirect_to(:action => :list)\n      end\n    end_eval\n  end\n\n  # now only create these methods if not excluded\n  unless (no_create)\n    module_eval <<-\"end_eval\", __FILE__, __LINE__\n      def new\#{suffix}\n        do_new\#{suffix}\n        return render\#{suffix}_template(:action => 'new.rjs') if request.xhr?\n\n        # Javascript disabled fallback\n        if @successful\n          @options = { :action => \"create\" }\n          render\#{suffix}_template(:action => \"_new_edit.rhtml\", :layout => true)\n        else\n          \#{prefix}return_to_main\n        end\n      end\n\n      def do_new\#{suffix}\n        @\#{singular_name} = \#{class_name}.new\n        @successful = true\n      end\n\n      def create\#{suffix}\n        begin\n          do_create\#{suffix}\n        rescue\n          flash[:error], @successful  = $!.to_s, false\n        end\n\n        return render\#{suffix}_template(:action => 'create.rjs') if request.xhr?\n\n        if @successful\n          \#{prefix}return_to_main\n        else\n          @options = { :scaffold_id => params[:scaffold_id], :action => \"create\" }\n          render\#{suffix}_template(:action => \"_new_edit.rhtml\", :layout => true)\n        end\n      end\n\n      def do_create\#{suffix}\n          @\#{singular_name} = \#{class_name}.new(params[:\#{singular_name}])\n          @successful = @\#{singular_name}.save\n      end\n    end_eval\n  end\n\n  unless (no_edit)\n    module_eval <<-\"end_eval\", __FILE__, __LINE__\n      def edit\#{suffix}\n        begin\n          do_edit\#{suffix}\n        rescue\n          flash[:error], @successful  = $!.to_s, false\n        end\n\n        return render\#{suffix}_template(:action => 'edit.rjs') if request.xhr?\n\n        if @successful\n          @options = { :scaffold_id => params[:scaffold_id], :action => \"update\", :id => params[:id] }\n          render\#{suffix}_template(:action => \"_new_edit.rhtml\", :layout => true)\n        else\n          \#{prefix}return_to_main\n        end\n      end\n      \n      def do_edit\#{suffix}\n        @\#{singular_name} = \#{class_name}.find(params[:id])\n        @successful = !@\#{singular_name}.nil?\n      end\n\n      def update\#{suffix}\n        begin\n          do_update\#{suffix}\n        rescue\n          flash[:error], @successful  = $!.to_s, false\n        end\n\n        return render\#{suffix}_template(:action => 'update.rjs') if request.xhr?\n\n        if @successful\n          \#{prefix}return_to_main\n        else\n          @options = { :action => \"update\" }\n          render\#{suffix}_template(:action => \"_new_edit.rhtml\", :layout => true)\n        end\n      end\n\n      def do_update\#{suffix}\n          @\#{singular_name} = \#{class_name}.find(params[:id])\n          @successful = @\#{singular_name}.update_attributes(params[:\#{singular_name}])\n      end\n    end_eval\n  end\n\n  unless (no_delete)\n    module_eval <<-\"end_eval\", __FILE__, __LINE__\n      def destroy\#{suffix}\n        begin\n          do_destroy\#{suffix}\n        rescue\n          flash[:error], @successful  = $!.to_s, false\n        end\n\n        return render\#{suffix}_template(:action => 'destroy.rjs') if request.xhr?\n\n        # Javascript disabled fallback\n        \#{prefix}return_to_main\n      end\n      \n      def do_destroy\#{suffix}            \n        @successful = \#{class_name}.find(params[:id]).destroy\n      end\n    end_eval\n  end\n\n  module_eval <<-\"end_eval\", __FILE__, __LINE__\n    def cancel\#{suffix}\n      @successful = true\n\n      return render\#{suffix}_template(:action => 'cancel.rjs') if request.xhr?\n\n       # Javascript disabled fallback\n      \#{prefix}return_to_main\n    end\n\n    protected\n      # Override this for custom selection conditions\n      def conditions_for_\#{plural_name}_collection\n        nil\n      end\n\n      # Override to change the default sort from plural_name.id\n      def default_\#{prefix}sort\n        \"\#{plural_name}.id\"\n      end\n\n      # Override to change the default sort direction\n      def default_\#{prefix}sort_direction\n        \"asc\"\n      end\n\n      # Returns the total number of items in the collection\n      def count_\#{plural_name}_collection(model, options)\n        count_collection_for_pagination(model, options)\n      end\n\n      # Per model collection method, using sort_collection_by_method\n      def page_and_sort_\#{plural_name}_collection_with_method(model, options, paginator)\n        # call: sort_collection_by_method(collection, column, order)\n        order_parts = options[:order].split(' ')\n        collection = model.find(:all, :conditions => options[:conditions],\n                                :joins => options[:join] || options[:joins],\n                                :include => options[:include],\n                                :select => options[:select])\n\n        sort_collection_by_method(collection, order_parts[0], order_parts[1]).slice(paginator.current.offset,options[:per_page])\n      end\n\n      # Per model collection method delegates to Rails as default\n      def page_and_sort_\#{plural_name}_collection(model, options, paginator)\n        find_collection_for_pagination(model, options, paginator)\n      end\n\n    private\n      def render\#{suffix}_template( options = {} )\n        @scaffold_columns ||= \#{prefix}scaffold_columns\n        @scaffold_column_totals = \#{prefix}scaffold_total_columns\n        @scaffold_class = \#{class_name}\n        @scaffold_singular_name, @scaffold_plural_name = \"\#{singular_name}\", \"\#{plural_name}\"\n        @scaffold_controller = \"/\" + self.class.to_s.sub(/Controller/, \"\").underscore\n        @no_create = \#{no_create}\n        @no_edit   = \#{no_edit}\n        @no_delete = \#{no_delete}\n        @suffix    = \"\#{suffix}\"\n        @prefix    = \"\#{prefix}\"\n\n        # check for template in  following order:\n        # views/scaffold_class/template\n        # views/controller_class/template\n        # views/ajax_scaffold/template\n\n        action = options[:action]\n        layout = options[:layout] || false\n        if template_exists?(\"\#{plural_name}/\\\#{action}\")\n          render(:action => \"../\#{plural_name}/\\\#{action}\", :layout => layout)\n\n        elsif template_exists?(\"\\\#{self.class.controller_path}/\\\#{action}\")\n          render(:action => action, :layout => layout)\n\n        else\n          render(:template => \"ajax_scaffold/\\\#{action}\", :layout => layout)\n        end\n      end\n\n      def build_\#{prefix}scaffold_columns\n        scaffold_columns = Array.new\n        \#{class_name}.content_columns.each do |column|\n          scaffold_columns << ScaffoldColumn.new(\#{class_name}, { :name => column.name })\n        end\n        scaffold_columns\n      end\n\n      def build_\#{prefix}scaffold_columns_hash\n        scaffold_columns_hash = Hash.new\n        \#{prefix}scaffold_columns.each do |scaffold_column|\n          scaffold_columns_hash[scaffold_column.name] = scaffold_column\n        end\n        scaffold_columns_hash\n      end\n\n  end_eval\n\n# end ajax_scaffold method\nend\n", __FILE__, __LINE__