rails-tables 0.4.4 → 0.5.0

data/README.md

@@ -12,7 +12,7 @@ A clean jQuery datatables DSL
 [jqd-railscast]: http://railscasts.com/episodes/340-datatables (Episode #340: Datatables)
 [squeel]: https://github.com/ernie/squeel (Squeel: ActiveRecord 3, improved)
 
-Version: 0.4.4
+Version: 0.5.0
 
 Please refer to the [RailsTables Wiki][wiki] for:
 

data/app/tables/column.rb

@@ -1,6 +1,7 @@
 class Column
 
-  attr_accessor :model, :name, :method, :column_source, :render_with, :sortable, :searchable, :blank_value
+  attr_accessor :model, :name, :method, :column_source, :render_with, :blank_value, :virtual, :sortable, :searchable
+
   def initialize(model, name, *args)
     self.model = model
     self.name = name.to_s
@@ -8,18 +9,19 @@ class Column
     attributes = args.pop || {}
     self.method = attributes.fetch(:method, name).to_s
     self.column_source = attributes.fetch(:column_source, '').to_s
+
+    virtual = (self.column_source.blank? and not self.model.column_names.include? self.method)
+    self.virtual = attributes.fetch(:virtual, virtual)
+    self.sortable = attributes.fetch(:sortable, !self.virtual)
+    self.searchable = attributes.fetch(:searchable, !self.virtual)
+
+    raise Exception, "Virtual columns are required to supply a render method (render_with: lambda): Column #{self.name}, Model: #{self.model.name}" if virtual and not attributes.has_key?(:render_with)
     self.render_with = attributes.fetch(:render_with, :default_render)
-    self.sortable = attributes.fetch(:sortable, true)
-    self.searchable = attributes.fetch(:searchable, true)
     self.blank_value = attributes.fetch(:blank_value, '–')
 
     define_singleton_method :render do |view, object|
-      related = object
-      self.column_source.split('.').each do |relation|
-        related = related.try(:send, relation)
-      end
       if self.render_with.kind_of? Symbol
-        content = self.send(self.render_with, view, related)
+        content = self.send(self.render_with, view, follow_source(object))
       else
         content = self.render_with.call(view, object)
       end
@@ -27,6 +29,16 @@ class Column
     end
   end
 
+private
+
+  def follow_source(object)
+    related = object
+    self.column_source.split('.').each do |relation|
+      related = related.try(:send, relation)
+    end
+    related
+  end
+
   def default_render(view, object)
     property = object.try(:send, self.method)
     property if not property.nil?

data/app/tables/datatable.rb

@@ -1,26 +1,17 @@
 class Datatable
+  include Datatable::Sorting
+  include Datatable::Searching
   delegate :params, to: 'self.view'
 
-attr_accessor :name, :model
+  attr_accessor :name, :model, :view, :scopes
+
+  # Called in has_datatable for model
   def initialize(name, model)
     self.name = name
     self.model = model
   end
 
-class_attribute :source
-  def self.source_path=(source)
-    self.source = Rails.application.routes.url_helpers.send(source, format: "json")
-  end
-
-class_attribute :initial_orderings
-  def self.initial_ordering(orderings)
-    self.set_initial_orderings orderings
-  end
-  def self.set_initial_orderings(orderings)
-    self.initial_orderings = {} if self.initial_orderings.nil?
-    self.initial_orderings.merge! orderings
-  end
-
+  # Render data attributes for table for view
   def html_data
     options = {}
     if self.class.source?
@@ -35,7 +26,7 @@ class_attribute :initial_orderings
     options
   end
 
-attr_accessor :view, :scopes
+  # Pass in view and scope table for controller
   def render_with(view, *args)
     arguments = args.pop || {}
     self.view = view
@@ -43,6 +34,7 @@ attr_accessor :view, :scopes
     return self
   end
 
+  # Format this table for controller's response
   def as_json(options={})
     {
       sEcho: params[:sEcho].to_i,
@@ -52,47 +44,46 @@ attr_accessor :view, :scopes
     }
   end
 
-class_attribute :columns, :column_factory
+  class_attribute :source, :source_factory
+  # Set source url for this table
+  def self.source_path=(source)
+    self.source_factory = source
+  end
+  def self.source
+    @source ||= Rails.application.routes.url_helpers.send(self.source_factory, format: "json")
+  end
+
+  class_attribute :columns, :column_factory
+  # Allow user defined columns, lazily instanciate later after 'self.model' is defined
   def self.column(name, *args)
     arguments = args.pop || {}
     self.column_factory = [] if self.column_factory.nil?
     self.column_factory << { name: name, args: arguments }
   end
+  # Lazily instanciates and caches columns
   def columns
     @columns ||= self.column_factory.map{ |new_column| Column.new(self.model, new_column[:name], new_column[:args]) }
   end
 
-class_attribute :joins
-self.joins = []
+  class_attribute :joins
+  self.joins = []
+  # Allow user to explicitly join tables (not sure of use case)
   def self.join(join)
     self.joins += [join.to_s]
   end
-attr_accessor :joins
+  # Deduce joins based on columns and explicitly joined tables 
   def joins
