card-mod-search 0.14.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206b17cbcd8dcd1d38acb8228deeda153fedd37e39846becd85e3c86272a52ee
-  data.tar.gz: a0e71ded665f407737832dae8fa8e7292a25339f0c990df9c5abaeb5b10ef5da
+  metadata.gz: 65e8166a82d2feff946e6181a24c00da4cb6bf0d7ce8a16a11c2b7b22db118d3
+  data.tar.gz: bd16364e72bfad3e63a38b0682dc9d3de2c500453b612b14030f12b72117f045
 SHA512:
-  metadata.gz: 0de1b034548fa4c6e523a848e521b1a0d5f0039d78252960adcfcfc55508877dac5313f12edecf5bef51fa08e429535d266363ccf461d25575b837d3176c909f
-  data.tar.gz: 1b8e708a4ebfc81c1613f52b92853298473780343cb689ebb200f13f336b39e5e95fce7be7bba1fe494d2a6a0dc0dd2c125cc9f82eb0e515dbfd42950e04d35b
+  metadata.gz: aa9207b80f1c7027f273e95adfe53f81ff790584d86e1c062f4588e39f63e8039a425a1f1aea06b46af30a32062fd25bc5279cb0639f9fe2129b4f7917de114d
+  data.tar.gz: 2881e5b1bdcf6a85411e9dad390a06f61c03ffe110503daed66b98eaf9a9e67a50551471ce77c6214f74d0bddf0aa562221b09e7ebe5cf7ddb74e4eca8705404

data/assets/script/autocomplete.js.coffee

@@ -0,0 +1,36 @@
+decko.slot.ready (slot) ->
+  slot.find('._autocomplete').each (_i) ->
+    decko.initAutoCardPlete($(this))
+
+  slot.find('._select2autocomplete').each (_i) ->
+    decko.select2Autocomplete.init $(this)
+
+decko.initAutoCardPlete = (input) ->
+  optionsCard = input.data 'options-card'
+  return unless !!optionsCard
+  path = optionsCard + '.json?view=name_match'
+  input.autocomplete { source: decko.slot.path(path) }
+
+decko.select2Autocomplete =
+  init: (el, options, ajaxOptions) ->
+    opts = $.extend {}, @_defaults(el), options
+    $.extend opts.ajax, ajaxOptions if ajaxOptions
+    el.select2 opts
+
+  _defaults: (el)->
+    multiple: false
+    width: "100%!important"
+    minimumInputLength: 0
+    maximumSelectionSize: 1
+
+    placeholder: el.attr("placeholder")
+    escapeMarkup: (markup) -> markup
+
+    ajax:
+      delay: 200
+      cache: true
+      url: decko.path ':search.json'
+      processResults: (data) -> results: data
+      data: (params) ->
+        query: { keyword: params.term }
+        view: "complete"

data/assets/script/search_box.js.coffee

@@ -0,0 +1,24 @@
+
+$(window).ready ->
+  el = $('._search-box')
+  box = new decko.searchBox el
+  el.data "searchBox", box
+  box.init()
+
+class decko.searchBox
+  constructor: (el) ->
+    @box = el
+    @sourcepath = @box.data "completepath"
+    @originalpath = @sourcepath
+    @config =
+      source: @sourcepath
+      select: @select
+
+  init: -> @box.autocomplete @config, html: true
+
+  select: (_event, ui) ->
+    url = ui.item.url
+    window.location = url if url
+
+  form: -> @box.closest "form"
+  keyword: -> @form().find("#query_keyword").val()

data/assets/style/search.scss

@@ -0,0 +1,69 @@
+
+.d0-search-box {
+  width: 100%;
+}
+
+.search-keyword {
+  font-style: italic;
+}
+
+.search-count {
+  float: right;
+  color: $gray-600;
+}
+
+.closed-content .search-no-results:after {
+  content:'';
+}
+
+/* english content in css.  ugh */
+.search-no-results:after {
+  content:'0 results';
+}
+
+.search-box-nav {
+  flex: 1 0 50%;
+  .search-box-form {
+    width: 100%;
+  }
+  .select2-results > .select2-results__options {
+    max-height: none !important;
+  }
+  .select2-search__field {
+    width: 100% !important;
+  }
+}
+
+.search-box-item-label {
+  float: left;
+  position: relative;
+  font-size: 10px;
+  width: 50px;
+  padding: 3px 0 3px 5px;
+}
+.search-box-item-value mark {
+  padding: 0.2em 0;
+}
+
+.ui-autocomplete {
+  z-index: 2000 !important; // to move it in front of modals (= 1050)
+  .ui-menu-item-wrapper {
+    display: block;
+  }
+}
+
+.autocomplete-item {
+  display: flex;
+  margin: 0.4em 0;
+  .autocomplete-icon {
+    width: 30px;
+    margin-right: 1em;
+    text-align: center;
+    img, svg {
+      max-width: 100% !important;
+      max-height: 100% !important;
+      min-width: auto !important;
+      min-height: auto !important;
+    }
+  }
+}

