fancygrid 1.0.0

data/.bundle/config

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -0,0 +1,34 @@
+1.0.0 - Added the "ajax_type" option so ajax callbacks are not restricted to GET requests only.
+      - Fixed a js bug that removes the input field focus when doing a simple search
+      BREAKING CHANGES:
+        - Added the "enable_sort_window" option. Set it to true to display the sort button that opens the sort window. The button was previosly always visible.
+1.0.0-pre - Full Feature implementation done. 
+          - Fixed tests
+          - Added new style
+          - Every "js-" prefix in css classes is now "fg-" and stands for 'fancygrid'
+0.6.2 - Drop down select box is now possible as a simple search input field
+0.6.1 - Refactored js and improved column sorting
+0.6.0 - Initial implemetation of column sorting feature
+0.5.1 - Fixed the complex search and improved viewstate caching.
+0.5.0 - Initial implementation of the complex search.
+0.4.2 - Ability to define a block for print out a custom css class for each table row. Check out the 'css_proc' method
+      - Implemented flexible query generator. You dont have to clutter all your conditions into a single place anymore
+0.4.1 - Added a dummy testapplication into spec folder.
+      - Added several tests testing the core functionality.
+      - Added more documentation.
+      - Fixed a bug where not all find options were passed to the final find call.
+0.4.0 - Fancygrid is now a Rails Engine instead of a Railtie. This allows us to 
+        use template names for rendering, instead of absolute pathes. This makes
+        it possible to use fancygrid in other rails engines.
+      - Dumping and loading a view state for a grid is now possible. You can
+        dump and save a viewstate when a user leaves a site and load that state
+        when the user comes back.
+      BREAKING CHANGES:
+        - The initializer variable names have changed. Check the new initializer
+          file and compare it to the one in your projects.
+0.3.3 - Fixed pagination
+0.3.2 - Flexible initilaization
+0.3.1 - Raketask replaced with generators 
+0.3.0 - Grid rendering using blocks is now possible
+0.2.0 - Revisited implementation
+0.1.0 - Initial implementation

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rails", ">=3.0.3"
+  gem "jeweler"
+end
+
+group :test do
+  gem "capybara", ">= 0.4.0"
+  gem "webrat"
+  gem "sqlite3"
+  gem "rspec-rails", ">= 2.0.0.beta"
+end
+
+

data/Gemfile.lock

@@ -0,0 +1,125 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.7)
+    builder (2.1.2)
+    capybara (0.4.1.1)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.7)
+    childprocess (0.1.6)
+      ffi (~> 0.6.3)
+    culerity (0.2.15)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.5.1)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.5.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.5.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.2)
+      childprocess (~> 0.1.5)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    webrat (0.7.3)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.0)
+  jeweler
+  rails (>= 3.0.3)
+  rspec-rails (>= 2.0.0.beta)
+  sqlite3
+  webrat

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alexander Gräfenstein
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,299 @@
+= 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.