Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Puppet4API Project Task 7] Modify the Puppet Function loading to use all of the new Puppet 4 API features #141

Closed
glennsarti opened this issue Jun 10, 2019 · 0 comments · Fixed by #142
Closed

[Puppet4API Project Task 7] Modify the Puppet Function loading to use all of the new Puppet 4 API features #141

glennsarti opened this issue Jun 10, 2019 · 0 comments · Fixed by #142
Assignees
@glennsarti
Labels
enhancement New feature or request Language Server
Milestone
0.20.0

Comments

@glennsarti
Copy link
Contributor

Task7 of the Puppet 4 API Project

Task 7

Modify the Puppet Function loading to use all of the new Puppet 4 API features
@glennsarti glennsarti added this to the 0.20.0 milestone Jun 10, 2019
@glennsarti glennsarti added enhancement New feature or request Language Server labels Jun 10, 2019
@glennsarti glennsarti self-assigned this Jun 10, 2019
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Change Puppet Function information in Sidecar to s…
5dfc8ae 
…upport V4 API

Previously the Puppet Function information retrieved over the Sidecar Protocol
only supported the older V3 Function API.  This commit updates the Protocol to
now be able to transmit V4 function information.  V3 information is expected to
be adapted into its equivalent in V4.

This commit:
* Removes the deprecated arity and type methods and adds function_version and
  signatures.  Where signatures are the function method signatures expressed as
  a PuppetFunctionSignatureList object
* Adds a PuppetFunctionSignature and PuppetFunctionSignatureList object which
  captures all of the properties of Puppet Function V4 API method signature.
  The PuppetFunctionSignatureList object is a "typed" array of
  PuppetFunctionSignature objects
* Adds a PuppetFunctionSignatureParameter and
  PuppetFunctionSignatureParameterList object which captures all of the
  properties of Puppet Function V4 API method signature parameter. The
  PuppetFunctionSignatureParameterList object is a "typed" array of
  PuppetFunctionSignatureParameter objects
* Updates the spec_helper to be able to create mock objects for functions,
  function signatures and function signature parameters
* Updates the sidecar protocol tests for the modified parameters and newly added
  classes
* Updates the in-memory cache object tests for the modified parameters of a
  Function.

At this point the protocol now only accepts V4 Function API information. Later
commits will modify the Sidecar and Language Server to generate and consume the
new information respectively.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
8760e60 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
3b64d1d 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
@glennsarti glennsarti mentioned this issue Jun 10, 2019
Merged
2 tasks
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Change Puppet Function information in Sidecar to s…
7b4db22 
…upport V4 API

Previously the Puppet Function information retrieved over the Sidecar Protocol
only supported the older V3 Function API.  This commit updates the Protocol to
now be able to transmit V4 function information.  V3 information is expected to
be adapted into its equivalent in V4.

This commit:
* Removes the deprecated arity and type methods and adds function_version and
  signatures.  Where signatures are the function method signatures expressed as
  a PuppetFunctionSignatureList object
* Adds a PuppetFunctionSignature and PuppetFunctionSignatureList object which
  captures all of the properties of Puppet Function V4 API method signature.
  The PuppetFunctionSignatureList object is a "typed" array of
  PuppetFunctionSignature objects
* Adds a PuppetFunctionSignatureParameter and
  PuppetFunctionSignatureParameterList object which captures all of the
  properties of Puppet Function V4 API method signature parameter. The
  PuppetFunctionSignatureParameterList object is a "typed" array of
  PuppetFunctionSignatureParameter objects
* Updates the spec_helper to be able to create mock objects for functions,
  function signatures and function signature parameters
* Updates the sidecar protocol tests for the modified parameters and newly added
  classes
* Updates the in-memory cache object tests for the modified parameters of a
  Function.

At this point the protocol now only accepts V4 Function API information. Later
commits will modify the Sidecar and Language Server to generate and consume the
new information respectively.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
d350100 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
ce870ec 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Change Puppet Function information in Sidecar to s…
5ceec6c 
…upport V4 API

