zadok 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 802adfb741625bb0a92b833800900763c43650fc69575976ccc5e291b31e27b7
-  data.tar.gz: c55686ea9b6959c99da063821f32fe7fa0af582c081829f3a450c79859b698be
+  metadata.gz: f672da6d9e4bf75eca14ab1b8659bfe92f362c38dfe22ced3fdf9a31c5c204cd
+  data.tar.gz: bf67606b9b15e5dcdf00fa1dd23e00e8b261a239b2f8fa51370f005206de86c5
 SHA512:
-  metadata.gz: 613351795412bee396b05ad9b53c93fe3635b812b00baa5a78c1b0c30f601fb98e17f87ca42e6a555cf17c59d04c70ca3512799cfa3282a6a747b1e885cbf857
-  data.tar.gz: 02bbf8b19aedf75f2fda96bea3e3f648d290d514ac84c939ac738d223bd630557539163c4ef6b72a52557316cbfadff8f53c3e37b9a4cf8dabd2c334f9cfc3bd
+  metadata.gz: 8a02b809e8ff1094dc12fc06dc7a2d1eacd3578affb18bddea6da73036c2a3771f6bcfee64ab24ee2547173e0363eacf3345ac99e60fc4f2e9ae732343cdcb86
+  data.tar.gz: 6a1a91ce657643eb57f948bd0efaff1e11b8dcb54282df3f508f5181638fe24c720fb13aff49b0125367834b21cb0fda9a945e0a50c4f55d0722d63ea577af5e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zadok (0.1.4)
+    zadok (0.1.5)
       bootstrap (~> 4.0.0.beta2.1)
       cancancan (~> 2.0)
       font-awesome-rails (~> 4.7)

data/app/controllers/zadok_controller.rb

@@ -59,6 +59,46 @@ class ZadokController < ApplicationController
 
   protected
 
+  def filter_collection
+    Zadok::FilterCollection.new(search_params, filters_namespace)
+  end
+
+  def filters_namespace
+    "filters/#{search_model}".classify.pluralize.constantize
+  end
+
+  def filtered_resources
+    current_search.result
+  end
+
+  def search_params
+    permitted_params.fetch(:q) { {} }
+  end
+
+  def search_model
+    raise "search_model method not implemented"
+  end
+
+  def current_search
+    search_model.ransack(search_params)
+  end
+
+  def search_results
+    current_search.result
+  end
+
+  def page
+    permitted_params.fetch(:page) { nil }
+  end
+
+  def per_page
+    permitted_params.fetch(:per_page) { 30 }
+  end
+
+  def current_sort
+    search_params.fetch(:s) { nil }
+  end
+
   def permitted_params
     params.permit(:page, :per_page, q: %i[s search_model])
   end

data/app/views/zadok/filters/_autocomplete.html.slim

@@ -0,0 +1,8 @@
+.autocomplete.ui-front
+  = f.hidden_field filter.param, value: filter.describe(search_params)
+  = text_field_tag(filter.field_id, filter.field_value(search_params), { role: "autocomplete",
+    class: "form-control",
+    id: filter.field_id,
+    data: { source: filter.source,
+            parent: "#filter-form",
+            target_id: filter.target_field_id }})

data/app/views/zadok/filters/_edit.html.slim

@@ -0,0 +1,4 @@
+- if filter_collection.active_filters?
+  #filter-form
+    = search_form_for current_search, url: filters_path, method: :put do |form|
+      = render "zadok/filters/form_fields", form: form

data/app/views/zadok/filters/_form_fields.html.slim

@@ -0,0 +1,17 @@
+= form.hidden_field :s, value: current_sort
+= form.hidden_field :search_model, value: search_model
+
+.row
+  - filter_collection.filters.each do |filter|
+    .col-lg-3.col-md-3.col-sm-4.col-xs-12[class=filter.type]
+      = form.label filter.param, filter.i18n_name
+      = render "zadok/filters/#{filter.type}", f: form, filter: filter
+
+.row
+  .col-lg-3.col-md-3.col-sm-4.col-xs-12
+    |  
+    = form.submit t("application.buttons.apply"), class: "btn btn-block btn-default"
+  .col-lg-6.col-md-6.col-sm-4.visible-sm-block.visible-md-block.visible-lg-block.hidden
+  .results.col-lg-3.col-md-3.col-sm-4.col-xs-12.text-right
+    = "#{t("filter.amount")}: "
+    .total-results.label.label-default

