yard 0.9.5 → 0.9.6

data/lib/yard/registry_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 
 module YARD
@@ -37,7 +38,8 @@ module YARD
 
       # check disk
       return if @notfound[key]
-      if obj = @serializer.deserialize(key)
+      obj = @serializer.deserialize(key)
+      if obj
         @loaded_objects += 1
         put(key, obj)
       else
@@ -152,14 +154,15 @@ module YARD
       log.debug "Loading entire database: #{@file} ..."
       objects = []
 
-      all_disk_objects.sort_by {|x| x.size }.each do |path|
-        if obj = @serializer.deserialize(path, true)
-          objects << obj
-        end
+      all_disk_objects.sort_by(&:size).each do |path|
+        obj = @serializer.deserialize(path, true)
+        objects << obj if obj
       end
+
       objects.each do |obj|
         put(obj.path, obj)
       end
+
       @loaded_objects += objects.size
       log.debug "Loaded database (file='#{@file}' count=#{objects.size} total=#{@available_objects})"
     end
@@ -177,7 +180,7 @@ module YARD
       destroy unless merge
 
       sdb = Registry.single_object_db
-      if sdb == true || sdb == nil
+      if sdb == true || sdb.nil?
         @serializer.serialize(@store)
       else
         values(false).each do |object|
@@ -292,15 +295,16 @@ module YARD
     end
 
     def load_root
-      if root = @serializer.deserialize('root')
-        @loaded_objects += 1
-        if root.is_a?(Hash) # single object db
-          log.debug "Loading single object DB from .yardoc"
-          @loaded_objects += (root.keys.size - 1)
-          @store = root
-        else # just the root object
-          @store[:root] = root
-        end
+      root = @serializer.deserialize('root')
+      return if root.nil?
+
+      @loaded_objects += 1
+      if root.is_a?(Hash) # single object db
+        log.debug "Loading single object DB from .yardoc"
+        @loaded_objects += (root.keys.size - 1)
+        @store = root
+      else # just the root object
+        @store[:root] = root
       end
     end
 

data/lib/yard/rubygems/backports.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 begin
   require 'rubygems'
   if defined?(Gem::VERSION) && Gem::VERSION >= '1.8.0'
@@ -5,4 +6,5 @@ begin
     require File.dirname(__FILE__) + '/backports/source_index'
   end
 rescue LoadError
+  nil # noop
 end

data/lib/yard/rubygems/backports/gem.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Gem
   class << self
     undef source_index if method_defined?(:source_index)

data/lib/yard/rubygems/backports/source_index.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #--
 # Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
 # All rights reserved.
@@ -41,9 +42,7 @@ class Gem::SourceIndex
     # Undef old methods
     %w(from_installed_gems installed_spec_directories
         from_gems_in load_specification).each do |meth|
-      if instance_methods(true).find {|m| m.to_s == meth }
-        undef_method(meth)
-      end
+      undef_method(meth) if instance_methods(true).find {|m| m.to_s == meth }
     end
 
     ##
@@ -63,7 +62,7 @@ class Gem::SourceIndex
       if deprecated.empty?
         from_gems_in(*installed_spec_directories)
       else
-        from_gems_in(*deprecated) # HACK warn
+        from_gems_in(*deprecated) # HACK: warn
       end
     end
 
@@ -71,7 +70,7 @@ class Gem::SourceIndex
     # Returns a list of directories from Gem.path that contain specifications.
 
     def installed_spec_directories
-      Gem.path.collect { |dir| File.join(dir, "specifications") }
+      Gem.path.collect {|dir| File.join(dir, "specifications") }
     end
 
     ##
@@ -91,7 +90,6 @@ class Gem::SourceIndex
     def load_specification(file_name)
       Gem::Specification.load file_name
     end
-
   end
 
   ##
@@ -101,9 +99,9 @@ class Gem::SourceIndex
   # TODO merge @gems and @prerelease_gems and provide a separate method
   # #prerelease_gems
 
-  def initialize(specifications={})
+  def initialize(specifications = {})
     @gems = {}
-    specifications.each{ |full_name, spec| add_spec spec }
+    specifications.each {|_full_name, spec| add_spec spec }
     @spec_dirs = nil
   end
 
@@ -113,11 +111,11 @@ class Gem::SourceIndex
   end
 
   def prerelease_gems
-    @gems.reject{ |name, gem| !gem.version.prerelease? }
+    @gems.reject {|_name, gem| !gem.version.prerelease? }
   end
 
   def released_gems
-    @gems.reject{ |name, gem| gem.version.prerelease? }
+    @gems.reject {|_name, gem| gem.version.prerelease? }
   end
 
   ##
@@ -142,8 +140,8 @@ class Gem::SourceIndex
   # Returns an Array specifications for the latest released versions
   # of each gem in this index.
 
-  def latest_specs(include_prerelease=false)
-    result = Hash.new { |h,k| h[k] = [] }
+  def latest_specs(include_prerelease = false)
+    result = Hash.new {|h, k| h[k] = [] }
     latest = {}
 
     sort.each do |_, spec|
