yard 0.6.8 → 0.7.0

data/lib/yard/code_objects/root_object.rb

@@ -9,7 +9,7 @@ module YARD
       def equal?(other)
         other == :root ? true : super(other)
       end
-      
+
       def hash; :root.hash end
     end
   end

data/lib/yard/config.rb

@@ -3,18 +3,18 @@ module YARD
   # the loading of plugins. To access options call {options}, and to load
   # a plugin use {load_plugin}. All other public methods are used by YARD
   # during load time.
-  # 
+  #
   # == User Configuration Files
-  # 
-  # Persistent user configuration files can be stored in the file 
+  #
+  # Persistent user configuration files can be stored in the file
   # +~/.yard/config+, which is read when YARD first loads. The file should
   # be formatted as YAML, and should contain a map of keys and values.
-  # 
+  #
   # Although you can specify any key-value mapping in the configuration file,
   # YARD defines special keys specified in {DEFAULT_CONFIG_OPTIONS}.
-  # 
+  #
   # An example of a configuration file is listed below:
-  # 
+  #
   #     !!!yaml
   #     load_plugins: true # Auto-load plugins when YARD starts
   #     ignored_plugins:
@@ -22,30 +22,30 @@ module YARD
   #       - broken2 # yard- prefix not necessary
   #     autoload_plugins:
   #       - yard-rspec
-  # 
+  #
   # == Automatic Loading of Plugins
-  # 
-  # YARD 0.6.2 will no longer automatically load all plugins by default. This 
-  # option can be reset by setting 'load_plugins' to true in the configuration 
-  # file. In addition, you can specify a set of specific plugins to load on 
-  # load through the 'autoload_plugins' list setting. This setting is 
+  #
+  # YARD 0.6.2 will no longer automatically load all plugins by default. This
+  # option can be reset by setting 'load_plugins' to true in the configuration
+  # file. In addition, you can specify a set of specific plugins to load on
+  # load through the 'autoload_plugins' list setting. This setting is
   # independent of the 'load_plugins' value and will always be processed.
-  # 
+  #
   # == Ignored Plugins File
-  # 
+  #
   # YARD 0.5 and below used a +~/.yard/ignored_plugins+ file to specify
   # plugins to be ignored at load time. Ignored plugins in 0.6.2 and above
   # should now be specified in the main configuration file, though YARD
   # will support the +ignored_plugins+ file until 0.7.x.
-  # 
+  #
   # == Safe Mode
-  # 
+  #
   # YARD supports running in safe-mode. By doing this, it will avoid executing
   # any user code such as require files or queries. Plugins will still be
   # loaded with safe mode on, because plugins are properly namespaced with
   # a 'yard-' prefix, must be installed as a gem, and therefore cannot be
   # touched by the user. To specify safe mode, use the +safe_mode+ key.
-  # 
+  #
   # @since 0.6.2
   # @see options
   class Config
@@ -58,14 +58,14 @@ module YARD
 
     # The location where YARD stores user-specific settings
     CONFIG_DIR = File.expand_path('~/.yard')
-    
+
     # The main configuration YAML file.
     CONFIG_FILE = File.join(CONFIG_DIR, 'config')
-    
-    # File listing all ignored plugins 
+
+    # File listing all ignored plugins
     # @deprecated Set `ignored_plugins` in the {CONFIG_FILE} instead.
     IGNORED_PLUGINS = File.join(CONFIG_DIR, 'ignored_plugins')
-    
+
     # Default configuration options
     DEFAULT_CONFIG_OPTIONS = {
       :load_plugins => false,   # Whether to load plugins automatically with YARD
@@ -73,11 +73,11 @@ module YARD
       :autoload_plugins => [],  # A list of plugins to be automatically loaded
       :safe_mode => false       # Does not execute or eval any user-level code
     }
-    
+
     # The prefix used for YARD plugins. Name your gem with this prefix
     # to allow it to be used as a plugin.
     YARD_PLUGIN_PREFIX = /^yard[-_]/
-    
+
     # Loads settings from {CONFIG_FILE}. This method is called by YARD at
     # load time and should not be called by the user.
     # @return [void]
