rolemodel_tables 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4ee2f9c219c3b794961065e8e2ad79bd6de362fc4bbc9c7f7ca5fe76f5231c9
-  data.tar.gz: bc7c188b7a7b666089a6e0a6a0076d1d47e37be70fd6ce870b4b03842db47070
+  metadata.gz: 6f1a42253a5583547dba681eda52f60b16127b513500d0ae4b05257e5dbd6945
+  data.tar.gz: 0b8b0c4ffe45ff940cde6041013b2b2fafb39e440cfd3294ca8648a5096961c6
 SHA512:
-  metadata.gz: 98bce5a12bf187e90d38e1e4fedbbfca5a23dd5f4fa6d46c57baa23e323d21fb94483cae90b348941037343c12956a47cee506a37808f9a4a3bb6abba3abf4e9
-  data.tar.gz: 8bd04a2300f93ea63de60772fed8ff6e21949786ab49a95ab2cf0f095dcd5deef7fe578183e43cad9374c35102dc392f537f3037315a19339dc9373ed085438a
+  metadata.gz: 06556643aff1a83c64d7c9e443009a2e0c835d6d6921331dfd5c0c29cbbc473f3744129a616964f08f59ddd454d9d8c8d98f358e0d508376bd55c9c16c99f9ba
+  data.tar.gz: b040bfe87341bda6a691467f5b582d4b16b149b503d0bad845e90cf0295c64cd39214af49c6b7cf503e5450fe9e6d73c31a5a49d84c7777996348bb72ab59f65

data/app/javascript/controllers/advanced_table_search_controller.js

@@ -0,0 +1,53 @@
+const { Controller } = require("@hotwired/stimulus")
+
+class AdvancedTableSearchController extends Controller {
+  static values = {
+    advancedLabel: String,
+  }
+
+  static targets = [
+    'showSearchHiddenInput',
+    'toggleButton',
+    'controlsContainer',
+    'keywordSearchButton',
+    'toggleableArea',
+  ]
+
+  connect() {
+    /* global window */
+    // Did the user initiate a search via the form? If so, reveal the form
+    // on page load. The form is initially hidden.
+    const searchParams = new URLSearchParams(window.location.search)
+    if (searchParams.get('show_advanced_search') === 'true') {
+      this.toggle()
+    }
+  }
+
+  toggle() {
+    this.toggleableAreaTarget.classList.toggle('hidden')
+
+    this.keywordSearchButtonTarget.classList.toggle('hidden')
+
+    const text = this.toggleableAreaTarget.classList.contains('hidden') ? 'Show' : 'Hide'
+    this.toggleButtonTarget.innerText = `${text} ${this.advancedLabelValue}`
+
+    const advancedSearchState = this.toggleableAreaTarget.classList.contains('hidden') ? 'false' : 'true'
+    this.showSearchHiddenInputTarget.value = advancedSearchState
+
+    const searchParams = new URLSearchParams(window.location.search)
+    searchParams.set('show_advanced_search', advancedSearchState)
+    const newRelativePathQuery = this._newRelativePathQuery(searchParams)
+    window.history.pushState(null, '', newRelativePathQuery)
+  }
+
+  clear() {
+    const searchParams = new URLSearchParams({ show_advanced_search: 'true' })
+    window.location = this._newRelativePathQuery(searchParams)
+  }
+
+  _newRelativePathQuery(searchParams) {
+    return `${window.location.pathname}?${searchParams.toString()}`
+  }
+}
+
+export default AdvancedTableSearchController

data/app/views/kaminari/_first_page.html.slim

@@ -0,0 +1,10 @@
+/ 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
+
+span
+  = link_to_unless current_page.first?, icon('first_page'), url, remote: remote, class: 'btn btn--outline btn--small'

data/app/views/kaminari/_gap.html.slim

@@ -0,0 +1,9 @@
+/ 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
+  .btn.btn--small.pagination__gap = t('views.pagination.truncate').html_safe

data/app/views/kaminari/_last_page.html.slim

@@ -0,0 +1,10 @@
+/ 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
+
+span
+  = link_to_unless current_page.last?, icon('last_page'), url, remote: remote, class: 'btn btn--outline btn--small'

data/app/views/kaminari/_next_page.html.slim

@@ -0,0 +1,10 @@
+/ 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
+
+span
+  = link_to_unless current_page.last?, icon('chevron_right'), url, rel: 'next', remote: remote, class: 'btn btn--outline btn--small'

data/app/views/kaminari/_page.html.slim

@@ -0,0 +1,14 @@
+/ 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
+
+span.page
+  - if page.current?
+    .btn.btn--small.pagination__current = page
+  - else
+    = link_to page, url, remote: remote, rel: page.rel, class: 'btn btn--small btn--outline'

data/app/views/kaminari/_paginator.html.slim

