inline_forms 1.1.12 → 1.1.13

data/app/controllers/inline_forms_controller.rb

@@ -45,10 +45,8 @@ class InlineFormsController < ApplicationController
 
   include InlineFormsHelper
 
-  # shows a list of all objects from class @Klass, using will_paginate
-  #
-  # The link to 'new' allows you to create a new record.
-  #
+  # :index shows a list of all objects from class @Klass, using will_paginate,
+  # including a link to 'new', that allows you to create a new record.
   def index
     @update_span = params[:update]
     @parent_class = params[:parent_class]
@@ -57,11 +55,22 @@ class InlineFormsController < ApplicationController
     @PER_PAGE = 5 unless @parent_class.nil?
     # if the parent_class is not nill, we are in associated list and we don't search there.
     # also, make sure the Model that you want to do a search on has a :name attribute. TODO
-    @parent_class.nil? ? conditions = [ @Klass.order_by_clause.to_s + " like ?", "%#{params[:search]}%" ] : conditions =  [ "#{@parent_class.foreign_key} = ?", @parent_id ]
+    if @parent_class.nil?
+      conditions = [ @Klass.order_by_clause.to_s + " like ?", "%#{params[:search]}%" ]
+    else
+      conditions =  [ "#{@parent_class.foreign_key} = ?", @parent_id ]
+    end
+    # if we are using cancan, then make sure to select only accessible records
     if cancan_enabled?
-      @objects = @Klass.accessible_by(current_ability).order(@Klass.order_by_clause).paginate :page => params[:page], :per_page => @PER_PAGE || 12, :conditions => conditions
+      @objects = @Klass.accessible_by(current_ability).order(@Klass.order_by_clause).paginate(
+        :page => params[:page],
+        :per_page => @PER_PAGE || 12,
+        :conditions => conditions )
     else
-      @objects = @Klass.order(@Klass.order_by_clause).paginate :page => params[:page], :per_page => @PER_PAGE || 12, :conditions => conditions
+      @objects = @Klass.order(@Klass.order_by_clause).paginate(
+        :page => params[:page],
+        :per_page => @PER_PAGE || 12,
+        :conditions => conditions )
     end
     respond_to do |format|
       format.html { render 'inline_forms/_list', :layout => 'inline_forms' } unless @Klass.not_accessible_through_html?
@@ -69,10 +78,9 @@ class InlineFormsController < ApplicationController
     end
   end
 
-  # :new prepares a new object, updates the entire list of objects and replaces it with a new
-  # empty form. After pressing OK or Cancel, the list of objects is retrieved in the same way as :index
-  #
-  # GET /examples/new
+  # :new prepares a new object, updates the list of objects and replaces it with
+  # an empty form. After pressing OK or Cancel, the list of objects is retrieved
+  # in the same way as :index
   def new
     @object = @Klass.new
     @update_span = params[:update]
@@ -87,9 +95,6 @@ class InlineFormsController < ApplicationController
   end
 
   # :edit presents a form to edit one specific attribute from an object
-  #
-  # GET /examples/1/edit
-  #
   def edit
     @object = @Klass.find(params[:id])
     @attribute = params[:attribute]
@@ -101,10 +106,8 @@ class InlineFormsController < ApplicationController
     end
   end
 
-  # :create creates the object made with :new. It then presents the list of objects.
-  #
-  # POST /examples
-  #
+  # :create creates the object made with :new.
+  # It then presents the list of objects.
   def create
     object = @Klass.new
     @update_span = params[:update]
@@ -139,10 +142,8 @@ class InlineFormsController < ApplicationController
       end
     end
   end
+
   # :update updates a specific attribute from an object.
-  #
-  # PUT /examples/1
-  #
   def update
     @object = @Klass.find(params[:id])
     @attribute = params[:attribute]
@@ -157,11 +158,8 @@ class InlineFormsController < ApplicationController
     end
   end
 
-  # :show shows one attribute (attribute) from a record (object). It inludes the link to 'edit'
-  #
-  # GET /examples/1?attribute=name&form_element=text
-  #
-  
+  # :show shows one attribute (attribute) from a record (object).
+  # It includes the link to 'edit'
   def show
     @object = @Klass.find(params[:id])
     @attribute = params[:attribute]
@@ -191,6 +189,7 @@ class InlineFormsController < ApplicationController
     end
   end
 
+  # :destroy destroys the record, but also shows an undo link (with paper_trail)
   def destroy
     @update_span = params[:update]
     @object = @Klass.find(params[:id])