Previously the Puppet Function information retrieved over the Sidecar Protocol
only supported the older V3 Function API.  This commit updates the Protocol to
now be able to transmit V4 function information.  V3 information is expected to
be adapted into its equivalent in V4.

This commit:
* Removes the deprecated arity and type methods and adds function_version and
  signatures.  Where signatures are the function method signatures expressed as
  a PuppetFunctionSignatureList object
* Adds a PuppetFunctionSignature and PuppetFunctionSignatureList object which
  captures all of the properties of Puppet Function V4 API method signature.
  The PuppetFunctionSignatureList object is a "typed" array of
  PuppetFunctionSignature objects
* Adds a PuppetFunctionSignatureParameter and
  PuppetFunctionSignatureParameterList object which captures all of the
  properties of Puppet Function V4 API method signature parameter. The
  PuppetFunctionSignatureParameterList object is a "typed" array of
  PuppetFunctionSignatureParameter objects
* Updates the spec_helper to be able to create mock objects for functions,
  function signatures and function signature parameters
* Updates the sidecar protocol tests for the modified parameters and newly added
  classes
* Updates the in-memory cache object tests for the modified parameters of a
  Function.

At this point the protocol now only accepts V4 Function API information. Later
commits will modify the Sidecar and Language Server to generate and consume the
new information respectively.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
d482cb4 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
b5df4d3 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
0617e0f 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
7e93d87 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
8ddad4b 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
69ec36e 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
e009d06 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Add tests for Puppet Language Functions
9081301 
Previously the function loader was modified for V4 Function API however there
were no tests for the Puppet based Functions, as opposed to Ruby.  This commit
adds the test fixtures and tests to ensure that Puppet based Functions are
loaded correctly.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 10, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
67e317e 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 11, 2019
@glennsarti
(puppetlabsGH-141) Change Puppet Function information in Sidecar to s…
18eafa6 
…upport V4 API

Previously the Puppet Function information retrieved over the Sidecar Protocol
only supported the older V3 Function API.  This commit updates the Protocol to
now be able to transmit V4 function information.  V3 information is expected to
be adapted into its equivalent in V4.

This commit:
* Removes the deprecated arity and type methods and adds function_version and
  signatures.  Where signatures are the function method signatures expressed as
  a PuppetFunctionSignatureList object
* Adds a PuppetFunctionSignature and PuppetFunctionSignatureList object which
  captures all of the properties of Puppet Function V4 API method signature.
  The PuppetFunctionSignatureList object is a "typed" array of
  PuppetFunctionSignature objects
* Adds a PuppetFunctionSignatureParameter and
  PuppetFunctionSignatureParameterList object which captures all of the
  properties of Puppet Function V4 API method signature parameter. The
  PuppetFunctionSignatureParameterList object is a "typed" array of
  PuppetFunctionSignatureParameter objects
* Updates the spec_helper to be able to create mock objects for functions,
  function signatures and function signature parameters
* Updates the sidecar protocol tests for the modified parameters and newly added
  classes
* Updates the in-memory cache object tests for the modified parameters of a
  Function.

At this point the protocol now only accepts V4 Function API information. Later
commits will modify the Sidecar and Language Server to generate and consume the
new information respectively.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 11, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
9830dfa 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 11, 2019
@glennsarti
(puppetlabsGH-141) Add tests for Puppet Language Functions
43594a8 
Previously the function loader was modified for V4 Function API however there
were no tests for the Puppet based Functions, as opposed to Ruby.  This commit
adds the test fixtures and tests to ensure that Puppet based Functions are
loaded correctly.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 11, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
8263b84 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 11, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
1dcd34e 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 11, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
8cbc51d 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 11, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
674cbe0 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Update Sidecar to extract Function V4 API information
5299cbd 
Previously the Sidecar could only emit information in function V3 API format.
Now that the Sidecar Protocol has been changed to emit V4 information, this
commit updates the Sidecar to extact the V4 information.

This commit:
* Updates the sidecar_protocol_extensions for the Puppet Function object to
  adapt the V3 function information into the V4 version
