smart_table 0.0.1

data/app/helpers/smart_table/smart_table_helper.rb

@@ -0,0 +1,211 @@
+module SmartTable
+  module SmartTableHelper
+
+    # include Kaminari helpers, like paginate
+    include Kaminari::Helpers::HelperMethods
+
+    # Renders pagination controls (centered, usually below the table). Usage:
+    #
+    #   <%= smart_table_paginate @records, @total_records_count, Record.model_name.human %>
+    #
+    # This method requires the loaded records for the current page and the total
+    # record count (sum of all pages). It also requires the listed record's human
+    # name, so it can generate a human sentence for the number of records shown.
+    #
+    # When the user clicks on one of the page size's links, a new request to the
+    # index action is made, including a page number parameter available through
+    # smart_table_params.limit and smart_table_params.offset.
+    #
+    # These values can be passed to ActiveRecord directly, e.g.:
+    #
+    #   @records = Record.
+    #     limit(smart_table_params.limit).
+    #     offset(smart_table_params.offset)
+
+    def smart_table_paginate(records, total_records_count, record_model_name)
+      raise 'smart_table_params must be called on the controller, before using smart_table_paginate helper' unless get_cached_smart_table_params
+
+      paginatable_array = Kaminari.
+        paginate_array(records, total_count: total_records_count).
+        page(get_cached_smart_table_params.page_number).
+        per(get_cached_smart_table_params.page_size)
+
+      html_elements = []
+
+      # call to Kaminari view helper
+      html_elements << paginate(paginatable_array, param_name: PAGE_PARAM, theme: "smart_table")
+
+      html_elements << content_tag(:div, class: 'text-center') do
+        # call to Kaminari view helper
+        page_entries_info(paginatable_array, entry_name: record_model_name.downcase)
+      end
+
+      html_elements.join.html_safe
+    end
+
+    SORT_ORDERS = ["asc", "desc"]
+
+    # Renders table header with sortable feature. Usage:
+    #
+    #   <th><%= smart_table_sortable("Header Text", :attribute_name) %></th>
+    #
+    # This will generate a link that will make a new request to your index page,
+    # including a sort parameter that will be available through smart_table_params.sort.
+    # You can simply pass this parameter to ActiveRecord:
+    #
+    #   @records = Record.order(smart_table_params.sort)
+
+    def smart_table_sortable(text, attribute)
+      raise 'smart_table_params must be called on the controller, before using smart_table_sortable helper' unless get_cached_smart_table_params
+
+      current_sort_state = get_cached_smart_table_params.sort
+      attribute = attribute.to_s
+
+      current_sort_attribute, current_sort_order = if current_sort_state.present?
+        current_sort_state.downcase.split
+      else
+        nil
+      end
+
+      next_sort_order = if current_sort_attribute == attribute
+        SORT_ORDERS[(SORT_ORDERS.index(current_sort_order) + 1) % SORT_ORDERS.size]
+      else
+        SORT_ORDERS.first
+      end
+
+      link_url = current_request_url_with_merged_query_params(SORT_PARAM => "#{attribute} #{next_sort_order}")
+      link_to link_url do
+        text.html_safe + ' ' + (
+          if current_sort_attribute == attribute && current_sort_order == 'asc'
+            "<span class='fa fa-sort-down'></span>".html_safe
+          elsif current_sort_attribute == attribute && current_sort_order == 'desc'
+            "<span class='fa fa-sort-up'></span>".html_safe
+          else
+            "<span class='fa fa-sort'></span>".html_safe
+          end
+        )
+      end
+    end
+
+    # Renders table page size selector (centered, usually below the table). Usage:
+    #
+    #   <%= smart_table_page_size_selector @total_records_count, Record.model_name.human %>
+    #
+    # This method requires the total number of records, so it can prune the list
+    # of available page size to only the ones that make sense for a certain
+    # number of records. It also requires the listed record's human name, so
+    # it can generate a human sentence for the number of records shown.
+    #
+    # When the user clicks on one of the page size's links, a new request to the
+    # index action is made, including a page size parameter available through
+    # smart_table_params.limit and smart_table_params.offset.
+    #
+    # These values can be passed to ActiveRecord directly, e.g.:
+    #
+    #   @records = Record.
+    #     limit(smart_table_params.limit).
+    #     offset(smart_table_params.offset)
+
+
+    def smart_table_page_size_selector(total_records_count, record_model_name)
+      raise 'smart_table_params must be called on the controller, before using smart_table_page_size_selector helper' unless get_cached_smart_table_params
+
+      page_sizes = PAGE_SIZES.dup
+      page_sizes << get_cached_smart_table_params.page_size.to_i if get_cached_smart_table_params.page_size
+      page_sizes.sort!
+
+      if page_sizes.last >= total_records_count || get_cached_smart_table_params.page_size.nil?
+        page_sizes.reject! {|size| size > total_records_count}
+        page_sizes << SHOW_ALL
+      end
+
+      content_tag(:div, class: 'text-center') do
+        (
+          record_model_name.pluralize + ' ' +
+          I18n.t('smart_table.per_page') + ': ' +
+          page_sizes.map do |page_size|
+            if page_size == get_cached_smart_table_params.page_size
+              page_size.to_s
+            else
+              human_page_size = (page_size == SHOW_ALL ? I18n.t('smart_table.show_all') : page_size.to_s)
+              link_to human_page_size, current_request_url_with_merged_query_params(PAGE_SIZE_PARAM => page_size)
+            end
+          end.join(' ')
+        ).html_safe
+      end
+    end
+
+    # Renders search field (right-aligned, usually above the table). Usage:
+    #
+    #   <div>
+    #     <%= smart_table_search %>
+    #   </div>
+    #
+    #   <table class='table'>
+    #     <thead>
+    #       ...
+    #
+    # When the user types something on the search field and focuses out (or
+    # presses ENTER), a new request is made to the index action, including a
+    # search parameter available through smart_table_params.search.
+    #
+    # You are responsible for using the search parameter to build a query in your
+    # own way e.g.:
+    #
+    #   @records = Record.
+    #     where(
+    #       'column1 LIKE ? OR column2 LIKE ?',
+    #       *Array.new(2, "%#{ActiveRecord::Base.sanitize_sql_like(smart_table_params.search)}%")
+    #     )
+
+    def smart_table_search
+      raise 'smart_table_params must be called on the controller, before using smart_table_search helper' unless get_cached_smart_table_params
+
+      text_field_tag(
+        SEARCH_PARAM,
+        get_cached_smart_table_params.search,
+        type: 'search', placeholder: I18n.t('smart_table.search'), class: 'smart_table_search', id: 'smart_table_search'
+      )
+    end
+
+    # Creates section for extra table filters. Usage:
+    #
+    # <%= smart_table_extra_filters do %>
+    #   <%= check_box_tag 'somekey', 'value', params['somekey'] %>
+    #   <%= select_tag "credit_card", options_for_select({"VISA" => 'visa', "MasterCard" => 'master_card'}, params['credit_card']) %>
+    #   <%= text_field_tag "somefield", params['somefield'] %>
+    #   <%= radio_button_tag("category", "", !params["category"].present?) %>
+    #   <%= radio_button_tag("category", "rails", params["category"] == 'rails') %>
+    #   <%= radio_button_tag("category", "java", params["category"] == 'java') %>
+    # <% end %>
+    #
+    # Everytime the user changes any of the fields inside this section, the page
+    # will be refreshed and the field value will be included to the request params.
+    #
+    # You are responsible for using the parameters by yourself when loading the
+    # records.
+
+    def smart_table_extra_filters(&block)
+      raise 'smart_table_params must be called on the controller, before using smart_table_extra_filters helper' unless get_cached_smart_table_params
+
+      content = capture(&block)
+      content_tag(:div,
+        content,
+        id: 'smart_table_extra_filters',
+        class: 'smart_table_extra_filters'
+      )
+    end
+
+  private
+
+    # generates url merging parameters to the current url
+    def current_request_url_with_merged_query_params(params)
+      request_url = URI::parse(request.url)
+      link_query_params = URI::decode_www_form(request_url.query || '').to_h.merge(params.stringify_keys)
+      link_url = request_url.dup
+      link_url.query = URI::encode_www_form(link_query_params)
+      link_url.to_s
+    end
+
+  end
+end

