kinetic_sdk 5.0.18 → 5.0.20

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+# Handles class declarations
+class YARD::Handlers::Ruby::ClassHandler < YARD::Handlers::Ruby::Base
+  include YARD::Handlers::Ruby::StructHandlerMethods
+  handles :class, :sclass
+  namespace_only
+
+  process do
+    classname = statement[0].source.gsub(/\s/, '')
+    if statement.type == :class
+      superclass = parse_superclass(statement[1])
+      if superclass == "Struct"
+        is_a_struct = true
+        superclass = struct_superclass_name(statement[1]) # refine the superclass if possible
+        create_struct_superclass(superclass, statement[1])
+      end
+      undocsuper = statement[1] && 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_superclass(klass, statement[1])
+      elsif klass
+        create_attributes(klass, members_from_tags(klass))
+      end
+      parse_block(statement[2], :namespace => klass)
+
+      if undocsuper
+        raise YARD::Parser::UndocumentableError, 'superclass (class was added without superclass)'
+      end
+    elsif statement.type == :sclass
+      if statement[0] == s(:var_ref, s(:kw, "self"))
+        parse_block(statement[1], :namespace => namespace, :scope => :class)
+      else
+        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[0, 1] =~ /[A-Z]/
+          register ClassObject.new(namespace, classname) if Proxy === proxy
+          parse_block(statement[1], :namespace => proxy, :scope => :class)
+        else
+          raise YARD::Parser::UndocumentableError, "class '#{classname}'"
+        end
+      end
+    else
+      sig_end = (statement[1] ? statement[1].source_end : statement[0].source_end) - statement.source_start
+      raise YARD::Parser::UndocumentableError, "class: #{statement.source[0..sig_end]}"
+    end
+  end
+
+  private
+
+  # Extract the parameters from the Struct.new AST node, returning them as a list
+  # of strings
+  #
+  # @param [MethodCallNode] superclass the AST node for the Struct.new call
+  # @return [Array<String>] the member names to generate methods for
+  def extract_parameters(superclass)
+    members = superclass.parameters.select {|x| x && x.type == :symbol_literal }
+    members.map! {|x| x.source.strip[1..-1] }
+    members
+  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_superclass(the_super, superclass_def)
+    the_super
+  end
+
+  def struct_superclass_name(superclass)
+    if superclass.call?
+      first = superclass.parameters.first
+      if first.type == :string_literal && first[0].type == :string_content && first[0].size == 1
+        return "Struct::#{first[0][0][0]}"
+      end
+    end
+    "Struct"
+  end
+
+  def parse_struct_superclass(klass, superclass)
+    return unless superclass.call? && superclass.parameters
+    members = extract_parameters(superclass)
+    create_attributes(klass, members)
+  end
+
+  def parse_superclass(superclass)
+    return nil unless superclass
+
+    case superclass.type
+    when :var_ref
+      return namespace.path if superclass.first == s(:kw, "self")
+      return superclass.source if superclass.first.type == :const
+    when :const, :const_ref, :const_path_ref, :top_const_ref
+      return superclass.source
+    when :fcall, :command
+      methname = superclass.method_name.source
+      return superclass.parameters.first.source if methname == "DelegateClass"
+      return methname if superclass.method_name.type == :const
+    when :call, :command_call
+      cname = superclass.namespace.source
+      if cname =~ /^O?Struct$/ && superclass.method_name(true) == :new
+        return cname
+      end
+    end
+    nil
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# Handles a class variable (@@variable)
+class YARD::Handlers::Ruby::ClassVariableHandler < YARD::Handlers::Ruby::Base
+  handles :assign
+  namespace_only
+
+  process do
+    if statement[0].type == :var_field && statement[0][0].type == :cvar
+      name = statement[0][0][0]
+      value = statement[1].source
+      register ClassVariableObject.new(namespace, name) do |o|
+        o.source = statement
+        o.value = value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+# Handles any lone comment statement in a Ruby file
+class YARD::Handlers::Ruby::CommentHandler < YARD::Handlers::Ruby::Base
+  handles :comment, :void_stmt
+  namespace_only
+
+  process do
+    register_docstring(nil)
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+# Handles any constant assignment
+class YARD::Handlers::Ruby::ConstantHandler < YARD::Handlers::Ruby::Base
+  include YARD::Handlers::Ruby::StructHandlerMethods
+  handles :assign
+  namespace_only
+
+  process do
+    if statement[1].call? && statement[1][0][0] == s(:const, "Struct") &&
+       statement[1][2] == s(:ident, "new")
+      process_structclass(statement)
+    elsif statement[0].type == :var_field && statement[0][0].type == :const
+      process_constant(statement)
+    elsif statement[0].type == :const_path_field
+      process_constant(statement)
+    end
+  end
+
+  private
+
+  def process_constant(statement)
+    name = statement[0].source
+    value = statement[1].source
+    obj = P(namespace, name)
+    if obj.is_a?(NamespaceObject) && obj.namespace == namespace
+      raise YARD::Parser::UndocumentableError, "constant for existing #{obj.type} #{obj}"
+    else
+      ensure_loaded! obj.parent
+      register ConstantObject.new(namespace, name) {|o| o.source = statement; o.value = value.strip }
+    end
+  end
+
+  def process_structclass(statement)
+    lhs = statement[0][0]
+    if lhs.type == :const
+      klass = create_class(lhs[0], P(:Struct))
+      create_attributes(klass, extract_parameters(statement[1]))
+      parse_block(statement[1].block[1], :namespace => klass) unless statement[1].block.nil?
+    else
+      raise YARD::Parser::UndocumentableError, "Struct assignment to #{statement[0].source}"
+    end
+  end
+
+  # Extract the parameters from the Struct.new AST node, returning them as a list
+  # of strings
+  #
+  # @param [MethodCallNode] superclass the AST node for the Struct.new call
+  # @return [Array<String>] the member names to generate methods for
+  def extract_parameters(superclass)
+    return [] unless superclass.parameters
+    members = superclass.parameters.select {|x| x && x.type == :symbol_literal }
+    members.map! {|x| x.source.strip[1..-1] }
+    members
+  end
+end

data/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/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/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/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/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/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/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