card 1.97.0.1 → 1.98.0

data/tmpsets/set/mod020-search/abstract/00_filter_helper.rb

@@ -0,0 +1,66 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (FilterHelper)
+#
+# TODO: move sort/filter handling out of card and into base format
+module FilterHelper;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/search/set/abstract/00_filter_helper.rb"; end
+# sorting and filtering is about viewing the data, not altering the data itself.
+
+def sort_hash
+  sort_param.present? ? { sort: sort_param } : {}
+end
+
+def filter_param field
+  filter_hash[field.to_sym]
+end
+
+# FIXME: it is inconsistent that #sort_hash has :sort as the key, but
+# #filter_hash is the _value_ of the hash with :filter as the key.
+def filter_hash
+  @filter_hash ||= begin
+    filter = Env.params[:filter]
+    filter = filter.to_unsafe_h if filter&.respond_to?(:to_unsafe_h)
+    filter.is_a?(Hash) ? filter : {}
+  end
+end
+
+def sort_param
+  safe_sql_param :sort
+end
+
+def safe_sql_param key
+  param = Env.params[key]
+  param.blank? ? nil : Card::Query.safe_sql(param)
+end
+
+def filter_keys_with_values
+  filter_keys.map do |key|
+    values = filter_param(key)
+    values.present? ? [key, values] : next
+  end.compact
+end
+
+def default_filter_option
+  {}
+end
+
+def offset
+  param_to_i :offset, 0
+end
+
+module Format; parent.send :register_set_format, Card::Format, self; extend Card::Set::AbstractFormat
+  delegate :filter_hash, :sort_hash, :filter_param, :sort_param,
+           :all_filter_keys, to: :card
+
+  def extra_paging_path_args
+    super.merge filter_and_sort_hash
+  end
+
+  def filter_and_sort_hash
+    sort_hash.merge filter: filter_hash
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/search/set/abstract/00_filter_helper.rb ~~

data/tmpsets/set/mod020-search/abstract/01_filter_form_helper.rb

@@ -0,0 +1,125 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (FilterFormHelper)
+#
+module FilterFormHelper;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/search/set/abstract/01_filter_form_helper.rb"; end
+include_set Abstract::FilterHelper
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  view :filter_name_formgroup, cache: :never do
+    text_filter :name
+  end
+
+  def sort_options
+    {}
+  end
+
+  def select_filter field, default=nil, options=nil
+    options ||= filter_options field
+    options.unshift(["--", ""]) unless default
+    select_filter_tag field, default, options
+  end
+
+  def multiselect_filter field, default=nil, options=nil
+    options ||= filter_options field
+    multiselect_filter_tag field, default, options
+  end
+
+  def text_filter field, opts={}
+    text_filter_with_name_and_value filter_name(field), filter_param(field), opts
+  end
+
+  def text_filter_with_name_and_value name, value, opts
+    opts[:class] ||= "simple-text"
+    add_class opts, "form-control"
+    text_field_tag name, value, opts
+  end
+
+  def range_filter field, opts={}
+    add_class opts, "simple-text range-filter-subfield"
+    output [range_sign(:from),
+            sub_text_filter(field, :from, opts),
+            range_sign(:to),
+            sub_text_filter(field, :to, opts)]
+  end
+
+  def range_sign side
+    dir = side == :from ? "right" : "left"
+    wrap_with :span, class: "input-group-prepend" do
+      fa_icon("chevron-circle-#{dir}", class: "input-group-text")
+    end
+  end
+
+  def sub_text_filter field, subfield, opts={}
+    name = "filter[#{field}][#{subfield}]"
+    value = filter_hash.dig field, subfield
+    text_filter_with_name_and_value name, value, opts
+  end
+
+  def select_filter_type_based type_codename, order="asc"
+    # take the card name as default label
+    options = type_options type_codename, order, 80
+    select_filter type_codename, nil, options
+  end
+
+  def autocomplete_filter type_code, options_card=nil
+    options_card ||= Card::Name[type_code, :type, :by_name]
+    text_filter type_code, class: "#{type_code}_autocomplete",
+                           "data-options-card": options_card
+  end
+
+  def multiselect_filter_type_based type_codename
+    options = type_options type_codename
+    multiselect_filter type_codename, nil, options
+  end
+
+  def multiselect_filter_tag field, default, options, html_options={}
+    html_options[:multiple] = true
+    select_filter_tag field, default, options, html_options
+  end
+
+  def select_filter_tag field, default, options, html_options={}
+    name = filter_name field, html_options[:multiple]
+    default = filter_param(field) || default
+    options = options_for_select(options, default)
+
+    pointer_class = html_options[:multiple] ? "pointer-multiselect" : "pointer-select"
+    other_classes = "filter-input #{field} _filter_input_field _no-select2 form-control"
+    # _no-select2 because select is initiated after filter is opened.
+    add_class html_options, "#{pointer_class} #{other_classes}"
+
+    select_tag name, options, html_options
+  end
+
+  def filter_name field, multi=false
+    "filter[#{field}]#{'[]' if multi}"
+  end
+
+  def filter_options field
+    raw = send("#{field}_options")
+    raw.is_a?(Array) ? raw : option_hash_to_array(raw)
+  end
+
+  def option_hash_to_array hash
+    hash.each_with_object([]) do |(key, value), array|
+      array << [key, value.to_s.downcase]
+      array
+    end
+  end
+
+  def type_options type_codename, order="asc", max_length=nil
+    type_card = Card[type_codename]
+    res = Card.search type_id: type_card.id, return: :name, sort: "name", dir: order
+    return res unless max_length
+
+    res.map { |i| [trim_option(i, max_length), i] }
+  end
+
+  def trim_option option, max_length
+    option.size > max_length ? "#{option[0..max_length]}..." : option
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/search/set/abstract/01_filter_form_helper.rb ~~

