trk_datatables 0.1.0

data/lib/trk_datatables/dt_params.rb

@@ -0,0 +1,156 @@
+module TrkDatatables
+  # rubocop:disable Metrics/ClassLength
+
+  # This class wraps databases format https://datatables.net/manual/server-side#Returned-data
+  #
+  # In future we can use some another datatables like
+  # https://github.com/gregnb/mui-datatables
+  # https://github.com/handsontable/handsontable
+  # https://github.com/cloudflarearchive/backgrid (archived)
+  class DtParams
+    def initialize(params)
+      @params = ActiveSupport::HashWithIndifferentAccess.new params
+    end
+
+    def dt_offset
+      @params[:start].to_i
+    end
+
+    def dt_per_page
+      return if @params[:length].blank?
+
+      @params[:length].to_i
+    end
+
+    # def page
+    #   (dt_offset / dt_per_page) + 1
+    # end
+
+    # Typecast so we can safelly use dt_order[:column_index] (Integer) and
+    # dt_order[:direction] (:asc/:desc)
+    # @return
+    #   [
+    #     { column_index: 2, direction: :asc }.
+    #     { column_index: 1, direction: :desc },
+    #   ]
+    def dt_orders
+      return @dt_orders if defined? @dt_orders
+
+      @dt_orders = []
+      return @dt_orders if @params[:order].blank?
+
+      @dt_orders = \
+        @params[:order].each_with_object([]) do |(_index, dt_order), a|
+          # for order we ignore key (index) since order is preserved
+          a << {
+            column_index: dt_order[:column].to_i,
+            direction: dt_order[:dir]&.to_s&.casecmp('ASC')&.zero? ? :asc : :desc,
+          }
+        end
+      @dt_orders
+    end
+
+    # Typecast so we can safelly use dt_column[:searchable] (Boolean),
+    # dt_column[:orderable] (Boolean), dt_column[:search_value] (String)
+    #
+    # Returned size could be different from columns size, we match key from params to
+    # insert in appropriate place, and all other values are default
+    # @return
+    #   [
+    #     { index: 0, searchable: true, orderable: true, search_value: 'dule' },
+    #   ]
+    def dt_columns
+      return @dt_columns if defined? @dt_columns
+
+      @dt_columns = []
+      return @dt_columns unless @params[:columns].respond_to? :each
+
+      @params[:columns].each.map do |(dt_position, dt_column)|
+        @dt_columns[dt_position.to_i] = {
+          index: dt_position.to_i,
+          searchable: dt_column[:searchable].to_s != 'false', # if nil as it is in set_params, than use true
+          orderable: dt_column[:orderable].to_s != 'false', # if nil as it is in set_params, than use true
+          search_value: (dt_column[:search] && dt_column[:search][:value]) || '',
+        }
+      end
+      @dt_columns.each_with_index do |dt_column, i|
+        next unless dt_column.nil?
+
+        @dt_columns[i] = {
+          index: i,
+          searchable: true,
+          orderable: true,
+          search_value: '',
+        }
+      end
+    end
+
+    def search_all
+      @params.dig(:search, :value) || ''
+    end
+
+    def as_json(all_count, filtered_items_count, data)
+      draw = @params[:draw].to_i
+      {
+        draw: draw,
+        recordsTotal: all_count,
+        recordsFiltered: filtered_items_count,
+        data: data,
+      }
+    end
+
+    def self.param_set(column_index, value)
+      { columns: { column_index.to_s => { search: { value: value } } } }
+    end
+
+    def param_get(column_index)
+      @params.dig :columns, column_index.to_s, :search, :value
+    end
+
+    def self.sample_view_params(options = {})
+      OpenStruct.new(
+        params: sample_params(options),
+      )
+    end
+
+    def self.sample_params(options = {})
+      HashWithIndifferentAccess.new(
+        draw: '1',
+        start: '0',
+        length: '10',
+        search: {
+          value: '', regex: 'false'
+        },
+        order: {
+          '0': { column: '0', dir: 'desc' }
+        },
+        # [:columns] should have the same size as column_key_options since we
+        # ignore keys, and use positions
+        columns: {
+          '0': {
+            searchable: 'true',
+            orderable: 'true',
+            search: {
+              value: '', regex: 'false'
+            }
+          },
+          '1': {
+            searchable: 'true',
+            orderable: 'true',
+            search: {
+              value: '', regex: 'false'
+            }
+          },
+          '2': {
+            searchable: 'true',
+            orderable: 'false',
+            search: {
+              value: '', regex: 'false'
+            }
+          },
+        },
+      ).merge options
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/trk_datatables/preferences.rb

