data_tables-responder 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 843cafe60eba33bd11e4a1db95f408e29dc95df6
-  data.tar.gz: 9e52d51f84b77cea416333e8634198019c497d7c
+  metadata.gz: c9e0c1d6257f60b5b07b2e17d6dcbc1ca2fdc39c
+  data.tar.gz: 0b559fd04b9cc9fce90cf40fda777e63f6c942bc
 SHA512:
-  metadata.gz: 702847fb2fee755b7a439c959d247f7829f1bc70ba2eb24cebcca9cdccd7d6c41673b31f7edb5be44a1e53f352d133e37681ef056e71b5b8a2bf2eb9f8fb15d2
-  data.tar.gz: 007d3b0842e8fb4ce9efbd38edb81a4b96761667409bce1c7c2d5a82cc8f1204b190f45ce4c2decd9e88e4f61fe46532516aa1346fb7a0e26ad435eabf35fc04
+  metadata.gz: 7eb090ae3ef6f7968594f31b28161cbd5e527078ed53da634358eb20b1a5a9e3434a4cbe69b53bf9193a2a227bb7045f350f23b2183d717249e96dc67fbfe68c
+  data.tar.gz: 81ab0c4502f9b29b793b5ab514056622580862fe036483d8b65773734c9eff9c61e79ce5a87e4e5e93529c7273d2b2805441fb0124f1a263aae2ea48565cba14

data/data_tables-responder.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'active_model_serializers', '~> 0.10.0'
+  spec.add_dependency 'active_model_serializers', '~> 0.10.4'
   spec.add_dependency 'count_estimate'
 
   spec.add_development_dependency 'bundler', '~> 1.12'

data/lib/data_tables/active_model_serializers/adapter/meta.rb

@@ -0,0 +1,28 @@
+module ActiveModelSerializers
+  module Adapter
+    class DataTables
+
+      class Meta
+        def initialize(serializer)
+          @object = serializer.object
+          @scope = serializer.scope
+
+          # Use the return value of the block unless it is nil.
+          if serializer._meta.respond_to?(:call)
+            @value = instance_eval(&serializer._meta)
+          else
+            @value = serializer._meta
+          end
+        end
+
+        def as_json
+          @value
+        end
+
+        protected
+
+        attr_reader :object, :scope
+      end
+    end
+  end
+end

data/lib/data_tables/active_model_serializers/adapter/pagination.rb

