yard 0.9.11 → 0.9.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b075d91aec0b1492b93b3fb3b55eb25c6720bc04
-  data.tar.gz: c101b99bd96a0b02a92ddedd103703c12e080fa8
+  metadata.gz: 74bbd8287f17919c27e5ff01d7f2ad6bf4664bb5
+  data.tar.gz: 37ec664545378af541b4a3767ae0f03f087fb1f2
 SHA512:
-  metadata.gz: 286a15411272d9163a587207e410f988609e2b876ed2cd89b4c3f4cdb44cbbdd6e052508a55112bea01ff7a36cbf479f82e47182a375e75788103b85a0506423
-  data.tar.gz: 85ef32b03a96db7b32bac83a89c91c1b88d1211606b3f9b7b7132ce49f1996695fd2b10a82b5e4f8a6687b5ff88ccafb7724f0ce2ae90b7ab5cd4d892bae8fe7
+  metadata.gz: cee724ae82beccaa8d7b6f0e4159a045c89c03c75b2d402947f978bf8277b8d3e650c543c08b4d2ec4bd2ee0550752dcaed2b43e7824fc79452f370e6e282a02
+  data.tar.gz: ccb8e825752ba9ca38e11bd8f0dd0bbf23e743582b385d983d76fa27177b141106254c12f368336b8fd907f8ffb39e8967b9ed2caf86ca1f3ccd425a26978c53

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.9.12] - November 26th, 2017
+
+[0.9.12]: https://github.com/lsegal/yard/compare/v0.9.11...v0.9.12
+
+- Be more explicit about lack of support for absolute paths in extra files
+  specified by `yard doc` command.
+
 # [0.9.11] - November 23rd, 2017
 
 [0.9.11]: https://github.com/lsegal/yard/compare/v0.9.10...v0.9.11

data/README.md

@@ -3,7 +3,6 @@
 [![Homepage](http://img.shields.io/badge/home-yardoc.org-blue.svg)](http://yardoc.org)
 [![GitHub](http://img.shields.io/badge/github-lsegal/yard-blue.svg)](http://github.com/lsegal/yard)
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/yard/frames)
-[![IRC Chat](https://img.shields.io/badge/chat-%23yard%20@%20freenode-orange.svg)](irc://irc.freenode.net/yard)
 
 [![Gem Version](https://badge.fury.io/rb/yard.svg)](http://github.com/lsegal/yard/releases)
 [![Build Status](https://travis-ci.org/lsegal/yard.svg?branch=master)](https://travis-ci.org/lsegal/yard)

data/lib/yard/cli/yardoc.rb

@@ -411,14 +411,27 @@ module YARD
       def add_extra_files(*files)
         files.map! {|f| f.include?("*") ? Dir.glob(f) : f }.flatten!
         files.each do |file|
-          if File.file?(file)
+          if extra_file_valid?(file)
             options.files << CodeObjects::ExtraFileObject.new(file)
-          else
-            log.warn "Could not find extra file: #{file}"
           end
         end
       end
 
+      # @param file [String] the filename to validate
+      # @param check_exists [Boolean] whether the file should exist on disk
+      # @return [Boolean] whether the file is allowed to be used
+      def extra_file_valid?(file, check_exists = true)
+        if file =~ %r{^(?:\.\./|/)}
+          log.warn "Invalid file: #{file}"
+          false
+        elsif check_exists && !File.file?(file)
+          log.warn "Could not find file: #{file}"
+          false
+        else
+          true
+        end
+      end
+
       # Parses the file arguments into Ruby files and extra files, which are
       # separated by a '-' element.
       #
@@ -644,10 +657,8 @@ module YARD
 
         opts.on('-r', '--readme FILE', '--main FILE', 'The readme file used as the title page',
                                                       '  of documentation.') do |readme|
-          if File.file?(readme)
+          if extra_file_valid?(readme)
             options.readme = CodeObjects::ExtraFileObject.new(readme)
-          else
-            log.warn "Could not find readme file: #{readme}"
           end
         end
 
@@ -658,12 +669,9 @@ module YARD
 
         opts.on('--asset FROM[:TO]', 'A file or directory to copy over to output ',
                                      '  directory after generating') do |asset|
-          re = %r{^(?:\.\./|/)}
           from, to = *asset.split(':').map {|f| File.cleanpath(f, true) }
           to ||= from
-          if from =~ re || to =~ re
-            log.warn "Invalid file '#{asset}'"
-          else
+          if extra_file_valid?(from, false) && extra_file_valid?(to, false)
             assets[from] = to
           end
         end