yard 0.9.5 → 0.9.6

data/lib/yard/cli/diff.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'tmpdir'
 require 'fileutils'
 require 'open-uri'
@@ -29,21 +30,19 @@ module YARD
           if @use_git
             load_git_commit(gemfile)
             all_objects
+          elsif load_gem_data(gemfile)
+            log.info "Found #{gemfile}"
+            all_objects
           else
-            if load_gem_data(gemfile)
-              log.info "Found #{gemfile}"
-              all_objects
-            else
-              log.error "Cannot find gem #{gemfile}"
-              nil
-            end
+            log.error "Cannot find gem #{gemfile}"
+            nil
           end
         end.compact
 
         return if registry.size != 2
 
         first_object = nil
-        [   ["Added objects", "A", added_objects(*registry)],
+        [["Added objects", "A", added_objects(*registry)],
             ["Modified objects", "M", modified_objects(*registry)],
             ["Removed objects", "D", removed_objects(*registry)]].each do |name, short, objects|
           next if short == "M" && @modified == false
@@ -51,7 +50,7 @@ module YARD
           last_object = nil
           all_objects_notice = false
           log.puts name + ":" unless @compact
-          objects.sort_by {|o| o.path }.each do |object|
+          objects.sort_by(&:path).each do |object|
             if !@list_all && last_object && object.parent == last_object
               log.print " (...)" unless all_objects_notice
               all_objects_notice = true
@@ -63,7 +62,7 @@ module YARD
             end
             all_objects_notice = false
             log.print "" + (@compact ? "#{short} " : "  ") +
-              object.path + " (#{object.file}:#{object.line})"
+                      object.path + " (#{object.file}:#{object.line})"
             last_object = object
             first_object = true
           end
@@ -123,30 +122,29 @@ module YARD
         # First check for argument as .yardoc file
         [File.join(gemfile, '.yardoc'), gemfile].each do |yardoc|
           log.info "Searching for .yardoc db at #{yardoc}"
-          if File.directory?(yardoc)
-            Registry.load_yardoc(yardoc)
-            Registry.load_all
-            return true
-          end
+          next unless File.directory?(yardoc)
+          Registry.load_yardoc(yardoc)
+          Registry.load_all
+          return true
         end
 
         # Next check installed RubyGems
         gemfile_without_ext = gemfile.sub(/\.gem$/, '')
         log.info "Searching for installed gem #{gemfile_without_ext}"
-        Gem.source_index.find_name('').find do |spec|
-          if spec.full_name == gemfile_without_ext
-            if yardoc = Registry.yardoc_file_for_gem(spec.name, "= #{spec.version}")
-              Registry.load_yardoc(yardoc)
-              Registry.load_all
-            else
-              log.enter_level(Logger::ERROR) do
-                olddir = Dir.pwd
-                Gems.run(spec.name, spec.version.to_s)
-                Dir.chdir(olddir)
-              end
+        YARD::GemIndex.find_all_by_name('').find do |spec|
+          next unless spec.full_name == gemfile_without_ext
+          yardoc = Registry.yardoc_file_for_gem(spec.name, "= #{spec.version}")
+          if yardoc
+            Registry.load_yardoc(yardoc)
+            Registry.load_all
+          else
+            log.enter_level(Logger::ERROR) do
+              olddir = Dir.pwd
+              Gems.run(spec.name, spec.version.to_s)
+              Dir.chdir(olddir)
             end
-            return true
           end
+          return true
         end
 
         # Look for local .gem file
@@ -166,6 +164,7 @@ module YARD
           open(url) {|io| expand_and_parse(gemfile, io) }
           return true
         rescue OpenURI::HTTPError
+          nil # noop
         end
         false
       end
@@ -177,7 +176,6 @@ module YARD
       end
 
       def generate_yardoc(dir)
-        olddir = Dir.pwd
         Dir.chdir(dir) do
           log.enter_level(Logger::ERROR) { Yardoc.run('-n', '--no-save') }
         end
@@ -192,21 +190,23 @@ module YARD
           require 'rubygems/package/tar_reader'
           reader = Gem::Package::TarReader.new(io)
           reader.each do |pkg|
-            if pkg.full_name == 'data.tar.gz'
-              Zlib::GzipReader.wrap(pkg) do |gzio|
-                tar = Gem::Package::TarReader.new(gzio)
-                tar.each do |entry|
-                  mode = entry.header.mode
-                  file = File.join(tmpdir, entry.full_name)
-                  FileUtils.mkdir_p(File.dirname(file))
-                  File.open(file, 'wb') do |out|
-                    out.write(entry.read)
-                    out.fsync rescue nil
+            next unless pkg.full_name == 'data.tar.gz'
+            Zlib::GzipReader.wrap(pkg) do |gzio|
+              tar = Gem::Package::TarReader.new(gzio)
+              tar.each do |entry|
+                file = File.join(tmpdir, entry.full_name)
+                FileUtils.mkdir_p(File.dirname(file))
+                File.open(file, 'wb') do |out|
+                  out.write(entry.read)
+                  begin
+                    out.fsync
+                  rescue NotImplementedError
+                    nil # noop
                   end
                 end
               end
-              break
             end
+            break
           end
         else
           Gem::Package.open(io) do |pkg|

data/lib/yard/cli/display.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Display one object
@@ -53,7 +54,7 @@ module YARD
         @objects = args.map {|o| Registry.at(o) }
 
         # validation
-        return false if @objects.any? {|o| o.nil? }
+        return false if @objects.any?(&:nil?)
         verify_markup_options
       end
 

data/lib/yard/cli/gems.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # @since 0.6.0
@@ -45,8 +46,9 @@ module YARD
 
       def add_gems(gems)
         0.step(gems.size - 1, 2) do |index|
-          gem, ver_require = gems[index], gems[index + 1] || ">= 0"
-          specs = Gem.source_index.find_name(gem, ver_require)
+          gem = gems[index]
+          ver_require = gems[index + 1] || ">= 0"
+          specs = YARD::GemIndex.find_all_by_name(gem, ver_require)
           if specs.empty?
             log.warn "#{gem} #{ver_require} could not be found in RubyGems index"
           else
@@ -71,13 +73,12 @@ module YARD
         parse_options(opts, args)
         add_gems(args)
 
-
         if !args.empty? && @gems.empty?
           log.error "No specified gems could be found for command"
         elsif @gems.empty?
-          @gems += Gem.source_index.find_name('') if @gems.empty?
+          @gems += YARD::GemIndex.find_all_by_name('') if @gems.empty?
         end
       end
     end
   end
-end
+end

data/lib/yard/cli/graph.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Options to pass to the {Graph} CLI.
@@ -115,11 +116,9 @@ module YARD
 
         expression = "#{visibilities.uniq.inspect}.include?(object.visibility)"
         options.verifier = Verifier.new(expression)
-        if args.first
-          @objects = args.map {|o| Registry.at(o) }.compact
-        else
-          @objects = [Registry.root]
-        end
+        @objects = args.first ?
+          args.map {|o| Registry.at(o) }.compact :
+          [Registry.root]
       end
     end
   end

data/lib/yard/cli/help.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Handles help for commands
@@ -6,7 +7,8 @@ module YARD
       def description; "Retrieves help for a command" end
 
       def run(*args)
-        if args.first && cmd = CommandParser.commands[args.first.to_sym]
+        cmd = args.first && CommandParser.commands[args.first.to_sym]
+        if cmd
           cmd.run('--help')
         else
           log.puts "Command #{args.first} not found." if args.first
@@ -15,4 +17,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/cli/i18n.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "pathname"
 
 module YARD
@@ -20,7 +21,7 @@ module YARD
       end
 
       def run(*args)
-        if args.size == 0 || !args.first.nil?
+        if args.empty? || !args.first.nil?
           # fail early if arguments are not valid
           return unless parse_arguments(*args)
         end

data/lib/yard/cli/list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Lists all constant and method names in the codebase. Uses {Yardoc} --list.
@@ -19,4 +20,4 @@ module YARD
       end
     end
   end
-end
+end

data/lib/yard/cli/markup_types.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # Lists all markup types
@@ -10,7 +11,7 @@ module YARD
       #
       # @param [Array<String>] args the list of arguments.
       # @return [void]
-      def run(*args)
+      def run(*args) # rubocop:disable Lint/UnusedMethodArgument
         log.puts "Available markup types for `doc' command:"
         log.puts
         types = Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS
@@ -18,11 +19,9 @@ module YARD
         types.sort_by {|name, _| name.to_s }.each do |name, providers|
           log.puts "[#{name}]"
           libs = providers.map {|p| p[:lib] }.compact
-          if libs.size > 0
-            log.puts "  Providers: #{libs.join(" ")}"
-          end
+          log.puts "  Providers: #{libs.join(" ")}" unless libs.empty?
           if exts[name]
-            log.puts "  Extensions: #{exts[name].map {|e| ".#{e}"}.join(" ")}"
+            log.puts "  Extensions: #{exts[name].map {|e| ".#{e}" }.join(" ")}"
           end
 
           log.puts

data/lib/yard/cli/server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # A local documentation server
@@ -71,7 +72,8 @@ module YARD
 
       def add_libraries(args)
         (0...args.size).step(2) do |index|
-          library, dir = args[index], args[index + 1]
+          library = args[index]
+          dir = args[index + 1]
 
           libver = nil
           if dir
@@ -109,23 +111,23 @@ module YARD
       # @return [LibraryVersion, nil]
       def create_library_version_if_yardopts_exist(library, dir)
         if dir
-         options_file = File.join(dir, Yardoc::DEFAULT_YARDOPTS_FILE)
-         if File.exist?(options_file)
-           # Found yardopts, extract db path
-           yfile = extract_db_from_options_file(options_file)
-           db = File.expand_path(yfile, dir)
-
-           # Create libver
-           libver = YARD::Server::LibraryVersion.new(library, nil, db)
-           libver.source_path = dir
-           libver
-         end
+          options_file = File.join(dir, Yardoc::DEFAULT_YARDOPTS_FILE)
+          if File.exist?(options_file)
+            # Found yardopts, extract db path
+            yfile = extract_db_from_options_file(options_file)
+            db = File.expand_path(yfile, dir)
+
+            # Create libver
+            libver = YARD::Server::LibraryVersion.new(library, nil, db)
+            libver.source_path = dir
+            libver
+          end
         end
       end
 
       def add_gems
         require 'rubygems'
-        Gem.source_index.find_name('').each do |spec|
+        YARD::GemIndex.find_all_by_name('').each do |spec|
           libraries[spec.name] ||= []
           libraries[spec.name] |= [YARD::Server::LibraryVersion.new(spec.name, spec.version.to_s, nil, :gem)]
         end
@@ -174,7 +176,7 @@ module YARD
         end
         opts.on('-t', '--template-path PATH',
                 'The template path to look for templates in. (used with -t).') do |path|
-          self.template_paths << path
+          template_paths << path
         end
         opts.separator ''
         opts.separator "Web Server Options:"
@@ -183,7 +185,7 @@ module YARD
         end
         opts.on('-B HOST', '--bind', 'The host address to bind to') do |host|
           server_options[:Host] = host.to_s
-        end        
+        end
         opts.on('-p PORT', '--port', 'Serves documentation on PORT') do |port|
           server_options[:Port] = port.to_i
         end
@@ -191,20 +193,23 @@ module YARD
           server_options[:DocumentRoot] = File.expand_path(docroot)
         end
         opts.on('-a', '--adapter ADAPTER', 'Use the ADAPTER (full Ruby class) for web server') do |adapter|
-          if adapter.downcase == 'webrick'
+          if adapter.casecmp('webrick') == 0
             self.adapter = YARD::Server::WebrickAdapter
-          elsif adapter.downcase == 'rack'
+          elsif adapter.casecmp('rack') == 0
             self.adapter = YARD::Server::RackAdapter
           else
-            self.adapter = eval(adapter)
+            self.adapter = eval(adapter) # rubocop:disable Lint/Eval
           end
         end
         opts.on('-s', '--server TYPE', 'Use a specific server type eg. thin,mongrel,cgi (Rack specific)') do |type|
           server_options[:server] = type
         end
+        opts.on('--fork', 'Use process forking when serving requests') do
+          options[:use_fork] = true
+        end
         common_options(opts)
         opts.on('-e', '--load FILE', 'A Ruby script to load before the source tree is parsed.') do |file|
-          self.scripts << file
+          scripts << file
         end
         parse_options(opts, args)
 
@@ -215,9 +220,7 @@ module YARD
           # Generate doc for first time
           # This is not necessary but makes for a better first-run experience
           libver = libraries.empty? ? nil : libraries.values.first.first
-          if libver and !libver.ready?
-            generate_doc_for_first_time(libver)
-          end
+          generate_doc_for_first_time(libver) if libver && !libver.ready?
         else
           add_libraries(args)
           options[:single_library] = false if libraries.size > 1
@@ -226,7 +229,7 @@ module YARD
 
       def generate_doc_for_first_time(libver)
         log.enter_level(Logger::INFO) do
-          yardoc_file = libver.yardoc_file.sub /^#{Regexp.quote Dir.pwd}[\\\/]+/, ''
+          yardoc_file = libver.yardoc_file.sub(%r{^#{Regexp.quote Dir.pwd}[\\/]+}, '')
           log.info "No yardoc db found in #{yardoc_file}, parsing source before starting server..."
         end
         Dir.chdir(libver.source_path) do
@@ -243,7 +246,7 @@ module YARD
         begin
           opts.parse!(args)
         rescue OptionParser::ParseError
-          args.shift if args.first && args.first[0,1] != '-'
+          args.shift if args.first && args.first[0, 1] != '-'
           retry
         end
 

data/lib/yard/cli/stats.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module CLI
     # @since 0.6.0
@@ -49,8 +50,9 @@ module YARD
       # To add statistics for a specific type, add a method +#stats_for_TYPE+
       # to this class that calls {#output}.
       def print_statistics
-        @total, @undocumented = 0, 0
-        meths = methods.map {|m| m.to_s }.grep(/^stats_for_/)
+        @total = 0
+        @undocumented = 0
+        meths = methods.map(&:to_s).grep(/^stats_for_/)
         STATS_ORDER.each do |meth|
           mname = "stats_for_#{meth}"
           if meths.include?(mname)
@@ -60,13 +62,14 @@ module YARD
         end
         meths.each {|m| send(m) }
 
-        if @undocumented == 0
-          total = 100
-        elsif @total == 0
-          total = 0
-        else
-          total = (@total - @undocumented).to_f / @total.to_f * 100
-        end
+        total =
+          if @undocumented == 0
+            100
+          elsif @total == 0
+            0
+          else
+            (@total - @undocumented).to_f / @total.to_f * 100
+          end
         log.puts("% 3.2f%% documented" % total)
       end
 
@@ -137,8 +140,8 @@ module YARD
       # Statistics for methods
       def stats_for_methods
         objs = all_objects.select {|m| m.type == :method }
-        objs.reject! {|m| m.is_alias? }
-        objs.reject! {|m| m.is_attribute? }
+        objs.reject!(&:is_alias?)
+        objs.reject!(&:is_attribute?)
         undoc = objs.select {|m| m.docstring.blank? }
         @undoc_list |= undoc if @undoc_list
         output "Methods", objs.size, undoc.size
@@ -156,11 +159,12 @@ module YARD
       def output(name, data, undoc = nil)
         @total += data if data.is_a?(Integer) && undoc
         @undocumented += undoc if undoc.is_a?(Integer)
-        if undoc
-          data = ("%5s (% 5d undocumented)" % [data, undoc])
-        else
-          data = "%5s" % data
-        end
+        data =
+          if undoc
+            ("%5s (% 5d undocumented)" % [data, undoc])
+          else
+            "%5s" % data
+          end
         log.puts("%-12s %s" % [name + ":", data])
       end