card-mod-format 0.13.2 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b5eba52fcc743e248f18a00a831e82ff2c26c7b39971e4cbf51157e526e570c
-  data.tar.gz: c384fb08ea3a69ee0403ce37f3f388b2ec70bc31af3152158d4feff719f4b702
+  metadata.gz: 6dc960bb48dd11ee9c71a5c8b570b93e626be8608eed453410bcdbae6d02c362
+  data.tar.gz: c98318fd72600cd4a66c40af08c23a638cd80040eda0017cc625bcad29cae281
 SHA512:
-  metadata.gz: 49e90f15050ccc0b22bc8cb36785c0e97c0ae92ba1f973db21dba261e4d175f5af39fc2af944aea7bb90fc0347062c59e70ce5bbf5ace98230e78728b53c29d0
-  data.tar.gz: caed17f4e4161215445a67e0f9a15ed38dd772b54ea1deb909935211446c965d0fb239f037e87c8a5d7815619f9360790d024456b09d8a574a2db4ea5fddb7ae
+  metadata.gz: '015682b9e06d33fea65eba7ffcdf165054e8f076aa941378f21aa2744ea05afb63abf39fe1a0f77230f9e76f64fbc0e597aab42d8bcdb4a20908b6c87bba1a35'
+  data.tar.gz: 827a8b652a37e1435f82e83e18fa1b968e0a5906baf56544c9ac98a0ef82227fee91b8e3a20d5e59a8152c3ebea122e45b68a4b85d0ac983096325b7bec936c7

data/lib/card/format/html_format.rb

@@ -19,15 +19,6 @@ class Card
         @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

data/lib/card/format/scss_format.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    # Scss format
+    class ScssFormat < CssFormat
+      register :scss
+
+      def mime_type
+        "text/x-scss"
+      end
+
+      def self.view_caching?
+        false
+      end
+    end
+  end
+end

data/lib/card/format/yaml_format.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  class Format
+    # base class for rendering in YAML (Yet Another Markup Language)
+    class YamlFormat < DataFormat
+      register :yaml
+      register :yml
+      aliases["yml"] = "yaml"
+
+      def mime_type
+        "text/x-yaml"
+      end
+    end
+  end
+end

data/lib/card/path.rb

@@ -35,7 +35,8 @@ class Card
     end
 
     def standard
-      base + extension + query
+      anch = anchor
+      base + extension + query + anch
     end
 
     def base
@@ -75,6 +76,11 @@ class Card
       extension ? ".#{extension}" : ""
     end
 
+    def anchor
+      anchor = opts.delete :anchor
+      anchor ? "##{anchor}" : ""
+    end
+
     def query
       query_opts = cast_path_hash opts
       query_opts.empty? ? "" : "?#{query_opts.to_param}"

data/locales/de.yml

@@ -0,0 +1,23 @@
+de:
+  format_add_card: "%{cardname} hinzufügen"
+  format_bad_address: "404: Ungültige Adresse"
+  format_close: Schließen
+  format_configure_card: "%{cardname} konfigurieren"
+  format_denial: Erlaubnis abgelehnt
+  format_denied_task: to %{denied_task} this
+  format_invalid_json: ungültiges json
+  format_need_permission_task: "Sie brauchen Erlaubnis %{task}."
+  format_not_found_named: Konnte %{cardname} nicht finden.
+  format_not_found_no_name: die angeforderte Karte
+  format_not_numeric: "'%{content}' ist nicht numerisch"
+  format_or: "oder"
+  format_please: Bitte
+  format_problems_name: Probleme mit %{cardname}
+  format_read_only: Wir sind derzeit im Nur-Lese-Modus. Bitte versuchen Sie es später noch einmal.
+  format_server_error: "\nServer Fehler. Ups, entschuldige bitte.\nUm uns den Fehler mitzuteilen und über eine Lösung informiert zu werden,\nerstelle ein Support-Ticket %{ticket_link}\n"
+  format_sorry: Sorry!
+  format_to_do_that: um das zu tun
+  format_toggle_no: "nein"
+  format_toggle_yes: "ja"
+  format_too_deep: Du bist zu tief.  (Zu viele verschachtelte Nester aufeinmal)
+  format_unsupported_view: Ansicht (%{view}) wird nicht unterstützt für %{cardname}

data/locales/en.yml