@@ -152,16 +150,16 @@ class Gem::SourceIndex
       prev_ver = latest.key?(name) ? latest[name].version : nil
 
       next if !include_prerelease && curr_ver.prerelease?
-      next unless prev_ver.nil? or curr_ver >= prev_ver or
+      next unless prev_ver.nil? || curr_ver >= prev_ver ||
                   latest[name].platform != Gem::Platform::RUBY
 
-      if prev_ver.nil? or
-         (curr_ver > prev_ver and spec.platform == Gem::Platform::RUBY) then
+      if prev_ver.nil? ||
+         (curr_ver > prev_ver && spec.platform == Gem::Platform::RUBY)
         result[name].clear
         latest[name] = spec
       end
 
-      if spec.platform != Gem::Platform::RUBY then
+      if spec.platform != Gem::Platform::RUBY
         result[name].delete_if do |result_spec|
           result_spec.platform == spec.platform
         end
@@ -273,7 +271,7 @@ class Gem::SourceIndex
     requirement = nil
     only_platform = false
 
-    # TODO - Remove support and warning for legacy arguments after 2008/11
+    # TODO: Remove support and warning for legacy arguments after 2008/11
     unless Gem::Dependency === gem_pattern
       warn "#{Gem.location_of_caller.join ':'}:Warning: Gem::SourceIndex#search support for #{gem_pattern.class} patterns is deprecated, use #find_name"
     end
@@ -285,9 +283,9 @@ class Gem::SourceIndex
       only_platform = platform_only
       requirement = gem_pattern.requirement
 
-      gem_pattern = if Regexp === gem_pattern.name then
+      gem_pattern = if Regexp === gem_pattern.name
                       gem_pattern.name
-                    elsif gem_pattern.name.empty? then
+                    elsif gem_pattern.name.empty?
                       //
                     else
                       /^#{Regexp.escape gem_pattern.name}$/
@@ -297,22 +295,22 @@ class Gem::SourceIndex
       gem_pattern = /#{gem_pattern}/i
     end
 
-    unless Gem::Requirement === requirement then
+    unless Gem::Requirement === requirement
       requirement = Gem::Requirement.create requirement
     end
 
     specs = all_gems.values.select do |spec|
-      spec.name =~ gem_pattern and
-        requirement.satisfied_by? spec.version
+      spec.name =~ gem_pattern &&
+        requirement.satisfied_by?(spec.version)
     end
 
-    if only_platform then
+    if only_platform
       specs = specs.select do |spec|
         Gem::Platform.match spec.platform
       end
     end
 
-    specs.sort_by { |s| s.sort_obj }
+    specs.sort_by(&:sort_obj)
   end
 
   ##
@@ -337,34 +335,31 @@ class Gem::SourceIndex
 
       fetcher = Gem::SpecFetcher.fetcher
       remotes = fetcher.find_matching dependency
-      remotes = remotes.map { |(_, version, _), _| version }
+      remotes = remotes.map {|(_, version, _), _| version }
 
       latest = remotes.sort.last
 
-      outdateds << local.name if latest and local.version < latest
+      outdateds << local.name if latest && local.version < latest
     end
 
     outdateds
   end
 
   def ==(other) # :nodoc:
-    self.class === other and @gems == other.gems
+    self.class === other && @gems == other.gems
   end
 
   def dump
     Marshal.dump(self)
   end
-
 end
 
 # :stopdoc:
 module Gem
-
   ##
   # Cache is an alias for SourceIndex to allow older YAMLized source index
   # objects to load properly.
 
   Cache = SourceIndex unless defined?(Cache)
-
 end
 # :startdoc:

data/lib/yard/rubygems/doc_manager.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 begin
   require 'rubygems/user_interaction'
   require 'rubygems/doc_manager'
 rescue LoadError
+  nil # noop
 end
 
 class Gem::DocManager
@@ -14,19 +16,19 @@ class Gem::DocManager
     args << '--backtrace' if Gem.configuration.backtrace
     unless File.file?(File.join(@spec.full_gem_path, '.yardopts'))
       args << @spec.require_paths
-      if @spec.extra_rdoc_files.size > 0
+      unless @spec.extra_rdoc_files.empty?
         args << '-'
         args += @spec.extra_rdoc_files
       end
     end
-    args = args.flatten.map {|arg| arg.to_s }
+    args = args.flatten.map(&:to_s)
 
     old_pwd = Dir.pwd
     Dir.chdir(@spec.full_gem_path)
     YARD::CLI::Yardoc.run(*args)
   rescue Errno::EACCES => e
     dirname = File.dirname e.message.split("-")[1].strip
-    raise Gem::FilePermissionError.new(dirname)
+    raise Gem::FilePermissionError, dirname
   rescue => ex
     alert_error "While generating documentation for #{@spec.full_name}"
     ui.errs.puts "... MESSAGE:   #{ex}"
@@ -37,10 +39,10 @@ class Gem::DocManager
     Dir.chdir(old_pwd)
   end
 
