card 1.95.3 → 1.96.0

data/lib/card/set/format/abstract_format.rb

@@ -0,0 +1,104 @@
+# -*- encoding : utf-8 -*-
+
+class Card
+  module Set
+    module Format
+      # All Format modules are extended with this module in order to support
+      # the basic format API, including view, layout, and basket definitions
+      module AbstractFormat
+        include Set::Basket
+        include Set::Format::HamlViews
+
+        mattr_accessor :views
+        self.views = Hash.new { |h, k| h[k] = {} }
+
+        def before view, &block
+          define_method "_before_#{view}", &block
+        end
+
+        def view view, *args, &block
+          # view = view.to_viewname.key.to_sym
+          interpret_view_opts view, args[0] if block_given?
+          view_method_block = view_block(view, args, &block)
+          if async_view? args
+            # This case makes only sense for HtmlFormat
+            # but I don't see an easy way to override class methods for a specific
+            # format. All formats are extended with this general module. So
+            # a HtmlFormat.view method would be overridden by AbstractFormat.view
+            # We need something like AbstractHtmlFormat for that.
+            define_async_view_method view, &view_method_block
+          else
+            define_standard_view_method view, &view_method_block
+          end
+        end
+
+        def view_for_override viewname
+          view viewname do
+            "override '#{viewname}' view"
+          end
+        end
+
+        def define_standard_view_method view, &block
+          views[self][view] = block
+          define_method "_view_#{view}", &block
+        end
+
+        def define_async_view_method view, &block
+          view_content = "#{view}_async_content"
+          define_standard_view_method view_content, &block
+          define_standard_view_method view do
+            %(<card-view-placeholder data-url="#{path view: view_content}" />)
+          end
+        end
+
+        def interpret_view_opts view, opts
+          return unless opts.present?
+          Card::Format.interpret_view_opts view, opts
+          extract_view_cache_rules view, opts.delete(:cache)
+        end
+
+        def extract_view_cache_rules view, cache_rule
+          return unless cache_rule
+          methodname = Card::Format.view_cache_setting_method view
+          define_method(methodname) { cache_rule }
+        end
+
+        def view_block view, args, &block
+          return haml_view_block(view, wrap_with_slot?(args), &block) if haml_view?(args)
+          block_given? ? block : lookup_alias_block(view, args)
+        end
+
+        def haml_view? args
+          args.first.is_a?(Hash) && args.first[:template] == :haml
+        end
+
+        def wrap_with_slot? args
+          args.first.is_a?(Hash) && args.first[:slot]
+        end
+
+        def async_view? args
+          args.first.is_a?(Hash) && args.first[:async]
+        end
+
+        def lookup_alias_block view, args
+          opts = args[0].is_a?(Hash) ? args.shift : { view: args.shift }
+          opts[:mod] ||= self
+          opts[:view] ||= view
+          views[opts[:mod]][opts[:view]] || begin
+            raise "cannot find #{opts[:view]} view in #{opts[:mod]}; " \
+                  "failed to alias #{view} in #{self}"
+          end
+        end
+
+        def source_location
+          set_module.source_location
+        end
+
+        # remove the format part of the module name
+        def set_module
+          Card.const_get name.split("::")[0..-2].join("::")
+        end
+      end
+    end
+  end
+end

data/mod/Modfile

@@ -4,6 +4,7 @@ mod 'core'
 mod 'virtual'
 mod 'history'
 mod 'basic_formats'
+mod 'item'
 mod 'pointer'
 mod 'ace_editor'
 mod 'prosemirror_editor'

data/mod/basic_formats/set/all/all_csv.rb

@@ -79,7 +79,7 @@ format :csv  do
   def column_titles extra_titles=nil
     res = Array extra_titles
     card1 = Card.fetch card.item_names(limit: 1).first
-    card1.each_nested_chunk do |chunk|
+    card1.nest_chunks.each do |chunk|
       res << column_title(chunk.options)
     end
     res.compact

data/mod/basic_formats/set/all/json.rb

@@ -1,4 +1,9 @@
 format :json do
+  # because card.item_cards returns "[[#{self}]]"
+  def item_cards
+    uniq_nested_cards
+  end
+
   AUTOCOMPLETE_LIMIT = 8 # number of name suggestions for autocomplete text fields
 
   def default_nest_view
@@ -13,8 +18,11 @@ format :json do
     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 ||= :content
