yard 0.9.18 → 0.9.23

data/lib/yard/handlers/ruby/visibility_handler.rb

@@ -1,22 +1,22 @@
-# frozen_string_literal: true
-# Handles 'private', 'protected', and 'public' calls.
-class YARD::Handlers::Ruby::VisibilityHandler < YARD::Handlers::Ruby::Base
-  include YARD::Handlers::Ruby::DecoratorHandlerMethods
-
-  handles method_call(:private)
-  handles method_call(:protected)
-  handles method_call(:public)
-  namespace_only
-
-  process do
-    return if (ident = statement.jump(:ident)) == statement
-    case statement.type
-    when :var_ref, :vcall
-      self.visibility = ident.first.to_sym
-    when :fcall, :command
-      process_decorator do |method|
-        method.visibility = ident.first if method.respond_to? :visibility=
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+# Handles 'private', 'protected', and 'public' calls.
+class YARD::Handlers::Ruby::VisibilityHandler < YARD::Handlers::Ruby::Base
+  include YARD::Handlers::Ruby::DecoratorHandlerMethods
+
+  handles method_call(:private)
+  handles method_call(:protected)
+  handles method_call(:public)
+  namespace_only
+
+  process do
+    return if (ident = statement.jump(:ident)) == statement
+    case statement.type
+    when :var_ref, :vcall
+      self.visibility = ident.first.to_sym
+    when :fcall, :command
+      process_decorator do |method|
+        method.visibility = ident.first if method.respond_to? :visibility=
+      end
+    end
+  end
+end

data/lib/yard/handlers/ruby/yield_handler.rb

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-# Handles 'yield' calls
-class YARD::Handlers::Ruby::YieldHandler < YARD::Handlers::Ruby::Base
-  handles :yield, :yield0
-
-  process do
-    return unless owner.is_a?(MethodObject) # Only methods yield
-    return if owner.has_tag? :yield         # Don't override yield tags
-    return if owner.has_tag? :yieldparam    # Same thing.
-
-    yieldtag = YARD::Tags::Tag.new(:yield, "", [])
-
-    if statement.type == :yield
-      statement.jump(:list).children.each do |item|
-        if item == s(:var_ref, s(:kw, "self"))
-          yieldtag.types << '_self'
-          owner.add_tag YARD::Tags::Tag.new(:yieldparam,
-            "the object that the method was called on", owner.namespace.path, '_self')
-        elsif item == s(:zsuper)
-          yieldtag.types << '_super'
-          owner.add_tag YARD::Tags::Tag.new(:yieldparam,
-            "the result of the method from the superclass", nil, '_super')
-        else
-          yieldtag.types << item.source
-        end
-      end
-    end
-
-    owner.add_tag(yieldtag) unless yieldtag.types.empty?
-  end
-end
+# frozen_string_literal: true
+# Handles 'yield' calls
+class YARD::Handlers::Ruby::YieldHandler < YARD::Handlers::Ruby::Base
+  handles :yield, :yield0
+
+  process do
+    return unless owner.is_a?(MethodObject) # Only methods yield
+    return if owner.has_tag? :yield         # Don't override yield tags
+    return if owner.has_tag? :yieldparam    # Same thing.
+
+    yieldtag = YARD::Tags::Tag.new(:yield, "", [])
+
+    if statement.type == :yield
+      statement.jump(:list).children.each do |item|
+        if item == s(:var_ref, s(:kw, "self"))
+          yieldtag.types << '_self'
+          owner.add_tag YARD::Tags::Tag.new(:yieldparam,
+            "the object that the method was called on", owner.namespace.path, '_self')
+        elsif item == s(:zsuper)
+          yieldtag.types << '_super'
+          owner.add_tag YARD::Tags::Tag.new(:yieldparam,
+            "the result of the method from the superclass", nil, '_super')
+        else
+          yieldtag.types << item.source
+        end
+      end
+    end
+
+    owner.add_tag(yieldtag) unless yieldtag.types.empty?
+  end
+end

data/lib/yard/i18n/locale.rb

