datatable 0.1.1alpha4 → 0.2pre1

data/.gitignore

@@ -5,3 +5,4 @@ vendor/ruby
 example_app/config/database.yml
 */**/.DS_Store
 .DS_Store
+.*.swp

data/Rakefile

@@ -1,6 +1,9 @@
 require 'rake/clean'
 require 'rdoc/task'
 
+$:.push File.expand_path("../lib", __FILE__)
+require "datatable/version"
+
 CLOBBER.include('*.gem')
 
 task :default do

data/example_app/.gitignore

@@ -4,3 +4,4 @@ log/*.log
 tmp/
 vendor/ruby
 .DS_Store
+.*.swp

data/example_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    datatable (0.1.0alpha2)
+    datatable (0.2pre1)
       rails (>= 3.0)
 
 GEM

data/example_app/app/controllers/orders_controller.rb

@@ -1,7 +1,19 @@
 class OrdersController < ApplicationController
 
   def index
-    @datatable = OrdersIndex
+  end
+
+  def example1
+    @datatable = Example1
+    respond_to do |format|
+      format.html 
+      format.js { render :json => @datatable.query(params).to_json }
+    end
+  end
+
+  def example2
+    @datatable = Example2
+    @datatable.relation = Order.select([:order_number, :memo]).where(["memo like ?", 'red'])
     respond_to do |format|
       format.html 
       format.js { render :json => @datatable.query(params).to_json }

data/example_app/app/datatables/{orders_index.rb → example1.rb}

@@ -1,4 +1,4 @@
-class OrdersIndex < Datatable::Base
+class Example1 < Datatable::Base
 
   sql <<-SQL
       SELECT

data/example_app/app/datatables/example2.rb

@@ -0,0 +1,13 @@
+class Example2 < Datatable::Base
+
+  set_model Order
+
+  column :id, :type => :integer, :sTitle => "Id"
+  column :memo
+
+  option('individual_column_searching', true)
+  option('sDom', '<"clear"><"H"Trf>t<"F"i>')
+  option('bScrollInfinite', true)
+  option('bScrollCollapse', true)
+  option('sScrollY', '200px')
+end

data/example_app/app/views/orders/example1.html.erb

@@ -0,0 +1,11 @@
+<h1>Example #1</h1>
+
+<%#= stylesheet_link_tag '/datatable/css/demo_table.css' %>
+
+<%= stylesheet_link_tag '/datatable/css/smoothness/jquery-ui-1.8.14.custom.css' %>
+<%= stylesheet_link_tag '/datatable/css/demo_table_jui.css' %>
+
+<%= datatable %>
+
+
+<%= javascript_include_datatable %>

data/example_app/app/views/orders/example2.html.erb

@@ -0,0 +1,10 @@
+<h1>Example #2</h1>
+
+<%#= stylesheet_link_tag '/datatable/css/demo_table.css' %>
+
+<%= stylesheet_link_tag '/datatable/css/smoothness/jquery-ui-1.8.14.custom.css' %>
+<%= stylesheet_link_tag '/datatable/css/demo_table_jui.css' %>
+
+<%= datatable %>
+
+<%= javascript_include_datatable %>

data/example_app/app/views/orders/index.html.erb

@@ -1,14 +1,5 @@
-
-<h1>
-  Orders
-</h1>
-
-<%#= stylesheet_link_tag '/datatable/css/demo_table.css' %>
-
-<%= stylesheet_link_tag '/datatable/css/smoothness/jquery-ui-1.8.14.custom.css' %>
-<%= stylesheet_link_tag '/datatable/css/demo_table_jui.css' %>
-
-<%= datatable %>
-
-
-<%= javascript_include_datatable %>
+<h1>Datatable Examples</h1>
+<ul>
+  <li><%= link_to "example 1", example1_path %> - sql override</li>
+  <li><%= link_to "example 2", example2_path %> - active relation</li>
+</ul>

data/example_app/config/routes.rb

@@ -1,6 +1,9 @@
 RailsApp::Application.routes.draw do
 
+  match "example1" => "orders#example1", :as => 'example1'
+  match "example2" => "orders#example2", :as => 'example2'
+
   resources :orders
-  root :to => "orders#index"
 
+  root :to => "orders#index"
 end

data/example_app/spec/datatables/active_record_dsl_spec.rb

@@ -2,14 +2,6 @@ require 'spec_helper'
 
 describe 'Generating sql based on our DSL' do
 
-  # it 'should work' do
-  #   Order.create!(:order_number => 32)
-  #   datatable = OrdersIndex.new
-  #   params = {}
-  #   json = datatable.query(params).json
-  #   json['aaRecords'][0][0].should == 32
-  # end
-
   it 'should select two fields' do
     class OrdersSimple < Datatable::Base
       set_model Order 
@@ -37,6 +29,7 @@ describe 'Generating sql based on our DSL' do
     OrdersSimple.relation.should == Order.select(orders[:memo]).joins(:customer)
   end
 
+
   it 'should handle a join with an inner column' do
     class OrdersSimple < Datatable::Base
       set_model Order 

data/example_app/spec/datatables/sql_search_global_spec.rb

@@ -46,6 +46,8 @@ describe 'SQL defined datatable supports global search' do
   end
 
   it 'integer columns' do
+    # make sure all of the order numbers are nil so they don't match 
+    Order.update_all(:order_number => nil)
     order_id =  Order.all[rand(Order.count)].id.to_s
     @params['sSearch'] = order_id
     T.query(@params).to_json['aaData'][0][0].should == order_id

data/example_app/spec/datatables/sql_variables_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'variable substitution' do
+describe 'variable substitution in' do
 
   before do
     Object.send(:remove_const, :T) rescue nil
@@ -8,97 +8,64 @@ describe 'variable substitution' do
     @params = { "iColumns" =>	1 }
   end
 
-  describe "in sql clause" do
-    it 'of simple variables' do
-       class T < Datatable::Base
-        sql <<-SQL
-          SELECT
-            orders.id
-          FROM
-            orders
-          WHERE
-            orders.id = {{order_id}}
-        SQL
-        columns(
-          {'orders.id' => {:type => :integer}}
-        )
-       end
-      order_id = Order.last.id
-      T.query(@params, :order_id => order_id).to_json['aaData'].length.should == 1
-      T.query(@params, :order_id => order_id).to_json['aaData'].flatten.first.should == order_id.to_s
+  it "sql clause handles strings" do
+    class T < Datatable::Base
+      count "SELECT count(orders.id) FROM orders"
+      sql "SELECT orders.id FROM {{table}}"
+      columns({'orders.id' => {:type => :integer}})
     end
+    T.query(@params, :table => "orders").to_json['aaData'].flatten.sort.should == Order.all.map(&:id).map(&:to_s).sort
+  end
 
-    it 'of arrays' do
-       class T < Datatable::Base
-        sql <<-SQL
-          SELECT
-            orders.id
-          FROM
-            orders
-          WHERE
-            orders.id IN {{order_ids}}
-        SQL
-        columns(
-          {'orders.id' => {:type => :integer}}
-        )
-       end
-       order_ids = Order.all.map{|order| order.id }.sort
-       T.query(@params, :order_ids => order_ids).to_json['aaData'].flatten.sort.should == Order.order(:id).all.map {|o| o.id.to_s }
+  it "count clause handles strings" do
+    class T < Datatable::Base
+      count "SELECT count(orders.id) FROM {{table}}"
+      sql "SELECT orders.id FROM orders"
+      columns({'orders.id' => {:type => :integer}})
+    end
+    T.query(@params, :table => "orders").to_json['aaData'].flatten.sort.should == Order.all.map(&:id).map(&:to_s).sort
+  end
+  
+  it "where clause handles strings" do
+    class T < Datatable::Base
+      count "SELECT count(orders.id) FROM orders"
+      sql "SELECT orders.id FROM orders"
+      where "{{table}}.id IS NOT NULL"
+      columns({'orders.id' => {:type => :integer}})
     end
+    T.query(@params, :table => "orders").to_json['aaData'].flatten.sort.should == Order.all.map(&:id).map(&:to_s).sort
   end
 
-  it 'in count clause' do
+  it "where clause handles arrays" do
     class T < Datatable::Base
-     count <<-SQL
-       SELECT
-         count(orders.id)
-       FROM
-         orders
-     SQL
-     sql <<-SQL
-       SELECT
-         orders.id
-       FROM
-         orders
-     SQL
-     where <<-SQL
-       orders.id = {{order_id}}
-     SQL
-     columns(
-       {'orders.id' => {:type => :integer}}
-     )
+      count "SELECT count(orders.id) FROM orders"
+      sql "SELECT orders.id FROM orders"
+      where "orders.id in {{order_ids}}"
+      columns({'orders.id' => {:type => :integer}})
     end
-    order_id = Order.last.id
-    T.query(@params, :order_id => order_id).to_json['aaData'].length.should == 1
-    T.query(@params, :order_id => order_id).to_json['aaData'].should == [[order_id.to_s]]
+    T.query(@params, :order_ids => Order.all.map(&:id)).to_json['aaData'].flatten.sort.should == Order.all.map(&:id).map(&:to_s).sort
   end
 
-  describe "in where and count clause" do
-    it "should do something" do
-      class T < Datatable::Base
-       count <<-SQL
-         SELECT
-           count(orders.id)
-         FROM
-           orders
-       SQL
-       sql <<-SQL
-         SELECT
-           orders.id
-         FROM
-           orders
-       SQL
-       where <<-SQL
-          orders.id = {{order_id}}
-        SQL
-       columns(
-         {'orders.id' => {:type => :integer}}
-       )
-      end
-      order_id = Order.last.id
+  it "where clause handles empty arrays" do
+    class T < Datatable::Base
+      count "SELECT count(orders.id) FROM orders"
+      sql "SELECT orders.id FROM orders"
+      where "orders.id in {{order_ids}}"
+      columns({'orders.id' => {:type => :integer}})
     end
+    T.query(@params, :order_ids => []).to_json['aaData'].flatten.should == []
   end
 
+  it "where clause handles multiple calls" do
+    class T < Datatable::Base
+      count "SELECT count(orders.id) FROM orders"
+      sql "SELECT orders.id FROM orders"
+      where "orders.id = {{order_ids}}"
+      columns({'orders.id' => {:type => :integer}})
+    end
+    T.query(@params, :order_ids => Order.order(:id).first.id ).to_json['aaData'].flatten.sort.should == [Order.order(:id).first.id.to_s]
+    T.query(@params, :order_ids => Order.order(:id).last.id ).to_json['aaData'].flatten.sort.should == [Order.order(:id).last.id.to_s]
+  end
 
 
 end

data/lib/datatable/active_record_dsl.rb

@@ -10,6 +10,10 @@ module Datatable
         @relation
       end
 
+      def relation=(arg)
+        @relation = arg
+      end
+
       def set_model(model)
         @model = model
         @relation = model
@@ -25,9 +29,10 @@ module Datatable
 
         @columns ||= ActiveSupport::OrderedHash.new
 
-        column_hash = {}
-        column_hash[:type] = current_model.columns.detect{ |col| col.name == c.to_s}.type
-        column_hash[:link_to] = options[:link_to]
+        column_hash = options
+        unless column_hash[:type]
+          column_hash[:type] = current_model.columns.detect{ |col| col.name == c.to_s}.type
+        end
 
         @columns["#{current_model.table_name}.#{c}"] = column_hash
 
@@ -36,7 +41,6 @@ module Datatable
 
       # TODO: Change to joins to match arel
       def join(association, &block)
-
         @inner_model = current_model.reflect_on_association(association).klass
         @relation = @relation.joins(association)
         instance_eval(&block) if block_given?

data/lib/datatable/version.rb

@@ -1,4 +1,4 @@
 module Datatable
   # http://semver.org
-  VERSION = "0.1.1alpha4"
+  VERSION = "0.2pre1"
 end

data/lib/datatable.rb

@@ -58,14 +58,16 @@ module Datatable
     attr_accessor :records
 
     def self.sql(*args)
-      return @sql_string if args.empty?
-
-      @sql_string = args.first
+      if args.empty?
+        @sql_string
+      else
+        @sql_string = args.first
+      end
     end
-
+   
     def self.count(*args)
       if args.empty?
-        return @count_sql
+        @count_sql
       else
         @count_sql = args.first
       end
@@ -73,14 +75,14 @@ module Datatable
 
     def self.where(*args)
       if args.empty?
-        return @where_sql
+        @where_sql
       else
         @where_sql = args.first
       end
     end
 
-    def self.sql_string
-      @sql_string
+    def self.template_text
+      (where || "") + (count || "") + (sql || "")
     end
 
     def self.columns(*args)
@@ -126,28 +128,20 @@ module Datatable
         skparams[key] = (value ? true : false) if key =~ /^b/
       end
 
-      if @sql_string && !@already_substituted
-        substitute_variables(variables)
+      # scan the template text looking for the variables so 
+      # we can give a sensible error if it's missing
+      variables.each do |key, value|
+        unless template_text =~ /#{key}/m
+          fail "Substitution key: '#{key}' not in found in SQL text"
+        end
       end
-      @already_substituted = true
-
+ 
       datatable = new(skparams)
-      datatable.count
-      datatable.instance_query
+      datatable.count(variables)
+      datatable.instance_query(variables)
       datatable
     end
 
-    def self.substitute_variables(substitutions)
-      substitutions.stringify_keys.each do |key, value|
-        unless "#{@where_sql}#{@count_sql}#{@sql_string}" =~ /#{key}/m
-          fail "Substitution key: '#{key}' not in found in SQL text"
-        end
-        new_text = value.kind_of?(Array) ? "(#{value.join(', ')})" : value.to_s
-        @where_sql.try(:gsub!,"{{#{key}}}", new_text )
-        @sql_string.try(:gsub!, "{{#{key}}}", new_text)
-        @count_sql.try(:gsub!,"{{#{key}}}", new_text)
-      end
-    end
 
     # only used in testing
     def self.to_sql
@@ -174,13 +168,13 @@ module Datatable
       @records = []
     end
 
-    def instance_query
-      @records =  self.class.sql_string ? sql_instance_query : active_record_instance_query
+    def instance_query(variables={})
+      @records =  self.class.sql ? sql_instance_query(variables) : active_record_instance_query
       self
     end
 
-    def count
-      @count = self.class.sql_string ? sql_count : self.class.relation.count
+    def count(variables={})
+      @count = self.class.sql ? sql_count(variables) : self.class.relation.count
     end
 
 
@@ -195,27 +189,78 @@ module Datatable
 
     private
 
-    def sql_count
-      if self.class.count
-        count_sql = self.class.count.dup
-        if self.class.where && !@already_counted
-          count_sql << " WHERE " + self.class.where
-        end
-        @already_counted = true
+#    def sql_count
+#      if self.class.count
+#        count_sql = self.class.count.dup
+#        if self.class.where && !@already_counted
+#          count_sql << " WHERE " + self.class.where
+#        end
+#        @already_counted = true
+#      else
+#        count_sql = query_sql.sub(/^\s*SELECT(.*?)FROM/mi, 'SELECT count(*) FROM')
+#        # we don't tak the where on because it's already been done inside query_sql
+#      end
+#      ActiveRecord::Base.connection.select_value(count_sql).to_i
+#    end
+    #
+    def sql_string
+      self.class.sql ? self.class.sql.dup : nil
+    end
+
+    def where_string
+      self.class.where ? self.class.where.dup : nil
+    end
+
+    def count_string
+      self.class.count ? self.class.count.dup : nil
+    end
+
+    def sql_count(variables)
+      if count_string.blank?
+        query = query_sql.sub(/^\s*SELECT(.*?)FROM/mi, 'SELECT count(*) FROM')
       else
-        count_sql = query_sql.sub(/^\s*SELECT(.*?)FROM/mi, 'SELECT count(*) FROM')
-        # we don't tak the where on because it's already been done inside query_sql
+        if where_string.blank?
+          query = count_string
+        else
+          query = count_string + " WHERE " + where_string
+        end
       end
-      ActiveRecord::Base.connection.select_value(count_sql).to_i
+      query = substitute_variables(query.dup, variables)
+      ActiveRecord::Base.connection.select_value(query).to_i
     end
 
     def column_attributes
       self.class.columns
     end
 
-    def sql_instance_query
+    def evaluate_variable(value)
+      if value.kind_of?(Array)
+        if value.empty?
+          return "(NULL)"
+        else
+          return "(#{value.join(',')})"
+        end
+      end
+      value.to_s
+    end
+
+    def substitute_variables(template, substitutions)
+      result = template.dup
+      substitutions.stringify_keys.each do |key, value|
+        if template =~ /#{key}/m
+          result.gsub!("{{#{key}}}", evaluate_variable(value))
+        else
+          #fail "Substitution key: '#{key}' not in found in SQL text\n#{template}"
+        end
+      end
+      result
+    end
+
+    def sql_instance_query(variables)
+      query = query_sql + order_by_sql_fragment + limit_offset_sql_fragment
+      query = substitute_variables(query.dup, variables)
       connection = self.class.model ? self.class.model.connection : ActiveRecord::Base.connection
-      connection.select_rows(query_sql + order_by_sql_fragment + limit_offset_sql_fragment)
+      connection.select_rows(query)
     end
 
     def active_record_instance_query
@@ -319,7 +364,7 @@ module Datatable
     end
 
     def query_sql
-      result =  self.class.sql_string.dup
+      result =  self.class.sql.dup
       if self.class.where
         result << " WHERE " + self.class.where
         if search_string

metadata

@@ -1,50 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: datatable
-version: !ruby/object:Gem::Version 
-  hash: -3702664372
-  prerelease: 5
-  segments: 
-  - 0
-  - 1
-  - 1
-  - alpha
-  - 4
-  version: 0.1.1alpha4
+version: !ruby/object:Gem::Version
+  version: 0.2pre1
+  prerelease: 3
 platform: ruby
-authors: 
+authors:
 - Michael Greenly
 - Mischa Fierer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-18 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &12836780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  prerelease: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  requirement: *id001
+  prerelease: false
+  version_requirements: *12836780
 description: A Rails plugin for the jquery.datatables library
-email: 
+email:
 - michaelgreenly@logic-refinery.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .bundle/config
 - .gitignore
 - .rspec
@@ -63,7 +48,8 @@ files:
 - example_app/Rakefile
 - example_app/app/controllers/application_controller.rb
 - example_app/app/controllers/orders_controller.rb
-- example_app/app/datatables/orders_index.rb
+- example_app/app/datatables/example1.rb
+- example_app/app/datatables/example2.rb
 - example_app/app/helpers/application_helper.rb
 - example_app/app/models/customer.rb
 - example_app/app/models/item.rb
@@ -71,6 +57,8 @@ files:
 - example_app/app/models/order_item.rb
 - example_app/app/models/sales_rep.rb
 - example_app/app/views/layouts/application.html.erb
+- example_app/app/views/orders/example1.html.erb
+- example_app/app/views/orders/example2.html.erb
 - example_app/app/views/orders/index.html.erb
 - example_app/config.ru
 - example_app/config/application.rb
@@ -233,38 +221,26 @@ files:
 - vendor/datatable/media/js/jquery.dataTables.min.js
 homepage: https://github.com/logic-refinery/datatable
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      hash: 25
-      segments: 
-      - 1
-      - 3
-      - 1
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A Rails plugin for the jquery.datatables library
 test_files: []
-