Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Eric Thompson updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: Eric Thompson QA Highest Test Level: Unit Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Eric Thompson updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: Eric Thompson QA Status: Reviewed Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Eric Thompson updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: Eric Thompson QA Risk Assessment Reason: docstrings messy, with workarounds. unit tests cover this nicely Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Eric Thompson updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: Eric Thompson QA Risk Assessment: Low Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title
William Hopper updated an issue
Puppet Strings / PDOC-126
Ruby quoting constructs are incompletely stripped from some docstrings
Change By:
William Hopper
Acceptance Criteria:
Given the following provider, strings should parse the docstring as "The database provider on Linux. Here is a test: #{test}" rather than "%Q{The database provider on Linux. Here is a test: #{test}}". Note that string interpolations are not supported, so we expect to see the literal interpolation _expression_ in the final string. {code}Puppet::Type.type(:database).provide :linux do confine 'osfamily' => 'linux' defaultfor 'osfamily' => 'linux' commands :database => '/usr/bin/database' test = "hello world" desc %Q{The database provider on Linux. Here is a test: #{test}} # ...end{code}
Add Comment
This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)
--
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title
William Hopper updated an issue
Puppet Strings / PDOC-126
Ruby quoting constructs are incompletely stripped from some docstrings
Change By:
William Hopper
Acceptance Criteria:
Given the following provider, strings should parse the docstring as "The database provider on Linux. Here is a test: #{test}" rather than "%Q{The database provider on Linux. Here is a test: #{test}}".{code}Puppet::Type.type(:database).provide :linux do confine 'osfamily' => 'linux' defaultfor 'osfamily' => 'linux' commands :database => '/usr/bin/database' test = "hello world" desc %Q{The database provider on Linux. Here is a test: #{test}} # ...end{code}
Add Comment
This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)
--
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Release Notes Summary: Previously, docstrings using the Ruby %Q or %q syntax were parsed literally, resulting in the literal "%Q" appearing in the final string. This change ensures that the resulting string does not include that notation. Release Notes: Bug Fix Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper assigned an issue to qa Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Status: Ready for CI Test Assignee: qa Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Story Points: 2 1 Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Story Points: 2 Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Team: Puppet Developer Support Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Sprint: PDS 2016-11-02 Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Nicholas Fagerlund commented on PDOC-126 Re: Ruby quoting constructs are incompletely stripped from some docstrings I agree with Peter! Interpolation is not desirable here, and treating it as raw text is an excellent fallback when we encounter it. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Fix Version/s: PDOC 1.0.0 Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper assigned an issue to William Hopper Puppet Strings / PDOC-126 Ruby quoting constructs are incompletely stripped from some docstrings Change By: William Hopper Assignee: William Hopper Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Peter Huene commented on PDOC-126 Re: Ruby quoting constructs are incompletely stripped from some docstrings Yes on stripping %Q and %q (and the brackets). Yes on treating interpolated expressions as simply raw docstring text; I think it's a much better alternative than failing, although maybe generating a warning if the AST has an interpolation _expression_ in it would be ideal. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title William Hopper commented on PDOC-126 Re: Ruby quoting constructs are incompletely stripped from some docstrings So then it sounds like the plan of action for this ticket is to simply strip off %Q and %q from docstrings? And unless we can find a way to prevent those warnings, it's expected that docstrings that contain interpolated text will end up having the interpolation _expression_? Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Peter Huene commented on PDOC-126 Re: Ruby quoting constructs are incompletely stripped from some docstrings 👍 thanks for the tests, looks like the quoted heredoc is operating correctly with respect to the best puppet-strings can do. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title
William Hopper commented on PDOC-126
Re: Ruby quoting constructs are incompletely stripped from some docstrings
Here are a few test cases and what we currently get:
1: string interpolation using %Q
test = "hello world"
desc %Q{This is a Q test to see what happens when
we use interpolation: #{test}}
bundle exec puppet strings generate test_provider.rb
[warn]: In file `test_provider.rb':1: Cannot resolve link to This from text.
"docstring": {
"text": "%Q{This is a Q test to see what happens when\nwe use interpolation: #{test}}"
},
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Peter Huene commented on PDOC-126 Re: Ruby quoting constructs are incompletely stripped from some docstrings I believe it would be treated the same as a double quoted string with interpolations: namely the result should contain the interpolation _expression_ as text. We should test this, William Hopper. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title Henrik Lindberg commented on PDOC-126 Re: Ruby quoting constructs are incompletely stripped from some docstrings Is "quoted heredoc" supported ? it can also include interpolations. Just stripping %q %Q sounds fine to me as well as error if there is Ruby interpolation in a docstring. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title
Peter Huene commented on PDOC-126
Re: Ruby quoting constructs are incompletely stripped from some docstrings
Currently only string literals and heredoc expressions are supported, with the latter having known issues due to long standing "it's not a bug!" bug in YARD that we try to work around.
I think we can attempt to fix this by simply stripping both %q} and {{%Q from around the strings, although we should error if the latter attempts interpolation as that cannot be supported.
Add Comment
This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)
--
You received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com.
To post to this group, send email to puppet-bugs@googlegroups.com.
Visit this group at https://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-126) Ruby quoting constructs are incompletely stripped from some docstrings
Title: Message Title
Nicholas Fagerlund created an issue
Puppet Strings / PDOC-126
Ruby quoting constructs are incompletely stripped from some docstrings
Issue Type:
Bug
Assignee:
Unassigned
Created:
2016/10/11 11:24 AM
Priority:
Normal
Reporter:
Nicholas Fagerlund
In Strings's JSON output, check out the 'password' parameter of the 'user' resource type. It has a leftover %q (plus curly braces) from its original ruby string quoting:
{
"name": "password",
"description": "%q{The user's password, in whatever encrypted format the local system\nrequires. Consult your operating system's documentation for acceptable password\nencryption formats and requirements.\n\n* Mac OS X 10.5 and 10.6, and some older Linux distributions, use salted SHA1\n hashes. You can use Puppet's built-in `sha1` function to generate a salted SHA1\n hash from a password.\n* Mac OS X 10.7 (Lion), and many recent Linux distributions, use salted SHA512\n hashes. The Puppet Labs [stdlib][] module contains a `str2saltedsha512`