@@ -0,0 +1,35 @@
+module TrkDatatables
+  module Preferences
+    # Override this to set model where you can store order, index, page length
+    # @example
+    #   def preferences_holder
+    #     @view.current_user
+    #   end
+    def preferences_holder
+      nil
+    end
+
+    # Override if you use different than :preferences
+    # You can generate with this command:
+    # @code
+    #   rails g migration add_preferences_to_users preferences:jsonb
+    def preferences_field
+      :preferences
+    end
+
+    def get_preference(key)
+      return unless preferences_holder
+
+      preferences_holder.send(preferences_field).dig :dt_preferences, self.class.name, key
+    end
+
+    def set_preference(key, value)
+      return unless preferences_holder
+
+      h = { dt_preferences: { self.class.name => { key => value } } }
+      preferences_holder.send("#{preferences_field}=", {}) if preferences_holder.send(preferences_field).nil?
+      preferences_holder.send(preferences_field).deep_merge! h
+      preferences_holder.save!
+    end
+  end
+end

data/lib/trk_datatables/render_html.rb

@@ -0,0 +1,133 @@
+module TrkDatatables
+  # rubocop:disable Rails/OutputSafety
+  class RenderHtml
+    @indent = 0
+    def initialize(search_link, datatable, html_options)
+      @search_link = search_link
+      @datatable = datatable
+      @html_options = html_options
+      self.class.indent = -1
+    end
+
+    def result
+      if @search_link.nil?
+        table_tag_client
+      else
+        table_tag_server
+      end
+    end
+
+    class << self
+      attr_accessor :indent
+    end
+
+    # https://github.com/rails/rails/blob/master/actionview/lib/action_view/helpers/output_safety_helper.rb#L33
+    def safe_join(array, sep = $,)
+      sep = ERB::Util.unwrapped_html_escape(sep)
+
+      array.map { |i| ERB::Util.unwrapped_html_escape(i) }.join(sep).html_safe
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    #
+    # _content_tag :p, 'Hi'
+    # _content_tag :p, class: 'button', 'Hi'
+    # _content_tag :div, do
+    # _content_tag :div, class: 'background' do
+    def _content_tag(tag, options = {}, content = nil)
+      if !options.is_a?(Hash)
+        inline = true
+        content = options
+        options = {}
+      elsif content.present?
+        inline = true
+      end
+      self.class.indent += 1
+      html = "#{'  ' * self.class.indent}<#{tag}".html_safe
+      options.each do |attribute, value|
+        html << " #{attribute}='".html_safe << replace_quote(value) << "'".html_safe
+      end
+      html << if inline
+                '>'.html_safe << content.to_s << "</#{tag}>\n".html_safe
+              else
+                ">\n".html_safe << yield << "\n#{'  ' * self.class.indent}</#{tag}>".html_safe
+              end
+      self.class.indent -= 1
+      html
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def _select_tag(options, search_value)
+      selected = search_value.to_s.split(MULTIPLE_OPTION_SEPARATOR)
+      _content_tag :select, multiple: 'multiple' do
+        safe_join(options.map do |key, value|
+          _content_tag :option, { value: value }.merge(selected.include?(value.to_s) ? { selected: 'selected' } : {}), key
+        end)
+      end
+    end
+
+    # We need to replace single quote since it is used in option='value'
+    def replace_quote(string)
+      # do not know those two are different
+      #  ERB::Util.html_escape string.to_s.gsub 'aaa', 'bbb'
+      #  ERB::Util.html_escape string.to_s
+      # since it is safebuffer and html_safe, this will output with single
+      # quotes for example: data-datatable-multiselect='      <select multiple='multi
+      # ERB::Util.html_escape string
+      # replace single quote with double quote
+      string.to_s.tr "'", '"'
+    end
+
+    def table_tag_server
+      _content_tag(
+        :table,
+        class: "table table-bordered table-striped #{@html_options[:class]}",
+        'data-datatable': true,
+        'data-datatable-ajax-url': @search_link,
+        'data-datatable-page-length': @datatable.dt_per_page_or_default,
+        'data-datatable-order': (@datatable.dt_orders_or_default.map do |dt_order|
+          [dt_order[:column_index], dt_order[:direction].to_s.html_safe]
+        end).to_json, # TODO: legacy, better is to use simple @datatable.dt_orders_or_default.to_json
+        'data-datatable-total-length': @datatable.all_items.count
+      ) do
+        thead << "\n".html_safe << tbody
+      end
+    end
+
+    def thead
+      _content_tag :thead do
+        _content_tag :tr do
+          safe_join(@datatable.column_key_options.map do |column_key_option|
+            options = column_key_option[:html_options]
+            search_value = @datatable.param_get(column_key_option[:column_key]) if options['data-searchable'] != false
+            options['data-datatable-search-value'] = search_value if search_value.present?
+            select_options = column_key_option[:column_options][ColumnKeyOptions::SELECT_OPTIONS]
+            options['data-datatable-multiselect'] = _select_tag select_options, search_value if select_options.present?
+            _content_tag :th, options, column_key_option[:title]
+          end)
+        end
+      end
+    end
+
+    def tbody
+      # use raw html_safe only for <td>, not for data since it could be injection
+      # hole if we show, for example some params
+      ordered_paginated_filtered_items = @datatable.order_and_paginate_items \
+        @datatable.filter_by_search_all @datatable.filter_by_columns @datatable.all_items
+      _content_tag :tbody do
+        safe_join(@datatable.rows(ordered_paginated_filtered_items).map do |row|
+          _content_tag :tr do
+            safe_join(row.map do |col|
+              _content_tag :td, col
+            end)
+          end
+        end, "\n".html_safe)
+      end
+    end
+
+    def table_tag_client
+      ''
+    end
+  end
+  # rubocop:enable Rails/OutputSafety
+end

