rabbit-slide-nishidayuya-2023-09-16-matrk10-permanent_uri_and_dpu 2023.9.16.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf601a9b2e63bceb6aaab76c3ae42abcefd87706df377d2d2594621d42dcfd6d
+  data.tar.gz: cf4b24c066617269f1fc850cee179c924a9b121511fb7b4783251139558cb5bb
+SHA512:
+  metadata.gz: 1f8294ac43cdc65babb8c4f2a7e0b15f7b670f936a25e44912e43d413577e9742cad462b781faedc6cbfe661246c8b3dbbe4e53a56a48dfc5dda08204ade616f
+  data.tar.gz: f2d8cc9491c11ee0c3b2b691ce4c2d5ebe69c02ac3f30192b34c521c06126fd4dee56464743206b3ece3c8a0f19e39ed6432539af4f812732540f9d96cd1c117

data/.rabbit

@@ -0,0 +1,2 @@
+--size 1368,768
+permanent_uri_and_dpu.md

data/README.md

@@ -0,0 +1,27 @@
+# ソースコード参照URIの考察と作成したツールの紹介
+
+2023-09-16に開催された[松江Ruby会議10](https://matsue.rubyist.net/matrk10/)での発表資料
+
+---
+
+ソースコードを参照するURIは，ブランチ名を使ったものよりもコミットIDを使ったもの（permalink）がよく，さらにはタグ名を使ったものがより望ましいと考える．本発表ではその説明と作成したツールの紹介を行う．
+
+## 作者向け
+
+### 表示
+
+    rake
+
+### 公開
+
+    rake publish
+
+## 閲覧者向け
+
+### インストール
+
+    gem install rabbit-slide-nishidayuya-2023-09-16-matrk10-permanent_uri_and_dpu
+
+### 表示
+
+    rabbit rabbit-slide-nishidayuya-2023-09-16-matrk10-permanent_uri_and_dpu.gem

data/Rakefile

@@ -0,0 +1,17 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  # spec.files += Dir.glob("doc/**/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+  # spec.add_runtime_dependency("rabbit-theme-YOUR-THEME")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/config.yaml

@@ -0,0 +1,24 @@
+---
+id: 2023-09-16-matrk10-permanent_uri_and_dpu
+base_name: permanent_uri_and_dpu
+tags:
+- CC-BY-4.0
+presentation_date: '2023-09-16'
+presentation_start_time:
+presentation_end_time:
+version: 2023.9.16.0
+licenses: []
+slideshare_id:
+speaker_deck_id:
+vimeo_id:
+youtube_id:
+width: 1368
+height: 768
+source_code_uri:
+author:
+  markup_language: :markdown
+  name: Yuya.Nishida.
+  email:
+  rubygems_user: nishidayuya
+  slideshare_user:
+  speaker_deck_user: nishidayuya

data/permanent_uri_and_dpu.md

@@ -0,0 +1,254 @@
+# ソースコード参照URIの考察と作成したツールの紹介
+
+author
+: 西田雄也
+
+date
+: 2023-09-16
+
+allotted-time
+: 20m
+
+theme
+: lightning-simple
+
+start-time
+: 2023-09-16
+
+end-time
+: 2023-09-16
+
+# 自己紹介
+
+- 西田雄也 ネットワーク応用通信研究所
+- GitHub: [https://github.com/nishidayuya](https://github.com/nishidayuya)
+- X（旧Twitter）: [https://twitter.com/nishidayuya](https://twitter.com/nishidayuya)
+- なにかツールを作るのが趣味
+    - [git-cococo](https://github.com/nishidayuya/git-cococo): Gitの作業ディレクトリ上で実行したコマンドによる変更をコミットメッセージに残しながらコミットするコマンド
+    - [img_to_pdf](https://github.com/nishidayuya/img_to_pdf): 画像ファイルを大きく印刷するために複数ページのPDFにするコマンド
+    - [redmine_ruby_wasm](https://github.com/nishidayuya/redmine_ruby_wasm): Redmineに書いたRubyのコードを実行
+    - [dpu](https://github.com/nishidayuya/dpu): 今日紹介するもの
+
+# では
+
+# 想像してください
+
+# 想像してください
+
+- とあるウェブサービスのクライアントプログラムの改修をしていました．
+- POSTする際のデフォルトのタイムアウト時間は60秒でした．
+- なぜ60秒であるのか．
+- 調べたところ，あるpull-requestに辿り着きました．
+
+# 悲劇
+
+# 参照先のURIが見当違い
+
+# なぜでしょうか
+
+# なぜでしょうか
+
+- コメントが書かれた当時(2021-01-07)は合っていた ✨
+
+↓
+
+- 対象リポジトリの開発が進んだ 🎉
+- 当該コードの行番号が変わった 👀
+
+↓
+
+- コメントはそのままのため，不適切な位置になった 😭
+
+# 発生する場面
+
+今回はpull-requestのコメントでした
+
+- ソースコード上のコメント
+- X（旧Twitter）のポスト
+- ブログ記事
+- ...
+
+↓
+
+ソースコードを参照するURIを書く全ての場面
+
+# そうすると
+
+# どうすれば良かったのか
+
+# どうすれば良かったのか
+
+- ブランチ名によるURI
+    - https://github.com/ruby/ruby/blob/master/lib/net/http.rb#L690
+    - 　　　　　　　　　　　　　　　　　↑↑↑↑ここ
+
+# どうすれば良かったのか
+
+- ブランチ名によるURI
+    - https://github.com/ruby/ruby/blob/master/lib/net/http.rb#L690
+    - 　　　　　　　　　　　　　　　　　↑↑↑↑ここ変える
+
+↓
+
+- コミットIDかタグを元にしたURIにする
+    - https://github.com/ruby/ruby/blob/4d0985a7bd8f591dff4b430e288bfd83af782e51/lib/net/http.rb#L690
+- masterブランチに新しいコミットが積まれてもそのままでOK！ 🎉
+
+# GitHub.comの場合
+
+# GitHub.comの場合
+
+- 三点リーダークリック→「Copy permalink」クリック
+    - y C-l C-cでコピーしても良い
+
+![](github_copy_permalink.png){:relative_height='90'}
+
+- コミットIDを元にしたURIが得られる！
+
+# 解決
+
+# でも...
+
+# でも...
+
+- いちいちウェブブラウザ上でソースコードを参照するのは面倒
+    - テキストエディター上で読むことが多いため
+- 手でURIを作るのも面倒
+
+↓
+
+- 手元のテキストエディターからサクッとURIを取得したい．
+
+↓
+
+# エディターの拡張を書こう
+
+# エディターの拡張を書こう
+
+- 自分が使うテキストエディター
+    - Emacs: 普段使い
+    - Textbringer: 軽い編集時
+    - Vim: sudoで編集するとき
+    - Visual Studio Code: ペアプロ・モブプロ時にLiveShare
+
+↓
+
+- いっぱいある
+
+# エディターの拡張を書こう
+
+- 自分が使うテキストエディター
+    - Emacs: Emacs Lispで書く
+    - Textbringer: Rubyで書く
+    - Vim: Vim scriptで書く（らしい）
+    - Visual Studio Code: TypeScriptやJavaScriptで書く
+
+↓
+
+- URIを決定するのはRubyで書いて各拡張から呼びだそう！
+
+# デモ
+
+# dpu.gem: determine permanent URI
+
+- `gem install dpu`
+- https://github.com/nishidayuya/dpu
+- タグを使ったURIを生成するメソッドとコマンド
+    - 最新20タグ以内に同一内容のファイルがなかったらコミットIDを使う．
+
+↓
+
+- ブランチURIの悲劇は起こさない．
+
+# dpu.gem
+
+- なぜタグを使うか．
+- 短い
+    - https://github.com/ruby/ruby/blob/v3_0_0/lib/net/http.rb#L690
+    - https://github.com/ruby/ruby/blob/4d0985a7bd8f591dff4b430e288bfd83af782e51/lib/net/http.rb#L690
+- 動いているプログラムの調査をするときは，
+  動かしているバージョンのソースコードを調べる．
+    - URIを見ただけでバージョンが明らか
+
+# dpu.gem
+
+対応しているSCMのサービス
+
+- GitHub.com
+- sourcehut
+    - pull-requestいただきました
+- (GitLab.com)
+
+# dpu.gem - EmacsとTextbringer
+
+- https://github.com/nishidayuya/dpu に設定方法
+- Emacs
+    - .emacsに書いて使う
+- Textbringer
+    - .textbringer.rbに書いて使う
+    - 直接dpu.gemのメソッド呼び出しをしている．
+
+# dpu.gem - Vim
+
+- 自分がVim scriptわかってない
+- sudoで編集するときなので作っていない
+
+↓
+
+- どなたか作られましたらご連絡ください！
+
+# dpu.gem - Visual Studio Code
+
+- Marketplaceに出してます
+    - [Copy permanent URL](https://marketplace.visualstudio.com/items?itemName=nishidayuya.copy-permanent-url) で検索
+    - https://marketplace.visualstudio.com/items?itemName=nishidayuya.copy-permanent-url
+- 2023-09-15時点のインストール数は脅威の
+
+# dpu.gem - Visual Studio Code
+
+- Marketplaceに出してます
+    - [Copy permanent URL](https://marketplace.visualstudio.com/items?itemName=nishidayuya.copy-permanent-url) で検索
+    - https://marketplace.visualstudio.com/items?itemName=nishidayuya.copy-permanent-url
+- 2023-09-15時点のインストール数は脅威の
+    - ![](vscode_marketplace_copy_permanent_url.png){:relative_height="130" :align="right" :relative_margin_right="-5"}
+
+# dpu.gem - Visual Studio Code
+
+- ruby.wasmを同梱して呼び出そうと考えた．
+
+↓
+
+- dpu.gemのインストールをしなくても
+  拡張をインストールしたら使えるように
+- （Rubyが入っていないとしてもすぐ使える）
+
+# dpu.gem - Visual Studio Code
+
+- ruby.wasmを同梱して呼び出そうと考えましたが...
+
+↓
+
+- dpu.gemは中でGitのコマンドを実行する．
+- https://github.com/ruby/ruby/blob/a1dc1a3de9683daf5a543d6f618e17aabfcb8708/wasm/README.md#current-limitation より
+    - Spawning a new process is not supported. e.g. Kernel.spawn and Kernel.system
+- ruby.wasmの下にあるwasi libcをコマンド実行に対応させる必要がありそう...→調査できてない
+
+# 類似ソフトウェア
+
+- Emacs
+    - [git-link](https://github.com/sshaw/git-link): https://github.com/sshaw/git-link
+- Vim
+    - [vim-github-link](https://github.com/knsh14/vim-github-link): https://github.com/knsh14/vim-github-link
+- Visual Studio Code
+    - [GitHub Pull Requests and Issues](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github)
+    - [vscode-copy-github-permalink](https://marketplace.visualstudio.com/items?itemName=hogashi.vscode-copy-github-permalink)
+    - [Copy GitHub URL](https://marketplace.visualstudio.com/items?itemName=mattlott.copy-github-url)
+
+# まとめ
+
+- ブランチへのURIは古くなる→やめよう
+- タグまたはコミットIDを使ったURIを使う
+- ツールもあるよ！
+- スターはこちら→[https://github.com/nishidayuya/dpu](https://github.com/nishidayuya/dpu)
+
+![](qrcode_dpu_repository.png){:relative_height="130" :align="right" :relative_margin_right="-5"}

data/script.md

@@ -0,0 +1,43 @@
+
+
+## 未送信
+
+はい、そうすると，「ソースコード参照uriの考察と作成したツールの紹介」ということで、ネットワーク応用通信研究所の西田がしゃべります．
+
+## 未送信
+
+はい、とりあえず自己紹介というところで，GitHub.comとX旧Twitterのアカウントはこれです．
+自分は何かしらのツールを作るのが趣味で、例えばRailsのgenerator生成したコードは，もうそれだけでコミットして，そうじゃない部分のレビューをしたいので，そのためのコマンドラインプログラムを書いたりだとか，自分の娘の写真をでっかく印刷したいので、あの複数ページのPDFにするようなプログラムを書いたりとか，、あとは今日の紹介するツールとかを書いたりしていまう．
+自己紹介はそんなところでちょっと中に入りましょう．
+
+## 未送信
+
+ということでちょっと想像してみてください。
+今、あなたはとあるWebサービスのクライアントプログラムの改修をしています．
+で、POSTする際のタイムアウト時間のデフォルトが60秒でした。
+しかし、なぜ60秒なのか、ちょっと調べたところ，pull-requestに辿り着きました。 
+
+うん、これがそのクライアント部分の実装を行ったpull-requestだ．
+デフォルトのタイムアウト時間60秒ってのはそうそう、ここですね．
+これなんで60秒なんだっけ？
+おお，ちゃんとコメントが書いてある．えーと何々，
+<読み上げ>．
+なるほどなるほど．
+で、これがその根拠になったソースコードのURLなんですね。
+Rubyのリポジトリのこのファイルの697行目でこれを判断したと．
+本当にそうなの?一応このコードを見ておこうっとー．
+クリック，クリックー．ポチ．
+ええ?!
+
+皆々様はこのようなご経験はないでしょうか？ 
+
+## 未送信
+
+はい。 
+
+一体何が起こったんでしょうか？
+
+## 未送信
+
+ってしまったのです．
+

data/setup.md

@@ -0,0 +1,72 @@
+# 準備
+
+## 画面1
+
+### スライド
+
+```console
+bundle exec rake &
+```
+
+F11での全画面とウィンドウのトグル
+
+### 端末
+
+C-+を7回
+
+Tmux上で最後のセッション
+
+ディレクトリは以下
+
+- rabbit ~/private/presentations/2023-09-16
+    - `bundle exec rake &`
+- ruby_matrk10 ~/src/github.com/nishidayuya/test_202309_3_matrk10_ruby
+
+### ブラウザ
+
+#### pull-request
+
+https://github.com/nishidayuya/test_202309_1_matrk10_sample/pull/2/files を表示して次のJavaScriptを実行して投稿した日付を見かけ上，変える．
+
+```js
+[...document.querySelectorAll('relative-time[datetime]')].forEach((node) => node.setAttribute('datetime', node.getAttribute('datetime').replace(/.*T/, '2021-01-07T')))
+```
+
+200%で開いておく．
+
+#### ruby/rubyのfork
+
+https://github.com/nishidayuya/test_202309_3_matrk10_ruby
+
+#### pull-request改
+
+https://github.com/nishidayuya/test_202309_1_matrk10_sample/pull/3/files を表示して同様のJavaScriptを実行する．
+
+## 画面2
+
+### ブラウザ
+
+- 空のURI
+
+### Emacs
+
+`emacsclient -c`で起動
+
+以下をそれぞれC-x C-0で+を5回
+
+- ~/src/github.com/nishidayuya/test_202309_3_matrk10_ruby/lib/net/http.rb
+- `*Messages*`
+    - 2行程度表示できる高さ
+
+## 画面3
+
+### ブラウザ
+
+- 空のURI
+
+### Visual Studio Code
+
+C-+を4回ぐらい
+
+- ~/src/github.com/nishidayuya/test_202309_3_matrk10_ruby/lib/net/http.rb
+    - 開く

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-nishidayuya-2023-09-16-matrk10-permanent_uri_and_dpu
+version: !ruby/object:Gem::Version
+  version: 2023.9.16.0
+platform: ruby
+authors:
+- Yuya.Nishida.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: |-
+  2023-09-16に開催された[松江Ruby会議10](https://matsue.rubyist.net/matrk10/)での発表資料
+
+  ---
+
+  ソースコードを参照するURIは，ブランチ名を使ったものよりもコミットIDを使ったもの（permalink）がよく，さらにはタグ名を使ったものがより望ましいと考える．本発表ではその説明と作成したツールの紹介を行う．
+email:
+-
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.md
+- Rakefile
+- config.yaml
+- github_copy_permalink.png
+- pdf/2023-09-16-matrk10-permanent_uri_and_dpu-permanent_uri_and_dpu.pdf
+- permanent_uri_and_dpu.md
+- qrcode_dpu_repository.png
+- script.md
+- setup.md
+- vscode_marketplace_copy_permanent_url.png
+homepage: https://slide.rabbit-shocker.org/authors/nishidayuya/2023-09-16-matrk10-permanent_uri_and_dpu/
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: ソースコード参照URIの考察と作成したツールの紹介
+test_files: []