rabbit-slide-kou-schoo-readable-code-2014-12 2014.12.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef138a2efa333bae81b5af0da93222988f23e601
+  data.tar.gz: 88e3eff5a8959b737fb4a5a8920816709dec1c85
+SHA512:
+  metadata.gz: 1a410b288981d8ece57cc84e3ff2d5cc53a46b0d0cb5b8441eee2505a0c56ef59f90d3a8e7b83de338f068aafe357d7f0358c90947981eeed725d5b98fd709b1
+  data.tar.gz: 08a1f6cd7202825ed273d664cace41f6eda25f55e6654a3daafe6accf47bd48c2d175ba9c67e0ec4d22ae378a2b766ec02856e9c93bcf829636a041362e4ad61

data/.rabbit

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

data/README.rd

@@ -0,0 +1,32 @@
+= 名著『リーダブルコード - より良いコードを書くためのシンプルで実践的なテクニック』を解説者と一緒に読み解こう
+
+2014年12月9日（火）21:00-22:00に実施する授業の資料です。今回は「3章 誤解されない名前」を読みながら、よい名前のつけ方について学びます。
+
+== ライセンス
+
+CC BY-SA 4.0
+
+原著作者名は以下の通りです。
+
+  * 須藤功平（またはKouhei Sutou）
+
+== 作者向け
+
+=== 表示
+
+  rake
+
+=== 公開
+
+  rake publish
+
+== 閲覧者向け
+
+=== インストール
+
+  gem install rabbit-slide-kou-schoo-readable-code-2014-12
+
+=== 表示
+
+  rabbit rabbit-slide-kou-schoo-readable-code-2014-12.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
+  # task.spec.files += Dir.glob("doc/**/*.*")
+  # task.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-3.rab