@@ -92,28 +92,28 @@ module YARD
       log.error "Invalid configuration file, using default options."
       options.update(DEFAULT_CONFIG_OPTIONS)
     end
-    
+
     # Saves settings to {CONFIG_FILE}.
     # @return [void]
     def self.save
       require 'yaml'
       File.open(CONFIG_FILE, 'w') {|f| f.write(YAML.dump(options)) }
     end
-    
+
     # Loads gems that match the name 'yard-*' (recommended) or 'yard_*' except
-    # those listed in +~/.yard/ignored_plugins+. This is called immediately 
+    # those listed in +~/.yard/ignored_plugins+. This is called immediately
     # after YARD is loaded to allow plugin support.
-    # 
+    #
     # @return [Boolean] true if all plugins loaded successfully, false otherwise.
     def self.load_plugins
       load_gem_plugins &&
         load_autoload_plugins &&
         load_commandline_plugins ? true : false
     end
-    
+
     # Loads an individual plugin by name. It is not necessary to include the
     # +yard-+ plugin prefix here.
-    # 
+    #
     # @param [String] name the name of the plugin (with or without +yard-+ prefix)
     # @return [Boolean] whether the plugin was successfully loaded
     def self.load_plugin(name)
@@ -126,9 +126,9 @@ module YARD
     rescue LoadError => e
       load_plugin_failed(name, e)
     end
-    
+
     private
-    
+
     # Load gem plugins if :load_plugins is true
     def self.load_gem_plugins
       return true unless options[:load_plugins]
@@ -148,12 +148,12 @@ module YARD
       log.debug "RubyGems is not present, skipping plugin loading"
       false
     end
-    
+
     # Load plugins set in :autoload_plugins
     def self.load_autoload_plugins
       options[:autoload_plugins].each {|name| load_plugin(name) }
     end
-    
+
     # Load plugins from {#arguments}
     def self.load_commandline_plugins
       with_yardopts do
@@ -163,7 +163,7 @@ module YARD
         end
       end
     end
-    
+
     # Print a warning if the plugin failed to load
     # @return [false]
     def self.load_plugin_failed(name, exception)
@@ -171,14 +171,14 @@ module YARD
       log.backtrace(exception) if $DEBUG
       false
     end
-    
+
     # Legacy support for {IGNORED_PLUGINS}
     def self.add_ignored_plugins_file
       if File.file?(IGNORED_PLUGINS)
         options[:ignored_plugins] += File.read(IGNORED_PLUGINS).split(/\s+/)
       end
     end
-    
+
     # Translates plugin names to add yard- prefix.
     def self.translate_plugin_names
       options[:ignored_plugins].map! {|name| translate_plugin_name(name) }
@@ -196,7 +196,7 @@ module YARD
         {}
       end
     end
-    
+
     # Sanitizes and normalizes a plugin name to include the 'yard-' prefix.
     # @param [String] name the plugin name
     # @return [String] the sanitized and normalized plugin name.
@@ -205,7 +205,7 @@ module YARD
       name = "yard-" + name unless name =~ YARD_PLUGIN_PREFIX
       name
     end
-    
+
     # Temporarily loads .yardopts file into @yardopts
     def self.with_yardopts(&block)
       yfile = CLI::Yardoc::DEFAULT_YARDOPTS_FILE
@@ -214,12 +214,12 @@ module YARD
       @yardopts = nil
       result
     end
-    
+
     # @return [Array<String>] arguments from commandline and yardopts file
     def self.arguments
       ARGV + @yardopts
     end
   end
-  
+
   Config.options = Config::DEFAULT_CONFIG_OPTIONS
 end

data/lib/yard/core_ext/array.rb

@@ -2,13 +2,13 @@ class Array
   # Places values before or after another object (by value) in
   # an array. This is used in tandem with the before and after
   # methods of the {Insertion} class.
-  # 
+  #
   # @example Places an item before another
   #   [1, 2, 3].place(4).before(3) # => [1, 2, 4, 3]
   # @example Places an item after another
   #   [:a, :b, :c].place(:x).after(:a) # => [:a, :x, :b, :c]
   # @param [Array] values value to insert
