hyper-pro-gem 0.0.1

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

@@ -0,0 +1,61 @@
+# 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)
+  handles method_call(:prepend)
+  namespace_only
+
+  process do
+    errors = []
+    statement.parameters(false).reverse.each do |mixin|
+      begin
+        process_mixin(mixin)
+      rescue YARD::Parser::UndocumentableError => err
+        errors << err.message
+      end
+    end
+    unless errors.empty?
+      msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
+      raise YARD::Parser::UndocumentableError, "mixin#{msg} for class #{namespace.path}"
+    end
+  end
+
+  protected
+
+  def process_mixin(mixin)
+    raise YARD::Parser::UndocumentableError unless mixin.ref?
+    raise YARD::Parser::UndocumentableError if mixin.first.type == :ident
+
+    if mixin.type == :var_ref && mixin[0] == s(:kw, "self")
+      obj = namespace
+    else
+      case obj = Proxy.new(namespace, mixin.source)
+      when ConstantObject # If a constant is included, use its value as the real object
+        obj = Proxy.new(namespace, obj.value, :module)
+      else
+        obj = Proxy.new(namespace, mixin.source, :module)
+      end
+    end
+
+    rec = recipient(mixin)
+    return if rec.nil?
+
+    ensure_loaded!(rec)
+    return if rec.mixins(scope).include?(obj)
+
+    shift = statement.method_name(true) == :include ? :unshift : :push
+    rec.mixins(scope).send(shift, obj)
+  end
+
+  def recipient(mixin)
+    if statement[0].type == :const_path_ref || statement[0].type == :top_const_ref
+      Proxy.new(namespace, statement[0].source)
+    elsif statement[0].type == :var_ref && statement[0][0] != s(:kw, "self")
+      statement[0][0].type == :const ?
+        Proxy.new(namespace, statement.namespace.source) :
+        nil
+    else
+      namespace
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# 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
+  include YARD::Handlers::Ruby::DecoratorHandlerMethods
+
+  handles method_call(:module_function)
+  namespace_only
+
+  process do
+    return if statement.jump(:ident) == statement
+    case statement.type
+    when :var_ref, :vcall
+      self.scope = :module
+    when :fcall, :command
+      statement[1].traverse do |node|
+        case node.type
+        when :def
+          process_decorator do |instance_method|
+            make_module_function(instance_method, namespace)
+          end
+          break
+        when :symbol; name = node.first.source
+        when :string_content; name = node.source
+        else next
+        end
+
+        instance_method = MethodObject.new(namespace, name)
+        make_module_function(instance_method, namespace)
+      end
+    end
+  end
+
+  def make_module_function(instance_method, namespace)
+    class_method = MethodObject.new(namespace, instance_method.name, :module)
+    instance_method.copy_to(class_method)
+    class_method.visibility = :public
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# Handles the declaration of a module
+class YARD::Handlers::Ruby::ModuleHandler < YARD::Handlers::Ruby::Base
+  handles :module
+  namespace_only
+
+  process do
+    modname = statement[0].source
+    mod = register ModuleObject.new(namespace, modname)
+    parse_block(statement[1], :namespace => mod)
+  end
+end

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

