ajax-datatables-rails-alt-api 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cce225c4b7705f45eac8c0f0142d898dd35addd7aed1c647b0bd9cbcd2f88fc8
-  data.tar.gz: 6fca93efddb6ae77ef8db63accca3865ab721f11aa215937a5a48d0146774dbc
+  metadata.gz: a6522d9b2e6ae68225c8473af907a91fc026bbf0c16ba3a39f12beaa01cb1ed2
+  data.tar.gz: ea4a1ac52a37dd2af6ecc4e3ecd8236c0f6797bbe6d03a9c892497726de74a68
 SHA512:
-  metadata.gz: ce6b635f8c50f38341179f7f37322ef312942b10ca178615c391677488810467abc9024c512d43a9bef3ea91a8f706df8fb6e71c3d6ed43ffead2e88110fa3f0
-  data.tar.gz: efb2089258523718e2e3f4f0b6e556e8294bbb0cac0815646bc75c65b11285cb497092b54d19392108f86972ffdae56018aeb75cbd717b853f020046cc90c4e4
+  metadata.gz: d5f7b57f278fbb6af63483bdbb6cf167df7577707bd317e88ba3658b73da45821b8ba992515c5565b6fe5914a9ece00d6acd33b8735e62aa833fc45824bed957
+  data.tar.gz: f6cfd7ebaf80da820d37ebf4a2e159791bf4ac6b7b45904eb6ae6a2ec731192fe4f3360eaac3044b2a2238c39abd77a7bb2eee9ec162bad7f8335d1611086e28

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.1.3
+
+* Fixing huge memory leak and performance
+
 ## 0.1.1
 
 * Fixing broken homepage link

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ajax-datatables-rails-alt-api (0.1.1)
+    ajax-datatables-rails-alt-api (0.1.3)
       ajax-datatables-rails (~> 1.0.0)
 
 GEM

data/README.md

@@ -1,8 +1,8 @@
 # AjaxDatatablesRails::AltApi
 