data/data/files/mod_search_script_asset_output/file.js

@@ -0,0 +1,4 @@
+// autocomplete.js.coffee
+(function(){decko.slot.ready(function(e){return e.find("._autocomplete").each(function(){return decko.initAutoCardPlete($(this))}),e.find("._select2autocomplete").each(function(){return decko.select2Autocomplete.init($(this))})}),decko.initAutoCardPlete=function(e){var t,n;if(t=e.data("options-card"))return n=t+".json?view=name_match",e.autocomplete({source:decko.slot.path(n)})},decko.select2Autocomplete={init:function(e,t,n){var o;return o=$.extend({},this._defaults(e),t),n&&$.extend(o.ajax,n),e.select2(o)},_defaults:function(e){return{multiple:!1,width:"100%!important",minimumInputLength:0,maximumSelectionSize:1,placeholder:e.attr("placeholder"),escapeMarkup:function(e){return e},ajax:{delay:200,cache:!0,url:decko.path(":search.json"),processResults:function(e){return{results:e}},data:function(e){return{query:{keyword:e.term},view:"complete"}}}}}}}).call(this);
+// search_box.js.coffee
+(function(){$(window).ready(function(){var t,o;return o=$("._search-box"),t=new decko.searchBox(o),o.data("searchBox",t),t.init()}),decko.searchBox=function(){function t(t){this.box=t,this.config={source:this.box.data("completepath"),select:this.select}}return t.prototype.init=function(){return this.box.autocomplete(this.config,{html:!0})},t.prototype.select=function(t,o){var e;if((e=o.item).url)return window.location=e.url},t.prototype.goto=function(){},t.prototype.search=function(){},t}()}).call(this);

data/data/real.yml