-    @joins ||= (self.columns.map(&:column_source).reject(&:blank?) + self.class.joins).uniq 
-  end
-
-class_attribute :searches
-self.searches = []
-  def self.search_on(column_source, methods)
-    Array(methods).each do |method|
-      join column_source
-      self.searches += [{column_source: column_source.to_s, method: method.to_s}]
-    end
-  end
-attr_accessor :searches
-  def searches
-    @searches ||= (
-      self.columns.select(&:searchable).select{|c| c.column_source.present?}.map{|c| {column_source: c.column_source, method: c.method} } + self.class.searches).uniq
+    @joins ||= (self.columns.reject(&:virtual).map(&:column_source).reject(&:blank?) + self.class.joins).uniq 
   end
 
 private
 
+  # Compose query to fetch objects from database
   def objects
     query = self.model.uniq
     self.joins.each do |join|
-      query = query.joins{ join.split('.').inject(self, :__send__).outer }
-      query = query.includes{ join.split('.').inject(self, :__send__).outer }
+      query = query.joins{ join.split('.').inject((join.present? ? self : nil), :__send__).outer }
+      query = query.includes{ join.split('.').inject((join.present? ? self : nil), :__send__).outer }
     end
     if sortable
       sort_expression = sort
@@ -107,25 +98,8 @@ private
     end
     query = query.paginate(page: page, per_page: per_page)
   end
-  
-  def sortable
-    self.columns.map{ |column| column.sortable }[params[:iSortCol_0].to_i] unless params[:bUseDefaultSort] == 'true'
-  end
-  def sort
-    column = self.columns[params[:iSortCol_0].to_i]
-    direction = params[:sSortDir_0] == "asc" ? 1 : -1
-    Squeel::Nodes::KeyPath.new(column.column_source.split('.') << Squeel::Nodes::Order.new(column.method, direction))
-  end
-
-  def search(terms)
-    terms = terms.split if terms.is_a? String
-    self.searches.map do |search|
-      terms.map do |word|
-        Squeel::Nodes::KeyPath.new(search[:column_source].split('.') << Squeel::Nodes::Stub.new(search[:method])) =~ "%#{word}%"
-      end.compact.inject(&:|)
-    end.compact.inject(&:|)
-  end
 
+  # Pagination doesn't merit it's own module.
   def page
     params[:iDisplayStart].to_i/per_page + 1
   end
@@ -133,6 +107,7 @@ private
     params[:iDisplayLength].to_i > 0 ? params[:iDisplayLength].to_i : 10
   end
 
+  # Generate HTML for each row
   def data
     objects.map do |object|
       self.columns.map{ |column| column.render(self.view, object) }

data/app/tables/datatable/searching.rb

@@ -0,0 +1,38 @@
+module Datatable::Searching
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :searches
+    self.searches = []
+    extend ClassMethods
+    include InstanceMethods
+  end
+
+  module ClassMethods
+    # Allow user defined fields to sort on in addition to introspected fields
+    def search_on(column_source, methods)
+      Array(methods).each do |method|
+        join column_source
+        self.searches += [{column_source: column_source.to_s, method: method.to_s}]
+      end
+    end
+  end
+
+  module InstanceMethods
+  private
+    # Introspect available searches as well as user defined ones
+    def searches
+      @searches ||= (self.columns.select(&:searchable).select{|c| c.column_source.present?}.map{|c| {column_source: c.column_source, method: c.method} } + self.class.searches).uniq
+    end
+    # Build Squeel Stubs for search
+    def search(terms)
+      terms = terms.split if terms.is_a? String
+      self.searches.map do |search|
+        terms.map do |word|
+          Squeel::Nodes::KeyPath.new(search[:column_source].split('.') << Squeel::Nodes::Stub.new(search[:method])) =~ "%#{word}%"
+        end.compact.inject(&:|)
+      end.compact.inject(&:|)
+    end
+  end
+
+end

data/app/tables/datatable/sorting.rb

@@ -0,0 +1,38 @@
+module Datatable::Sorting
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :initial_orderings
+    extend ClassMethods
+    include InstanceMethods
+  end
+
+  module ClassMethods
+    # Gotta set these to fight against datatables' default ordering on first column
+    def initial_ordering(orderings)
+      self.set_initial_orderings orderings
+    end
+    def set_initial_orderings(orderings)
+      self.initial_orderings = {} if self.initial_orderings.nil?
+      self.initial_orderings.merge! orderings
+    end
+
+  end
+
+  module InstanceMethods
+  private
+    # Check if table is sortable
+    def sortable
+      self.columns.map{ |column| column.sortable }[params[:iSortCol_0].to_i] unless params[:bUseDefaultSort] == 'true'
+    end
+    # Find column to search by and create a Squeel Order
+    def sort
+      column = self.columns[params[:iSortCol_0].to_i]
+      if column.sortable
+        direction = params[:sSortDir_0] == "asc" ? 1 : -1
+        Squeel::Nodes::KeyPath.new(column.column_source.split('.') << Squeel::Nodes::Order.new(column.method, direction))
+      end
+    end
+  end
+
+end

data/lib/rails-tables/version.rb

@@ -1,3 +1,3 @@
 module RailsTables
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-tables
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -117,6 +117,8 @@ extra_rdoc_files: []
 files:
 - app/assets/javascripts/rails-tables.js.coffee
 - app/tables/column.rb
+- app/tables/datatable/searching.rb
+- app/tables/datatable/sorting.rb
 - app/tables/datatable.rb
 - config/routes.rb
 - lib/rails-tables/engine.rb