mongoid-data_table 1.0.2 → 1.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongoid-data_table (1.0.1)
+    mongoid-data_table (1.0.3)
       rails (~> 3.0.0)
       will_paginate (~> 3.0.pre2)
 
@@ -35,7 +35,7 @@ GEM
       activemodel (= 3.0.7)
       activesupport (= 3.0.7)
     activesupport (3.0.7)
-    arel (2.0.9)
+    arel (2.0.10)
     bson (1.3.1)
     bson_ext (1.3.1)
     builder (2.1.2)
@@ -81,7 +81,7 @@ GEM
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
       rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.0)
+    rspec-core (2.6.1)
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)

data/README.rdoc

@@ -1,40 +1,91 @@
-= Data Table
+= Mongoid: Data Table
 
-Makes it easy to ship data to a jQuery DataTable from ActiveRecord or Mongoid.
+Makes it easy to ship data to a jQuery DataTable from Mongoid.
 
 == Quick example:
 
-in your javascript:
+=== Javascript
 
-  $(".providers-data-table").dataTable({"bJQueryUI"       : true,
-                                        "bProcessing"     : true,
-                                        "bAutoWidth"      : false,
-                                        "sPaginationType" : "full_numbers",
-                                        "aoColumns"       : [{"sType" : "html"}, null, null, null, null],
-                                        "aaSorting"       : [[0, 'asc'], [1, 'asc']],
-                                        "bServerSide"     : true,
-                                        "sAjaxSource"     : "/providers.json" }).fnSetFilteringDelay();
+  $(".providers-data-table").dataTable({
+    "bJQueryUI"       : true,
+    "bProcessing"     : true,
+    "bAutoWidth"      : false,
+    "sPaginationType" : "full_numbers",
+    "aoColumns"       : [{"sType" : "html"}, null, null, null, null],
+    "aaSorting"       : [[0, 'asc'], [1, 'asc']],
+    "bServerSide"     : true,
+    "sAjaxSource"     : "/providers.json"
+  }).fnSetFilteringDelay();
 
-Note: the fnSetFilteringDelay() call isn't required but highly recommended: http://datatables.net/plug-ins/api#fnSetFilteringDelay
+*Note:* the fnSetFilteringDelay() call isn't required but highly recommended: http://datatables.net/plug-ins/api#fnSetFilteringDelay
 
-in your controller:
+=== Model
+
+  class Provider
+
+    include Mongoid::Documenta
+    include Mongoid::DataTable
+
+    ## fields ##
+    field :name
+    field :fein
+    field :country
+    field :state
+
+    ## associations ##
+    referenced_in :category
+
+    ## data_table ##
+    data_table_options.merge!({
+      :fields => %w(name fein category country state),
+      :searchable => %w(name fein),
+      :dataset => lambda do |provider|
+        {
+          0 => "<%= link_to(provider.name, provider) %>",
+          1 => provider.fein,
+          2 => provider.category.name,
+          3 => provider.country,
+          4 => provider.state,
+          :DT_RowId => provider._id
+        }
+      end
+    })
+
+  end
+
+=== Controller (InheritedResources::Base)
+
+*Recommended:* https://github.com/josevalim/inherited_resources
+
+  class PrividersController < InheritedResources::Base
+
+    respond_to :json, :only => :index
+
+    protected
+
+    def collection
+      @providers ||= end_of_association_chain.to_data_table(self)
+    end
+
+  end
+
+=== Controller (ActionController::Base)
 
   class ProvidersController < ApplicationController
 
     def index
-      respond_to do |wants|
-        wants.html
-        wants.json do
-          render(:json => Provider.for_data_table(self, %w(name fein categories.name county state), %w(name fein)) do |provider|
-            ["<%= link_to(provider, provider) %>", provider.fein, provider.category.name, provider.county, provider.state]
-          end)
+      respond_to do |format|
+        format.html
+        format.json do
+          render :json => Provider.to_data_table(self)
         end
       end
     end
 
   end
 
-in your view (assuming HAML):
+
+=== View (HAML)
 
   %table.providers-data-table
     %thead
@@ -51,4 +102,4 @@ Patches welcome, enjoy!
 
 == Copyright
 
-Copyright (c) 2010 Jason Dew. See LICENSE for details.
+Copyright (c) 2010-2011 Jason Dew, Andrew Bennett. See LICENSE for details.

data/lib/mongoid/data_table/criteria.rb

