rabbit-slide-kou-schoo-readable-code-2015-04 2015.4.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 375f4283c021659fa0aa9cb050066b834f92e408
+  data.tar.gz: 5578a7088b61491271240141fd4d615131389516
+SHA512:
+  metadata.gz: c20f9ac2013920950e0211b64d1b1c461cbb2c8ca1285442fb3b359953a618c3fa834e595b63f2a3faf455912f07e892eb1c3f576b130ec0e9b66fb31d1a3b3b
+  data.tar.gz: 0755f1997a03ab369158ddf0bb7b04b940bae5891a19f9c915b9490cbc1a7d3455233dc87411090b2787572d12a5b97d79af7d06d84ebed6ff1e9984f735fed6

data/.rabbit

@@ -0,0 +1 @@
+chapter-7.rab

data/README.rd

@@ -0,0 +1,32 @@
+= 名著『リーダブルコード』を解説者と一緒に読み解こう - 7章 制御フローを読みやすくする
+
+2015年4月3日（金）21:00-22:00に実施する授業の資料です。今回は「7章 制御フローを読みやすくする」を読みながら、よりよい制御フローの書き方について学びます。
+
+== ライセンス
+
+CC BY-SA 4.0
+
+原著作者名は以下の通りです。
+
+  * 須藤功平（またはKouhei Sutou）
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide-kou-schoo-readable-code-2015-04
+
+=== 表示
+
+  rabbit rabbit-slide-kou-schoo-readable-code-2015-04.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/**/*.*")
+  task.spec.add_runtime_dependency("rabbit-theme-clear-code")
+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/chapter-7.rab

