kinetic_sdk 5.0.19 → 5.0.20

data/gems/yard-0.9.25/lib/yard/tags/overload_tag.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+module YARD
+  module Tags
+    class OverloadTag < Tag
+      attr_reader :signature, :parameters, :docstring
+
+      def initialize(tag_name, text)
+        super(tag_name, nil)
+        parse_tag(text)
+        parse_signature
+      end
+
+      def tag(name) docstring.tag(name) end
+      def tags(name = nil) docstring.tags(name) end
+      def has_tag?(name) docstring.has_tag?(name) end
+
+      def object=(value)
+        super(value)
+        docstring.object = value
+        docstring.tags.each {|tag| tag.object = value }
+      end
+
+      def name(prefix = false)
+        return @name unless prefix
+        object.scope == :class ? @name.to_s : "#{object.send(:sep)}#{@name}"
+      end
+
+      def method_missing(*args, &block)
+        object.send(*args, &block)
+      end
+
+      def type
+        object.type
+      end
+
+      def is_a?(other)
+        object.is_a?(other) || self.class >= other.class || false
+      end
+      alias kind_of? is_a?
+
+      private
+
+      def parse_tag(text)
+        @signature, text = *text.split(/\r?\n/, 2)
+        @signature.strip!
+        text ||= String.new("")
+        numspaces = text[/\A(\s*)/, 1].length
+        text.gsub!(/^[ \t]{#{numspaces}}/, '')
+        text.strip!
+        @docstring = Docstring.new(text, nil)
+      end
+
+      def parse_signature
+        if signature =~ /^(?:def\s)?\s*(#{CodeObjects::METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
+          meth = $1
+          args = $2
+          meth.gsub!(/\s+/, '')
+          # FIXME: refactor this code to not make use of the Handlers::Base class (tokval_list should be moved)
+          toks = YARD::Parser::Ruby::Legacy::TokenList.new(args)
+          args = YARD::Handlers::Ruby::Legacy::Base.new(nil, nil).send(:tokval_list, toks, :all)
+          args = args.map do |a|
+            k, v = *a.split(/:|=/, 2)
+            [k.strip.to_s + (a[k.size, 1] == ':' ? ':' : ''), (v ? v.strip : nil)]
+          end if args
+          @name = meth.to_sym
+          @parameters = args
+        end
+      end
+    end
+  end
+end

data/gems/yard-0.9.25/lib/yard/tags/ref_tag.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module YARD
+  module Tags
+    module RefTag
+      attr_accessor :owner
+    end
+  end
+end

data/gems/yard-0.9.25/lib/yard/tags/ref_tag_list.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module YARD
+  module Tags
+    class RefTagList
+      attr_accessor :owner, :tag_name, :name
+
+      def initialize(tag_name, owner, name = nil)
+        @owner = CodeObjects::Proxy === owner ? owner : P(owner)
+        @tag_name = tag_name.to_s
+        @name = name
+      end
+
+      def tags
+        if owner.is_a?(CodeObjects::Base)
+          o = owner.tags(tag_name)
+          o = o.select {|t| t.name.to_s == name.to_s } if name
+          o.each do |t|
+            t.extend(RefTag)
+            t.owner = owner
+          end
+          o
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/gems/yard-0.9.25/lib/yard/tags/tag.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+module YARD
+  module Tags
+    # Represents a metadata tag value (+@tag+). Tags can have any combination of
+    # {#types}, {#name} and {#text}, or none of the above.
+    #
+    # @example Programmatic tag creation
+    #   # The following docstring syntax:
+    #   #   @param [String, nil] arg an argument
+    #   #
+    #   # is equivalent to:
+    #   Tag.new(:param, 'an argument', ['String', 'nil'], 'arg')
+    class Tag
+      # @return [String] the name of the tag
+      attr_accessor :tag_name
+
+      # @return [String] the tag text associated with the tag
+      # @return [nil] if no tag text is supplied
+      attr_accessor :text
+
+      # @return [Array<String>] a list of types associated with the tag
+      # @return [nil] if no types are associated with the tag
+      attr_accessor :types
+
+      # @return [String] a name associated with the tag
+      attr_accessor :name
+
+      # @return [CodeObjects::Base] the associated object
+      attr_accessor :object
+
+      # Creates a new tag object with a tag name and text. Optionally, formally declared types
+      # and a key name can be specified.
+      #
+      # Types are mainly for meta tags that rely on type information, such as +param+, +return+, etc.
+      #
+      # Key names are for tags that declare meta data for a specific key or name, such as +param+,
+      # +raise+, etc.
+      #
+      # @param [#to_s] tag_name        the tag name to create the tag for
+      # @param [String] text           the descriptive text for this tag
+      # @param [Array<String>] types   optional type list of formally declared types
+      #                                for the tag
+      # @param [String] name           optional key name which the tag refers to
+      def initialize(tag_name, text, types = nil, name = nil)
+        @tag_name = tag_name.to_s
+        @text = text
+        @name = name
+        @types = (types ? [types].flatten.compact : nil)
+      end
+
+      # Convenience method to access the first type specified. This should mainly
+      # be used for tags that only specify one type.
+      #
+      # @return [String] the first of the list of specified types
+      # @see #types
+      def type
+        types.first
+      end
+
+      # Provides a plain English summary of the type specification, or nil
+      # if no types are provided or parseable.
+      #
+      # @return [String] a plain English description of the associated types
+      # @return [nil] if no types are provided or not parseable
+      def explain_types
+        return nil if !types || types.empty?
+        TypesExplainer.explain(*types)
+      end
+    end
+  end
+end

data/gems/yard-0.9.25/lib/yard/tags/tag_format_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module YARD
+  module Tags
+    class TagFormatError < RuntimeError
+    end
+  end
+end

data/gems/yard-0.9.25/lib/yard/tags/types_explainer.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+require 'strscan'
+
+module YARD
+  module Tags
+    class TypesExplainer
+      # (see Tag#explain_types)
+      # @param types [Array<String>] a list of types to parse and summarize
+      def self.explain(*types)
+        explain!(*types)
+      rescue SyntaxError
+        nil
+      end
+
+      # (see explain)
+      # @raise [SyntaxError] if the types are not parseable
+      def self.explain!(*types)
+        Parser.parse(types.join(", ")).join("; ")
+      end
+
+      class << self
+        private :new
+      end
+
+      # @private
+      class Type
+        attr_accessor :name
+
+        def initialize(name)
+          @name = name
+        end
+
+        def to_s(singular = true)
+          if name[0, 1] == "#"
+            singular ? "an object that responds to #{name}" : "objects that respond to #{name}"
+          elsif name[0, 1] =~ /[A-Z]/
+            singular ? "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} " + name : "#{name}#{name[-1, 1] =~ /[A-Z]/ ? "'" : ''}s"
+          else
+            name
+          end
+        end
+
+        private
+
+        def list_join(list)
+          index = 0
+          list.inject(String.new) do |acc, el|
+            acc << el.to_s
+            acc << ", " if index < list.size - 2
+            acc << " or " if index == list.size - 2
+            index += 1
+            acc
+          end
+        end
+      end
+
+      # @private
+      class CollectionType < Type
+        attr_accessor :types
+
+        def initialize(name, types)
+          @name = name
+          @types = types
+        end
+
+        def to_s(_singular = true)
+          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} of (" + list_join(types.map {|t| t.to_s(false) }) + ")"
+        end
+      end
+
+      # @private
+      class FixedCollectionType < CollectionType
+        def to_s(_singular = true)
+          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} containing (" + types.map(&:to_s).join(" followed by ") + ")"
+        end
+      end
+
+      # @private
+      class HashCollectionType < Type
+        attr_accessor :key_types, :value_types
+
+        def initialize(name, key_types, value_types)
+          @name = name
+          @key_types = key_types
+          @value_types = value_types
+        end
+
+        def to_s(_singular = true)
+          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} with keys made of (" +
+            list_join(key_types.map {|t| t.to_s(false) }) +
+            ") and values of (" + list_join(value_types.map {|t| t.to_s(false) }) + ")"
+        end
+      end
+
+      # @private
+      class Parser
+        include CodeObjects
+
+        TOKENS = {
+          :collection_start => /</,
+          :collection_end => />/,
+          :fixed_collection_start => /\(/,
+          :fixed_collection_end => /\)/,
+          :type_name => /#{ISEP}#{METHODNAMEMATCH}|#{NAMESPACEMATCH}|\w+/,
+          :type_next => /[,;]/,
+          :whitespace => /\s+/,
+          :hash_collection_start => /\{/,
+          :hash_collection_next => /=>/,
+          :hash_collection_end => /\}/,
+          :parse_end => nil
+        }
+
+        def self.parse(string)
+          new(string).parse
+        end
+
+        def initialize(string)
+          @scanner = StringScanner.new(string)
+        end
+
+        def parse
+          types = []
+          type = nil
+          name = nil
+          loop do
+            found = false
+            TOKENS.each do |token_type, match|
+              # TODO: cleanup this code.
+              # rubocop:disable Lint/AssignmentInCondition
+              next unless (match.nil? && @scanner.eos?) || (match && token = @scanner.scan(match))
+              found = true
+              case token_type
+              when :type_name
+                raise SyntaxError, "expecting END, got name '#{token}'" if name
+                name = token
+              when :type_next
+                raise SyntaxError, "expecting name, got '#{token}' at #{@scanner.pos}" if name.nil?
+                type = Type.new(name) unless type
+                types << type
+                type = nil
+                name = nil
+              when :fixed_collection_start, :collection_start
+                name ||= "Array"
+                klass = token_type == :collection_start ? CollectionType : FixedCollectionType
+                type = klass.new(name, parse)
+              when :hash_collection_start
+                name ||= "Hash"
+                type = HashCollectionType.new(name, parse, parse)
+              when :hash_collection_next, :hash_collection_end, :fixed_collection_end, :collection_end, :parse_end
+                raise SyntaxError, "expecting name, got '#{token}'" if name.nil?
+                type = Type.new(name) unless type
+                types << type
+                return types
+              end
+            end
+            raise SyntaxError, "invalid character at #{@scanner.peek(1)}" unless found
+          end
+        end
+      end
+    end
+  end
+end

data/gems/yard-0.9.25/lib/yard/templates/engine.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+require 'ostruct'
+
+module YARD
+  module Templates
+    # This module manages all creation, handling and rendering of {Template}
+    # objects.
+    #
+    # * To create a template object at a path, use {template}.
+    # * To render a template, call {render}.
+    # * To register a template path in the lookup paths, call {register_template_path}.
+    module Engine
+      class << self
+        # @return [Array<String>] the list of registered template paths
+        attr_accessor :template_paths
+
+        # Registers a new template path in {template_paths}
+        #
+        # @param [String] path a new template path
+        # @return [void]
+        def register_template_path(path)
+          template_paths.push(path) unless template_paths.include?(path)
+        end
+
+        # Creates a template module representing the path. Searches on disk
+        # for the first directory named +path+ (joined by '/') within the
+        # template paths and builds a template module for. All other matching
+        # directories in other template paths will be included in the
+        # generated module as mixins (for overriding).
+        #
+        # @param [Array<String, Symbol>] path a list of path components
+        # @raise [ArgumentError] if the path does not exist within one of the
+        #   {template_paths} on disk.
+        # @return [Template] the module representing the template
+        def template(*path)
+          from_template = nil
+          from_template = path.shift if path.first.is_a?(Template)
+          path = path.join('/')
+          full_paths = find_template_paths(from_template, path)
+
+          path = File.cleanpath(path).gsub('../', '')
+          raise ArgumentError, "No such template for #{path}" if full_paths.empty?
+          mod = template!(path, full_paths)
+
+          mod
+        end
+
+        # Forces creation of a template at +path+ within a +full_path+.
+        #
+        # @param [String] path the path name of the template
+        # @param [Array<String>] full_paths the full path on disk of the template
+        # @return [Template] the template module representing the +path+
+        def template!(path, full_paths = nil)
+          full_paths ||= [path]
+          full_paths = [full_paths] unless full_paths.is_a?(Array)
+          name = template_module_name(full_paths.first)
+          begin; return const_get(name); rescue NameError; nil end
+
+          mod = const_set(name, Module.new)
+          mod.send(:include, Template)
+          mod.send(:initialize, path, full_paths)
+          mod
+        end
+
+        # Renders a template on a {CodeObjects::Base code object} using
+        # a set of default (overridable) options. Either the +:object+
+        # or +:type+ keys must be provided.
+        #
+        # If a +:serializer+ key is provided and +:serialize+ is not set to
+        # false, the rendered contents will be serialized through the {Serializers::Base}
+        # object. See {with_serializer}.
+        #
+        # @example Renders an object with html formatting
+        #   Engine.render(:format => :html, :object => obj)
+        # @example Renders without an object
+        #   Engine.render(:type => :fulldoc, :otheropts => somevalue)
+        # @param [Hash] options the options hash
+        # @option options [Symbol] :format (:text) the default format
+        # @option options [Symbol] :type (nil) the :object's type.
+        # @option options [Symbol] :template (:default) the default template
+        # @return [String] the rendered template
+        def render(options = {})
+          options = set_default_options(options)
+          mod = template(options.template, options.type, options.format)
+
+          if options.serializer && options.serialize != false
+            with_serializer(options.object, options.serializer) { mod.run(options) }
+          else
+            mod.run(options)
+          end
+        end
+
+        # Passes a set of objects to the +:fulldoc+ template for full documentation generation.
+        # This is called by {CLI::Yardoc} to most commonly perform HTML
+        # documentation generation.
+        #
+        # @param [Array<CodeObjects::Base>] objects a list of {CodeObjects::Base}
+        #   objects to pass to the template
+        # @param [Hash] options (see {render})
+        # @return [void]
+        def generate(objects, options = {})
+          options = set_default_options(options)
+          options.objects = objects
+          options.object = Registry.root
+          template(options.template, :fulldoc, options.format).run(options)
+        end
+
+        # Serializes the results of a block with a +serializer+ object.
+        #
+        # @param [CodeObjects::Base] object the code object to serialize
+        # @param [Serializers::Base] serializer the serializer object
+        # @yield a block whose result will be serialize
+        # @yieldreturn [String] the contents to serialize
+        # @see Serializers::Base
+        def with_serializer(object, serializer)
+          output = nil
+          filename = serializer.serialized_path(object)
+          if serializer.respond_to?(:basepath)
+            filename = File.join(serializer.basepath, filename)
+          end
+          log.capture("Generating #{filename}", nil) do
+            serializer.before_serialize if serializer
+            output = yield
+            if serializer
+              serializer.serialize(object, output)
+              serializer.after_serialize(output)
+            end
+          end
+          output
+        end
+
+        private
+
+        # Sets default options on the options hash
+        #
+        # @param [Hash] options the options hash
+        # @option options [Symbol] :format (:text) the default format
+        # @option options [Symbol] :type (nil) the :object's type, if provided
+        # @option options [Symbol] :template (:default) the default template
+        # @return [void]
+        def set_default_options(options = {})
+          if options.is_a?(Hash)
+            options = TemplateOptions.new.tap do |o|
+              o.reset_defaults
+              o.update(options)
+            end
+          end
+          options.type ||= options.object.type if options.object
+          options
+        end
+
+        # Searches through the registered {template_paths} and returns
+        # all full directories that have the +path+ within them on disk.
+        #
+        # @param [Template] from_template if provided, allows a relative
+        #   path to be specified from this template's full path.
+        # @param [String] path the path component to search for in the
+        #   {template_paths}
+        # @return [Array<String>] a list of full paths that are existing
+        #   candidates for a template module
+        def find_template_paths(from_template, path)
+          paths = template_paths.dup
+          paths = from_template.full_paths + paths if from_template
+
+          paths.inject([]) do |acc, tp|
+            full_path = File.cleanpath(File.join(tp, path))
+            acc.unshift(full_path) if File.directory?(full_path)
+            acc
+          end.uniq
+        end
+
+        # The name of the module that represents a +path+
+        #
+        # @param [String] path the path to generate a module name for
+        # @return [String] the module name
+        def template_module_name(path)
+          'Template_' + path.to_s.gsub(/[^a-z0-9]/i, '_')
+        end
+      end
+
+      self.template_paths = []
+    end
+
+    Engine.register_template_path(File.join(YARD::ROOT, '..', 'templates'))
+  end
+end

data/gems/yard-0.9.25/lib/yard/templates/erb_cache.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module YARD
+  module Templates
+    # @since 0.5.4
+    module ErbCache
+      def self.method_for(filename)
+        @methods ||= {}
+        return @methods[filename] if @methods[filename]
+        @methods[filename] = name = "_erb_cache_#{@methods.size}"
+        erb = yield.src
+        encoding = erb[/\A(#coding[:=].*\r?\n)/, 1] || ''
+        module_eval "#{encoding}def #{name}; #{erb}; end", filename
+
+        name
+      end
+
+      def self.clear!
+        return unless defined?(@methods) && @methods
+        @methods.clear
+      end
+    end
+  end
+end