yard 0.9.5 → 0.9.6

data/templates/default/method/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   sections :header, [T('method_details')]
-end
+end

data/templates/default/method_details/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   sections :header, [:method_signature, T('docstring'), :source]
 end

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

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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   @modules = object.children.select {|o| o.type == :module }
   @classes = object.children.select {|o| o.type == :class }
@@ -11,4 +12,4 @@ end
 
 def classes
   @classes.map {|k| yieldall :object => k }.join("\n")
-end
+end

data/templates/default/module/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 include Helpers::ModuleHelper
 
 def init
@@ -28,15 +29,15 @@ 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)
+  @mm = mms.find {|o| o.name == :method_missing && o.scope == :instance }
+  erb(:methodmissing) if @mm
 end
 
 def method_listing(include_specials = true)
   return @smeths ||= method_listing.reject {|o| special_method?(o) } unless include_specials
-  return @meths if @meths
+  return @meths if defined?(@meths) && @meths
   @meths = object.meths(:inherited => false, :included => !options.embed_mixins.empty?)
-  if options.embed_mixins.size > 0
+  unless options.embed_mixins.empty?
     @meths = @meths.reject {|m| options.embed_mixins_match?(m.namespace) == false }
   end
   @meths = sort_listing(prune_method_listing(@meths))
@@ -50,14 +51,14 @@ def special_method?(meth)
 end
 
 def attr_listing
-  return @attrs if @attrs
+  return @attrs if defined?(@attrs) && @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)
+    next if !options.embed_mixins.empty? &&
+            !options.embed_mixins_match?(superclass)
     [:class, :instance].each do |scope|
-      superclass.attributes[scope].each do |name, rw|
+      superclass.attributes[scope].each do |_name, rw|
         attr = prune_method_listing([rw[:read], rw[:write]].compact, false).first
         @attrs << attr if attr
       end
@@ -68,7 +69,7 @@ def attr_listing
 end
 
 def constant_listing
-  return @constants if @constants
+  return @constants if defined?(@constants) && @constants
   @constants = object.constants(:included => false, :inherited => false)
   @constants += object.cvars
   @constants = run_verifier(@constants)
@@ -79,40 +80,36 @@ def sort_listing(list)
   list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end
 
-def inherited_attr_list(&block)
+def inherited_attr_list
   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
+    next if !options.embed_mixins.empty? && 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 = attribs.select {|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
+    yield superclass, attribs unless attribs.empty?
   end
 end
 
-def inherited_constant_list(&block)
+def inherited_constant_list
   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
+    next if !options.embed_mixins.empty? && 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.select {|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
+    yield superclass, consts unless consts.empty?
   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
+  docstring = obj.tags(:overload).size == 1 && obj.docstring.empty? ?
+    obj.tag(:overload).docstring : obj.docstring
 
   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)
+    docstring = Docstring.new(obj.tag(:return).text.gsub(/\A([a-z])/, &:upcase).strip)
   end
 
   docstring
@@ -123,7 +120,8 @@ def docstring_summary(obj)
 end
 
 def groups(list, type = "Method")
-  if groups_data = object.groups
+  groups_data = object.groups
+  if groups_data
     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|

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   sections :header, [T('docstring')], :children, :includes, :extends,
     :class_meths_list, :instance_meths_list
@@ -9,4 +10,4 @@ end
 
 def instance_meths
   @instmeths ||= method_listing.select {|o| o.scope == :instance }
-end
+end

data/templates/default/onefile/html/layout.erb

@@ -3,15 +3,15 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
-    <title><%= @title %></title>
+    <title><%= defined?(@title) ? @title : '' %></title>
     <%= erb(:headers) %>
   </head>
   <body>
     <div id="content">
-      <h1><%= @title %></h1>
+      <h1><%= defined?(@title) ? @title : '' %></h1>
       <%= yieldall %>
     </div>
 
     <%= erb(:footer) %>
   </body>
-</html>
+</html>

data/templates/default/onefile/html/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 include T('default/layout/html')
 include YARD::Parser::Ruby::Legacy
 
@@ -15,7 +16,6 @@ def all_objects
 end
 
 def layout
-  fulldoc = Object.new.extend(T('fulldoc'))
   layout = Object.new.extend(T('layout'))
   @css_data = layout.stylesheets.map {|sheet| read_asset(sheet) }.join("\n")
   @js_data = layout.javascripts.map {|script| read_asset(script) }.join("")
@@ -24,7 +24,8 @@ def layout
 end
 
 def read_asset(file)
-  return unless file = T('fulldoc').find_file(file)
+  file = T('fulldoc').find_file(file)
+  return unless file
   data = File.read(file)
   superfile = self.class.find_nth_file('fulldoc', 2)
   data.gsub!('{{{__super__}}}', superfile ? IO.read(superfile) : "")
@@ -34,7 +35,7 @@ end
 private
 
 def parse_top_comments_from_file
-  return unless @readme
+  return unless defined?(@readme) && @readme
   return @readme.contents unless @readme.filename =~ /\.rb$/
   data = ""
   tokens = TokenList.new(@readme.contents)
@@ -48,14 +49,14 @@ end
 def override_serializer
   return if @serializer.nil?
   class << @serializer
-    def serialize(object, data)
+    define_method(:serialize) do |object, data|
       return unless object == 'index.html'
-      super
+      super(object, data)
     end
 
-    def serialized_path(object)
+    define_method(:serialized_path) do |object|
       return object if object.is_a?(String)
-      return 'index.html'
+      'index.html'
     end
   end
-end
+end

data/templates/default/root/dot/setup.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 include T('default/module/dot')
 
-def format_path(object)
+def format_path(_object)
   ""
-end
+end

data/templates/default/root/html/setup.rb

@@ -1 +1,2 @@
-include T('default/module/html')
+# frozen_string_literal: true
+include T('default/module/html')

data/templates/default/tags/html/option.erb

@@ -1,6 +1,6 @@
 <% if object.has_tag?(:option) %>
   <% object.parameters.each do |param, default| %>
-    <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+/, '') } %>
+    <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+|:$/, '') } %>
     <% next if tags.empty? %>
     <p class="tag_title">Options Hash (<tt><%= param %></tt>):</p>
     <ul class="option">