@@ -200,8 +199,9 @@ class InlineFormsController < ApplicationController
     end
   end
 
+  # :revert works like undo.
+  # Thanks Ryan Bates: http://railscasts.com/episodes/255-undo-with-paper-trail
   def revert
-    # http://railscasts.com/episodes/255-undo-with-paper-trail
     @update_span = params[:update]
     @version = Version.find(params[:id])
     @version.reify.save!
@@ -209,19 +209,11 @@ class InlineFormsController < ApplicationController
     respond_to do |format|
       format.js { render :close }
     end
-
-    #    if @version.reify
-    #      @version.reify.save!
-    #    else
-    #      @version.item.destroy
-    #    end
-    #    link_name = params[:redo] == "true" ? "undo" : "redo"
-    #    link = view_context.link_to(link_name, revert_version_path(@version.next, :redo => !params[:redo]), :method => :post)
-    #    redirect_to :back, :notice => "Undid #{@version.event}. #{link}"
   end
 
   private
   # Get the class from the controller name.
+  # CountryController < InlineFormsController, so what class are we?
   def getKlass #:doc:
     @Klass = self.controller_name.classify.constantize
   end

data/app/views/inline_forms/_list.html.erb

@@ -3,7 +3,6 @@
   <script type="text/javascript">
     $(function() { $("#flash").delay(1000).fadeToggle('2000'); } );
   </script>
-
 <% end %>
 
 <!-- purpose: list objects. we come here from #index and from #new.
@@ -53,35 +52,31 @@ they are @object. We need this magic here to rewrite all the @variables to varia
 
 <% end %>
 
-<% if ul_needed %>
-  <ul id="<%= update_span -%>" class="inline_forms_list">
+<%= "<ul id=\"#{update_span}\" class=\"inline_forms_list\">" if ul_needed -%>
+<!--  # link to new -->
+<%= link_to_new_record("Add a new #{human_readable_class}", model_name, path_to_new, update_span, parent_class, parent_id) -%>
+<!--  # list of objects -->
+<% for object in objects %>
+  <% if parent_class.nil?  %>
+    <% css_class_id = object.class.to_s.underscore + '_' + object.id.to_s -%>
+    <% path_to_object = object.class.to_s.underscore + '_path' %>
+  <% else %>
+    <% css_class_id = parent_class.to_s.underscore + '_' + parent_id.to_s + '_' + attribute.to_s.singularize.underscore + "_" + object.id.to_s -%>
+    <% path_to_object = attribute.to_s.singularize.underscore + "_path" %>
   <% end %>
-  <!--  # link to new -->
-  <%= link_to_new_record("Add a new #{human_readable_class}", model_name, path_to_new, update_span, parent_class, parent_id) -%>
-  <!--  # list of objects -->
-  <% for object in objects %>
-    <% if parent_class.nil?  %>
-      <% css_class_id = object.class.to_s.underscore + '_' + object.id.to_s -%>
-      <% path_to_object = object.class.to_s.underscore + '_path' %>
-    <% else %>
-      <% css_class_id = parent_class.to_s.underscore + '_' + parent_id.to_s + '_' + attribute.to_s.singularize.underscore + "_" + object.id.to_s -%>
-      <% path_to_object = attribute.to_s.singularize.underscore + "_path" %>
-    <% end %>
-    <li id="<%= css_class_id -%>" class="<%= cycle('odd', 'even') -%>" >
-      <%= link_to_destroy('del',object, css_class_id) -%>
-      <%= link_to h(object._presentation),
-        send( path_to_object, object, :update => css_class_id),
-        :remote => true -%>
-    </li>
-  <% end -%>
-  <!--  # pagination -->
-  <li class="even">
-    <%  if parent_id.nil? -%>
-      <%= will_paginate objects -%>
-    <% else %>
-      <%= will_paginate objects, :ajax => true, :params => {:controller => attribute, :action => :index, :id => nil, :parent_class => parent_class, :parent_id => parent_id, :update => "#{parent_class.to_s.underscore}_#{parent_id}_#{attribute}", :ul_needed => true  } -%>
-    <% end %>
+  <li id="<%= css_class_id -%>" class="<%= cycle('odd', 'even') -%>" >
+    <%= link_to_destroy('del',object, css_class_id) -%>
+    <%= link_to h(object._presentation),
+      send( path_to_object, object, :update => css_class_id),
+      :remote => true -%>
   </li>
