yard 0.9.5 → 0.9.6

data/benchmarks/rdoc_vs_yardoc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 
 files = Dir.glob(File.dirname(__FILE__) + '/../lib/**/*.rb').join(" ")
@@ -7,4 +8,4 @@ Benchmark.bmbm do |x|
   x.report("yardoc-cached") { `rm -rf yard && ./bin/yardoc -c -q -o yard #{files} && rm -rf yard` }
   x.report("yardoc-legacy") { `rm -rf yard && ./bin/yardoc --legacy -q -o yard #{files} && rm -rf yard` }
   x.report("yardoc-legacy-cached") { `rm -rf yard && ./bin/yardoc --legacy -c -q -o yard #{files} && rm -rf yard` }
-end
+end

data/benchmarks/registry_store_types.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'benchmark'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 

data/benchmarks/ri_vs_yri.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 
 TIMES = 10

data/benchmarks/ripper_parser.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'benchmark'
 require File.dirname(__FILE__) + '/../lib/yard'
 
@@ -9,4 +10,4 @@ TIMES = 2
 Benchmark.bmbm do |x|
   x.report("rip-parser") { TIMES.times { $files_rip.each {|f| YARD::Parser::Ruby::RubyParser.parse(*f) } } }
   x.report("yard-parser  ") { TIMES.times { $files.each {|f| YARD::Parser::Ruby::Legacy::StatementList.new(f) } } }
-end
+end

data/benchmarks/splat_vs_flatten.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 
 # To prove that flattening a small list is not significantly slower than
@@ -7,6 +8,6 @@ def foo(*args) args.last.inspect end
 
 TESTS = 10_000
 Benchmark.bmbm do |x|
-  x.report("splat") { TESTS.times { foo *$a } }
-  x.report("flatten") { TESTS.times { foo *[$a].flatten } }
-end
+  x.report("splat") { TESTS.times { foo(*$a) } }
+  x.report("flatten") { TESTS.times { foo(*[$a].flatten) } }
+end

data/benchmarks/template_erb.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 
@@ -19,4 +20,4 @@ Benchmark.bm do |x|
     end
   end
   x.report("no-trim  ") { TIMES.times { obj.format(:format => :html) } }
-end
+end

data/benchmarks/template_format.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "benchmark"
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 

data/benchmarks/template_profile.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'ruby-prof'
-#require 'benchmark'
+# require 'benchmark'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'yard')
 
 YARD::Registry.load_yardoc(File.join(File.dirname(__FILE__), '..', '.yardoc'))
 obj = YARD::Registry.at("YARD::CodeObjects::Base")
 
-#PerfTools::CpuProfiler.start("template_profile") do
-#end
+# PerfTools::CpuProfiler.start("template_profile") do
+# end
 
 result = RubyProf.profile do
   obj.format(:format => :html, :no_highlight => true)

data/benchmarks/yri_cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require File.dirname(__FILE__) + "/../lib/yard"
 require "benchmark"
 include YARD::CLI
@@ -16,4 +17,4 @@ remove_cache; YRI.run(NAME)
 Benchmark.bmbm do |x|
   x.report("cache   ") { TIMES.times { YRI.run(NAME) } }
   x.report("no-cache") { TIMES.times { remove_cache; YRI.run(NAME) } }
-end
+end

data/bin/yard

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # We do all this work just to find the proper load path
 path = __FILE__
 while File.symlink?(path)
   path = File.expand_path(File.readlink(path), File.dirname(path))
 end
-$:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'yard'
 

data/bin/yardoc

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # We do all this work just to find the proper load path
 path = __FILE__
 while File.symlink?(path)
   path = File.expand_path(File.readlink(path), File.dirname(path))
 end
-$:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'yard'
 

data/bin/yri

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # We do all this work just to find the proper load path
 path = __FILE__
 while File.symlink?(path)
   path = File.expand_path(File.readlink(path), File.dirname(path))
 end
-$:.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(path)), '..', 'lib'))
 
 require 'yard'
 

data/docs/templates/default/fulldoc/html/setup.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 def generate_tag_list
   @list_title = "Tag List"
   @list_type = "tag"
   asset('tag_list.html', erb(:full_list))
 end
