card 1.97.0.1 → 1.98.0

data/mod/core/set/all/haml.rb

@@ -1,5 +1,5 @@
 format do
-  include Card::Set::Format::HamlViews
+  include Card::Set::Format::HamlPaths
 
   define_method :the_scope do
     set_scope
@@ -11,7 +11,7 @@ format do
 
   # Renders haml templates. The haml template can be passed as string or
   # block or a symbol that refers to a view template.
-  # @param  template_or_locals [Hash, String, Symbol]
+  # @param args [Hash, String, Symbol]
   #   If a symbol is given then a template is expected in the corresponding view
   #   directory.
   # @return [String] rendered haml as HTML

data/mod/core/set/all/item.rb

@@ -67,8 +67,8 @@ format do
   end
 
   def implicit_item_view
-    view = params[:item] || voo_items_view || default_item_view
-    Card::View.canonicalize view
+    view = voo_items_view || default_item_view
+    Card::View.normalize view
   end
 
   def voo_items_view

data/mod/core/set/all/permissions.rb

@@ -111,7 +111,6 @@ end
 def permitted? action
   return if Card.config.read_only
   return true if action != :comment && Auth.always_ok?
-
   permitted_ids = who_can action
   if action == :comment && Auth.always_ok?
     # admin can comment if anyone can

data/mod/core/set/all/phases.rb

@@ -10,7 +10,3 @@ end
 delegate :validation_phase, to: :director
 delegate :storage_phase, to: :director
 delegate :integration_phase, to: :director
-
-# def clean_up
-#   Card::ActManager.clear
-# end

data/mod/core/set/all/references.rb

@@ -166,7 +166,7 @@ event :update_referer_content, :finalize,
       on: :update, after: :name_change_finalized, when: :update_referers do
   referers.each do |card|
     next if card.structure
-    card.skip = %i[validate_renaming check_permissions!]
+    card.skip_in_action = %i[validate_renaming check_permissions!]
     attach_subcard card.name,
                    content: card.replace_reference_syntax(name_before_last_save, name)
   end
@@ -177,8 +177,7 @@ end
 # eg.  A links to X+Y.  if X+Y is renamed and we're not updating the link in A,
 # then we need to be sure that A has a partial reference
 event :update_referer_references_out, :finalize,
-      on: :update, after: :name_change_finalized,
-      when: :not_update_referers do
+      on: :update, after: :name_change_finalized, when: :not_update_referers do
   referers.map(&:update_references_out)
 end
 

data/mod/core/set/all/rename.rb

@@ -24,7 +24,7 @@ event :cascade_name_changes, :finalize, on: :update, changed: :name,
   @descendants = nil # reset
 
   children.each do |child|
-    Rails.logger.info "cascading name: #{child.name}"
+    Rails.logger.debug "cascading name: #{child.name}"
     newname = child.name.swap name_before_last_save, name
     # not sure if this is still needed since we attach the children as subcards
     # (it used to be resolved right here without adding subcards)

data/mod/core/set/all/states.rb

@@ -1,47 +1,84 @@
+# All cards have one (and only one) of these three states: real, virtual, and unknown.
+#
+# - *real* cards are stored in the database (but not in the trash) and have a unique id.
+# - *virtual* cards are not real, but they act real based on rules. For example,
+#   Home+*editors does a search for all the users who have edited the "Home" card.
+#   There are many other similar cards that search for things like references, children,
+#   etc. But we don't store all these cards in the database; we generate them dynamically
+#   based on the names.
+# - *unknown* cards are everything else.
+#
+# These states are frequently grouped as follows:
+#
+# - *known* cards are either _real_ or _virtual_
+# - *new* (or *unreal*) cards are either _unknown_ or _virtual_
+
 module ClassMethods
-  def exists? mark
-    card = quick_fetch mark
-    card.present?
+  def real? mark
+    quick_fetch(mark).present?
   end