-  <% if ul_needed %>
-  </ul>
-<% end %>
+<% end -%>
+<!--  # pagination -->
+<li class="even">
+  <%  if parent_id.nil? -%>
+    <%= will_paginate objects -%>
+  <% else %>
+    <%= will_paginate objects, :ajax => true, :params => {:controller => attribute, :action => :index, :id => nil, :parent_class => parent_class, :parent_id => parent_id, :update => "#{parent_class.to_s.underscore}_#{parent_id}_#{attribute}", :ul_needed => true  } -%>
+  <% end %>
+</li>
+<%= "</ul>" if ul_needed -%>

data/lib/inline_forms.rb

@@ -1,15 +1,15 @@
 require ('inline_forms/version.rb')
-#puts "Loading inline_forms version #{InlineForms::VERSION}"
+# InlineForms is a Rails Engine that let you setup an admin interface quick and
+# easy. Please install it as a gem or include it in your Gemfile.
 module InlineForms
-
-  # ActiveRecord::Migration comes with a set of column types.
-  # They are listed here so they can be used alongside our Special Column Types.
+  # DEFAULT_COLUMN_TYPES holds the standard ActiveRecord::Migration column types.
+  # This list provides compatability with the standard types, but we add our own
+  # later in 'Special Column Types'.
   #
-  # These types will override the Special Column Types, so don't declare
-  # types with these names as Special Column Types!
+  # These types will override Special Column Types of the same name.\
   #
   # Example:
-  #  rails g inline_forms Example name:string price:integer
+  # rails g inline_forms Example name:string price:integer
   # will result in:
   #   class InlineFormsCreateExamples < ActiveRecord::Migration
   #     def self.up
@@ -40,7 +40,9 @@ module InlineForms
     # :belongs_to => :belongs_to,
   }
 
-  # For each Default Column Type, we need to specify a Form Element for use in form creation.
+  # DEFAULT_FORM_ELEMENTS holds a mapping from Default Column Types to
+  # Form Elements. Form Elements are defined in app/helpers/form_elements
+  # and are pieces of code that display a form for a field.
   #
   # Example:
   #  rails g inline_forms Example name:string price:integer
@@ -70,12 +72,11 @@ module InlineForms
     :boolean    => :check_box,
   }
 
-  # This Hash will be used to map our Special Column Types to
-  # ActiveRecord::Migration Column Types.
+  # SPECIAL_COLUMN_TYPES maps the column types that we define here and in
+  # app/helpers/form_elements to the standard ActiveRecord::Migration column
+  # types
   #
-  # The helpers in app/helpers/form_elements add to this Hash.
-  #
-  # Usage example: in app/helpers/form_elements/dropdown.rb
+  # Example: in app/helpers/form_elements/dropdown.rb
   #  InlineForms::SPECIAL_COLUMN_TYPES[:dropdown]=:belongs_to
   # this maps the :dropdown form element to the :belongs_to column type.
   #
@@ -89,6 +90,9 @@ module InlineForms
   SPECIAL_COLUMN_TYPES = {
     :associated => :no_migration
   }
+  
+  # RELATIONS defines a mapping between AR::Migrations columns and the Model.
+  #
   # When a column has the type of :references or :belongs_to, then
   # there will be a line in the migration reflecting that, but not in the model.
   # == Why?
@@ -115,7 +119,9 @@ module InlineForms
     :references => :belongs_to,
   }
 
-  # The stuff in this hash will add a line to the model, but little else.
+  # SPECIAL_RELATIONS maps AR relations to migrations.
+  # In most cases, these relations have no migration at all, but they do need
+  # a line in the model.
   SPECIAL_RELATIONS = {
     :has_many                 => :no_migration,
     :has_many_destroy         => :no_migration,
@@ -125,10 +131,10 @@ module InlineForms
   }
 
   # Declare as a Rails::Engine, see http://www.ruby-forum.com/topic/211017#927932
-  class InlineFormsEngine < Rails::Engine
-    initializer 'inline_forms.helper' do |app|
-      ActionView::Base.send :include, InlineFormsHelper
-    end
+  class Engine < Rails::Engine
+#    initializer 'inline_forms.helper' do |app|
+#      ActionView::Base.send :include, InlineFormsHelper
+#    end
   end
 end
 

data/lib/inline_forms/version.rb

@@ -1,3 +1,3 @@
 module InlineForms
-  VERSION = "1.1.12"
+  VERSION = "1.1.13"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: inline_forms
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 1
   - 1
-  - 12
-  version: 1.1.12
+  - 13
+  version: 1.1.13
 platform: ruby
 authors: 
 - Ace Suares