data/app/views/zadok/filters/_hidden.html.slim

@@ -0,0 +1 @@
+= f.hidden_field filter.param, value: filter.describe(search_params)

data/app/views/zadok/filters/_multiselect.slim

@@ -0,0 +1,2 @@
+= f.select filter.param, options_for_select(filter.options, filter.describe(search_params)),
+        { include_blank: true }, { multiple: true, class: "form-control" }

data/app/views/zadok/filters/_numeric_range_field.html.slim

@@ -0,0 +1,13 @@
+.textfield.numeric_range_field
+  = text_field_tag filter.name, filter.value(params),
+    placeholder: I18n.t("filter_labels.numeric_range.placeholder"),
+    pattern: ' *- *\d+|\d+( *- *(\d+)?)?',
+    "data-role" => "numeric_range",
+    "data-left" => filter.params[0],
+    "data-right" => filter.params[1],
+    "data-content" => filter.popover_content,
+    "data-trigger" => "focus",
+    "data-html" => "true",
+    class: "form-control"
+  = f.hidden_field filter.params[0]
+  = f.hidden_field filter.params[1]

data/app/views/zadok/filters/_options.html.slim

@@ -0,0 +1,5 @@
+- filter.options.each do |value, label|
+  .radio
+    label
+      = f.radio_button filter.param, value
+      = label

data/app/views/zadok/filters/_range.html.slim

@@ -0,0 +1,9 @@
+.range
+  = f.text_field filter.param, value: filter.describe(search_params),
+          data: { provide: :slider,
+                  "slider-step": 5,
+                  "slider-value": filter.describe(search_params),
+                  "slider-ticks": filter.ticks,
+                  "slider-ticks_labels": filter.ticks_labels,
+                  "slider-ticks_positions": filter.ticks_positions,
+                  "slider-tooltip": "hide" }

data/app/views/zadok/filters/_select.html.slim

@@ -0,0 +1,3 @@
+= f.select filter.param,
+           options_for_select(filter.options, filter.describe(search_params)),
+           { include_blank: true }, filter.html_options

data/app/views/zadok/filters/_textfield.html.slim

@@ -0,0 +1,2 @@
+.textfield
+  = f.text_field filter.param, class: "form-control"

data/app/views/zadok/filters/_typeable_multiselect.html.slim

@@ -0,0 +1,25 @@
+.textfield.input-group
+  = f.hidden_field filter.param, id: "#{filter.param}_id",
+                                 name: "",
+                                 value: ""
+  = f.text_field filter.param, class: "autocomplete form-control",
+                               id: "#{filter.param}_name",
+                               name: "",
+                               value: "",
+                               autocomplete:"off",
+                               data: { id: "#{filter.data_id}",
+                                       path: filter.data_path,
+                                       type: filter.data_type }
+  .input-group-addon.add-entry id="#{filter.param}_button"
+    .fa.fa-plus
+
+ul.active-filters id="#{filter.param}_list"
+  - if params[filter.param]
+    - params[filter.param].each do |value|
+      li
+        = filter.options[value]
+        = f.hidden_field filter.param, id: "#{filter.param}_#{value}",
+                                       value: value,
+                                       name: "q[#{filter.param}][]"
+        a.remove-entry[href="#"]
+          .fa.fa-times.pull-right

data/app/views/zadok/index.html.slim

@@ -6,7 +6,7 @@
         - if can?(:create, resource_name.classify.constantize)
           = link_to t("#{resource_name.pluralize}.new"), resource_url_for(:new), class: "btn btn-primary text-white float-right"
 
-      = render "filters/edit"
+      = render "zadok/filters/edit"
 
       table.table.table-light.table-bordered.table-striped.table-hover.table-sm
         thead

