Extract Subproperties class from Renderer. (77aca643) · Commits · extjs / jsduck

lib/jsduck/renderer.rb

+2 −89

Original line number	Diff line number	Diff line
		@@ -2,6 +2,7 @@ require 'jsduck/util/html'
		require 'jsduck/signature_renderer'
		require 'jsduck/tag_renderer'
		require 'jsduck/sidebar'
		require 'jsduck/subproperties'

		module JsDuck

		@@ -145,99 +146,11 @@ module JsDuck

		doc << render_tags(m)

		doc << render_params_and_return(m)
		doc << Subproperties.render_member(m)

		doc
		end

		# Handles both rendering of method parameters and return value.
		# Plus the rendering of object properties, which could also be
		# functions in which case they too will be rendered with
		# parameters and return value.
		def render_params_and_return(item)
		doc = []

		if item[:params] && item[:params].length > 0
		params = item[:params]
		elsif item[:properties] && item[:properties].length > 0
		params = item[:properties]
		# If the name of last property is "return"
		# remove it from params list and handle it separately afterwards
		if params.last[:name] == "return"
		ret = params.last
		params = params.slice(0, params.length-1)
		end
		end

		if params
		if item[:type] == "Function" \|\| item[:tagname] == :method \|\| item[:tagname] == :event
		doc << '<h3 class="pa">Parameters</h3>'
		end
		doc << [
		"<ul>",
		params.map {\|p\| render_long_param(p) },
		"</ul>",
		]
		end

		if item[:return]
		doc << render_return(item[:return])
		elsif ret
		doc << render_return(ret)
		end

		if item[:throws]
		doc << render_throws(item[:throws])
		end

		doc
		end

		def render_long_param(p)
		return [
		"<li>",
		"<span class='pre'>#{p[:name]}</span> : ",
		p[:html_type],
		p[:optional] ? " (optional)" : "",
		"<div class='sub-desc'>",
		p[:doc],
		p[:default] ? "<p>Defaults to: <code>#{Util::HTML.escape(p[:default])}</code></p>" : "",
		p[:properties] && p[:properties].length > 0 ? render_params_and_return(p) : "",
		"</div>",
		"</li>",
		]
		end

		def render_return(ret)
		return [
		"<h3 class='pa'>Returns</h3>",
		"<ul>",
		"<li>",
		"<span class='pre'>#{ret[:html_type]}</span>",
		"<div class='sub-desc'>",
		ret[:doc],
		ret[:properties] && ret[:properties].length > 0 ? render_params_and_return(ret) : "",
		"</div>",
		"</li>",
		"</ul>",
		]
		end

		def render_throws(throws)
		return [
		"<h3 class='pa'>Throws</h3>",
		"<ul>",
		throws.map do \|thr\|
		[
		"<li>",
		"<span class='pre'>#{thr[:html_type]}</span>",
		"<div class='sub-desc'>#{thr[:doc]}</div>",
		"</li>",
		]
		end,
		"</ul>",
		]
		end
		end

		end

lib/jsduck/subproperties.rb

0 → 100644

+105 −0

Original line number	Diff line number	Diff line
		require 'jsduck/util/html'
		require 'jsduck/util/singleton'

		module JsDuck

		# Renders params, return values and everything else that can have
		# nested subproperties.
		class Subproperties
		include Util::Singleton

		def render_member(item)
		doc = []
		doc << render_params(item[:params]) if item[:params] && item[:params].length > 0
		doc << render_return(item[:return]) if item[:return]
		doc << render_throws(item[:throws]) if item[:throws]
		doc
		end

		# Renders object properties, which could also be functions in
		# which case they will be rendered with parameters and return
		# value.
		def render(item)
		doc = []

		if item[:type] == "Function"
		params = item[:properties]
		# If the name of last property is "return" remove it from
		# properties list and format as a return value afterwards.
		if item[:properties].last[:name] == "return"
		ret = params.last
		params = params.slice(0, params.length-1)
		end

		doc << render_params(params)
		doc << render_return(ret) if ret
		else
		doc << render_list(item[:properties])
		end

		doc
		end

		def render_params(params)
		return [
		'<h3 class="pa">Parameters</h3>',
		render_list(params),
		]
		end

		def render_list(params)
		return [
		"<ul>",
		params.map {\|p\| render_single_param(p) },
		"</ul>",
		]
		end

		def render_single_param(p)
		return [
		"<li>",
		"<span class='pre'>#{p[:name]}</span> : ",
		p[:html_type],
		p[:optional] ? " (optional)" : "",
		"<div class='sub-desc'>",
		p[:doc],
		p[:default] ? "<p>Defaults to: <code>#{Util::HTML.escape(p[:default])}</code></p>" : "",
		p[:properties] && p[:properties].length > 0 ? render(p) : "",
		"</div>",
		"</li>",
		]
		end

		def render_return(ret)
		return [
		"<h3 class='pa'>Returns</h3>",
		"<ul>",
		"<li>",
		"<span class='pre'>#{ret[:html_type]}</span>",
		"<div class='sub-desc'>",
		ret[:doc],
		ret[:properties] && ret[:properties].length > 0 ? render(ret) : "",
		"</div>",
		"</li>",
		"</ul>",
		]
		end

		def render_throws(throws)
		return [
		"<h3 class='pa'>Throws</h3>",
		"<ul>",
		throws.map do \|thr\|
		[
		"<li>",
		"<span class='pre'>#{thr[:html_type]}</span>",
		"<div class='sub-desc'>#{thr[:doc]}</div>",
		"</li>",
		]
		end,
		"</ul>",
		]
		end
		end

		end