fancygrid 1.1.0 → 2.0.0

data/.bundle/config

@@ -1,2 +0,0 @@
---- {}
-

data/README.rdoc

@@ -1,299 +0,0 @@
-= Fancygrid
-Fancygrid mades it easy to create and render tables for database records in rails.
-== Features
-* ActiveRecord and ActiveResource are supported
-* Ajax data fetch
-* Pagination
-* Simple search with LIKE condition
-* Complex search with 17 different conditions
-* Frontend column sorting
-* View state caching
-* May be rendered anywhere, not restricted to the index action
-* Column values may be attributes, methods or even custom blocks
-* Custom templates for column formatting
-
-= Requirements
-* jQuery >= 1.4.2
-* jQuery-ui (required if column sorting is wanted)
-* Rails 3
-* Haml
-
-= Installation
-In your gemfile
-    gem 'fancygrid', :git => 'git://github.com/giniedp/fancygrid.git'
-
-or for specific tag
-    gem 'fancygrid', :git => 'git://github.com/giniedp/fancygrid.git', :tag => "1.0.0-pre"
-    
-Run
-    bundle install
-    
-and
-    rails g fancygrid:install
-    
-then follow the instructions
-
-= Getting started
-
-== Basic Setup
-In any controller in any action you can define a fancygrid for a specific model.
-A controller is the place where you define what data should be queried from
-the database and what columns will be visible. For example you could define
-a table for your users like this:
-=== Example
-    # UsersController
-    def index
-      # setup fancygrid to display users
-      fancygrid_for :users do |user|
-        
-        # specify attributes to display  
-        user.attributes( :id, :username, :email )
-
-        # specify the callback url for ajax loading
-        user.url = users_path
-        
-        # finally call find with some customized find options
-        user.find( :order => "users.created_at DESC" )
-        
-      end
-    end
-  
-In your View you have to render the fancygrid. Use the name that you have used
-in your controller
-=== Example
-    # app/views/users/index.html.haml
-    = fancygrid :users
-
-== Static tables
-If you dont want to have an ajax table, you can set the data directly without
-providing a callback url. 
-=== Example
-    def index
-      fancygrid_for :users do |user|
-        
-        # ...
-        
-        # dont set the url and find options like in the first example
-        # instead set the data directly
-        user.data= User.find(:all)
-        
-      end
-    end
-   
-== Table names and model names
-Usually fancygrid takes the passed name and tries to resolve the models class
-and its database table name. If you need to use a name that is different
-from your models name which is the case when you have namespaced models, you can 
-pass the models constant and its table name to fancygrid
-=== Example
-    def index
-      fancygrid_for :user, Namespace::User, "users" do |user|
-        
-        # ...
-        
-      end
-    end
-    
-= Using methods on records
-You are not limited to the models attributes to display in the fancygrid. You can
-provide method names to display a models properties
-=== Example
-    def index  
-      fancygrid_for :users do |user|
-      
-        # ...
-        
-        # specify methods to call on each record
-        user.methods(:full_name, :some_other_method)
-        
-        # ...
-        
-      end
-    end
-    
-You can even pass a proc to a single column
-=== Example
-    def index  
-      fancygrid_for :users do |user|
-      
-        # ...
-        
-        user.proc( :roles ) do |record|
-          record.roles.map{ |r| r.name }.join(", ")
-        end
-        
-        # ...
-        
-      end
-    end
-    
-For more complex output you must have to render a column with custom template
-
-== Rendering columns with templates
-For custom cell rendering create a template at some place like *app/views/fancygrid/users.html.haml*
-In your fancygrid definition do:
-=== Example
-    def index  
-      fancygrid_for :users do |user|
-      
-        # ...
-        
-        # specify cells that will be rendered with custom code
-        user.rendered(:actions)
-        
-        # set the templates name 
-        user.template = "fancygrid/users"
-        
-        # ...
-        
-      end
-    end
-
-In your template you can use the following locals: <tt>table</tt>, <tt>column</tt>, <tt>record</tt> and <tt>value</tt>
-so you can render your cell like this:
-=== Example
-    - case table.name
-    - when :users
-      - case column.name
-      - when :actions
-        = link_to "Show", user_path(record)
-        = link_to "Edit", edit_user_path(record)
-
-== Rendering columns with a haml block
-In your view you can give a grid a block that should be used for rendering
-=== Example
-    = fancygrid(:users) do |column, record, value|
-      - case column.name
-      - when :actions
-        = link_to "Show", user_path(record)
-        = link_to "Edit", edit_user_path(record)
-        
-== Display associated data (belongs_to or has_one)
-To display an associated data you have to build the nodes for that data and
-specify the include option for the find method
-=== Example
-    def index  
-      fancygrid_for :users do |user|
-      
-        # ...
-        
-        user.columns_for(:contact) do |contact|
-          contact.attributes( :first_name, :last_name )
-        end
-        
-        # ...
-        
-        user.find( :include => :contact )
-        
-      end
-    end
-    
-If your association name is different from the models name pass the model 
-constant into the columns_for method.
-=== Example
-    def index  
-      fancygrid_for :users do |user|
-      
-        # ...
-        
-        user.columns_for(:work_address, Address) do |address|
-          address.attributes( :street, :zipcode, :city )
-        end
-        
-        # ...
-        
-        user.find( :include => :work_address )
-        
-      end
-    end
-    
-== Display associated data (has_many or has_and_belongs_to_many)
-Similar to the previous example you have to build the nodes for the associations
-and specify the include option
-=== Example
-    def index  
-      fancygrid_for :users do |user|
-      
-        # ...
-        
-        user.columns_for(:roles) do |roles|
-          roles.attributes( :name )
-        end
-        
-        # ...
-
-        user.find( :unclude => :roles )
-        
-      end
-    end
-    
-However this would not work as expected. Its the same as calling <tt>user.roles.name</tt>
-which would call <tt>name</tt> on a collection of roles.
-
-Instead you should rather define a <tt>proc</tt> to return all role names or 
-render that cell with custom code.
-=== Example      
-    def index  
-      fancygrid_for :users do |user|
-      
-        # ...
-        
-        user.proc( :roles ) do |record|
-          record.roles.map{ |r| r.name }.join(", ")
-        end
-        
-        # ...
-        
-      end
-    end
-
-== Order your conditions
-If you have a large condition to make or you want to use a condition that depends on a users role, for example when
-some of your users are not allowed to see specific data, then you can give the find method a block and use the query generator
-
-=== Example
-    fancygrid_for :users do |grid|
-      
-      # ...
-      
-      grid.find do |query|
-        # all the conditions are joined with an AND operator
-        query.conditions(["users.first_name = ?", "some name"])
-        query.conditions(["users.last_name = ?", "some name"])
-        
-        # use other finder options as methods
-        query.select #...
-        query.order  #...
-        # ...
-      end
-    end
-    
-== Caching the view state
-To make your users life easier you can enable the view state caching. This way
-the user can search for data, leave the site, come back and have his last
-search back on screen. Here is an example of how to store the view in the users session:
-=== Example
-    # ensure that there is a hash in the session
-    session[:users_table_view_state] ||= {}
-    
-    fancygrid_for :users do |grid|
-      
-      # ...
-      
-      # specify a proc to load the view state
-      grid.load_view_proc do |grid_instance|
-        session["fancygrid_users"] || {}
-      end
-      
-      # specify a proc to store the view state
-      grid.store_view_proc do |grid_instance, dump|
-        session["fancygrid_users"] = dump
-      end
-
-    end
-    
-Its up to your business logic where and how you store the dumped view state. If you have lots of tables 
-i would recommend to enable database session store.
-   
-= Copyright
-Copyright (c) 2010 Alexander Graefenstein. See LICENSE for details.