data/tmpsets/set/mod020-search/abstract/02_search_params.rb

@@ -0,0 +1,67 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (SearchParams)
+#
+module SearchParams;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/search/set/abstract/02_search_params.rb"; end
+include_set Abstract::PagingParams
+
+module Format; parent.send :register_set_format, Card::Format, self; extend Card::Set::AbstractFormat
+  def offset
+    search_params[:offset] || 0
+  end
+
+  def search_params
+    @search_params ||= default_search_params
+  end
+
+  # used for override
+  def default_search_params
+    if (qparams = query_params)
+      paging_params.merge vars: qparams
+    else
+      paging_params
+    end
+  end
+
+  def paging_params
+    { limit: limit_param, offset: offset_param }
+  end
+
+  def query_params
+    return nil unless (vars = params[:query])
+
+    Card.safe_param vars
+  end
+
+  def default_limit
+    100
+  end
+
+  def extra_paging_path_args
+    return {} unless (vars = query_params)
+
+    { query: vars }
+  end
+end
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  def default_limit
+    Cardio.config.paging_limit || 20
+  end
+end
+
+module JsonFormat; parent.send :register_set_format, Card::Format::JsonFormat, self; extend Card::Set::AbstractFormat
+  def default_limit
+    20
+  end
+end
+
+module RssFormat; parent.send :register_set_format, Card::Format::RssFormat, self; extend Card::Set::AbstractFormat
+  def default_limit
+    25
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/search/set/abstract/02_search_params.rb ~~

data/tmpsets/set/mod020-search/abstract/03_filter.rb

