Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 232 lines (193 sloc) 5.779 kb
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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
require "jsduck/aggregator"
require "jsduck/source_file"
require "jsduck/class"
require "jsduck/relations"

describe JsDuck::Aggregator do
  def parse(string)
    agr = JsDuck::Aggregator.new
    agr.aggregate(JsDuck::SourceFile.new(string))
    agr.process_overrides
    JsDuck::Relations.new(agr.result.map {|cls| JsDuck::Class.new(cls) })
  end

  shared_examples_for "override" do
    it "gets :override property" do
      @method.should have_key(:overrides)
    end

    it "lists parent method in :override property" do
      @method[:overrides][0][:owner].should == "Parent"
    end
  end

  describe "method overriding parent class method" do
    before do
      @docs = parse(<<-EOF)
/** @class Parent */
/** @method foo */

/** @class Child @extends Parent */
/** @method foo */
EOF
      @method = @docs["Child"].members(:method)[0]
    end

    it_should_behave_like "override"
  end

  describe "mixin method overriding parent class method" do
    before do
      @docs = parse(<<-EOF)
/** @class Parent */
/** @method foo */
/** @class Mixin */
/** @method foo */

/** @class Child @extends Parent @mixins Mixin */
EOF
      @method = @docs["Child"].members(:method)[0]
    end

    it_should_behave_like "override"
  end

  describe "mixin method overriding multiple parent class methods" do
    before do
      @docs = parse(<<-EOF)
/** @class Parent1 */
/** @method foo */
/** @class Parent2 */
/** @method foo */
/** @class Mixin */
/** @method foo */

/** @class Child1 @extends Parent1 @mixins Mixin */
/** @class Child2 @extends Parent2 @mixins Mixin */
EOF
      # Call #members on two child classes, this will init the
      # :overrides in Mixin class
      @docs["Child1"].members(:method)
      @docs["Child2"].members(:method)

      @method = @docs["Mixin"].members(:method)[0]
    end

    it "gets :override property listing multiple methods" do
      @method[:overrides].length.should == 2
    end
  end

  def create_members_map(cls)
    r = {}
    cls.all_local_members.each do |m|
      r[m[:name]] = m
    end
    r
  end

  describe "defining @override for a class" do
    let(:classes) do
      parse(<<-EOF)
/**
* @class Foo
* Foo comment.
*/
/**
* @method foo
* Foo comment.
*/
/**
* @method foobar
* Original comment.
*/

/**
* @class FooOverride
* @override Foo
* FooOverride comment.
*/
/**
* @method bar
* Bar comment.
*/
/**
* @method foobar
* Override comment.
*/
EOF
    end

    let(:methods) { create_members_map(classes["Foo"]) }

    it "keeps the original class" do
      classes["Foo"].should_not == nil
    end

    it "throws away the override" do
      classes["FooOverride"].should == nil
    end

    it "combines class doc with doc from override" do
      classes["Foo"][:doc].should == "Foo comment.\n\n**From override FooOverride:** FooOverride comment."
    end

    it "adds override to list of source files" do
      classes["Foo"][:files].length.should == 2
    end

    it "keeps its original foo method" do
      methods["foo"].should_not == nil
    end

    it "gets the new bar method from override" do
      methods["bar"].should_not == nil
    end

    it "adds special override comment to bar method" do
      methods["bar"][:doc].should == "Bar comment.\n\n**Defined in override FooOverride.**"
    end

    it "changes owner of bar method to target class" do
      methods["bar"][:owner].should == "Foo"
    end

    it "keeps the foobar method that's in both original and override" do
      methods["foobar"].should_not == nil
    end

    it "combines docs of original and override" do
      methods["foobar"][:doc].should == "Original comment.\n\n**From override FooOverride:** Override comment."
    end

    it "adds override source to list of files to overridden member" do
      methods["foobar"][:files].length.should == 2
    end

    it "keeps owner of foobar method to be the original class" do
      methods["foobar"][:owner].should == "Foo"
    end
  end

  describe "comment-less @override for a class" do
    let(:classes) do
      parse(<<-EOF)
/**
* @class Foo
* Foo comment.
*/
/**
* @method foobar
* Original comment.
*/

/**
* @class FooOverride
* @override Foo
*/
/**
* @method foobar
*/
EOF
    end

    let(:methods) { create_members_map(classes["Foo"]) }

    it "adds no doc from override to the class itself" do
      classes["Foo"][:doc].should == "Foo comment."
    end

    it "adds note about override to member" do
      methods["foobar"][:doc].should == "Original comment.\n\n**Overridden in FooOverride.**"
    end
  end

  describe "auto-detected override: in Ext.define" do
    let(:classes) do
      parse(<<-EOF)
/** */
Ext.define("Foo", {
foobar: function(){}
});

/** */
Ext.define("FooOverride", {
override: "Foo",
bar: function(){},
foobar: function(){ return true; }
});
EOF
    end

    let(:methods) { create_members_map(classes["Foo"]) }

    it "adds member to overridden class" do
      methods["bar"].should_not == nil
    end

    it "adds note to docs about member being overridden" do
      methods["foobar"][:doc].should == "**Overridden in FooOverride.**"
    end
  end
end
Something went wrong with that request. Please try again.