@@ -0,0 +1,316 @@
+= リーダブルコードを\n読み解こう
+
+: subtitle
+   3章 誤解されない名前
+: author
+   須藤功平
+: institution
+   株式会社クリアコード
+: content-source
+   schoo
+: date
+   2014/12/9
+: allotted-time
+   60m
+: theme
+   clear-code
+
+= 内容
+
+  * 自己紹介
+  * リーダブルコードとは
+  * 実例で考えよう
+  * 実際の改善にチャレンジ！
+  * まとめ
+  * 質疑応答
+
+= 自己紹介（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'))(('tag:large'))
+3章「誤解されない名前」\n
+より
+
+((' '))
+
+= 3.1 例：filter()（1）
+
+  # coderay python
+
+  results =
+    Database.all_objects.filter("year <= 2011")
+
+(({results}))はなに？
+
+  * 2011年以前のレコード？
+  * 2012年以降のレコード？
+
+= 3.1 例：filter()（2）
+
+  * filterはあいまいな言葉
+    * 選択する→(({select()}))
+    * 除外する→(({exclude()}))
+
+  select("year <= 2011")
+  exclude("year <= 2011")
+
+= 3.2 例：Clip()（1）
+
+    # coderay python
+
+    # textの最後を切り落として、
+    # 「...」をつける
+    def Clip(text, length):
+
+  * 最後から(({length}))文字を削除する？
+  * 最大(({length}))文字まで切り詰める？
+
+= 3.2 例：Clip()（2）
+
+切り詰めるなら：(({Clip}))→(({Truncate}))
+
+  # coderay python
+
+  def Clip(text, length):
+  # ↓
+  def Truncate(text, length):
+
+= 3.2 例：Clip()（3）
+
+((*最大*))(({length}))文字なら：(({max}))をつける
+
+  # coderay python
+
+  def Truncate(text, length):
+  # ↓
+  def Truncate(text, max_length):
+
+= 3.2 例：Clip()（4）
+
+最大(({length}))((*文字*))なら：\n
+(({length}))→(({chars}))
+
+  # coderay python
+
+  def Truncate(text, max_length):
+  # ↓
+  def Truncate(text, max_chars):
+
+= 3.3 限界値（1）
+
+ショッピングカートに入る商品が\n
+最大10点のケース
+
+  # coderay python
+
+  CART_TOO_BIG_LIMIT = 10
+
+  if cart.num_items() >= CART_TOO_BIG_LIMIT:
+      Error("カートにある商品数が多すぎます。")
+
+= 3.3 限界値（2）
+
+(('tag:center'))
+バグあり！\n
+9点までしか入らない
+
+  # coderay python
+
+  CART_TOO_BIG_LIMIT = 10
+
+  if cart.num_items() >= CART_TOO_BIG_LIMIT:
+      Error("カートにある商品数が多すぎます。")
+
+= 3.3 限界値（3）
+
+  * (({CART_TOO_BIG_LIMIT}))はあいまい
+    * 未満？以下？→境界値の情報がない
+  * (({MAX_ITEMS_IN_CARTS}))は明確
+    * この値が最大値（境界値を含む）
+    * 最大値のときは(({max}))を使おう！\n
+      (('note:（最小値のときは(({min}))）'))
+
+= 3.3 限界値（4）
+
+  # coderay python
+
+  # CART_TOO_BIG_LIMIT = 10
+  # if cart.num_items() >= CART_TOO_BIG_LIMIT:
+  #     Error("カートにある商品数が多すぎます。")
+  MAX_ITEMS_IN_CARTS = 10
+  if cart.num_items() > MAX_ITEMS_IN_CARTS:
+      Error("カートにある商品数が多すぎます。")
+
+= 他の例
+
+  * 範囲を指定するときは\n
+    (({first}))と(({last}))を使う
+  * 包括／排他的範囲には\n
+    (({begn}))と(({end}))を使う
+  * …
+  * （詳細は本を買ってください）
+
+= 実際の改善にチャレンジ！
+
+    # coderay php
+
+    /* schooの学生名一覧を返す
+       引数は返す学生名の最大値 */
+    function student($num) {
+      /* 処理の具体的な内容 */
+    }
+
+  * 誤解されない名前に改善して投稿
+  * よい投稿に「いいね！」して応援
+
+= まとめ（1）
+
+  * リーダブルコードとは
+    * 変更できるコード
+    * バグを見つけられるコード
+    * ↑は((*読む人視点*))
+
+= まとめ（2）
+
+  * 「誤解されない名前」を考えた
+    * (({filter}))はあいまい
+    * (({Clip}))もあいまい
+    * (({TOO_BIG_LIMIT}))もあいまい
+
+= まとめ（3）
+
+  * 実際の改善にチャレンジした
+    * 「((*読む人*))が理解しやすいか？」を\n
+      とことん考えたはず
+
+  # blockquote
+  # title = 3章 誤解されない名前 p. 30
+
+  名前が「他の意味と間違えられることはないだろうか？」と何度も自問自答する
+
+= これから（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-2014-12
+base_name: chapter-3
+tags:
+- rabbit
+- readable-code
+- schoo
+presentation_date: 2014-12-9
+version: 2014.12.9.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: 
+  speaker_deck_user: 

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="990"
+   height="673"
+   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="494.78333"
+     inkscape:cy="353.66125"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="956"
+     inkscape:window-height="757"
+     inkscape:window-x="2032"
+     inkscape:window-y="76"
+     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></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="レイヤー 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-293.57144,-235.86218)">
+    <image
+       y="235.86218"
+       x="293.57144"
+       id="image3269"
+       xlink:href="github-kou.png"
+       height="673"
+       width="990" />
+    <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-2014-12
+version: !ruby/object:Gem::Version
+  version: 2014.12.9.0
+platform: ruby
+authors:
+- Kouhei Sutou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-02 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: 2014年12月9日（火）21:00-22:00に実施する授業の資料です。今回は「3章 誤解されない名前」を読みながら、よい名前のつけ方について学びます。
+email:
+- kou@clear-code.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.rd
+- Rakefile
+- chapter-3.rab
+- config.yaml
+- images/github-kou-with-annotation.svg
+- images/github-kou.png
+- pdf/schoo-readable-code-2014-12-chapter-3.pdf
+homepage: http://slide.rabbit-shocker.org/authors/kou/schoo-readable-code-2014-12/
+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: "名著『リーダブルコード - より良いコードを書くためのシンプルで実践的なテクニック』を解説者と一緒に読み解こう"
+test_files: []