Merge pull request #77 from everyleaf/update-topics

akira888 · web-flow · commit 52ab68fb0008 · 2024-08-23T10:40:51.000+09:00
topics&#12398;&#24773;&#22577;&#12434;&#26356;&#26032;&#12377;&#12427; - debug gem&#12434;&#32057;&#20171;&#12377;&#12427;
diff --git a/docs/topics.md b/docs/topics.md
@@ -2,8 +2,6 @@
 
 &#26412;&#12489;&#12461;&#12517;&#12513;&#12531;&#12488;&#12399;&#12289;&#12459;&#12522;&#12461;&#12517;&#12521;&#12512;&#12395;&#20855;&#20307;&#30340;&#12395;&#12399;&#21547;&#12414;&#12428;&#12390;&#12356;&#12414;&#12379;&#12435;&#12364;&#12289;&#30693;&#12387;&#12390;&#12362;&#12356;&#12390;&#12411;&#12375;&#12356;&#12488;&#12500;&#12483;&#12463;&#12434;&#12414;&#12392;&#12417;&#12383;&#12418;&#12398;&#12391;&#12377;&#12290;&#29305;&#23450;&#12398;&#12473;&#12486;&#12483;&#12503;&#12395;&#21547;&#12417;&#12427;&#12371;&#12392;&#12364;&#12391;&#12365;&#12394;&#12363;&#12387;&#12383;&#35441;&#38988;&#12399;&#12371;&#12371;&#12395;&#12414;&#12392;&#12417;&#12390;&#12362;&#12365;&#12414;&#12377;&#12290;
 
-NOTE: &#27231;&#33021;&#12398;&#32057;&#20171;&#12391;&#12399;&#12394;&#12367;&#12289;&#12381;&#12428;&#12434;&#12371;&#12358;&#12356;&#12358;&#39080;&#12395;&#33391;&#12367;&#20351;&#12387;&#12390;&#12356;&#12414;&#12377;&#12392;&#12356;&#12358;&#12450;&#12503;&#12525;&#12540;&#12481;&#12391;&#12414;&#12392;&#12417;&#12383;&#12356;&#12391;&#12377;&#12290;
-
 ## git &#12395;&#38306;&#12377;&#12427;&#12488;&#12500;&#12483;&#12463;
 
 git&#12398;&#35443;&#12375;&#12356;&#35299;&#35500;&#12395;&#12388;&#12356;&#12390;&#12399;
@@ -114,44 +112,46 @@ Rails&#12398;&#12450;&#12503;&#12522;&#12465;&#12540;&#12471;&#12519;&#12531;&#12484;&#12522;&#12540;&#12395;&#31227;&#21205;&#12375;&#12390;&#20197;&#19979;&#12398;&#12424;&#12358;&#12395;&#36215;&#21205;
 $ rails c
 ```
 
-### pry &#12434;&#21033;&#29992;&#12377;&#12427;
+### debug gem &#12434;&#21033;&#29992;&#12377;&#12427;
 
-pry &#12392;&#12356;&#12358; Gem &#12434;&#21033;&#29992;&#12377;&#12427;&#12392;&#12289;&#12450;&#12503;&#12522;&#12465;&#12540;&#12471;&#12519;&#12531;&#12398;&#23455;&#34892;&#20013;&#12395;&#22909;&#12365;&#12394;&#22580;&#25152;&#12391;&#23550;&#35441;&#30340;&#12394;&#23455;&#34892;&#29872;&#22659;(REPL)&#12434;&#38283;&#12356;&#12390;&#29694;&#22312;&#12398;&#22793;&#25968;&#12398;&#29366;&#24907;&#12420;&#23455;&#34892;&#32080;&#26524;&#12434;&#24471;&#12427;&#12371;&#12392;&#12364;&#12391;&#12365;&#12427;&#12424;&#12358;&#12395;&#12394;&#12426;&#12414;&#12377;&#12290;
+debug &#12392;&#12356;&#12358; Gem &#12434;&#21033;&#29992;&#12377;&#12427;&#12392;&#12289;&#12450;&#12503;&#12522;&#12465;&#12540;&#12471;&#12519;&#12531;&#12398;&#23455;&#34892;&#20013;&#12395;&#22909;&#12365;&#12394;&#22580;&#25152;&#12391;&#23550;&#35441;&#30340;&#12394;&#23455;&#34892;&#29872;&#22659;(REPL)&#12434;&#38283;&#12356;&#12390;&#29694;&#22312;&#12398;&#22793;&#25968;&#12398;&#29366;&#24907;&#12420;&#23455;&#34892;&#32080;&#26524;&#12434;&#24471;&#12383;&#12426;&#12289;&#12522;&#12514;&#12540;&#12488;&#12487;&#12496;&#12483;&#12464;&#12364;&#12391;&#12365;&#12427;&#12424;&#12358;&#12395;&#12394;&#12426;&#12414;&#12377;&#12290;
 
-&#20844;&#24335;&#12489;&#12461;&#12517;&#12513;&#12531;&#12488;: https://github.com/pry/pry/wiki
+&#20844;&#24335;&#12489;&#12461;&#12517;&#12513;&#12531;&#12488;: https://github.com/ruby/debug/blob/master/README.md 
 
 #### Rails&#12395;&#12362;&#12369;&#12427;&#12452;&#12531;&#12473;&#12488;&#12540;&#12523;&#26041;&#27861;
 
 Gemfile &#12395;&#20197;&#19979;&#12398;&#19968;&#25991;&#12434;&#36861;&#21152;&#12375;&#12414;&#12377;&#12290;&#65288;&#38283;&#30330;&#26178;&#12395;&#12384;&#12369;&#20351;&#29992;&#12377;&#12427;&#12383;&#12417;&#12289;development &#12392; test &#29872;&#22659;&#12391;&#12398;&#12415;&#23566;&#20837;&#12375;&#12414;&#12377;&#65289;
 
 ```Ruby
 group :development, :test do