-  alias :exist? :exists?
+  alias exist? real?
+  alias exists? real?
 
   def known? mark
-    card = fetch mark, skip_modules: true
-    card.present?
+    fetch(mark).present?
   end
 end
 
-def state
+# @return [Symbol] :real, :virtual, or :unknown
+def state anti_fishing=true
   case
-  when !known?     then :unknown
-  when !ok?(:read) then :unknown # anti-fishing
-  when real?       then :real
-  when virtual?    then :virtual
+  when !known?                     then :unknown
+  when anti_fishing && !ok?(:read) then :unknown
+  when real?                       then :real
+  when virtual?                    then :virtual
   else :wtf
   end
 end
 
-def new_card?
-  new_record? ||       # not yet in db (from ActiveRecord)
-    !@from_trash.nil?  # in process of restoration from trash
-end
-alias_method :new?, :new_card?
-
-def known?
-  real? || virtual?
+# @return [True/False]
+def real?
+  !unreal?
 end
 
-def real?
-  !new_card?
+# Virtual cards are structured, compound cards that are not stored in the database. You
+# can create virtual cards with structure rules.
+#
+# Some cards with hard-coded content will also override the #virtual? method. This
+# is established practice, but it is NOT advisable to override any of the other
+# state methods.
+#
+# @return [True/False]
+def virtual?
+  if @virtual.nil?
+    @virtual = real? || name.simple? ? false : structure.present?
+  end
+  @virtual
 end
 
+# @return [True/False]
 def unknown?
   !known?
 end
 
+# @return [True/False]
+def known?
+  real? || virtual?
+end
+
+# @return [True/False]
+def new?
+  new_record? ||       # not yet in db (from ActiveRecord)
+    !@from_trash.nil?  # in process of restoration from trash
+end
+alias new_card? new?
+alias unreal? new?
+
+# has not been edited directly by human users.  bleep blorp.
 def pristine?
-  # has not been edited directly by human users.  bleep blorp.
-  new_card? || !actions.joins(:act).where(
-    "card_acts.actor_id != ?", Card::WagnBotID
-  ).exists?
+  new_card? || !user_changes?
 end
+
+def user_changes?
+  actions.joins(:act).where("card_acts.actor_id != ?", Card::WagnBotID).exists?
+end

data/mod/core/set/all/templating.rb

@@ -1,10 +1,14 @@
 
 def is_template?
-  name.trait_name? :structure, :default
+  return @is_template unless @is_template.nil?
+
+  @is_template = name.trait_name? :structure, :default
 end
 
 def is_structure?
-  name.trait_name? :structure
+  return @is_structure unless @is_structure.nil?
+
+  @is_structure = name.trait_name? :structure
 end
 
 def template
@@ -49,10 +53,9 @@ def assigns_type?
   # needed because not all *structure templates govern the type of set members
   # for example, X+*type+*structure governs all cards of type X,
   # but the content rule does not (in fact cannot) have the type X.
-  return unless (set_pattern = Card.fetch name.trunk_name.tag_name,
-                                          skip_modules: true)
-  return unless (pattern_code = set_pattern.codename)
-  return unless (set_class = Set::Pattern.find pattern_code)
+  pattern_code = Card.quick_fetch(name.trunk_name.tag_name)&.codename
+  return unless pattern_code && (set_class = Set::Pattern.find pattern_code)
+
   set_class.assigns_type
 end
 
@@ -61,15 +64,8 @@ def structure
   template
 end
 
-def virtual?
-  return false unless new_card?
-  if @virtual.nil?
-    name.simple? ? (@virtual = false) : template
-  end
-  @virtual
-end
-
 def structure_rule_card
-  card = rule_card :structure, skip_modules: true
-  card && card.db_content.strip == "_self" ? nil : card
+  return unless (card = rule_card :structure, skip_modules: true)
+
+  card.db_content&.strip == "_self" ? nil : card
 end