data/app/views/fancygrid/_cells.html.haml

@@ -1,13 +0,0 @@
-/ available locals are
-/ grid   : the fancygrid instance
-/ cell   : the column to render
-/ record : the datarecord for the current row to render
-/ value  : the value for current cell to render
- 
-/ example rendering the actions show and edit for a users table
-/- case grid.name
-/- when :users
-/  - case cell.name
-/  - when :actions
-/    = link_to "Show", user_path(record)
-/    = link_to "Edit", edit_user_path(record)

data/app/views/fancygrid/base/controls.html.haml

@@ -1,40 +0,0 @@
-%ul.fg-control-bar{ :class => css_class }
-  %li
-    %span
-      = t(:"pagination.per_page", :default => "Results per Page", :scope => Fancygrid.i18n_scope)
-    = select_tag(:per_page, options_for_select(fancygrid.per_page_options, fancygrid.view.get_pagination_per_page), :class => "fg-per-page")
-    
-  %li.separator
-  %li.button
-    = fancygrid_button(:"fg-previous", :"pagination.prev_page", "Previous page")
-    
-  %li
-    %span
-      = t(:"pagination.page", :default => "Page", :scope => Fancygrid.i18n_scope)
-    = text_field_tag(:"fg-page", fancygrid.view.get_pagination_page + 1, :class => :"fg-page" )
-    %span
-      = t(:"pagination.of", :default => "of", :scope => Fancygrid.i18n_scope)
-    %span.fg-page-total
-      = 0
-      
-  %li.button
-    = fancygrid_button(:"fg-next", :"pagination.next_page","Next page")
-  %li.separator
-  %li
-    %span
-      = t(:"pagination.results", :default => "Total entries", :scope => Fancygrid.i18n_scope)
-    %span.fg-result-total
-      = fancygrid.resultcount or 0
-  %li.button
-    = fancygrid_button(:"fg-reload", :"pagination.reload", "Reload")
-  %li.button
-    = fancygrid_button(:"fg-clear", :"search.clear", "Clear search")
-  %li.button
-    = fancygrid_button(:"fg-magnify", :"search.toggle", "Toggle Search")
-      
-  - if fancygrid.has_sort_window?
-    %li.button
-      = fancygrid_button(:"fg-sort", :"sort.submit", "Sort columns")
-  %li.separator
-  
-  = yield :fancygrid_buttons

