RubyGems - card-mod-format - Versions diffs - 0.11.0 - Mend

card-mod-format 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (51) hide show

checksums.yaml +7 -0
data/lib/card/format/css_format.rb +17 -0
data/lib/card/format/csv_format.rb +19 -0
data/lib/card/format/data_format.rb +6 -0
data/lib/card/format/file_format.rb +8 -0
data/lib/card/format/html_format.rb +45 -0
data/lib/card/format/js_format.rb +17 -0
data/lib/card/format/json_format.rb +24 -0
data/lib/card/format/rss_format.rb +9 -0
data/lib/card/format/text_format.rb +16 -0
data/lib/card/format/xml_format.rb +13 -0
data/lib/card/path.rb +127 -0
data/set/all/active_card.rb +6 -0
data/set/all/base.rb +137 -0
data/set/all/css.rb +37 -0
data/set/all/csv.rb +93 -0
data/set/all/error.rb +79 -0
data/set/all/export.rb +68 -0
data/set/all/file.rb +9 -0
data/set/all/frame.rb +53 -0
data/set/all/haml.rb +75 -0
data/set/all/head.rb +148 -0
data/set/all/header.rb +62 -0
data/set/all/header/header_wrap.haml +4 -0
data/set/all/html_content.rb +168 -0
data/set/all/html_content/labeled.haml +4 -0
data/set/all/html_error.rb +193 -0
data/set/all/html_error/debug_server_error.haml +1015 -0
data/set/all/html_error/not_found.haml +7 -0
data/set/all/html_error/server_error.haml +5 -0
data/set/all/html_show.rb +53 -0
data/set/all/html_title.rb +47 -0
data/set/all/html_wrapper.rb +159 -0
data/set/all/js.rb +10 -0
data/set/all/json.rb +166 -0
data/set/all/links.rb +149 -0
data/set/all/menu.rb +129 -0
data/set/all/meta_tags.haml +4 -0
data/set/all/path.rb +78 -0
data/set/all/rich_html.rb +4 -0
data/set/all/rss.rb +76 -0
data/set/all/text.rb +7 -0
data/set/self/home.rb +9 -0
data/set/type/html.rb +27 -0
data/set/type/json.rb +41 -0
data/set/type/number.rb +22 -0
data/set/type/phrase.rb +5 -0
data/set/type/plain_text.rb +9 -0
data/set/type/toggle.rb +38 -0
data/set/type/uri.rb +15 -0
metadata +123 -0

data/set/all/html_error/not_found.haml ADDED

@@ -0,0 +1,7 @@
+%h2
+  Could not find
+  - if card.name.present?
+    %em
+      = safe_name
+  - else
+    that

data/set/all/html_error/server_error.haml ADDED

@@ -0,0 +1,5 @@
+.border.border-danger.text-center.p-3
+  %h1 Wild Card!
+  %h2.alert-danger 500 Server Error
+  %h4.p-3
+    Yuck, sorry about that.

data/set/all/html_show.rb ADDED

@@ -0,0 +1,53 @@
+format :html do
+  def show view, args
+    capture_the_freak do
+      content = send show_method, view, args
+      show_full_page? ? wrap_with_html_page(content) : content
+    end
+  end
+  def show_method
+    "show_#{show_layout? ? :with : :without}_page_layout"
+  end
+  def show_without_page_layout view, args
+    @main = true if params[:is_main] || args[:main]
+    args.delete(:layout)
+    view ||= args[:home_view] || :open # default_nest_view
+    render! view, args
+  end
+  def show_full_page?
+    !Env.ajax?
+  end
+  wrapper :html_page do
+    <<-HTML.strip_heredoc
+      <!DOCTYPE HTML>
+      <html class="h-100">
+        <head>
+          #{head_content}
+        </head>
+        #{interior}
+      </html>
+    HTML
+  end
+  def head_content
+    nest card.rule_card(:head), view: :head_content
+  end
+  private
+  # this is a temporary fix to try to debug a recurring encoding-related error
+  # TODO: remove the following after tracking down wikirate encoding bug
+  def capture_the_freak
+    yield
+  rescue Card::Error::ServerError => e
+    if e.message.match?(/invalid byte sequence/)
+      Card::Lexicon.cache.reset
+      Rails.logger.info "reset name cache to prevent encoding freakiness"
+    end
+    raise e
+  end
+end

data/set/all/html_title.rb ADDED

