language_server-protocol 3.17.0.6 → 3.18.0.0.pre.1

data/lib/language_server/protocol/interface/inline_completion_list.rb

@@ -0,0 +1,38 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionList
+        def initialize(items:)
+          @attributes = {}
+
+          @attributes[:items] = items
+
+          @attributes.freeze
+        end
+
+        #
+        # The inline completion items
+        #
+        # @return [InlineCompletionItem[]]
+        def items
+          attributes.fetch(:items)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/inline_completion_options.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline completion options used during static registration.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionOptions
+        def initialize(work_done_progress: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/inline_completion_params.rb

@@ -0,0 +1,66 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # A parameter literal used in inline completion requests.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionParams
+        def initialize(context:, text_document:, position:, work_done_token: nil)
+          @attributes = {}
+
+          @attributes[:context] = context
+          @attributes[:textDocument] = text_document
+          @attributes[:position] = position
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+
+          @attributes.freeze
+        end
+
+        #
+        # Additional information about the context in which inline completions were
+        # requested.
+        #
+        # @return [InlineCompletionContext]
+        def context
+          attributes.fetch(:context)
+        end
+
+        #
+        # The text document.
+        #
+        # @return [TextDocumentIdentifier]
+        def text_document
+          attributes.fetch(:textDocument)
+        end
+
+        #
+        # The position inside the text document.
+        #
+        # @return [Position]
+        def position
+          attributes.fetch(:position)
+        end
+
+        #
+        # An optional token that a server can use to report work done progress.
+        #
+        # @return [ProgressToken]
+        def work_done_token
+          attributes.fetch(:workDoneToken)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/inline_completion_registration_options.rb

@@ -0,0 +1,55 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Inline completion options used during static or dynamic registration.
+      #
+      # @since 3.18.0
+      #
+      class InlineCompletionRegistrationOptions
+        def initialize(work_done_progress: nil, document_selector:, id: nil)
+          @attributes = {}
+
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:documentSelector] = document_selector
+          @attributes[:id] = id unless id.nil?
+
+          @attributes.freeze
+        end
+
+        # @return [boolean]
+        def work_done_progress
+          attributes.fetch(:workDoneProgress)
+        end
+
+        #
+        # A document selector to identify the scope of the registration. If set to null
+        # the document selector provided on the client side will be used.
+        #
+        # @return [DocumentSelector | nil]
+        def document_selector
+          attributes.fetch(:documentSelector)
+        end
+
+        #
+        # The id used to register the request. The id can be used to deregister
+        # the request again. See also Registration#id.
+        #
+        # @return [string]
+        def id
+          attributes.fetch(:id)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/inline_value.rb

@@ -15,10 +15,10 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:text] = text if text
-          @attributes[:variableName] = variable_name if variable_name
-          @attributes[:caseSensitiveLookup] = case_sensitive_lookup if case_sensitive_lookup
-          @attributes[:expression] = expression if expression
+          @attributes[:text] = text unless text.nil?
+          @attributes[:variableName] = variable_name unless variable_name.nil?
+          @attributes[:caseSensitiveLookup] = case_sensitive_lookup unless case_sensitive_lookup.nil?
+          @attributes[:expression] = expression unless expression.nil?
 
           @attributes.freeze
         end
@@ -29,12 +29,16 @@ module LanguageServer
         # --- OR ---
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the variable name from the underlying document.
+        #
+        # The range could be used to extract the variable name
+        # from the underlying document.
         #
         # --- OR ---
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the evaluatable expression from the underlying document.
+        #
+        # The range could be used to extract the evaluatable expression
+        # from the underlying document.
         #
         # @return [Range]
         def range
@@ -66,7 +70,7 @@ module LanguageServer
         end
 
         #
-        # If specified the expression overrides the extracted expression.
+        # If specified the expression could be evaluated instead.
         #
         # @return [string]
         def expression

data/lib/language_server/protocol/interface/inline_value_client_capabilities.rb

@@ -10,7 +10,7 @@ module LanguageServer
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/inline_value_evaluatable_expression.rb

@@ -2,9 +2,13 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Provide an inline value through an expression evaluation.
-      # If only a range is specified, the expression will be extracted from the underlying document.
-      # An optional expression can be used to override the extracted expression.
+      # To compute an inline value through an expression evaluation.
+      #
+      # If only a range is specified, the expression should be
+      # extracted from the underlying document.
+      #
+      # An optional expression could be evaluated instead of
+      # the extracted expression.
       #
       # @since 3.17.0
       #
