card 1.19.6 → 1.20.0

data/mod/standard/set/abstract/search/paging.rb

@@ -0,0 +1,81 @@
+format do
+  def limit
+    default_limit
+  end
+
+  def offset
+    search_params[:offset] || 0
+  end
+end
+
+format :html do
+  def with_paging path_args={}
+    paging_path_args path_args
+    output [yield, _optional_render_paging]
+  end
+
+  view :paging, cache: :never do
+    return "" unless paging_needed?
+    <<-HTML
+      <nav>
+        <ul class="pagination paging">
+          #{paging_links.join}
+        </ul>
+      </nav>
+    HTML
+  end
+
+  def paging_links
+    total_pages = ((count_with_params - 1) / limit).to_i
+    current_page = (offset / limit).to_i
+    PagingLinks.new(total_pages, current_page)
+               .build do |text, page, status, options|
+      page_link_li text, page, status, options
+    end
+  end
+
+  # First page is 0 (not 1)
+  def page_link_li text, page, status, options={}
+    wrap_with :li, class: status do
+      page_link text, page, options
+    end
+  end
+
+  def page_link text, page, options
+    return text unless page
+    paging_path_args[:offset] = page * limit
+    options.merge! class: "card-paging-link slotter",
+                   remote: true,
+                   path: paging_path_args
+    link_to raw(text), options
+  end
+
+  def paging_path_args local_args={}
+    @paging_path_args ||= {
+      limit: limit,
+      view: voo.home_view,
+      slot: voo.slot_options
+    }.merge(extra_paging_path_args).merge local_args
+  end
+
+  def paging_view
+    (voo && voo.home_view) || :content
+  end
+
+  def extra_paging_path_args
+    {}
+  end
+
+  def paging_needed?
+    return false if limit < 1
+    return false if fewer_results_than_limit? # avoid extra count search
+    # count search result instead
+    limit < count_with_params
+  end
+
+  # clear we don't need paging even before running count query
+  def fewer_results_than_limit?
+    return false unless offset.zero?
+    limit > offset + search_with_params.length
+  end
+end

data/mod/standard/set/abstract/search/paging/paging_links.rb

@@ -0,0 +1,90 @@
+#! no set module
+
+# render paging links
+class PagingLinks
+  def initialize total_pages, current_page
+    @total = total_pages
+    @current = current_page
+  end
+
+  # @param window [integer] number of page links shown left and right
+  #   of the current page
+  # @example: current page = 5, window = 2
+  #   |<<|1|...|3|4|[5]|6|7|...|10|>>|
+  # @yield [text, page, status, options] block to build single paging link
+  # @yieldparam status [Symbol] :active (for current page) or :disabled
+  # @yieldparam page [Integer] page number, first page is 0
+  # @return [Array<String>]
+  def build window=2, &block
+    @render_item = block
+    links window
+  end
+
+  private
+
+  def links window
+    @window_start = [@current - window, 0].max
+    @window_end = [@current + window, @total].min
+    left_part + window_part + right_part
+  end
+
+  # the links around the current page
+  def window_part
+    (@window_start..@window_end).map do |page|
+      direct_page_link page
+    end.compact
+  end
+
+  def left_part
+    [
+      previous_page_link,
+      (direct_page_link 0 if @window_start > 0),
+      (ellipse if @window_start > 1)
+    ].compact
+  end
+
+  def right_part
+    [
+      (ellipse if @total > @window_end + 1),
+      (direct_page_link @total if @total > @window_end),
+      next_page_link
+    ].compact
+  end
+
+  def previous_page_link
+    paging_item '<span aria-hidden="true">&laquo;</span>', previous_page,
+                "aria-label" => "Previous"
+  end
+
+  def next_page_link
+    paging_item '<span aria-hidden="true">&raquo;</span>', next_page,
+                "aria-label" => "Next"
+  end
+
+  def direct_page_link page
+    return unless page >= 0 && page <= @total
+    paging_item page + 1, page
+  end
+
+  def ellipse
+    @render_item.call "<span>...</span>", false
+  end
+
+  def paging_item text, page, options={}
+    status =
+      if page == @current
+        :active
+      elsif !page
+        :disabled
+      end
+    @render_item.call text, page, status, options
+  end
+
+  def previous_page
+    @current > 0 ? @current - 1 : false
+  end
+
+  def next_page
+    @current < @total ? @current + 1 : false
+  end
+end

data/mod/standard/set/abstract/wql_search.rb