@@ -0,0 +1,47 @@
+format do
+  view :title, compact: true, perms: :none do
+    standard_title
+  end
+  def standard_title
+    name_variant title_in_context(voo.title)
+  end
+end
+format :html do
+  view :title do
+    show_view?(:title_link, :hide) ? render_title_link : render_title_no_link
+  end
+  view :title_link, compact: true, perms: :none do
+    link_to_card card.name, render_title_no_link
+  end
+  view :title_no_link, compact: true, perms: :none do
+    wrapped_title standard_title
+  end
+  def title_with_link link_text
+    link_to_card card.name, link_text
+  end
+  def safe_name
+    h super
+  end
+  def title_in_context title=nil
+    title = title&.html_safe
+    # escape titles generated from card names, but not those set explicitly
+    h super(title)
+  end
+  def wrapped_title title
+    wrap_with :span, class: classy("card-title"), title: title do
+      title.to_name.parts.join wrapped_joint
+    end
+  end
+  def wrapped_joint
+    wrap_with :span, "+", classy("joint")
+  end
+end

data/set/all/html_wrapper.rb ADDED

@@ -0,0 +1,159 @@
+format :html do
+  # Does two main things:
+  # (1) gives CSS classes for styling and
+  # (2) adds card data for javascript - including the "card-slot" class,
+  #     which in principle is not supposed to be in styles
+  def wrap slot=true, slot_attr={}, tag=:div, &block
+    attrib = slot_attributes slot, slot_attr
+    method_wrap :wrap_with, tag, attrib, &block
+  end
+  wrapper :slot do |opts|
+    class_up "card-slot", opts[:class] if opts[:class]
+    attrib = slot_attributes true, opts
+    method_wrap(:wrap_with, :div, attrib) { interior }
+  end
+  def haml_wrap slot=true, slot_attr={}, tag=:div, &block
+    attrib = slot_attributes slot, slot_attr
+    method_wrap :haml_tag, tag, attrib, &block
+  end
+  def method_wrap method, tag, attrib, &block
+    @slot_view = @current_view
+    debug_slot { send method, tag, attrib, &block }
+  end
+  def slot_attributes slot, slot_attr
+    { id: slot_id, class: wrap_classes(slot), data: wrap_data }.tap do |hash|
+      add_class hash, slot_attr.delete(:class)
+      hash.deep_merge! slot_attr
+    end
+  end
+  def slot_id
+    "#{card.name.safe_key}-#{@current_view}-view"
+  end
+  def wrap_data slot=true
+    with_slot_data slot do
+      { "card-id": card.id, "card-name": slot_cardname, "slot-id": SecureRandom.hex(10) }
+    end
+  end
+  def slot_cardname
+    name = card.name
+    name = card.new? && name.compound? ? name.url_key : name
+    h name
+  end
+  def with_slot_data slot
+    hash = yield
+    # rails helper convert slot hash to json
+    # but haml joins nested keys with a dash
+    hash[:slot] = slot_options_json if slot
+    hash
+  end
+  def slot_options_json
+    html_escape_except_quotes JSON(slot_options)
+  end
+  def slot_options
+    options = voo ? voo.slot_options : {}
+    name_context_slot_option options
+    options
+  end
+  def name_context_slot_option opts
+    return unless initial_context_names.present?
+    opts[:name_context] = initial_context_names.map(&:key) * ","
+  end
+  def debug_slot
+    debug_slot? ? debug_slot_wrap { yield } : yield
+  end
+  def debug_slot?
+    params[:debug] == "slot"
+  end
+  def debug_slot_wrap
+    pre = "<!--\n\n#{'  ' * depth}"
+    post = " SLOT: #{h card.name}\n\n-->"
+    [pre, "BEGIN", post, yield, pre, "END", post].join
+  end
+  def wrap_classes slot
+    list = slot ? ["card-slot"] : []
+    list += ["#{@current_view}-view", card.safe_set_keys]
+    list << "STRUCTURE-#{voo.structure.to_name.key}" if voo&.structure
+    classy list
+  end
+  def wrap_body
+    wrap_with(:div, class: body_css_classes) { yield }
+  end
+  def haml_wrap_body
+    wrap_body do
+      capture_haml { yield }
+    end
+  end
+  def body_css_classes
+    css_classes = ["d0-card-body"]
+    css_classes += ["d0-card-content", card.safe_set_keys] if @content_body
+    classy(*css_classes)
+  end
+  def wrap_main
+    return yield if no_main_wrap?
+    wrap_with :div, yield, id: "main"
+  end
+  def no_main_wrap?
+    Env.ajax? || params[:layout] == "none"
+  end
+  def wrap_with tag, content_or_args={}, html_args={}, &block
+    tag_args = block_given? ? content_or_args : html_args
+    content_tag(tag, tag_args) { content_within_wrap content_or_args, &block }
+  end
+  def wrap_each_with tag, content_or_args={}, args={}, &block
+    tag_args = block_given? ? content_or_args : args
+    content_items_within_wrap(content_or_args, args, &block).map do |item|
+      wrap_with(tag, tag_args) { item }
+    end.join "\n"
+  end
+  private
+  def content_items_within_wrap content, args
+    content = block_given? ? yield(args) : content
+    content.compact
+  end
+  def content_within_wrap content
+    content = block_given? ? yield : content
+    output(content).to_s.html_safe
+  end
+  def html_escape_except_quotes string
+    # to be used inside single quotes (makes for readable json attributes)
+    string.to_s.gsub(/&/,  "&amp;")
+          .gsub(/\'/, "&apos;")
+          .gsub(/>/,  "&gt;")
+          .gsub(/</,  "&lt;")
+  end
+  wrapper :div, :div
+  wrapper :em, :em
+  wrapper :none do
+    interior
+  end
+end

data/set/all/js.rb ADDED

@@ -0,0 +1,10 @@
+format :js do
+  def default_item_view
+    :core
+  end
+  view :source do
+    path format: :js
+  end
+end

data/set/all/json.rb ADDED

@@ -0,0 +1,166 @@
+format :json do
+  # because card.item_cards returns "[[#{self}]]"
+  def item_cards
+    nested_cards
+  end
+  def default_nest_view
+    :atom
+  end
+  def default_item_view
+    params[:item] || :name
+  end
+  def max_depth
+    params[:max_depth].present? ? params[:max_depth].to_i : 1
+  end
+  # TODO: support layouts in json
+  # eg layout=stamp gives you the metadata currently in "page" view
+  # and layout=none gives you ONLY the requested view (default atom)
+  def show view, args
+    view ||= :molecule
+    string_with_page_details do
+      render! view, args
+    end
+  end
+  def string_with_page_details
+    raw = yield
+    return raw if raw.is_a? String
+    stringify page_details(raw)
+  end
+  def stringify raw
+    method = params[:compress] ? :generate : :pretty_generate
+    JSON.send method, raw
+  end
+  def page_details obj
+    return obj unless obj.is_a? Hash
+    obj.merge url: request_url, timestamp: Time.now.to_s
+  end
+  view :status, unknown: true, perms: :none do
+    { key: card.key,
+      url_key: card.name.url_key,
+      status: card.state }.tap do |h|
+      h[:id] = card.id if h[:status] == :real
+    end
+  end
+  def request_url
+    controller.request&.original_url || path
+  end
+  view :core, unknown: true do
+    card.known? ? render_content : nil
+  end
+  view :content do
+    card.content
+  end
+  view :nucleus do
+    nucleus
+  end
+  # TODO: add simple values for fields
+  view :atom, unknown: true do
+    atom
+  end
+  view :molecule do
+    molecule
+  end
+  view :page, cache: :never do
+    page_details card: render_atom
+  end
+  # NOCACHE because sometimes item_cards is dynamic.
+  # could be safely cached for non-dynamic lists
+  view :items, cache: :never do
+    listing item_cards, view: :atom
+  end
+  view :links do
+    card.link_chunks.map do |chunk|
+      if chunk.referee_name
+        path mark: chunk.referee_name, format: :json
+      else
+        link_to_resource chunk.link_target
+      end
+    end
+  end
+  view :ancestors do
+    card.name.ancestors.map do |name|
+      nest name, view: :nucleus
+    end
+  end
+  # minimum needed to re-fetch card
+  view :cast do
+    card.cast
+  end
+  ## DEPRECATED
+  view :marks do
+    {
+      id: card.id,
+      name: card.name,
+      key: card.key,
+      url: path
+    }
+  end
+  view :essentials do
+    if voo.show? :marks
+      render_marks.merge(essentials)
+    else
+      essentials
+    end
+  end
+  def essentials
+    return {} if card.structure
+    { content: card.db_content }
+  end
+  # NOTE: moving these to methods prevents potential caching problems, because other
+  # views manipulate their hashes.
+  #
+  def nucleus
+    { id: card.id,
+      name: card.name,
+      type: card.type_name,
+      url: path(format: :json) }.tap do |h|
+      h[:codename] = card.codename if card.codename
+    end
+  end
+  def atom
+    nucleus.tap do |h|
+      h[:content] = render_content if card.known? && !card.structure
+    end
+  end
+  def molecule
+    atom.merge items: _render_items,
+               links: _render_links,
+               ancestors: _render_ancestors,
+               html_url: path,
+               type: nest(card.type_card, view: :nucleus)
+  end
+end
+# TODO: perhaps this should be in a general "data" module.
+def cast
+  real? ? { id: id } : { name: name, type_id: type_id, content: db_content }
+end