* Updates the tests for the sidecar_protocol_extensions for the new parameters
  for the V4 API functions
* Updates the Puppet Strings Helper to extract the required information from
  YARN in order to populate the V4 API function metadata.  In particular the
  concepts of function type and arity no longer apply, and have been replaced
  using Function Signatures.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Add tests for Puppet Language Functions
7d603fd 
Previously the function loader was modified for V4 Function API however there
were no tests for the Puppet based Functions, as opposed to Ruby.  This commit
adds the test fixtures and tests to ensure that Puppet based Functions are
loaded correctly.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Add Puppet Strings Helper tests
acbc934 
Previously a Puppet Strings Helper was added however there no tests for the
metadata extraction.  This commit:

* Adds tests to ensure that YARD/Puppet Strings extracts the metadata correctly
* Converts the Strings Helper module into a class to make it easier to test
* Updates the Puppet 4 function fixture to be a more complete example
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Detect parameter names within Function signature keys
8cb7f05 
When Puppet Strings extracts the parameter name it differs from how it appears
in the signature key. This makes it hard for clients to determine where in the
signature, the parameter actually is. This commit:

* Updates the Sidecar Protocol and adds two new methods for the
  PuppetFunctionSignatureParameter class; signature_key_offset and
  signature_key_length.  These values will store where in the signature key
  a parameter exists
* Updates the protocol tests and spec helper for the new methods
* Updates the Puppet Strings Helper to detect and populate the offset and length
  values for each parameter in a signature
* Updates the Puppet Strings Helper tests to assert these values are correct for
  bare parameter names, blocks and splattable arguments.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
a87fd92 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Add Puppet Strings Helper tests
425587d 
Previously a Puppet Strings Helper was added however there no tests for the
metadata extraction.  This commit:

* Adds tests to ensure that YARD/Puppet Strings extracts the metadata correctly
* Converts the Strings Helper module into a class to make it easier to test
* Updates the Puppet 4 function fixture to be a more complete example
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Detect parameter names within Function signature keys
f4c64d0 
When Puppet Strings extracts the parameter name it differs from how it appears
in the signature key. This makes it hard for clients to determine where in the
signature, the parameter actually is. This commit:

* Updates the Sidecar Protocol and adds two new methods for the
  PuppetFunctionSignatureParameter class; signature_key_offset and
  signature_key_length.  These values will store where in the signature key
  a parameter exists
* Updates the protocol tests and spec helper for the new methods
* Updates the Puppet Strings Helper to detect and populate the offset and length
  values for each parameter in a signature
* Updates the Puppet Strings Helper tests to assert these values are correct for
  bare parameter names, blocks and splattable arguments.
glennsarti added a commit to glennsarti/puppet-editor-services that referenced this issue Jun 13, 2019
@glennsarti
(puppetlabsGH-141) Update Completion and Hover providers for V4 API F…
ee8238b 
…unctions

Now that the Sidecar and the Sidecar Protocol have been modified to emit V4
API function metadata the completion and hover providers need to be modified
to use it.  This commit:

* Because the concept of Function Type no longer exists (rvalue vs statement)
  all functions need to be returned when in the root of a document.  Therefore
  the all_statement_functions method is changed into all_functions
* The completion resolver is modified to only emit completion information if the
  function actually has a signature (all functions should have at least one
  sig). The resulting resolution now returns the function documentation and
  function signatures in separate fields in the response
* The insertion text for the completion item now just emits the function with
  empty parentheses. This should trigger the Signature Helper, which will be
  implemented in later commits
* The hover provider is modified to remove a todo item because arity no longer
  exists
jpogran added a commit that referenced this issue Jun 25, 2019
@jpogran
Merge pull request #142 from glennsarti/gh141-pup4-functions
31b5c35 
(GH-141) Modify the Puppet Function loading to use all of the new Puppet 4 API features
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@glennsarti glennsarti

Labels
enhancement New feature or request Language Server
Projects
None yet
Milestone
0.20.0
1 participant
@glennsarti