data/mod/core/set_pattern/08_type_plus_right.rb

@@ -1,3 +1,5 @@
+# Patterned field names on a specific type
+
 @@options = {
   junction_only: true,
   assigns_type: true,

data/mod/core/spec/chunk/nest_spec.rb

@@ -65,6 +65,7 @@ RSpec.describe Card::Content::Chunk::Nest do
       expect(options[:nest_name]).to eq("toy")
       expect(options[:view]).to eq("link")
       expect(options[:hide]).to eq("me")
+      expect(instance.text).to eq "{{toy|view:link;hide:me}}"
       expect(options.key?(:items)).to eq(false)
     end
 

data/mod/core/spec/format/html_format_spec.rb

@@ -5,8 +5,8 @@ RSpec.describe Card::Format::HtmlFormat do
     specify "content" do
       expect(view(:content, card: "A+B"))
         .to have_tag(
-          'div[class="card-slot content-view ALL ALL_PLUS TYPE-basic '\
-    'RIGHT-b TYPE_PLUS_RIGHT-basic-b SELF-a-b d0-card-content"]'
+          'div[class="card-slot content-view ALL ALL_PLUS TYPE-rich_text '\
+    'RIGHT-b TYPE_PLUS_RIGHT-rich_text-b SELF-a-b d0-card-content"]'
         )
     end
 

data/mod/core/spec/set/all/assign_attributes_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe Card::Set::All::AssignAttributes do
     expect(Card["A"].type_code).to eq(:cardtype)
   end
 
-  example "create cardtype with codename" do
+  example "create cardtype with codename", as_bot: true do
     card = Card.create! name: "Foo Type", codename: "foo",
                         type: "Cardtype"
     expect(card).to have_type(:cardtype).and have_codename :foo

data/mod/core/spec/set/all/chunk_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe Card::Set::All::Chunk do
       format = format_with_edit_fields [:write, :basic]
       expect(format.render_edit).to have_tag ".card-slot" do
         with_tag ".card-editor.RIGHT-Xwrite", with: { card_name: "A+*write" }
-        with_tag ".card-editor.RIGHT-basic", with: { card_name: "A+Basic" }
+        with_tag ".card-editor.RIGHT-rich_text", with: { card_name: "A+RichText" }
       end
     end
 

data/mod/core/spec/set/all/collection_spec.rb

@@ -151,7 +151,7 @@ RSpec.describe Card::Set::All::Collection do
       assert_view_select tabs, "div[role=tabpanel]" do
         assert_select 'li > a[data-toggle=tab][href="#tab_test-1-a"]',
                       "my tab title"
-        assert_select "div.tab-pane#tab_test-1-a", "Basic"
+        assert_select "div.tab-pane#tab_test-1-a", "RichText"
       end
     end
 

data/mod/core/spec/set/all/export_spec.rb

@@ -19,8 +19,8 @@ RSpec.describe Card::Set::All::Export do
         expect(export_pointer(%w[T A+B])).to include(
           a_hash_including(name: "pointer export card", type: "Pointer",
                            content: "[[T]]\n[[A+B]]"),
-          a_hash_including(name: "T", type: "Basic", content: "Theta"),
-          a_hash_including(name: "A+B", type: "Basic", content: "AlphaBeta")
+          a_hash_including(name: "T", type: "RichText", content: "Theta"),
+          a_hash_including(name: "A+B", type: "RichText", content: "AlphaBeta")
         )
       end
       it "handles multi levels pointer cards" do
@@ -30,8 +30,8 @@ RSpec.describe Card::Set::All::Export do
                            content: "[[inner pointer]]\n[[A+B]]"),
           a_hash_including(name: "inner pointer", type: "Pointer",
                            content: "[[T]]"),
-          a_hash_including(name: "T", type: "Basic", content: "Theta"),
-          a_hash_including(name: "A+B", type: "Basic", content: "AlphaBeta")
+          a_hash_including(name: "T", type: "RichText", content: "Theta"),
+          a_hash_including(name: "A+B", type: "RichText", content: "AlphaBeta")
         )
       end
 
