yard 0.9.5 → 0.9.6

data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 # (see Ruby::PrivateClassMethodHandler)
 class YARD::Handlers::Ruby::Legacy::PrivateClassMethodHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles /\Aprivate_class_method(\s|\(|$)/
+  handles(/\Aprivate_class_method(\s|\(|$)/)
   namespace_only
 
   process do

data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 # (see Ruby::PrivateConstantHandler)
 class YARD::Handlers::Ruby::Legacy::PrivateConstantHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles /\Aprivate_constant(\s|\(|$)/
+  handles(/\Aprivate_constant(\s|\(|$)/)
   namespace_only
 
   process do

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

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 # (see Ruby::VisibilityHandler)
 class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles /\A(protected|private|public)(\s|\(|$)/
+  handles(/\A(protected|private|public)(\s|\(|$)/)
   namespace_only
 
   process do
@@ -13,4 +14,4 @@ class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Le
       end
     end
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # (see Ruby::YieldHandler)
 class YARD::Handlers::Ruby::Legacy::YieldHandler < YARD::Handlers::Ruby::Legacy::Base
   handles TkYIELD

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Handles a conditional inside a method
 class YARD::Handlers::Ruby::MethodConditionHandler < YARD::Handlers::Ruby::Base
   handles :if_mod, :unless_mod
@@ -5,4 +6,4 @@ class YARD::Handlers::Ruby::MethodConditionHandler < YARD::Handlers::Ruby::Base
   process do
     parse_block(statement.then_block, :owner => owner)
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Handles a method definition
 class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
   handles :def, :defs
@@ -58,11 +59,12 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
       end
     end
 
-    if info = obj.attr_info
+    info = obj.attr_info
+    if info
       if meth.to_s =~ /=$/ # writer
         info[:write] = obj if info[:read]
-      else
-        info[:read] = obj if info[:write]
+      elsif info[:write]
+        info[:read] = obj
       end
     end
 
@@ -75,7 +77,7 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
     params = []
 
     if args.unnamed_required_params
-      params += args.unnamed_required_params.map { |a| [a.source, nil] }
+      params += args.unnamed_required_params.map {|a| [a.source, nil] }
     end
 
     if args.unnamed_optional_params
@@ -84,12 +86,10 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
       end
     end
 
-    if args.splat_param
-      params << ['*' + args.splat_param.source, nil]
-    end
+    params << ['*' + args.splat_param.source, nil] if args.splat_param
 
     if args.unnamed_end_params
-      params += args.unnamed_end_params.map { |a| [a.source, nil] }
+      params += args.unnamed_end_params.map {|a| [a.source, nil] }
     end
 
     if args.named_params
@@ -102,9 +102,7 @@ class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
       params << ['**' + args.double_splat_param.source, nil]
     end
 
-    if args.block_param
-      params << ['&' + args.block_param.source, nil]
-    end
+    params << ['&' + args.block_param.source, nil] if args.block_param
 
     params
   end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Handles the 'include' statement to mixin a module in the instance scope
 class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
   handles method_call(:include)
@@ -12,7 +13,7 @@ class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
         errors << err.message
       end
     end
-    if errors.size > 0
+    unless errors.empty?
       msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
       raise YARD::Parser::UndocumentableError, "mixin#{msg} for class #{namespace.path}"
     end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Handles module_function calls to turn methods into public class methods.
 # Also creates a private instance copy of the method.
 class YARD::Handlers::Ruby::ModuleFunctionHandler < YARD::Handlers::Ruby::Base
@@ -5,7 +6,7 @@ class YARD::Handlers::Ruby::ModuleFunctionHandler < YARD::Handlers::Ruby::Base
   namespace_only
 
   process do
-    return if (ident = statement.jump(:ident)) == statement
+    return if statement.jump(:ident) == statement
     case statement.type
     when :var_ref, :vcall
       self.scope = :module

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Handles the declaration of a module
 class YARD::Handlers::Ruby::ModuleHandler < YARD::Handlers::Ruby::Base
   handles :module
@@ -8,4 +9,4 @@ class YARD::Handlers::Ruby::ModuleHandler < YARD::Handlers::Ruby::Base
     mod = register ModuleObject.new(namespace, modname)
     parse_block(statement[1], :namespace => mod)
   end
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Sets visibility of a class method to private.
 class YARD::Handlers::Ruby::PrivateClassMethodHandler < YARD::Handlers::Ruby::Base
   include YARD::Handlers::Ruby::DecoratorHandlerMethods

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

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 module YARD
   module Handlers
     module Ruby
-
       # Sets visibility of a constant (class, module, const)
       class PrivateConstantHandler < YARD::Handlers::Ruby::Base
         handles method_call(:private_constant)
@@ -17,7 +17,7 @@ module YARD
               errors << err.message
             end
           end
-          if errors.size > 0
+          unless errors.empty?
             msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
             raise UndocumentableError, "private constant#{msg} for #{namespace.path}"
           end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Sets visibility of a class method to public.
 class YARD::Handlers::Ruby::PublicClassMethodHandler < YARD::Handlers::Ruby::Base
   include YARD::Handlers::Ruby::DecoratorHandlerMethods

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Helper methods to parse @attr_* tags on a class.
 #
 # @deprecated The use of +@attr+ tags are deprecated since 0.8.0 in favour of
@@ -15,7 +16,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
   # @return [Tags::Tag, nil] the tag matching the request, or nil if not found
   def member_tag_for_member(klass, member, type = :read)
     specific_tag = type == :read ? :attr_reader : :attr_writer
-    (klass.tags(specific_tag) + klass.tags(:attr)).find {|tag| tag.name == member}
+    (klass.tags(specific_tag) + klass.tags(:attr)).find {|tag| tag.name == member }
   end
 
   # Retrieves all members defined in @attr* tags
@@ -24,7 +25,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
   # @return [Array<String>] the list of members defined as attributes on the class
   def members_from_tags(klass)
     tags = klass.tags(:attr) + klass.tags(:attr_reader) + klass.tags(:attr_writer)
-    tags.map {|t| t.name }.uniq
+    tags.map(&:name).uniq
   end
 
   # Determines whether to create an attribute method based on the class's
@@ -38,7 +39,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
     return true if (klass.tags(:attr) + klass.tags(:attr_reader) + klass.tags(:attr_writer)).empty?
     return true if member_tag_for_member(klass, member, type)
     return !member_tag_for_member(klass, member, :write) if type == :read
-    return !member_tag_for_member(klass, member, :read)
+    !member_tag_for_member(klass, member, :read)
   end
 
   # Gets the return type for the member in a nicely formatted string. Used
@@ -48,7 +49,7 @@ module YARD::Handlers::Ruby::StructHandlerMethods
   # @return [String] the user-declared type of the struct member, or [Object] if
   #   the user did not define a type for this member.
   def return_type_from_tag(member_tag)
-    (member_tag && member_tag.types) ? member_tag.types : "Object"
+    member_tag && member_tag.types ? member_tag.types : "Object"
   end
 
   # Creates the auto-generated docstring for the getter method of a struct's

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Handles 'private', 'protected', and 'public' calls.
 class YARD::Handlers::Ruby::VisibilityHandler < YARD::Handlers::Ruby::Base
   include YARD::Handlers::Ruby::DecoratorHandlerMethods

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Handles 'yield' calls
 class YARD::Handlers::Ruby::YieldHandler < YARD::Handlers::Ruby::Base
   handles :yield, :yield0

data/lib/yard/i18n/locale.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module I18n
     # +Locale+ is a unit of translation. It has {#name} and a set of

data/lib/yard/i18n/message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "set"
 
 module YARD
@@ -10,7 +11,7 @@ module YARD
       # @return [String] the message ID of the trnslation target message.
       attr_reader :id
 
-      # @return [Set] the set of locations. Location is an array of 
+      # @return [Set] the set of locations. Location is an array of
       # path and line number where the message is appeared.
       attr_reader :locations
 
@@ -46,9 +47,9 @@ module YARD
       # @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) and
-          @id == other.id and
-          @locations == other.locations and
+        other.is_a?(self.class) &&
+          @id == other.id &&
+          @locations == other.locations &&
           @comments == other.comments
       end
     end

data/lib/yard/i18n/messages.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module I18n
     # Acts as a container for {Message} objects.
@@ -42,7 +43,7 @@ module YARD
       # @param [Messages] other the container to compare.
       # @return [Boolean] whether +self+ and +other+ is equivalence or not.
       def ==(other)
-        other.is_a?(self.class) and
+        other.is_a?(self.class) &&
           @messages == other.messages
       end
 

data/lib/yard/i18n/po_parser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module I18n
     # +Locale+ is a wrapper for gettext's PO parsing feature. It hides
@@ -11,8 +12,8 @@ module YARD
           require "gettext/runtime/mofile"
           @@gettext_version = 2
         rescue LoadError
-          log.warn "Need gettext gem 2.x for i18n feature:"
-          log.warn "  gem install gettext -v 2.3.9"
+          log.warn "Need gettext gem 2.x for i18n feature:\n" \
+                   "\tgem install gettext -v 2.3.9"
         end
       else
         begin
@@ -25,8 +26,8 @@ module YARD
             require "gettext/runtime/mofile"
             @@gettext_version = 2
           rescue LoadError
-            log.warn "Need gettext gem for i18n feature:"
-            log.warn "  gem install gettext"
+            log.warn "Need gettext gem for i18n feature:\n" \
+                     "\tgem install gettext"
           end
         end
       end

data/lib/yard/i18n/pot_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "stringio"
 
 module YARD
@@ -119,11 +120,9 @@ module YARD
       #
       # @return [String] POT format string
       def generate
-        pot = header
+        pot = String.new(header)
         sorted_messages = @messages.sort_by do |message|
-          sorted_locations = message.locations.sort_by do |location|
-            location
-          end
+          sorted_locations = message.locations.sort
           sorted_locations.first || []
         end
         sorted_messages.each do |message|
@@ -133,6 +132,7 @@ module YARD
       end
 
       private
+
       def header
         <<-EOH
 # SOME DESCRIPTIVE TITLE.
@@ -192,7 +192,7 @@ EOH
       end
 
       def extract_documents(object)
-        return if @extracted_objects.has_key?(object)
+        return if @extracted_objects.key?(object)
 
         @extracted_objects[object] = true
         case object
@@ -241,13 +241,13 @@ EOH
 
       def extract_tag_name(tag)
         return if tag.name.nil?
-        return if tag.name.is_a?(String) and tag.name.empty?
+        return if tag.name.is_a?(String) && tag.name.empty?
         key = "tag|#{tag.tag_name}|#{tag.name}"
         message = register_message(key)
         tag.object.files.each do |path, line|
           message.add_location(path, line)
         end
-        tag_label = "@#{tag.tag_name}"
+        tag_label = String.new("@#{tag.tag_name}")
         tag_label << " [#{tag.types.join(', ')}]" if tag.types
         message.add_comment(tag_label)
       end
@@ -259,7 +259,7 @@ EOH
         tag.object.files.each do |path, line|
           message.add_location(path, line)
         end
-        tag_label = "@#{tag.tag_name}"
+        tag_label = String.new("@#{tag.tag_name}")
         tag_label << " [#{tag.types.join(', ')}]" if tag.types
         tag_label << " #{tag.name}" if tag.name
         message.add_comment(tag_label)

data/lib/yard/i18n/text.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module YARD
   module I18n
     # Provides some convenient features for translating a text.
@@ -8,7 +9,7 @@ module YARD
       # @param [#each_line] input a text to be translated.
       # @option options [Boolean] :have_header (false) whether the
       #   input text has header or not.
-      def initialize(input, options={})
+      def initialize(input, options = {})
         @input = input
         @options = options
       end
@@ -33,7 +34,6 @@ module YARD
       # @return [void]
       def extract_messages
         parse do |part|
-          line_no = part[:line_no]
           case part[:type]
           when :markup, :empty_line
             # ignore
@@ -50,7 +50,7 @@ module YARD
       # @param [Locale] locale the translation target locale.
       # @return [String] translated text.
       def translate(locale)
-        translated_text = ""
+        translated_text = String.new("")
         parse do |part|
           case part[:type]
           when :markup
@@ -74,7 +74,7 @@ module YARD
       private
 
       def parse(&block)
-        paragraph = ""
+        paragraph = String.new("")
         paragraph_start_line = 0
         line_no = 0
         in_header = @options[:have_header]
@@ -109,7 +109,7 @@ module YARD
               paragraph << line
               emit_paragraph_event(paragraph, paragraph_start_line, line_no,
                                    &block)
-              paragraph = ""
+              paragraph = String.new("")
             end
           else
             paragraph_start_line = line_no if paragraph.empty?
@@ -126,7 +126,7 @@ module YARD
         part = {
           :type => :markup,
           :line => line,
-          :line_no => line_no,
+          :line_no => line_no
         }
         yield(part)
       end
@@ -139,7 +139,7 @@ module YARD
           :infix => match_data[3],
           :value => match_data[4],
           :suffix => match_data[5],
-          :line_no => line_no,
+          :line_no => line_no
         }
         yield(part)
       end
@@ -148,7 +148,7 @@ module YARD
         part = {
           :type => :empty_line,
           :line => line,
-          :line_no => line_no,
+          :line_no => line_no
         }
         yield(part)
       end
@@ -156,7 +156,7 @@ module YARD
       def emit_paragraph_event(paragraph, paragraph_start_line, line_no, &block)
         paragraph_part = {
           :type => :paragraph,
-          :line_no => paragraph_start_line,
+          :line_no => paragraph_start_line
         }
         match_data = /(\s*)\z/.match(paragraph)
         if match_data