@@ -0,0 +1,560 @@
+= リーダブルコードを\n読み解こう
+
+: subtitle
+   7章 制御フローを読みやすくする
+: author
+   須藤功平
+: institution
+   株式会社クリアコード
+: content-source
+   schoo
+: date
+   2015-04-03
+: allotted-time
+   40m
+: theme
+   clear-code
+
+= 質問（1）
+
+(('tag:center'))
+前回の授業は…
+
+  * A：参加した
+  * B：参加できなかった\n
+    (('note:（都合が合わなかった、知らなかったなど）'))
+  * C：知っていたが参加していない
+
+= 質問（2）
+
+(('tag:center'))
+プログラミングについて
+
+  * A：未経験
+  * B：学習中(('note:（schooや学校、独学など）'))
+  * C：趣味・仕事でたまに書く\n
+    (('note:（趣味でWebサイトを作っている、職業がデザイナーなど）'))
+  * D：趣味・仕事でバリバリ書く\n
+    (('note:（趣味でOSSを開発している、職業がエンジニアなど）'))
+
+= 質問（3）
+
+(('tag:center'))
+リーダブルコード（本）を…
+
+  * A：読んだ
+  * B：読んでいる
+  * C：まだ読んでいない
+= 内容
+
+  * 自己紹介
+  * リーダブルコードとは
+  * 実例で考えよう
+  * 実際の改善にチャレンジ！
+  * まとめ
+  * 質疑応答
+
+= 自己紹介（1）
+
+  * リーダブルコードの\n
+    「解説」の著者\n
+    (('note:http://www.clear-code.com/blog/2012/6/11.html'))
+
+= 自己紹介（2）
+
+  * クリアコードの代表取締役
+    * 「クリア」な（意図が明確な）\n
+      「コード」を大事にする\n
+      ソフトウェア開発会社
+
+= 自己紹介（3）
+
+  # image
+  # src = images/github-kou-with-annotation.svg
+  # relative_height = 100
+
+== スライドプロパティー
+
+: enable-title-on-image
+   false
+
+= リーダブルコードとは（1）
+
+  # blockquote
+  # title = はじめに p. x
+
+  本書の目的は、君のコードをよくすることだ
+
+= リーダブルコードとは（2）
+
+  # blockquote
+  # title = はじめに p. x
+
+  その中心となるのは、コードは理解しやすくなければいけないという考えだ
+
+= リーダブルコードとは（3）
+
+  # blockquote
+  # title = 1.2 読みやすさの基本定理 p. 3
+
+  「コードを理解する」というのは、変更を加えたりバグを見つけたりできるという意味
+
+= リーダブルコード
+
+読む人が…
+
+  * 変更できるコード
+  * バグを見つけられるコード
+
+(('tag:center'))(('tag:x-large'))
+↓\n
+読む人視点！
+
+= 何をしているコード？
+
+  # coderay cpp
+
+  Node* node = list->head;
+  if (node == NULL) return;
+
+  while (node->next != NULL) {
+      Print(node->data);
+      node = node->next;
+  }
+  if (node != NULL) Print(node->data);
+
+(('tag:center'))(('note:「優れた」コードって何？ p. 2より'))
+
+= 何をしているコード？
+
+  # coderay cpp
+
+  for (Node* node = list->head;
+       node != NULL;
+       node = node->next)
+      Print(node->data);
+
+(('tag:center'))(('note:「優れた」コードって何？ p. 2より'))
+
+= どちらがリーダブル？
+
+  # coderay cpp
+
+  // どちらがリーダブルコード？どうして？
+  // リーダブルコード：変更できる・バグを見つけられるコード
+  // A.
+  Node* node = list->head;
+  if (node == NULL) return;
+  while (node->next != NULL) {
+      Print(node->data);
+      node = node->next;
+  }
+  if (node != NULL) Print(node->data);
+  // B.
+  for (Node* node = list->head; node != NULL; node = node->next)
+      Print(node->data);
+
+(('tag:center'))(('note:「優れた」コードって何？ p. 2より'))
+
+= 実例で考えよう
+
+(('tag:center'))
+7章\n
+「制御フローを読みやすくする」\n
+より
+
+((' '))
+
+= 7.1 例：式の並び順（1）
+
+  # coderay c
+
+  /* A */
+  if (length >= 10)
+  /* B */
+  if (10 <= length)
+
+(('tag:center'))
+どちらがリーダブル？
+
+= 7.1 例：式の並び順（2）
+
+  # coderay c
+
+  /* A */
+  while (bytes_received < bytes_expected)
+  /* B */
+  while (bytes_expected > bytes_received)
+
+(('tag:center'))
+どちらがリーダブル？
+
+= 7.1 式の並び順の指針
+
+  * 左側
+    * 「調査対象」の式。変化する。
+    * (({length})), (({bytes_received}))
+  * 右側
+    * 「比較対象」の式。変化しにくい。
+    * (({10})), (({bytes_expected}))
+
+= 7.1 指針に沿った並び順
+
+  # coderay c
+
+  /*  ↓調査対象。変化する。 */
+  if (length >= 10)
+  /*           ↑比較対象。変化しない。 */
+  /*     ↓調査対象 */
+  while (bytes_received < bytes_expected)
+  /*                     ↑比較対象 */
+
+= 7.1 指針の理由
+
+(('tag:center'))
+自然言語の並び順に近い
+
+  # coderay c
+
+  /* もし長さが10以上なら */
+  if (length >= 10)
+
+  /* もし10が長さ以下なら */
+  if (10 <= length)
+
+= 番外：別の指針
+
+  * 左側
+    * 小さい値
+  * 右側
+    * 大きい値
+
+左から右にいくほど\n
+大きくなることは自然\n
+(('note:（例：数直線）'))
+
+= 番外：指針に沿った並び順
+
+使う比較演算子は「(({<}))」と「(({<=}))」
+
+  # coderay c
+
+  if (10 <= length)
+
+  while (bytes_received < bytes_expected)
+
+= 7.1：まとめ
+
+  * 条件式内の並び順を工夫すると\n
+    リーダブル度があがる
+  * 指針：
+    * 左側：変化する式
+    * 右側：変化しにくい式
+
+= 7.2 例：処理の順番
+
+  # coderay c
+
+  if (a == b) {   | if (a != b) {
+    /* ケース1 */ |   /* ケース2 */
+  } else {        | } else {
+    /* ケース2 */ |   /* ケース1 */
+  }               | }
+
+(('tag:center'))
+どちらがリーダブル？
+
+= 7.2 指針
+
+  * 否定形は肯定形にして書く
+    * if (!debug)よりif (debug)
+  * 単純な処理の条件を先に書く
+    * ifとelseを一望できて読みやすい
+  * 関心を引く条件を先に書く
+  * 目立つ条件を先に書く
+
+= 7.2 指針：注意
+
+  * 同時に満たせないことがある
+  * 自分で優劣を判断すること
+  * 優劣は明確になることが多い
+
+= 7.2 判断してみよう
+
+  # coderay cpp
+
+  if (!url.HasQueryParameter("expand_all")) {
+    response.Render(items);
+    // ...
+  } else {
+    for (int i = 0; i < items.size(); i++) {
+      items[i].Expand();
+    }
+    // ...
+  }
+
+= 7.2 !を外して順番を逆に
+
+  # coderay cpp
+
+  // 関心が引く条件「expand_all」を優先
+  // （肯定形になったのはおまけ）
+  if (url.HasQueryParameter("expand_all")) {
+    for (int i = 0; i < items.size(); i++) {
+      items[i].Expand();
+    }
+    // ...
+  } else {
+    response.Render(items);
+    // ...
+  }
+
+= 7.2 まとめ
+
+  * 処理する条件の順番次第で\n
+    リーダブル度があがる
+  * 指針：
+    * 否定形は肯定形にして書く
+    * 単純な条件を先に書く
+    * 関心がある・目立つ条件を先に書く
+
+= 7.5 関数から早く返す
+
+(('tag:center'))
+「ガード節」
+
+  # coderay java
+
+  public boolean Contains(String str, String substr) {
+    if (str == null || substr == null) return false;
+    if (substr.equals("")) return true;
+    // ...
+  }
+
+= 7.5 ガード節の効果
+
+  * 以降の処理が単純になる
+    * 異常値・特別値を考慮しなくてよい
+    * →考える事が減る
+  * ネストが浅くなる
+    * →コードの見通しがよくなる
+
+(('tag:center'))
+リーダブルコードにつながる！
+
+= 番外：ifとreturnの使い方
+
+(('tag:center'))
+ifとreturnの使い方\n
+ククログ(2012-03-28)\n
+(('note:http://www.clear-code.com/blog/2012/3/28.html'))
+
+((' '))
+
+= 番外：パス
+
+(('tag:center'))
+同じ処理でも流れ（パス）は違う
+
+  # coderay ruby
+
+  if 条件    | return if 条件
+    サブ処理 |
+  end        | サブ処理
+
+= 番外：パスとリーダブル
+
+  * 処理を実行するときの流れ
+  * コードを読むときの流れ
+    * 読みやすい流れにすれば\n
+      リーダブルになる！
+
+= 番外：例（1）
+
+  # coderay ruby
+
+  def add_comment(post, user, text)
+    if post.hidden_from?(user)
+      report_access_error
+    else
+      comment = Comment.create(text)
+      post.add(comment)
+    end
+  end
+
+= 番外：例（1）コメント付き
+
+  # coderay ruby
+
+  # コメントを追加するメソッドだな！
+  def add_comment(post, user, text)
+    if post.hidden_from?(user)
+      # コメント追加しないの！？
+      report_access_error
+    else
+      # ネストされているけど正常系の処理か
+      # ifの方と同列の処理かと思った
+      comment = Comment.create(text)
+      post.add(comment)
+    end
+  end
+
+= 番外：例（1）return付き
+
+  # coderay ruby
+
+  # コメントを追加するメソッドだな！
+  def add_comment(post, user, text)
+    if post.hidden_from?(user)
+      # ネストされているし特別な処理なんだな
+      report_access_error
+      return
+    end
+
+    # 通常はコメントが追加されるんだな！
+    comment = Comment.create(text)
+    post.add(comment)
+  end
+
+= 番外：例（1）まとめ
+
+  * 正常系と異常系の扱いを変える
+    * 正常系の方が重要なコード
+  * 正常系はネストしない
+    * 重要なコードは見やすい場所に
+
+= 番外：例（2）
+
+  # coderay ruby
+
+  def prepare_database(path)
+    if not File.exist?(path)
+      return Database.create(path)
+    end
+
+    Database.open(path)
+  end
+
+= 番外：例（2）コメント付き
+
+  # coderay ruby
+
+  # データベースを準備するんだな
+  def prepare_database(path)
+    if not File.exist?(path)
+      # なかったら作るのか
+      return Database.create(path)
+    end
+
+    # あったら開くのか
+    # あれ、どっちも正常系じゃない？
+    Database.open(path)
+  end
+
+= 番外：例（2）returnなし
+
+  # coderay ruby
+
+  # データベースを準備するんだな
+  def prepare_database(path)
+    if File.exist?(path)
+      # あったら開いて
+      Database.open(path)
+    else
+      # なかったら作るのか
+      Database.create(path)
+    end
+  end
+
+= 番外：例（2）まとめ
+
+  * 正常系同士の扱いを変えない
+    * 変えると異常系と勘違いしてしまう
+  * なんでもガード節にしない
+    * 特別なケースや異常系のときだけ
+
+= 他の例
+
+  * 三項演算子
+  * ネストを浅くする
+  * …
+  * （詳細は本を買ってください）
+
+= 実際の改善にチャレンジ！
+
+    TODO
+
+  * 誤解されない名前に改善して投稿
+  * よい投稿に「いいね！」して応援
+
+= まとめ（1）
+
+  * リーダブルコードとは
+    * 変更できるコード
+    * バグを見つけられるコード
+    * ↑は((*読む人視点*))
+
+= まとめ（2）
+
+  * 「読みやすい制御フロー」を\n
+    考えた
+    * 条件式内の並び順
+      * →左に変化するもの・右に変化しにくいもの
+    * 条件による処理の順番
+      * →肯定形で書く・単純な条件を先に書くなど
+    * ガード節
+      * →特別なケースはすぐにreturn
+
+= まとめ（3）
+
+  * 実際の改善にチャレンジした
+    * 「((*読む人*))が理解しやすいか？」を\n
+      とことん考えたはず
+
+  # blockquote
+  # title = 7章 制御フローを読みやすくする p. 89
+
+  鍵となる考え\n
+  行数を短くするよりも、他の人が理解するのにかかる時間を短くする。
+
+= これから（1）
+
+  * これからも((*読む人*))のことを\n
+    考えてコードを書こう
+  * ((*読む人*))のことを考えるには？
+    * 読む経験をたくさん積む
+    * たくさんコードを読もう
+
+= これから（2）
+
+  * たくさんコードを読むコツ
+    * コードから学ぶ気持ちで読む
+    * ×悪いこと探し
+    * ○いいこと探し
+    * 本来、コードを読むことは\n
+      楽しいことのはず！
+
+= 悪いコード
+
+  * 見つけやすい
+    * 異質
+    * リーダブルじゃない
+
+= よいコード
+
+  * 見つけにくい
+    * リーダブルだから
+    * すーっと理解できてひっかからない
+  * これからのチャレンジ
+    * 意識して見つけよう！
+
+= これから（3）
+
+(('tag:center'))(('tag:large'))
+「解説」を読む\n
+(('note:http://www.clear-code.com/blog/2012/6/11.html'))
+
+  * 本文：((*個人*))で\n
+    リーダブルコードを書く方法
+  * 解説：((*チーム*))で\n
+    リーダブルコードを書く方法