@@ -0,0 +1,31 @@
+module Mongoid
+  module DataTable
+    module Criteria
+      # do nothing
+    end
+  end
+
+  class Criteria
+
+    # Used for chaining +Criteria+ scopes together in the for of class methods
+    # on the +Document+ the criteria is for.
+    #
+    # Options:
+    #
+    # name: The name of the class method on the +Document+ to chain.
+    # args: The arguments passed to the method.
+    # block: Optional block to pass
+    #
+    # Returns: <tt>Criteria</tt>
+    def method_missing(name, *args, &block)
+      if @klass.respond_to?(name)
+        @klass.send(:with_scope, self) do
+          @klass.send(name, *args, &block)
+        end
+      else
+        return entries.send(name, *args)
+      end
+    end
+
+  end
+end

data/lib/mongoid/data_table/proxy.rb

@@ -8,9 +8,9 @@ module Mongoid
         @klass      = klass
         @controller = controller
         @options    = klass.data_table_options.merge(options)
-        @extension  = block
+        @extension  = block || klass.data_table_dataset || default_data_table_dataset
 
-        @params   = options[:params]   || controller.params.dup
+        @params   = options[:params]   || (controller.params.dup rescue {})
         @criteria = options[:criteria] || klass.criteria
         @unscoped = options[:unscoped] || klass.unscoped
         @fields   = options[:fields]   || klass.data_table_fields
@@ -44,7 +44,7 @@ module Mongoid
       end
 
       def to_hash(&inline_block)
-        inline_block = extension || default_data_table_block unless block_given?
+        inline_block = extension unless block_given?
         {
           :sEcho => params[:sEcho].to_i,
           :iTotalRecords => unscoped.count,
@@ -60,8 +60,12 @@ module Mongoid
         }
       end
 
-      def to_json(*args)
-        to_hash.to_json
+      def as_json(options = nil, &inline_block)
+        to_hash(&inline_block).to_json(options)
+      end
+
+      def to_json(*args, &inline_block)
+        as_json(*args, &inline_block)
       end
 
       protected
@@ -105,7 +109,7 @@ module Mongoid
 
       private
 
-      def default_data_table_block
+      def default_data_table_dataset
         lambda do |object|
           Hash[aliases.map { |c| [ aliases.index(c), object.send(c) ] }].merge(:DT_RowId => object._id)
         end

data/lib/mongoid/data_table/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module DataTable
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/lib/mongoid/data_table.rb

@@ -6,8 +6,10 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/class/inheritable_attributes'
 require 'active_support/concern'
 
+require 'mongoid/criteria'
 require 'mongoid/relations/proxy'
 
+require 'mongoid/data_table/criteria'
 require 'mongoid/data_table/proxy'
 require 'mongoid/data_table/version'
 
@@ -35,6 +37,10 @@ module Mongoid
         self.data_table_options[:sortable] ||= self.data_table_fields
       end
 
+      def data_table_dataset
+        self.data_table_options[:dataset]
+      end
+
       def to_data_table(controller, options = {}, &block)
         ::Mongoid::DataTable::Proxy.new(self, controller, options, &block)
       end

data/spec/models/category.rb

@@ -0,0 +1,11 @@
+class Category
+
+  include Mongoid::Document
+
+  ## fields ##
+  field :name
+
+  ## associations ##
+  references_many :providers
+
+end

data/spec/models/provider.rb

@@ -0,0 +1,31 @@
+class Provider
+
+  include Mongoid::Document
+  include Mongoid::DataTable
+
+  ## fields ##
+  field :name
+  field :fein
+  field :country
+  field :state
+
+  ## associations ##
+  referenced_in :category
+
+  ## data_table ##
+  data_table_options.merge!({
+    :fields => %w(name fein category country state),
+    :searchable => %w(name fein),
+    :dataset => lambda do |provider|
+      {
+        0 => "<%= link_to(provider.name, '#') %>",
+        1 => provider.fein,
+        2 => provider.category.name,
+        3 => provider.country,
+        4 => provider.state,
+        :DT_RowId => provider._id
+      }
+    end
+  })
+
+end

