Contents

module Yoda
  module Model
    module Descriptions
      class FunctionDescription < Base
        # @return [FunctionSignatures::Base]
        attr_reader :function

        # @param function [FunctionSignatures::Base]
        def initialize(function)
          fail ArgumentError, function unless function.is_a?(FunctionSignatures::Wrapper)
          @function = function
        end

        def title
          "#{function.namespace_path}#{function.sep}#{function.to_s}"
        end

        def label
          signature
        end

        def signature
          "#{function.to_s}"
        end

        def sort_text
          function.name.to_s
        end

        def parameter_names
          function.parameters.parameter_names
        end

        def to_markdown
          <<~EOS
          **#{title}**

          #{function.document}
          #{tag_documents}
          EOS
        end

        private

        def tag_documents
          function.tags.map do |tag|
            str = "@#{tag.tag_name}"
            str += " `#{tag.name}`" if tag.name
            str += " [#{tag.yard_types.map { |name| "`#{name}`" }.join(', ')}]" if tag.yard_types && !(tag.yard_types.empty?)
            str += " #{tag.text.chomp}" if tag.text
            str
          end.join("  \n") # Commonmark requires 2 spaces for line breaking
        end
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
yoda-language-server-0.10.1	lib/yoda/model/descriptions/function_description.rb
yoda-language-server-0.10.0	lib/yoda/model/descriptions/function_description.rb
yoda-language-server-0.9.0	lib/yoda/model/descriptions/function_description.rb
yoda-language-server-0.8.0	lib/yoda/model/descriptions/function_description.rb