@@ -13,14 +17,16 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:expression] = expression if expression
+          @attributes[:expression] = expression unless expression.nil?
 
           @attributes.freeze
         end
 
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the evaluatable expression from the underlying document.
+        #
+        # The range could be used to extract the evaluatable expression
+        # from the underlying document.
         #
         # @return [Range]
         def range
@@ -28,7 +34,7 @@ module LanguageServer
         end
 
         #
-        # If specified the expression overrides the extracted expression.
+        # If specified the expression could be evaluated instead.
         #
         # @return [string]
         def expression

data/lib/language_server/protocol/interface/inline_value_options.rb

@@ -10,7 +10,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/inline_value_params.rb

@@ -13,7 +13,7 @@ module LanguageServer
           @attributes[:textDocument] = text_document
           @attributes[:range] = range
           @attributes[:context] = context
-          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end
@@ -27,7 +27,7 @@ module LanguageServer
         end
 
         #
-        # The document range for which inline values should be computed.
+        # The document range for which inline values information will be returned.
         #
         # @return [Range]
         def range
@@ -35,7 +35,7 @@ module LanguageServer
         end
 
         #
-        # Additional information about the context in which inline values were
+        # Additional information about the context in which inline values information was
         # requested.
         #
         # @return [InlineValueContext]

data/lib/language_server/protocol/interface/inline_value_registration_options.rb

@@ -10,9 +10,9 @@ module LanguageServer
         def initialize(work_done_progress: nil, document_selector:, id: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
           @attributes[:documentSelector] = document_selector
-          @attributes[:id] = id if id
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/inline_value_text.rb

@@ -2,7 +2,7 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Provide inline value as text.
+      # Returns inline value information as the complete text to be shown.
       #
       # @since 3.17.0
       #

data/lib/language_server/protocol/interface/inline_value_variable_lookup.rb

@@ -2,9 +2,13 @@ module LanguageServer
   module Protocol
     module Interface
       #
-      # Provide inline value through a variable lookup.
-      # If only a range is specified, the variable name will be extracted from the underlying document.
-      # An optional variable name can be used to override the extracted name.
+      # To compute inline value through a variable lookup.
+      #
+      # If only a range is specified, the variable name should
+      # be extracted from the underlying document.
+      #
+      # An optional variable name could be used to lookup instead
+      # of the extracted name.
       #
       # @since 3.17.0
       #
@@ -13,7 +17,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:range] = range
-          @attributes[:variableName] = variable_name if variable_name
+          @attributes[:variableName] = variable_name unless variable_name.nil?
           @attributes[:caseSensitiveLookup] = case_sensitive_lookup
 
           @attributes.freeze
@@ -21,7 +25,9 @@ module LanguageServer
 
         #
         # The document range for which the inline value applies.
-        # The range is used to extract the variable name from the underlying document.
+        #
+        # The range could be used to extract the variable name
+        # from the underlying document.
         #
         # @return [Range]
         def range

data/lib/language_server/protocol/interface/inline_value_workspace_client_capabilities.rb

@@ -10,7 +10,7 @@ module LanguageServer
         def initialize(refresh_support: nil)
           @attributes = {}
 
-          @attributes[:refreshSupport] = refresh_support if refresh_support
+          @attributes[:refreshSupport] = refresh_support unless refresh_support.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/linked_editing_range_client_capabilities.rb

@@ -10,7 +10,7 @@ module LanguageServer
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/linked_editing_range_options.rb

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/linked_editing_range_params.rb

@@ -7,7 +7,7 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/linked_editing_range_registration_options.rb

@@ -6,8 +6,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
-          @attributes[:id] = id if id
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
+          @attributes[:id] = id unless id.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/linked_editing_ranges.rb

@@ -11,7 +11,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:ranges] = ranges
-          @attributes[:wordPattern] = word_pattern if word_pattern
+          @attributes[:wordPattern] = word_pattern unless word_pattern.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/location_link.rb

@@ -9,7 +9,7 @@ module LanguageServer
         def initialize(origin_selection_range: nil, target_uri:, target_range:, target_selection_range:)
           @attributes = {}
 
-          @attributes[:originSelectionRange] = origin_selection_range if origin_selection_range
+          @attributes[:originSelectionRange] = origin_selection_range unless origin_selection_range.nil?
           @attributes[:targetUri] = target_uri
           @attributes[:targetRange] = target_range
           @attributes[:targetSelectionRange] = target_selection_range

data/lib/language_server/protocol/interface/location_uri_only.rb