-

data/docs/templates/default/layout/html/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   super
   sections.place(:tag_list).after_any(:files)

data/docs/templates/default/yard_tags/html/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   sections :list, [T('docstring')]
 end
@@ -5,23 +6,21 @@ end
 def tag_signature(tag)
   types = tag.types || []
   signature = "<strong>#{tag_link_name(tag)}</strong> "
-  extra = nil
-  if sig_tag = tag.object.tag('yard.signature')
-    extra = sig_tag.text
-  end
-  extra = case types.first
-  when 'with_name'
-    "name description"
-  when 'with_types'
-    "[Types] description"
-  when 'with_types_and_name'
-    "name [Types] description"
-  when 'with_title_and_text'
-    "title\ndescription"
-  when 'with_types_and_title'
-    "[Types] title\ndescription"
-  else
-    "description"
-  end if extra.nil?
+  sig_tag = tag.object.tag('yard.signature')
+  extra = sig_tag.text if sig_tag
+  extra ||= case types.first
+            when 'with_name'
+              "name description"
+            when 'with_types'
+              "[Types] description"
+            when 'with_types_and_name'
+              "name [Types] description"
+            when 'with_title_and_text'
+              "title\ndescription"
+            when 'with_types_and_title'
+              "[Types] title\ndescription"
+            else
+              "description"
+            end
   signature + h(extra).gsub(/\n/, "<br/>&nbsp;&nbsp;&nbsp;")
-end
+end

data/docs/templates/plugin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 include YARD
 include Templates
 
@@ -11,7 +12,7 @@ module TagTemplateHelper
   end
 
   def collect_tags
-    (all_tags + all_directives).sort_by {|t| t.name }
+    (all_tags + all_directives).sort_by(&:name)
   end
 
   def tag_link(tag)
@@ -25,15 +26,16 @@ module TagTemplateHelper
 
   # Wrap url_for and url_for_file to rewrite object when generating docs for
   # yard.tag/directive objects.
-  %w(url_for, url_for_file).each do |meth|
+  %w(url_for url_for_file).each do |meth|
     self.class.send(:define_method, meth) do
       if object.is_a?(CodeObjects::Base) &&
-            (object.tag('yard.tag') || object.tag('yard.directive') ||
-            (object.type == :class && object.superclass.name == :Directive))
-          obj, self.object = object, Registry.root
-          url = super
-          self.object = obj
-          url
+         (object.tag('yard.tag') || object.tag('yard.directive') ||
+         (object.type == :class && object.superclass.name == :Directive))
+        obj = object
+        self.object = Registry.root
+        url = super
+        self.object = obj
+        url
       else
         super
       end
@@ -46,13 +48,16 @@ module TagTemplateHelper
       when "yard:include_tags"
         return T('yard_tags').run(options)
       when /^tag:(\S+)/
-        tag_name, suffix = $1, "tag"
+        tag_name = $1
+        suffix = "tag"
         if tag_name =~ /^!/
-          tag_name, suffix = tag_name[1..-1], "directive"
-        end
-        if obj = Registry.at("YARD::Tags::Library##{tag_name}_#{suffix}")
-          return tag_link(obj.tag("yard.#{suffix}"))
+          tag_name = tag_name[1..-1]
+          suffix = "directive"
         end
+
+        obj = Registry.at("YARD::Tags::Library##{tag_name}_#{suffix}")
+        return tag_link(obj.tag("yard.#{suffix}")) if obj
+
         log.warn "Cannot find tag: #{args.first}"
         return args.first
       end

data/lib/rubygems_plugin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 if defined?(Gem::VERSION) && Gem::VERSION >= "2.0."
   require File.expand_path(File.dirname(__FILE__) + '/yard/rubygems/hook')
 else

data/lib/yard.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   # The root path for YARD source libraries
   ROOT = File.expand_path(File.dirname(__FILE__))
@@ -33,11 +34,8 @@ module YARD
   def self.windows?
     return @windows if defined? @windows
     require 'rbconfig'