data/lib/zadok/filter_collection.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "active_support/inflector"
+
+Dir[Rails.root + "app/filters/**/*.rb"].each do |file|
+  require_dependency file
+end
+
+module Zadok
+  class FilterCollection
+    attr_reader :filters, :params
+
+    def initialize(params, filters_namespace = Zadok::Filters)
+      @params = params
+      @filters = []
+      filters_namespace.constants.each do |constant|
+        unless constant.match?(/Ransack/)
+          @filters << "#{filters_namespace}::#{constant}".constantize.new
+        end
+      end
+      @filters.sort! { |a, b| a.index <=> b.index }
+    end
+
+    def current_filters
+      @filters.select do |filter|
+        filter.active_in? params
+      end
+    end
+
+    def current_filter_params(params)
+      current_filters.flat_map(&:params).uniq.map do |param|
+        [param, params[param]]
+      end
+    end
+
+    def active_filters?
+      current_filters.count.positive?
+    end
+
+    def variable_results?
+      current_filters.any?(&:variable_results?)
+    end
+  end
+end

data/lib/zadok/filters/ransack/autocomplete_filter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class AutocompleteFilter < Base
+        def describe(current_params)
+          current_params[param]
+        end
+
+        def model
+          raise NotImplementedError
+        end
+
+        def attr
+          raise NotImplementedError
+        end
+
+        def autocomplete_attribute
+          raise NotImplementedError
+        end
+
+        def source
+          model.to_s.downcase.pluralize
+        end
+
+        def options
+          Hash[model.uniq.pluck(attr, autocomplete_attribute)]
+        end
+
+        def type
+          :autocomplete
+        end
+
+        def field_id
+          "#{source.singularize}_#{autocomplete_attribute}"
+        end
+
+        def target_field_id
+          "q_#{param}"
+        end
+
+        def field_value(params)
+          model.find_by(attr => describe(params))&.send(autocomplete_attribute)
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/base.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class Base
+        def initialize(opts = {})
+          @params = opts[:params]
+        end
+
+        attr_reader :params
+
+        # most filters just use a single param
+        def param
+          params[0]
+        end
+
+        def active_in?(current_params)
+          params.any? { |param| current_params.include? param }
+        end
+
+        def index
+          99
+        end
+
+        def i18n_name
+          I18n.t("filter.#{self.class.name.split('::').last.underscore}")
+        end
+
+        def title
+          i18n_name
+        end
+
+        def describe(_current_params)
+          raise NotImplementedError
+        end
+
+        # form control type
+        def type
+          raise NotImplementedError
+        end
+
+        def text(_current_params)
+          param
+        end
+
+        # options hash for filters with options
+        def options
+          I18n.t("filter_labels.#{param}").with_indifferent_access
+        end
+
+        # Each filter may opt to change the column(s) of the filtered admission
+        # list table - add or remove some.
+        def modify_columns(columns)
+          columns
+        end
+
+        def remove_from_params(current_params)
+          current_params.except(*params)
+        end
+
+        def add_to_params(current_params, value)
+          current_params.merge(param => value)
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/hidden_filter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class HiddenFilter < Base
+        def describe(current_params)
+          current_params[param]
+        end
+
+        def type
+          :hidden
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/multiselect_filter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class MultiselectFilter < Base
+        def describe(current_params)
+          return [] if current_params[param].blank?
+          options.map do |key, value|
+            value if current_params[param].include?(key)
+          end.compact.join(", ")
+        end
+
+        def type
+          :multiselect
+        end
+
+        def active_in?(current_params)
+          super && (current_params[param] & options.keys).present?
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/numeric_range_filter.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "abbrev"
+
+module Zadok
+  module Filters
+    module Ransack
+      class NumericRangeFilter < Base
+        def describe(current_params = {})
+          left, right = range_ends current_params
+          key = key_from_range_ends left, right
+          if key
+            I18n.t("filter_labels.numeric_range.#{key}", left: left, right: right)
+          else
+            left
+          end
+        end
+
+        def range_ends(current_params = {})
+          params.map do |param|
+            x = current_params[param]
+            x == "" ? nil : x
+          end
+        end
+
+        def key_from_range_ends(left, right)
+          if left && right
+            "closed" if left != right
+          elsif right
+            "left_open"
+          elsif left
+            "right_open"
+          else
+            raise "Both range ends missing; filter shouldn't be active"
+          end
+        end
+
+        def type
+          :numeric_range_field
+        end
+
+        def active_in?(current_params = {})
+          range_ends(current_params).any?
+        end
+
+        def name
+          prefix = common_prefix params.map(&:to_s)
+          prefix = params.join("_") + "_" if prefix.empty?
+          prefix + "range"
+        end
+
+        def common_prefix(strings)
+          strings.abbrev.keys.sort_by(&:length).first[0..-2]
+        end
+
+        def value(current_params)
+          left, right = range_ends current_params
+          if left == right
+            left
+          elsif left || right
+            "#{left} - #{right}"
+          else
+            ""
+          end
+        end
+
+        def popover_content
+          I18n.t("filter_labels.numeric_range.popover_text")
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/options_filter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class OptionsFilter < Base
+        def current_params
+          options[current_params[param]]
+        end
+
+        def type
+          :options
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/range_filter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class RangeFilter < Base
+        def describe(current_params)
+          current_params[param]
+        end
+
+        def type
+          :range
+        end
+
+        def ticks
+          options.map { |k, _v| k.to_s.to_i }
+        end
+
+        def ticks_labels
+          options.map { |_k, v| v }
+        end
+
+        def ticks_positions
+          ticks.map.with_index do |_tick, index|
+            (100 / (ticks.count.to_f - 1)) * index
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/select_filter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class SelectFilter < Base
+        def describe(current_params)
+          current_params[param]
+        end
+
+        def type
+          :select
+        end
+
+        def html_options
+          { class: "form-control" }
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/textfield_filter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class TextfieldFilter < Base
+        def describe(current_params)
+          current_params[param]
+        end
+
+        def type
+          :textfield
+        end
+      end
+    end
+  end
+end

