data_tables-responder 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 499aade7583b2148751f39d6004c1b3bea164620
+  data.tar.gz: 502c2d8e2aa857390f3e55c8139204d375670032
+SHA512:
+  metadata.gz: 71c654d1f58279888be4541f919e4ce8b51f1c7da354b4d4b9a04ee5eacb6be6844cd87e6857711e7b8c9a7341ba94f0cc4910afdcd57e428f40897a8878117b
+  data.tar.gz: d938cf9b87575b5d2a18dbf0dacb315e1fa7e286bf1f5cc37bbb228bbe1e0f7da89f59d653d730bd0f5d87ec3da49878b367dfeb506946558aacb449353a30df

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in data_tables-responder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dale Stevens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# DataTables::Responder
+
+DataTables Responder assists with responding, filtering, searching, paginating and formatting results from DataTable client requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data_tables-responder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install data_tables-responder
+
+## Usage
+
+```ruby
+# routes.rb
+
+resources :users do
+  post :index, constraints: { format: :dt }, on: :collection
+end
+```
+
+```ruby
+class UsersController < ApplicationController
+
+  def index
+    @users = User.all
+    respond_to do |format|
+      format.dt { render json: @users, adapter: DataTables::Adapter }
+    end
+  end
+
+  # ...
+
+end
+```
+
+## Roadmap
+
+ * Adapters for popular Search and Pagination gems
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/data_tables-responder.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "data_tables/responder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data_tables-responder.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_tables/responder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'data_tables-responder'
+  spec.version       = DataTables::Responder::VERSION
+  spec.authors       = ['Dale Stevens']
+  spec.email         = ['dale@twilightcoders.net']
+
+  spec.summary       = 'Respond to DataTable requests.'
+  spec.homepage      = "https://github.com/TwilightCoders/data_tables-responder"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  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_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/data_tables/adapter.rb

@@ -0,0 +1,99 @@
+require 'active_model_serializers'
+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/modules/pagination.rb

@@ -0,0 +1,46 @@
+module DataTables
+  module Modules
+    class Pagination
+      MissingSerializationContextError = Class.new(KeyError)
+      FIRST_PAGE = 1
+
+      attr_reader :collection, :context
+
+      def initialize(collection, adapter_options)
+        @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
+      end
+
+      def paginate
+        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)
+      end
+
+      def as_json
+        {
+          recordsTotal: @collection&.model&.count || 0,
+          recordsFiltered: @collection&.total_entries || 0
+        }
+      end
+
+      protected
+
+      attr_reader :adapter_options
+
+      private
+
+      def request_parameters
+        @request_parameters ||= context.request_parameters
+      end
+    end
+  end
+end

data/lib/data_tables/modules/search.rb

@@ -0,0 +1,84 @@
+module DataTables
+  module Modules
+    class Search
+      MissingSerializationContextError = Class.new(KeyError)
+
+      attr_reader :collection, :context
+
+      def initialize(collection, adapter_options)
+        @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
+      end
+
+      def search
+        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
+
+        or_clause = nil
+        search_by = searches.collect do |k, query|
+          if query.is_a? Hash
+            assoc = model.reflect_on_association(k)
+            assoc_klass = assoc.klass
+            assoc_arel_table = assoc_klass.arel_table
+
+            if model.respond_to? :left_outer_join
+              @collection = @collection.left_outer_join(k)
+            else
+              @collection = @collection.includes(k).references(k)
+            end
+
+            assoc_arel_table[query.first.first].matches(query.first.last)
+          else
+            if (column = model.columns.find { |c| c.name == k.to_s })
+              case column.type
+              when :string
+                model.arel_table[k].matches("%#{query}%")
+              when :integer
+                model.arel_table[k].eq(query)
+              else
+                nil
+              end
+            end
+          end
+        end.compact
+
+        @collection.where(search_by.reduce(:or))
+      end
+
+      protected
+
+      def searchable_columns(default_search)
+        @searchable_columns = {}
+        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
+            end
+          end
+          a
+        end
+
+        @searchable_columns
+      end
+
+      private
+
+      def request_parameters
+        @request_parameters ||= context.request_parameters
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+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 )
+      end
+    end
+  end
+end

data/lib/data_tables/responder/version.rb

@@ -0,0 +1,5 @@
+module DataTables
+  module Responder
+    VERSION = '0.2.1'
+  end
+end

data/lib/data_tables-responder.rb

@@ -0,0 +1,11 @@
+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

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: data_tables-responder
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Dale Stevens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- dale@twilightcoders.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data_tables-responder.gemspec
+- lib/data_tables-responder.rb
+- lib/data_tables/adapter.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/railtie.rb
+- lib/data_tables/responder/version.rb
+homepage: https://github.com/TwilightCoders/data_tables-responder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Respond to DataTable requests.
+test_files: []