decko-commons/decko

View on GitHub
card/mod/core/spec/set/all/name_events_spec.rb

Summary

Maintainability
A
0 mins
Test Coverage
RSpec.describe Card::Set::All::NameEvents do
  include CardExpectations

  def assert_rename card, new_name
    card = card_to_rename card
    attrs_before = name_invariant_attributes(card)
    actions_count_before = card.actions.count
    old_name = card.name

    update! card.name, name: new_name

    expect(name_invariant_attributes(card)).to eq(attrs_before)
    expect_successful_rename old_name, card, (actions_count_before + 1)
  end

  private

  def expect_successful_rename old_name, card, num_actions
    expect(card.actions.count).to eq(num_actions)
    expect(Card.cache.read(old_name)).to eq(nil)
    expect(card.name.card).to eq(card)
  end

  def name_invariant_attributes card
    descendant_ids = []
    card.each_descendant { |d| descendant_ids << d.id }
    {
      content: card.db_content,
      # updater_id:  card.updater_id,
      # revisions:   card.actions.count,
      referers: card.referers.map(&:name).sort,
      referees: card.referees.map(&:name).sort,
      descendants: descendant_ids.sort
    }
  end

  def card_to_rename card
    return card unless card.is_a? String

    Card[card]&.refresh || raise("Couldn't find card named #{card}")
  end

  it "renames simple card to its own child" do
    assert_rename "F", "F+M"
  end

  it "disallows renaming simple to compound when simple is used as tag" do
    expect { Card["A"].update! name: "A+M" }.to raise_error(/illegal name change/)
  end

  it "renames plus card to its own child" do
    assert_rename "A+B", "A+B+T"
  end

  it "clears cache for old name" do
    Card["A"]
    Card["A+B"]
    assert_rename "A", "AAA"
    expect(Card.cache.read("a")).to be_nil
    expect(Card.cache.read("a+b")).to be_nil
  end

  it "wipes old references by default" do
    update "Menu", name: "manure", skip: :update_referer_content
    expect(Card["manure"].references_in.size).to eq(1)
    # codename reference does not get wiped
  end

  it "picks up new references" do
    expect(Card["Z"].references_in.size).to eq(2)
    assert_rename "Z", "Mister X"
    expect(Card["Mister X"].references_in.size).to eq(3)
  end

  it "handles name variants" do
    assert_rename "B", "b"
  end

  it "handles plus cards renamed to simple" do
    assert_rename "A+B", "K"
  end

  it "handles flipped parts" do
    assert_rename "A+B", "B+A"
  end

  it "fails if card exists" do
    expect { update "T", name: "A+B" }.to raise_error(/Name must be unique/)
  end

  it "fails if used as tag" do
    expect { update "B", name: "A+D" }.to raise_error(/Name must be unique/)
  end

  it "updates descendants" do
    old_names = %w[One+Two One+Two+Three Four+One Four+One+Five]
    new_names = %w[Uno+Two Uno+Two+Three Four+Uno Four+Uno+Five]
    card_list = old_names.map { |name| Card[name] }

    expect(card_list.map(&:name)).to eq old_names
    update "One", name: "Uno"
    expect(card_list.map(&:id).map(&:cardname)).to eq new_names
  end

  it "fails if name is invalid" do
    expect { update "T", name: "" }.to raise_error(/Name can't be blank/)
  end

  example "simple to simple" do
    assert_rename "A", "Alephant"
  end

  example "simple to junction with create" do
    assert_rename "T", "C+J"
  end

  example "reset key" do
    c = Card["basicname"]
    update "basicname", name: "banana card"
    expect(c.key).to eq("banana_card")
    expect(Card["Banana Card"]).not_to be_nil
  end

  it "does not fail when updating inaccessible referer" do
    Card.create! name: "Joe Card", content: "Whattup"
    Card::Auth.as "joe_admin" do
      Card.create! name: "Admin Card", content: "[[Joe Card]]"
    end

    c = Card["Joe Card"]
    c.update! name: "Card of Joe"
    assert_equal "[[Card of Joe]]", Card["Admin Card"].content
  end

  it "test_rename_should_update_structured_referer" do
    Card::Auth.as_bot do
      c = Card.create! name: "Pit"
      Card.create! name: "Orange", type: "Fruit", content: "[[Pit]]"
      Card.create! name: "Fruit+*type+*structure", content: "this [[Pit]]"

      assert_equal "this [[Pit]]", Card["Orange"].content
      c.update! name: "Seed"
      assert_equal "this [[Seed]]", Card["Orange"].content
    end
  end

  it "handles plus cards that have children" do
    assert_rename Card["a+b"], "e+f"
  end

  context "with self references" do
    example "renaming card with self link should not hang" do
      pre_content = Card["self_aware"].content
      update "self aware", name: "buttah"
      expect_card("Buttah").to have_content(pre_content)
    end

    it "renames card without updating references" do
      pre_content = Card["self_aware"].content
      update "self aware", name: "Newt"
      expect_card("Newt").to have_content(pre_content)
    end
  end

  context "with references" do
    it "updates nests" do
      update "Blue", name: "Red"
      expect_card("blue includer 1").to have_content("{{Red}}")
      expect_card("blue includer 2").to have_content("{{Red|closed;other:stuff}}")
    end

    it "updates nests when renaming to plus" do
      update "Blue", name: "blue includer 1+color"
      expect_card("blue includer 1").to have_content("{{blue includer 1+color}}")
    end

    it "reference updates on case variants" do
      update "Blue", name: "Red"
      expect_card("blue linker 1").to have_content("[[Red]]")
      expect_card("blue linker 2").to have_content("[[Red]]")
    end

    it "handles link to and nest of same card" do
      update "blue linker 1", content: "[[Blue]] is {{Blue|name}}"
      update "Blue", name: "Red"
      expect_card("blue linker 1").to have_content("[[Red]] is {{Red|name}}")
    end

    example "reference updates plus to simple" do
      assert_rename Card["A+B"], "schmuck"
      expect_card("X").to have_content("[[A]] [[schmuck]] [[T]]")
    end

    it "substitutes name part" do
      c1 = Card["A+B"]
      assert_rename Card["B"], "buck"
      expect(Card.find(c1.id).name).to eq "A+buck"
    end
  end

  describe "event: set_name" do
    it "handles case variants" do
      c = Card.create! name: "chump"
      c.update! name: "Chump"
      expect(c.name).to eq("Chump")
    end

    context "when changing from plus card to simple" do
      let(:card) { Card.create! name: "four+five" }

      before do
        card.update! name: "nine"
      end

      it "assigns the cardname" do
        expect(card.name).to eq("nine")
      end

      it "removes the left id" do
        expect(card.left_id).to eq(nil)
      end

      it "removes the right id" do
        expect(card.right_id).to eq(nil)
      end
    end
  end

  describe "event: prepare_left_and_right" do
    it "creates left card, right card, and compound card for 2-part names" do
      Card.create! name: "Peach+Pear", content: "juicy"
      expect("Peach".card).to be_a(Card)
      expect("Pear".card).to be_a(Card)
      expect("Peach+Pear".card).to be_a(Card)
    end

    it "creates all cards for three-part names" do
      sugar_milk_flour = Card.create! name: "Sugar+Milk+Flour", content: "tasty"
      sugar_milk = "Sugar+Milk".card
      expect(sugar_milk_flour.left_id).to eq(sugar_milk.id)
      expect(sugar_milk_flour.right_id).to eq("Flour".card_id)
      expect(sugar_milk.left_id).to eq("Sugar".card_id)
      expect(sugar_milk.right_id).to eq("Milk".card_id)
    end
  end

  specify "event: rename_in_trash", as_bot: true do
    a = "a".card
    a.delete!

    b = "b".card
    b.update! name: "A"

    trashed_a = Card.find a.id

    expect(b.name).to eq("A")
    expect(trashed_a.name).to eq("A*trash")
    expect(trashed_a.key).to eq("a*trash")
  end

  describe "event: escape_name" do
    it "escapes invalid characters" do
      c = Card.create! name: "8 / 5 <script>"
      expect(c.name).to eq("8 &#47; 5 &#60;script&#62;")
    end
  end

  describe "#validate_name" do
    it "does not allow empty name" do
      expect { create "" }
        .to raise_error(/Name can't be blank/)
    end

    it "does not allow mismatched name and key" do
      expect { create "Test", key: "foo" }
        .to raise_error(/wrong key/)
    end
  end
end