-This is an alternative API to the `ajax-datatables-rails gem`. The motivation for this was that we had a lot of datatables written agains an older version of ajax-datatables-rails. The newer version of ajax-datatables-rails was incompatible with our older implementation of datatables, so it required a major refactor effort. There were certain things in the recent ajax-datatables-rails API felt redundant, and if a major refactor was needed, a reimagined API started to be devloped.
+This is an alternative API to the [ajax-datatables-rails](https://github.com/jbox-web/ajax-datatables-rails) gem. The motivation for this was that we had a lot of datatables written against an older version of ajax-datatables-rails. The newer version of ajax-datatables-rails was incompatible with our older implementation of datatables, so it required a major refactor effort. There were certain things in the recent ajax-datatables-rails API felt redundant, and if a major refactor was needed, a reimagined API started to be developed.
 
-This uses ajax-datatables-rails under the hood. Idealy, this or something similar may influence future versions of ajax-datatables-rails.
+This uses ajax-datatables-rails under the hood. Ideally, this or something similar may influence future versions of ajax-datatables-rails.
 
 ## Features
 
@@ -13,7 +13,7 @@ There are some additional features this API provides.
 * Columns are defined once, with the goal of reducing redundancy.
 * Debugging mismatch problems with jQuery datatables can be frustrating. There is some code to help debug these tricky situations. There are still many improvements that can be done with this, but it is a start.
 
-## Usage
+## Basic Usage
 
 Inside your application datatable or the individual datatables, include the module.
 
@@ -57,6 +57,48 @@ class UserDatatable < ApplicationDatatable
 end
 ```
 
+### Front-end usage
+
+Newer versions of jQuery Datatables expects the columns to be defined when the table is initialized. This gem generates that info based on the definition in the datatable.
+
+```Ruby
+# users_controller.rb
+class UsersController < ApplicationController
+  def index
+    @users_datatable = UserDatatable.new(params, view_context: view_context)
+
+    respond_to do |fmt|
+      fmt.html
+      fmt.json do
+        render json: @customer_datatable
+      end
+    end
+  end
+end
+```
+
+```ERB
+// users/index.html.erb
+
+<table id="users-datatable"
+       data-ajax-url=""
+       data-datatable-columns=<%= @users_datatable.js_columns %>>
+  <th>Name</th>
+  <th>Company</th>
+  <th>Address</th>
+  <th>Last updated</th>
+  <th>links</th>
+</table>
+
+<script>
+  $table = $('#users-datatable');
+  $table.DataTable({
+    ajax: $table.data('ajax-url'),
+    columns: $table.data('datatable-columns')
+  })
+</script>
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ajax-datatables-rails/alt-api/datatable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'ajax-datatables-rails/alt-api/datatable/column_def'
+require 'ajax-datatables-rails/alt-api/datatable/row_context'
 require 'ajax-datatables-rails/alt-api/datatable/view_columns'
 
 module AjaxDatatablesRails
@@ -117,33 +118,15 @@ module AjaxDatatablesRails
         raise NotImplementedError if columns.empty?
 
         records_with_error_logging.map do |record|
-          @current_record = record
-          delegate_to_view_and_record(record)
+          row_context = RowContext.new(@view, record)
 
           columns.each_with_object({}) do |col, row|
-            row[col.attr_name] = col.render(record)
+            row[col.attr_name] = col.render(row_context)
             row
           end
         end
       end
 
-      def delegate_to_view_and_record(record) # rubocop:disable Lint/MethodLength,Lint/UnusedMethodArgument
-        singleton_class.class_eval do
-          def method_missing(meth, *args)
-            if record.respond_to?(meth)
-              record.send(meth, *args)
-            elsif view.respond_to?(meth)
-              view.send(meth, *args)
-            else
-              super
-            end
-          end
-
-          def respond_to_missing?(meth, _include_all)
-            record.respond_to?(meth) || view.respond_to?(meth) || super
-          end
-        end
-      end
 
       # There are some hard to debug scenarios that come up with ajax-datatables-rails.
       # This helps debug some problems. Usually the bug is caused by some mismatched
@@ -152,7 +135,7 @@ module AjaxDatatablesRails
         @records ||= records
       rescue NoMethodError => e
         if e.name == :fetch && e.receiver.nil?
-          Rails.logger.error "#{self.class.name} column problem. view_columns: #{view_columns.pretty_inspect}"
+          Rails.logger.error String.new("#{self.class.name} column problem. view_columns: #{view_columns.pretty_inspect}")
         end
         raise e
       end

data/lib/ajax-datatables-rails/alt-api/datatable/column_def.rb

@@ -61,14 +61,16 @@ module AjaxDatatablesRails
           visible && condition_met?
         end
 
-        def render(record) # rubocop:disable Metrics/AbcSize
+        def render(row_context) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
           return unless render?
 
+          record = row_context.record
+
           if cell_renderer
             if cell_renderer.arity == 1
-              datatable.instance_exec(record, &cell_renderer)
+              row_context.instance_exec(record, &cell_renderer)
             else
-              datatable.instance_exec(&cell_renderer)
+              row_context.instance_exec(&cell_renderer)
             end
           elsif record.respond_to?(attr_name)
             record.send(attr_name)

data/lib/ajax-datatables-rails/alt-api/datatable/row_context.rb

@@ -0,0 +1,31 @@
+module AjaxDatatablesRails
+  module AltApi
+    module Datatable
+      # This is used by the column.cell_renderer and seamlessly
+      # delegates to the view or the record
+      class RowContext
+        attr_reader :view, :record
+
+        def initialize(view, record)
+          @view = view
+          @record = record
+        end
+
+        # This allows seamless delegation to @current_record or @view
+        def method_missing(meth, *args)
+          if @record.respond_to?(meth)
+            @record.send(meth, *args)
+          elsif @view.respond_to?(meth)
+            @view.send(meth, *args)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(meth, _include_all)
+          @record.respond_to?(meth) || @view.respond_to?(meth) || super
+        end
+      end
+    end
+  end
+end

data/lib/ajax-datatables-rails/alt-api/datatable/view_columns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AjaxDatatablesRails
   module AltApi
     module Datatable

data/lib/ajax-datatables-rails/alt-api/version.rb

@@ -1,5 +1,5 @@
 module AjaxDatatablesRails
   module AltApi
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ajax-datatables-rails-alt-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Sean McCleary
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ajax-datatables-rails
@@ -117,6 +117,7 @@ files:
 - bin/setup
 - lib/ajax-datatables-rails/alt-api/datatable.rb
 - lib/ajax-datatables-rails/alt-api/datatable/column_def.rb
+- lib/ajax-datatables-rails/alt-api/datatable/row_context.rb
 - lib/ajax-datatables-rails/alt-api/datatable/view_columns.rb
 - lib/ajax-datatables-rails/alt-api/version.rb
 - lib/ajax-datatables-rails/alt_api.rb