@@ -0,0 +1,14 @@
+# 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
+
+  handles method_call(:private_class_method)
+  namespace_only
+
+  process do
+    process_decorator :scope => :class do |method|
+      method.visibility = :private if method.respond_to? :visibility=
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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)
+        namespace_only
+
+        process do
+          errors = []
+          statement.parameters.each do |param|
+            next unless AstNode === param
+            begin
+              privatize_constant(param)
+            rescue UndocumentableError => err
+              errors << err.message
+            end
+          end
+          unless errors.empty?
+            msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
+            raise UndocumentableError, "private constant#{msg} for #{namespace.path}"
+          end
+        end
+
+        private
+
+        def privatize_constant(node)
+          if node.literal? || (node.type == :var_ref && node[0].type == :const)
+            node = node.jump(:tstring_content, :const)
+            const = Proxy.new(namespace, node[0])
+            ensure_loaded!(const)
+            const.visibility = :private
+          else
+            raise UndocumentableError, "invalid argument to private_constant: #{node.source}"
+          end
+        rescue NamespaceMissingError
+          raise UndocumentableError, "private visibility set on unrecognized constant: #{node[0]}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# 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
+
+  handles method_call(:public_class_method)
+  namespace_only
+
+  process do
+    process_decorator :scope => :class do |method|
+      method.visibility = :public if method.respond_to? :visibility
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# 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
+#   the +@!attribute+ directive. This module should not be relied on.
+# @since 0.5.6
+module YARD::Handlers::Ruby::StructHandlerMethods
+  include YARD::CodeObjects
+
+  # Extracts the user's defined @member tag for a given class and its member. Returns
+  # nil if the user did not define a @member tag for this struct entry.
+  #
+  # @param [ClassObject] klass the class whose tags we're searching
+  # @param [String] member the name of the struct member we need
+  # @param [Symbol] type reader method, or writer method?
+  # @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 }
+  end
+
+  # Retrieves all members defined in @attr* tags
+  #
+  # @param [ClassObject] klass the class with the attributes
+  # @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(&:name).uniq
+  end
+
+  # Determines whether to create an attribute method based on the class's
+  # tags.
+  #
+  # @param [ClassObject] klass the class whose tags we're searching
+  # @param [String] member the name of the struct member we need
+  # @param [Symbol] type (:read) reader method, or writer method?
+  # @return [Boolean] should the attribute be created?
+  def create_member_method?(klass, member, type = :read)
+    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
+    !member_tag_for_member(klass, member, :read)
+  end
+
+  # Gets the return type for the member in a nicely formatted string. Used
+  # to be injected into auto-generated docstrings.
+  #
+  # @param [Tags::Tag] member_tag the tag object to check for types
+  # @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"
+  end
+
+  # Creates the auto-generated docstring for the getter method of a struct's
+  # member. This is used so the generated documentation will look just like that
+  # of an attribute defined using attr_accessor.
+  #
+  # @param [ClassObject] klass the class whose members we're working with
+  # @param [String] member the name of the member we're generating documentation for
+  # @return [String] a docstring to be attached to the getter method for this member
+  def add_reader_tags(klass, new_method, member)
+    member_tag = member_tag_for_member(klass, member, :read)
+    return_type = return_type_from_tag(member_tag)
+    getter_doc_text = member_tag ? member_tag.text : "Returns the value of attribute #{member}"
+    new_method.docstring.replace(getter_doc_text)
+    new_method.add_tag YARD::Tags::Tag.new(:return, "the current value of #{member}", return_type)
+  end
+
+  # Creates the auto-generated docstring for the setter method of a struct's
+  # member. This is used so the generated documentation will look just like that
+  # of an attribute defined using attr_accessor.
+  #
+  # @param [ClassObject] klass the class whose members we're working with
+  # @param [String] member the name of the member we're generating documentation for
+  # @return [String] a docstring to be attached to the setter method for this member
+  def add_writer_tags(klass, new_method, member)
+    member_tag = member_tag_for_member(klass, member, :write)
+    return_type = return_type_from_tag(member_tag)
+    setter_doc_text = member_tag ? member_tag.text : "Sets the attribute #{member}"
+    new_method.docstring.replace(setter_doc_text)
+    new_method.add_tag YARD::Tags::Tag.new(:param, "the value to set the attribute #{member} to.", return_type, "value")
+    new_method.add_tag YARD::Tags::Tag.new(:return, "the newly set value", return_type)
+  end
+
+  # Creates and registers a class object with the given name and superclass name.
+  # Returns it for further use.
+  #
+  # @param [String] classname the name of the class
+  # @param [String] superclass the name of the superclass
+  # @return [ClassObject] the class object for further processing/method attaching
+  def create_class(classname, superclass)
+    register ClassObject.new(namespace, classname) do |o|
+      o.superclass = superclass if superclass
+      o.superclass.type = :class if o.superclass.is_a?(Proxy)
+    end
+  end
+
+  # Creates the setter (writer) method and attaches it to the class as an attribute.
+  # Also sets up the docstring to prettify the documentation output.
+  #
+  # @param [ClassObject] klass the class to attach the method to
+  # @param [String] member the name of the member we're generating a method for
+  def create_writer(klass, member)
+    # We want to convert these members into attributes just like
+    # as if they were declared using attr_accessor.
+    new_meth = register MethodObject.new(klass, "#{member}=", :instance) do |o|
+      o.parameters = [['value', nil]]
+      o.signature ||= "def #{member}=(value)"
+      o.source ||= "#{o.signature}\n  @#{member} = value\nend"
+    end
+    add_writer_tags(klass, new_meth, member)
+    klass.attributes[:instance][member][:write] = new_meth
+  end
+
+  # Creates the getter (reader) method and attaches it to the class as an attribute.
+  # Also sets up the docstring to prettify the documentation output.
+  #
+  # @param [ClassObject] klass the class to attach the method to
+  # @param [String] member the name of the member we're generating a method for
+  def create_reader(klass, member)
+    new_meth = register MethodObject.new(klass, member, :instance) do |o|
+      o.signature ||= "def #{member}"
+      o.source ||= "#{o.signature}\n  @#{member}\nend"
+    end
+    add_reader_tags(klass, new_meth, member)
+    klass.attributes[:instance][member][:read] = new_meth
+  end
+
+  # Creates the given member methods and attaches them to the given ClassObject.
+  #
+  # @param [ClassObject] klass the class to generate attributes for
+  # @param [Array<String>] members a list of member names
+  def create_attributes(klass, members)
+    # For each parameter, add reader and writers
+    members.each do |member|
+      next if klass.attributes[:instance][member]
+      klass.attributes[:instance][member] = SymbolHash[:read => nil, :write => nil]
+      create_writer klass, member if create_member_method?(klass, member, :write)
+      create_reader klass, member if create_member_method?(klass, member, :read)
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# 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
+      globals.visibility_origin = :keyword
+    when :command
+      if RUBY_VERSION >= '3.' && is_attribute_method?(statement.parameters.first)
+        parse_block(statement.parameters.first, visibility: ident.first.to_sym)
+        return
+      end
+      process_decorator do |method|
+        method.visibility = ident.first if method.respond_to? :visibility=
+      end
+    when :fcall
+      process_decorator do |method|
+        method.visibility = ident.first if method.respond_to? :visibility=
+      end
+    end
+  end
+
+  def is_attribute_method?(node)
+    node.type == :command && node.jump(:ident).first.to_s =~ /^attr_(accessor|writer|reader)$/
+  end
+end

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

