datatablesnet 1.0

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.DS_Store
+*.log
+nbproject

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'rake', '< 0.9'
+
+gemspec

data/datatablesnet.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "datatablesnet/version"
+
+Gem::Specification.new do |s|
+  s.name        = "datatablesnet"
+  s.version     = Datatablesnet::VERSION
+  s.platform    = Gem::Platform::RUBY  
+  s.summary     = "Datatables.net component for rails"
+  s.email       = "mfields106@gmail.com"
+  s.homepage    = "https://github.com/IslandPort/datatablesnet"
+  s.description = "Component abstraction for datatables.net"
+  s.authors     = ['Matt Fields']
+
+
+  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/lib/datatablesnet/_table.html.haml

@@ -0,0 +1,43 @@
+-options = config[:options]
+
+:javascript
+  $(document).ready(function(){
+    $('##{table_id}').dataTable(#{config[:table_options].to_json});
+    if(#{options[:toolbar].present? or options[:toolbar_external]}){
+      $('div.toolbar').html($('##{table_id}_toolbar').html());
+    }
+    if(#{options[:width].present?}){
+      $('##{table_id}_wrapper').css('width', '#{options[:width].to_s}');
+    }
+  });
+
+-if options[:toolbar].present?
+  %div{:id => table_id + "_toolbar", :style => "display:none"}
+    - options[:toolbar].each do |toolbar_item|
+      .toolbarItem
+        -if toolbar_item[:url]
+          =link_to toolbar_item[:text], toolbar_item[:url] , :class=>"btn"
+        -else
+          =toolbar_item[:text]
+
+%table.display{:id => table_id, :style => "#{options[:width].present? ? 'width:' + options[:width].to_s : 'width:100%!important'}"}
+  %thead
+    - columns.each do |column|
+      %th= column[:label]
+    - if options[:show_actions].to_b
+      %th Actions
+    - if options[:server_side].to_b
+      %th
+  %tbody
+    - unless options[:data_url].present?
+      - rows.each do |row|
+        %tr
+          - columns.each do |column|
+            %td
+              =datatable_get_column_data(row,column)
+          - if options[:show_actions] == 'true'
+            %td
+              .tableAction= link_to 'Show', row
+              .tableAction= link_to 'Edit', send("edit_#{row.class.to_s.demodulize.underscore}_path",row)
+              .tableAction= link_to 'Destroy', row, :confirm => 'Are you sure?', :method => :delete
+

data/lib/datatablesnet/datatable.rb

@@ -0,0 +1,310 @@
+require 'datatablesnet/types'
+
+module Datatable
+
+  class UrlHelper
+    include Rails.application.routes.url_helpers
+    #default_url_options[:routing_type] = :path
+
+    def url_for(options = {})
+      options ||= {}
+      url = case options
+      when String
+        super
+      when Hash
+        super
+      when :back
+        super
+      else
+        polymorphic_path(options)
+      end
+
+      url
+    end
+  end
+
+  #Options
+  # :sort_by
+  # :additional_data
+  # :search
+  # :search_label
+  # :processing
+  # :persist_state
+  # :per_page
+  # :no_records_message
+  # :auto_width
+  # :row_callback
+  # :show_actions
+  #Column Options
+  # :name
+  # :label
+  # :render
+  # :format
+
+  module_function
+
+  def template_path
+    path = File.expand_path('..', __FILE__)
+    $:.unshift(path)
+    path
+  end
+
+  def datatable_tag id, columns = [], rows = nil, options = {}
+    options_map = {:sort_by => "aaSorting",
+                   :search => "bFilter",
+                   :search_label => "sSearch",
+                   :processing => "bProcessing",
+                   :persist_state => "bSaveState",
+                   :per_page => "iDisplayLength",
+                   :no_records_message => "sZeroRecords",
+                   :auto_width => "bAutoWidth",
+                   :dom => "sDom",
+                   :data_url => "sAjaxSource",
+                   :server_side => "bServerSide",
+                   :auto_scroll => "bScrollInfinite",
+                   :pagination_type => "sPaginationType",
+                   :paginate => "bPaginate",
+                   :save_state => "bStateSave"
+                   }
+
+
+    options =
+      {
+        :show_actions       => true,
+        :per_page           => 25,
+        :toolbar_external   => false
+      }.merge(options)
+
+    index = 0
+    columns.each do |column|
+      column[:label] = field_to_label(column[:field]) unless column[:label].present?
+      if options[:data_url].present?
+        options[:data_url] << "?" if column == columns.first
+        options[:data_url] << "column_field_#{index.to_s}=#{column[:field]}"
+        if column[:view_link].present?
+          options[:data_url] << "&column_view_link_#{index.to_s}=#{column[:view_link]}"
+        end
+        options[:data_url] << "&" unless column == columns.last
+      end
+      index += 1
+    end
+
+    if options[:toolbar].present? or options[:toolbar_external]
+      options[:dom]='<"toolbar">lfrtip'
+    end
+
+    table_options = {}
+    options_map.each do |k,v|
+      if options[k].present?
+        table_options[v] = options[k]
+      end
+    end
+
+    table_options["aoColumns"] = datatable_get_column_defs(options,columns)
+
+    config = {:options => options, :columns =>columns, :table_options => table_options}
+    config.to_json
+    render :file => template_path + "/_table", :locals => { :table_id => id, :columns => columns, :rows => rows, :config => config}
+  end
+
+  def datatable_get_column_defs options, columns
+    column_defs = []
+    column_options_map = {:width => "sWidth",
+                          :sortable => "bSortable",
+                          :searchable => "bSearchable",
+                          :class => "sClass"}
+
+
+    column_index =0
+    columns.each do |column|
+      column_options = {}
+      column_options_map.each do |k,v|
+        if column[k].present?
+          column_options[v] = column[k]
+        end
+      end
+      column_options["fnRender"] = NoEscape.new(options[:render]) if column[:render].present?
+      column_options["fnRender"] = NoEscape.new("function (obj) {return #{column[:format]}(obj.aData[#{column_index}])}") if column[:format].present?
+      if column[:view_link].present? and options[:server_side]
+        column_options["fnRender"] = NoEscape.new("function (obj) {return '<a href = ' + obj.aData[#{columns.length}]['urls']['#{column[:field]}'] + '>' + obj.aData[#{column_index}] + '</a>'}")
+      end
+
+      unless column_options.empty?
+        column_defs << column_options
+      else
+        column_defs << nil
+      end
+      column_index+=1
+    end
+
+    if options[:show_actions]
+      column_defs << nil
+    end
+
+    if options[:server_side]
+      column_defs << {"bVisible" => false}
+    end
+
+    return column_defs
+  end
+
+  def get_field_data obj, field
+    attrs = field.split('.')
+    attrs.each do |attr|
+      if obj
+        obj = obj.send attr
+      else
+        return ""
+      end
+    end
+    return obj
+  end
+
+  def datatable_get_column_data row, column
+    obj = get_field_data(row, column[:field])
+
+    if column[:view_link].present?
+      if column[:view_link] == "."
+        return link_to(obj, row)
+      else
+        return link_to(obj, row.send(column[:view_link]))
+      end
+    else
+      return obj
+    end
+  end
+
+  def field_to_label(field)
+    label = field.gsub(/[_.]/, " ")
+    label.to_s.gsub(/\b\w/){$&.upcase}
+  end
+
+  def parse_params params
+    grid_options = {}
+    columns = []
+    order_by = {}
+    filter_by = {}
+    (0..params[:iColumns].to_i-2).each do |index|
+      column = {}
+      column[:field] = params["column_field_#{index}"]
+      column[:searchable] = params["bSearchable_#{index}"].to_b
+      column[:sortable] = params["bSortable_#{index}"].to_b
+      column[:index] = index
+      if params["column_view_link_#{index}"].present?
+        column[:view_link] = params["column_view_link_#{index}"]
+      end
+      columns << column
+      if params["iSortCol_#{index}"].present?
+        order_column_index = params["iSortCol_#{index}"]
+        order_column = params["column_field_#{order_column_index}"]
+        order_column_order = params["sSortDir_#{index}"] || "DESC"
+        order_by[order_column] = order_column_order
+      end
+      if params["sSearch_#{index}"].present?
+        filter_by[column[:field]] = params["sSearch_#{index}"]
+      end
+    end
+
+    grid_options[:columns] = columns
+    grid_options[:order_by] = order_by
+    grid_options[:filter_by] = filter_by
+    grid_options[:page] = (params[:iDisplayStart].to_i/params[:iDisplayLength].to_i rescue 0)+1
+    grid_options[:per_page] = params[:iDisplayLength]
+    if params["sSearch"].present?
+      grid_options[:search] = params["sSearch"]
+    end
+
+    grid_options
+  end
+
+
+  def find(klass, params={}, options = {})
+    field_filter_where = {}
+    all_filter_where = {}
+
+    grid_options = parse_params params
+
+
+    options[:page] = grid_options[:page]
+    options[:per_page] = grid_options[:per_page]
+
+    # Build order by
+    grid_options[:order_by].each do |column, order|
+      if options[:order].present?
+        options[:order] << ", "
+      else
+        options[:order] = ""
+      end
+      options[:order] << "#{column} #{order}"
+    end
+
+    # Build filter by
+    grid_options[:filter_by].each do |column, value|
+      field_filter_where[column] = value
+    end
+
+    # Search all searchable columns
+    if grid_options[:search].present?
+      grid_options[:columns].each do |column|
+        if column[:searchable].to_b
+          all_filter_where[column[:field]] = grid_options[:search]
+        end
+      end
+    end
+
+    if !field_filter_where.empty? or !all_filter_where.empty?
+      options[:conditions] = [field_filter_where.sql_like, all_filter_where.sql_or.sql_like].sql_and.sql_where
+    end
+
+    puts options[:conditions]
+
+    rows = klass.paginate options
+
+    objects = []
+    rows.each do |row|
+      object = []
+      grid_options[:columns].each do |column|
+        object << get_field_data(row, column[:field])
+      end
+
+      meta = build_row_meta row, grid_options
+      object << meta
+      objects << object
+    end
+
+    total_records = klass.count
+    if options[:conditions].present?
+      klass.count(:conditions => options[:conditions])
+    else
+      total_display_records = total_records
+    end
+    json_data = {:sEcho => params[:sEcho],
+                 :iTotalRecords =>  total_records,
+                 :iTotalDisplayRecords => total_display_records,
+                 :aaData => objects
+    }
+    return json_data
+  end
+
+
+  def build_row_meta row, grid_options
+    url_helper = UrlHelper.new
+    meta={}
+    meta[:urls] = {}
+    grid_options[:columns].each do |column|
+      if column[:view_link].present?
+        view_link = column[:view_link]
+        if view_link == "."
+          url = url_helper.url_for(row)
+        else
+          url = url_helper.url_for(row.send(view_link))
+        end
+        meta[:urls][column[:field]] = url
+      end
+    end
+    return meta
+  end
+
+end
+
+

data/lib/datatablesnet/hash_sql.rb

@@ -0,0 +1,85 @@
+
+
+module HashSql
+
+  def self.included(klass)
+    klass.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    attr_accessor :sql_operator
+    attr_accessor :sql_comparator
+
+    def sql_where
+      if self.instance_of?(Hash)
+        build_where
+      else
+        combine_wheres
+      end
+    end
+
+    def sql_and
+      self.sql_operator = "and"
+      return self
+    end
+
+    def sql_or
+      self.sql_operator = "or"
+      return self
+    end
+
+    def sql_like
+      self.sql_comparator = "like"
+      return self
+    end
+
+
+    private
+
+     def build_where
+        values = []
+        where_string = ""
+        self.each do |name, value|
+          if where_string != ""
+            where_string << " #{sql_operator ? sql_operator : 'and'} "
+          end
+
+          if self.sql_comparator = "like"
+            where_string <<  "#{name} LIKE ?"
+            values << '%' + value + '%'
+          else
+            where_string <<  "#{name} = ?"
+            values << value
+          end
+        end
+        where = [where_string] + values
+        return where
+      end
+
+      def combine_wheres
+        values = []
+        where_string = ""
+        self.each do |where_hash|
+          unless where_hash.empty?
+            where = where_hash.sql_where
+            if where_string != ""
+              where_string << " and "
+            end
+
+            where_string << "(#{where[0]})"
+
+            values += where[1..-1]
+          end
+        end
+
+        [where_string] + values
+      end
+  end
+end
+
+[Array, Hash].each do |klass|
+  klass.class_eval do
+    include HashSql
+  end
+end

data/lib/datatablesnet/railtie.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Datatablesnet
+  # @private
+  class Railtie < Rails::Railtie
+    initializer 'datatablesnet.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include Datatable
+      end
+    end
+  end
+end

data/lib/datatablesnet/types.rb

@@ -0,0 +1,34 @@
+
+class NoEscape
+  def as_json(options = nil) self end #:nodoc:
+  def encode_json(encoder) to_s end #:nodoc:
+
+  def initialize text
+    @text = text
+  end
+
+  def to_s
+    @text
+  end
+end
+
+
+module ToBoolean
+  def self.included(klass)
+    klass.send :include, InstanceMethods
+  end
+
+
+  module InstanceMethods
+    def to_b
+      string = self
+      return true if string == true || string =~ (/(true|t|yes|y|1)$/i)
+      return false if string == false || string.nil? || string =~ (/(false|f|no|n|0)$/i)
+      raise ArgumentError.new("invalid value for Boolean: \"#{string}\"")
+    end
+  end
+end
+
+Object.class_eval do
+  include ToBoolean
+end

data/lib/datatablesnet/version.rb

@@ -0,0 +1,3 @@
+module Datatablesnet
+  VERSION = "1.0"
+end

data/lib/datatablesnet.rb

@@ -0,0 +1,10 @@
+require 'datatablesnet/railtie' if defined?(::Rails)
+
+module Datatablesnet
+  extend ActiveSupport::Autoload
+
+  autoload :Datatable
+  autoload :HashSql
+  autoload :NoEscape
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: datatablesnet
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Matt Fields
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-30 00:00:00 Z
+dependencies: []
+
+description: Component abstraction for datatables.net
+email: mfields106@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- datatablesnet.gemspec
+- lib/datatablesnet.rb
+- lib/datatablesnet/_table.html.haml
+- lib/datatablesnet/datatable.rb
+- lib/datatablesnet/hash_sql.rb
+- lib/datatablesnet/railtie.rb
+- lib/datatablesnet/types.rb
+- lib/datatablesnet/version.rb
+homepage: https://github.com/IslandPort/datatablesnet
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Datatables.net component for rails
+test_files: []
+