data/lib/zadok/filters/ransack/typeable_multiselect_filter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Zadok
+  module Filters
+    module Ransack
+      class TypeableMultiselect < Base
+        def describe(current_params)
+          options.map do |key, value|
+            value if current_params[param].include?(key)
+          end.compact.join("|")
+        end
+
+        def type
+          :typeable_multiselect
+        end
+      end
+    end
+  end
+end

data/lib/zadok/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zadok
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zadok
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Leon Hooijer
@@ -197,6 +197,17 @@ files:
 - app/controllers/zadok_controller.rb
 - app/helpers/zadok_helper.rb
 - app/views/zadok/edit.html.slim
+- app/views/zadok/filters/_autocomplete.html.slim
+- app/views/zadok/filters/_edit.html.slim
+- app/views/zadok/filters/_form_fields.html.slim
+- app/views/zadok/filters/_hidden.html.slim
+- app/views/zadok/filters/_multiselect.slim
+- app/views/zadok/filters/_numeric_range_field.html.slim
+- app/views/zadok/filters/_options.html.slim
+- app/views/zadok/filters/_range.html.slim
+- app/views/zadok/filters/_select.html.slim
+- app/views/zadok/filters/_textfield.html.slim
+- app/views/zadok/filters/_typeable_multiselect.html.slim
 - app/views/zadok/form/fields/_email_field.html.slim
 - app/views/zadok/form/fields/_select.html.slim
 - app/views/zadok/form/fields/_text_field.html.slim
@@ -204,6 +215,17 @@ files:
 - app/views/zadok/new.html.slim
 - lib/zadok.rb
 - lib/zadok/engine.rb
+- lib/zadok/filter_collection.rb
+- lib/zadok/filters/ransack/autocomplete_filter.rb
+- lib/zadok/filters/ransack/base.rb
+- lib/zadok/filters/ransack/hidden_filter.rb
+- lib/zadok/filters/ransack/multiselect_filter.rb
+- lib/zadok/filters/ransack/numeric_range_filter.rb
+- lib/zadok/filters/ransack/options_filter.rb
+- lib/zadok/filters/ransack/range_filter.rb
+- lib/zadok/filters/ransack/select_filter.rb
+- lib/zadok/filters/ransack/textfield_filter.rb
+- lib/zadok/filters/ransack/typeable_multiselect_filter.rb
 - lib/zadok/link_renderer.rb
 - lib/zadok/version.rb
 - zadok.gemspec