@@ -0,0 +1,67 @@
+include_set Abstract::Search
+
+def search args={}
+  query = fetch_query(args)
+  # forces explicit limiting
+  # can be 0 or less to force no limit
+  raise "OH NO.. no limit" unless query.mods[:limit]
+  query.run
+end
+
+# override this to define search
+def wql_hash
+  @wql_hash ||= begin
+    query = raw_content
+    query = query.is_a?(Hash) ? query : parse_json_query(query)
+    query.symbolize_keys
+  end
+end
+
+def query args={}
+  query_args = wql_hash.merge! args
+  query_args = standardized_query_args query_args
+  Query.new query_args, name
+end
+
+def fetch_query args={}
+  @query ||= {}
+  @query[args.to_s] ||= query(args.clone) # cache query
+end
+
+def standardized_query_args args
+  args = args.symbolize_keys
+  args[:context] ||= cardname
+  args
+end
+
+def parse_json_query query
+  empty_query_error! if query.empty?
+  JSON.parse query
+rescue
+  raise Error::BadQuery, "Invalid JSON search query: #{query}"
+end
+
+def empty_query_error!
+  raise Error::BadQuery,
+        "Error in card '#{name}':can't run search with empty content"
+end
+
+format do
+  def default_search_params
+    @default_search_params ||= { limit: (card_content_limit || default_limit) }
+  end
+
+  def card_content_limit
+    card.wql_hash[:limit]
+  rescue
+    nil
+  end
+
+  def query_with_params
+    @query_with_params ||= card.fetch_query search_params
+  end
+
+  def limit
+    query_with_params.limit
+  end
+end

data/mod/standard/set/all/error.rb

@@ -9,8 +9,8 @@ format do
     ""
   end
 
-  view :unsupported_view, perms: :none, tags: :unknown_ok do |args|
-    "view (#{args[:unsupported_view]}) not supported for #{error_cardname}"
+  view :unsupported_view, perms: :none, tags: :unknown_ok do
+    "view (#{voo.unsupported_view}) not supported for #{error_cardname}"
   end
 
   view :missing, perms: :none do
@@ -48,31 +48,31 @@ format do
 end
 
 format :html do
-  def view_for_unknown view, args
+  def view_for_unknown view
     case
-    when focal? && ok?(:create)   then :new
-    when commentable?(view, args) then view
+    when focal? && ok?(:create) then :new
+    when commentable?(view)     then view
     else super
     end
   end
 
-  def commentable? view, args
-    return false unless self.class.tagged view, :comment
-    visibility_args = args.merge default_visibility: :hide
-    return false unless show_view? :comment_box, visibility_args
+  def commentable? view
+    return false unless self.class.tagged(view, :comment) &&
+                        show_view?(:comment_box, :hide)
     ok? :comment
   end
 
   def rendering_error exception, view
+    debug_error exception if Auth.always_ok?
     details = Auth.always_ok? ? backtrace_link(exception) : error_cardname
-    content_tag :span, class: "render-error alert alert-danger" do
+    wrap_with :span, class: "render-error alert alert-danger" do
       ["error rendering", details, "(#{view} view)"].join "\n"
     end
   end
 
   def backtrace_link exception