@@ -51,7 +51,7 @@ RSpec.describe Card::Set::All::Export do
         expect(export).to include(
           a_hash_including(name: "skin export card", type: "Skin",
                            content: "[[T]]"),
-          a_hash_including(name: "T", type: "Basic", content: "Theta")
+          a_hash_including(name: "T", type: "RichText", content: "Theta")
         )
       end
     end
@@ -61,8 +61,8 @@ RSpec.describe Card::Set::All::Export do
         expect(export_pointer('{"left":"A"}', :search_type)).to include(
           a_hash_including(name: "search_type export card", type: "Search",
                            content: '{"left":"A"}'),
-          a_hash_including(name: "A+B", content: "AlphaBeta", type: "Basic"),
-          a_hash_including(name: "A+C", type: "Basic")
+          a_hash_including(name: "A+B", content: "AlphaBeta", type: "RichText"),
+          a_hash_including(name: "A+C", type: "RichText")
         )
       end
     end

data/mod/core/spec/set/all/fetch_spec.rb

@@ -180,7 +180,7 @@ RSpec.describe Card::Set::All::Fetch do
         expect(card).to be_virtual.and have_content "Right Content"
 
         #        warn 'creating template'
-        tpr = Card.create! name: "Basic+y+*type plus right+*structure",
+        tpr = Card.create! name: "RichText+y+*type plus right+*structure",
                            content: "Type Plus Right Content"
         card = Card.fetch("a+y")
         expect(card).to be_virtual.and have_content "Type Plus Right Content"
@@ -307,7 +307,7 @@ RSpec.describe Card::Set::All::Fetch do
     end
 
     example "id" do
-      expect(Card.fetch_name(Card::BasicID)).to eq "Basic"
+      expect(Card.fetch_name(Card::BasicID)).to eq "RichText"
     end
 
     example "invalid id" do

data/mod/core/spec/set/all/pattern_spec.rb

@@ -5,10 +5,10 @@ RSpec.describe Card::Set::All::Pattern do
     it "returns self, type, all for simple cards" do
       Card::Auth.as_bot do
         card = Card.new(name: "AnewCard")
-        expect(card.set_names).to eq(["Basic+*type", "*all"])
+        expect(card.set_names).to eq(["RichText+*type", "*all"])
         card.save!
         card = Card.fetch("AnewCard")
-        expect(card.set_names).to eq(["AnewCard+*self", "Basic+*type", "*all"])
+        expect(card.set_names).to eq(["AnewCard+*self", "RichText+*type", "*all"])
       end
     end
 
@@ -26,7 +26,7 @@ RSpec.describe Card::Set::All::Pattern do
       Card::Auth.as_bot do
         expect(Card.new(name: "Iliad+author").set_names).to eq(
           [
-            "Book+author+*type plus right", "author+*right", "Basic+*type",
+            "Book+author+*type plus right", "author+*right", "RichText+*type",
             "*all plus", "*all"
           ]
         )
@@ -37,7 +37,7 @@ RSpec.describe Card::Set::All::Pattern do
       expect(Card.new(name: "Iliad+*to").set_names).to eq(
         [
           "Book+*to+*type plus right", "*to+*right", "*rstar",
-          "Pointer+*type", "*all plus", "*all"
+          "List+*type", "*all plus", "*all"
         ]
       )
     end
@@ -46,7 +46,7 @@ RSpec.describe Card::Set::All::Pattern do
       expect(Card.new(name: "*all+*create").set_names).to eq(
         [
           "Set+*create+*type plus right", "*create+*right", "*rule", "*rstar",
-          "Pointer+*type", "*all plus", "*all"
+          "List+*type", "*all plus", "*all"
         ]
       )
     end
