honeybadger 5.3.0 → 5.4.0

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/generator/pot/po_entry.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+##
+# A PO entry in PO
+
+class RDoc::Generator::POT::POEntry
+
+  # The msgid content
+  attr_reader :msgid
+
+  # The msgstr content
+  attr_reader :msgstr
+
+  # The comment content created by translator (PO editor)
+  attr_reader :translator_comment
+
+  # The comment content extracted from source file
+  attr_reader :extracted_comment
+
+  # The locations where the PO entry is extracted
+  attr_reader :references
+
+  # The flags of the PO entry
+  attr_reader :flags
+
+  ##
+  # Creates a PO entry for +msgid+. Other valus can be specified by
+  # +options+.
+
+  def initialize msgid, options = {}
+    @msgid = msgid
+    @msgstr = options[:msgstr] || ""
+    @translator_comment = options[:translator_comment]
+    @extracted_comment = options[:extracted_comment]
+    @references = options[:references] || []
+    @flags = options[:flags] || []
+  end
+
+  ##
+  # Returns the PO entry in PO format.
+
+  def to_s
+    entry = ''
+    entry += format_translator_comment
+    entry += format_extracted_comment
+    entry += format_references
+    entry += format_flags
+    entry += <<-ENTRY
+msgid #{format_message(@msgid)}
+msgstr #{format_message(@msgstr)}
+    ENTRY
+  end
+
+  ##
+  # Merges the PO entry with +other_entry+.
+
+  def merge other_entry
+    options = {
+      :extracted_comment  => merge_string(@extracted_comment,
+                                          other_entry.extracted_comment),
+      :translator_comment => merge_string(@translator_comment,
+                                          other_entry.translator_comment),
+      :references         => merge_array(@references,
+                                         other_entry.references),
+      :flags              => merge_array(@flags,
+                                         other_entry.flags),
+    }
+    self.class.new(@msgid, options)
+  end
+
+  private
+
+  def format_comment mark, comment
+    return '' unless comment
+    return '' if comment.empty?
+
+    formatted_comment = ''
+    comment.each_line do |line|
+      formatted_comment += "#{mark} #{line}"
+    end
+    formatted_comment += "\n" unless formatted_comment.end_with?("\n")
+    formatted_comment
+  end
+
+  def format_translator_comment
+    format_comment('#', @translator_comment)
+  end
+
+  def format_extracted_comment
+    format_comment('#.', @extracted_comment)
+  end
+
+  def format_references
+    return '' if @references.empty?
+
+    formatted_references = ''
+    @references.sort.each do |file, line|
+      formatted_references += "\#: #{file}:#{line}\n"
+    end
+    formatted_references
+  end
+
+  def format_flags
+    return '' if @flags.empty?
+
+    formatted_flags = flags.join(",")
+    "\#, #{formatted_flags}\n"
+  end
+
+  def format_message message
+    return "\"#{escape(message)}\"" unless message.include?("\n")
+
+    formatted_message = '""'
+    message.each_line do |line|
+      formatted_message += "\n"
+      formatted_message += "\"#{escape(line)}\""
+    end
+    formatted_message
+  end
+
+  def escape string
+    string.gsub(/["\\\t\n]/) do |special_character|
+      case special_character
+      when "\t"
+        "\\t"
+      when "\n"
+        "\\n"
+      else
+        "\\#{special_character}"
+      end
+    end
+  end
+
+  def merge_string string1, string2
+    [string1, string2].compact.join("\n")
+  end
+
+  def merge_array array1, array2
+      (array1 + array2).uniq
+  end
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/generator/pot.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+##
+# Generates a POT file.
+#
+# Here is a translator work flow with the generator.
+#
+# == Create .pot
+#
+# You create .pot file by pot formatter:
+#
+#   % rdoc --format pot
+#
+# It generates doc/rdoc.pot.
+#
+# == Create .po
+#
+# You create .po file from doc/rdoc.pot. This operation is needed only
+# the first time. This work flow assumes that you are a translator
+# for Japanese.
+#
+# You create locale/ja/rdoc.po from doc/rdoc.pot. You can use msginit
+# provided by GNU gettext or rmsginit provided by gettext gem. This
+# work flow uses gettext gem because it is more portable than GNU
+# gettext for Rubyists. Gettext gem is implemented by pure Ruby.
+#
+#   % gem install gettext
+#   % mkdir -p locale/ja
+#   % rmsginit --input doc/rdoc.pot --output locale/ja/rdoc.po --locale ja
+#
+# Translate messages in .po
+#
+# You translate messages in .po by a PO file editor. po-mode.el exists
+# for Emacs users. There are some GUI tools such as GTranslator.
+# There are some Web services such as POEditor and Tansifex. You can
+# edit by your favorite text editor because .po is a text file.
+# Generate localized documentation
+#
+# You can generate localized documentation with locale/ja/rdoc.po:
+#
+#   % rdoc --locale ja
+#
+# You can find documentation in Japanese in doc/. Yay!
+#
+# == Update translation
+#
+# You need to update translation when your application is added or
+# modified messages.
+#
+# You can update .po by the following command lines:
+#
+#   % rdoc --format pot
+#   % rmsgmerge --update locale/ja/rdoc.po doc/rdoc.pot
+#
+# You edit locale/ja/rdoc.po to translate new messages.
+
+class RDoc::Generator::POT
+
+  RDoc::RDoc.add_generator self
+
+  ##
+  # Description of this generator
+
+  DESCRIPTION = 'creates .pot file'
+
+  ##
+  # Set up a new .pot generator
+
+  def initialize store, options #:not-new:
+    @options    = options
+    @store      = store
+  end
+
+  ##
+  # Writes .pot to disk.
+
+  def generate
+    po = extract_messages
+    pot_path = 'rdoc.pot'
+    File.open(pot_path, "w") do |pot|
+      pot.print(po.to_s)
+    end
+  end
+
+  def class_dir
+    nil
+  end
+
+  private
+  def extract_messages
+    extractor = MessageExtractor.new(@store)
+    extractor.extract
+  end
+
+  require_relative 'pot/message_extractor'
+  require_relative 'pot/po'
+  require_relative 'pot/po_entry'
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/generator/ri.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+##
+# Generates ri data files
+
+class RDoc::Generator::RI
+
+  RDoc::RDoc.add_generator self
+
+  ##
+  # Description of this generator
+
+  DESCRIPTION = 'creates ri data files'
+
+  ##
+  # Set up a new ri generator
+
+  def initialize store, options #:not-new:
+    @options    = options
+    @store      = store
+    @store.path = '.'
+  end
+
+  ##
+  # Writes the parsed data store to disk for use by ri.
+
+  def generate
+    @store.save
+  end
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+##
+# RDoc uses generators to turn parsed source code in the form of an
+# RDoc::CodeObject tree into some form of output.  RDoc comes with the HTML
+# generator RDoc::Generator::Darkfish and an ri data generator
+# RDoc::Generator::RI.
+#
+# == Registering a Generator
+#
+# Generators are registered by calling RDoc::RDoc.add_generator with the class
+# of the generator:
+#
+#   class My::Awesome::Generator
+#     RDoc::RDoc.add_generator self
+#   end
+#
+# == Adding Options to +rdoc+
+#
+# Before option processing in +rdoc+, RDoc::Options will call ::setup_options
+# on the generator class with an RDoc::Options instance.  The generator can
+# use RDoc::Options#option_parser to add command-line options to the +rdoc+
+# tool.  See RDoc::Options@Custom+Options for an example and see OptionParser
+# for details on how to add options.
+#
+# You can extend the RDoc::Options instance with additional accessors for your
+# generator.
+#
+# == Generator Instantiation
+#
+# After parsing, RDoc::RDoc will instantiate a generator by calling
+# #initialize with an RDoc::Store instance and an RDoc::Options instance.
+#
+# The RDoc::Store instance holds documentation for parsed source code.  In
+# RDoc 3 and earlier the RDoc::TopLevel class held this data.  When upgrading
+# a generator from RDoc 3 and earlier you should only need to replace
+# RDoc::TopLevel with the store instance.
+#
+# RDoc will then call #generate on the generator instance.  You can use the
+# various methods on RDoc::Store and in the RDoc::CodeObject tree to create
+# your desired output format.
+
+module RDoc::Generator
+
+  autoload :Markup,   "#{__dir__}/generator/markup"
+
+  autoload :Darkfish,  "#{__dir__}/generator/darkfish"
+  autoload :JsonIndex, "#{__dir__}/generator/json_index"
+  autoload :RI,        "#{__dir__}/generator/ri"
+  autoload :POT,       "#{__dir__}/generator/pot"
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/ghost_method.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+##
+# GhostMethod represents a method referenced only by a comment
+
+class RDoc::GhostMethod < RDoc::AnyMethod
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/i18n/locale.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+##
+# A message container for a locale.
+#
+# This object provides the following two features:
+#
+#   * Loads translated messages from .po file.
+#   * Translates a message into the locale.
+
+class RDoc::I18n::Locale
+
+  @@locales = {} # :nodoc:
+
+  class << self
+
+    ##
+    # Returns the locale object for +locale_name+.
+
+    def [](locale_name)
+      @@locales[locale_name] ||= new(locale_name)
+    end
+
+    ##
+    # Sets the locale object for +locale_name+.
+    #
+    # Normally, this method is not used. This method is useful for
+    # testing.
+
+    def []=(locale_name, locale)
+      @@locales[locale_name] = locale
+    end
+
+  end
+
+  ##
+  # The name of the locale. It uses IETF language tag format
+  # +[language[_territory][.codeset][@modifier]]+.
+  #
+  # See also {BCP 47 - Tags for Identifying
+  # Languages}[http://tools.ietf.org/rfc/bcp/bcp47.txt].
+
+  attr_reader :name
+
+  ##
+  # Creates a new locale object for +name+ locale. +name+ must
+  # follow IETF language tag format.
+
+  def initialize(name)
+    @name = name
+    @messages = {}
+  end
+
+  ##
+  # Loads translation messages from +locale_directory+/+@name+/rdoc.po
+  # or +locale_directory+/+@name+.po. The former has high priority.
+  #
+  # This method requires gettext gem for parsing .po file. If you
+  # don't have gettext gem, this method doesn't load .po file. This
+  # method warns and returns +false+.
+  #
+  # Returns +true+ if succeeded, +false+ otherwise.
+
+  def load(locale_directory)
+    return false if @name.nil?
+
+    po_file_candidates = [
+      File.join(locale_directory, @name, 'rdoc.po'),
+      File.join(locale_directory, "#{@name}.po"),
+    ]
+    po_file = po_file_candidates.find do |po_file_candidate|
+      File.exist?(po_file_candidate)
+    end
+    return false unless po_file
+
+    begin
+      require 'gettext/po_parser'
+      require 'gettext/mo'
+    rescue LoadError
+      warn('Need gettext gem for i18n feature:')
+      warn('  gem install gettext')
+      return false
+    end
+
+    po_parser = GetText::POParser.new
+    messages = GetText::MO.new
+    po_parser.report_warning = false
+    po_parser.parse_file(po_file, messages)
+
+    @messages.merge!(messages)
+
+    true
+  end
+
+  ##
+  # Translates the +message+ into locale. If there is no translation
+  # messages for +message+ in locale, +message+ itself is returned.
+
+  def translate(message)
+    @messages[message] || message
+  end
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/i18n/text.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+##
+# An i18n supported text.
+#
+# This object provides the following two features:
+#
+#   * Extracts translation messages from wrapped raw text.
+#   * Translates wrapped raw text in specified locale.
+#
+# Wrapped raw text is one of String, RDoc::Comment or Array of them.
+
+class RDoc::I18n::Text
+
+  ##
+  # Creates a new i18n supported text for +raw+ text.
+
+  def initialize(raw)
+    @raw = raw
+  end
+
+  ##
+  # Extracts translation target messages and yields each message.
+  #
+  # Each yielded message is a Hash. It consists of the followings:
+  #
+  # :type      :: :paragraph
+  # :paragraph :: String (The translation target message itself.)
+  # :line_no   :: Integer (The line number of the :paragraph is started.)
+  #
+  # The above content may be added in the future.
+
+  def extract_messages
+    parse do |part|
+      case part[:type]
+      when :empty_line
+        # ignore
+      when :paragraph
+        yield(part)
+      end
+    end
+  end
+
+  # Translates raw text into +locale+.
+  def translate(locale)
+    translated_text = ''
+    parse do |part|
+      case part[:type]
+      when :paragraph
+        translated_text += locale.translate(part[:paragraph])
+      when :empty_line
+        translated_text += part[:line]
+      else
+        raise "should not reach here: unexpected type: #{type}"
+      end
+    end
+    translated_text
+  end
+
+  private
+  def parse(&block)
+    paragraph = ''
+    paragraph_start_line = 0
+    line_no = 0
+
+    each_line(@raw) do |line|
+      line_no += 1
+      case line
+      when /\A\s*\z/
+        if paragraph.empty?
+          emit_empty_line_event(line, line_no, &block)
+        else
+          paragraph += line
+          emit_paragraph_event(paragraph, paragraph_start_line, line_no,
+                               &block)
+          paragraph = ''
+        end
+      else
+        paragraph_start_line = line_no if paragraph.empty?
+        paragraph += line
+      end
+    end
+
+    unless paragraph.empty?
+      emit_paragraph_event(paragraph, paragraph_start_line, line_no, &block)
+    end
+  end
+
+  def each_line(raw, &block)
+    case raw
+    when RDoc::Comment
+      raw.text.each_line(&block)
+    when Array
+      raw.each do |comment, location|
+        each_line(comment, &block)
+      end
+    else
+      raw.each_line(&block)
+    end
+  end
+
+  def emit_empty_line_event(line, line_no)
+    part = {
+      :type => :empty_line,
+      :line => line,
+      :line_no => line_no,
+    }
+    yield(part)
+  end
+
+  def emit_paragraph_event(paragraph, paragraph_start_line, line_no, &block)
+    paragraph_part = {
+      :type => :paragraph,
+      :line_no => paragraph_start_line,
+    }
+    match_data = /(\s*)\z/.match(paragraph)
+    if match_data
+      paragraph_part[:paragraph] = match_data.pre_match
+      yield(paragraph_part)
+      emit_empty_line_event(match_data[1], line_no, &block)
+    else
+      paragraph_part[:paragraph] = paragraph
+      yield(paragraph_part)
+    end
+  end
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/i18n.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+##
+# This module provides i18n related features.
+
+module RDoc::I18n
+
+  autoload :Locale, "#{__dir__}/i18n/locale"
+  require_relative 'i18n/text'
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/include.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+##
+# A Module included in a class with \#include
+#
+#   RDoc::Include.new 'Enumerable', 'comment ...'
+
+class RDoc::Include < RDoc::Mixin
+
+end

data/vendor/bundle/ruby/3.2.0/gems/rdoc-6.6.0/lib/rdoc/known_classes.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+module RDoc
+
+  ##
+  # Ruby's built-in classes, modules and exceptions
+
+  KNOWN_CLASSES = {
+    "rb_cArray"            => "Array",
+    "rb_cBasicObject"      => "BasicObject",
+    "rb_cBignum"           => "Bignum",
+    "rb_cClass"            => "Class",
+    "rb_cData"             => "Data",
+    "rb_cDir"              => "Dir",
+    "rb_cEncoding"         => "Encoding",
+    "rb_cFalseClass"       => "FalseClass",
+    "rb_cFile"             => "File",
+    "rb_cFixnum"           => "Fixnum",
+    "rb_cFloat"            => "Float",
+    "rb_cHash"             => "Hash",
+    "rb_cIO"               => "IO",
+    "rb_cInteger"          => "Integer",
+    "rb_cModule"           => "Module",
+    "rb_cNilClass"         => "NilClass",
+    "rb_cNumeric"          => "Numeric",
+    "rb_cObject"           => "Object",
+    "rb_cProc"             => "Proc",
+    "rb_cRange"            => "Range",
+    "rb_cRefinement"       => "Refinement",
+    "rb_cRegexp"           => "Regexp",
+    "rb_cRubyVM"           => "RubyVM",
+    "rb_cSocket"           => "Socket",
+    "rb_cString"           => "String",
+    "rb_cStruct"           => "Struct",
+    "rb_cSymbol"           => "Symbol",
+    "rb_cThread"           => "Thread",
+    "rb_cTime"             => "Time",
+    "rb_cTrueClass"        => "TrueClass",
+
+    "rb_eArgError"         => "ArgumentError",
+    "rb_eEOFError"         => "EOFError",
+    "rb_eException"        => "Exception",
+    "rb_eFatal"            => "fatal",
+    "rb_eFloatDomainError" => "FloatDomainError",
+    "rb_eIOError"          => "IOError",
+    "rb_eIndexError"       => "IndexError",
+    "rb_eInterrupt"        => "Interrupt",
+    "rb_eLoadError"        => "LoadError",
+    "rb_eNameError"        => "NameError",
+    "rb_eNoMemError"       => "NoMemoryError",
+    "rb_eNotImpError"      => "NotImplementedError",
+    "rb_eRangeError"       => "RangeError",
+    "rb_eRuntimeError"     => "RuntimeError",
+    "rb_eScriptError"      => "ScriptError",
+    "rb_eSecurityError"    => "SecurityError",
+    "rb_eSignal"           => "SignalException",
+    "rb_eStandardError"    => "StandardError",
+    "rb_eSyntaxError"      => "SyntaxError",
+    "rb_eSystemCallError"  => "SystemCallError",
+    "rb_eSystemExit"       => "SystemExit",
+    "rb_eTypeError"        => "TypeError",
+    "rb_eZeroDivError"     => "ZeroDivisionError",
+
+    "rb_mComparable"       => "Comparable",
+    "rb_mEnumerable"       => "Enumerable",
+    "rb_mErrno"            => "Errno",
+    "rb_mFConst"           => "File::Constants",
+    "rb_mFileTest"         => "FileTest",
+    "rb_mGC"               => "GC",
+    "rb_mKernel"           => "Kernel",
+    "rb_mMath"             => "Math",
+    "rb_mProcess"          => "Process"
+  }
+
+end