-  begin undef setup_rdoc; rescue NameError; end
+  begin undef setup_rdoc; rescue NameError; nil end
   def setup_rdoc
-    if File.exist?(@doc_dir) && !File.writable?(@doc_dir) then
-      raise Gem::FilePermissionError.new(@doc_dir)
+    if File.exist?(@doc_dir) && !File.writable?(@doc_dir)
+      raise Gem::FilePermissionError, @doc_dir
     end
 
     FileUtils.mkdir_p @doc_dir unless File.exist?(@doc_dir)
@@ -71,7 +73,7 @@ class Gem::DocManager
   begin
     alias install_ri_yard_orig install_ri
     alias install_ri install_ri_yard
-  rescue NameError; end
+  rescue NameError; nil end
 
   def install_rdoc_yard
     if @spec.has_rdoc?
@@ -84,5 +86,5 @@ class Gem::DocManager
   begin
     alias install_rdoc_yard_orig install_rdoc
     alias install_rdoc install_rdoc_yard
-  rescue NameError; end
+  rescue NameError; nil end
 end

data/lib/yard/rubygems/hook.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'rubygems/user_interaction'
 require 'fileutils'
@@ -10,7 +11,6 @@ require 'fileutils'
 
 module YARD
   class RubygemsHook
-
     include Gem::UserInteraction
     extend Gem::UserInteraction
 
@@ -32,12 +32,10 @@ module YARD
     attr_accessor :generate_yri
 
     class << self
-
       ##
       # Loaded version of YARD. Set by ::load_yard
 
       attr_reader :yard_version
-
     end
 
     ##
@@ -52,9 +50,10 @@ module YARD
       generate_yri = types.include? 'yri'
 
       specs.each do |spec|
-        gen_yard, gen_yri = generate_yard, generate_yri
+        gen_yard = generate_yard
+        gen_yri = generate_yri
         gen_yri = false if gen_yard # never generate both, no need
-        if types.size > 0 # --no-document is not in effect
+        unless types.empty? # --no-document is not in effect
           # look at spec.metadata['yard.run'] for override
           run_yard = spec.metadata['yard.run']
           gen_yard = true if run_yard && run_yard != 'yri'
@@ -64,7 +63,7 @@ module YARD
         new(spec, gen_yard, gen_yri).generate
       end
 
-      return unless generate_yard or generate_yri
+      return unless generate_yard || generate_yri
 
       duration = (Time.now - start).to_i
       names = specs.map(&:name).join ', '
@@ -100,19 +99,19 @@ module YARD
       args << '--backtrace' if Gem.configuration.backtrace
       unless File.file?(File.join(@spec.full_gem_path, '.yardopts'))
         args << @spec.require_paths
-        if @spec.extra_rdoc_files.size > 0
+        unless @spec.extra_rdoc_files.empty?
           args << '-'
           args += @spec.extra_rdoc_files
         end
       end
-      args = args.flatten.map {|arg| arg.to_s }
+      args = args.flatten.map(&:to_s)
 
       Dir.chdir(@spec.full_gem_path) do
         YARD::CLI::Yardoc.run(*args)
       end
     rescue Errno::EACCES => e
       dirname = File.dirname e.message.split("-")[1].strip
-      raise Gem::FilePermissionError.new(dirname)
+      raise Gem::FilePermissionError, dirname
     rescue => ex
       alert_error "While generating documentation for #{@spec.full_name}"
       ui.errs.puts "... MESSAGE:   #{ex}"
@@ -144,13 +143,9 @@ module YARD
 
       setup
 
-      if @generate_yri && (@force || !File.exist?(@yri_dir))
-        install_yri
-      end
+      install_yri if @generate_yri && (@force || !File.exist?(@yri_dir))
 
-      if @generate_yard && (@force || !File.exist?(@yard_dir))
-        install_yard
-      end
+      install_yard if @generate_yard && (@force || !File.exist?(@yard_dir))
     end
 
     ##
@@ -160,9 +155,7 @@ module YARD
       self.class.load_yard
 
       if File.exist?(@doc_dir)
-        unless File.writable?(@doc_dir)
-          raise Gem::FilePermissionError, @doc_dir
-        end
+        raise Gem::FilePermissionError, @doc_dir unless File.writable?(@doc_dir)
       else
         FileUtils.mkdir_p @doc_dir
       end

data/lib/yard/rubygems/specification.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems/specification'
 
 class Gem::Specification

data/lib/yard/serializers/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module Serializers
     # The abstract base serializer. Serializers allow templates to be
@@ -58,7 +59,9 @@ module YARD
       # @param [CodeObjects::Base] object the object to check existence of
       # @return [Boolean] whether the endpoint exists.
       # @since 0.6.0
-      def exists?(object) false end
+      def exists?(object) # rubocop:disable Lint/UnusedMethodArgument
+        false
+      end
 
       # @group Callbacks
 
@@ -77,4 +80,4 @@ module YARD
       def after_serialize(data); end
     end
   end
-end
+end