simple_datatables 0.2.1 → 0.3.0

data/Gemfile.lock

@@ -1,111 +1,106 @@
-PATH
-  remote: .
-  specs:
-    simple_datatables (0.1)
-      meta_search
-      rails (~> 3.1.0.rc5)
-      will_paginate (~> 3.0.pre2)
-
-PATH
-  remote: jsonify-rails
-  specs:
-    jsonify-rails (0.0.6)
-      actionpack (~> 3.1.0.rc4)
-      jsonify
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.1.0.rc5)
-      actionpack (= 3.1.0.rc5)
-      mail (~> 2.3.0)
-    actionpack (3.1.0.rc5)
-      activemodel (= 3.1.0.rc5)
-      activesupport (= 3.1.0.rc5)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6)
-      rack (~> 1.3.1)
-      rack-cache (~> 1.0.2)
-      rack-mount (~> 0.8.1)
-      rack-test (~> 0.6.0)
-      sprockets (~> 2.0.0.beta.12)
-    activemodel (3.1.0.rc5)
-      activesupport (= 3.1.0.rc5)
-      bcrypt-ruby (~> 2.1.4)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.0.rc5)
-      activemodel (= 3.1.0.rc5)
-      activesupport (= 3.1.0.rc5)
-      arel (~> 2.1.4)
-      tzinfo (~> 0.3.29)
-    activeresource (3.1.0.rc5)
-      activemodel (= 3.1.0.rc5)
-      activesupport (= 3.1.0.rc5)
-    activesupport (3.1.0.rc5)
-      multi_json (~> 1.0)
-    arel (2.1.4)
-    bcrypt-ruby (2.1.4-x86-mingw32)
-    builder (3.0.0)
-    erubis (2.7.0)
-    hike (1.2.0)
-    i18n (0.6.0)
-    jsonify (0.1.0)
-    mail (2.3.0)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    meta_search (0.5.4)
-      actionpack (>= 3.0.0.beta4)
-      activerecord (>= 3.0.0.beta4)
-      activesupport (>= 3.0.0.beta4)
-      arel (>= 0.4.0)
-    mime-types (1.16)
-    multi_json (1.0.3)
-    polyglot (0.3.2)
-    rack (1.3.2)
-    rack-cache (1.0.2)
-      rack (>= 0.4)
-    rack-mount (0.8.1)
-      rack (>= 1.0.0)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.1.0.rc5)
-      actionmailer (= 3.1.0.rc5)
-      actionpack (= 3.1.0.rc5)
-      activerecord (= 3.1.0.rc5)
-      activeresource (= 3.1.0.rc5)
-      activesupport (= 3.1.0.rc5)
-      bundler (~> 1.0)
-      railties (= 3.1.0.rc5)
-    railties (3.1.0.rc5)
-      actionpack (= 3.1.0.rc5)
-      activesupport (= 3.1.0.rc5)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2)
-    rdoc (3.9.1)
-    sprockets (2.0.0.beta.13)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    thor (0.14.6)
-    tilt (1.3.2)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.29)
-    will_paginate (3.0.pre4)
-
-PLATFORMS
-  ruby
-  x86-mingw32
-
-DEPENDENCIES
-  jsonify-rails!
-  simple_datatables!
+PATH
+  remote: .
+  specs:
+    simple_datatables (0.2.1)
+      jsonify-rails
+      meta_search (~> 1.1.0)
+      rails (~> 3.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    json (1.7.3)
+    jsonify (0.3.1)
+      multi_json (~> 1.0)
+    jsonify-rails (0.3.2)
+      actionpack
+      jsonify (< 0.4.0)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    meta_search (1.1.3)
+      actionpack (~> 3.1)
+      activerecord (~> 3.1)
+      activesupport (~> 3.1)
+      polyamorous (~> 0.5.0)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyamorous (0.5.0)
+      activerecord (~> 3.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  simple_datatables!

data/README.rdoc

@@ -1,6 +1,6 @@
 = Simple Datatables
 
-Connects two awesome plugins - Datatables for Jquery and Meta Search together for Rails 3.1
+Connects two awesome plugins - Datatables for Jquery and Meta Search together for Rails 3
 
 == Install
 
@@ -8,7 +8,7 @@ Add the following to your Gemfile to install simple datatables:
 
   gem 'simple_datatables'
 
-After bundle install add this line to rails 3.1 assets pipeline and restart server:
+After bundle install add this line to rails assets pipeline and restart server:
 
   //= require simple_datatables
 
@@ -40,27 +40,33 @@ Use standard datatables initializer options for creating table:
 * fnServerData: point to simpleDatatables function
 * aoColumns: you *should* define all searchable/fiterable sName attributes here. Use format as used in meta_search (with underscores) 
 
-Create Jsonify view with column values for columns listed in aoColumns. See example for clarification.
+Create Jsonify view with column values for columns listed in aoColumns. View should be written in Jsonify style and should have *.jsonify file extension in order to work properly. See example and Jsonify docs for more details.
+
+== Dependencies
 
 This gem uses:
 * meta_search for nice search and sort request syntax mapping
 * jsonify for simple output generation 
 
 This gem provides integration with:
-* will_paginate for nice pagination request syntax mapping
+* will_paginate for nice pagination request syntax mapping (not bundled)
 
-Gem works only with rails 3.1.
+Gem works only with rails 3.1 and higher.
 
 Gem includes datatables library and fnSetFilteringDelay plugin so you haven't include it by yourself.
 
+Gem does not include any CSS files. Please use styles from datatables website examples.
+
 == Pagination
 
-Simple_datatables is compatible with will_paginate. Datatables will provide you "page" and "per_page" request params.
+Simple_datatables is compatible with will_paginate. In order to provide choise freedom you should add will_paginate to your project by yourself. Datatables will provide you "page" and "per_page" request params.
 
 If you do not use pagination do not forget to save search result to some variable with meta_search relation method:
 
   @products = Product.search(params[:search]).relation
 
+Your can use any other paginator. See below for the details.
+
 == Search for all fields
 
 Note that fulltext search will work only with text fields due to meta_search restrictions. To prevent errors use bSearchable: false for non-text columns in aoColumns field.
@@ -79,19 +85,30 @@ Independent fields search will always search using "starts_with" finder.
 
 If you are getting strange results (for instance, iTotalRecords and iTotalDisplayRecords both equal 0, or entirely the wrong collection is used), you might want to specify which collection to use:
 
-  respond_with @products, :locals => {:collection => @products}
+  @collection = @products
+  respond_with @products
 
 Also if you are using own or uncommon implementation of pagination you may use direct page count variables setting as follows:
 
-  respond_with @products, :locals => {:total_entries => 12, :current_page_entries => 10}
+  @total_entries = 12
+  @current_page_entries = 10
+  respond_with @products
 
-In this case gem will not try to find collection or pagination and will use the counters passed via locals.
+In this case gem will not try to find collection or pagination and will use the counters passed via variables.
 
 == Example
 
 The following code will show products list datatables. Manufacturer is belongs_to association for Product.
 
-In your controller:
+First of all add to your routes.rb datatables search api method:
+
+  resources :products do
+    collection do
+      get :search
+    end
+  end
+
+Then implement it in your controller:
 
   respond_to :html, :datatables
   
@@ -101,13 +118,13 @@ In your controller:
     respond_with @products
   end
 
-In your search view (app/views/products/search.jsonify):
+In your search view (app/views/products/search.jsonify) implement output fields order:
 
   @products.each do |product|
     json << [product.name, product.manufacturer.name]
   end
 
-In your index view:
+In your index view make a table with header (HAML):
 
   %table#products
     %thead
@@ -117,8 +134,7 @@ In your index view:
   
     %tbody
 
-
-In your javascript:
+In your javascript add the following code to initialize the datatables (be sure to do it after document load):
 
   $("#products").dataTable({
       "sAjaxSource"     : "/products/search.datatables",
@@ -133,4 +149,4 @@ In your javascript:
 
 == Copyright
 
-Copyright (c) Grigory Dmitrenko, 2011. See LICENSE for details.
+Copyright (c) Grigory Dmitrenko, 2012. See LICENSE for details.

data/Rakefile

@@ -1,3 +1,8 @@
-require "bundler"
+require 'rspec/core/rake_task'
 
-Bundler::GemHelper.install_tasks
+task :default => :spec
+
+desc 'Run ALL OF the specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  # t.ruby_opts = '-w'
+end

data/app/views/layouts/application.datatables.jsonify

@@ -1,36 +1,36 @@
-total_entries ||= nil
-current_page_entries ||= 0
-collection ||= nil
+@total_entries ||= nil
+@current_page_entries ||= 0
+@collection ||= nil
 
 # Looking for object with pagination if pages count not set
-if total_entries.nil? and current_page_entries==0
+if @total_entries.nil? and @current_page_entries==0
 
   # looking for the right collection if not initiated via parameter
-  if collection.nil?
+  if @collection.nil?
     instance_variables.each do |vn|
       v = instance_variable_get(vn)
   
       # if a collection variable was specified, use it only
-      next if collection && collection != v
+      next if @collection && @collection != v
       next if v.class.name.nil?
 
-      collection = v if v.class.name.start_with?("MetaSearch::Searches", "ActiveRecord::Relation", "Mongoid::Criteria")
+      @collection = v if v.class.name.start_with?("MetaSearch::Searches", "ActiveRecord::Relation", "Mongoid::Criteria")
     end
   end
 
   # receiving correct current page entries count
-  current_page_entries = collection.size if collection.respond_to?('size')
+  @current_page_entries = @collection.size if @collection.respond_to?('size')
 
   # looking for the total entries count
-  total_entries = collection.length if collection.class.name.start_with?("Mongoid::Criteria")
-  total_entries = collection.total_entries if collection.respond_to?('total_entries')
+  @total_entries = @collection.length if @collection.class.name.start_with?("Mongoid::Criteria")
+  @total_entries = @collection.total_entries if @collection.respond_to?('total_entries')
 
   # fallback to 1 page if total entries count not found
-  total_entries = current_page_entries if total_entries.nil?
+  @total_entries = @current_page_entries if @total_entries.nil?
 end
 
-json.iTotalRecords current_page_entries
-json.iTotalDisplayRecords total_entries
+json.iTotalRecords @current_page_entries
+json.iTotalDisplayRecords @total_entries
 json.sEcho params["sEcho"].to_i
 json.aaData do
   json.ingest! yield

data/lib/simple_datatables/version.rb

@@ -1,3 +1,3 @@
 module SimpleDatatables
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/simple_datatables.gemspec

@@ -1,24 +1,24 @@
-$:.push File.expand_path("../lib", __FILE__)
-require "simple_datatables/version"
-
-Gem::Specification.new do |s|
-  s.name        = "simple_datatables"
-  s.version     = SimpleDatatables::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Grigory"]
-  s.email       = ["grigory@snsk.ru"]
-  s.homepage    = "http://github.com/gryphon/simple_datatables"
-  s.summary     = %q{Simple datatables to rails mapping using meta_search, will_paginage and jsonify}
-  s.description = %q{Simple datatables to rails mapping using meta_search, will_paginage and jsonify}
-
-  s.rubyforge_project = "data_table"
-
-  s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_dependency "rails", "~> 3.1.0"
-  s.add_dependency "meta_search", '~> 1.1.0'
-  s.add_dependency "jsonify-rails"
-
-end
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_datatables/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_datatables"
+  s.version     = SimpleDatatables::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Grigory"]
+  s.email       = ["grigory@snsk.ru"]
+  s.homepage    = "http://github.com/gryphon/simple_datatables"
+  s.summary     = %q{Simple datatables to rails mapping using meta_search, will_paginage and jsonify}
+  s.description = %q{Simple datatables to rails mapping using meta_search, will_paginage and jsonify}
+
+  s.rubyforge_project = "data_table"
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 3.1"
+  s.add_dependency "meta_search", '~> 1.1.0'
+  s.add_dependency "jsonify-rails"
+
+end