data/app/views/kaminari/smart_table/_first_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link to the "First" page
+  - available local variables
+    url:           url to the first page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+
+<% unless current_page.first? %>
+  <%= link_to t('views.pagination.first').html_safe, url, class: 'first', :remote => remote %>
+<% end %>

data/app/views/kaminari/smart_table/_gap.html.erb

@@ -0,0 +1,8 @@
+<%# Non-link tag that stands for skipped pages...
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<span class="page gap"><%= t('views.pagination.truncate').html_safe %></span>

data/app/views/kaminari/smart_table/_last_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link to the "Last" page
+  - available local variables
+    url:           url to the last page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+
+<% unless current_page.last? %>
+  <%= link_to t('views.pagination.last').html_safe, url, class: 'last', :remote => remote %>
+<% end %>

data/app/views/kaminari/smart_table/_next_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link to the "Next" page
+  - available local variables
+    url:           url to the next page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+
+<% unless current_page.last? %>
+  <%= link_to t('views.pagination.next').html_safe, url, class: 'next', :rel => 'next', :remote => remote %>
+<% end %>

data/app/views/kaminari/smart_table/_page.html.erb

@@ -0,0 +1,10 @@
+<%# Link showing page number
+  - available local variables
+    page:          a page object for "this" page
+    url:           url to this page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+<%= link_to page, url, {:remote => remote, class: "page#{ ' current' if page.current? }", :rel => page.next? ? 'next' : page.prev? ? 'prev' : nil} %>