@@ -0,0 +1,112 @@
+---
+- :name: Search
+  :type: :cardtype
+  :codename: search_type
+  :fields:
+    :description: |-
+      <p>
+        Searches return a list of cards using 
+        [[http://decko.org/CQL|CQL, the Card Query Language]]. 
+        See the [[http://decko.org/CQL_syntax|syntax documentation]].
+      </p>
+
+- :name: "*search"
+  :type: :search_type
+  :codename: search
+  :content: '{"match":"$keyword", "sort":"relevance"}'
+- :name: "*recent"
+  :type: :search_type
+  :codename: recent
+  :fields:
+    :self:
+      :fields:
+        :read: Anyone
+- :name: "*count"
+  :codename: count
+
+- :name: by name
+  :codename: by_name
+- :name: by create
+  :codename: by_create
+- :name: by update
+  :codename: by_update
+
+- :name: "*last edited"
+  :codename: last_edited
+- :name: "*creator"
+  :codename: creator
+- :name: "*created"
+  :codename: created
+  :fields:
+    :right:
+      :fields:
+        :help: Cards created by <em>{{_left|name}}</em>.
+- :name: "*edited"
+  :codename: edited
+  :fields:
+    :right:
+      :fields:
+        :help: Cards edited by <em>{{_left|name}}</em>.
+- :name: "*editors"
+  :codename: editors
+  :fields:
+    :right:
+      :fields:
+        :help: Users who have edited <em>{{_left|name}}</em>.
+
+- :name: "*children"
+  :codename: children
+  :fields:
+    :right:
+      :fields:
+        :help: |-
+          <p>
+            Cards formed by "mating" <em>{{_left|name}}</em> with another card. 
+            eg\: "{{_left|name}}<strong>+</strong>mate".
+          </p>
+- :name: "*mates"
+  :codename: mates
+  :fields:
+    :right:
+      :fields:
+        :help: |-
+          <p>
+            If there is a card named "X+<em>{{_left|name}}</em>", 
+            then X is a mate of <em>{{_left|name}}</em>.
+          </p>
+- :name: "*nested by"
+  :codename: nested_by
+  :fields:
+    :right:
+      :fields:
+        :help: "<p>Cards that refer to <em>{{_left|name}}</em>.</p>"
+- :name: "*linked to by"
+  :codename: linked_to_by
+  :fields:
+    :right:
+      :fields:
+        :help: "<p>Cards that link to <em>{{_left|name}}</em>.</p>"
+- :name: "*nests"
+  :codename: nests
+  :fields:
+    :right:
+      :fields:
+        :help: "<p>Cards nested within <em>{{_left|name}}</em></p>"
+- :name: "*links to"
+  :codename: links_to
+  :fields:
+    :right:
+      :fields:
+        :help: "<p>Cards that <em>{{_left|name}}</em> links to.</p>"
+- :name: "*referred to by"
+  :codename: referred_to_by
+  :fields:
+    :right:
+      :fields:
+        :help: "<p>Cards referred to by <em>{{_left|name}}</em>.</p>"
+- :name: "*refers to"
+  :codename: refers_to
+  :fields:
+    :right:
+      :fields:
+        :help: "<p>Cards that <em>{{_left|name}}</em> refers to.</p>"

data/data/test.yml

@@ -0,0 +1,18 @@
+---
+- :name: '42'
+  :content: |
+    Far out in the uncharted backwaters of the unfashionable end of
+    the western spiral arm of the Galaxy lies a small unregarded
+    yellow sun.
+
+    Orbiting this at a distance of roughly ninety-two million miles
+    is an utterly insignificant little blue green planet whose ape-
+    descended life forms are so amazingly primitive that they still
+    think digital watches are a pretty neat idea.
+
+    This planet has - or rather had - a problem, which was this: most
+    of the people living on it were unhappy for pretty much of the time.
+    Many solutions were suggested for this problem, but most of these
+    were largely concerned with the movements of small green pieces
+    of paper, which is odd because on the whole it wasn't the small
+    green pieces of paper that were unhappy.

data/lib/card/mod/search.rb

@@ -0,0 +1,4 @@
+Cardio::Railtie.config.tap do |config|
+  config.paging_limit = 20
+  config.search_box_match_start_only = true
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  search_search_box_placeholder: Search
+  search_results_title: Search Results
+  search_results_for: Results for

data/set/abstract/0_search/checkbox_item.haml

@@ -0,0 +1,6 @@
+//- id = "#{card.key}-_-#{item_card.key}"
+.w-100.d-flex.align-items-center
+  = check_box_tag item_card.name, item_card.key, false,
+                  class: "_checkbox-list-checkbox p-1 me-3"
+  %label.p-2.w-100
+    = nest_item item_card

data/set/abstract/{02_search_params.rb → 0_search/search_params.rb}

@@ -5,7 +5,7 @@ format do
 
   # used for override
   def default_search_params
-    if (qparams = query_params)
+    if (qparams = query_params)&.present?
       paging_params.merge vars: qparams
     else
       paging_params
@@ -17,9 +17,7 @@ format do
   end
 
   def query_params
-    return nil unless (vars = params[:query])
-
-    Env.hash vars
+    (vars = params[:query]) ? Env.hash(vars) : {}
   end
 
   def default_limit

data/set/abstract/{05_search → 0_search}/views.rb

@@ -4,8 +4,7 @@ format do
   end
 
   view :search_error, cache: :never do
-    sr_class = search_with_params.class.to_s
-    %(#{sr_class} :: #{search_with_params.message} :: #{card.content})
+    %(#{search_with_params.class} :: #{search_with_params.message} :: #{card.content})
   end
 
   view :card_list, cache: :never do
@@ -25,15 +24,19 @@ format do
   def with_results
     search_with_params.empty? ? render_no_search_results : yield
   end
-end
-
-format :json do
-  AUTOCOMPLETE_LIMIT = 8 # number of name suggestions for autocomplete text fields
 
   def item_cards
     search_with_params
   end
 
+  def term_param
+    params[:term]
+  end
+end
+
+format :json do
+  AUTOCOMPLETE_LIMIT = 8 # number of name suggestions for autocomplete text fields
+
   # NOCACHE because paging_urls is uncacheable hash and thus not safe to merge
   view :molecule, cache: :never do
     molecule.merge render_paging_urls
@@ -48,30 +51,32 @@ format :json do
     complete_or_match_search limit: AUTOCOMPLETE_LIMIT
   end
 
-  def complete_or_match_search limit: AUTOCOMPLETE_LIMIT, start_only: false
-    starts_with = complete_search limit: limit
+  def complete_or_match_search limit: AUTOCOMPLETE_LIMIT, start_only: false,
+                               additional_cql: {}
+    starts_with = complete_search limit: limit, additional_cql: additional_cql
     return starts_with if start_only
 
     remaining_slots = limit - starts_with.size
     return starts_with if remaining_slots.zero?
 
-    starts_with + match_search(not_names: starts_with, limit: remaining_slots)
+    starts_with + match_search(not_names: starts_with, limit: remaining_slots,
+                               additional_cql: additional_cql)
   end
 
-  def complete_search limit: AUTOCOMPLETE_LIMIT
-    card.search name_cql(limit).merge(complete_cql)
+  def complete_search limit: AUTOCOMPLETE_LIMIT, additional_cql: {}
+    card.search name_cql(limit).merge(complete_cql).merge(additional_cql)
   end
 
-  def match_search limit: AUTOCOMPLETE_LIMIT, not_names: []
-    card.search name_cql(limit).merge(match_cql(not_names))
+  def match_search limit: AUTOCOMPLETE_LIMIT, not_names: [], additional_cql: {}
+    card.search name_cql(limit).merge(match_cql(not_names)).merge(additional_cql)
   end
 
   def name_cql limit
-    { limit: limit, sort: "name", return: "name" }
+    { limit: limit, sort_by: "name", return: "name" }
   end
 
   def complete_cql
-    { complete: term_param }
+    term_param.present? ? { complete: term_param } : {}
   end
 
   def match_cql not_names
@@ -79,10 +84,6 @@ format :json do
     cql[:name] = ["not in"] + not_names if not_names.any?
     cql
   end
-
-  def term_param
-    params[:term]
-  end
 end
 
 format :data do
@@ -95,39 +96,28 @@ end
 
 format :csv do
   view :core, :core, mod: All::Csv::CsvFormat
-
-  view :card_list do
-    items = super()
-    if depth.zero?
-      title_row + items
-    else
-      items
-    end
-  end
+  #
+  # view :card_list do
+  #   items = super()
+  #   if depth.zero?
+  #     title_row + items
+  #   else
+  #     items
+  #   end
+  # end
 end
 
 format :html do
   view :card_list, cache: :never do
     with_results do
-      search_result_list "search-result-list" do |item_card|
-        card_list_item item_card
-      end
+      klasses = "card-list card-list-#{item_view_options[:view]} search-result-list"
+      search_result_list(klasses) { |item_card| card_list_item item_card }
     end
   end
 
-  view :select_item, cache: :never do
-    wrap do
-      haml :select_item
-    end
-  end
-
-  before :select_item do
-    class_up "card-slot", "_filter-result-slot"
-  end
-
   view :checkbox_list, cache: :never do
     with_results do
-      search_result_list "_search-checkbox-list pr-2" do |item_card|
+      search_result_list "_search-checkbox-list pe-2" do |item_card|
         checkbox_item item_card
       end
     end
@@ -158,8 +148,4 @@ format :html do
       haml :checkbox_item, unique_id: unique_id, item_card: item_card
     end
   end
-
-  def closed_limit
-    [search_params[:limit].to_i, Card.config.closed_search_limit].min
-  end
 end

data/set/abstract/{05_search.rb → 0_search.rb}

@@ -1,6 +1,4 @@
 include_set Abstract::Paging
-include_set Abstract::SearchParams
-include_set Abstract::Filter
 
 def search _args={}
   raise Error, "search not overridden"
@@ -38,9 +36,9 @@ def count args={}
 end
 
 # for override
-def item_type
-  nil
-end
+# def item_type_id
+#   nil
+# end
 
 def each_item_name_with_options _content=nil
   options = {}
@@ -60,10 +58,6 @@ format do
     @count_with_params ||= search_with_rescue search_params.merge(return: :count)
   end
 
-  view :filtered_count, cache: :never do
-    count_with_params
-  end
-
   def search_with_rescue query_args
     rescuing_bad_query query_args do
       card.cached_search query_args

data/set/abstract/{06_cql_search.rb → cql_search.rb}

@@ -11,9 +11,10 @@ def cql_content
   query.symbolize_keys
 end
 
-def item_type
+def item_type_id
   type = cql_hash[:type]
-  type unless type.is_a?(Array) || type.is_a?(Hash)
+  type = type&.card_id unless type.is_a? Hash
+  type if type.is_a? Integer
 end
 
 # for override, eg when required subqueries are known to be missing
@@ -71,10 +72,6 @@ def standardized_query_args args
 end
 
 format do
-  def search_params
-    super.merge filter_and_sort_cql
-  end
-
   def default_limit
     card_content_limit || super
   end

data/set/abstract/search_views.rb

@@ -41,8 +41,7 @@ format :html do
     if depth > max_depth
       "..."
     else
-      search_params[:limit] = closed_limit
-      _render_core hide: "paging", items: { view: :link }
+      render_core hide: "paging", items: { view: :link }
       # TODO: if item is queryified to be "name", then that should work.
       # otherwise use link
     end

data/set/abstract/virtual_search.rb

@@ -0,0 +1,3 @@
+def virtual?
+  new?
+end

data/set/all/autocomplete/autocomplete_input.haml

@@ -0,0 +1,3 @@
+.pointer-list-editor.pointer-list-ul
+  = text_field_tag 'pointer_item', item, class: "pointer-item-text form-control _autocomplete #{extra_classes}",
+                                         "data-options-card": options_card

data/set/all/autocomplete/autocomplete_item.haml

@@ -0,0 +1,5 @@
+.autocomplete-item{ class: "autocomplete-item-#{type}" }
+  .autocomplete-icon
+    = icon
+  .autocomplete-label
+    = label

data/set/all/autocomplete.rb

@@ -0,0 +1,48 @@
+def add_autocomplete_ok?
+  new_card? && name.valid? && !virtual? && ok?(:create)
+end
+
+format :html do
+  view :goto_autocomplete_item do
+    autocomplete_item :goto, goto_autocomplete_icon, autocomplete_label
+  end
+
+  view :add_autocomplete_item, unknown: true do
+    autocomplete_item :add, icon_tag(:add), autocomplete_label
+  end
+
+  def autocomplete_field item, options_card_name, extra_classes=""
+    haml :autocomplete_input,
+         item: item, options_card: options_card_name,
+         extra_classes: extra_classes
+  end
+
+  def name_autocomplete_field item, extra_classes=""
+    # select_tag "autocomplete_#{card.key}", "", class: "_select2autocomplete"
+    text_field_tag "pointer_item", item,
+                   class: "pointer-item-text form-control _autocomplete #{extra_classes}",
+                   "data-options-card": %i[all by_name].to_name
+  end
+
+  def add_autocomplete_item_path
+    path
+  end
+
+  private
+
+  def autocomplete_item type, icon, label
+    haml :autocomplete_item, type: type, icon: icon, label: label
+  end
+
+  def goto_autocomplete_icon
+    if card.fetch :image
+      field_nest :image, view: :core, size: :small
+    else
+      icon_tag :arrow_forward
+    end
+  end
+
+  def autocomplete_label
+    card.name
+  end
+end

data/set/right/by_create.rb

@@ -0,0 +1,7 @@
+include_set Abstract::VirtualSearch
+
+assign_type :search_type
+
+def cql_content
+  { found_by: "_left", sort_by: "create" }
+end

data/set/right/by_name.rb

@@ -0,0 +1,7 @@
+include_set Abstract::VirtualSearch
+
+assign_type :search_type
+
+def cql_content
+  { found_by: "_left", sort_by: "name" }
+end

data/set/right/by_update.rb

@@ -0,0 +1,7 @@
+include_set Abstract::VirtualSearch
+
+assign_type :search_type
+
+def cql_content
+  { "found_by": "_left", sort_by: "update" }
+end

data/set/right/children.rb

@@ -1,3 +1,11 @@
+include_set Abstract::VirtualSearch
+
+assign_type :search_type
+
+def cql_content
+  { part: "_left", sort_by: "name" }
+end
+
 def raw_help_text
   "Cards formed by \"mating\" {{_left|name}} with another card. "\
   "eg: \"{{_left|name}}+mate\"."

data/set/right/count.rb

@@ -0,0 +1,9 @@
+assign_type :search_type
+
+def virtual?
+  new?
+end
+
+def cql_content
+  { found_by: "_left", return: "count" }
+end

data/set/right/created.rb

@@ -1,3 +1,11 @@
+include_set Abstract::VirtualSearch
+
+assign_type :search_type
+
+def cql_content
+  { created_by: "_left", sort_by: "create", dir: "desc" }
+end
+
 def raw_help_text
   "Cards created by {{_left|name}}."
 end

data/set/right/creator.rb

@@ -0,0 +1,7 @@
+include_set Abstract::VirtualSearch
+
+assign_type :search_type
+
+def cql_content
+  { creator_of: "_left" }
+end