@@ -0,0 +1,35 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # Location with only uri and does not include range.
+      #
+      # @since 3.18.0
+      #
+      class LocationUriOnly
+        def initialize(uri:)
+          @attributes = {}
+
+          @attributes[:uri] = uri
+
+          @attributes.freeze
+        end
+
+        # @return [DocumentUri]
+        def uri
+          attributes.fetch(:uri)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/log_trace_params.rb

@@ -6,7 +6,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:message] = message
-          @attributes[:verbose] = verbose if verbose
+          @attributes[:verbose] = verbose unless verbose.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/markdown_client_capabilities.rb

@@ -11,8 +11,8 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:parser] = parser
-          @attributes[:version] = version if version
-          @attributes[:allowedTags] = allowed_tags if allowed_tags
+          @attributes[:version] = version unless version.nil?
+          @attributes[:allowedTags] = allowed_tags unless allowed_tags.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/marked_string_with_language.rb

@@ -0,0 +1,40 @@
+module LanguageServer
+  module Protocol
+    module Interface
+      #
+      # @since 3.18.0
+      # @deprecated use MarkupContent instead.
+      #
+      class MarkedStringWithLanguage
+        def initialize(language:, value:)
+          @attributes = {}
+
+          @attributes[:language] = language
+          @attributes[:value] = value
+
+          @attributes.freeze
+        end
+
+        # @return [string]
+        def language
+          attributes.fetch(:language)
+        end
+
+        # @return [string]
+        def value
+          attributes.fetch(:value)
+        end
+
+        attr_reader :attributes
+
+        def to_hash
+          attributes
+        end
+
+        def to_json(*args)
+          to_hash.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/language_server/protocol/interface/moniker.rb

@@ -13,7 +13,7 @@ module LanguageServer
           @attributes[:scheme] = scheme
           @attributes[:identifier] = identifier
           @attributes[:unique] = unique
-          @attributes[:kind] = kind if kind
+          @attributes[:kind] = kind unless kind.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/moniker_client_capabilities.rb

@@ -10,7 +10,7 @@ module LanguageServer
         def initialize(dynamic_registration: nil)
           @attributes = {}
 
-          @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
+          @attributes[:dynamicRegistration] = dynamic_registration unless dynamic_registration.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/moniker_options.rb

@@ -5,7 +5,7 @@ module LanguageServer
         def initialize(work_done_progress: nil)
           @attributes = {}
 
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/moniker_params.rb

@@ -7,8 +7,8 @@ module LanguageServer
 
           @attributes[:textDocument] = text_document
           @attributes[:position] = position
-          @attributes[:workDoneToken] = work_done_token if work_done_token
-          @attributes[:partialResultToken] = partial_result_token if partial_result_token
+          @attributes[:workDoneToken] = work_done_token unless work_done_token.nil?
+          @attributes[:partialResultToken] = partial_result_token unless partial_result_token.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/moniker_registration_options.rb

@@ -6,7 +6,7 @@ module LanguageServer
           @attributes = {}
 
           @attributes[:documentSelector] = document_selector
-          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
+          @attributes[:workDoneProgress] = work_done_progress unless work_done_progress.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/notebook_cell.rb

@@ -16,8 +16,8 @@ module LanguageServer
 
           @attributes[:kind] = kind
           @attributes[:document] = document
-          @attributes[:metadata] = metadata if metadata
-          @attributes[:executionSummary] = execution_summary if execution_summary
+          @attributes[:metadata] = metadata unless metadata.nil?
+          @attributes[:executionSummary] = execution_summary unless execution_summary.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/notebook_cell_array_change.rb

@@ -13,7 +13,7 @@ module LanguageServer
 
           @attributes[:start] = start
           @attributes[:deleteCount] = delete_count
-          @attributes[:cells] = cells if cells
+          @attributes[:cells] = cells unless cells.nil?
 
           @attributes.freeze
         end

data/lib/language_server/protocol/interface/{hover_result.rb → notebook_cell_language.rb}

@@ -1,18 +1,21 @@
 module LanguageServer
   module Protocol
     module Interface
-      class HoverResult
-        def initialize(value:)
+      #
+      # @since 3.18.0
+      #
+      class NotebookCellLanguage
+        def initialize(language:)
           @attributes = {}
 
-          @attributes[:value] = value
+          @attributes[:language] = language
 
           @attributes.freeze
         end
 
         # @return [string]
-        def value
-          attributes.fetch(:value)
+        def language
+          attributes.fetch(:language)
         end
 
         attr_reader :attributes