@@ -1,67 +1,67 @@
-# frozen_string_literal: true
-module YARD
-  module I18n
-    # +Locale+ is a unit of translation. It has {#name} and a set of
-    # messages.
-    #
-    # @since 0.8.2
-    class Locale
-      class << self
-        # @return [String, nil] the default locale name.
-        # @since 0.8.4
-        attr_accessor :default
-
-        undef default
-        def default
-          @@default ||= nil
-        end
-
-        undef default=
-        def default=(locale)
-          @@default = locale
-        end
-      end
-
-      # @return [String] the name of the locale. It used IETF language
-      #   tag format +[language[_territory][.codeset][@modifier]]+.
-      # @see http://tools.ietf.org/rfc/bcp/bcp47.txt
-      #   BCP 47 - Tags for Identifying Languages
-      attr_reader :name
-
-      # Creates a locale for +name+ locale.
-      #
-      # @param [String] name the locale name.
-      def initialize(name)
-        @name = name
-        @messages = {}
-      end
-
-      # Loads translation messages from +locale_directory+/{#name}.po.
-      #
-      # @param [String] locale_directory the directory path that has
-      #   {#name}.po.
-      # @return [Boolean] +true+ if PO file exists, +false+ otherwise.
-      def load(locale_directory)
-        return false if @name.nil?
-
-        po_file = File.join(locale_directory, "#{@name}.po")
-        return false unless File.exist?(po_file)
-
-        require "yard/i18n/po_parser"
-        return false unless POParser.available?
-
-        po_parser = POParser.new
-        @messages.merge!(po_parser.parse(po_file))
-
-        true
-      end
-
-      # @param [String] message the translation target message.
-      # @return [String] translated message. If tarnslation isn't
-      #   registered, the +message+ is returned.
-      def translate(message)
-        @messages[message] || message
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module I18n
+    # +Locale+ is a unit of translation. It has {#name} and a set of
+    # messages.
+    #
+    # @since 0.8.2
+    class Locale
+      class << self
+        # @return [String, nil] the default locale name.
+        # @since 0.8.4
+        attr_accessor :default
+
+        undef default
+        def default
+          @@default ||= nil
+        end
+
+        undef default=
+        def default=(locale)
+          @@default = locale
+        end
+      end
+
+      # @return [String] the name of the locale. It used IETF language
+      #   tag format +[language[_territory][.codeset][@modifier]]+.
+      # @see http://tools.ietf.org/rfc/bcp/bcp47.txt
+      #   BCP 47 - Tags for Identifying Languages
+      attr_reader :name
+
+      # Creates a locale for +name+ locale.
+      #
+      # @param [String] name the locale name.
+      def initialize(name)
+        @name = name
+        @messages = {}
+      end
+
+      # Loads translation messages from +locale_directory+/{#name}.po.
+      #
+      # @param [String] locale_directory the directory path that has
+      #   {#name}.po.
+      # @return [Boolean] +true+ if PO file exists, +false+ otherwise.
+      def load(locale_directory)
+        return false if @name.nil?
+
+        po_file = File.join(locale_directory, "#{@name}.po")
+        return false unless File.exist?(po_file)
+
+        require "yard/i18n/po_parser"
+        return false unless POParser.available?
+
+        po_parser = POParser.new
+        @messages.merge!(po_parser.parse(po_file))
+
+        true
+      end
+
+      # @param [String] message the translation target message.
+      # @return [String] translated message. If tarnslation isn't
+      #   registered, the +message+ is returned.
+      def translate(message)
+        @messages[message] || message
+      end
+    end
+  end
+end

data/lib/yard/i18n/message.rb