@@ -14,7 +14,7 @@ en:
   format_please: Please
   format_problems_name: Problems with %{cardname}
   format_read_only: We are currently in read-only mode.  Please try again later.
-  format_server_error: "\nWagn Hitch!  Server Error. Yuck, sorry about that.\nTo tell us more and follow the fix,\nadd a support ticket at %{ticket_link}\n"
+  format_server_error: "\nServer Error. Yuck, sorry about that.\nTo tell us more and follow the fix,\nadd a support ticket at %{ticket_link}\n"
   format_sorry: Sorry!
   format_to_do_that: to do that
   format_toggle_no: "no"

data/set/all/base.rb

@@ -1,3 +1,8 @@
+def format opts={}
+  opts = { format: opts.to_sym } if [Symbol, String].member? opts.class
+  Card::Format.new self, opts
+end
+
 format do
   def show view, args
     view ||= :core
@@ -130,10 +135,4 @@ format do
       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

data/set/all/data.rb

@@ -0,0 +1,110 @@
+def cast
+  real? ? { id: id } : { name: name, type_id: type_id, content: db_content }
+end
+
+def export_hash field_tags: []
+  { name: export_name,
+    type: export_type,
+    codename: codename,
+    content: export_content,
+    subfields: export_subfields(field_tags) }.compact_blank
+end
+
+def export_subfields marks
+  marks.each_with_object({}) do |mark, hash|
+    hash[mark] = [name, mark].card&.export_content
+  end.compact_blank
+end
+
+def export_type
+  type_name.codename_or_string
+end
+
+def export_name
+  simple? ? name.s : name.part_names.map(&:codename_or_string)
+end
+
+def export_content
+  structure ? nil : db_content
+end
+
+format :data do
+  view :export do
+    card.export_hash
+  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 :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
+
+  # NOCACHE because sometimes item_cards is dynamic.
+  # could be safely cached for non-dynamic lists
+  view :items, cache: :never do
+    listing item_cards, view: (voo_items_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
+
+  # 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),
+               created_at: card.created_at,
+               updated_at: card.updated_at
+  end
+end

data/set/all/error.rb

@@ -50,7 +50,7 @@ format do
   end
 
   def unsupported_view_error_message view
-    t(:format_unsupported_view, view: view, cardname: card.name)
+    t :format_unsupported_view, view: view, cardname: card.name
   end
 end
 

data/set/all/{html_error.rb → html/error.rb}

@@ -21,8 +21,9 @@ format :html do
   end
 
   def unknown_link text
-    path_opts = voo.type ? { card: { type: voo.type } } : {}
-    link_to_view :new_in_modal, text, path: path_opts, class: classy("unknown-link")
+    link_to_view :new_in_modal, text,
+                 path: (voo.type ? { card: { type: voo.type } } : {}),
+                 class: classy("unknown-link")
   end
 
   def unknown_icon
@@ -63,7 +64,7 @@ format :html do
     standard_errors voo.title
   end
 
-  view :not_found do
+  view :not_found, cache: :never do
     voo.hide! :menu
     voo.title = "Not Found"
     frame do
@@ -75,7 +76,7 @@ format :html do
     focal? ? loud_denial : quiet_denial
   end
 
-  def view_for_unknown view
+  def view_for_unknown setting_view
     main? && ok?(:create) ? :new : super
   end
 

data/set/all/{head.rb → html/head.rb}

@@ -7,11 +7,6 @@ format do
 end
 
 format :html do
-  # 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
@@ -61,7 +56,7 @@ format :html do
   def debug_or_machine_path setting, debug_lambda, machine_path_lambda
     return unless (asset_card = param_or_rule_card setting)
     debug_path(setting, asset_card, &debug_lambda) ||
-      machine_path_lambda.call(asset_card.machine_output_url)
+      machine_path_lambda.call(asset_card.asset_output_url)
   end
 
   def debug_path setting, asset_card

data/set/all/html/show.rb

@@ -0,0 +1,31 @@
+format :html do
+  def show view, args
+    content = send show_method, view, args
+    Env.ajax? ? content : wrap_with_html_page(content)
+  end
+
+  wrapper :html_page do
+    <<-HTML.strip_heredoc
+      <!DOCTYPE HTML>
+      <html class="h-100">
+        <head>
+          #{nest card.rule_card(:head), view: :head_content}
+        </head>
+        #{interior}
+      </html>
+    HTML
+  end
+
+  private
+
+  def show_without_page_layout view, args
+    @main = true if params[:is_main] || args[:main]
+    args.delete(:layout)
+    view ||= args[:home_view] || default_page_view
+    render! view, args
+  end
+
+  def show_method
+    "show_#{show_layout? ? :with : :without}_page_layout"
+  end
+end

data/set/all/{html_content.rb → html/views.rb}

@@ -13,7 +13,7 @@ format :html do
     end
   end
 
-  before(:content_with_edit_button) do
+  before :content_with_edit_button do
     prepare_content_slot
   end
 
@@ -64,8 +64,7 @@ format :html do
       [
         naming { render_header },
         render_flash,
-        wrap_body { render_titled_content },
-        render_comment_box(optional: :hide)
+        wrap_body { render_titled_content }
       ]
     end
   end
@@ -91,9 +90,7 @@ format :html do
     toggle_logic
     @toggle_mode = :open
     @content_body = true
-    frame do
-      [_render_open_content, render_comment_box(optional: :hide)]
-    end
+    frame { _render_open_content }
   end
 
   view :closed do

data/set/all/{rich_html.rb → html.rb}

@@ -13,4 +13,13 @@ format :html do
       link_to_card card.type_name, nil, class: "navbar-link"
     end
   end
+
+  def default_nest_view
+    :titled
+    # card.rule(:default_html_view) || :titled
+  end
+
+  def default_item_view
+    :bar
+  end
 end

data/set/all/json.rb

@@ -26,24 +26,6 @@ format :json do
     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, requested_at: Time.now.to_s
-  end
-
   view :status, unknown: true, perms: :none do
     { key: card.key,
       url_key: card.name.url_key,
@@ -52,116 +34,31 @@ format :json do
     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: (voo_items_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
+  private
 
-  # 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
+  def request_url
+    controller.request&.original_url || path
   end
 
-  def essentials
-    return {} if card.structure
+  def string_with_page_details
+    raw = yield
+    return raw if raw.is_a? String
 
-    { content: card.db_content }
+    stringify page_details(raw)
   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 page_details obj
+    return obj unless obj.is_a? Hash
 
-  def atom
-    nucleus.tap do |h|
-      h[:content] = render_content if card.known? && !card.structure
-    end
+    obj.merge url: request_url, requested_at: Time.now.to_s
   end
 
-  def molecule
-    atom.merge items: _render_items,
-               links: _render_links,
-               ancestors: _render_ancestors,
-               html_url: path,
-               type: nest(card.type_card, view: :nucleus),
-               created_at: card.created_at,
-               updated_at: card.updated_at
+  def stringify raw
+    method = params[:compress] ? :generate : :pretty_generate
+    JSON.send method, raw
   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

data/set/all/links.rb

@@ -95,7 +95,7 @@ format :html do
     opts[:href] ||= path opts.delete(:path)
     text = raw(text || opts[:href])
     interpret_data_opts_to_link_to opts
-    wrap_with :a, text, opts
+    content_tag :a, text, opts
   end
 
   # in HTML, #link_to_card adds special css classes indicated whether a

data/set/all/text.rb

@@ -1,8 +1,25 @@
 require "htmlentities"
 
+format do
+  def to_text html
+    HTMLEntities.new.decode strip_tags(html).to_s
+  end
+
+  def nestless_content
+    content_obj = content_object card.content
+    content_obj.strip_nests
+    content_obj.process_chunks
+    content_obj.to_s
+  end
+
+  view :text_without_nests do
+    to_text nestless_content
+  end
+end
+
 format :text do
+  # TODO: override this in cards without html content
   view :core do
-    HTMLEntities.new.decode strip_tags(super()).to_s
-    # need this string method to get out of html_safe mode
+    to_text super()
   end
 end

data/set/all/yaml.rb

@@ -0,0 +1,6 @@
+format :yaml do
+  def show view, args={}
+    view ||= :export
+    render!(view, args).to_yaml
+  end
+end

data/set/type/basic.rb

@@ -0,0 +1,3 @@
+def export_type
+  nil
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: card-mod-format
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.1
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: card
@@ -18,28 +18,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.103.2
+        version: 1.104.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.103.2
+        version: 1.104.1
 - !ruby/object:Gem::Dependency
   name: card-mod-content
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.2
+        version: 0.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.2
+        version: 0.14.1
 description: ''
 email:
 - info@decko.org
@@ -55,44 +55,48 @@ files:
 - lib/card/format/js_format.rb
 - lib/card/format/json_format.rb
 - lib/card/format/rss_format.rb
+- lib/card/format/scss_format.rb
 - lib/card/format/text_format.rb
 - lib/card/format/xml_format.rb
+- lib/card/format/yaml_format.rb
 - lib/card/path.rb
 - lib/card/path/cast_params.rb
+- locales/de.yml
 - locales/en.yml
-- set/all/active_card.rb
 - set/all/base.rb
 - set/all/content.rb
 - set/all/css.rb
 - set/all/csv.rb
+- set/all/data.rb
 - set/all/demo.rb
 - set/all/error.rb
-- set/all/export.rb
 - set/all/file.rb
-- set/all/frame.rb
 - set/all/haml.rb
-- set/all/head.rb
-- set/all/header.rb
-- set/all/header/header_wrap.haml
-- set/all/html_content.rb
-- set/all/html_content/labeled.haml
-- set/all/html_error.rb
-- set/all/html_error/debug_server_error.haml
-- set/all/html_error/not_found.haml
-- set/all/html_error/server_error.haml
-- set/all/html_show.rb
-- set/all/html_title.rb
-- set/all/html_wrapper.rb
+- set/all/html.rb
+- set/all/html/debug_server_error.haml
+- set/all/html/error.rb
+- set/all/html/frame.rb
+- set/all/html/head.rb
+- set/all/html/header.rb
+- set/all/html/header_wrap.haml
+- set/all/html/labeled.haml
+- set/all/html/menu.rb
+- set/all/html/meta_tags.haml
+- set/all/html/not_found.haml
+- set/all/html/server_error.haml
+- set/all/html/show.rb
+- set/all/html/views.rb
+- set/all/html/wrap.rb
 - set/all/js.rb
 - set/all/json.rb
 - set/all/links.rb
-- set/all/menu.rb
-- set/all/meta_tags.haml
 - set/all/path.rb
-- set/all/rich_html.rb
 - set/all/rss.rb
 - set/all/text.rb
+- set/all/title.rb
+- set/all/yaml.rb
 - set/self/home.rb
+- set/type/basic.rb
 - set/type/cardtype.rb
 - set/type/html.rb
 - set/type/json.rb
@@ -126,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: format

data/set/all/active_card.rb

@@ -1,5 +0,0 @@
-# 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/export.rb

@@ -1,70 +0,0 @@
-format :json do
-  # returns an array of Hashes (each in export_item view)
-  view :export, cache: :never do
-    exporting_uniques do
-      Array.wrap(render_export_item).concat(export_items_in_view(:export)).flatten
-    end
-  end
-
-  def max_export_depth
-    Env.params[:max_export_depth].present? ? Env.params[:max_export_depth].to_i : 2
-  end
-
-  # returns an array of Hashes (each in export_item view)
-  view :export_items, cache: :never do
-    exporting_uniques do
-      export_items_in_view(:export).flatten
-    end
-  end
-
-  # returns Hash with the essentials needed to import a card into a new database
-  view :export_item do
-    item = { name: card.name, type: card.type_name, content: card.content }
-    item[:codename] = card.codename if card.codename
-    track_exporting card
-    item
-  end
-
-  def export_items_in_view view
-    within_max_depth do
-      valid_items_for_export.map do |item|
-        nest item, view: view
-      end
-    end
-  end
-
-  def track_exporting card
-    return unless @exported_keys
-
-    @exported_keys << card.key
-  end
-
-  def exporting_uniques
-    @exported_keys ||= inherit(:exported_keys) || ::Set.new
-    yield
-  end
-
-  # prevent recursion
-  def within_max_depth
-    @export_depth ||= inherit(:export_depth).to_i + 1
-    @export_depth > max_export_depth ? [] : yield
-  end
-
-  def items_for_export
-    nest_chunks.map do |chunk|
-      next if chunk.try :main?
-
-      chunk.referee_card
-    end.compact
-  end
-
-  def valid_items_for_export
-    items_for_export.flatten.reject(&:blank?).uniq.find_all do |card|
-      valid_export_card? card
-    end
-  end
-
-  def valid_export_card? ecard
-    ecard.real? && !@exported_keys.include?(ecard.key)
-  end
-end

data/set/all/html_show.rb

@@ -1,53 +0,0 @@
-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