-  gem 'pry-rails'
+  gem 'debug'
 end
 ```
 
 `bundle install` &#12467;&#12510;&#12531;&#12489;&#12434;&#23455;&#34892;&#12377;&#12427;&#12392;&#20351;&#12360;&#12427;&#12424;&#12358;&#12395;&#12394;&#12426;&#12414;&#12377;&#12290;
 
-#### &#20351;&#29992;&#26041;&#27861;
-
-&#12467;&#12540;&#12489;&#12398;&#12358;&#12385;&#12289;&#29366;&#27841;&#12434;&#30906;&#35469;&#12375;&#12383;&#12356;&#37096;&#20998;&#12395;&#27425;&#12398;&#12424;&#12358;&#12395; `binding.pry` &#12434;&#35352;&#36848;&#12375;&#12414;&#12377;&#12290;
+#### &#20351;&#29992;&#20363;
 
+1. &#12487;&#12496;&#12483;&#12464;&#12375;&#12383;&#12356;&#12501;&#12449;&#12452;&#12523;&#19978;&#12391;debug&#12434;&#35501;&#12415;&#36796;&#12415;&#12414;&#12377;&#12290; 
+```Ruby
+require 'debug'
+``` 
+2. &#29366;&#27841;&#12434;&#30906;&#35469;&#12375;&#12383;&#12356;&#37096;&#20998;&#12395;&#27425;&#12398;&#12424;&#12358;&#12395; `binding.break` &#12434;&#35352;&#36848;&#12375;&#12414;&#12377;&#12290;
 ```Ruby
