!fix(viewer): pass `*Context` into viewer.Render #50

cnlangzi · 2025-02-17T14:26:33Z

Changed

!fix(viewer): update Render with func(*Context,any) error in Viewer. It brings Context into template.Bind

Fixed

Added

Tests

Tasks to complete before merging PR:

Ensure unit tests are passing. If not run make unit-test to check for any regressions 📋
Ensure lint tests are passing. if not run make lint to check for any issues
Ensure codecov/patch is passing for changes.

Summary by Sourcery

Pass the *Context object to viewer Render methods, enabling access to request and response information within viewers. Update the contribution guidelines to use the Apache 2.0 license and add badges to the README.

Enhancements:

Pass *Context to the Render methods of all viewers.
Update Context to use Values instead of values.
Use *Context in app.HandleFile and app.HandlePage handlers.
Refactor tests to use *Context when calling viewer Render methods

Documentation:

Update the contribution guidelines to reflect the Apache 2.0 license.
Add badges for issues and pull requests to the README.
Clarify the pronunciation of Xun in the README

sourcery-ai · 2025-02-17T14:26:38Z

Reviewer's Guide by Sourcery

This pull request updates the Viewer interface to use a *Context object in the Render method, providing access to the request and response within the viewer. It also renames the values field in the Context struct to Values and updates the contributing guidelines to reflect the correct license.

Sequence diagram for the updated rendering process

sequenceDiagram
    participant App
    participant Context
    participant Viewer
    participant ResponseWriter

    App->>Context: Creates Context
    App->>Viewer: Calls Render(ctx, data)
    activate Viewer
    Viewer->>Context: Accesses Request data
    Viewer->>Context: Accesses Response data
    Viewer->>ResponseWriter: Writes content
    deactivate Viewer

File-Level Changes

Change	Details	Files
Updated the `Viewer` interface's `Render` method to accept a `Context` instead of `http.ResponseWriter` and `http.Request`.	Modified the `Viewer` interface to include `Render(ctx Context, data any) error`. Updated all viewer implementations (`FileViewer`, `HtmlViewer`, `JsonViewer`, `StringViewer`, `TextViewer`, `XmlViewer`) to accept `Context` in their `Render` methods. Modified the `HandleFile` and `HandlePage` methods in `app.go` to pass the `*Context` to the `Render` method. Updated all viewer tests to use the new `Render` method signature.	`viewer_file_test.go` `viewer_json_test.go` `viewer_xml_test.go` `viewer_string_test.go` `context.go` `viewer_file.go` `viewer_html_test.go` `viewer_html.go` `viewer_json.go` `viewer_string.go` `viewer_text.go` `viewer_xml.go` `viewer_text_test.go` `app.go` `viewer.go`
Modified the `Context` struct to use `Values` instead of `values`.	Renamed the `values` field in the `Context` struct to `Values`. Updated the `Get` and `Set` methods in the `Context` struct to use the `Values` field.	`context.go`
Updated the contributing guidelines to reflect the correct license.	Changed the license from MIT to Apache-2.0 in the contributing guidelines.	`CONTRIBUTING.md`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding a method to the Context to return a NewResponseWriter to avoid duplication in the tests.
It looks like Context.values is now Context.Values, so update the comment to reflect this change.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

deepsource-io · 2025-02-17T14:27:34Z

Here's the code health analysis summary for commits 642af94..8c02261. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Go	✅ Success		View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

codecov · 2025-02-17T14:28:03Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.13%. Comparing base (642af94) to head (8c02261).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #50      +/-   ##
==========================================
+ Coverage   94.00%   94.13%   +0.12%     
==========================================
  Files          54       54              
  Lines        2203     2200       -3     
==========================================
  Hits         2071     2071              
+ Misses         98       96       -2     
+ Partials       34       33       -1

Flag	Coverage Δ
Unit-Tests	`94.13% <100.00%> (+0.12%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

fix(viewer): updated Viewer with (*Context,any) error

60980cc

sourcery-ai bot reviewed Feb 17, 2025

View reviewed changes

cnlangzi added 10 commits February 17, 2025 22:46

fix(viewer): wrap Context and data as ViewModel in text/html Render

6866464

chore(docs): fixed badges

a96b6e5

chore(docs): fixed badges

47349de

chore(docs): fixed badges

154cfb1

chore(docs): fixed badges

e99b8e6

chore(docs): fixed badges

0e0e726

chore(docs): fixed badges

81e9753

chore(docs): updated data bind syntax on template

b841709

fix(viewer): wrap TempData in ViewModel only

97f9807

fix(viewer): added TempData alias

8c02261

cnlangzi merged commit d37d00c into main Feb 17, 2025
7 checks passed

cnlangzi deleted the fix/viewer branch February 17, 2025 15:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

!fix(viewer): pass `*Context` into viewer.Render #50

!fix(viewer): pass `*Context` into viewer.Render #50

Uh oh!

cnlangzi commented Feb 17, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Feb 17, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

deepsource-io bot commented Feb 17, 2025 •

edited

Loading

Analysis Summary

Uh oh!

codecov bot commented Feb 17, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

!fix(viewer): pass *Context into viewer.Render #50

!fix(viewer): pass *Context into viewer.Render #50

Uh oh!

Conversation

cnlangzi commented Feb 17, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changed

Fixed

Added

Tests

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for the updated rendering process

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

deepsource-io bot commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis Summary

Uh oh!

codecov bot commented Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

!fix(viewer): pass `*Context` into viewer.Render #50

!fix(viewer): pass `*Context` into viewer.Render #50

cnlangzi commented Feb 17, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 17, 2025 •

edited

Loading

deepsource-io bot commented Feb 17, 2025 •

edited

Loading

codecov bot commented Feb 17, 2025 •

edited

Loading