data/spec/unit/mongoid/data_table/criteria_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Mongoid::DataTable::Criteria do
+
+  before do
+    Rails.stubs(:logger).returns(LOGGER)
+  end
+
+  let(:controller) do
+    Class.new(ActionController::Base).new.tap do |c|
+      c.stubs(:params).returns({})
+    end
+  end
+
+  let(:custom_array) { %w(custom) }
+
+  let(:custom_block) do
+    lambda { |object| custom_array }
+  end
+
+  context "with custom block" do
+
+    let(:bob) do
+      Person.find_or_create_by(:name => 'Bob')
+    end
+
+    let(:dt) do
+      bob
+      Person.criteria.to_data_table(controller, {}, &custom_block)
+    end
+
+    it "should store it as an @extension" do
+      dt.extension.should == custom_block
+    end
+
+    describe "#to_hash" do
+
+      it "should run the custom block" do
+        dt.to_hash[:aaData].first.should == custom_array
+      end
+
+      context "with inline block" do
+
+        it "should run the inline block" do
+          a = custom_array.push('inline')
+          h = dt.to_hash { |object| a }
+          h[:aaData].first.should == a
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/mongoid/data_table/proxy_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Mongoid::DataTable::Proxy do
 
-  let(:controller) do
+  let!(:controller) do
     Class.new(ActionController::Base).new.tap do |c|
       c.stubs(:params).returns({})
     end

data/spec/unit/mongoid-data_table_spec.rb

@@ -1,2 +1,74 @@
 require 'spec_helper'
 
+describe 'mongoid-data_table' do
+
+  let(:category) do
+    Category.find_or_create_by(:name => 'my_category')
+  end
+
+  let(:provider) do
+    Provider.find_or_create_by({
+      :name => 'my_name',
+      :fein => 'my_fein',
+      :country => 'my_country',
+      :state => 'my_state',
+      :category_id => category.id
+    })
+  end
+
+  before do
+    Rails.stubs(:logger).returns(LOGGER)
+  end
+
+  let(:controller) do
+    Class.new(ActionController::Base).new.tap do |c|
+      c.stubs(:params).returns({})
+    end
+  end
+
+  context "when using example from README" do
+
+    def sample_data(id)
+      {
+        "sEcho" => 0,
+        "iTotalRecords" => 1,
+        "iTotalDisplayRecords" => 1,
+        "aaData" => [{
+          "0" => "<a href=\"#\">my_name</a>",
+          "1" => "my_fein",
+          "2" => "my_category",
+          "3" => "my_country",
+          "4" => "my_state",
+          "DT_RowId" => id.to_s
+        }]
+      }
+    end
+
+    it "should return sample data" do
+      provider.category.should == category
+      JSON.load(Provider.where(:name => 'my_name').to_data_table(controller).to_json).should == sample_data(provider.id)
+    end
+
+    context "with inline block" do
+
+      def custom_sample_data(id)
+      {
+        "sEcho" => 0,
+        "iTotalRecords" => 1,
+        "iTotalDisplayRecords" => 1,
+        "aaData" => [[id.to_s]]
+      }
+    end
+
+      it "should return sample data" do
+        provider.category.should == category
+        JSON.load(Provider.where(:name => 'my_name').to_data_table(controller).to_json do |provider|
+          [ provider.id ]
+        end).should == custom_sample_data(provider.id)
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: mongoid-data_table
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Jason Dew
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 Z
+date: 2011-05-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -120,16 +120,19 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- TODO
 - lib/mongoid-data_table.rb
 - lib/mongoid/data_table.rb
+- lib/mongoid/data_table/criteria.rb
 - lib/mongoid/data_table/proxy.rb
 - lib/mongoid/data_table/version.rb
 - mongoid-data_table.gemspec
+- spec/models/category.rb
 - spec/models/person.rb
+- spec/models/provider.rb
 - spec/models/user_agent.rb
 - spec/spec_helper.rb
 - spec/unit/mongoid-data_table_spec.rb
+- spec/unit/mongoid/data_table/criteria_spec.rb
 - spec/unit/mongoid/data_table/proxy_spec.rb
 - spec/unit/mongoid/data_table_spec.rb
 homepage: http://rubygems.org/gems/mongoid-data_table
@@ -160,10 +163,13 @@ signing_key:
 specification_version: 3
 summary: Simple data preparation from Mongoid to the jQuery DataTables plugin
 test_files: 
+- spec/models/category.rb
 - spec/models/person.rb
+- spec/models/provider.rb
 - spec/models/user_agent.rb
 - spec/spec_helper.rb
 - spec/unit/mongoid-data_table_spec.rb
+- spec/unit/mongoid/data_table/criteria_spec.rb
 - spec/unit/mongoid/data_table/proxy_spec.rb
 - spec/unit/mongoid/data_table_spec.rb
 has_rdoc: 

data/TODO

@@ -1 +0,0 @@
-- repackage as a Rails 3 responder