data/app/views/kaminari/smart_table/_paginator.html.erb

@@ -0,0 +1,25 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+<%= paginator.render do -%>
+  <div class="text-center">
+    <ul class="pagination">
+      <%= first_page_tag unless current_page.first? || total_pages <= 2 %>
+      <%= prev_page_tag unless current_page.first? %>
+      <% each_page do |page| -%>
+          <% if page.left_outer? || page.right_outer? || page.inside_window? -%>
+            <%= page_tag page %>
+        <% elsif !page.was_truncated? -%>
+            <%= gap_tag %>
+        <% end -%>
+      <% end -%>
+      <%= next_page_tag unless current_page.last? %>
+      <%= last_page_tag unless current_page.last? || total_pages <= 2 %>
+    </ul>
+  </div>
+<% end -%>

data/app/views/kaminari/smart_table/_prev_page.html.erb

@@ -0,0 +1,12 @@
+<%# Link to the "Previous" page
+  - available local variables
+    url:           url to the previous page
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+-%>
+
+<% unless current_page.first? %>
+  <%= link_to t('views.pagination.previous').html_safe, url, class: 'prev', rel: 'prev', :remote => remote %>
+<% end %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "solvis_auth"
+
+# 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(__FILE__)

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/config/locales/smart_table.en.yml

@@ -0,0 +1,25 @@
+en:
+  views:
+    # Kaminari translations
+    pagination:
+      first: "« First"
+      last: "Last »"
+      previous: "‹ Prev"
+      next: "Next ›"
+      truncate: "…"
+  helpers:
+    # Kaminari translations
+    page_entries_info:
+      one_page:
+        display_entries:
+          zero: "No %{entry_name} found"
+          one: "Displaying <b>1</b> %{entry_name}"
+          other: "Displaying <b>all %{count}</b> %{entry_name}"
+      more_pages:
+        display_entries: "Displaying %{entry_name} <b>%{first}&nbsp;-&nbsp;%{last}</b> of <b>%{total}</b> in total"
+
+  # smart_table gem's specific translations
+  smart_table:
+    per_page: "per page"
+    show_all: "All"
+    search: "Search"

data/config/locales/smart_table.pt.yml