-    if ::RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/
-      @windows = true
-    else
-      @windows = false
-    end
+    @windows =
+      ::RbConfig::CONFIG['host_os'] =~ /mingw|win32|cygwin/ ? true : false
   ensure
     @windows ||= false
   end
@@ -54,7 +52,8 @@ end
 
 # Keep track of Ruby version for compatibility code
 # @deprecated Use {YARD.ruby18?} or {YARD.ruby19?} instead.
-RUBY18, RUBY19 = YARD.ruby18?, YARD.ruby19?
+RUBY18 = YARD.ruby18?
+RUBY19 = YARD.ruby19?
 
 # Load Ruby core extension classes
 Dir.glob(File.join(YARD::ROOT, 'yard', 'core_ext', '*.rb')).each do |file|

data/lib/yard/autoload.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # @private
 def __p(path) File.join(YARD::ROOT, 'yard', *path.split('/')); end
 
@@ -174,6 +175,7 @@ module YARD
 
       autoload :AstNode,           __p('parser/ruby/ast_node')
       autoload :RubyParser,        __p('parser/ruby/ruby_parser')
+      autoload :TokenResolver,     __p('parser/ruby/token_resolver')
     end
 
     autoload :Base,                __p('parser/base')
@@ -255,6 +257,7 @@ module YARD
     autoload :ScopeDirective,      __p('tags/directives')
     autoload :Tag,                 __p('tags/tag')
     autoload :TagFormatError,      __p('tags/tag_format_error')
+    autoload :TypesExplainer,      __p('tags/types_explainer')
     autoload :VisibilityDirective, __p('tags/directives')
   end
 
@@ -287,6 +290,7 @@ module YARD
   autoload :Config,           __p('config')
   autoload :Docstring,        __p('docstring')
   autoload :DocstringParser,  __p('docstring_parser')
+  autoload :GemIndex,         __p('gem_index')
   autoload :Logger,           __p('logging')
   autoload :Options,          __p('options')
   autoload :Registry,         __p('registry')

data/lib/yard/cli/command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module YARD
@@ -55,7 +56,7 @@ module YARD
         opts.parse!(args)
       rescue OptionParser::ParseError => err
         unrecognized_option(err)
-        args.shift if args.first && args.first[0,1] != '-'
+        args.shift if args.first && args.first[0, 1] != '-'
         retry
       end
 
@@ -81,4 +82,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/cli/command_parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # This class parses a command name out of the +yard+ CLI command and calls
@@ -61,13 +62,13 @@ module YARD
       # @return [void]
       def run(*args)
         unless args == ['--help']
-          if args.size == 0 || args.first =~ /^-/
+          if args.empty? || args.first =~ /^-/
             command_name = self.class.default_command
           else
             command_name = args.first.to_sym
             args.shift
           end
-          if commands.has_key?(command_name)
+          if commands.key?(command_name)
             return commands[command_name].run(*args)
           end
         end
@@ -82,7 +83,7 @@ module YARD
         log.puts "Usage: yard <command> [options]"
         log.puts
         log.puts "Commands:"
-        commands.keys.sort_by {|k| k.to_s }.each do |command_name|
+        commands.keys.sort_by(&:to_s).each do |command_name|
           command = commands[command_name].new
           log.puts "%-8s %s" % [command_name, command.description]
         end

data/lib/yard/cli/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # CLI command to view or edit configuration options
@@ -41,7 +42,7 @@ module YARD
         if gem_install_cmd
           configure_gemrc
         elsif key
-          if reset || values.size > 0
+          if reset || !values.empty?
             modify_item
           else
             view_item
@@ -80,7 +81,8 @@ module YARD
           YARD::Config.options[key] = YARD::Config::DEFAULT_CONFIG_OPTIONS[key]
         else
           log.debug "Setting #{key} to #{values.inspect}"
-          items, current_items = encode_values, YARD::Config.options[key]
+          items = encode_values
+          current_items = YARD::Config.options[key]
           items = [current_items].flatten + [items].flatten if append
           YARD::Config.options[key] = items
         end
@@ -191,7 +193,6 @@ module YARD
         self.values = args if args.size >= 1
         args
       end
-
     end
   end
-end
+end