data/app/views/fancygrid/base/list_frame.html.haml

@@ -1,37 +0,0 @@
-.fg-fancygrid{ :class => fancygrid.name }
-  - if fancygrid.has_complex_search?
-    = render(:template => Fancygrid.search_template, :locals => { :fancygrid => fancygrid })
-  - if fancygrid.has_top_control?
-    = render(:template => Fancygrid.controls_template, :locals => { :fancygrid => fancygrid, :css_class => "controls top" })
-
-  .fg-tablewrapper
-    - unless fancygrid.is_static?
-      %ul.fg-search
-        - fancygrid.each_visible_leaf do |leaf|
-          - next unless leaf.searchable
-          %li{ :class => leaf.css_class }
-            %label{ :for => leaf.tag_name }
-              = leaf.human_name
-            - case leaf.search_input_kind
-            - when :none
-              = text_field_tag( leaf.tag_name, leaf.search_value, :class => "fg-attribute" )
-            - when :select
-              = select_tag( leaf.tag_name, options_for_select(leaf.search_select_collection, :selected => leaf.search_value),  :class => "fg-attribute" )
-                
-    %ul.fg-row
-      - fancygrid.each_record do |record|
-        %li{ :class => fancygrid.name.to_s.singularize }
-          = render_fancygrid_leaf(record, fancygrid, &format_block)
-  
-  - if fancygrid.has_bottom_control?
-    = render(:template => Fancygrid.controls_template, :locals => { :fancygrid => fancygrid, :css_class => "controls bottom" })
-
-- unless fancygrid.is_static?
-  :javascript
-    $(function(){
-      var fancyOptions = #{fancygrid.js_options};
-      $(".fg-fancygrid.#{fancygrid.name}").fancygrid(fancyOptions);
-      if(!fancyOptions.isStatic){
-        $(".fg-fancygrid.#{fancygrid.name}").fancygrid("reloadPage");
-      }
-    });

