card-mod-format 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef6d2c7a456c6e35591c10a980bc93de5b970d87d88bc6af9518acc0f314a6cc
+  data.tar.gz: d1f9e4f0ce72e65f79d8bf35391e95954317647628cbb342eb7617304fe9966c
+SHA512:
+  metadata.gz: 53c0aef92bdd7fded5ff0a237d6d95aa1460a3612a9ec56a43e232be697ce627fffc69542ccdd3f2554d1f16df01f58459a85f575dc791981a906267b5d72c96
+  data.tar.gz: 74a7614d7a49a49e46fedc2f2064f523de67f98a88a9f06740dbe8f024edfa9a3dc3658a5e4cc4a7c0c137a8eebc783e3d9e4d6987aba658526d68d2d032992e

data/lib/card/format/css_format.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class CssFormat < Format
+      register :css
+
+      def mime_type
+        "text/css"
+      end
+
+      def self.view_caching?
+        false
+      end
+    end
+  end
+end

data/lib/card/format/csv_format.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class CsvFormat < TextFormat
+      register :csv
+
+      def mime_type
+        "text/comma-separated-values"
+      end
+
+      def self.view_caching?
+        # TODO: make view caching handle non-strings
+        # (specifically stub_render)
+        false
+      end
+    end
+  end
+end

data/lib/card/format/data_format.rb

@@ -0,0 +1,6 @@
+class Card
+  class Format
+    class DataFormat < Format
+    end
+  end
+end

data/lib/card/format/file_format.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class FileFormat < Format
+    end
+  end
+end

data/lib/card/format/html_format.rb

@@ -0,0 +1,45 @@
+# -*- encoding : utf-8 -*-
+
+# # require "card/content/diff"
+
+class Card
+  class Format
+    # Main Format class for formatting card views in HTML
+    class HtmlFormat < Format
+      register :html
+
+      attr_accessor :options_need_save, :start_time, :skip_autosave
+
+      def main?
+        !@main.nil?
+      end
+
+      # is the current card the requested card?
+      def focal?
+        @focal ||= show_layout? ? main? : depth.zero?
+      end
+
+      def default_nest_view
+        # FIXME: not sure this makes sense as a rule...
+        card.rule(:default_html_view) || :titled
+      end
+
+      def default_item_view
+        :bar
+      end
+
+      def escape_literal literal
+        "<span>#{literal}</span>"
+      end
+
+      def mime_type
+        "text/html"
+      end
+
+      def final_render_call method
+        rendered = super
+        rendered.is_a?(Array) ? output(rendered) : rendered
+      end
+    end
+  end
+end

data/lib/card/format/js_format.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class JsFormat < Format
+      register :js
+
+      def self.view_caching?
+        false
+      end
+
+      def mime_type
+        "text/javascript"
+      end
+    end
+  end
+end

data/lib/card/format/json_format.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class JsonFormat < DataFormat
+      register :json
+
+      def mime_type
+        "text/json"
+      end
+
+      def expand_stubs content
+        case content
+        when Hash
+          content.each { |k, v| content[k] = expand_stubs v }
+        when Array
+          content.map { |item| expand_stubs item }
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/card/format/rss_format.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class RssFormat < HtmlFormat
+      register :rss
+    end
+  end
+end

data/lib/card/format/text_format.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class TextFormat < Format
+      register :text
+      register :txt
+      aliases["txt"] = "text"
+
+      def self.view_caching?
+        # probably overkill.  problem was with email text message
+        false
+      end
+    end
+  end
+end

data/lib/card/format/xml_format.rb

@@ -0,0 +1,13 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    class XmlFormat < DataFormat
+      register :xml
+
+      def mime_type
+        "text/xml"
+      end
+    end
+  end
+end

data/lib/card/path.rb

@@ -0,0 +1,127 @@
+class Card
+  # Generate standard card paths.
+  class Path
+    cattr_accessor :cast_params
+    self.cast_params = { slot: { hide: :array, show: :array, wrap: :array } }.freeze
+
+    def initialize card, opts
+      @card = card
+      @opts = opts
+    end
+
+    def render
+      new_cardtype || standard
+    end
+
+    private
+
+    attr_reader :opts
+
+    def action
+      @action ||= opts.delete(:action)&.to_sym
+    end
+
+    def new_cardtype
+      return unless new_cardtype?
+
+      "#{action}/#{mark}#{query}"
+    end
+
+    def new_cardtype?
+      return false unless action.in? %i[new type]
+
+      # "new" and "type" are not really an action and are only
+      # a valid value here for this path
+      opts[:mark].present?
+    end
+
+    def standard
+      base + extension + query
+    end
+
+    def base
+      explicit_action? ? action_base : mark
+    end
+
+    def action_base
+      mark.present? ? "#{action}/#{mark}" : "card/#{action}"
+      # the card/ prefix prevents interpreting action as cardname
+    end
+
+    def explicit_action?
+      action.in? %i[create update delete]
+    end
+
+    def mark
+      @mark ||= (markless? ? "" : interpret_mark)
+    end
+
+    def interpret_mark
+      name = handle_unknown do
+        opts[:mark] ? Card::Name[opts.delete(:mark)] : @card.name
+      end
+      name.url_key
+    end
+
+    def markless?
+      action == :create || no_mark?
+    end
+
+    def no_mark?
+      @no_mark ||= opts.delete :no_mark
+    end
+
+    def extension
+      extension = opts.delete :format
+      extension ? ".#{extension}" : ""
+    end
+
+    def query
+      query_opts = cast_path_hash opts
+      query_opts.empty? ? "" : "?#{query_opts.to_param}"
+    end
+
+    # normalizes certain path opts to specified data types
+    def cast_path_hash hash, cast_hash=nil
+      return hash unless hash.is_a? Hash
+      cast_each_path_hash hash, (cast_hash || self.class.cast_params)
+      hash
+    end
+
+    def cast_each_path_hash hash, cast_hash
+      hash.each do |key, value|
+        next unless (cast_to = cast_hash[key])
+        hash[key] = cast_path_value value, cast_to
+      end
+    end
+
+    def cast_path_value value, cast_to
+      if cast_to.is_a? Hash
+        cast_path_hash value, cast_to
+      else
+        send "cast_path_value_as_#{cast_to}", value
+      end
+    end
+
+    def cast_path_value_as_array value
+      Array.wrap value
+    end
+
+    def handle_unknown
+      yield.tap do |name|
+        return name if name_specified? || name_standardish?(name) || Card.known?(name)
+        opts[:card] ||= {}
+        opts[:card][:name] = name
+      end
+    end
+
+    def name_specified?
+      opts.dig :card, :name
+    end
+
+    # no name info will be lost by using url_key
+    def name_standardish? name
+      name.s == Card::Name.url_key_to_standard(name.url_key)
+    end
+  end
+end