data/lib/trk_datatables/version.rb

@@ -0,0 +1,3 @@
+module TrkDatatables
+  VERSION = '0.1.0'.freeze
+end

data/trk_datatables.gemspec

@@ -0,0 +1,53 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trk_datatables/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'trk_datatables'
+  spec.version       = TrkDatatables::VERSION
+  spec.authors       = ['Dusan Orlovic']
+  spec.email         = ['duleorlovic@gmail.com']
+
+  spec.summary       = %q(Gem that simplify using datatables with Ruby on Rails and Sinatra.)
+  spec.description   = %q(Html render first page, sort and filter...)
+  spec.homepage      = 'https://github.com/trkin/trk_datatables'
+  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'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/trkin/trk_datatables'
+    spec.metadata['changelog_uri'] = 'https://github.com/trkin/trk_datatables/CHANGELOG.md'
+    spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # for HashWithIndifferentAccess
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'activerecord', '~> 6.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-color'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'sqlite3'
+end
+# rubocop:enable Metrics/BlockLength

data/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: trk_datatables
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dusan Orlovic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Html render first page, sort and filter...
+email:
+- duleorlovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/trk_datatables.rb
+- lib/trk_datatables/active_record.rb
+- lib/trk_datatables/base.rb
+- lib/trk_datatables/column_key_options.rb
+- lib/trk_datatables/dt_params.rb
+- lib/trk_datatables/preferences.rb
+- lib/trk_datatables/render_html.rb
+- lib/trk_datatables/version.rb
+- trk_datatables.gemspec
+- yarn.lock
+homepage: https://github.com/trkin/trk_datatables
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/trkin/trk_datatables
+  source_code_uri: https://github.com/trkin/trk_datatables
+  changelog_uri: https://github.com/trkin/trk_datatables/CHANGELOG.md
+  yard.run: yri
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Gem that simplify using datatables with Ruby on Rails and Sinatra.
+test_files: []