@@ -1,57 +1,57 @@
-# frozen_string_literal: true
-require "set"
-
-module YARD
-  module I18n
-    # +Message+ is a translation target message. It has message ID as
-    # {#id} and some properties {#locations} and {#comments}.
-    #
-    # @since 0.8.1
-    class Message
-      # @return [String] the message ID of the trnslation target message.
-      attr_reader :id
-
-      # @return [Set] the set of locations. Location is an array of
-      # path and line number where the message is appeared.
-      attr_reader :locations
-
-      # @return [Set] the set of comments for the messages.
-      attr_reader :comments
-
-      # Creates a trasnlate target message for message ID +id+.
-      #
-      # @param [String] id the message ID of the translate target message.
-      def initialize(id)
-        @id = id
-        @locations = Set.new
-        @comments = Set.new
-      end
-
-      # Adds location information for the message.
-      #
-      # @param [String] path the path where the message appears.
-      # @param [Integer] line the line number where the message appears.
-      # @return [void]
-      def add_location(path, line)
-        @locations << [path, line]
-      end
-
-      # Adds a comment for the message.
-      #
-      # @param [String] comment the comment for the message to be added.
-      # @return [void]
-      def add_comment(comment)
-        @comments << comment unless comment.nil?
-      end
-
-      # @param [Message] other the +Message+ to be compared.
-      # @return [Boolean] checks whether this message is equal to another.
-      def ==(other)
-        other.is_a?(self.class) &&
-          @id == other.id &&
-          @locations == other.locations &&
-          @comments == other.comments
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require "set"
+
+module YARD
+  module I18n
+    # +Message+ is a translation target message. It has message ID as
+    # {#id} and some properties {#locations} and {#comments}.
+    #
+    # @since 0.8.1
+    class Message
+      # @return [String] the message ID of the trnslation target message.
+      attr_reader :id
+
+      # @return [Set] the set of locations. Location is an array of
+      # path and line number where the message is appeared.
+      attr_reader :locations
+
+      # @return [Set] the set of comments for the messages.
+      attr_reader :comments
+
+      # Creates a trasnlate target message for message ID +id+.
+      #
+      # @param [String] id the message ID of the translate target message.
+      def initialize(id)
+        @id = id
+        @locations = Set.new
+        @comments = Set.new
+      end
+
+      # Adds location information for the message.
+      #
+      # @param [String] path the path where the message appears.
+      # @param [Integer] line the line number where the message appears.
+      # @return [void]
+      def add_location(path, line)
+        @locations << [path, line]
+      end
+
+      # Adds a comment for the message.
+      #
+      # @param [String] comment the comment for the message to be added.
+      # @return [void]
+      def add_comment(comment)
+        @comments << comment unless comment.nil?
+      end
+
+      # @param [Message] other the +Message+ to be compared.
+      # @return [Boolean] checks whether this message is equal to another.
+      def ==(other)
+        other.is_a?(self.class) &&
+          @id == other.id &&
+          @locations == other.locations &&
+          @comments == other.comments
+      end
+    end
+  end
+end

data/lib/yard/i18n/messages.rb

@@ -1,56 +1,56 @@
-# frozen_string_literal: true
-module YARD
-  module I18n
-    # Acts as a container for {Message} objects.
-    #
-    # @since 0.8.1
-    class Messages
-      include Enumerable
-
-      # Creates a new container.
-      def initialize
-        @messages = {}
-      end
-
-      # Enumerates each {Message} in the container.
-      #
-      # @yieldparam [Message] message the next message object in
-      #   the enumeration.
-      # @return [void]
-      def each(&block)
-        @messages.each_value(&block)
-      end
-
-      # @param [String] id the message ID to perform a lookup on.
-      # @return [Message, nil] a registered message for the given +id+,
-      #   or nil if no message for the ID is found.
-      def [](id)
-        @messages[id]
-      end
-
-      # Registers a {Message}, the mssage ID of which is +id+. If
-      # corresponding +Message+ is already registered, the previously
-      # registered object is returned.
-      #
-      # @param [String] id the ID of the message to be registered.
-      # @return [Message] the registered +Message+.
-      def register(id)
-        @messages[id] ||= Message.new(id)
-      end
-
-      # Checks if this messages list is equal to another messages list.
-      #
-      # @param [Messages] other the container to compare.
-      # @return [Boolean] whether +self+ and +other+ is equivalence or not.
-      def ==(other)
-        other.is_a?(self.class) &&
-          @messages == other.messages
-      end
-
-      protected
-
-      # @return [Hash{String=>Message}] the set of message objects
-      attr_reader :messages
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module I18n
+    # Acts as a container for {Message} objects.
+    #
+    # @since 0.8.1
+    class Messages
+      include Enumerable
+
+      # Creates a new container.
+      def initialize
+        @messages = {}
+      end
+
+      # Enumerates each {Message} in the container.
+      #
+      # @yieldparam [Message] message the next message object in
+      #   the enumeration.
+      # @return [void]
+      def each(&block)
+        @messages.each_value(&block)
+      end
+
+      # @param [String] id the message ID to perform a lookup on.
+      # @return [Message, nil] a registered message for the given +id+,
+      #   or nil if no message for the ID is found.
+      def [](id)
+        @messages[id]
+      end
+
+      # Registers a {Message}, the mssage ID of which is +id+. If
+      # corresponding +Message+ is already registered, the previously
+      # registered object is returned.
+      #
+      # @param [String] id the ID of the message to be registered.
+      # @return [Message] the registered +Message+.
+      def register(id)
+        @messages[id] ||= Message.new(id)
+      end
+
+      # Checks if this messages list is equal to another messages list.
+      #
+      # @param [Messages] other the container to compare.
+      # @return [Boolean] whether +self+ and +other+ is equivalence or not.
+      def ==(other)
+        other.is_a?(self.class) &&
+          @messages == other.messages
+      end
+
+      protected
+
+      # @return [Hash{String=>Message}] the set of message objects
+      attr_reader :messages
+    end
+  end
+end