-  # @return [Insertion] an insertion object to 
+  # @return [Insertion] an insertion object to
   # @see Insertion#before
   # @see Insertion#after
   def place(*values) Insertion.new(self, values) end

data/lib/yard/core_ext/file.rb

@@ -3,31 +3,31 @@ require 'fileutils'
 class File
   RELATIVE_PARENTDIR = '..'
   RELATIVE_SAMEDIR = '.'
-  
+
   # @group Manipulating Paths
-  
+
   # Turns a path +to+ into a relative path from starting
   # point +from+. The argument +from+ is assumed to be
   # a filename. To treat it as a directory, make sure it
   # ends in +File::SEPARATOR+ ('/' on UNIX filesystems).
-  # 
-  # @param [String] from the starting filename 
+  #
+  # @param [String] from the starting filename
   #   (or directory with +from_isdir+ set to +true+).
   # @param [String] to the final path that should be made relative.
   # @return [String] the relative path from +from+ to +to+.
   def self.relative_path(from, to)
     from = expand_path(from).split(SEPARATOR)
     to = expand_path(to).split(SEPARATOR)
-    from.length.times do 
-      break if from[0] != to[0] 
+    from.length.times do
+      break if from[0] != to[0]
       from.shift; to.shift
     end
     fname = from.pop
     join(*(from.map { RELATIVE_PARENTDIR } + to))
   end
-  
+
   # Cleans a path by removing extraneous '..', '.' and '/' characters
-  # 
+  #
   # @example Clean a path
   #   File.cleanpath('a/b//./c/../e') # => "a/b/e"
   # @param [String] path the path to clean
@@ -44,9 +44,9 @@ class File
     end
     File.join(*path)
   end
-  
+
   # @group Reading Files
-  
+
   # Forces opening a file (for writing) by first creating the file's directory
   # @param [String] file the filename to open
   # @since 0.5.2
@@ -55,7 +55,7 @@ class File
     FileUtils.mkdir_p(dir) unless directory?(dir)
     open(file, *args, &block)
   end
-  
+
   # Reads a file with binary encoding
   # @return [String] the ascii-8bit encoded data
   # @since 0.5.3

data/lib/yard/core_ext/insertion.rb

@@ -1,34 +1,34 @@
 # The Insertion class inserts a value before or after another
 # value in a list.
-# 
+#
 # @example
 #   Insertion.new([1, 2, 3], 4).before(3) # => [1, 2, 4, 3]
 class Insertion
   # Creates an insertion object on a list with a value to be
   # inserted. To finalize the insertion, call {#before} or
   # {#after} on the object.
-  # 
+  #
   # @param [Array] list the list to perform the insertion on
   # @param [Object] value the value to insert
   def initialize(list, value) @list, @values = list, (Array === value ? value : [value]) end
-    
+
   # Inserts the value before +val+
   # @param [Object] val the object the value will be inserted before
   # @param [Boolean] recursive look inside sublists
   def before(val, recursive = false) insertion(val, 0, recursive) end
-    
-  # Inserts the value after +val+. 
-  # 
+
+  # Inserts the value after +val+.
+  #
   # @example If subsections are ignored
   #   Insertion.new([1, [2], 3], :X).after(1) # => [1, [2], :X, 3]
   # @param [Object] val the object the value will be inserted after
   # @param [Boolean] recursive look inside sublists
   def after(val, recursive = false) insertion(val, 1, recursive) end
-    
+
   # Alias for {#before} with +recursive+ set to true
   # @since 0.6.0
   def before_any(val) insertion(val, 0, true) end
-    
+
   # Alias for {#after} with +recursive+ set to true
   # @since 0.6.0
   def after_any(val) insertion(val, 1, true) end
@@ -36,7 +36,7 @@ class Insertion
   private
 
   # This method performs the actual insertion
-  # 
+  #
   # @param [Object] val the value to insert
   # @param [Fixnum] rel the relative index (0 or 1) of where the object
   #   should be placed