data/set/all/active_card.rb

@@ -0,0 +1,6 @@
+
+# FIXME: -this needs a better home!
+def format opts={}
+  opts = { format: opts.to_sym } if [Symbol, String].member? opts.class
+  Card::Format.new self, opts
+end

data/set/all/base.rb

@@ -0,0 +1,137 @@
+format do
+  def show view, args
+    view ||= :core
+    render! view, args.merge(main_nest_options)
+  end
+
+  # NAME VIEWS
+
+  view :name, compact: true, perms: :none do
+    name_variant safe_name
+  end
+
+  def safe_name
+    card&.name
+  end
+
+  def name_variant name
+    voo.variant ? name.to_name.vary(voo.variant) : name
+  end
+
+  view(:key,      compact: true, perms: :none) { card.key }
+  view(:linkname, compact: true, perms: :none) { card.name.url_key }
+  view(:url,      compact: true, perms: :none) { card_url _render_linkname }
+
+  view :url_link, compact: true, perms: :none do
+    link_to_resource card_url(_render_linkname)
+  end
+
+  view :link, compact: true, perms: :none do
+    link_view
+  end
+
+  view :nav_link, compact: true, perms: :none do
+    link_view class: "nav-link"
+  end
+
+  def link_view opts={}
+    opts[:known] = card.known?
+    specify_type_in_link! opts
+    link_to_card card.name, _render_title, opts
+  end
+
+  def specify_type_in_link! opts
+    return if opts[:known] || !voo.type
+    opts[:path] = { card: { type: voo.type } }
+  end
+
+  view(:codename, compact: true) { card.codename.to_s }
+  view(:id,       compact: true) { card.id            }
+  view(:type,     compact: true) { card.type_name     }
+
+  # DATE VIEWS
+
+  view(:created_at, compact: true) { date_view card.created_at }
+  view(:updated_at, compact: true) { date_view card.updated_at }
+  view(:acted_at,   compact: true) { date_view card.acted_at   }
+
+  def date_view date
+    if voo.variant
+      date.strftime voo.variant
+    else
+      time_ago_in_words date
+    end
+  end
+
+  # CONTENT VIEWS
+
+  view :raw do
+    structure_card&.content || _render_blank
+  end
+
+  def structure_card
+    return nil if voo.structure == true
+    voo.structure ? Card[voo.structure] : card
+  end
+
+  view :core, compact: true do
+    process_content _render_raw
+  end
+
+  view :content do
+    _render_core
+  end
+
+  view :open_content do
+    _render_core
+  end
+
+  view :one_line_content, compact: true do
+    with_nest_mode :compact do
+      Card::Content.smart_truncate _render_core
+    end
+  end
+
+  view :labeled_content, unknown: :mini_unknown do
+    render_core
+  end
+
+  view :titled_content, unknown: :blank do
+    render_core
+  end
+
+  view :blank, compact: true, perms: :none do
+    ""
+  end
+
+  # note: content and open_content may look like they should be aliased to
+  # core, but it's important that they render core explicitly so that core view
+  # overrides work.  the titled and labeled views below, however, are not
+  # intended for frequent override, so this shortcut is fine.
+
+  # NAME + CONTENT VIEWS
+
+  view :titled do
+    "#{card.name}\n\n#{_render_core}"
+  end
+  view :open, :titled
+
+  view :labeled do
+    "#{card.name}: #{_render_labeled_content}"
+  end
+  view :closed, :labeled
+
+  # SPECIAL VIEWS
+
+  view :array, cache: :never do
+    card.item_cards(limit: 0).map do |item_card|
+      subformat(item_card)._render_core
+    end.inspect
+  end
+
+  # DEPRECATED
+  view :naked do
+    Rails.logger.info "DEPRECATED: naked view (used with #{card.name} card)"
+    render_core
+  end
+end