card 1.97.0.1 → 1.98.0

data/tmpsets/set/mod006-basic_formats/all/file.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (File)
+#
+module File;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/file.rb"; end
+module FileFormat; parent.send :register_set_format, Card::Format::FileFormat, self; extend Card::Set::AbstractFormat
+  view :core do
+    "File rendering of this card not yet supported"
+  end
+
+  view :style do
+    nil
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/file.rb ~~

data/tmpsets/set/mod006-basic_formats/all/head.rb

@@ -0,0 +1,155 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (Head)
+#
+module Head;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/head.rb"; end
+module Format; parent.send :register_set_format, Card::Format, self; extend Card::Set::AbstractFormat
+  view :page_title, unknown: true, perms: :none do
+    [(safe_name if card.name.present?), Card.global_setting(:title)].compact.join " - "
+  end
+end
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  # add tuples containing a
+  #  - the codename of a card with javascript config (usually in json format)
+  #  - the name of a javascript method that handles the config
+  basket :mod_js_config
+
+  view :head, unknown: true, perms: :none do
+    views_in_head.map { |viewname| render viewname }.flatten.compact.join "\n"
+  end
+
+  def views_in_head
+    %i[meta_tags page_title_tag favicon_tag head_stylesheet
+       decko_script_variables head_javascript html5shiv_tag
+       script_config_and_initiation
+       universal_edit_button rss_links]
+  end
+
+  # FIXME: tags not working with `template: :haml`
+  view :meta_tags, unknown: true, perms: :none do
+    haml :meta_tags
+  end
+
+  view :html5shiv_tag, unknown: true, perms: :none do
+    nest :script_html5shiv_printshiv, view: :script_tag
+  end
+
+  view :page_title_tag, unknown: true, perms: :none do
+    content_tag(:title) { render :page_title }
+  end
+
+  view :favicon_tag, unknown: true, perms: :none do
+    nest :favicon, view: :link_tag
+  end
+
+  view :universal_edit_button, unknown: true, denial: :blank, perms: :update do
+    return if card.new?
+    tag "link", rel: "alternate", type: "application/x-wiki",
+                title: "Edit this page!", href: path(view: :edit)
+  end
+
+  # these should render a view of the rule card
+  # it would then be safe to cache if combined with param handling
+  # (but note that machine clearing would need to reset card cache...)
+  view :head_stylesheet, unknown: true, cache: :never, perms: :none do
+    return unless (href = head_stylesheet_path)
+    tag "link", href: href, media: "all", rel: "stylesheet", type: "text/css"
+  end
+
+  view :head_javascript, unknown: true, cache: :never, perms: :none do
+    Array.wrap(head_javascript_paths).map do |path|
+      javascript_include_tag path
+    end
+  end
+
+  view :decko_script_variables, unknown: true, cache: :never, perms: :none do
+    string = ""
+    decko_script_variables.each do |k, v|
+      string += "#{k}=#{script_variable_to_js v};\n"
+    end
+    javascript_tag { string }
+  end
+
+  def decko_script_variables
+    {
+      "window.decko": { rootUrl: card_url("") },
+      "decko.doubleClick": Card.config.double_click,
+      "decko.cssPath": head_stylesheet_path,
+      "decko.currentUserId": (Auth.current_id if Auth.signed_in?)
+
+    }
+  end
+
+  def script_variable_to_js value
+    if value.is_a? Hash
+      string = "{"
+      value.each { |k, v| string += "#{k}:#{script_variable_to_js v}" }
+      string + "}"
+    else
+      "'#{value}'"
+    end
+  end
+
+  def param_or_rule_card setting
+    if params[setting]
+      Card[params[setting]]
+    else
+      root.card.rule_card setting
+    end
+  end
+
+  def debug_or_machine_path setting, &block
+    return unless (asset_card = param_or_rule_card setting)
+    debug_path(setting, asset_card, &block) || asset_card.machine_output_url
+  end
+
+  def debug_path setting, asset_card
+    return unless params[:debug] == setting.to_s
+    yield asset_card
+  end
+
+  def head_stylesheet_path
+    debug_or_machine_path :style do |style_card|
+      path mark: style_card.name, item: :import, format: :css
+    end
+  end
+
+  def head_javascript_paths
+    debug_or_machine_path :script do |script_card|
+      script_card.item_cards.map do |script|
+        script.format(:js).render :source
+      end
+    end
+  end
+
+  view :script_config_and_initiation, unknown: true, perms: :none do
+    javascript_tag do
+      (mod_js_configs << trigger_slot_ready).join "\n\n"
+    end
+  end
+
+  def mod_js_configs
+    mod_js_config.map do |codename, js_decko_function|
+      config_json = escape_javascript Card.global_setting(codename)
+      "decko.#{js_decko_function}('#{config_json}')"
+    end
+  end
+
+  def trigger_slot_ready
+    "$('document').ready(function() { $('.card-slot').trigger('slotReady'); })"
+  end
+
+  # TODO: move to rss mod
+  view :rss_links, unknown: true, perms: :none do
+    render :rss_link_tag if rss_link?
+  end
+
+  def rss_link?
+    Card.config.rss_enabled && respond_to?(:rss_link_tag)
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/head.rb ~~