@@ -0,0 +1,140 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (Filter)
+#
+module Filter;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/search/set/abstract/03_filter.rb"; end
+include_set Abstract::FilterFormHelper
+include_set Abstract::Utility
+
+def filter_class
+  Card::FilterQuery
+end
+
+def filter_and_sort_wql
+  sort? ? filter_wql.merge(sort_wql) : filter_wql
+end
+
+def filter_wql
+  return {} if filter_hash.empty?
+
+  filter_wql_from_params
+end
+
+# separate method is needed for tests
+def filter_wql_from_params
+  filter_class.new(filter_keys_with_values, blocked_id_wql).to_wql
+end
+
+def sort_wql
+  sort? ? sort_hash : {}
+end
+
+def sort?
+  true
+end
+
+def current_sort
+  sort_param || default_sort_option
+end
+
+def blocked_id_wql
+  not_ids = filter_param :not_ids
+  not_ids.present? ? { id: ["not in", not_ids.split(",")] } : {}
+end
+
+# all filter keys in the order they were selected
+def all_filter_keys
+  @all_filter_keys ||= filter_keys_from_params | filter_keys
+end
+
+def filter_keys
+  [:name]
+end
+
+def filter_keys_from_params
+  filter_hash.keys.map(&:to_sym) - [:not_ids]
+end
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  delegate :filter_hash, to: :card
+
+  def filter_fields slot_selector: nil, sort_field: nil
+    form_args = { action: filter_action_path, class: "slotter" }
+    form_args["data-slot-selector"] = slot_selector if slot_selector
+    filter_form filter_form_data, sort_field, form_args
+  end
+
+  def filter_form_data
+    all_filter_keys.each_with_object({}) do |cat, h|
+      h[cat] = { label: filter_label(cat),
+                 input_field: _render("filter_#{cat}_formgroup"),
+                 active: active_filter?(cat),
+                 default: default_filter?(cat) }
+    end
+  end
+
+  def active_filter? field
+    if card.filter_keys_from_params.present?
+      filter_hash.key? field
+    else
+      default_filter? field
+    end
+  end
+
+  def default_filter? field
+    card.default_filter_option.key?(field)
+  end
+
+  def filter_label field
+    # return "Keyword" if field.to_sym == :name
+    #
+    filter_label_from_method(field) || filter_label_from_name(field)
+  end
+
+  def filter_label_from_method field
+    try "#{field}_filter_label"
+  end
+
+  def filter_label_from_name field
+    Card.fetch_name(field) { field.to_s.capitalize }
+  end
+
+  def filter_action_path
+    path
+  end
+
+  view :filter_form, cache: :never do
+    filter_fields slot_selector: "._filter-result-slot",
+                  sort_field: _render(:sort_formgroup)
+  end
+
+  # @param data [Hash] the filter categories. The hash needs for every category
+  #   a hash with a label and a input_field entry.
+  def filter_form data={}, sort_input_field=nil, form_args={}
+    haml :filter_form, categories: data,
+                       sort_input_field: sort_input_field,
+                       form_args: form_args
+  end
+
+  def sort_options
+    {
+      "Alphabetical": :name,
+      "Recently Updated": :updated_at
+    }
+  end
+
+  view :sort_formgroup, cache: :never do
+    select_tag "sort",
+               options_for_select(sort_options, card.current_sort),
+               class: "pointer-select _filter-sort form-control",
+               "data-minimum-results-for-search": "Infinity"
+  end
+end
+
+def default_sort_option
+  wql_from_content[:sort]
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/search/set/abstract/03_filter.rb ~~

data/tmpsets/set/mod020-search/abstract/04_right_filter_form.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (RightFilterForm)
+#
+# To be included in a field card to get a filter for the parent.
+module RightFilterForm;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/search/set/abstract/04_right_filter_form.rb"; end
+# The core view renders a filter for the left card.
+
+include_set Set::Abstract::Filter
+
+def virtual?
+  true
+end
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  def filter_action_path
+    path mark: card.name.left, view: filter_view
+  end
+
+  view :core, cache: :never do
+    filter_fields slot_selector: ".filter_result-view"
+  end
+
+  def filter_view
+    :filter_result
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/search/set/abstract/04_right_filter_form.rb ~~

data/tmpsets/set/mod020-search/abstract/search.rb

@@ -0,0 +1,92 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (Search)
+#
+module Search;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/search/set/abstract/search.rb"; end
+include_set Abstract::Paging
+include_set Abstract::SearchParams
+include_set Abstract::Filter
+
+def search _args={}
+  raise Error, "search not overridden"
+end
+
+def cached_search args={}
+  @search_results ||= {}
+  @search_results[args.to_s] ||= search args
+end
+
+def returning item, args
+  args[:return] = item
+  yield
+end
+
+def item_cards args={}
+  args[:limit] ||= 0
+  returning(:card, args) { search args }
+end
+
+def item_names args={}
+  args[:limit] ||= 0
+  returning(:name, args) { search args }
+end
+
+def item_ids args={}
+  args[:limit] ||= 0
+  returning(:id, args) { search args }
+end
+
+def count args={}
+  args[:offset] = 0
+  args[:limit] = 0
+  returning(:count, args) { search args }
+end
+
+# for override
+def item_type
+  nil
+end
+
+def each_item_name_with_options _content=nil
+  options = {}
+  item = fetch_query.statement[:view]
+  options[:view] = item if item
+  item_names.each do |name|
+    yield name, options
+  end
+end
+
+module Format; parent.send :register_set_format, Card::Format, self; extend Card::Set::AbstractFormat
+  def search_with_params
+    search_with_rescue search_params
+  end
+
+  def count_with_params
+    search_with_rescue search_params.merge(return: :count)
+  end
+
+  def search_with_rescue query_args
+    card.cached_search query_args
+  rescue Error::BadQuery => e
+    e
+  end
+
+  def implicit_item_view
+    view = voo_items_view || item_view_from_query || default_item_view
+    Card::View.normalize view
+  end
+
+  # override if query can specify item view
+  def item_view_from_query
+    nil
+  end
+
+  def with_results
+    return render_no_search_results if search_with_params.empty?
+    yield
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/search/set/abstract/search.rb ~~