yard 0.9.16 → 0.9.17

data/lib/yard/core_ext/array.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-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
-  # @see Insertion#before
-  # @see Insertion#after
-  def place(*values) Insertion.new(self, values) end
-end
+# frozen_string_literal: true
+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
+  # @see Insertion#before
+  # @see Insertion#after
+  def place(*values) Insertion.new(self, values) end
+end

data/lib/yard/core_ext/file.rb

@@ -1,69 +1,69 @@
-# frozen_string_literal: true
-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
-  #   (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.shift; to.shift
-    end
-    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
-  # @param [Boolean] rel_root allows relative path above root value
-  # @return [String] the sanitized path
-  def self.cleanpath(path, rel_root = false)
-    path = path.split(SEPARATOR)
-    path = path.inject([]) do |acc, comp|
-      next acc if comp == RELATIVE_SAMEDIR
-      if comp == RELATIVE_PARENTDIR && !acc.empty? && acc.last != RELATIVE_PARENTDIR
-        acc.pop
-        next acc
-      elsif !rel_root && comp == RELATIVE_PARENTDIR && acc.empty?
-        next acc
-      end
-      acc << comp
-    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
-  def self.open!(file, *args, &block)
-    dir = dirname(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
-  def self.read_binary(file)
-    File.open(file, 'rb', &:read)
-  end
-end
+# frozen_string_literal: true
+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
+  #   (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.shift; to.shift
+    end
+    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
+  # @param [Boolean] rel_root allows relative path above root value
+  # @return [String] the sanitized path
+  def self.cleanpath(path, rel_root = false)
+    path = path.split(SEPARATOR)
+    path = path.inject([]) do |acc, comp|
+      next acc if comp == RELATIVE_SAMEDIR
+      if comp == RELATIVE_PARENTDIR && !acc.empty? && acc.last != RELATIVE_PARENTDIR
+        acc.pop
+        next acc
+      elsif !rel_root && comp == RELATIVE_PARENTDIR && acc.empty?
+        next acc
+      end
+      acc << comp
+    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
+  def self.open!(file, *args, &block)
+    dir = dirname(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
+  def self.read_binary(file)
+    File.open(file, 'rb', &:read)
+  end
+end

data/lib/yard/core_ext/hash.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-class Hash
-  class << self
-    def create(*args)
-      if args.first.is_a?(Array) && args.size == 1
-        obj = new
-        args.first.each {|k, v| obj[k] = v }
-        obj
-      else
-        create_186(*args)
-      end
-    end
-    alias create_186 []
-    alias [] create
-  end
-end if RUBY_VERSION < "1.8.7"
+# frozen_string_literal: true
+class Hash
+  class << self
+    def create(*args)
+      if args.first.is_a?(Array) && args.size == 1
+        obj = new
+        args.first.each {|k, v| obj[k] = v }
+        obj
+      else
+        create_186(*args)
+      end
+    end
+    alias create_186 []
+    alias [] create
+  end
+end if RUBY_VERSION < "1.8.7"

data/lib/yard/core_ext/insertion.rb

@@ -1,63 +1,63 @@
-# frozen_string_literal: true
-# 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 = list
-    @values = (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+.
-  #
-  # @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
-
-  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
-  # @param [Boolean] recursive look inside sublists
-  # @param [Array] list the list to place objects into
-  def insertion(val, rel, recursive = false, list = @list)
-    if recursive
-      list.each do |item|
-        next unless item.is_a?(Array)
-        tmp = item.dup
-        insertion(val, rel, recursive, item)
-        return(list) unless item == tmp
-      end
-    end
-
-    index = list.index(val)
-    list[index + rel, 0] = @values if index
-    list
-  end
-end
+# frozen_string_literal: true
+# 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 = list
+    @values = (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+.
+  #
+  # @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
+
+  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
+  # @param [Boolean] recursive look inside sublists
+  # @param [Array] list the list to place objects into
+  def insertion(val, rel, recursive = false, list = @list)
+    if recursive
+      list.each do |item|
+        next unless item.is_a?(Array)
+        tmp = item.dup
+        insertion(val, rel, recursive, item)
+        return(list) unless item == tmp
+      end
+    end
+
+    index = list.index(val)
+    list[index + rel, 0] = @values if index
+    list
+  end
+end

data/lib/yard/core_ext/module.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-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
-  def class_name
-    name.split("::").last
-  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
-  def namespace_name
-    name.split("::")[0..-2].join("::")
-  end
-end
+# frozen_string_literal: true
+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
+  def class_name
+    name.split("::").last
+  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
+  def namespace_name
+    name.split("::")[0..-2].join("::")
+  end
+end

data/lib/yard/core_ext/string.rb

@@ -1,68 +1,68 @@
-# frozen_string_literal: true
-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 = [String.new("")]
-    state = :none
-    escape_next = false
-    quote = String.new("")
-    strip.split(//).each do |char|
-      case state
-      when :none, :space
-        case char
-        when /\s/
-          out << String.new("") unless state == :space
-          state = :space
-          escape_next = false
-        when "\\"
-          if escape_next
-            out.last << char
-            escape_next = false
-          else
-            escape_next = true
-          end
-        when '"', "'"
-          if escape_next
-            out.last << char
-            escape_next = false
-          else
-            state = char
-            quote = String.new("")
-          end
-        else
-          state = :none
-          out.last << char
-          escape_next = false
-        end
-      when '"', "'"
-        case char
-        when '"', "'"
-          if escape_next
-            quote << char
-            escape_next = false
-          elsif char == state
-            out.last << quote
-            state = :none
-          else
-            quote << char
-          end
-        when '\\'
-          if escape_next
-            quote << char
-            escape_next = false
-          else
-            escape_next = true
-          end
-        else
-          quote << char
-          escape_next = false
-        end
-      end
-    end
-    out
-  end
-end
+# frozen_string_literal: true
+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 = [String.new("")]
+    state = :none
+    escape_next = false
+    quote = String.new("")
+    strip.split(//).each do |char|
+      case state
+      when :none, :space
+        case char
+        when /\s/
+          out << String.new("") unless state == :space
+          state = :space
+          escape_next = false
+        when "\\"
+          if escape_next
+            out.last << char
+            escape_next = false
+          else
+            escape_next = true
+          end
+        when '"', "'"
+          if escape_next
+            out.last << char
+            escape_next = false
+          else
+            state = char
+            quote = String.new("")
+          end
+        else
+          state = :none
+          out.last << char
+          escape_next = false
+        end
+      when '"', "'"
+        case char
+        when '"', "'"
+          if escape_next
+            quote << char
+            escape_next = false
+          elsif char == state
+            out.last << quote
+            state = :none
+          else
+            quote << char
+          end
+        when '\\'
+          if escape_next
+            quote << char
+            escape_next = false
+          else
+            escape_next = true
+          end
+        else
+          quote << char
+          escape_next = false
+        end
+      end
+    end
+    out
+  end
+end