data/tmpsets/set/mod006-basic_formats/all/json.rb

@@ -0,0 +1,161 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (Json)
+#
+module Json;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/json.rb"; end
+module JsonFormat; parent.send :register_set_format, Card::Format::JsonFormat, self; extend Card::Set::AbstractFormat
+  # because card.item_cards returns "[[#{self}]]"
+  def item_cards
+    uniq_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
+    raw = render! view, args
+    return raw if raw.is_a? String
+    method = params[:compress] ? :generate : :pretty_generate
+    JSON.send method, raw
+  end
+
+  view :status, unknown: true, perms: :none do
+    status = card.state
+    hash = { key: card.key,
+             url_key: card.name.url_key,
+             status: status }
+    hash[:id] = card.id if status == :real
+    hash
+  end
+
+  # NOCACHE because of timestamp
+  view :page, cache: :never do
+    { url: request_url,
+      timestamp: Time.now.to_s,
+      card: _render_atom }
+  end
+
+  def request_url
+    req = controller.request
+    req ? req.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
+
+  # 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
+    h = { id: card.id,
+          name: card.name,
+          type: card.type_name,
+          url: path(format: :json) }
+    h[:codename] = card.codename if card.codename
+    h
+  end
+
+  def atom
+    h = nucleus
+    h[:content] = render_content if card.known? && !card.structure
+    h
+  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
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/json.rb ~~

data/tmpsets/set/mod006-basic_formats/all/rss.rb

@@ -0,0 +1,85 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (Rss)
+#
+module Rss;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/rss.rb"; end
+module RssFormat; parent.send :register_set_format, Card::Format::RssFormat, self; extend Card::Set::AbstractFormat
+  attr_accessor :xml
+
+  def initialize card, args
+    super
+    @xml = @parent ? @parent.xml : ::Builder::XmlMarkup.new
+  end
+
+  def show view, args
+    view ||= :feed
+    render! view, args
+  end
+
+  # FIXME: integrate this with common XML features when it is added
+  view :feed, cache: :never do
+    return "RSS feeds disabled" unless Cardio.config.rss_enabled
+    begin
+      @xml.instruct! :xml, version: "1.0", standalone: "yes"
+      @xml.rss version: "2.0",
+               "xmlns:content" => "http://purl.org/rss/1.0/modules/content/" do
+        @xml.channel do
+          @xml.title       render_feed_title
+          @xml.description render_feed_description
+          @xml.link        render_url
+          render_feed_body
+        end
+      end
+    rescue => e
+      @xml.error "\n\nERROR rendering RSS: #{e.inspect}\n\n #{e.backtrace}"
+    end
+  end
+
+  def raw_feed_items
+    [card]
+  end
+
+  view :feed_body, cache: :never do
+    raw_feed_items.each do |item|
+      @xml.item do
+        subformat(item).render! :feed_item
+      end
+    end
+  end
+
+  view :feed_title do
+    Card.global_setting(:title) + " : " + card.name.gsub(/^\*/, "")
+  end
+
+  view :feed_item do
+    @xml.title card.name
+    add_name_context
+    @xml.description render_feed_item_description
+    @xml.pubDate pub_date
+    @xml.link render_url
+    @xml.guid render_url
+  end
+
+  def pub_date
+    (card.updated_at || Time.zone.now).to_s(:rfc822)
+    # updated_at fails on virtual
+    # cards, because not all to_s's take args (just actual dates)
+  end
+
+  view :feed_item_description do
+    render_open_content
+  end
+
+  view :feed_description do "" end
+  view :comment_box      do "" end
+  view :menu             do "" end
+
+  view :open,         :titled, mod: All::Base::Format
+  view :content,      :core,   mod: All::Base::Format
+  view :open_content, :core,   mod: All::Base::Format
+  view :closed,       :link,   mod: All::Base::Format
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/rss.rb ~~

data/tmpsets/set/mod006-basic_formats/all/text.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (Text)
+#
+module Text;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/text.rb"; end
+
+module TextFormat; parent.send :register_set_format, Card::Format::TextFormat, self; extend Card::Set::AbstractFormat
+  view :core do
+    HTMLEntities.new.decode strip_tags(super()).to_s
+    # need this string method to get out of html_safe mode
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_formats/set/all/text.rb ~~

data/tmpsets/set/mod006-basic_formats/self/head.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self
+# Set: The card "Head"
+#
+module Head;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_formats/set/self/head.rb"; end
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  # when *head is rendered in the main body of a page, we escape the HTML
+  # otherwise (most typically in the head tag, of course), we render the
+  # HTML unescaped
+  view :core, cache: :never do
+    escape_in_main do
+      nest root.card, view: :head
+      # note that the head tag for each card is different
+      # (different title, different style rules, etc)
+      # so we don't cache the core of *head, but we _do_ cache some
+      # views within each head (see all/head.rb)
+    end
+  end
+
+  view :editor do
+    "Content is can't be edited."
+  end
+
+  def escape_in_main
+    main? ? (h yield) : yield
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_formats/set/self/head.rb ~~