Split @method and @event specs to multiple files. (5978ee6c) · Commits · extjs / jsduck

spec/aggregator_event_spec.rb

0 → 100644

+78 −0

Original line number	Diff line number	Diff line
		require "jsduck/aggregator"
		require "jsduck/source_file"

		describe JsDuck::Aggregator do

		def parse(string)
		agr = JsDuck::Aggregator.new
		agr.aggregate(JsDuck::SourceFile.new(string))
		agr.result
		end

		shared_examples_for "event" do
		it "creates event" do
		@doc[:tagname].should == :event
		end

		it "takes documentation from doc-comment" do
		@doc[:doc].should == "Fires when needed."
		end

		it "detects event name" do
		@doc[:name].should == "mousedown"
		end
		end

		describe "explicit event" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @event mousedown
		* Fires when needed.
		*/
		EOS
		end
		it_should_behave_like "event"
		end

		describe "event with @event after @params" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Fires when needed.
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		* @event mousedown
		*/
		EOS
		end
		it_should_behave_like "event"
		end

		describe "implicit event name as string" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @event
		* Fires when needed.
		*/
		"mousedown"
		EOS
		end
		it_should_behave_like "event"
		end

		describe "implicit event name as object property" do
		before do
		@doc = parse(<<-EOS)[0]
		({/**
		* @event
		* Fires when needed.
		*/
		mousedown: true })
		EOS
		end
		it_should_behave_like "event"
		end

		end

spec/aggregator_methods_and_events_spec.rb→spec/aggregator_method_spec.rb

+168 −0

