qiita_org 0.1.20 → 0.1.25

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

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+# Helper methods to assist with processing decorators.
+module YARD::Handlers::Ruby::DecoratorHandlerMethods
+  # @overload process_decorator(*nodes, opts = {}, &block)
+  #   Takes care of parsing method definitions passed to decorators
+  #   as parameters, as well as parsing chained decorators.
+  #
+  #   Use this in a handler's process block.
+  #
+  #   @yieldparam method [YARD::CodeObjects::MethodObject] Method being decorated.
+  #   @yieldparam node [YARD::Parser::Ruby::AstNode] AST node of the decorated method.
+  #   @yieldparam name [Symbol] Name of the decorated method.
+  #   @return [Array<Hash>] Array of hashes containing :method, :node, :name.
+  #     See yield params.
+  #
+  #   @param nodes [YARD::Parser::Ruby::AstNode] AST nodes that refer to decorated
+  #     methods, like indexes of statement.parameter. Defaults to all parameters.
+  #     Pass nil to specify zero parameters.
+  #
+  #   @option opts [:instance, :class] :scope (:instance) Scope to use for each
+  #     MethodObject.
+  #
+  #   @option opts [true, false] :transfer_docstring Set false to disable
+  #     transferring the decorator docstring to method definitions passed to the
+  #     decorator as parameters.
+  #
+  #   @option opts [true, false] :transfer_source Set false to disable
+  #     transferring the decorator source code string to method definitions
+  #     passed to the decorator as parameters.
+  #
+  #   @example Basic Usage
+  #     # Simply pass the method docs through to the method definition.
+  #     process do
+  #       process_decorator
+  #     end
+  #
+  #   @example Setting a method's visibility to private.
+  #     process do
+  #       process_decorator :scope => :class do |method|
+  #         method.visibility = :private if method.respond_to? :visibility
+  #       end
+  #     end
+  def process_decorator(*nodes, &block)
+    opts = nodes.last.is_a?(Hash) ? nodes.pop : {}
+
+    all_nodes = statement.parameters.select do |p|
+      p.is_a? YARD::Parser::Ruby::AstNode
+    end
+
+    # Parse decorator parameters (decorator chain).
+    all_nodes.each do |param|
+      parse_block param if param.call? || param.def?
+    end
+
+    selected_nodes =
+      if nodes.empty?
+        all_nodes
+      elsif nodes.count == 1 && nodes.first.nil?
+        []
+      else
+        nodes
+      end
+
+    decorated_methods = selected_nodes.map do |param|
+      process_decorator_parameter param, opts, &block
+    end.flatten
+
+    # Store method nodes in decorator node.
+    statement.define_singleton_method :decorators do
+      decorated_methods.map {|h| h[:node] }
+    end
+
+    decorated_methods
+  end
+
+  private
+
+  def process_decorator_parameter(node, opts = {}, &block)
+    scope              = opts.fetch :scope, :instance
+    transfer_docstring = opts.fetch :transfer_docstring, true
+    transfer_source    = opts.fetch :transfer_source, true
+
+    name = nil
+
+    if node.call?
+      if node.respond_to? :decorators
+        return node.decorators.map do |n|
+          process_decorator_parameter n, opts, &block
+        end
+      end
+    elsif node.def?
+      name = node.jump(:def).method_name.source
+    else
+      name = node.jump(:ident, :string_content, :const).source
+    end
+
+    if name.nil?
+      raise YARD::Parser::UndocumentableError, 'statement, cannot determine method name'
+    end
+
+    method = YARD::CodeObjects::Proxy.new(
+      namespace,
+      (scope == :instance ? '#' : '.') + name.to_s,
+      :method
+    )
+
+    # Transfer source to methods passed to the helper as parameters.
+    method.source = statement.source if transfer_source && node.def?
+
+    # Transfer decorator docstring to methods passed to the helper as parameters.
+    if transfer_docstring && node.def? &&
+       statement.docstring && method.docstring.empty?
+      tags = method.tags if method.respond_to? :tags
+      tags ||= []
+      method.docstring = statement.docstring
+      tags.each {|t| method.add_tag t }
+    end
+
+    yield method, node, name.to_sym if block_given?
+
+    [{:method => method, :node => node, :name => name.to_sym}]
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module YARD
+  module Handlers
+    module Ruby
+      # Handles automatic detection of dsl-style methods
+      class DSLHandler < Base
+        include CodeObjects
+        include DSLHandlerMethods
+        handles method_call
+        namespace_only
+        process { handle_comments }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+module YARD
+  module Handlers
+    module Ruby
+      module DSLHandlerMethods
+        include CodeObjects
+        include Parser
+
+        IGNORE_METHODS = Hash[*%w(alias alias_method autoload attr attr_accessor
+          attr_reader attr_writer extend include module_function public private
+          protected private_constant private_class_method public_class_method).
+          map {|n| [n, true] }.flatten]
+
+        def handle_comments
+          return if IGNORE_METHODS[caller_method]
+
+          @docstring = statement.comments || ""
+          @docstring = @docstring.join("\n") if @docstring.is_a?(Array)
+
+          attaching = false
+          if @docstring =~ /^@!?macro\s+\[[^\]]*attach/
+            register_docstring(nil)
+            @docstring = ""
+            attaching = true
+          end
+
+          macro = find_attached_macro
+          if macro
+            txt = macro.expand([caller_method, *call_params], statement.source)
+            @docstring += "\n" + txt
+
+            # macro may have a directive
+            return register_docstring(nil) if !attaching && txt.match(/^\s*@!/)
+          elsif !statement.comments_hash_flag && !implicit_docstring?
+            return register_docstring(nil)
+          end
+
+          # ignore DSL definitions if @method/@attribute directive is used
+          if @docstring =~ /^@!?(method|attribute)\b/
+            return register_docstring(nil)
+          end
+
+          register MethodObject.new(namespace, method_name, scope) do |o|
+            o.signature = method_signature
+          end
+        end
+
+        def register_docstring(object, docstring = @docstring, stmt = statement)
+          super
+        end
+
+        private
+
+        def implicit_docstring?
+          tags = %w(method attribute overload visibility scope return)
+          tags.any? {|tag| @docstring =~ /^@!?#{tag}\b/ }
+        end
+
+        def method_name
+          name = call_params.first || ""
+          if name =~ /^#{CodeObjects::METHODNAMEMATCH}$/
+            name
+          else
+            raise UndocumentableError, "method, missing name"
+          end
+        end
+
+        def method_signature
+          "def #{method_name}"
+        end
+
+        def find_attached_macro
+          Registry.all(:macro).each do |macro|
+            next unless macro.method_object
+            next unless macro_name_matches(macro)
+            (namespace.inheritance_tree(true) + [P('Object')]).each do |obj|
+              return macro if obj == macro.method_object.namespace
+            end
+          end
+          nil
+        end
+
+        # @return [Boolean] whether caller method matches a macro or
+        #   its alias names.
+        def macro_name_matches(macro)
+          objs = [macro.method_object]
+          if objs.first.type != :proxy && objs.first.respond_to?(:aliases)
+            objs.concat(objs.first.aliases)
+          end
+
+          objs.any? {|obj| obj.name.to_s == caller_method.to_s }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# Handles 'raise' calls inside methods
+class YARD::Handlers::Ruby::ExceptionHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:raise)
+
+  process do
+    return unless owner.is_a?(MethodObject) # Only methods yield
+    return if [:command_call, :call].include? statement.type
+    return if owner.has_tag?(:raise)
+
+    klass = nil
+    if statement.call?
+      params = statement.parameters(false)
+      if params.size == 1
+        if params.first.ref? && params.first.first.type != :ident
+          klass = params.first.source
+        elsif params.first.call? && params.first.method_name(true) == :new
+          klass = params.first.namespace.source
+        end
+      elsif params.size > 1
+        klass = params.first.source
+      end
+    end
+
+    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/extend_handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# Handles 'extend' call to include modules into the class scope of another
+# @see MixinHandler
+class YARD::Handlers::Ruby::ExtendHandler < YARD::Handlers::Ruby::MixinHandler
+  handles method_call(:extend)
+  namespace_only
+
+  def scope; :class end
+
+  private
+
+  def process_mixin(mixin)
+    if mixin == s(:var_ref, s(:kw, "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/alias_handler.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# (see Ruby::AliasHandler)
+class YARD::Handlers::Ruby::Legacy::AliasHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\Aalias(_method)?(\s|\()/)
+  namespace_only
+
+  process do
+    if TkALIAS === statement.tokens.first
+      tokens = statement.tokens[2..-1].to_s.split(/\s+/)
+      names = [tokens[0], tokens[1]].map {|t| t.gsub(/^:(['"])?(.+?)\1?$|^(:)(.+)/, '\2') }
+    else
+      names = tokval_list(statement.tokens[2..-1], :attr)
+    end
+    raise YARD::Parser::UndocumentableError, statement.tokens.first.text if names.size != 2
+
+    names = names.map {|n| Symbol === n ? n.to_s.delete('"') : n }
+    new_meth = names[0].to_sym
+    old_meth = names[1].to_sym
+    old_obj = namespace.child(:name => old_meth, :scope => scope)
+    new_obj = register MethodObject.new(namespace, new_meth, scope) do |o|
+      o.add_file(parser.file, statement.tokens.first.line_no, statement.comments)
+    end
+
+    if old_obj
+      new_obj.signature = old_obj.signature
+      new_obj.source = old_obj.source
+      new_obj.docstring = old_obj.docstring + YARD::Docstring.new(statement.comments)
+      new_obj.docstring.line_range = statement.comments_range
+      new_obj.docstring.hash_flag = statement.comments_hash_flag
+      new_obj.docstring.object = new_obj
+    else
+      new_obj.signature = "def #{new_meth}" # this is all we know.
+    end
+
+    namespace.aliases[new_obj] = old_meth
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+# (see Ruby::AttributeHandler)
+class YARD::Handlers::Ruby::Legacy::AttributeHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles(/\Aattr(?:_(?:reader|writer|accessor))?(?:\s|\()/)
+  namespace_only
+
+  process do
+    begin
+      attr_type   = statement.tokens.first.text.to_sym
+      symbols     = tokval_list statement.tokens[2..-1], :attr, TkTRUE, TkFALSE
+      read = true
+      write = false
+    rescue SyntaxError
+      raise YARD::Parser::UndocumentableError, attr_type
+    end
+
+    # Change read/write based on attr_reader/writer/accessor
+    case attr_type
+    when :attr
+      # In the case of 'attr', the second parameter (if given) isn't a symbol.
+      write = symbols.pop if symbols.size == 2
+    when :attr_accessor
+      write = true
+    when :attr_reader
+      # change nothing
+    when :attr_writer
+      read = false
+      write = true
+    end
+
+    # Add all attributes
+    symbols.each do |name|
+      namespace.attributes[scope][name] = SymbolHash[:read => nil, :write => nil]
+
+      # Show their methods as well
+      {:read => name, :write => "#{name}="}.each do |type, meth|
+        if type == :read ? read : write
+          o = MethodObject.new(namespace, meth, scope)
+          if type == :write
+            o.parameters = [['value', nil]]
+            src = "def #{meth}(value)"
+            full_src = "#{src}\n  @#{name} = value\nend"
+            doc = "Sets the attribute #{name}\n@param value the value to set the attribute #{name} to."
+          else
+            src = "def #{meth}"
+            full_src = "#{src}\n  @#{name}\nend"
+            doc = "Returns the value of attribute #{name}"
+          end
+          o.source ||= full_src
+          o.signature ||= src
+          register(o)
+          o.docstring = doc if o.docstring.blank?(false)
+
+          # Regsiter the object explicitly
+          namespace.attributes[scope][name][type] = o
+        else
+          obj = namespace.children.find {|other| other.name == meth.to_sym && other.scope == scope }
+
+          # register an existing method as attribute
+          namespace.attributes[scope][name][type] = obj if obj
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+module YARD
+  module Handlers
+    module Ruby::Legacy
+      # This is the base handler for the legacy parser. To implement a legacy
+      # handler, subclass this class.
+      #
+      # @abstract (see Ruby::Base)
+      class Base < Handlers::Base
+        # For tokens like TkDEF, TkCLASS, etc.
+        include YARD::Parser::Ruby::Legacy::RubyToken
+
+        # @return [Boolean] whether or not a {Parser::Ruby::Legacy::Statement} object should be handled
+        #   by this handler.
+        def self.handles?(stmt)
+          handlers.any? do |a_handler|
+            case a_handler
+            when String
+              stmt.tokens.first.text == a_handler
+            when Regexp
+              stmt.tokens.to_s =~ a_handler
+            else
+              a_handler == stmt.tokens.first.class
+            end
+          end
+        end
+
+        # Parses a statement's block with a set of state values. If the
+        # statement has no block, nothing happens. A description of state
+        # values can be found at {Handlers::Base#push_state}
+        #
+        # @param [Hash] opts State options
+        # @option opts (see Handlers::Base#push_state)
+        # @see Handlers::Base#push_state #push_state
+        def parse_block(opts = {})
+          push_state(opts) do
+            if statement.block
+              blk = Parser::Ruby::Legacy::StatementList.new(statement.block)
+              parser.process(blk)
+            end
+          end
+        end
+
+        def call_params
+          if statement.tokens.first.is_a?(TkDEF)
+            extract_method_details.last.map(&:first)
+          else
+            tokens = statement.tokens[1..-1]
+            tokval_list(tokens, :attr, :identifier, TkId).map(&:to_s)
+          end
+        end
+
+        def caller_method
+          if statement.tokens.first.is_a?(TkIDENTIFIER)
+            statement.tokens.first.text
+          elsif statement.tokens.first.is_a?(TkDEF)
+            extract_method_details.first
+          end
+        end
+
+        private
+
+        # Extracts method information for macro expansion only
+        #
+        # @todo This is a duplicate implementation of {MethodHandler}. Refactor.
+        # @return [Array<String,Array<Array<String>>>] the method name followed by method
+        #   arguments (name and optional value)
+        def extract_method_details
+          if statement.tokens.to_s =~ /^def\s+(#{METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
+            meth = $1
+            args = $2
+            meth.gsub!(/\s+/, '')
+            args = tokval_list(Parser::Ruby::Legacy::TokenList.new(args), :all)
+            args.map! {|a| k, v = *a.split('=', 2); [k.strip, (v ? v.strip : nil)] } if args
+            meth = $` if meth =~ /(?:#{NSEPQ}|#{CSEPQ})([^#{NSEP}#{CSEPQ}]+)$/
+            [meth, args]
+          end
+        end
+
+        # The string value of a token. For example, the return value for the symbol :sym
+        # would be :sym. The return value for a string +"foo #{ bar}"+ would be the literal
+        # +"foo #{ bar}"+ without any interpolation. The return value of the identifier
+        # 'test' would be the same value: 'test'. Here is a list of common types and
+        # their return values:
+        #
+        # @example
+        #   tokval(TokenList.new('"foo"').first) => "foo"
+        #   tokval(TokenList.new(':foo').first) => :foo
+        #   tokval(TokenList.new('CONSTANT').first, RubyToken::TkId) => "CONSTANT"
+        #   tokval(TokenList.new('identifier').first, RubyToken::TkId) => "identifier"
+        #   tokval(TokenList.new('3.25').first) => 3.25
+        #   tokval(TokenList.new('/xyz/i').first) => /xyz/i
+        #
+        # @param [Token] token The token of the class
+        #
+        # @param [Array<Class<Token>>, Symbol] accepted_types
+        #   The allowed token types that this token can be. Defaults to [{TkVal}].
+        #   A list of types would be, for example, [+TkSTRING+, +TkSYMBOL+], to return
+        #   the token's value if it is either of those types. If +TkVal+ is accepted,
+        #   +TkNode+ is also accepted.
+        #
+        #   Certain symbol keys are allowed to specify multiple types in one fell swoop.
+        #   These symbols are:
+        #     :string       => +TkSTRING+, +TkDSTRING+, +TkDXSTRING+ and +TkXSTRING+
+        #     :attr         => +TkSYMBOL+ and +TkSTRING+
+        #     :identifier   => +TkIDENTIFIER, +TkFID+ and +TkGVAR+.
+        #     :number       => +TkFLOAT+, +TkINTEGER+
+        #
+        # @return [Object] if the token is one of the accepted types, in its real value form.
+        #   It should be noted that identifiers and constants are kept in String form.
+        # @return [nil] if the token is not any of the specified accepted types
+        def tokval(token, *accepted_types)
+          accepted_types = [TkVal] if accepted_types.empty?
+          accepted_types.push(TkNode) if accepted_types.include? TkVal
+
+          if accepted_types.include?(:attr)
+            accepted_types.push(TkSTRING, TkSYMBOL)
+          end
+
+          if accepted_types.include?(:string)
+            accepted_types.push(TkSTRING, TkDSTRING, TkXSTRING, TkDXSTRING)
+          end
+
+          if accepted_types.include?(:identifier)
+            accepted_types.push(TkIDENTIFIER, TkFID, TkGVAR)
+          end
+
+          if accepted_types.include?(:number)
+            accepted_types.push(TkFLOAT, TkINTEGER)
+          end
+
+          return unless accepted_types.any? {|t| t === token }
+
+          case token
+          when TkSTRING, TkDSTRING, TkXSTRING, TkDXSTRING
+            token.text[1..-2]
+          when TkSYMBOL
+            token.text[1..-1].to_sym
+          when TkFLOAT
+            token.text.to_f
+          when TkINTEGER
+            token.text.to_i
+          when TkREGEXP
+            token.text =~ %r{\A/(.+)/([^/])\Z}
+            Regexp.new($1, $2)
+          when TkTRUE
+            true
+          when TkFALSE
+            false
+          when TkNIL
+            nil
+          else
+            token.text
+          end
+        end
+
+        # Returns a list of symbols or string values from a statement.
+        # The list must be a valid comma delimited list, and values
+        # will only be returned to the end of the list only.
+        #
+        # Example:
+        #   attr_accessor :a, 'b', :c, :d => ['a', 'b', 'c', 'd']
+        #   attr_accessor 'a', UNACCEPTED_TYPE, 'c' => ['a', 'c']
+        #
+        # The tokval list of a {Parser::Ruby::Legacy::TokenList} of the above
+        # code would be the {#tokval} value of :a, 'b',
+        # :c and :d.
+        #
+        # It should also be noted that this function stops immediately at
+        # any ruby keyword encountered:
+        #   "attr_accessor :a, :b, :c if x == 5"  => ['a', 'b', 'c']
+        #
+        # @param [TokenList] tokenlist The list of tokens to process.
+        # @param [Array<Class<Token>>] accepted_types passed to {#tokval}
+        # @return [Array<String>] the list of tokvalues in the list.
+        # @return [Array<EMPTY>] if there are no symbols or Strings in the list
+        # @see #tokval
+        def tokval_list(tokenlist, *accepted_types)
+          return [] unless tokenlist
+          out = [[]]
+          parencount = 0
+          beforeparen = 0
+          needcomma = false
+          seen_comma = true
+          tokenlist.each do |token|
+            tokval = accepted_types == [:all] ? token.text : tokval(token, *accepted_types)
+            parencond = !out.last.empty? && !tokval.nil?
+            # puts "#{seen_comma.inspect} #{parencount} #{token.class.class_name} #{out.inspect}"
+            case token
+            when TkCOMMA
+              if parencount == 0
+                out << [] unless out.last.empty?
+                needcomma = false
+                seen_comma = true
+              elsif parencond
+                out.last << token.text
+              end
+            when TkLPAREN
+              if seen_comma
+                beforeparen += 1
+              else
+                parencount += 1
+                out.last << token.text if parencond
+              end
+            when TkRPAREN
+              if beforeparen > 0
+                beforeparen -= 1
+              else
+                out.last << token.text if parencount > 0 && !tokval.nil?
+                parencount -= 1
+              end
+            when TkLBRACE, TkLBRACK, TkDO
+              parencount += 1
+              out.last << token.text unless tokval.nil?
+            when TkRBRACE, TkRBRACK, TkEND
+              out.last << token.text unless tokval.nil?
+              parencount -= 1
+            else
+              break if TkKW === token && ![TkTRUE, TkFALSE, TkSUPER, TkSELF, TkNIL].include?(token.class)
+
+              seen_comma = false unless TkWhitespace === token
+              if parencount == 0
+                next if needcomma
+                next if TkWhitespace === token
+                if !tokval.nil?
+                  out.last << tokval
+                else
+                  out.last.clear
+                  needcomma = true
+                end
+              elsif parencond
+                needcomma = true
+                out.last << token.text
+              end
+            end
+
+            break if beforeparen == 0 && parencount < 0
+          end
+          # Flatten any single element lists
+          out.map {|e| e.empty? ? nil : (e.size == 1 ? e.pop : e.flatten.join) }.compact
+        end
+      end
+    end
+  end
+end