-    alert_class = "render-error-message errors-view admin-error-message"
-    warning = alert("warning", dismissible: true, alert_class: alert_class) do
+    class_up "alert", "render-error-message errors-view admin-error-message"
+    warning = alert("warning", true) do
       %{
         <h3>Error message (visible to admin only)</h3>
         <p><strong>#{exception.message}</strong></p>
@@ -83,39 +83,38 @@ format :html do
     link + warning
   end
 
-  view :unsupported_view, perms: :none, tags: :unknown_ok do |args|
+  view :unsupported_view, perms: :none, tags: :unknown_ok do
     %(
       <strong>
-        view <em>#{args[:unsupported_view]}</em>
+        view <em>#{voo.unsupported_view}</em>
         not supported for <em>#{error_cardname}</em>
       </strong>
     )
   end
 
-  view :message, perms: :none, tags: :unknown_ok do |args|
-    frame args do
-      params[:message]
-    end
+  view :message, perms: :none, tags: :unknown_ok do
+    frame { params[:message] }
   end
 
-  view :missing do |args|
+  view :missing do
     return "" unless card.ok? :create  # should this be moved into ok_view?
-    path_opts = args[:type] ? { card: { type: args[:type] } } : {}
-    link_text = "Add #{fancy_title args[:title]}"
-    klass = "slotter missing-#{args[:denied_view] || args[:home_view]}"
-    wrap(args) { link_to_view :new, link_text, path: path_opts, class: klass }
+    path_opts = voo.type ? { card: { type: voo.type } } : {}
+    link_text = "Add #{fancy_title _render_title}"
+    klass = "slotter missing-#{@denied_view || voo.home_view}"
+    wrap { link_to_view :new, link_text, path: path_opts, class: klass }
   end
 
   view :closed_missing, perms: :none do
-    %(<span class="faint"> #{showname} </span>)
+    wrap_with :span, showname, class: "faint"
   end
 
-  view :conflict, error_code: 409 do |args|
+  view :conflict, error_code: 409 do
     actor_link = link_to_card card.last_action.act.actor.cardname
-    expanded_act = wrap(args) do
+    expanded_act = wrap do
       _render_act_expanded act: card.last_action.act, current_rev_nr: 0
     end
-    wrap args.merge(slot_class: "error-view") do # ENGLISH below
+    class_up "card-slot", "error-view"
+    wrap do # ENGLISH below
       alert "warning" do
         %(
           <strong>Conflict!</strong>
@@ -128,72 +127,80 @@ format :html do
     end
   end
 
-  view :errors, perms: :none do |args|
-    if card.errors.any?
-      title = "Problems"
-      title += " with #{card.name}" unless card.name.blank?
-      frame_opts = { panel_class: "panel panel-warning",
-                     title: title, hide: "menu" }
-      frame args.merge(frame_opts) do
-        card.errors.map do |attrib, msg|
-          unless attrib == :abort
-            msg = "<strong>#{attrib.to_s.upcase}:</strong> #{msg}"
-          end
-          alert "warning", dismissible: true, alert_class: "card-error-msg" do
-            msg
-          end
+  view :errors, perms: :none do
+    return if card.errors.empty?
+    voo.title = card.name.blank? ? "Problems" : "Problems with #{card.name}"
+    voo.hide! :menu
+    class_up "card-frame", "panel panel-warning"
+    class_up "alert", "card-error-msg"
+    frame do
+      card.errors.map do |attrib, msg|
+        alert "warning", true do
+          attrib == :abort ? msg : standard_error_message(attrib, msg)
         end
       end
     end
   end
 
-  view :not_found do |args| # ug.  bad name.
-    sign_in_or_up_links =
-      unless Auth.signed_in?
-        signin_link = link_to_card :signin, "Sign in"
-        signup_link = link_to "Sign up", path: { action: :new, mark: :signup }
-        %(<div>#{signin_link} or #{signup_link} to create it.</div>)
-      end
-    frame args.merge(title: "Not Found", optional_menu: :never) do
-      card_label = card.name.present? ? "<em>#{card.name}</em>" : "that"
-      %(<h2>Could not find #{card_label}.</h2> #{sign_in_or_up_links})
+  def standard_error_message attribute, message
+    "<strong>#{attribute.to_s.upcase}:</strong> #{message}"
+  end
+
+  view :not_found do # ug.  bad name.
+    voo.hide! :menu
+    voo.title = "Not Found"
+    card_label = card.name.present? ? "<em>#{card.name}</em>" : "that"
+    frame do
+      [wrap_with(:h2) { "Could not find #{card_label}." },
+       sign_in_or_up_links]
+    end
+  end
+
+  def sign_in_or_up_links
+    return if Auth.signed_in?
+    signin_link = link_to_card :signin, "Sign in"
+    signup_link = link_to "Sign up", path: { action: :new, mark: :signup }
+    wrap_with(:div) { "#{signin_link} or #{signup_link} to create it." }
+  end
+
+  view :denial do
+    focal? ? loud_denial : quiet_denial
+  end
+
+  def quiet_denial
+    wrap_with :span, class: "denied" do
+      "<!-- Sorry, you don't have permission (#{@denied_task}) -->"
     end
   end
 
-  view :denial do |args|
-    task = args[:denied_task]
-    to_task = task ? "to #{task} this." : "to do that."
-    if !focal?
-      %(
-        <span class="denied">
-          <!-- Sorry, you don't have permission #{to_task} -->
-        </span>
-      )
+  def loud_denial
+    frame do
+      [
+        wrap_with(:h1, "Sorry!"),
+        wrap_with(:div, loud_denial_message)
+      ]
+    end
+  end
+
+  def loud_denial_message
+    to_task = @denied_task ? "to #{@denied_task} this." : "to do that."
+    case
+    when @denied_task != :read && Card.config.read_only
+      "We are currently in read-only mode.  Please try again later."
+    when Auth.signed_in?
+      "You need permission #{to_task}"
     else
-      frame args do # ENGLISH below
-        message =
-          case
-          when task != :read && Card.config.read_only
-            "We are currently in read-only mode.  Please try again later."
-          when Auth.signed_in?
-            "You need permission #{to_task}"
-          else
-            signin_link = link_to_card :signin, "sign in"
-            or_signup_link =
-              if Card.new(type_id: Card::SignupID).ok? :create
-                "or " +
-                  link_to("sign up", path: { action: "new", mark: :signup })
-              end
-            Env.save_interrupted_action(request.env["REQUEST_URI"])
-            "Please #{signin_link} #{or_signup_link} #{to_task}"
-          end
+      denial_message_with_links to_task
+    end
+  end
 
-        %(
-          <h1>Sorry!</h1>
-          <div>#{message}</div>
-        )
-      end
+  def denial_message_with_links to_task
+    linx = [link_to_card(:signin, "sign in")]
+    if Card.new(type_id: Card::SignupID).ok?(:create)
+      linx += ["or", link_to("sign up", path: { action: "new", mark: :signup })]
     end
+    Env.save_interrupted_action request.env["REQUEST_URI"]
+    "Please #{linx.join ' '} #{to_task}"
   end
 
   view :server_error do