@@ -0,0 +1,20 @@
+/ 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
+  nav.pagination role="navigation" aria-label="pager"
+    == first_page_tag unless current_page.first?
+    == prev_page_tag unless current_page.first?
+    - each_page do |page|
+      - if page.display_tag?
+        == page_tag page
+      - elsif !page.was_truncated?
+        == gap_tag
+    - unless current_page.out_of_range?
+      == next_page_tag unless current_page.last?
+      == last_page_tag unless current_page.last?

data/app/views/kaminari/_prev_page.html.slim

@@ -0,0 +1,10 @@
+/ 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
+
+span
+  = link_to_unless current_page.first?, icon('chevron_left'), url, rel: 'prev', remote: remote, class: 'btn btn--outline btn--small'

data/app/views/rolemodel_tables/_advanced_search_controls.html.slim

@@ -0,0 +1,21 @@
+.margin-y-md data-controller='advanced-table-search submit-on-select' data-advanced-table-search-advanced-label-value='Advanced Filters'
+  = search_form_for filter_view.ransack, url: request.path, html: { class: 'simple_form' , data: { 'submit-on-select-target' => 'form' }} do |f|
+    = hidden_field_tag :show_advanced_search, params.fetch(:show_advanced_search, false), data: { 'advanced-table-search-target': 'showSearchHiddenInput' }
+
+    .card.margin-bottom-md data-advanced-table-search-target='controlsContainer'
+      .flex.items-center.gap-sm
+        / TODO: INLINE STYLES BAD
+        .flex.items-center.gap-sm style='width: 300px'
+          = f.search_field filter_view.quick_search, placeholder: 'Keyword', class: 'form__input'
+          = f.button :search, class: 'btn btn--primary', data: { 'advanced-table-search-target': 'keywordSearchButton' }
+
+        button.project-search-toggle data-advanced-table-search-target='toggleButton' type='button' data-action='click->advanced-table-search#toggle' Show Advanced Filters
+
+      .margin-top-md.hidden data-advanced-table-search-target='toggleableArea'
+        .flex.flex-wrap
+          - filter_view.advanced_filters.each do |filter|
+            = filter.form_row(f).html_safe
+
+        .flex.justify-end.items-center.gap-sm.margin-top-md
+          button.btn.btn--outline type='button' data-action='click->advanced-table-search#clear' Clear
+          = f.button :search, class: 'btn btn--primary'

data/lib/rolemodel_tables/engine.rb

@@ -0,0 +1,4 @@
+module RoleModelTables
+  class Engine < Rails::Engine
+  end
+end

data/lib/rolemodel_tables/models/filter_view.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  # Parent class for all filter views.
+  class FilterView
+    class_attribute :default_sort, :quick_search, :advanced_filters
+    attr_reader :ransack
+
+    def initialize(scoped_collection)
+      @scoped_collection = scoped_collection
+    end
+
+    def self.default_sort(sort_option)
+      self.default_sort = sort_option
+    end
+
+    def self.quick_search(ransack_matcher)
+      self.quick_search = ransack_matcher
+    end
+
+    def self.advanced_filter(ransack_matcher, klass_name, form_options = {})
+      self.advanced_filters ||= {}
+      self.advanced_filters[ransack_matcher] = "RoleModelTables::Filters::#{klass_name}".constantize.new(ransack_matcher, form_options)
+    end
+
+    def advanced_filters
+      self.class.advanced_filters.map do |_, filter_instance|
+        filter_instance.filter = self
+        filter_instance
+      end
+    end
+
+    def search(params)
+      @ransack = @scoped_collection.ransack(params[:query])
+      @ransack.sorts = default_sort if @ransack.sorts.empty?
+      @ransack.result.page(params[:page])
+    end
+  end
+end

data/lib/rolemodel_tables/models/filters/collection_filter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  module Filters
+    # Handle collection dropdowns.
+    class CollectionFilter < RansackFilter
+      def form_row(form)
+        content_tag(:div, class: 'form__group') do
+          [
+            label(form),
+            collection_select(form)
+          ].join(' ').html_safe
+        end
+      end
+
+      private
+
+      def collection_select(form)
+        form.collection_select(
+          ransack_matcher,
+          form_options.fetch(:collection, -> { [] }).call(filter),
+          form_options.fetch(:option_value, ''),
+          form_options.fetch(:option_label, ''),
+          { include_blank: 'Any' },
+          { class: 'form__dropdown' }
+        )
+      end
+    end
+  end
+end

data/lib/rolemodel_tables/models/filters/date_filter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  module Filters
+    # Handles a single date field filter.
+    class DateFilter < RansackFilter
+      def form_row(form)
+        content_tag(:div, class: 'form__group') do
+          [
+            label(form),
+            date_field(form)
+          ].join(' ').html_safe
+        end
+      end
+
+      private
+
+      def date_field(form)
+        form.date_field(ransack_matcher, { class: 'form__input' })
+      end
+    end
+  end
+end