@@ -0,0 +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

data/yard-0.9.44/lib/yard/i18n/locale.rb

@@ -0,0 +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 https://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 translation isn't
+      #   registered, the +message+ is returned.
+      def translate(message)
+        @messages[message] || message
+      end
+    end
+  end
+end

data/yard-0.9.44/lib/yard/i18n/message.rb

@@ -0,0 +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 translation 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 translate 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/yard-0.9.44/lib/yard/i18n/messages.rb

@@ -0,0 +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 message 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

data/yard-0.9.44/lib/yard/i18n/po_parser.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module YARD
+  module I18n
+    # +Locale+ is a wrapper for gettext's PO parsing feature. It hides
+    # gettext API difference from YARD.
+    #
+    # @since 0.8.8
+    class POParser
+      if RUBY_VERSION < "1.9"
+        begin
+          require "gettext/tools/poparser"
+          require "gettext/runtime/mofile"
+          @@gettext_version = 2
+        rescue LoadError
+          log.warn "Need gettext gem 2.x for i18n feature:\n" \
+                   "\tgem install gettext -v 2.3.9"
+        end
+      else
+        begin
+          require "gettext/po_parser"
+          require "gettext/mo"
+          @@gettext_version = 3
+        rescue LoadError
+          begin
+            require "gettext/tools/poparser"
+            require "gettext/runtime/mofile"
+            @@gettext_version = 2
+          rescue LoadError
+            log.warn "Need gettext gem for i18n feature:\n" \
+                     "\tgem install gettext"
+          end
+        end
+      end
+
+      class << self
+        # @return [Boolean] true if gettext is available, false otherwise.
+        def available?
+          !@@gettext_version.nil?
+        end
+      end
+
+      # Parses PO file.
+      #
+      # @param [String] file path of PO file to be parsed.
+      # @return [Hash<String, String>] parsed messages.
+      def parse(file)
+        case @@gettext_version
+        when 2
+          parser = GetText::PoParser.new
+          data = GetText::MoFile.new
+        when 3
+          parser = GetText::POParser.new
+          data = GetText::MO.new
+        end
+        parser.report_warning = false
+        parser.parse_file(file, data)
+        data
+      end
+    end
+  end
+end