Auto-detection of class extends. (0417d7c6) · Commits · extjs / jsduck

lib/jsduck/ast.rb

+41 −5

Original line number	Diff line number	Diff line
		@@ -13,27 +13,43 @@ module JsDuck
		exp = expression?(ast) ? ast["expression"] : nil
		var = var?(ast) ? ast["declarations"][0] : nil

		# Ext.define("Class", {})
		if exp && ext_define?(exp)
		make_class(exp["arguments"][0])
		make_class(exp["arguments"][0], exp)

		elsif exp && assignment?(exp) && (ext_extend?(exp["right"]) \|\| class_name?(exp["left"]))
		# foo = Ext.extend("Parent", {})
		elsif exp && assignment?(exp) && ext_extend?(exp["right"])
		make_class(exp["left"], exp["right"])

		# Foo = ...
		elsif exp && assignment?(exp) && class_name?(exp["left"])
		make_class(exp["left"])

		elsif var && (ext_extend?(var["init"]) \|\| class_name?(var["id"]))
		# var foo = Ext.extend("Parent", {})
		elsif var && ext_extend?(var["init"])
		make_class(var["id"], var["init"])

		# var Foo = ...
		elsif var && class_name?(var["id"])
		make_class(var["id"])

		# function Foo() {}
		elsif function?(ast) && class_name?(ast["id"])
		make_class(ast["id"])

		# function foo() {}
		elsif function?(ast)
		make_method(ast["id"], ast)

		# foo = function() {}
		elsif exp && assignment?(exp) && function?(exp["right"])
		make_method(exp["left"], exp["right"])

		# var foo = function() {}
		elsif var && function?(var["init"])
		make_method(var["id"], var["init"])

		# foo: function() {}
		elsif property?(ast) && function?(ast["value"])
		make_method(ast["key"], ast["value"])

		@@ -86,10 +102,30 @@ module JsDuck
		end

		def make_class(name_ast, ast=nil)
		return {
		cls = {
		:type => :class,
		:name => to_s(name_ast)
		:name => to_s(name_ast),
		}

		# apply information from Ext.extend or Ext.define
		if ast
		if ext_extend?(ast)
		cls[:extends] = to_s(ast["arguments"][0])
		elsif ext_define?(ast)
		cfg = ast["arguments"][1]
		if cfg && cfg["type"] == "ObjectExpression"
		v = get_key_value(cfg, "extend")
		cls[:extends] = v ? to_s(v) : nil
		end
		end
		end

		return cls
		end

		def get_key_value(obj, key)
		p = obj["properties"].find {\|p\| to_s(p["key"]) == key }
		p ? p["value"] : nil
		end

		def make_method(name_ast, ast=nil)

spec/ast_class_spec.rb

+49 −0

Original line number	Diff line number	Diff line
		@@ -41,4 +41,53 @@ describe "JsDuck::Ast detects class with" do
		end
		end

		describe "extends in" do
		it "Ext.extend() assignment" do
		detect("/** */ MyClass = Ext.extend(Your.Class, { });")[:extends].should == "Your.Class"
		end

		it "var initialized with Ext.extend()" do
		detect("/** */ var MyClass = Ext.extend(Your.Class, { });")[:extends].should == "Your.Class"
		end

		it "Ext.define() with extend:" do
		detect(<<-EOS)[:extends].should == "Your.Class"
		/** */
		Ext.define('MyClass', {
		extend: "Your.Class"
		});
		EOS
		end

		it "Ext.define() with extend: as second object property" do
		detect(<<-EOS)[:extends].should == "Your.Class"
		/** */
		Ext.define('MyClass', {
		foo: 5,
		extend: "Your.Class"
		});
		EOS
		end
		end

		describe "no extends in" do
		it "Ext.define() with function argument" do
		detect(<<-EOS)[:extends].should == nil
		/** */
		Ext.define('MyClass', function() {
		});
		EOS
		end

		it "Ext.define() with no extend: in config object" do
		detect(<<-EOS)[:extends].should == nil
		/** */
		Ext.define('MyClass', {
		foo: 5,
		bar: "hah"
		});
		EOS
		end
		end

		end