data/lib/rolemodel_tables/models/filters/date_range_filter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  module Filters
+    # Handles a date range filter.
+    class DateRangeFilter < RansackFilter
+      def form_row(form)
+        content_tag(:div, class: 'form__group') do
+          [
+            label(form),
+            content_tag(:div, class: 'flex items-center gap-sm') do
+              [
+                date_field(form, :gteq),
+                content_tag(:span, '-'),
+                date_field(form, :lteq)
+              ].join(' ').html_safe
+            end
+          ].join(' ').html_safe
+        end
+      end
+
+      private
+
+      def date_field(form, predicate)
+        form.date_field("#{ransack_matcher}_#{predicate}", { class: 'form__input' })
+      end
+    end
+  end
+end

data/lib/rolemodel_tables/models/filters/number_range_filter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  module Filters
+    # Handles a number range filter.
+    class NumberRangeFilter < RansackFilter
+      def form_row(form)
+        content_tag(:div, class: 'form__group') do
+          [
+            label(form),
+            content_tag(:div, class: 'flex items-center gap-sm') do
+              [
+                search_field(form, :gteq),
+                content_tag(:span, '-'),
+                search_field(form, :lteq)
+              ].join(' ').html_safe
+            end
+          ].join(' ').html_safe
+        end
+      end
+
+      private
+
+      def search_field(form, predicate)
+        form.search_field(
+          "#{ransack_matcher}_#{predicate}",
+          class: 'form__input',
+          placeholder: form_options.fetch(:range_begin_placeholder, '')
+        )
+      end
+    end
+  end
+end

data/lib/rolemodel_tables/models/filters/text_filter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  module Filters
+    # Handles a text field filter.
+    class TextFilter < RansackFilter
+      def form_row(form)
+        content_tag(:div, class: 'form__group') do
+          [
+            label(form),
+            search_field(form)
+          ].join(' ').html_safe
+        end
+      end
+
+      private
+
+      def search_field(form)
+        form.search_field(
+          ransack_matcher,
+          class: 'form__input',
+          placeholder: form_options.fetch(:placeholder, '')
+        )
+      end
+    end
+  end
+end

data/lib/rolemodel_tables/models/ransack_filter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  module Filters
+    # Parent class for all custom filters.
+    class RansackFilter
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+
+      attr_reader :ransack_matcher, :form_options
+      attr_accessor :filter
+
+      def initialize(ransack_matcher, form_options = {})
+        @ransack_matcher = ransack_matcher
+        @form_options = form_options
+      end
+
+      def form_row(_form)
+        throw 'Subclass must override'
+      end
+
+      private
+
+      def label(form)
+        form.label(
+          ransack_matcher,
+          form_options.fetch(:label, ransack_matcher.to_s.humanize),
+          class: 'form__label'
+        )
+      end
+    end
+  end
+end

data/lib/rolemodel_tables/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  VERSION = '0.0.2'
+end

data/lib/rolemodel_tables.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RoleModelTables
+  class Error < StandardError; end
+end
+
+require 'rolemodel_tables/engine'
+require 'rolemodel_tables/models/filter_view'
+require 'rolemodel_tables/models/ransack_filter'
+
+Dir.chdir(__dir__) do
+  Dir['rolemodel_tables/models/filters/*.rb'].each { |file| require file }
+end

data/rolemodel_tables.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rolemodel_tables/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rolemodel_tables'
+  s.version     = RoleModelTables::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Jeremy Walton']
+  s.email       = 'consult@rolemodelsoftware.com'
+
+  s.summary     = 'Rolemodel Tables!'
+  s.description = 'Helpers for advanced table functionality.'
+  s.homepage    = 'https://github.com/RoleModel/rolemodel_tables'
+
+  s.license     = 'MIT'
+
+  # 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.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.1.0'
+
+  s.add_dependency 'kaminari', '~> 1.2'
+  s.add_dependency 'ransack', '~> 2.5'
+  s.add_dependency 'slim', '~> 4.1'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolemodel_tables
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Walton
@@ -61,6 +61,26 @@ files:
 - ".gitignore"
 - LICENSE
 - README.md
+- app/javascript/controllers/advanced_table_search_controller.js
+- app/views/kaminari/_first_page.html.slim
+- app/views/kaminari/_gap.html.slim
+- app/views/kaminari/_last_page.html.slim
+- app/views/kaminari/_next_page.html.slim
+- app/views/kaminari/_page.html.slim
+- app/views/kaminari/_paginator.html.slim
+- app/views/kaminari/_prev_page.html.slim
+- app/views/rolemodel_tables/_advanced_search_controls.html.slim
+- lib/rolemodel_tables.rb
+- lib/rolemodel_tables/engine.rb
+- lib/rolemodel_tables/models/filter_view.rb
+- lib/rolemodel_tables/models/filters/collection_filter.rb
+- lib/rolemodel_tables/models/filters/date_filter.rb
+- lib/rolemodel_tables/models/filters/date_range_filter.rb
+- lib/rolemodel_tables/models/filters/number_range_filter.rb
+- lib/rolemodel_tables/models/filters/text_filter.rb
+- lib/rolemodel_tables/models/ransack_filter.rb
+- lib/rolemodel_tables/version.rb
+- rolemodel_tables.gemspec
 homepage: https://github.com/RoleModel/rolemodel_tables
 licenses:
 - MIT