@@ -51,7 +51,7 @@ class Insertion
         return(list) unless item == tmp
       end
     end
-    
+
     if index = list.index(val)
       list[index+rel,0] = @values
     end

data/lib/yard/core_ext/module.rb

@@ -1,6 +1,6 @@
 class Module
   # Returns the class name of a full module namespace path
-  # 
+  #
   # @example
   #   module A::B::C; class_name end # => "C"
   # @return [String] the last part of a module path
@@ -9,7 +9,7 @@ class Module
   end
 
   # Returns the module namespace path minus the class/module name
-  # 
+  #
   # @example
   #   module A::B::C; namespace_name end # => "A::B"
   # @return [String] the namespace minus the class/module name

data/lib/yard/core_ext/string.rb

@@ -2,7 +2,7 @@ class String
   # Splits text into tokens the way a shell would, handling quoted
   # text as a single token. Use '\"' and "\'" to escape quotes and
   # '\\' to escape a backslash.
-  # 
+  #
   # @return [Array] an array representing the tokens
   def shell_split
     out = [""]
@@ -45,7 +45,7 @@ class String
             escape_next = false
           elsif char == state
             out.last << quote
-            state = :none 
+            state = :none
           else
             quote << char
           end

data/lib/yard/core_ext/symbol_hash.rb

@@ -1,8 +1,8 @@
-# A subclass of Hash where all keys are converted into Symbols, and 
+# A subclass of Hash where all keys are converted into Symbols, and
 # optionally, all String values are converted into Symbols.
 class SymbolHash < Hash
   # Creates a new SymbolHash object
-  # 
+  #
   # @param [Boolean] symbolize_value converts any String values into Symbols
   #   if this is set to +true+.
   def initialize(symbolize_value = true)
@@ -11,15 +11,15 @@ class SymbolHash < Hash
 
   # @overload [](hash)
   #   Creates a SymbolHash object from an existing Hash
-  #   
+  #
   #   @example
   #     SymbolHash['x' => 1, :y => 2] # => #<SymbolHash:0x...>
   #   @param [Hash] hash the hash object
   #   @return [SymbolHash] a new SymbolHash from a hash object
-  # 
+  #
   # @overload [](*list)
   #   Creates a SymbolHash from an even list of keys and values
-  #   
+  #
   #   @example
   #     SymbolHash[key1, value1, key2, value2, ...]
   #   @param [Array] list an even list of key followed by value
@@ -33,40 +33,40 @@ class SymbolHash < Hash
     end
     obj
   end
-  
+
   # Assigns a value to a symbolized key
   # @param [#to_sym] key the key
   # @param [Object] value the value to be assigned. If this is a String and
   #   values are set to be symbolized, it will be converted into a Symbol.
-  def []=(key, value) 
-    super(key.to_sym, value.instance_of?(String) && @symbolize_value ? value.to_sym : value) 
+  def []=(key, value)
+    super(key.to_sym, value.instance_of?(String) && @symbolize_value ? value.to_sym : value)
   end
-  
+
   # Accessed a symbolized key
   # @param [#to_sym] key the key to access
   # @return [Object] the value associated with the key
   def [](key) super(key.to_sym) end
-    
+
   # Deleted a key and value associated with it
   # @param [#to_sym] key the key to delete
   # @return [void]
   def delete(key) super(key.to_sym) end
-    
+
   # Tests if a symbolized key exists
   # @param [#to_sym] key the key to test
   # @return [Boolean] whether the key exists
   def has_key?(key) super(key.to_sym) end
-    
+
   # Updates the object with the contents of another Hash object
   # This method modifies the original SymbolHash object
-  # 
+  #
   # @param [Hash] hash the hash object to copy the values from
   # @return [SymbolHash] self
   def update(hash) hash.each {|k,v| self[k] = v }; self end
   alias_method :merge!, :update
 
   # Merges the contents of another hash into a new SymbolHash object
-  # 
+  #
   # @param [Hash] hash the hash of objects to copy
   # @return [SymbolHash] a new SymbolHash containing the merged data
   def merge(hash) dup.merge!(hash) end