gooddata 0.6.6 → 0.6.7

data/doc/templates/default/class/text/setup.rb

@@ -1,11 +0,0 @@
-include T('default/module/text')
-
-def init
-  super
-  sections.place(:subclasses).before(:children)
-  sections.delete(:children)
-end
-
-def format_object_title(object)
-  "Class: #{object.title} < #{object.superclass.title}"
-end

data/doc/templates/default/class/text/subclasses.erb

@@ -1,5 +0,0 @@
-Direct Known Subclasses:
-------------------------
-
-<%= indent(wrap(@subclasses.map {|name, child| name }.join(", "))) %>
-

data/doc/templates/default/constant/text/header.erb

@@ -1,11 +0,0 @@
-<%= title_align_right format_object_title(object) %>
-
-
-<%= object.name %> = <%= object.value.size > 40 ? "\n\n" + indent(object.value) : object.value %>
-
-
-<%= hr %>
-
-<%= yieldall %>
-
-<%= hr %>

data/doc/templates/default/constant/text/setup.rb

@@ -1,3 +0,0 @@
-def init
-  sections :header, [T('docstring')]
-end

data/doc/templates/default/docstring/setup.rb

@@ -1,51 +0,0 @@
-def init
-  return if object.docstring.blank? && !object.has_tag?(:api)
-  sections :index, [:private, :deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
-end
-
-def private
-  return unless object.has_tag?(:api) && object.tag(:api).text == 'private'
-  erb(:private)
-end
-
-def abstract
-  return unless object.has_tag?(:abstract)
-  erb(:abstract)
-end
-
-def deprecated
-  return unless object.has_tag?(:deprecated)
-  erb(:deprecated)
-end
-
-def todo
-  return unless object.has_tag?(:todo)
-  erb(:todo)
-end
-
-def note
-  return unless object.has_tag?(:note)
-  erb(:note)
-end
-
-def returns_void
-  return unless object.type == :method
-  return if object.name == :initialize && object.scope == :instance
-  return unless object.tags(:return).size == 1 && object.tag(:return).types == ['void']
-  erb(:returns_void)
-end
-
-def docstring_text
-  text = ""
-  unless object.tags(:overload).size == 1 && object.docstring.empty?
-    text = object.docstring
-  end
-
-  if text.strip.empty? && object.tags(:return).size == 1 && object.tag(:return).text
-    text = object.tag(:return).text.gsub(/\A([a-z])/) {|x| x.downcase }
-    text = "Returns #{text}" unless text.empty? || text =~ /^\s*return/i
-    text = text.gsub(/\A([a-z])/) {|x| x.upcase }
-  end
-
-  text.strip
-end

data/doc/templates/default/docstring/text/abstract.erb

@@ -1,2 +0,0 @@
-<%= indent(wrap("Abstract. #{object.tag(:abstract).text}")) %>
-

data/doc/templates/default/docstring/text/deprecated.erb

@@ -1,2 +0,0 @@
-<%= indent(wrap("Deprecated. #{object.tag(:deprecated).text}")) %>
-

data/doc/templates/default/docstring/text/index.erb

@@ -1,2 +0,0 @@
-
-<%= yieldall %>

data/doc/templates/default/docstring/text/note.erb

@@ -1,4 +0,0 @@
-<% object.tags(:note).each do |tag| %>
-<%= indent(wrap("Note: #{tag.text}")) %>
-
-<% end %>

data/doc/templates/default/docstring/text/private.erb

@@ -1,2 +0,0 @@
-<%= indent(wrap("This #{object.type} is part of a private API.")) %>
-

data/doc/templates/default/docstring/text/returns_void.erb

@@ -1 +0,0 @@
-<%= indent(wrap("This method returns an undefined value.")) %>

data/doc/templates/default/docstring/text/text.erb

@@ -1 +0,0 @@
-<%= indent wrap(h(docstring_text.strip), 68) %>

data/doc/templates/default/docstring/text/todo.erb

@@ -1,4 +0,0 @@
-<% object.tags(:todo).each do |tag| %>
-<%= indent(wrap("TODO: #{tag.text}")) %>
-
-<% end %>

data/doc/templates/default/layout/dot/header.erb

@@ -1,6 +0,0 @@
-digraph yard {
-  graph [rankdir=BT rank=sink outputMode=nodesfirst packMode="graph" splines=true];
-  node [shape=record rank=sink rankType=sink];
-
-  <%= yieldall %>
-}

data/doc/templates/default/layout/dot/setup.rb

@@ -1,14 +0,0 @@
-attr_reader :contents
-
-def init
-  if object
-    type = object.root? ? :module : object.type
-    sections :header, [T(type)]
-  else
-    sections :header, [:contents]
-  end
-end
-
-def header
-  tidy erb(:header)
-end

data/doc/templates/default/method/setup.rb

@@ -1,3 +0,0 @@
-def init
-  sections :header, [T('method_details')]
-end

data/doc/templates/default/method/text/header.erb

@@ -1 +0,0 @@
-<%= yieldall %>

data/doc/templates/default/method_details/setup.rb

@@ -1,11 +0,0 @@
-def init
-  super
-  sections :header, [:method_signature, T('docstring'), :source, :specs]
-end
-
-def source
-  return if owner != object.namespace
-  return if Tags::OverloadTag === object
-  return if object.source.nil?
-  erb(:source)
-end

data/doc/templates/default/method_details/text/header.erb

@@ -1,10 +0,0 @@
-<%= title_align_right format_object_title(object) %>
-
-<%= align_right "(Defined in: #{object.file})" %>
-<% if object.aliases.size > 0 %>
-
-<%= align_right "(Also known as: #{object.aliases.map {|o| o.name(true).to_s }.join(',')})" %>
-<% end %>
-
-<%= yieldall %>
-

data/doc/templates/default/method_details/text/method_signature.erb

@@ -1,12 +0,0 @@
-
-<% if object.tags(:overload).size == 1 %>
-<%= indent wrap(signature(object.tag(:overload))) %>
-<% elsif object.tags(:overload).size > 1 %>
-<% object.tags(:overload).each do |overload| %>
-<%= indent wrap(signature(overload)) %>
-<% end %>
-<% else %>
-<%= indent wrap(signature(object)) %>
-<% end %>
-<%= hr %>
-

data/doc/templates/default/method_details/text/setup.rb

@@ -1,10 +0,0 @@
-def init
-  super
-  sections.last.pop
-end
-
-def format_object_title(object)
-  title = "Method: #{object.name(true)}"
-  title += " (#{object.namespace})" if !object.namespace.root?
-  title
-end

data/doc/templates/default/module/dot/child.erb

@@ -1 +0,0 @@
-<%= format_path object %> [label="{<%= yieldall.gsub("\n", '') %>}" rank=sink];

data/doc/templates/default/module/dot/dependencies.erb

@@ -1,3 +0,0 @@
-<% object.mixins(:instance).each do |obj| %>
-  <%= format_path object %> -> <%= format_path obj %> [style=dotted arrowType=none];
-<% end %>

data/doc/templates/default/module/dot/header.erb

@@ -1,6 +0,0 @@
-subgraph cluster_<%= format_path object %> {
-  label = "<%= h(object.name) unless object.path == "" %>"; labelloc=b;
-  <% for obj in @modules %>
-    <%= yieldall :object => obj %>
-  <% end %>
-}

data/doc/templates/default/module/dot/info.erb

@@ -1,14 +0,0 @@
-<%= object.type %> <%= h object.name %>
-<% if options.full %>
-|
-<% object.attributes.each do |scope, list| %>
-<% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>
-<%= uml_visibility(rw.values.compact.first) %> <%= h (rw[:read]||rw[:write]).name(true).gsub(/=$/,'') %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
-<% end %>
-<% end %>
-|
-<% method_listing.each do |obj| %>
-<%= uml_visibility obj %> <%= h obj.name(true) %>
-<%= h(" : #{obj.tag(:return).types.first}") if obj.has_tag?(:return) && obj.tag(:return).types && obj.tag(:return).types.size > 0 %>\l
-<% end %>
-<% end %>

data/doc/templates/default/module/dot/setup.rb

@@ -1,14 +0,0 @@
-def init
-  @modules = object.children.select {|o| o.type == :module }
-  @classes = object.children.select {|o| o.type == :class }
-  sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
-end
-
-def dependencies
-  return unless options.dependencies
-  erb(:dependencies)
-end
-
-def classes
-  @classes.map {|k| yieldall :object => k }.join("\n")
-end

data/doc/templates/default/module/setup.rb

@@ -1,164 +0,0 @@
-include Helpers::ModuleHelper
-
-def init
-  sections :header, :box_info, :pre_docstring, T('docstring'), :specs, :children,
-    :constant_summary, [T('docstring')], :inherited_constants,
-    :attribute_summary, [:item_summary], :inherited_attributes,
-    :method_summary, [:item_summary], :inherited_methods,
-    :methodmissing, [T('method_details')],
-    :attribute_details, [T('method_details')],
-    :method_details_list, [T('method_details')]
-end
-
-def pre_docstring
-  return if object.docstring.blank?
-  erb(:pre_docstring)
-end
-
-def children
-  @inner = [[:modules, []], [:classes, []]]
-  object.children.each do |child|
-    @inner[0][1] << child if child.type == :module
-    @inner[1][1] << child if child.type == :class
-  end
-  @inner.map! {|v| [v[0], run_verifier(v[1].sort_by {|o| o.name.to_s })] }
-  return if (@inner[0][1].size + @inner[1][1].size) == 0
-  erb(:children)
-end
-
-def methodmissing
-  mms = object.meths(:inherited => true, :included => true)
-  return unless @mm = mms.find {|o| o.name == :method_missing && o.scope == :instance }
-  erb(:methodmissing)
-end
-
-def method_listing(include_specials = true)
-  return @smeths ||= method_listing.reject {|o| special_method?(o) } unless include_specials
-  return @meths if @meths
-  @meths = object.meths(:inherited => false, :included => !options.embed_mixins.empty?)
-  if options.embed_mixins.size > 0
-    @meths = @meths.reject {|m| !options.embed_mixins_match?(m.namespace) }
-  end
-  @meths = sort_listing(prune_method_listing(@meths))
-  @meths
-end
-
-def special_method?(meth)
-  return true if meth.name(true) == '#method_missing'
-  return true if meth.constructor?
-  false
-end
-
-def attr_listing
-  return @attrs if @attrs
-  @attrs = []
-  object.inheritance_tree(true).each do |superclass|
-    next if superclass.is_a?(CodeObjects::Proxy)
-    next if options.embed_mixins.size > 0 &&
-      options.embed_mixins_match?(superclass) == false
-    [:class, :instance].each do |scope|
-      superclass.attributes[scope].each do |name, rw|
-        attr = prune_method_listing([rw[:read], rw[:write]].compact, false).first
-        @attrs << attr if attr
-      end
-    end
-    break if options.embed_mixins.empty?
-  end
-  @attrs = sort_listing(@attrs)
-end
-
-def constant_listing
-  return @constants if @constants
-  @constants = object.constants(:included => false, :inherited => false)
-  @constants += object.cvars
-  @constants = run_verifier(@constants)
-  @constants
-end
-
-def sort_listing(list)
-  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
-end
-
-def inherited_attr_list(&block)
-  object.inheritance_tree(true)[1..-1].each do |superclass|
-    next if superclass.is_a?(YARD::CodeObjects::Proxy)
-    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
-    attribs = superclass.attributes[:instance]
-    attribs = attribs.reject {|name, rw| object.child(:scope => :instance, :name => name) != nil }
-    attribs = attribs.sort_by {|args| args.first.to_s }.map {|n, m| m[:read] || m[:write] }
-    attribs = prune_method_listing(attribs, false)
-    yield superclass, attribs if attribs.size > 0
-  end
-end
-
-def inherited_constant_list(&block)
-  object.inheritance_tree(true)[1..-1].each do |superclass|
-    next if superclass.is_a?(YARD::CodeObjects::Proxy)
-    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
-    consts = superclass.constants(:included => false, :inherited => false)
-    consts = consts.reject {|const| object.child(:type => :constant, :name => const.name) != nil }
-    consts = consts.sort_by {|const| const.name.to_s }
-    consts = run_verifier(consts)
-    yield superclass, consts if consts.size > 0
-  end
-end
-
-def docstring_full(obj)
-  docstring = ""
-  if obj.tags(:overload).size == 1 && obj.docstring.empty?
-    docstring = obj.tag(:overload).docstring
-  else
-    docstring = obj.docstring
-  end
-
-  if docstring.summary.empty? && obj.tags(:return).size == 1 && obj.tag(:return).text
-    docstring = Docstring.new(obj.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }.strip)
-  end
-
-  docstring
-end
-
-def docstring_summary(obj)
-  docstring_full(obj).summary
-end
-
-def groups(list, type = "Method")
-  if groups_data = object.groups
-    list.each {|m| groups_data |= [m.group] if m.group && owner != m.namespace }
-    others = list.select {|m| !m.group || !groups_data.include?(m.group) }
-    groups_data.each do |name|
-      items = list.select {|m| m.group == name }
-      yield(items, name) unless items.empty?
-    end
-  else
-    others = []
-    group_data = {}
-    list.each do |meth|
-      if meth.group
-        (group_data[meth.group] ||= []) << meth
-      else
-        others << meth
-      end
-    end
-    group_data.each {|group, items| yield(items, group) unless items.empty? }
-  end
-
-  scopes(others) {|items, scope| yield(items, "#{scope.to_s.capitalize} #{type} Summary") }
-end
-
-def scopes(list)
-  [:class, :instance].each do |scope|
-    items = list.select {|m| m.scope == scope }
-    yield(items, scope) unless items.empty?
-  end
-end
-
-def mixed_into(object)
-  unless globals.mixed_into
-    globals.mixed_into = {}
-    list = run_verifier Registry.all(:class, :module)
-    list.each {|o| o.mixins.each {|m| (globals.mixed_into[m.path] ||= []) << o } }
-  end
-
-  globals.mixed_into[object.path] || []
-end

data/doc/templates/default/module/text/children.erb

@@ -1,10 +0,0 @@
-Defined Under Namespace:
-------------------------
-
-<% @inner.each do |name, list| %>
-<% if list.size > 0 %>
-<% text = list.map {|c| c.name }.join(", ") + " (#{name})" %>
-<%= indent(wrap(text)) %>
-
-<% end %>
-<% end %>

data/doc/templates/default/module/text/class_meths_list.erb

@@ -1,8 +0,0 @@
-<% if class_meths.size > 0 %>
-Class methods:
---------------
-
-<%= indent wrap(class_meths.map {|o| o.name.to_s }.join(", "), 68) %>
-
-
-<% end %>

data/doc/templates/default/module/text/extends.erb

@@ -1,8 +0,0 @@
-<% if object.mixins(:class).size > 0 %>
-Extended by:
-------------
-
-<%= indent wrap(object.mixins(:class).join(", "), 68) %>
-
-
-<% end %>