Original line number	Diff line number	Diff line
		@@ -9,7 +9,7 @@ describe JsDuck::Aggregator do
		agr.result
		end

		shared_examples_for "method documentation" do
		shared_examples_for "method" do
		it "creates method" do
		@doc[:tagname].should == :method
		end
		@@ -23,125 +23,99 @@ describe JsDuck::Aggregator do
		end
		end

		shared_examples_for "no parameters" do
		it "by default methods have no parameters" do
		@doc[:params].length.should == 0
		end
		end

		shared_examples_for "two parameters" do
		it "detects parameter count" do
		@doc[:params].length.should == 2
		end

		it "detects parameter names" do
		@doc[:params][0][:name].should == "x"
		@doc[:params][1][:name].should == "y"
		end
		end

		shared_examples_for "parameter types" do
		it "detects parameter types" do
		@doc[:params][0][:type].should == "String"
		@doc[:params][1][:type].should == "Number"
		end
		end

		shared_examples_for "parameter default types" do
		it "parameter default type is Ibject" do
		@doc[:params][0][:type].should == "Object"
		@doc[:params][1][:type].should == "Object"
		end
		end

		shared_examples_for "parameter docs" do
		it "detects parameter types" do
		@doc[:params][0][:doc].should == "First parameter"
		@doc[:params][1][:doc].should == "Second parameter"
		describe "explicit method" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @method foo
		* Some function
		*/
		EOS
		end
		it_should_behave_like "method"
		end

		shared_examples_for "no return" do
		it "default return type is undefined" do
		@doc[:return][:type].should == "undefined"
		describe "explicit @method after @params-s" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		* @method foo
		*/
		EOS
		end
		it_should_behave_like "method"
		end

		shared_examples_for "has return" do
		it "detects return type" do
		@doc[:return][:type].should == "String"
		end
		it "detects return value comment" do
		@doc[:return][:doc].should == "return value"
		describe "explicit @method followed by function with another name" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @method foo
		*/
		function bar(x, y) {}
		EOS
		end
		it_should_behave_like "method"
		end

		describe "function declaration" do
		before do
		@doc = parse("/** Some function */ function foo() {}")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "no parameters"
		it_should_behave_like "no return"
		end

		describe "function declaration with parameters" do
		before do
		@doc = parse("/** Some function */ function foo(x, y) {}")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter default types"
		it_should_behave_like "no return"
		it_should_behave_like "method"
		end

		describe "function-literal with var" do
		before do
		@doc = parse("/** Some function */ var foo = function() {}")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "function-literal without var" do
		before do
		@doc = parse("/** Some function */ foo = function() {}")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "function-literal in object-literal" do
		before do
		@doc = parse("({ /** Some function */ foo: function() {} })")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "function-literal in object-literal-string" do
		before do
		@doc = parse("({ /** Some function */ 'foo': function() {} })")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "function-literal in prototype-chain" do
		before do
		@doc = parse("/** Some function */ Some.long.prototype.foo = function() {}")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "function-literal in comma-first style" do
		before do
		@doc = parse("({ blah: 7 /** Some function */ , foo: function() {} })")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "Ext.emptyFn in object-literal" do
		before do
		@doc = parse("({ /** Some function */ foo: Ext.emptyFn })")[0]
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "doc-comment followed by 'function'" do
		@@ -154,146 +128,6 @@ describe JsDuck::Aggregator do
		end
		end

		describe "explicit @method without @param-s" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @method foo
		* Some function
		*/
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "no parameters"
		it_should_behave_like "no return"
		end

		describe "explicit @method with @param-s" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @method foo
		* Some function
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		*/
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		it_should_behave_like "parameter docs"
		it_should_behave_like "no return"
		end

		describe "explicit @method after @params-s" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		* @method foo
		*/
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		it_should_behave_like "parameter docs"
		it_should_behave_like "no return"
		end

		describe "explicit @method with @param-s overriding implicit code" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		* @method foo
		*/
		function foo(q, z) {}
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		it_should_behave_like "parameter docs"
		end

		describe "explicit @method followed by function with another name" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @method foo
		*/
		function bar(x, y) {}
		EOS
		end
		it_should_behave_like "no parameters"
		end

		describe "@param-s partially overriding implicit params" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String} x
		* @param {Number} y
		*/
		function foo(q, v, z) {}
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "two parameters"
		end

		describe "@param-s declaring only types" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String}
		* @param {Number}
		*/
		function foo(x, y) {}
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		end

		describe "@return documenting return value" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @return {String} return value
		*/
		function foo() {}
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "has return"
		end

		describe "@returns being alias for @return" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @returns {String} return value
		*/
		function foo() {}
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "has return"
		end

		describe "Doc-comment not followed by function but containing @return" do
		before do
		@doc = parse(<<-EOS)[0]
		@@ -304,7 +138,7 @@ describe JsDuck::Aggregator do
		var foo = Ext.emptyFn;
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "Doc-comment not followed by function but containing @param" do
		@@ -317,7 +151,7 @@ describe JsDuck::Aggregator do
		var foo = Ext.emptyFn;
		EOS
		end
		it_should_behave_like "method documentation"
		it_should_behave_like "method"
		end

		describe "method without doc-comment" do
		@@ -331,81 +165,4 @@ describe JsDuck::Aggregator do
		@docs.length.should == 0
		end
		end

		shared_examples_for "event documentation" do
		it "creates event" do
		@doc[:tagname].should == :event
		end

		it "takes documentation from doc-comment" do
		@doc[:doc].should == "Fires when needed."
		end

		it "detects event name" do
		@doc[:name].should == "mousedown"
		end
		end

		describe "explicit event with name and @params" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @event mousedown
		* Fires when needed.
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		*/
		EOS
		end
		it_should_behave_like "event documentation"
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		it_should_behave_like "parameter docs"
		end

		describe "event with @event after @params" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Fires when needed.
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		* @event mousedown
		*/
		EOS
		end
		it_should_behave_like "event documentation"
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		it_should_behave_like "parameter docs"
		end

		describe "implicit event name as string" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @event
		* Fires when needed.
		*/
		"mousedown"
		EOS
		end
		it_should_behave_like "event documentation"
		it_should_behave_like "no parameters"
		end

		describe "implicit event name as object property" do
		before do
		@doc = parse(<<-EOS)[0]
		({/**
		* @event
		* Fires when needed.
		*/
		mousedown: true })
		EOS
		end
		it_should_behave_like "event documentation"
		it_should_behave_like "no parameters"
		end

		end