data/config.yaml

@@ -0,0 +1,23 @@
+---
+id: schoo-readable-code-2015-04
+base_name: chapter-7
+tags:
+- rabbit
+- readable-code
+- schoo
+presentation_date: 2015-04-03
+version: 2015.4.3.0
+licenses:
+- CC BY-SA 4.0
+slideshare_id: 
+speaker_deck_id: 
+ustream_id: 
+vimeo_id: 
+youtube_id: 
+author:
+  markup_language: :rd
+  name: Kouhei Sutou
+  email: kou@clear-code.com
+  rubygems_user: kou
+  slideshare_user: kou
+  speaker_deck_user: kou

data/images/github-kou-with-annotation.svg

@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="1003"
+   height="688"
+   id="svg2"
+   version="1.1"
+   inkscape:version="0.48.5 r10040"
+   sodipodi:docname="github-kou-with-annotation.svg">
+  <defs
+     id="defs4" />
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.7"
+     inkscape:cx="501.58384"
+     inkscape:cy="366.06296"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="956"
+     inkscape:window-height="757"
+     inkscape:window-x="2444"
+     inkscape:window-y="168"
+     inkscape:window-maximized="0"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0" />
+  <metadata
+     id="metadata7">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="レイヤー 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-280.92859,-231.57646)">
+    <image
+       y="231.57646"
+       x="280.92859"
+       id="image4540"
+       xlink:href="github-kou.png"
+       height="688"
+       width="1003" />
+    <rect
+       style="fill:#ffffff;fill-opacity:0.49803922;stroke:#a40000;stroke-width:3;stroke-linecap:round;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
+       id="rect4065"
+       width="727.14282"
+       height="107.14287"
+       x="545"
+       y="551.71924"
+       rx="5"
+       ry="5" />
+    <text
+       xml:space="preserve"
+       style="font-size:60px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Sans;-inkscape-font-specification:Sans"
+       x="576.42853"
+       y="624.57635"
+       id="text4059"
+       sodipodi:linespacing="125%"><tspan
+         sodipodi:role="line"
+         id="tspan4063"
+         x="576.42853"
+         y="624.57635">毎日コードを書いている</tspan></text>
+  </g>
+</svg>

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-kou-schoo-readable-code-2015-04
+version: !ruby/object:Gem::Version
+  version: 2015.4.3.0
+platform: ruby
+authors:
+- Kouhei Sutou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 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
+- !ruby/object:Gem::Dependency
+  name: rabbit-theme-clear-code
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 2015年4月3日（金）21:00-22:00に実施する授業の資料です。今回は「7章 制御フローを読みやすくする」を読みながら、よりよい制御フローの書き方について学びます。
+email:
+- kou@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.rd
+- Rakefile
+- chapter-7.rab
+- config.yaml
+- images/github-kou-with-annotation.svg
+- images/github-kou.png
+- pdf/schoo-readable-code-2015-04-chapter-7.pdf
+homepage: http://slide.rabbit-shocker.org/authors/kou/schoo-readable-code-2015-04/
+licenses:
+- CC BY-SA 4.0
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: "名著『リーダブルコード』を解説者と一緒に読み解こう - 7章 制御フローを読みやすくする"
+test_files: []