@@ -71,22 +71,22 @@ RSpec.describe Card::Set::All::Pattern do
     it "returns css names for simple star cards" do
       Card::Auth.as_bot do
         card = Card.new(name: "*AnewCard")
-        expect(card.safe_set_keys).to eq("ALL TYPE-basic STAR")
+        expect(card.safe_set_keys).to eq("ALL TYPE-rich_text STAR")
         card.save!
         card = Card.fetch("*AnewCard")
-        expect(card.safe_set_keys).to eq("ALL TYPE-basic STAR SELF-Xanew_card")
+        expect(card.safe_set_keys).to eq("ALL TYPE-rich_text STAR SELF-Xanew_card")
       end
     end
 
     it "returns set names for junction cards" do
       card = Card.new(name: "Iliad+author")
       expect(card.safe_set_keys).to eq(
-        "ALL ALL_PLUS TYPE-basic RIGHT-author TYPE_PLUS_RIGHT-book-author"
+        "ALL ALL_PLUS TYPE-rich_text RIGHT-author TYPE_PLUS_RIGHT-book-author"
       )
       card.save!
       card = Card.fetch("Iliad+author")
       expect(card.safe_set_keys).to eq(
-        "ALL ALL_PLUS TYPE-basic RIGHT-author TYPE_PLUS_RIGHT-book-author "\
+        "ALL ALL_PLUS TYPE-rich_text RIGHT-author TYPE_PLUS_RIGHT-book-author "\
         "SELF-iliad-author"
       )
     end

data/mod/core/spec/set/all/rules2_spec.rb

@@ -4,7 +4,7 @@
 # I think we should move the rendering tests into basic and trim this to about
 # a quarter of its current length
 
-describe Card do
+RSpec.describe Card do
   RSpec::Matchers.define :have_toc do
     match do |card|
       values_match?(/Table of Contents/, card.format.render_open_content)
@@ -19,7 +19,7 @@ describe Card do
   context "when there is a general toc rule of 2" do
     before do
       Card::Auth.as_bot do
-        described_class.create! name: "Basic+*type+*table of contents", content: "2"
+        create [:basic, :type, :table_of_contents], "2"
       end
     end
 
@@ -58,18 +58,18 @@ describe Card do
       end
       # it "shows type plus right sets when they exist" do
       #   Card::Auth.as_bot do
-      #     Card.create name: 'Basic+A+*type plus right', content: ''
+      #     Card.create name: 'RichText+A+*type plus right', content: ''
       #   end
       #   sets = Card['A'].related_sets
-      #   sets.should == ['A+*self', 'A+*right', 'Basic+A+*type plus right']
+      #   sets.should == ['A+*self', 'A+*right', 'RichText+A+*type plus right']
       # end
       # it "shows type plus right sets when they exist, and type" do
       #   Card::Auth.as_bot do
-      #     Card.create name: 'Basic+Cardtype A+*type plus right', content: ''
+      #     Card.create name: 'RichText+Cardtype A+*type plus right', content: ''
       #   end
       #   sets = Card['Cardtype A'].related_sets
       #   sets.should == ['Cardtype A+*self', 'Cardtype A+*type',
-      #     'Cardtype A+*right', 'Basic+Cardtype A+*type plus right']
+      #     'Cardtype A+*right', 'RichText+Cardtype A+*type plus right']
       # end
       it "is empty for a non-simple card" do
         sets = described_class["A+B"].related_sets.map { |s| s[0] }
@@ -170,7 +170,7 @@ describe Card do
   context "when I create a new rule" do
     before do
       Card::Auth.as_bot do
-        described_class.create! name: "Basic+*type+*table of contents", content: "2"
+        described_class.create! name: "RichText+*type+*table of contents", content: "2"
         @c1 = described_class.create! name: "toc1", type: "CardtypeE",
                                       content: described_class["Onne Heading"].content
         @c2 = described_class.create! name: "toc2", content: described_class["Twwo Heading"].content