spec/aggregator_param_spec.rb

0 → 100644

+138 −0

Original line number	Diff line number	Diff line
		require "jsduck/aggregator"
		require "jsduck/source_file"

		describe JsDuck::Aggregator do

		def parse(string)
		agr = JsDuck::Aggregator.new
		agr.aggregate(JsDuck::SourceFile.new(string))
		agr.result
		end

		shared_examples_for "no parameters" do
		it "detects no params" do
		@doc[:params].length.should == 0
		end
		end

		shared_examples_for "two parameters" do
		it "detects parameter count" do
		@doc[:params].length.should == 2
		end

		it "detects parameter names" do
		@doc[:params][0][:name].should == "x"
		@doc[:params][1][:name].should == "y"
		end
		end

		shared_examples_for "parameter types" do
		it "detects parameter types" do
		@doc[:params][0][:type].should == "String"
		@doc[:params][1][:type].should == "Number"
		end
		end

		describe "explicit @method without @param-s" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @method foo
		* Some function
		*/
		EOS
		end
		it_should_behave_like "no parameters"
		end

		describe "function declaration without params" do
		before do
		@doc = parse("/** Some function */ function foo() {}")[0]
		end
		it_should_behave_like "no parameters"
		end

		describe "function declaration with parameters" do
		before do
		@doc = parse("/** Some function */ function foo(x, y) {}")[0]
		end
		it_should_behave_like "two parameters"
		it "parameter types default to Object" do
		@doc[:params][0][:type].should == "Object"
		@doc[:params][1][:type].should == "Object"
		end
		end

		describe "explicit @method with @param-s" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* @method foo
		* Some function
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		*/
		EOS
		end
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		end

		describe "explicit @method with @param-s overriding implicit code" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String} x First parameter
		* @param {Number} y Second parameter
		* @method foo
		*/
		function foo(q, z) {}
		EOS
		end
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		end

		describe "explicit @method followed by function with another name" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @method foo
		*/
		function bar(x, y) {}
		EOS
		end
		it_should_behave_like "no parameters"
		end

		describe "explicit @param-s followed by more implicit params" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String} x
		* @param {Number} y
		*/
		function foo(q, v, z) {}
		EOS
		end
		it_should_behave_like "two parameters"
		end

		describe "@param-s declaring only types" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @param {String}
		* @param {Number}
		*/
		function foo(x, y) {}
		EOS
		end
		it_should_behave_like "two parameters"
		it_should_behave_like "parameter types"
		end
		end

spec/aggregator_return_spec.rb

0 → 100644

+61 −0

Original line number	Diff line number	Diff line
		require "jsduck/aggregator"
		require "jsduck/source_file"

		describe JsDuck::Aggregator do

		def parse(string)
		agr = JsDuck::Aggregator.new
		agr.aggregate(JsDuck::SourceFile.new(string))
		agr.result
		end

		describe "method without @return" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		*/
		function foo() {}
		EOS
		end
		it "defaults return type to undefined" do
		@doc[:return][:type].should == "undefined"
		end
		end

		shared_examples_for "has return" do
		it "detects return type" do
		@doc[:return][:type].should == "String"
		end
		it "detects return value comment" do
		@doc[:return][:doc].should == "return value"
		end
		end

		describe "@return documenting return value" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @return {String} return value
		*/
		function foo() {}
		EOS
		end
		it_should_behave_like "has return"
		end

		describe "@returns being alias for @return" do
		before do
		@doc = parse(<<-EOS)[0]
		/**
		* Some function
		* @returns {String} return value
		*/
		function foo() {}
		EOS
		end
		it_should_behave_like "has return"
		end

		end