@@ -0,0 +1,22 @@
+module DataTables
+  module ActiveModelSerializers
+    class Adapter
+      class Pagination
+
+        attr_reader :collection
+
+        def initialize(serializer)
+          @collection = serializer.object
+        end
+
+        def as_h
+          {
+            recordsTotal: collection&.total_entries&.to_i,
+            recordsFiltered: @collection&.unscope(:limit, :offset)&.count_estimate&.to_i
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/data_tables/active_model_serializers/adapter.rb

@@ -0,0 +1,43 @@
+require 'active_model_serializers'
+
+module DataTables
+  module ActiveModelSerializers
+    class Adapter < ::ActiveModelSerializers::Adapter::Json
+      extend ActiveSupport::Autoload
+      autoload :Pagination
+      autoload :Meta
+
+      def serializable_hash(options = nil)
+        options = serialization_options(options)
+
+        serialized_hash = {
+          data: ::ActiveModelSerializers::Adapter::Attributes.new(serializer, instance_options).serializable_hash(options)
+        }
+        serialized_hash[meta_key] = meta unless meta.blank?
+        serialized_hash.merge!(pagination) unless pagination.blank?
+
+        self.class.transform_key_casing!(serialized_hash, instance_options)
+      end
+
+      def meta_key
+        instance_options.fetch(:meta_key, 'meta'.freeze)
+      end
+
+      protected
+
+      def pagination
+        Pagination.new(serializer).as_h
+      end
+
+      def meta
+        {
+          sql: serializer.object.to_sql
+        }.merge(instance_options.fetch(:meta, {}))
+        # }.merge(Meta.new(@serializer))
+      end
+    end
+  end
+end
+
+# Register adapter manually (due to namespacing)
+ActiveModelSerializers::Adapter.register(:dt, DataTables::ActiveModelSerializers::Adapter)

data/lib/data_tables/active_model_serializers/register_dt_renderer.rb

@@ -0,0 +1,56 @@
+# In controllers, use `render dt: model` rather than `render json: model, adapter: :dt`.
+#
+# For example, in a controller action, we can:
+# respond_to do |format|
+#   format.dt { render dt: model }
+# end
+#
+# or
+#
+# render dt: model
+#
+# No wrapper format needed as it does not apply (i.e. no `wrap_parameters format: [dt]`)
+module DataTables
+  module ActiveModelSerializers
+    MEDIA_TYPE = 'application/json'.freeze
+    HEADERS = {
+      response: { 'CONTENT_TYPE'.freeze => MEDIA_TYPE },
+      request:  { 'ACCEPT'.freeze => MEDIA_TYPE }
+    }.freeze
+
+    def self.install
+      # actionpack/lib/action_dispatch/http/mime_types.rb
+      Mime::Type.register_alias MEDIA_TYPE, :dt, %w( text/plain text/x-json application/jsonrequest application/dt application/datatable )
+
+      # if Rails::VERSION::MAJOR >= 5
+      #   ActionDispatch::Request.parameter_parsers[:dt] = parser
+      # else
+      #   ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:dt]] = parser
+      # end
+
+      ::ActionController::Renderers.add :dt do |json, options|
+        json = serialize_dt(json, options).to_json(options) unless json.is_a?(String)
+        self.content_type ||= Mime[:dt]
+        self.response_body = json
+      end
+    end
+
+    module ControllerSupport
+      def serialize_dt(resource, options)
+        options[:adapter] = :dt
+        options.fetch(:serialization_context) do
+          options[:serialization_context] = ::ActiveModelSerializers::SerializationContext.new(request)
+        end
+        # Magic happens here
+        resource = DataTables::Responder.respond(resource, request.params)
+        get_serializer(resource, options)
+      end
+    end
+  end
+end
+
+DataTables::ActiveModelSerializers.install
+
+ActiveSupport.on_load(:action_controller) do
+  include DataTables::ActiveModelSerializers::ControllerSupport
+end

data/lib/data_tables/modules/pagination.rb

@@ -1,26 +1,20 @@
+require 'count_estimate'
+
 module DataTables
   module Modules
     class Pagination
-      MissingSerializationContextError = Class.new(KeyError)
       FIRST_PAGE = 1
 
       attr_reader :collection, :context
 
-      def initialize(collection, adapter_options)
+      def initialize(collection, request_parameters)
         @collection = collection
-        @adapter_options = adapter_options
-        @context = adapter_options.fetch(:serialization_context) do
-          fail MissingSerializationContextError, <<-EOF.freeze
-  Datatables::Pagination requires a ActiveModelSerializers::SerializationContext.
-  Please pass a ':serialization_context' option or
-  override CollectionSerializer#paginated? to return 'false'.
-           EOF
-        end
+        @request_parameters = request_parameters
       end
 
       def paginate
-        start = (request_parameters[:start] || '0').to_i
-        length = (request_parameters[:length] || '10').to_i
+        start = (@request_parameters[:start] || '0').to_i
+        length = (@request_parameters[:length] || '10').to_i
         page = (start / length) + 1
         @collection = @collection.paginate(page: page, per_page: length, total_entries: records_total)
       end
@@ -46,9 +40,6 @@ module DataTables
 
       private
 
-      def request_parameters
-        @request_parameters ||= context.request_parameters
-      end
     end
   end
 end

data/lib/data_tables/modules/search.rb

@@ -1,30 +1,22 @@
 module DataTables
   module Modules
     class Search
-      MissingSerializationContextError = Class.new(KeyError)
 
       attr_reader :collection, :context
 
-      def initialize(collection, adapter_options)
+      def initialize(collection, request_parameters)
         @collection = collection
-        @adapter_options = adapter_options
-        @context = adapter_options.fetch(:serialization_context) do
-          fail MissingSerializationContextError, <<-EOF.freeze
-  Datatables::Search requires a ActiveModelSerializers::SerializationContext.
-  Please pass a ':serialization_context' option or
-  override CollectionSerializer#searchable? to return 'false'.
-           EOF
-        end
+        @request_parameters = request_parameters
       end
 
       def search
-        default_search = request_parameters.dig(:search, :value)
+        default_search = @request_parameters.dig(:search, :value)
 
         model = @collection.try(:model) || @collection
         arel_table = model.arel_table
         columns = searchable_columns(default_search)
 
-        searches = DataTables.flat_keys_to_nested columns
+        searches = DataTables::Responder.flat_keys_to_nested columns
 
         search_by = build_search(model, searches)
 
@@ -42,11 +34,11 @@ module DataTables
             assoc = model.reflect_on_association(column)
             assoc_klass = assoc.klass
 
-            outer_join = join_type.new(assoc_klass.arel_table,
+            join = join_type.new(assoc_klass.arel_table,
               Arel::Nodes::On.new(
                 model.arel_table[assoc.foreign_key].eq(assoc_klass.arel_table[assoc.active_record_primary_key])
             ))
-            @collection = @collection.joins(outer_join)
+            @collection = @collection.joins(join)
             queries << build_search(assoc_klass, query).reduce(:and)
           else
             col_s = column.to_s
@@ -73,7 +65,7 @@ module DataTables
 
       def searchable_columns(default_search)
         @searchable_columns = {}
-        request_parameters[:columns]&.inject(@searchable_columns) do |a, b|
+        @request_parameters[:columns]&.inject(@searchable_columns) do |a, b|
           if (b[:searchable] && b[:data].present?)
             if ((value = b.dig(:search, :value).present? ? b.dig(:search, :value) : default_search).present?)
               a[b[:data]] = value
@@ -87,10 +79,6 @@ module DataTables
 
       private
 
-      def request_parameters
-        @request_parameters ||= context.request_parameters
-      end
-
     end
   end
 end

data/lib/data_tables/responder/railtie.rb

@@ -1,11 +1,17 @@
-require 'rails'
+require 'rails/railtie'
+require 'action_controller'
+require 'action_controller/railtie'
 
 module DataTables
   module Responder
     class Railtie < ::Rails::Railtie
-      initializer "data_tables.configure", after: 'active_model_serializers.prepare_serialization_context' do
-        Mime::Type.register_alias 'application/json', :dt, %w( text/plain text/x-json application/jsonrequest application/dt application/datatable )
+
+      initializer 'data_tables-responder.action_controller', after: 'active_model_serializers.action_controller' do
+        ActiveSupport.on_load(:action_controller) do
+          require 'data_tables/active_model_serializers/register_dt_renderer'
+        end
       end
+
     end
   end
 end

data/lib/data_tables/responder/version.rb

@@ -1,5 +1,5 @@
 module DataTables
   module Responder
-    VERSION = '0.2.3'
+    VERSION = '0.3.0'
   end
 end

data/lib/data_tables/responder.rb

@@ -0,0 +1,68 @@
+require "data_tables/responder/version"
+
+require 'data_tables/modules/pagination'
+require 'data_tables/modules/search'
+
+require 'data_tables/active_model_serializers/adapter'
+require 'data_tables/responder/railtie' if defined? ::Rails::Railtie
+
+module DataTables
+  module Responder
+
+    def self.respond(resource, params)
+      model = resource.try(:model) || resource
+
+      results = resource
+      hashed_orders = transmute_datatable_order(params[:order], params[:columns])
+      orders = flat_keys_to_nested hashed_orders
+
+      order_by = orders.collect do |k, order|
+        if order.is_a? Hash
+          if (klass = model.reflect_on_association(k).try(:klass))
+            results = results.joins(k)
+            klass.arel_table[order.first.first].send(order.first.last)
+          end
+        else
+          { k => order }
+        end
+      end
+
+      results = search(results, params)
+
+      # Rails.logger.warn "SEARCH BY: #{search_by}"
+      results = order_by.inject(results) { |r, o| r.order(o) }
+      results = paginate(results, params)
+    end
+
+    def self.flat_keys_to_nested(hash)
+      hash.each_with_object({}) do |(key, value), all|
+        key_parts = key.split('.').map!(&:to_sym)
+        leaf = key_parts[0...-1].inject(all) { |h, k| h[k] ||= {} }
+        leaf[key_parts.last] = value
+      end
+    end
+
+
+    def self.paginate(collection, params)
+      Modules::Pagination.new(collection, params).paginate
+    end
+
+    def self.search(collection, params)
+      Modules::Search.new(collection, params).search
+    end
+
+    def self.transmute_datatable_order(orders, columns)
+      Hash[if orders.is_a? Array
+        orders.collect do |order|
+          if (name = columns[order[:column]][:data]).present?
+            [name, order[:dir]]
+          else
+            nil
+          end
+        end
+      else
+        []
+      end.compact]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_tables-responder
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Dale Stevens
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: count_estimate
   requirement: !ruby/object:Gem::Requirement
@@ -96,11 +96,13 @@ files:
 - bin/console
 - bin/setup
 - data_tables-responder.gemspec
-- lib/data_tables-responder.rb
-- lib/data_tables/adapter.rb
+- lib/data_tables/active_model_serializers/adapter.rb
+- lib/data_tables/active_model_serializers/adapter/meta.rb
+- lib/data_tables/active_model_serializers/adapter/pagination.rb
+- lib/data_tables/active_model_serializers/register_dt_renderer.rb
 - lib/data_tables/modules/pagination.rb
 - lib/data_tables/modules/search.rb
-- lib/data_tables/monkey_patch/active_model_serializers/serialization_context.rb
+- lib/data_tables/responder.rb
 - lib/data_tables/responder/railtie.rb
 - lib/data_tables/responder/version.rb
 homepage: https://github.com/TwilightCoders/data_tables-responder

data/lib/data_tables/adapter.rb

@@ -1,100 +0,0 @@
-require 'active_model_serializers'
-require 'count_estimate'
-require 'data_tables/modules/pagination'
-require 'data_tables/modules/search'
-
-module DataTables
-  def self.flat_keys_to_nested(hash)
-    hash.each_with_object({}) do |(key, value), all|
-      key_parts = key.split('.').map!(&:to_sym)
-      leaf = key_parts[0...-1].inject(all) { |h, k| h[k] ||= {} }
-      leaf[key_parts.last] = value
-    end
-  end
-
-  class Adapter < ::ActiveModelSerializers::Adapter::Base
-
-    def serializable_hash(options)
-      options = serialization_options(options)
-      @serialization_context = options[:serialization_context]
-
-      collection = serializer.object
-
-      params = @serialization_context.request_parameters
-      model = collection.try(:model) || collection
-
-      @results = collection
-      hashed_orders = transmute_datatable_order(params[:order], params[:columns])
-      orders = DataTables.flat_keys_to_nested hashed_orders
-
-      order_by = orders.collect do |k, order|
-        if order.is_a? Hash
-          if (klass = model.reflect_on_association(k).try(:klass))
-            @results = @results.joins(k)
-            klass.arel_table[order.first.first].send(order.first.last)
-          end
-        else
-          { k => order }
-        end
-      end
-
-      @results = search(@results)
-
-      # Rails.logger.warn "SEARCH BY: #{search_by}"
-      @results = order_by.inject(@results) { |r, o| r.order(o) }
-      @results = paginate(@results)
-
-      new_serializer = serializer.class.new(@results, serializer.instance_variable_get(:@options))
-      serialized_hash = {
-        data: ::ActiveModelSerializers::Adapter::Attributes.new(new_serializer, instance_options).serializable_hash(options)
-      }
-      serialized_hash[meta_key] = meta unless meta.blank?
-      serialized_hash.merge!(@pagination.as_json) unless @pagination.blank?
-
-      self.class.transform_key_casing!(serialized_hash, instance_options)
-      # binding.pry
-    end
-
-    def reformatted_columns(params)
-      # binding.pry
-      params[:columns]
-    end
-
-    protected
-
-    def paginate(collection)
-      @pagination ||= Modules::Pagination.new(collection, instance_options)
-      collection = @pagination.paginate
-    end
-
-    def search(collection)
-      @search ||= Modules::Search.new(collection, instance_options)
-      collection = @search.search
-    end
-
-    def transmute_datatable_order(orders, columns)
-      Hash[if orders.is_a? Array
-        orders.collect do |order|
-          if (name = columns[order[:column]][:data]).present?
-            [name, order[:dir]]
-          else
-            nil
-          end
-        end
-      else
-        []
-      end.compact]
-    end
-
-    def meta
-      {
-        sql: @results.to_sql
-      }.merge(instance_options.fetch(:meta, {}))
-    end
-
-    def meta_key
-      instance_options.fetch(:meta_key, 'meta'.freeze)
-    end
-
-  end
-end

data/lib/data_tables/monkey_patch/active_model_serializers/serialization_context.rb

@@ -1,21 +0,0 @@
-require 'active_model_serializers/serialization_context'
-module ActiveModelSerializers
-  class SerializationContext
-    attr_reader :request_parameters
-
-    def initialize(*args)
-      options = args.extract_options!
-      if args.size == 1
-        request = args.pop
-        options[:request_url] = request.original_url[/\A[^?]+/]
-        options[:query_parameters] = request.query_parameters
-        options[:request_parameters] = request.request_parameters
-      end
-      @request_url = options.delete(:request_url)
-      @query_parameters = options.delete(:query_parameters)
-      @request_parameters = options.delete(:request_parameters)
-      @url_helpers = options.delete(:url_helpers) || self.class.url_helpers
-      @default_url_options = options.delete(:default_url_options) || self.class.default_url_options
-    end
-  end
-end

data/lib/data_tables-responder.rb

@@ -1,11 +0,0 @@
-require "data_tables/responder/version"
-# Monkey-patch :/
-require "data_tables/monkey_patch/active_model_serializers/serialization_context"
-
-require 'data_tables/adapter'
-require 'data_tables/responder/railtie' if defined? ::Rails::Railtie
-
-module DataTables
-  module Responder
-  end
-end