qiita_org 0.1.20 → 0.1.25

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_condition_handler.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+# (see Ruby::ClassConditionHandler)
+# @since 0.5.4
+class YARD::Handlers::Ruby::Legacy::ClassConditionHandler < YARD::Handlers::Ruby::Legacy::Base
+  namespace_only
+  handles TkIF, TkELSIF, TkUNLESS
+
+  process do
+    condition = parse_condition
+    if condition.nil?
+      # Parse both blocks if we're unsure of the condition
+      parse_then_block
+      parse_else_block
+    elsif condition
+      parse_then_block
+    else
+      parse_else_block
+    end
+  end
+
+  protected
+
+  # Parses the condition part of the if/unless statement
+  #
+  # @return [true, false, nil] true if the condition can be definitely
+  #   parsed to true, false if not, and nil if the condition cannot be
+  #   parsed with certainty (it's dynamic)
+  # @since 0.5.5
+  def parse_condition
+    condition = nil
+
+    # Right now we can handle very simple unary conditions like:
+    #   if true
+    #   if false
+    #   if 0
+    #   if 100 (not 0)
+    #   if defined? SOME_CONSTANT
+    #
+    # The last case will do a lookup in the registry and then one
+    # in the Ruby world (using eval).
+    case statement.tokens[1..-1].to_s.strip
+    when /^(\d+)$/
+      condition = $1 != "0"
+    when /^defined\?\s*\(?\s*([A-Za-z0-9:_]+?)\s*\)?$/
+      # defined? keyword used, let's see if we can look up the name
+      # in the registry, then we'll try using Ruby's powers. eval() is not
+      # *too* dangerous here since code is not actually executed.
+      name = $1
+      obj = YARD::Registry.resolve(namespace, name, true)
+      begin
+        condition = true if obj || Object.instance_eval("defined? #{name}")
+      rescue SyntaxError, NameError
+        condition = false
+      end
+    when "true"
+      condition = true
+    when "false"
+      condition = false
+    end
+
+    if TkUNLESS === statement.tokens.first
+      condition = !condition unless condition.nil?
+    end
+    condition
+  end
+
+  # @since 0.5.5
+  def parse_then_block
+    parse_block(:visibility => visibility)
+  end
+
+  # @since 0.5.5
+  def parse_else_block
+    return unless statement.block
+    stmtlist = YARD::Parser::Ruby::Legacy::StatementList
+    stmtlist.new(statement.block).each do |stmt|
+      next unless TkELSE === stmt.tokens.first
+      push_state(:visibility => visibility) do
+        parser.process(stmtlist.new(stmt.block))
+      end
+    end
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_handler.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+# (see Ruby::ClassHandler)
+class YARD::Handlers::Ruby::Legacy::ClassHandler < YARD::Handlers::Ruby::Legacy::Base
+  include YARD::Handlers::Ruby::StructHandlerMethods
+  handles TkCLASS
+  namespace_only
+
+  process do
+    if statement.tokens.to_s =~ /^class\s+(#{NAMESPACEMATCH})\s*(?:<\s*(.+)|\Z)/m
+      classname = $1
+      superclass_def = $2
+      superclass = parse_superclass($2)
+      classname = classname.gsub(/\s/, '')
+      if superclass == "Struct"
+        is_a_struct = true
+        superclass = struct_superclass_name(superclass_def)
+        create_struct_superclass(superclass, superclass_def)
+      end
+      undocsuper = superclass_def && superclass.nil?
+
+      klass = register ClassObject.new(namespace, classname) do |o|
+        o.superclass = superclass if superclass
+        o.superclass.type = :class if o.superclass.is_a?(Proxy)
+      end
+      if is_a_struct
+        parse_struct_subclass(klass, superclass_def)
+      elsif klass
+        create_attributes(klass, members_from_tags(klass))
+      end
+      parse_block(:namespace => klass)
+
+      if undocsuper
+        raise YARD::Parser::UndocumentableError, 'superclass (class was added without superclass)'
+      end
+    elsif statement.tokens.to_s =~ /^class\s*<<\s*([\w\:\s]+)/
+      classname = $1.gsub(/\s/, '')
+      proxy = Proxy.new(namespace, classname)
+
+      # Allow constants to reference class names
+      if ConstantObject === proxy
+        if proxy.value =~ /\A#{NAMESPACEMATCH}\Z/
+          proxy = Proxy.new(namespace, proxy.value)
+        else
+          raise YARD::Parser::UndocumentableError, "constant class reference '#{classname}'"
+        end
+      end
+
+      if classname == "self"
+        parse_block(:namespace => namespace, :scope => :class)
+      elsif classname[0, 1] =~ /[A-Z]/
+        register ClassObject.new(namespace, classname) if Proxy === proxy
+        parse_block(:namespace => proxy, :scope => :class)
+      else
+        raise YARD::Parser::UndocumentableError, "class '#{classname}'"
+      end
+    else
+      raise YARD::Parser::UndocumentableError, "class: #{statement.tokens}"
+    end
+  end
+
+  private
+
+  # Extracts the parameter list from the Struct.new declaration and returns it
+  # formatted as a list of member names. Expects the user will have used symbols
+  # to define the struct member names
+  #
+  # @param [String] superstring the string declaring the superclass
+  # @return [Array<String>] a list of member names
+  def extract_parameters(superstring)
+    paramstring = superstring.match(/\A(O?Struct)\.new\((.*?)\)/)[2]
+    paramstring.split(",").select {|x| x.strip[0, 1] == ":" }.map {|x| x.strip[1..-1] } # the 1..-1 chops the leading :
+  end
+
+  def create_struct_superclass(superclass, superclass_def)
+    return if superclass == "Struct"
+    the_super = register ClassObject.new(P("Struct"), superclass[8..-1]) do |o|
+      o.superclass = "Struct"
+    end
+    parse_struct_subclass(the_super, superclass_def)
+    the_super
+  end
+
+  def struct_superclass_name(superclass)
+    match = superclass.match(/\A(Struct)\.new\((.*?)\)/)
+    if match
+      paramstring = match[2].split(",")
+      first = paramstring.first.strip
+      if first[0, 1] =~ /['"]/ && first[-1, 1] =~ /['"]/ && first !~ /\#\{/
+        return "Struct::#{first[1..-2]}"
+      end
+    end
+    "Struct"
+  end
+
+  def parse_struct_subclass(klass, superclass_def)
+    # Bounce if there's no parens
+    return unless superclass_def =~ /O?Struct\.new\((.*?)\)/
+    members = extract_parameters(superclass_def)
+    create_attributes(klass, members)
+  end
+
+  def parse_superclass(superclass)
+    case superclass
+    when /\A(#{NAMESPACEMATCH})(?:\s|\Z)/,
+         /\A(Struct|OStruct)\.new/,
+         /\ADelegateClass\((.+?)\)\s*\Z/,
+         /\A(#{NAMESPACEMATCH})\(/
+      $1
+    when "self"
+      namespace.path
+    end
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/class_variable_handler.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# (see Ruby::ClassVariableHandler)
+class YARD::Handlers::Ruby::Legacy::ClassVariableHandler < YARD::Handlers::Ruby::Legacy::Base
+  HANDLER_MATCH = /\A@@\w+\s*=\s*/m
+  handles HANDLER_MATCH
+  namespace_only
+
+  process do
+    name, value = *statement.tokens.to_s.split(/\s*=\s*/, 2)
+    register ClassVariableObject.new(namespace, name) do |o|
+      o.source = statement
+      o.value = value.strip
+    end
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/comment_handler.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+# (see Ruby::CommentHandler)
+class YARD::Handlers::Ruby::Legacy::CommentHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles TkCOMMENT
+  namespace_only
+
+  process do
+    register_docstring(nil)
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/constant_handler.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# (see Ruby::ConstantHandler)
+class YARD::Handlers::Ruby::Legacy::ConstantHandler < YARD::Handlers::Ruby::Legacy::Base
+  include YARD::Handlers::Ruby::StructHandlerMethods
+  HANDLER_MATCH = /\A[A-Z]\w*\s*=[^=]\s*/m
+  handles HANDLER_MATCH
+  namespace_only
+
+  process do
+    name, value = *statement.tokens.to_s.split(/\s*=\s*/, 2)
+    if value =~ /\A\s*Struct.new(?:\s*\(?|\b)/
+      process_structclass(name, $')
+    else
+      register ConstantObject.new(namespace, name) {|o| o.source = statement; o.value = value.strip }
+    end
+  end
+
+  private
+
+  def process_structclass(classname, parameters)
+    klass = create_class(classname, P(:Struct))
+    create_attributes(klass, extract_parameters(parameters))
+  end
+
+  def extract_parameters(parameters)
+    members = tokval_list(YARD::Parser::Ruby::Legacy::TokenList.new(parameters), TkSYMBOL)
+    members.map(&:to_s)
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/dsl_handler.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        # (see Ruby::DSLHandler)
+        class DSLHandler < Base
+          include CodeObjects
+          include DSLHandlerMethods
+          handles TkIDENTIFIER
+          namespace_only
+          process { handle_comments }
+        end
+      end
+    end
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/exception_handler.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# (see Ruby::ExceptionHandler)
+class YARD::Handlers::Ruby::Legacy::ExceptionHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\Araise(\s|\(|\Z)/)
+
+  process do
+    return unless owner.is_a?(MethodObject) # Only methods yield
+    return if owner.has_tag?(:raise)
+
+    klass = statement.tokens.to_s[/^raise[\(\s]*(#{NAMESPACEMATCH})\s*(?:\)|,|\s(?:if|unless|until)|;|(?:(?:\.|\:\:)\s*)?new|$)/, 1]
+    owner.add_tag YARD::Tags::Tag.new(:raise, '', klass) if klass
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/extend_handler.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# (see Ruby::ExtendHandler)
+class YARD::Handlers::Ruby::Legacy::ExtendHandler < YARD::Handlers::Ruby::Legacy::MixinHandler
+  handles(/\Aextend(\s|\()/)
+  namespace_only
+
+  def scope; :class end
+
+  private
+
+  def process_mixin(mixin)
+    if mixin == "self"
+      if namespace.is_a?(ClassObject)
+        raise UndocumentableError, "extend(self) statement on class"
+      end
+      namespace.mixins(scope) << namespace
+    else
+      super
+    end
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/method_handler.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+# (see Ruby::MethodHandler)
+class YARD::Handlers::Ruby::Legacy::MethodHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles TkDEF
+
+  process do
+    nobj = namespace
+    mscope = scope
+
+    if statement.tokens.to_s =~ /^def\s+(#{METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
+      meth = $1
+      args = $2
+      meth.gsub!(/\s+/, '')
+      args = tokval_list(YARD::Parser::Ruby::Legacy::TokenList.new(args), :all)
+      args.map! do |a|
+        k, v, r = *a.split(/(:)|=/, 2)
+        if r
+          k += v
+          v = r
+        end
+        [k.strip, (v ? v.strip : nil)]
+      end if args
+    else
+      raise YARD::Parser::UndocumentableError, "method: invalid name"
+    end
+
+    # Class method if prefixed by self(::|.) or Module(::|.)
+    if meth =~ /(?:#{NSEPQ}|#{CSEPQ})([^#{NSEP}#{CSEPQ}]+)$/
+      mscope = :class
+      meth = $1
+      prefix = $`
+      if prefix =~ /^[a-z]/ && prefix != "self"
+        raise YARD::Parser::UndocumentableError, 'method defined on object instance'
+      end
+      nobj = P(namespace, prefix) unless prefix == "self"
+    end
+
+    nobj = P(namespace, nobj.value) while nobj.type == :constant
+    obj = register MethodObject.new(nobj, meth, mscope) do |o|
+      o.explicit = true
+      o.parameters = args
+    end
+
+    # delete any aliases referencing old method
+    nobj.aliases.each do |aobj, name|
+      next unless name == obj.name
+      nobj.aliases.delete(aobj)
+    end if nobj.is_a?(NamespaceObject)
+
+    if mscope == :instance && meth == "initialize"
+      unless obj.has_tag?(:return)
+        obj.add_tag(YARD::Tags::Tag.new(:return,
+          "a new instance of #{namespace.name}", namespace.name.to_s))
+      end
+    elsif mscope == :class && obj.docstring.blank? && %w(inherited included
+        extended method_added method_removed method_undefined).include?(meth)
+      obj.add_tag(YARD::Tags::Tag.new(:private, nil))
+    elsif meth.to_s =~ /\?$/
+      if obj.tag(:return) && (obj.tag(:return).types || []).empty?
+        obj.tag(:return).types = ['Boolean']
+      elsif obj.tag(:return).nil?
+        unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
+          obj.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
+        end
+      end
+    end
+
+    if obj.has_tag?(:option)
+      # create the options parameter if its missing
+      obj.tags(:option).each do |option|
+        expected_param = option.name
+        unless obj.tags(:param).find {|x| x.name == expected_param }
+          new_tag = YARD::Tags::Tag.new(:param, "a customizable set of options", "Hash", expected_param)
+          obj.add_tag(new_tag)
+        end
+      end
+    end
+
+    info = obj.attr_info
+    if info
+      if meth.to_s =~ /=$/ # writer
+        info[:write] = obj if info[:read]
+      elsif info[:write]
+        info[:read] = obj
+      end
+    end
+
+    parse_block(:owner => obj) # mainly for yield/exceptions
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/mixin_handler.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+# (see Ruby::MixinHandler)
+class YARD::Handlers::Ruby::Legacy::MixinHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\Ainclude(\s|\()/)
+  namespace_only
+
+  process do
+    errors = []
+    statement.tokens[1..-1].to_s.split(/\s*,\s*/).reverse.each do |mixin|
+      mixin = mixin.strip
+      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
+
+  private
+
+  def process_mixin(mixin)
+    mixmatch = mixin[/\A(#{NAMESPACEMATCH})/, 1]
+    raise YARD::Parser::UndocumentableError unless mixmatch
+
+    case obj = Proxy.new(namespace, mixmatch)
+    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, mixmatch, :module)
+    end
+
+    namespace.mixins(scope).unshift(obj) unless namespace.mixins(scope).include?(obj)
+  end
+end

data/gems/ruby/2.7.0/gems/yard-0.9.25/lib/yard/handlers/ruby/legacy/module_function_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# (see Ruby::ModuleFunctionHandler)
+class YARD::Handlers::Ruby::Legacy::ModuleFunctionHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\A(module_function)(\s|\(|$)/)
+  namespace_only
+
+  process do
+    if statement.tokens.size == 1
+      self.scope = :module
+    else
+      tokval_list(statement.tokens[2..-1], :attr).each do |name|
+        instance_method = MethodObject.new(namespace, name)
+        class_method = MethodObject.new(namespace, name, :module)
+        instance_method.copy_to(class_method)
+        class_method.visibility = :public
+      end
+    end
+  end
+end