datatable 0.1.0alpha2

data/.bundle/config

@@ -0,0 +1,3 @@
+--- 
+BUNDLE_PATH: vendor
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1,7 @@
+.idea
+docs
+*.gem
+vendor/ruby
+example_app/config/database.yml
+*/**/.DS_Store
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+-c -f d 

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# all the runtime dependencies are listed in the gemspec
+gemspec
+
+# all the develpment dependencies are listed here
+gem 'rake'
+gem 'rdoc'
+gem 'gemcutter'

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    datatable (0.1.0alpha2)
+      rails (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.9)
+      actionpack (= 3.0.9)
+      mail (~> 2.2.19)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    gemcutter (0.7.0)
+    i18n (0.5.0)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.9)
+      actionmailer (= 3.0.9)
+      actionpack (= 3.0.9)
+      activerecord (= 3.0.9)
+      activeresource (= 3.0.9)
+      activesupport (= 3.0.9)
+      bundler (~> 1.0)
+      railties (= 3.0.9)
+    railties (3.0.9)
+      actionpack (= 3.0.9)
+      activesupport (= 3.0.9)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rdoc (3.8)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  datatable!
+  gemcutter
+  rake
+  rdoc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Michael A. Greenly
+
+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.md

@@ -0,0 +1,135 @@
+Datatable
+=========
+
+This is a [Rails 3.0](http://rubyonrails.org) plugin that provides server-side processing for the [Datatables](http://datatables.net) javascript library.  The screenshot below
+contains an example with global search, per column search, infinite scrolling and the optional table tools plugin installed using the jquery ui them 'smoothness'.
+
+
+![Alt text](https://github.com/logic-refinery/datatable/raw/master/images/datatable_screenshot.png "optional title") 
+
+
+WARNING!!!
+==========
+
+This gem is not ready for primetime but if you're feeling adventurous read on....
+
+
+Introduction
+============
+
+It's likely the code base will experience significant churn in the next few releases as we search for the best way deliver the desired 
+functionality.  If you think this may be a problem you should most likely avoid using it for now.  On the other hand if you're not afraid
+of diving into the code to help us improve it we will certiainly do what we can to make sure it works
+for you in return.
+
+Setup
+======
+
+Because of the fast moving nature of this project for the time being I recomend using bundler and pulling from git.  If you
+intend to deploy an application using this gem I'd recomend locking your dependency to a specific well tested commit.
+
+Add the following to you Gemfile
+
+```ruby
+  gem "datatable", :git => "git://github.com/logic-refinery/datatable.git" :ref => "500a5f"
+```
+
+Then run bundle install
+
+```sh
+  bundle
+```
+
+Then run the generator to create the javascript files and code templates
+
+```sh
+  rails generate datatable:install
+```
+
+The generator will have added some javascript files to your public/javascript folder that need to be added after jquery using a helper.
+
+```erb
+  <%= javascript_include_tag :defaults %>
+  <%= datatable_javascript %>
+```
+
+If you want to use the jquery ui be sure to include those style sheets.
+
+```erb
+  <%= stylesheet_link_tag :all %>
+  <%= stylesheet_link_tag 'smoothness/jquery-ui-1.8.14.custom' %>
+```
+
+The generator created a template in app/config/initializers/datatable.rb that you can modify as needed.
+
+```ruby
+  Datatable::Base.config do |config|
+    config.style = true
+    config.sql_like = 'ILIKE'
+    config.table_tools = true
+  end
+```
+
+Usage
+=====
+
+Imagine that you have an 'Order' that belongs to a 'Customer' and has many 'Item'
+
+In app/controllers/orders_controller.rb you would add something like this:
+
+```ruby
+  def index
+    @datatable = OrdersIndex
+    respond_to do |format|
+      format.html
+      format.js { render :json => @datatable.query(params).to_json }
+    end
+  end
+```
+
+In app/views/orders/index.html.erb you would add something like this:
+
+```erb
+  <%= datatable %>
+```
+
+In app/datatables/orders_index.rb you would need to define the datatable.  In the future this hopefully will be a DSL that's easier to use.
+Right now it mostly just exposes the internal datastructures so the necessary information can be defined. See the [wiki](https://github.com/logic-refinery/datatable/wiki) 
+for more detailed information.
+
+```ruby
+  class OrdersIndex < Datatable::Base
+    sql <<-SQL
+      SELECT
+      orders.id,
+      orders.order_number,
+      customers.first_name,
+      customers.last_name,
+      orders.memo
+    FROM
+      orders
+    JOIN
+      customers ON customers.id = orders.customer_id
+    SQL
+
+    columns(
+      {"orders.id" => {:type => :integer, :heading => "Id", :sWidth => '50px'}},
+      {"orders.order_number" => {:type => :integer, :link_to => link_to('{{1}}', order_path('{{0}}')),:heading => 'Order Number', :sWidth => '125px' }},
+      {"customers.first_name" => {:type => :string, :link_to => link_to('{{2}}', order_path('{{0}}')),:sWidth => '200px' }},
+      {"customers.last_name" => {:type => :string,:sWidth => '200px'}},
+      {"orders.memo" => {:type => :string }})
+
+    option('bJQueryUI', true)
+    option('individual_column_searching', true)
+    option('sDom', '<"clear"><"H"Trf>t<"F"i>')
+    option('bScrollInfinite', true)
+    option('bScrollCollapse', true)
+    option('sScrollY', '200px')
+  end
+```
+
+
+Limitations
+==========
+
+ *  It only supports MySQL and PostgreSLQ through ActiveRecord.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/clean'
+require 'rdoc/task'
+
+CLOBBER.include('*.gem')
+
+task :default do
+  puts 'Run "rake spec" in the "example_app" directory to perform tests.'
+end
+
+desc 'Generate documentation for the datatable plugin.'
+Rake::RDocTask.new(:rdoc => 'rdoc', :clobber_rdoc => "rdoc:clobber", :rerdoc => 'rdoc:force') do |rdoc|
+  rdoc.rdoc_dir = 'docs'
+  rdoc.title    = 'Datatable'
+  rdoc.options  << "--all"
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "build gem"
+task :build do
+  system "gem build datatable.gemspec"
+end
+
+desc "publish gem"
+task :release => :build do
+  system "gem push datatable-#{Datatable::VERSION}.gem"
+end

data/TODO

@@ -0,0 +1,71 @@
+Update the config initializer
+
+BUG: search column count doesn't include unsearchable columns and this
+     isn't taken into account.
+
+SECURITY: don't rely on iColumns being meaningful or correct us our internal
+          definition of the table to determine the number of columns.  using
+          the parameter allows the caller to make our code operate out of
+          bounds
+
+PERFORMANCE: if the search string is empty leave that search out of the SQL 
+             don't search for '%%'
+
+#) replace haeding w/ sTitle
+
+
+
+
+--------
+
+#) Provide example of fnRender in the tests for example: It needs to be possible to turn
+   a boolean field into 'done' or 'not done'.
+
+#) write a script that puts the most recent files into the gem root. it should not include the files that we don't want (e.g. demo_page.css)
+
+#) Need to be able to define default sort ordefault sort orders
+
+#) provide a reset link in so that all the search inputs are cleared
+   would be nice if it was easily hooked to a keystroke for example
+   ESC when any of the inputs have the focus
+
+#) allow multiple space separated search values in global search the OR the result
+   together for each value and each column.  So for example having "alice bob" in the search input
+   would generate a where clause like this...
+
+      WHERE (first_name LIKE 'alice' OR first_name LIKE 'bob') OR (other_column LIKE 'alice' OR other_column LIKE 'bob') OR ...
+
+
+#) release 0.1 (support for rails 3.0)
+
+THE FUTURE
+  Advanced search
+  Date search
+  TYPECASTING
+    #) make it so both global search and individual column searches
+   support typcasting so that those columns can be searched as
+   strings, example:
+
+       SELECT order_number FROM orders WHERE CAST(order_number as text) LIKE '%123%';
+
+       column({'orders.order_number' => {:type => :string, :cast => :text }})
+
+   having :cast present would force it to build any where clauses using a type cast
+  Move all tests into root directory so there can be multiple versions of the example application
+  Rails 3.1
+  printing
+  download as csv/excel
+  search date ranges
+  support internationalization (http://www.datatables.net/usage/i18n)
+  support callbacks  (http://www.datatables.net/usage/callbacks)
+  support all datatable options (http://www.datatables.net/usage/options)
+  make config more robust (https://github.com/jnicklas/carrierwave/blob/master/lib/carrierwave/uploader/configuration.rb)
+  reordering columns
+  lightbox editing
+  maybe parse the sql?
+  maybe build the sql from the column definitions?
+  focus on active relation version
+
+
+
+http://docs.codehaus.org/display/JPARSEC/SQL+parser+in+rparsec

data/datatable.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "datatable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "datatable"
+  s.version     = Datatable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Greenly", 'Mischa Fierer']
+  s.email       = ["michaelgreenly@logic-refinery.com"]
+  s.homepage    = "https://github.com/logic-refinery/datatable"
+  s.summary     = %q{A Rails plugin for the jquery.datatables library}
+  s.description = %q{A Rails plugin for the jquery.datatables library}
+  s.add_dependency('rails', '>= 3.0')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/example_app/.gitignore

@@ -0,0 +1,6 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+vendor/ruby
+.DS_Store

data/example_app/.rspec

@@ -0,0 +1 @@
+--colour

data/example_app/Gemfile

@@ -0,0 +1,35 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.7'
+gem 'pg'
+gem 'mysql'
+gem 'datatable', :path => "../" 
+gem "jquery-rails"
+
+
+#
+# ruby-debug can't be installed using bundler on Linx under rvm with Ruby 1.9 because it
+# tries to download header files to folders not owned by the current user.  The easiest
+# way to work around this is to put ruby-debug in an optional group and that can be 
+# excluded when bundle install is run.
+#
+#  bundle install --exclude=debug
+#
+# If you want you can install ruby-debug manually in this situation
+#
+#  gem install ruby-debug19 -- --with-ruby-include=$rvm_path/src/$RUBY_VERSION/
+#
+group :test, :development do
+  gem 'require_relative'
+  gem 'ruby-debug', :platform => :ruby_18
+  gem 'rake', '0.8.7'
+  gem "i18n"
+  gem "webrat"
+  gem "activesupport"
+  gem "rspec"
+  gem "rspec-rails"
+  gem "factory_girl_rails"
+  gem "webrat"
+end
+
+

data/example_app/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: ../
+  specs:
+    datatable (0.1.0alpha2)
+      rails (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.10)
+    builder (2.1.2)
+    columnize (0.3.3)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (1.3.3)
+    factory_girl_rails (1.0.1)
+      factory_girl (~> 1.3)
+      railties (>= 3.0.0)
+    i18n (0.5.0)
+    jquery-rails (1.0.11)
+      railties (~> 3.0)
+      thor (~> 0.14)
+    linecache (0.45)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mysql (2.8.1)
+    nokogiri (1.4.5)
+    pg (0.11.0)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    require_relative (1.0.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.28)
+    webrat (0.7.3)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  datatable!
+  factory_girl_rails
+  i18n
+  jquery-rails
+  mysql
+  pg
+  rails (= 3.0.7)
+  rake (= 0.8.7)
+  require_relative
+  rspec
+  rspec-rails
+  ruby-debug
+  webrat

data/example_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+RailsApp::Application.load_tasks

data/example_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/example_app/app/controllers/orders_controller.rb

@@ -0,0 +1,13 @@
+class OrdersController < ApplicationController
+
+  def index
+    @datatable = OrdersIndex
+    respond_to do |format|
+      format.html 
+      format.js { render :json => @datatable.query(params).to_json }
+    end
+  end
+
+end
+
+

data/example_app/app/datatables/orders_index.rb

@@ -0,0 +1,31 @@
+class OrdersIndex < Datatable::Base
+
+  sql <<-SQL
+      SELECT
+        orders.id,
+        orders.order_number,
+        customers.first_name,
+        customers.last_name,
+        orders.memo
+      FROM
+        orders
+      JOIN
+        customers ON customers.id = orders.customer_id
+  SQL
+
+  columns(
+    {"orders.id" => {:type => :integer, :sTitle => "Id", :sWidth => '50px'}},
+    {"orders.order_number" => {:type => :integer, :link_to => link_to('{{1}}', order_path('{{0}}')),:sTitle => 'Order Number', :sWidth => '125px'  }},
+    {"customers.first_name" => {:type => :string, :link_to => link_to('{{2}}', order_path('{{0}}')),:sWidth => '200px' }},
+    {"customers.last_name" => {:type => :string,:sWidth => '200px'}},
+    {"orders.memo" => {:type => :string }}
+  )
+  option('individual_column_searching', true)
+  #option('sDom', '<"H"lrf>t<"F"ip>')    # use with pagination
+  
+  # to use pagination comment out following and enable previous line
+  option('sDom', '<"clear"><"H"Trf>t<"F"i>')
+  option('bScrollInfinite', true)
+  option('bScrollCollapse', true)
+  option('sScrollY', '200px')
+end

data/example_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/example_app/app/models/customer.rb

@@ -0,0 +1,4 @@
+class Customer < ActiveRecord::Base
+  belongs_to :sales_rep
+  has_many :orders
+end

data/example_app/app/models/item.rb

@@ -0,0 +1,4 @@
+class Item < ActiveRecord::Base
+  has_many :order_items
+  has_many :orders, :through => :order_items
+end

data/example_app/app/models/order.rb

@@ -0,0 +1,5 @@
+class Order < ActiveRecord::Base
+  has_many :order_items
+  has_many :items, :through => :order_items
+  belongs_to :customer
+end

data/example_app/app/models/order_item.rb

@@ -0,0 +1,4 @@
+class OrderItem < ActiveRecord::Base
+  belongs_to :item
+  belongs_to :order
+end

data/example_app/app/models/sales_rep.rb

@@ -0,0 +1,3 @@
+class SalesRep < ActiveRecord::Base
+  has_many :customers
+end

data/example_app/app/views/layouts/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Datatable App</title>
+    <%= csrf_meta_tag %>
+    <%= stylesheet_link_tag :all %>
+    <%= javascript_include_tag :defaults %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>