@@ -0,0 +1,25 @@
+pt:
+  views:
+    # Kaminari translations
+    pagination:
+      first: "« Primeira"
+      last: "Última »"
+      previous: "‹ Anterior"
+      next: "Próxima ›"
+      truncate: "…"
+  helpers:
+    # Kaminari translations
+    page_entries_info:
+      one_page:
+        display_entries:
+          zero: "Sem %{entry_name} para exibir"
+          one: "Mostrando <b>1</b> %{entry_name}"
+          other: "Mostrando <b>todos %{count}</b> %{entry_name}"
+      more_pages:
+        display_entries: "Mostrando %{entry_name} <b>%{first}&nbsp;-&nbsp;%{last}</b> de <b>%{total}</b> no total"
+
+  # smart_table gem's specific translations
+  smart_table:
+    per_page: "por página"
+    show_all: "Tudo"
+    search: "Buscar"

data/lib/generators/init_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+# Generates gem initializer
+#
+#   rails g smart_table:init
+#
+
+module SmartTable
+  class InitGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_initializer
+      copy_file 'smart_table_initializer.rb', 'config/initializers/smart_table.rb'
+    end
+  end
+end

data/lib/generators/templates/smart_table_initializer.rb

@@ -0,0 +1,6 @@
+
+# Check existing configs on lib/solvis_auth/config.rb
+
+SmartTable.setup do |config|
+
+end

data/lib/smart_table/config.rb

@@ -0,0 +1,15 @@
+module SmartTable
+  class Config
+    DEFAULT_CONFIGS = {
+
+    }
+
+    DEFAULT_CONFIGS.each do |config_name, default_value|
+      # defines accessors for each configuration on Config class
+      self.cattr_accessor config_name, instance_accessor: false
+      # initializes default value
+      self.send(config_name.to_s + '=', default_value)
+    end
+
+  end
+end

data/lib/smart_table/engine.rb

@@ -0,0 +1,21 @@
+
+module SmartTable
+
+  class Engine < ::Rails::Engine
+
+    # This makes models, controllers and routes defined on this gem to be all
+    # scoped under SmartTable::
+    # Ref: http://edgeguides.rubyonrails.org/engines.html
+    isolate_namespace SmartTable
+
+    # This automatically includes smart_table methods on all controllers
+    initializer 'smart_table.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        include SmartTable::SmartTableConcern
+        helper SmartTable::SmartTableHelper
+      end
+    end
+
+  end
+
+end

data/lib/smart_table/version.rb

@@ -0,0 +1,3 @@
+module SmartTable
+  VERSION = "0.0.1"
+end

data/lib/smart_table.rb

@@ -0,0 +1,28 @@
+require 'rails'
+require 'kaminari'
+
+require 'smart_table/engine' if defined?(Rails::Engine)
+
+require 'smart_table/version'
+require 'smart_table/config'
+require 'generators/init_generator'
+
+
+module SmartTable
+
+  # Method called on the gem initializer
+  def self.setup
+    if block_given?
+      yield Config
+    end
+  end
+
+  # Constants
+  SORT_PARAM = :st_sort
+  PAGE_PARAM = :st_page
+  PAGE_SIZE_PARAM = :st_page_size
+  SEARCH_PARAM = :st_search
+  SHOW_ALL = 'show_all'
+  PAGE_SIZES = [10,50,200]
+
+end

data/smart_table.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_table"
+  spec.version       = SmartTable::VERSION
+  spec.authors       = ["Henrique Gubert"]
+  spec.email         = ["guberthenrique@hotmail.com"]
+
+  spec.summary       = %q{Implements tables with pagination and search for Rails,
+    with server-side content loading.}
+  spec.description   = %q{}
+
+  spec.files         = Dir[File.dirname(__FILE__) + '/**/*'].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"]
+
+  # this gem should be used in a rails app
+  spec.add_runtime_dependency 'rails', '<5.3.0', '>4.2.0'
+  spec.add_runtime_dependency 'kaminari', '~> 0'
+  spec.add_runtime_dependency 'font-awesome-rails', '~> 0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rspec-rails', '~> 3.7'
+  spec.add_development_dependency 'sqlite3', '~> 0'
+  spec.add_development_dependency "byebug", '~> 9'
+end

data/spec/dummy_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy_app/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/spec/dummy_app/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy_app/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy_app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy_app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy_app/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy_app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy_app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy_app/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>DummyApp</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy_app/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy_app/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy_app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')