-def foo
-  ...
-  binding.pry
-  ...
+def parse(str)
+  binding.break
+  str.split(',')
 end
 ```
 
-&#12450;&#12503;&#12522;&#12465;&#12540;&#12471;&#12519;&#12531;&#12434;&#23455;&#34892;&#12375;&#12383;&#26178;&#28857;&#12391;&#12289; `binding.pry` &#12434;&#35352;&#36848;&#12375;&#12383;&#37096;&#20998;&#12395;&#20966;&#29702;&#12364;&#21040;&#36948;&#12377;&#12427;&#12392;&#12289;&#12381;&#12371;&#12391; REPL &#12364;&#31435;&#12385;&#19978;&#12364;&#12427;&#12398;&#12391;&#12289;&#23459;&#35328;&#28168;&#12415;&#12398;&#22793;&#25968;&#12398;&#20013;&#36523;&#12434;&#35211;&#12383;&#12426;&#12289;&#12513;&#12477;&#12483;&#12489;&#12434;&#23455;&#34892;&#12375;&#12383;&#12426;&#12391;&#12365;&#12414;&#12377;&#12290;
+&#12450;&#12503;&#12522;&#12465;&#12540;&#12471;&#12519;&#12531;&#12434;&#23455;&#34892;&#12375;&#12383;&#26178;&#28857;&#12391;&#12289; `binding.break` &#12434;&#35352;&#36848;&#12375;&#12383;&#37096;&#20998;&#12395;&#20966;&#29702;&#12364;&#21040;&#36948;&#12377;&#12427;&#12392;&#12289;&#12381;&#12371;&#12391; REPL &#12364;&#31435;&#12385;&#19978;&#12364;&#12427;&#12398;&#12391;&#12289;&#23459;&#35328;&#28168;&#12415;&#12398;&#22793;&#25968;&#12398;&#20013;&#36523;&#12434;&#35211;&#12383;&#12426;&#12289;&#12513;&#12477;&#12483;&#12489;&#12434;&#23455;&#34892;&#12375;&#12383;&#12426;&#12391;&#12365;&#12414;&#12377;&#12290;
 
 
 ### &#12525;&#12540;&#12459;&#12523;&#12395;&#12354;&#12427; Gem &#12398;&#20013;&#36523;&#12434;&#35211;&#12427;
 
 &#38283;&#30330;&#20013;&#12395;&#12450;&#12503;&#12522;&#12465;&#12540;&#12471;&#12519;&#12531;&#12391;&#20351;&#29992;&#12375;&#12390;&#12356;&#12427; Gem &#12398;&#35443;&#12375;&#12356;&#25369;&#21205;&#12434;&#30693;&#12427;&#24517;&#35201;&#24615;&#12364;&#12354;&#12427;&#12371;&#12392;&#12399;&#12424;&#12367;&#12354;&#12426;&#12414;&#12377;&#12290;
 &#12381;&#12398;&#38555;&#12395;&#12399;&#33258;&#20998;&#12398;&#12510;&#12471;&#12531;&#12395;&#12452;&#12531;&#12473;&#12488;&#12540;&#12523;&#12373;&#12428;&#12383; Gem &#12434;&#35211;&#12383;&#12426;&#12289;
-Gem &#12398;&#20013;&#12391; `binding.pry` &#12434;&#35352;&#36617;&#12375;&#12390;&#35443;&#32048;&#12394;&#12487;&#12540;&#12479;&#12398;&#27969;&#12428;&#12434;&#35211;&#12383;&#12426;&#12375;&#12390;&#25226;&#25569;&#12377;&#12427;&#12371;&#12392;&#12364;&#22810;&#12356;&#12391;&#12377;&#12290;
+Gem &#12398;&#20013;&#12391; `binding.break` &#12434;&#35352;&#36617;&#12375;&#12390;&#35443;&#32048;&#12394;&#12487;&#12540;&#12479;&#12398;&#27969;&#12428;&#12434;&#35211;&#12383;&#12426;&#12375;&#12390;&#25226;&#25569;&#12377;&#12427;&#12371;&#12392;&#12364;&#22810;&#12356;&#12391;&#12377;&#12290;
 &#12414;&#12383;&#12289;Gem &#12398;&#12467;&#12540;&#12489;&#12434;&#35501;&#12435;&#12391;&#21442;&#32771;&#12395;&#12377;&#12427;&#12371;&#12392;&#12391;&#12289;&#12467;&#12540;&#12487;&#12451;&#12531;&#12464;&#33021;&#21147;&#12434;&#30952;&#12367;&#12398;&#12395;&#12418;&#24441;&#12395;&#31435;&#12388;&#12391;&#12375;&#12423;&#12358;&#12290;
 
 bundler &#12395;&#12399;&#12289;Gemfile &#12391;&#31649;&#29702;&#12373;&#12428;&#12390;&#12356;&#12427; Gem &#12434;&#21462;&#12426;&#25201;&#12358;&#12398;&#12395;&#20415;&#21033;&#12394;&#12467;&#12510;&#12531;&#12489;&#12364;&#24190;&#12388;&#12363;&#25552;&#20379;&#12373;&#12428;&#12390;&#12356;&#12414;&#12377;&#12290;
@@ -175,7 +175,7 @@ $ export BUNDLER_EDITOR=atom
 $ bundle open rails
 ```
 
