File: section_spec.rb

package info (click to toggle)
yard 0.9.38-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,736 kB
  • sloc: ruby: 31,680; javascript: 7,658; makefile: 21
file content (144 lines) | stat: -rw-r--r-- 4,379 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# frozen_string_literal: true
require File.dirname(__FILE__) + '/spec_helper'

RSpec.describe YARD::Templates::Section do
  include YARD::Templates

  describe "#initialize" do
    it "converts first argument to splat if it is array" do
      s = Section.new(:name, [:foo, :bar])
      expect(s.name).to eq :name
      expect(s[0].name).to eq :foo
      expect(s[1].name).to eq :bar
    end

    it "allows initialization with Section objects" do
      s = Section.new(:name, [:foo, Section.new(:bar)])
      expect(s.name).to eq :name
      expect(s[0]).to eq Section.new(:foo)
      expect(s[1]).to eq Section.new(:bar)
    end

    it "makes a list of sections" do
      s = Section.new(:name, [:foo, [:bar]])
      expect(s).to eq Section.new(:name, Section.new(:foo, Section.new(:bar)))
    end
  end

  describe "#[]" do
    it "uses Array#[] if argument is integer" do
      expect(Section.new(:name, [:foo, :bar])[0].name).to eq :foo
    end

    it "returns new Section object if more than one argument" do
      expect(Section.new(:name, :foo, :bar, :baz)[1, 2]).to eq Section.new(:name, :bar, :baz)
    end

    it "returns new Section object if arg is Range" do
      expect(Section.new(:name, :foo, :bar, :baz)[1..2]).to eq Section.new(:name, :bar, :baz)
    end

    it "looks for section by name if arg is object" do
      expect(Section.new(:name, :foo, :bar, [:baz])[:bar][:baz]).to eq Section.new(:baz)
    end
  end

  describe "#eql?" do
    it "checks for equality of two equal sections" do
      expect(Section.new(:foo, [:a, :b])).to eql(Section.new(:foo, :a, :b))
      expect(Section.new(:foo, [:a, :b])).to eq Section.new(:foo, :a, :b)
    end

    it "is not equal if section names are different" do
      expect(Section.new(:foo, [:a, :b])).not_to eql(Section.new(:bar, :a, :b))
      expect(Section.new(:foo, [:a, :b])).not_to eq Section.new(:bar, :a, :b)
    end
  end

  describe "#==" do
    it "allows comparison to Symbol" do
      expect(Section.new(:foo, 2, 3)).to eq :foo
    end

    it "allows comparison to String" do
      expect(Section.new("foo", 2, 3)).to eq "foo"
    end

    it "allows comparison to Template" do
      t = YARD::Templates::Engine.template!(:xyzzy, '/full/path/xyzzy')
      expect(Section.new(t, 2, 3)).to eq t
    end

    it "allows comparison to Section" do
      expect(Section.new(1, [2, 3])).to eq Section.new(1, 2, 3)
    end

    it "allows comparison to Object" do
      expect(Section.new(1, [2, 3])).to eq 1
    end

    it "allows comparison to Array" do
      expect(Section.new(1, 2, [3])).to eq [1, [2, [3]]]
    end
  end

  describe "#to_a" do
    it "converts Section to regular Array list" do
      arr = Section.new(1, 2, [3, [4]]).to_a
      expect(arr.class).to eq Array
      expect(arr).to eq [1, [2, [3, [4]]]]
    end
  end

  describe "#place" do
    it "places objects as Sections" do
      expect(Section.new(1, 2, 3).place(4).before(3)).to eq [1, [2, 4, 3]]
    end

    it "places objects anywhere inside Section with before/after_any" do
      expect(Section.new(1, 2, [3, [4]]).place(5).after_any(4)).to eq [1, [2, [3, [4, 5]]]]
      expect(Section.new(1, 2, [3, [4]]).place(5).before_any(4)).to eq [1, [2, [3, [5, 4]]]]
    end

    it "allows multiple sections to be placed" do
      expect(Section.new(1, 2, 3).place(4, 5).after(3).to_a).to eq [1, [2, 3, 4, 5]]
      expect(Section.new(1, 2, 3).place(4, [5]).after(3).to_a).to eq [1, [2, 3, 4, [5]]]
    end
  end

  describe "#push" do
    it "pushes objects as Sections" do
      s = Section.new(:foo)
      s.push :bar
      expect(s[0]).to eq Section.new(:bar)
    end

    it "is aliased as #<<" do
      s = Section.new(1)
      s << :index
      expect(s[:index]).to be_a(Section)
    end
  end

  describe "#unshift" do
    it "unshifts objects as Sections" do
      s = Section.new(:foo)
      s.unshift :bar
      expect(s[0]).to eq Section.new(:bar)
    end
  end

  describe "#any" do
    it "finds item inside sections" do
      s = Section.new(:foo, Section.new(:bar, Section.new(:bar)))
      s.any(:bar).push(:baz)
      expect(s.to_a).to eq [:foo, [:bar, [:bar, :baz]]]
    end

    it "finds item in any deeply nested set of sections" do
      s = Section.new(:foo, Section.new(:bar, Section.new(:baz)))
      s.any(:baz).push(:qux)
      expect(s.to_a).to eq [:foo, [:bar, [:baz, [:qux]]]]
    end
  end
end