Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Ruby: data flow docs #10932

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
Merged
merged 8 commits into from
Nov 4, 2022
Merged

Ruby: data flow docs #10932

merged 8 commits into from
Nov 4, 2022

Conversation

nickrolfe
Copy link
Contributor

No description provided.

asgerf
asgerf reviewed Oct 24, 2022
View reviewed changes
Copy link
Contributor

@asgerf asgerf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@calumgrant requested that we make an early start on reviews, so I put in my comments for now

docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst
expr = call.getArgument(0).getALocalSource()
select call, expr

All these three queries give identical results.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI there's currently a discrepancy between localFlow and flowsTo as the latter does not include capture steps, but I aim to fix that in my PR. Hopefully it will be true around the time we merge this 😄

Just mentioning it in case anyone else stumbles across this and wonders what's going on.

@aibaars aibaars force-pushed the nickrolfe/ruby-dataflow-docs branch from 4218472 to b1da636 Compare October 27, 2022 09:42
@github-actions github-actions bot removed the Ruby label Oct 27, 2022
@aibaars aibaars changed the base branch from main to codeql-cli-2.11.2 October 27, 2022 09:43
@nickrolfe nickrolfe changed the title Ruby: first draft of data flow docs Ruby: data flow docs Oct 31, 2022
@nickrolfe nickrolfe marked this pull request as ready for review October 31, 2022 11:25
@nickrolfe nickrolfe added the Ruby label Oct 31, 2022
calumgrant
calumgrant reviewed Oct 31, 2022
View reviewed changes
Copy link
Contributor

@calumgrant calumgrant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions that can be safely ignored. Nice!

@github-actions github-actions bot removed the Ruby label Oct 31, 2022
@nickrolfe nickrolfe added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Oct 31, 2022
@lucascosti
Copy link

👋 Docs first responder here! I've put this on our board for someone to pick up and review

felicitymay
felicitymay reviewed Nov 1, 2022
View reviewed changes
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nickrolfe - thanks for writing this new article for people who want to explore data flow in Ruby code.

It's a while since I looked at any articles like this but it generally seems clear. I've made some suggestions that I hope will make the content easier to read.

@nickrolfe
Copy link
Contributor Author

Thanks for the review @felicitymay – your suggestions were all great. I think some of them would also apply to the Python version of this document.

@felicitymay
Copy link
Contributor

Many thanks for the updates @nickrolfe - especially the expanded explanations of the final examples 💖

@felicitymay
Copy link
Contributor

I'd like to see the tests passing, so that I can see the generated output, before approving this PR. Possibly we can get #10957 merged today, so that we can update the PR to include the new article 🙂

felicitymay
felicitymay approved these changes Nov 4, 2022
View reviewed changes
Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Sphinx preview looks good and didn't reveal any formatting issues 🚀

calumgrant
calumgrant approved these changes Nov 4, 2022
View reviewed changes
Copy link
Contributor

@calumgrant calumgrant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff!

@calumgrant calumgrant merged commit e9e94dc into codeql-cli-2.11.2 Nov 4, 2022
@calumgrant calumgrant deleted the nickrolfe/ruby-dataflow-docs branch November 4, 2022 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asgerf asgerf asgerf left review comments

@felicitymay felicitymay felicitymay approved these changes

@calumgrant calumgrant calumgrant approved these changes

Assignees
No one assigned
Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. Ruby GA
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@nickrolfe @lucascosti @felicitymay @asgerf @calumgrant @aibaars