-&#12371;&#12371;&#12363;&#12425;&#12289;&#35443;&#12375;&#12367;&#35211;&#12383;&#12356;&#12467;&#12540;&#12489;&#12434;&#31934;&#26619;&#12375;&#12383;&#12426;&#12289;`binding.pry` &#12394;&#12393;&#12391;&#12487;&#12496;&#12483;&#12464;&#12467;&#12540;&#12489;&#12434;&#20837;&#12428;&#12390;&#12289;&#25369;&#21205;&#12434;&#35443;&#12375;&#12367;&#35211;&#12427;&#12371;&#12392;&#12364;&#12391;&#12365;&#12414;&#12377;&#12290;
+&#12371;&#12371;&#12363;&#12425;&#12289;&#35443;&#12375;&#12367;&#35211;&#12383;&#12356;&#12467;&#12540;&#12489;&#12434;&#31934;&#26619;&#12375;&#12383;&#12426;&#12289;`binding.break` &#12394;&#12393;&#12391;&#12487;&#12496;&#12483;&#12464;&#12467;&#12540;&#12489;&#12434;&#20837;&#12428;&#12390;&#12289;&#25369;&#21205;&#12434;&#35443;&#12375;&#12367;&#35211;&#12427;&#12371;&#12392;&#12364;&#12391;&#12365;&#12414;&#12377;&#12290;
 
 #### gem pristine
 

-Original file line number
+Diff line change
 本ドキュメントは、カリキュラムに具体的には含まれていませんが、知っておいてほしいトピックをまとめたものです。特定のステップに含めることができなかった話題はここにまとめておきます。
 -NOTE: 機能の紹介ではなく、それをこういう風に良く使っていますというアプローチでまとめたいです。
+-
 ## git に関するトピック
 gitの詳しい解説については
 $ rails c
 ```
 -### pry を利用する
 +### debug gem を利用する
 -pry という Gem を利用すると、アプリケーションの実行中に好きな場所で対話的な実行環境(REPL)を開いて現在の変数の状態や実行結果を得ることができるようになります。
 +debug という Gem を利用すると、アプリケーションの実行中に好きな場所で対話的な実行環境(REPL)を開いて現在の変数の状態や実行結果を得たり、リモートデバッグができるようになります。
 -公式ドキュメント: https://github.com/pry/pry/wiki
 +公式ドキュメント: https://github.com/ruby/debug/blob/master/README.md
 #### Railsにおけるインストール方法
 Gemfile に以下の一文を追加します。（開発時にだけ使用するため、development と test 環境でのみ導入します）
 ```Ruby
 group :development, :test do
 -  gem 'pry-rails'
 +  gem 'debug'
 end
 ```
 `bundle install` コマンドを実行すると使えるようになります。
 -#### 使用方法
+-
 -コードのうち、状況を確認したい部分に次のように `binding.pry` を記述します。
 +#### 使用例
 +1. デバッグしたいファイル上でdebugを読み込みます。
 +```Ruby
 +require 'debug'
 +```
 +2. 状況を確認したい部分に次のように `binding.break` を記述します。
 ```Ruby
 -def foo
 -  ...
 -  binding.pry
 -  ...
 +def parse(str)
 +  binding.break
 +  str.split(',')
 end
 ```
 -アプリケーションを実行した時点で、 `binding.pry` を記述した部分に処理が到達すると、そこで REPL が立ち上がるので、宣言済みの変数の中身を見たり、メソッドを実行したりできます。
 +アプリケーションを実行した時点で、 `binding.break` を記述した部分に処理が到達すると、そこで REPL が立ち上がるので、宣言済みの変数の中身を見たり、メソッドを実行したりできます。
 ### ローカルにある Gem の中身を見る
 開発中にアプリケーションで使用している Gem の詳しい挙動を知る必要性があることはよくあります。
 その際には自分のマシンにインストールされた Gem を見たり、
 -Gem の中で `binding.pry` を記載して詳細なデータの流れを見たりして把握することが多いです。
 +Gem の中で `binding.break` を記載して詳細なデータの流れを見たりして把握することが多いです。
 また、Gem のコードを読んで参考にすることで、コーディング能力を磨くのにも役に立つでしょう。
 bundler には、Gemfile で管理されている Gem を取り扱うのに便利なコマンドが幾つか提供されています。
 $ bundle open rails
 ```
 -ここから、詳しく見たいコードを精査したり、`binding.pry` などでデバッグコードを入れて、挙動を詳しく見ることができます。
 +ここから、詳しく見たいコードを精査したり、`binding.break` などでデバッグコードを入れて、挙動を詳しく見ることができます。
 #### gem pristine