+    view ||= :molecule
     raw = render! view, args
     return raw if raw.is_a? String
     method = params[:compress] ? :generate : :pretty_generate
@@ -54,20 +62,69 @@ format :json do
     hash
   end
 
-  view :content, cache: :never do
+  view :page, cache: :never do
     { url: request_url,
       timestamp: Time.now.to_s,
       card: _render_atom }
   end
 
+  view :content do
+    render_page
+  end
+
+  view :core do
+    { card.name => card.content }
+  end
+
+  view :nucleus, cache: :never do
+    {
+      id: card.id,
+      name: card.name,
+      url: path(format: :json),
+      html_url: path
+    }
+  end
+
   view :atom, cache: :never do
-    h = { name: card.name, type: card.type_name }
+    h = _render_nucleus
+    h[:type] = card.type_name
+    h[:type_url] = path mark: card.type_name, format: :json
+    h[:atom_url] = path format: :json, view: :atom
+    h[:nucleus_url] = path format: :json, view: :nucleus
     h[:content] = card.db_content unless card.structure
     h[:codename] = card.codename if card.codename
-    h[:value] = _render_core if depth < max_depth
     h
   end
 
+  view :items, cache: :never do
+    item_cards.map do |i_card|
+      nest i_card
+    end
+  end
+
+  view :links, cache: :never 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, cache: :never do
+    card.name.ancestors.map do |name|
+      nest name
+    end
+  end
+
+  view :molecule, cache: :never do
+    _render_atom.merge items: _render_items,
+                       links: _render_links,
+                       ancestors: _render_ancestors
+
+  end
+
   # minimum needed to re-fetch card
   view :cast, cache: :never do
     card.cast

data/mod/basic_formats/spec/set/all/json_spec.rb

@@ -1,6 +1,56 @@
 # -*- encoding : utf-8 -*-
 
-describe Card::Set::All::Json, "JSON mod" do
+RSpec.describe Card::Set::All::Json do
+  include_context "json context"
+  specify "nucleus view" do
+    expect_view(:nucleus, format: :json)
+      .to eq nucleus_values
+  end
+
+  specify "atom view" do
+    expect_view(:atom, format: :json)
+      .to eq atom_values
+  end
+
+  describe "molecule view" do
+    context "with internal link" do
+      it "has link url" do
+        expect_view(:molecule, format: :json)
+          .to eq atom_values.merge items: [],
+                                   links: [json_url("Z")],
+                                   ancestors: []
+      end
+    end
+
+    context "with external link" do
+      def card_subject
+        @card ||= create "external link",
+                         content: "[[http://xkcd.com|link text]]" \
+                                  "[[/Z]]"
+      end
+
+      it "has link urls" do
+        expect_view(:molecule, format: :json)
+          .to eq atom_values.merge items: [],
+                                   links: ["http://xkcd.com", url("Z")],
+                                   ancestors: []
+      end
+    end
+
+    context "with nests" do
+      def card_subject
+        Card["B"]
+      end
+
+      it "has nests" do
+        expect_view(:molecule, format: :json)
+          .to eq atom_values.merge items: [atom_values(Card["Z"])],
+                                   links: [],
+                                   ancestors: []
+      end
+    end
+  end
+
   context "status view" do
     it "handles real and virtual cards" do
       jf = Card::Format::JsonFormat

data/mod/basic_formats/spec/shared_context/json_shared_context.rb

@@ -0,0 +1,40 @@
+RSpec.shared_context "json context", shared_context: :json do
+  before do
+    Card::Env[:host] = "json.com"
+    Card::Env[:protocol] = "http://"
+  end
+
+  let(:root) { "http://json.com" }
+
+  def json_url target, query=nil
+    url "#{target}.json", query
+  end
+
+  def url target, query=nil
+    ["#{root}/#{target}", query].compact.join "?"
+  end
+
+  def nucleus_values card=card_subject
+    {
+      id: card.id,
+      name: card.name,
+      url: json_url(card.name.url_key),
+      html_url: "#{root}/#{card.name.url_key}"
+    }
+  end
+
+  def atom_values card=card_subject, structured: false
+    values = nucleus_values(card).merge(
+      type: card.type_name,
+      type_url: json_url(card.type_name),
+      atom_url: json_url(card.name.url_key, "view=atom"),
+      nucleus_url: json_url(card.name.url_key, "view=nucleus")
+    )
+    values[:content] = card.content unless structured
+    values
+  end
+
+  def structured_atom_values card=card_subject
+    atom_values card, structured: true
+  end
+end

