Create HaloModule #14
Conversation
Codecov ReportBase: 98.36% // Head: 88.34% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #14 +/- ##
=============================================
- Coverage 98.36% 88.34% -10.02%
- Complexity 30 86 +56
=============================================
Files 5 9 +4
Lines 122 309 +187
=============================================
+ Hits 120 273 +153
- Misses 2 36 +34
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
koriym
force-pushed
the
halo
branch
2 times, most recently
from
4a11d6e to
b54c032
Compare
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
The PHP versions in the continuous-integration.yml and coding-standards.yml GitHub workflow files have been updated. The old_stable version in the continuous integration file has been changed to 8.1 and 8.2, while the PHP version in the coding standards file has been updated to 8.3 to match the project's updated dependencies.
Introduced the 'madapaja/twig-module' dependency and its related data to the composer lock file. The version for 'psr/log' dependency is updated from '2.0.0' to '3.0.0'. The 'composer.json' is updated
Added PHPStan ignore comment to the XHProf profile saving line in DevInvoker.php. This change ensures that PHPStan does not inspect this line
A new file, named composer-require-checker.json, has been created. In this file, a symbol-whitelist array has been added, encompassing various preset value types and methods to ensure safer and more efficient handling of JSON data and XHPROF performance data.
This commit includes various changes such as updating the coding standard in `phpcs.xml` and removing unused imports from several files. Moreover, superfluous whitespaces and functions are deleted to improve code readability and efficiency.
This commit includes the addition of the "xhprof/xhprof" package to the composer.json file. Additionally, the package name "longxinh/xhprof" has been modified to "xhprof/xhprof". xhprof/xhprof beacuase avoid further feature BC break.
Refactored method "isDisableHalo" to "isEnableHalo" in HaloRenderer class. The change in function name is also accompanied by an update in its logic – specifically related to the condition checks and setcookie values. Furthermore, adjusted the call in the 'render' function to reflect this modification. This improves the understanding and readability of the code.
This commit includes a modification in HaloRenderer class where a new method 'setHaloCookie' checks if PHP_SAPI is 'cli' before setting the cookie. The 'render' method has also been modified to
Walkthrough概要プロジェクト全体でPHPのバージョンを更新し、新しい依存関係を追加し、古い機能を非推奨にしました。また、開発ツールとしての機能強化が行われ、新しいモジュールやテンプレートが導入されています。 変更点
Recent Review DetailsConfiguration used: CodeRabbit UI Files ignored due to path filters (4)
Files selected for processing (46)
Files skipped from review due to trivial changes (8)
Additional Context UsedLanguageTool (4)
Additional comments not posted (64)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
@suzumaze 時間経過してたのでmergeしました。(15ヶ月!) |
Halo module
A frame, called a halo, appears around the HTML representation of the resource.
The halo identifies the resource being rendered and provides tools about the resource.
The tools in the halo provide information about the resource, such as its status (Status), its representation (View), the interceptor applied to it, and so on. It also provides links to editors to resource classes and resource templates.
リソースの HTML 表現の周りには、ハローと呼ばれるフレームが表示されます。
ハローはレンダリングされているリソースを特定し、そのリソースに関するツールを提供します。
ハローのツールは、リソースの状態（Status）、表現（View）、適用されているインターセプタなどのメタ情報やプロファイル情報、リソースクラスやリソーステンプレートへのエディタへのリンクも提供します。
ライブデモ
使い方
クエリで
?halo=0とするとハローが消去され、?halo=1で表示されます。Example
「
app://self/jaを含んだpage://self/indexページ」はこのようなハローで表示されます。Status (page)
Status (app)
View
Info
Editor link
コールグラフ (要ext-xhprof + graphviz)
プロファイリングを行う場合はext-xhprof、コールグラフを描画する場合はgraphvizのインストールが必要です。
元々BEAR.Saturday, BEAR.Sunday 0.xに実装していた機能を移植しました。アイデアはオリジナルですが、SmalltalkのフレームワークSeasideで全く同じ着想の機能がありそこでは「ハロー」と呼ばれているのを知り名前を拝借しました。
この機能の目的は２つ。１つはプロジェクトを前任者から引き継いだ人がアプリケーションの構成を早く把握するようにすること。画面で表示されているリソースがどのクラスのどのテンプレートを使ったものかを把握するためです。Web画面から該当するPHPファイルやテンプレートファイルをPhpStormで開くことができます。
もう１つは、デバック用途です。状態やコールグラフなどのプロファイルに容易にアクセスできるようにします。
Summary by CodeRabbit
新機能
改善点
非推奨
バグ修正
.gitignoreに特定のディレクトリとファイルを追加し、例外として.idea/runConfigurations/を許可しました。ドキュメント