data/templates/default/tags/html/tag.erb

@@ -1,4 +1,4 @@
-<p class="tag_title"><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</p>
+<p class="tag_title"><%= (defined?(@label) && @label) ? @label : YARD::Tags::Library.labels[@name] %>:</p>
 <ul class="<%= @name %>">
   <% object.tags(@name).each do |tag| %>
     <li>

data/templates/default/tags/setup.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 def init
   tags = Tags::Library.visible_tags - [:abstract, :deprecated, :note, :todo]
   create_tag_methods(tags - [:example, :option, :overload, :see])
-  sections :index, tags.map {|t| t.to_s.gsub('.', '_').to_sym }
+  sections :index, tags.map {|t| t.to_s.tr('.', '_').to_sym }
   sections.any(:overload).push(T('docstring'))
 end
 
@@ -22,17 +23,18 @@ private
 def tag(name, opts = nil)
   return unless object.has_tag?(name)
   opts ||= options_for_tag(name)
-  @no_names = true if opts[:no_names]
-  @no_types = true if opts[:no_types]
+  @no_names = opts[:no_names] ? true : false
+  @no_types = opts[:no_types] ? true : false
   @name = name
   out = erb('tag')
-  @no_names, @no_types = nil, nil
+  @no_names = nil
+  @no_types = nil
   out
 end
 
 def create_tag_methods(tags)
   tags.each do |tag|
-    tag_meth = tag.to_s.gsub('.', '_')
+    tag_meth = tag.to_s.tr('.', '_')
     next if respond_to?(tag_meth)
     instance_eval(<<-eof, __FILE__, __LINE__ + 1)
       def #{tag_meth}; tag(#{tag.inspect}) end

data/templates/default/tags/text/option.erb

@@ -1,6 +1,6 @@
 <% if object.has_tag?(:option) %>
 <% object.parameters.each do |param, default| %>
-<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
+<% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+|:$/, '') } %>
 <% next if tags.empty? %>
 Options Hash (<%= param %>):
 --------------<%= hr(param.to_s.length) %>--

data/templates/default/tags/text/tag.erb

@@ -1,4 +1,4 @@
-<% title = @label ? @label : YARD::Tags::Library.labels[@name] %>
+<% title = (defined?(@label) && @label) ? @label : YARD::Tags::Library.labels[@name] %>
 <%= title %>:
 <%= hr(title.length) %>-
 
@@ -10,4 +10,4 @@
 <% text += tag.text if tag.text && !tag.text.empty? %>
 <%= indent wrap(text) %>
 
-<% end %>
+<% end %>

data/templates/guide/class/html/setup.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 include T('guide/module/html')

data/templates/guide/docstring/html/setup.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 include T('default/docstring/html')