data/mod/bootstrap/lib/stylesheets/style_bootstrap_cards.scss

@@ -11,6 +11,7 @@
 $label_color: $gray-600;
 $header_color: $gray-200;
 $credit_color: $primary;
+$bar_stripe_color: $gray-700;
 
 header {
   a {
@@ -57,7 +58,6 @@ form {
   padding: 0px;
 }
 
-
 .link-muted {
   color: $text-muted;
   &:hover {
@@ -65,6 +65,13 @@ form {
   }
 }
 
+.grow-1 {
+  flex-grow: 1;
+}
+.grow-2 {
+  flex-grow: 2;
+}
+
 /*-------- Special Pages --------*/
 
 /*-- sign in page --*/
@@ -336,3 +343,12 @@ body.mceContentBody {
     display: none !important;
   }
 }
+
+.bar-top.left-stripe, .bar.left-stripe {
+  border-left: 4px solid $bar_stripe_color !important;
+}
+
+.bar-bottom .bar.left-stripe {
+  border-left: 3px solid $bar_stripe_color !important;
+}
+

data/mod/bootstrap/set/abstract/bootswatch_theme.rb

@@ -10,7 +10,7 @@
 #
 # The content of a bootswatch theme card consists of four parts:
 #   * pre_variables: hard-coded theme independent stuff
-#       and bootstrap functions to make the available in the variables part
+#       and bootstrap functions to make them available in the variables part
 #   * variables: the content from `_variables.scss`,
 #   * post_variables: the bootstrap css and libraries like select2 and
 #       bootstrap-colorpicker that depend on the theme
@@ -39,7 +39,7 @@
 include_set Abstract::Machine
 include_set Type::Scss
 include_set Abstract::CodeFile
-include_set Abstract::SkinThumbnail
+include_set Abstract::SkinBox
 
 CONTENT_PARTS = %i[pre_variables variables post_variables stylesheets].freeze
 
@@ -155,13 +155,3 @@ def source_dir
   @source_dir ||=
     ::File.expand_path "../../../vendor/bootswatch/dist/#{theme_name}", __FILE__
 end
-
-format :html do
-  view :thumbnail, template: :haml do
-    voo.show! :customize_button, :thumbnail_image
-  end
-
-  view :closed_content do
-    ""
-  end
-end

data/mod/bootstrap/set/abstract/bootswatch_theme/html_views.rb

@@ -0,0 +1,31 @@
+include_set Abstract::Media
+include_set Abstract::BsBadge
+
+format :html do
+  before :box do
+    super()
+    voo.show! :customize_button, :box_middle
+  end
+
+  view :closed_content do
+    ""
+  end
+
+  view :bar_left do
+    class_up "card-title", "my-0 ml-2"
+    class_up "media-left", "m-0", true
+    text_with_image size: :small, title: "", text: _render_title,
+                    media_opts: { class: "align-items-center" }
+    # field_nest(:image, view: :core) + wrap_with(:h4, render(:title))
+  end
+
+  view :bar_right do
+    customize_button text: "Customize"
+  end
+
+  view :bar_bottom do
+    wrap_with :code do
+      render_core
+    end
+  end
+end

data/mod/bootstrap/set/type/customized_bootswatch_skin.rb

@@ -12,6 +12,18 @@ card_accessor :colors
 card_accessor :variables
 card_accessor :stylesheets
 
+def top_level_item_cards
+  cards = PRE_VARIABLES_CARD_NAMES.map { |n| Card[n] }
+  cards += [colors_card, variables_card]
+  cards += POST_VARIABLES_CARD_NAMES.map { |n| Card[n] }
+  cards << stylesheets_card
+  cards
+end
+
+def editable_item_cards
+  [colors_card, variables_card, stylesheets_card]
+end
+
 def variables_card_names
   %i[colors variables].map { |s| Card.fetch_name name, s }
 end

data/mod/bootstrap/set/type/customized_bootswatch_skin/core.haml

@@ -0,0 +1,5 @@
+%h5
+  Skin configuration from simplest to most advanced
+= field_nest :colors, view: :bar, title: "Palette and uses of colors"
+= field_nest :variables, view: :bar, title: "Additional SCSS variables", show: :edit_button
+= field_nest :stylesheets, view: :bar, title: "SCSS and CSS stylesheets", show: :edit_button