data/app/views/fancygrid/base/search.html.haml

@@ -1,33 +0,0 @@
-:ruby
-  searchable_columns = fancygrid.serachable_leafs.map{ |leaf| 
-    [leaf.human_name, leaf.tag_name] 
-  }
-  search_operators = fancygrid.search_operators.map { |op| 
-    [I18n.t(:"search.operator.#{op.to_s}", :default => op.to_s.humanize, :scope => Fancygrid.i18n_scope ), op.to_s] 
-  }
-   
-= field_set_tag( t(:"search.title", :default => "Search", :scope => Fancygrid.i18n_scope), :class => :"fg-search" ) do
-  .fg-search-controls
-    = fancygrid_button(:"fg-search-add", :"search.add", 'Add')
-    = fancygrid_button(:"fg-search-submit", :"search.submit", 'Search')
-    = fancygrid_button(:"fg-clear", :"search.clear", 'Clear search')
-    = check_box_tag(:"fg-search-conditions", :all, fancygrid.view.get_search_operator.to_s == "all")
-    = label_tag(:"fg-search-conditions", t(:"fancygrid.search.conditions", :default => 'All conditions must met:'))
-      
-  %ul.fg-search-criteria
-    - fancygrid.each_visible_leaf do |leaf|
-      - fancygrid.view.get_node_search_conditions(leaf).each do |condition|
-        %li.fg-search-criterion
-          = fancygrid_button(:"fg-search-remove", :"search.remove", "Remove")
-          = select_tag(:column_name, options_for_select(searchable_columns, leaf.tag_name))    
-          = select_tag(:operator, options_for_select(search_operators, condition[:operator]))
-          = text_field_tag(:column_value, condition[:value])
-  
-
-      
-.fg-search-template
-  %li.fg-search-criterion
-    = fancygrid_button(:"fg-search-remove", :"search.remove", "Remove")
-    = select_tag(:column_name, options_for_select(searchable_columns))    
-    = select_tag(:operator, options_for_select(search_operators ))
-    = text_field_tag(:column_value, "")

data/app/views/fancygrid/base/sort.html.haml

@@ -1,20 +0,0 @@
-.fg-sort-window.ui-widget-overlay{ :style => "display: none;" }
-.fg-sort-content{ :style => "display: none;" }
-  .ui-state-highlight.ui-corner-all
-    = t(:"sort.info", :scope => Fancygrid.i18n_scope)
-  %ul.fg-sortable-visible.fg-sortable.ui-widget-content.ui-corner-all
-    %li.fg-not-sortable.ui-corner-all.ui-state-active
-      %h4
-        = t(:"sort.header_visible", :scope => Fancygrid.i18n_scope)
-    - fancygrid.each_visible_leaf do |leaf|
-      %li.ui-state-default.ui-widget-header.ui-corner-all{ :class =>  leaf.css_class, :id => leaf.tag_name} 
-        %span.ui-icon.ui-icon-arrowthick-2-n-s
-        = leaf.human_name
-  %ul.fg-sortable-hidden.fg-sortable.ui-widget-content.ui-corner-all
-    %li.fg-not-sortable.ui-corner-all.ui-state-active
-      %h4
-        = t(:"sort.header_hidden", :scope => Fancygrid.i18n_scope)
-    - fancygrid.each_hidden_leaf do |leaf|
-      %li.ui-state-default.ui-widget-header.ui-corner-all{ :class =>  leaf.css_class, :id => leaf.tag_name} 
-        %span.ui-icon.ui-icon-arrowthick-2-n-s
-        = leaf.human_name