LIVESENSE made*

リブセンスのエンジニアやデザイナーの活動や注目していることをまとめたブログです。

MENU

4Kモニターを仕事で使い始めたらやっぱり最高だった

こんにちは、マッハバイトエンジニアの黒川です。 今日は、最近会社で買ってもらって仕事で使っている4Kモニターが最高だという話をします。 エンジニアブログというよりは商品レポートなので、お気軽に読んでいただければ幸いです。

入社時点での設備

9月に入社した時点で私には、タッチバーつきスペックマシマシのMacBook Proが支給されました(デフォルトがそれなだけで、他のが良ければもちろん任意のマシンも申請可能でした)。 またモニターはオフィスにたくさん置いてあり、好きなだけ持っていって使って良いという状態でした。

しかしそこにはちょっとした問題点がありました。モニターのサイズが少し小さくて、解像度が低かったのです。 最強のMacBook Proがあるのに、USB-C変換アダプターをぶら下げてHDの解像度のモニターで仕事をするのは、せっかくマシンに投資してもらっているのにもったいないなと思っていました。

良いモニターがほしい!

もし良いモニターがあれば、最強のMacをさらに活かし良いものを作れるはずだということで、チームリーダーに相談してみました。するとリーダーがすぐに総務に相談してくれました。 その後はチーム内で他にも4Kモニターがほしい人がいないかアンケートを取ったうえで、無事購入してもらえました。

要望を言える空気、そして前向きに検討してもらえて叶える方向で動いてもらえる空気感の弊社は最高だなと思いました。 実際仕事場にモニターが来たらさらに最高でした。

どんな感じに最高なのよ

ここからは、仕事場に新しいMacBook Proと4Kモニターがあるとどう最高なのかを説明していきます。 ちなみに買ってもらったのはLGの27UD88-Wです。

まず何より、デカい

私は今までモニターを2枚並べて使っていましたが、2枚を横に並べると横幅が大きくなりすぎて、ひと目で全体を把握できませんでした。 またその関係上、よくマウスポインターがモニター上のどこにあるかわからなくなっていました。 これらの問題を、新しいモニターはそのデカさで補ってくれます。

f:id:blackawa:20171114171906j:plain

(左: 新しいモニター / 右: オフィスによく置いてあるモニター) 新しいモニターは、オフィスに置いてあるものに比べて一回りほど大きいです。 おかげで今は、1枚の大きなモニターに情報をまとめて表示できています。

文字が潰れない

今まで使っていたモニターはサイズが小さかったので、Mac側で文字サイズを小さくしてたくさんの情報を表示できるようにしていました。 しかしそうすると新たな別の問題が発生します。それは「文字が潰れる」ということです。 まずオフィスに置いてあるモニターを、手元のiPhone SEで写真に撮ってみました。

f:id:blackawa:20171114172100j:plain

画像も粗いし、「新妻」の「妻」の字は潰れてしまっています。 文字が潰れてしまう状態で大量の文字を読むと、だんだん目が疲れてきます。

次に、新しいモニターを見てみます。

f:id:blackawa:20171114172103j:plain

ひと目で分かるレベルで画像も文字もきれいに表示できています。 カメラ越しでもこの差!実際にはもっと見やすいです。 今もこの記事を新しいモニターで書いていますが、爽快な書き心地を体験できます。 いわんや、これがソースコードなら。

なめらかな角度調節・高さ調節

オフィスに置いてあるモニターの中には、高さの調節ができるものとできないものが混在しています。 高さが調節できないと目線が常に下になるので肩や首が疲れやすくなります。 また、姿勢も悪くなってしまいます。私は身長が190cm近くあるので、余計負担が大きかったです。 新しいモニターの要件にはもちろん高さ調節機能があります。

f:id:blackawa:20171114172445g:plain

もちろんモニターの角度も片手で滑らかに変えられます。

f:id:blackawa:20171114172448g:plain

これで、体格に合った高さと角度で業務に取り掛かることができます。

さらばケーブル・アダプター地獄

最後は少しTIPS感のある良さですが、これもこれでとても良いので紹介させてください。

Mac Book Pro 2016から、外部インターフェースがUSB Type-C限定になりました。 今まで通りのHDMIやUSBケーブル、Thunderboltケーブルを使うためには、専用のアダプターが必要でした。 このアダプターだけで1万円近くかかるという、便利になったのかなっていないのかよくわからない状態でした。

しかし、新しいモニターはUSB-Cがいかに優れモノかを見せてくれます。

f:id:blackawa:20171114172609j:plain

なんとモニターとMacをUSB-Cケーブルで接続するだけで、 - 画面表示できる - 充電できる - ディプレイのUSBポートに挿したキーボードを使える

のです。 下の写真のように、モニターにUSBケーブルを接続するとあたかもMacに挿しているのと同じように使えます。

f:id:blackawa:20171114172714j:plain

これで、離席する時にはMacに挿してある1本のケーブルを抜けば良いだけです。 席に戻ってきたら再び挿せばすぐに画面が表示されて充電が始まり、外付けキーボードのHHKBで作業ができます。 おかげでテーブルのまわりのケーブルがこんなにシンプルになりました。

f:id:blackawa:20171114172755j:plain

これで離席があってもストレスなく作業を再開できそうです。

まとめ

ここまで、4Kモニターとそれを買ってくれる弊社最高という話をしてきました。 ぜひ皆様のチームでも良いマシンと良い機材を導入してみてください。 全力で集中して長い時間使うオフィスの機材が良くなるのは最高の体験です。

CircleCI 2.0でbundle updateを定期実行してみた話

こんにちは、IESHILでエンジニアをしている須貝です。
今回は先月ローンチしたIESHIL CONNECT(イエシルコネクト)の運用で、CircleCI 2.0を使ってbundle updateを自動で実行するようにした話をします。CircleCI 1.0ではなく2.0というのがちょっとしたポイントです。

ところで、みなさんCircleCI 2.0を使っていますか? 2.0では純粋なDockerベースになっていてローカルでも実行可能、より柔軟に設定を記述できる、とにかく速いなど1.0と比較すると大幅に進化しています。どんどん使っていきましょう。

やろうとした背景

そもそも何でこれをやろうとしたの?という話なんですが、 IESHIL CONNECTはIESHILとは別に新規開発したRailsアプリです。せっかくの新規開発ですから、IESHIL本体の開発では手を回せていないことをやろう、というのが個人的にやりたいことでした。たとえばLint(rubocop, slim-lintなど)をCIで実行するなどです。

そのひとつが「bundle updateを定期的に実行する」ことでした。
依存しているライブラリの更新はこまめに実行したいところですが、こうした作業はどうしても忘れがち、後回しになりがちだと思います。 しかし、後でまとめてアップデートしようとすると、動作確認などのコストが非常に大きくなり負担となってしまいます。
ですので、リリースしたての今のうちにこの作業を自動化しよう、というのが今回の背景になります。

実現したいこと

やりたいことのおおまかな流れは下の図のとおりです。

f:id:ssugai:20171025164025p:plain

今回の場合、4, 5の部分はすでに設定済みなので、図の背景が緑の部分を作っていきます。

手順

ここからは手順とポイントを簡単に解説していきたいと思います。

1. Circle CIを起動する

Circle CI 1.0の場合はCircle CIの公式ドキュメントにあるように、Parameterized Build APIを利用して、Web API経由で任意の環境変数がセットされている場合に通常のCI以外の処理を走らせる、という方法で実現することができます。
以下、1.0の場合の例(公式ドキュメントより引用)です。

test:
  post:
    - >
      if [ -n "${RUN_NIGHTLY_BUILD}" ]; then
        ./bin/run-functional-tests.sh ${FUNCTIONAL_TEST_TARGET};
      fi

ややトリッキーですね。

一方、2.0の場合はもっとシンプルです。Parameterized Builds APIを利用するのは同じですが、設定ファイルに通常のCIとは別の任意のjobを定義しておいて、そのjob名をCIRCLE_JOBというパラメータにセットしてAPIを呼び出すだけで簡単に実現できます。
以下、2.0の設定ファイル例です。

# .circleci/config.yml
version: 2
jobs:
  build: # デフォルトで実行されるjob
  ...
  hello: # 任意のjob
    docker:
      - image: circleci/ruby:2.4.2
    steps:
      - run:
          name: Hello World
          command: |
            echo 'Hello, World'

上記のような設定を.circleci/config.ymlに記述しておくと、下記のようにAPIをコールすることでCircle CI上で任意のjobを実行できるようになります。

curl \
  -X POST \
  --header "Content-Type: application/json" \
  --data '{ "build_parameters": { "CIRCLE_JOB": "hello" } }' \
  https://circleci.com/api/v1.1/project/github/:username/:project/tree/master?circle-token=:token

これをcron的なもので定期実行するわけですが、IESHIL CONNECTはHerokuを使っているのでHeroku Schedulerを使ってAPIを呼び出しています。

なお、Circle CIのAPIを利用するにはトークンが必要なので、プロジェクトのSettingsからAPI Permissionsに遷移してCreate Tokenからトークンを発行しておく必要があります。

2. Circle CI上でbundle updateを実行する

次にCircle CI上でbundle updateを実行できるようにしていきます。

# .circleci/config.yml
  bundle_update: # bundle update用のjob
    docker:
      - image: circleci/ruby:2.4.2
    ... # 中略
    steps:
      - checkout
      ... # 中略
      - run:
          name: Run bundle update
          command: |
            if [ "${CIRCLE_BRANCH}" = "master" ]; then
              bundle update
              ... # 中略
            fi

念のためmasterブランチかどうかを確認しています。

3-1. Gemfile.lockに変更があればGitHubにpushする

続いてbundle updateした結果、Gemfile.lockに変更があればGitHubにpushします。
GitHubとCircle CIを連携済みであれば簡単にpushできるのでは?と思うところですが、ここは少し設定が必要です。 なぜなら、GitHubに登録されているCircle CIのdeploy keyがread権限のみだとCircle CIからpushできないからです。
というわけでwrite権限のあるdeploy keyを新たに追加しましょう。GitHubで対象プロジェクトの SettingsからDeploy keysを選択し、Add deploy keyボタンでdeploy keyを新たに追加します。

f:id:ssugai:20171025185023p:plain

その際に、Allow write accessにチェックを入れるのを忘れずに。
deploy keyを追加したら、公式ドキュメントを参考にconfig.ymlにwrite権限のあるdeploy keyを設定します。

# .circleci/config.yml
    steps:
      - checkout
      - add-ssh-keys:
          fingerprints:
            - "xx:xx:xx:xx:xx:xx:xx:xx"
      ...

ここで注意したいのが、- add-ssh-keys:の次行のfingerprints:のインデントです。

# NG
- add-ssh-keys:
  fingerprints:
    - "xx:xx:xx:xx:xx:xx:xx:xx"

# これだと評価した結果が下記のようになってしまう。
# => [{"add-ssh-keys"=>nil, "fingerprints"=>["xx:xx:xx:xx:xx:xx:xx:xx"]}]

# OK
- add-ssh-keys:
    fingerprints:
      - "xx:xx:xx:xx:xx:xx:xx:xx"

# => [{"add-ssh-keys"=>{"fingerprints"=>["xx:xx:xx:xx:xx:xx:xx:xx"]}}]

というわけでfingerprints:- add-ssh-keys:先頭の-から半角スペース4つ下げる必要があります。 私はややハマりました。

3-2. pushが成功したらPull Requestを作成する

最後にGitHubにプルリクエストを作ります。いろいろなやり方があると思いますが、今回はGitHubのWebAPIを利用することにしました。

curl \
  --header "Accept: application/vnd.github.v3+json" \
  --data "{\"title\": \"${BRANCH}\", \"head\": \"${CIRCLE_PROJECT_USERNAME}:${BRANCH}\", \"base\":\"${CIRCLE_BRANCH}\" }" \
  https://api.github.com/repos/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}/pulls?access_token=${GITHUB_ACCESS_TOKEN}

なお、GitHubのAPIアクセストークンが必要なので取得しておく必要があります。
トークンはCircleCIの設定画面で環境変数として設定しておくと良いでしょう。私はGITHUB_ACCESS_TOKENという名前で登録しました。

最終的にできあがったconfig.yml(一部抜粋)は以下になります。

version: 2
jobs:
  build:
  ... # 中略
  bundle_update:
    docker:
      - image: circleci/ruby:2.4.2
        environment:
          TZ: "/usr/share/zoneinfo/Asia/Tokyo"
        environment:
          - RAILS_ENV=development
          - RACK_ENV=development
    working_directory: ~/ieshil-connect-dev
    steps:
      - checkout
      - add-ssh-keys:
          fingerprints:
            - "xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx"
      - run:
          name: Run bundle update
          command: |
            if [ "${CIRCLE_BRANCH}" = "master" ]; then
              bundle update
              if [ -n "`git status -sb | grep Gemfile.lock`" ]; then
                BRANCH=bundle-update-`date -u "+%Y%m%d"`
                git config --global user.email ${BOT_EMAIL}
                git config --global user.name ${BOT_NAME}
                git checkout -b ${BRANCH}
                git add Gemfile.lock
                git commit -m "Bundle update `date -u '+%Y-%m-%d'`"
                if git push ${CIRCLE_REPOSITORY_URL} ${BRANCH}
                then
                  curl \
                    --header "Accept: application/vnd.github.v3+json" \
                    --data "{\"title\": \"${BRANCH}\", \"head\": \"${CIRCLE_PROJECT_USERNAME}:${BRANCH}\", \"base\":\"${CIRCLE_BRANCH}\" }" \
                    https://api.github.com/repos/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}/pulls?access_token=${GITHUB_ACCESS_TOKEN}
                fi
              fi
            fi

Circle CI側が用意している機能を利用すればもっとスッキリと書けそうな感じもするので、改善の余地がありそうです。

実際にやってみた感想

月並みですが、「やっぱり自動化しておくと楽だなあ」という一言に尽きます。
現在は日次でbundle updateの実行をしていて、一度に更新されるgemの数も少なくそこまで負担は感じていません。

もちろん、ライブラリのアップデートをしたことが原因で不具合が発生するリスクもあります。そうしたリスクを軽減するためにもまず「テストを書く」ことが大切なのかなと思いました。今回のような仕組みを導入できたのも、高いテストカバレッジを保てていることが前提にあります。きちんとテストを書いている開発陣に感謝。

改めて今回やってみたことを書き起こして見るとそこそこ手間がかかるなあという印象もありますが、一回作ってしまったら後は非常に楽なのでぜひ試してみてください!

入社後、いきなりのサイトリニューアル

はじめに

みなさん、こんにちは。 アルバイト事業部で「マッハバイト」のフロントエンドエンジニアをやっています、山田と申します。 私は7月の頭に入社したばかりなのですが、入社後最初のミッションがサイトリニューアルでした。 今回はその話に触れていきたいと思います。

サイトリニューアルで行ったこと

リニューアルと言っても、フルスクラッチでプロダクトコードを全て書き直すわけではありません。 アーキテクチャの見直しなどは別チームが並行で進めており、僕らの行うことは画面のデザイン変更が主です。

その対応を、9/28のリリースに向けて進めていかなければいけませんでした。

その工程は困りごとの連続

作業を始めたはいいものの、その工程は困りごとの連続でした。

  • CSSの修正が想像よりもやりづらい。
  • 修正が必要な画面がどれくらいあるの把握出来ていない。
  • プロダクトコードがPHP(Symfony)とRuby(Ruby on Rails)に分離していて、戸惑う。
  • プロダクトが複雑で、一機能の仕様把握だけでもかなりエネルギーを使う。

一つずつ触れていこうと思います。

CSSの修正が想像よりもやりづらい

デザイン変更を始めて最初にぶつかった問題がこれでした。

マッハバイトはPCとSP(モバイル)でCSSが分離しています。 PCとSPのそれぞれで、CSSの設計思想が違っていたことが初期の参入コストを高めていました。

  • PC : FLOCSSベースの設計
  • SP : オリジナル設計

といった具合です。

これだけ見るとPCの方が修正しやすく思えるかもしれませんが、そうでもなかったりします。 マッハバイト(当時はリニューアル前のジョブセンスでしたが)はSPの方がユーザーが多く、 CVR向上のためのABテストが繰り返し行われてきました。そのため、設計自体は今風なPC側よりも こまめな整理がされてきたSP側の方が直しやすい場面が度々ありました。

それを踏まえつつ、以下のような方針で地道に修正を重ねました。

  • 不要物の削除
    • 使われなくなったページ、CSSがそのままになっているので消す。
  • 命名規則の統一
    • 今はハイフン区切りで運用しているが、数年前に作った古いページはキャメルケースになっている。
    • CSS用のクラス名が、JavaScriptのイベントトリガーで使われている箇所があるので分ける。
  • デバイス間の設計思想の統一
    • SPの思想を、PCに徐々に寄せていく。
  • 後回しにして放置してしまう展開を避けるため、「後で直す」をなるべくやらない。
    • 影響範囲の広い箇所も直すメリットが大きそうなら、恐れずに直す。リニューアル後になると、直しずらくなってしまう。

ありがちな話ではありますが、方針と対応を列挙してみました。 上記以外にも細かい課題はまだ残っているのですが、日々の小さな積み重ねの中で少しずつでも解決していけるように取り組みを進めています。

修正が必要な画面がどれくらいか把握出来ていない

次にぶつかった問題がこれでした。

入社して間もなかった人間が、プロダクトの機能を全て把握しているわけもなく、 画面数がどれくらいか把握しているわけでもない。 どの程度のペースで作業を進めていけばリリースに間に合うのか分からず、頭を抱えました。

しかし、この問題はすぐに解決しました。 僕の入社前に対応が必要な画面の洗い出しは既にGoogleスプレッドシートに纏まっており、 それらを片っ端からやっていけばOKという訳です。

最終的に、画面名を書いたポストイットをホワイトボードに全部張り出し、 修正が済んだらポストイットを剥がすという運用にしました。 (進捗の確認は毎日行っている夕会で各自報告し合う、というルールになっています) こうしておくことで、体の向きを少し変えるだけで残作業が一目で確認出来るようになりました。

「状況はスプレッドシートで確認出来ます」と言っても、案外見てもらえなかったりもします。 場合によっては、こうしたアナログなやり方の方が上手く機能することもあるので、今後も柔軟に考えていきたいです。

プロダクトコードがPHP(Symfony)とRuby(Ruby on Rails)に分離していて、戸惑う

マッハバイトのプロダクトコードはSymfonyとRailsが混在しています。

ジョブセンス時代は元々PHPで開発されており、それらのコードを順次Rubyに置き換えているため、 現在はそれぞれが混在している状況になっているという訳です。

「この画面のViewはPHPだけど、こっちの画面はRailsにあるSlimを触らないといけない・・」

こうした場面が度々あり、参加初期は混乱の連続でした。

PHPは経験があったので、手探りでSymfony実装に潜っていくことが出来たのですが、 Railsは数年前に少し触ったきりだったので、全く実装を追えませんでした。 そこに危機感を感じた僕は、プライベートでやっていた他言語の勉強を一旦全て中断。 PHPとRubyの学習に充てることにしました。

その甲斐もあってか、今はSlimの記法にも慣れ、 RailsのControllerの処理を追うこともなんとか出来るようになってきている実感があります。

これからもPHPやRubyに対する理解を深め、 プロダクトの改善に貢献できるように心がけようと考えています。

プロダクトが複雑で、一機能の仕様把握だけでもかなりエネルギーを使う。

長年続いている事業ならよくある話なのかもしれませんが、 以前はWeb制作の会社で働いていた僕にとっては結構な衝撃でした。

「求人を探し、バイトを見つける」

ユーザがサービス内で行う行動を言葉にするとシンプルに思えるのですが、 それを取り巻く様々な機能や仕様が存在しており、それらは長年の運用によって非常に複雑なものになっています。

サイトリニューアルを行う中で様々な画面を見て、そこに存在している事を知りました。 フロントエンド領域が僕の主戦場ではありますが、事業内で関われる領域を広げるためにも ビジネスロジックに対する深い理解は欠かせないと思うようになりました。

まとめ

3ヶ月弱の期間でサイトリニューアルをやると聞いた時は少し不安がありましたが、 周りの方々の助けを大いにアテにし、なんとか完遂することが出来ました。

今になって思えば、新参者が全画面を一通り触れたのは今後のサービス改善を進める上で 非常に有り難い機会だったとも感じています。

今後はリニューアルのタイミングで手が回らなかったCSS周りの設計整理や、TypeScriptの導入等に挑戦していく予定です。

チーム全員が知っててほしい抽象化のこと

はじめまして。転職会議ユニットでエンジニアをしている狩野です。
元々PHPerでしたが、最近はRuby(Rails)やReactを触ったりして楽しくやっています。

今回は、中堅エンジニア*1が最近受けた質問とそれに対する回答を、今までのシステム開発で得た知見と併せてブログを書きたいと思います。

はじめに

最近、若手のエンジニアから「クラスとかメソッドってどう分けるんですか?」という質問を受けました。
私は「実世界をそのまま表現するだけですよ。」と答えました。
真面目に答えたのですが、若手エンジニアには全く伝わっていないようでした*2

良い機会なので、実世界の抽象化について少し掘り下げて書いてみたいと思います。

システムとは?

基本的に、システムは「あるドメインを体系的に表現した仕組み」です。
システム開発*3とは、それを作る行為になります。

「ドメイン」とは全体の中に定義される一部の領域のことを指します。
日本語にすると「領域」です。事業を展開する領域*4と考えるのが分かりやすいです。
実際にその領域にいる人々*5に対して、我々はサービスを作って届けています。

ではどのように表現するのでしょうか。実世界は複雑です。そのまま表現はできません。ですので、モデル化(モデリング)して表現をします。
モデル化とは、抽象化のプロセスです。抽象化を行なうには知識(経験やセンス)が必要になります。
抽象化と言うと「曖昧にする」という印象ですが、寧ろ「強調したい一面を明確にする」為に抽象化を行います*6

抽象化について

例えば「人間」についてモデルを考えてみましょう。
「人間」とはなんでしょう?辞書を調べると「哺乳類、道具を使う、複雑な言語を持つ」と出てきました。「人間」を抽象化すると「哺乳類、道具を使う、複雑な言語を持つ」ということになります。
ここで疑問が生じます。例えば、生まれたばかりの赤ん坊は道具も使えないし言葉も話せません。そうなると赤ん坊はこの定義から外れます。赤ん坊は人間ではないのでしょうか。

このように、我々の行うモデルは曖昧です。
この場合、より具体的な「人間」という表現では赤ん坊は含みますが、より抽象的な「道具を使う、複雑な言語を持つ」いう表現では赤ん坊は含まないことになります。
この抽象化が絶対的な正解ということではなく、抽象化の進む方向は領域によって異なります。
対象としている領域に対して矛盾なく抽象化していくことが必要になります。

抽象化を行い、いくつかの正解(様々な解釈)の中から採用するモデルを決定します。改めて、関係する側面を抽象化して、集中するモデルを決定します。これを繰り返します。
この過程を経て、モデル化が進みシステムの表現がゴールへと向かいます。

さて、抽象化はどの程度行うべきなのでしょう。
答えは「時と場合による」です。
先にも書いたとおり、抽象化が絶対的な正解はありません。
身も蓋もないのですが、これが事実です。

よくある例えで、地図の話があります。
地図はモデルです。モデルは対象の概念を表現します。
例えば、近所のお店に行く為に世界地図を用意はしないでしょう。反対に、太平洋の航海を行う為に住んでいる街の地図を用意もしないでしょう。
近所のお店に行く時は住んでいる街が対象であり、太平洋を航海する時は世界が対象になるからです。
時と場合によって、適切な地図を使用します。

f:id:livesense-made:20171003110521p:plain:w300

適切さについて

「適切さ」こそがシステム開発の肝になります。
しかしながら、またしても身も蓋もないのですが、適切さを追い求める方法に正解は無いと思います。
ただそれで終わる訳にもいかないので、主観にはなりますが、3つほど進め方のヒントを挙げてみたいと思います。

1. サイクルを回す

適切さについて、サイクルを回して定期的に見直します。
有名なサイクルとして、PDCA(計画、実行、評価、改善)サイクルや、イテレーションの開発サイクルなどがあります。
最初から完璧な適切さを求めることはできないので、定期的に見直す必要があります。無理のない範囲で小さいサイクルで回して細かく合わせていくのが良いと思います*7
そういった意味でも、開発手法はウォータフォールよりもアジャイルが適しています。

アジャイル開発の中で、習慣的にリファクタリングを繰り返して、コードをきれいな状態に保ちます。
重要なモデルを追加すると同時に、役に立たないモデルを取り除きます。
可能な限りをコードで表現して、ドキュメントとしても価値のあるコードを書きます。コード単体で意図の伝わることが理想です。
それでも「何故」などはコードに残せないので、必要があればWhyをドキュメントとして表現します*8*9

実世界をモデル化する作業を「野球のグローブ」や「革のジャンパー」に例えた話もあります。
最初はしっくりきていなくても、使っている間に自分の手や身体に合った形に馴染んでくる例えです。
モデルも使い込んで見直していく間に蒸留されて、より適切な形になっていきます。

f:id:livesense-made:20171003111621p:plain:w300
2. コードの見通しを良くする

コードの見通しを良くすることで、適切さを維持します。
「見通し良さ」とはなんでしょう?

コメントをたくさん書けば良いという訳ではありません。寧ろ冗長になって見通しが悪くなることもあります*10
寧ろ、コメントを書かずに「シンプルに保つ」ことこそが見通しを良くする手段です。
簡単なコメントなら書かなくても伝わるようなコードを考えましょう。また、簡単なコメントを書かなければいけないのであればコードの表現が誤っている可能性があります。
先に述べたように、コメントを書かない訳ではありません。ただ、極力コメントを書かず、コード単体で意図の伝わることを目指します。

コメントは書き換えなくてもコードは動きます。
コードとコメントが密である間はまだ良いですが、改修を続けていると徐々にコードとコメントが離れていきます。
例えば、別ファイルに依存したコメントなどを書いてしまうと、その別ファイルのコードを更新した際にコメントを修正しなければいけないですが、別ファイルに記述されているコメントに気付くのはほぼ不可能です。そうなると実体を表さないコメントだけ残ることになり負債となります。

コメントも運用や保守の対象であることを認識して、コメントを書かなくても意図が伝わるコードを心掛ける必要があります。
コードの読み易さにこだわりましょう。

また、技術的な層とビジネスを表現した層を混在させないことも重要です。
責務の分割して層を分けて、見通しを維持します。
可能であれば、技術的な層はフレームワークやライブラリに任せるのが良いでしょう。
フレームワークが用意している思想に合わせると、共通の認識が持ちやすく、結果的に見通しも良くなります。
その一方で、得た知識を盲信してエンジニアの思想に閉じたコードになってしまわないよう、注意が必要です*11

オーバーエンジニアリングは柔軟性を与えてくれるように見えて、実は邪魔になることが多くあります。
適切に表現されたモデルはシンプルなものが多いです。

シンプルであることこそが、最適な抽象化です。最もシンプルな表現を心掛けます。
モデルは、それを変更しようとする別の人にとっても分かりやすくなければいけません。シンプルであれば変更も容易です。
YAGNI(You Ain't Gonna Need It.)や、KISS(Keep It Simple, Stupid.)などの法則もあります*12

3. 共通の言語を持つ

共通の言語を使うことで、適切さを正していきます。
共通の言語というのは「システムに関わる全ての人が、同じ領域においては同じ言語を使う」ということです。

このような言語は「ユビキタス言語」などと呼ばれることもあります。

一例で「あるサービスの名称」について考えてみます。
同じサービスを指す名称であっても、「サービスの商品名」「システム上でサービスを示す呼称」など、別名で呼ばれることがあります。
これらは本質的には同じものを指しているので、理想的には一致しているが望ましいです。「同じものは同じ名前を付ける」が鉄則で、脳内でのマッピングを回避できて理解しやすくなります。
しかしながら、下記に挙げるような制約で「仕方なく別名にしている」というのが現状です。

  • システム上では英語で呼ばれ、商品名は日本語で呼ばれる
  • 実体を表さない商品名
  • etc.

既存でそれなりに実体を表す共通の呼称があれば、それを採用するのが良いと思います。

良くあるのが、商品名は顧客に対する表面的な名称として使いつつ営業内で使用し、サービスの呼称はエンジニア内で使用する、という状況です。
ここで問題となるのが、商品名しか知らない営業とサービス名しか知らないエンジニアの会話です。
その解決策としては、下記に挙げる三択のいずれかになります。

  • 営業がサービスの呼称を知る
  • エンジニアが商品名を知る
  • 通訳を設ける

理想的なのは「営業がサービス名の呼称を知る」です。なぜなら、サービス名の呼称こそがそのものの実体を表現した名称になっている(はずだ)からです*13
実体を表さない商品名をエンジニアが常にキャッチアップするのは難しいです*14
通訳を設けるのであれば常にディレクターなどを同席させての会話が必要になります。

こういった前提があり、エンジニアに限らず浸透しやすく、誤解なく実体を表す命名が必要となります。
省略形の命名なども、対象となる領域で浸透していないのであれば、誤解の元となるので避けた方が良いでしょう*15

更に進んで、最初にサービスを示す呼称を決めきることは難しく、多いので時間の変化と共に見直していくのが良いです。
これは先に述べた「サイクルを回す」で対応できます。
しかしながら、技術的制約で名称変更が難しい箇所などは、最初の段階でどこまで想定して名前付けを行えるかが肝となります。

新しく定義した「user」や「status」という言葉が別の人に正しく伝わるとは限りません。
寧ろ、正しく伝わらない前提で進めるくらいが良いでしょう。
そういった観点が、より正しい言語を探す道へと続きます。

群盲象を評す」という寓話があります。
目の見えない人たちが全員で同じ象を触っているのに全員が違うことを言う、という例え話です。
サービスも目に見えないものなので、これと同じような状況にあることがあります。
全員が同じモデルを持つには、共通の言語が必要になります。

開発に着手する前に、対象を言葉で表現してみます。言葉で表現(言語化)できないものは理解できていない可能性があります。
名前付けは、運用や保守にとても重要です。寧ろモデル化の大部分は名前で決まると言っても過言ではありません。
名前がしっくりこない場合は、モデル化の構造自体を見直した方が良いでしょう。
言葉で表現できるようになってから、開発に取り掛かりましょう。

f:id:livesense-made:20171004110452p:plain:w300

進化する実世界

ここまで話して、実世界の対象となる領域をモデル化してシステム開発を進める方法は、何となくは伝わったかと思います。

しかしながら、システムは完成しません。
なぜなら、実世界は進化を続けているからです。

一般的な例として、サービス領域の拡張などがあります。
大きいものでは、任天堂が花札からビデオゲーム機に主力商品を変えたり、Amazon.comが書店から総合ECサイトになったり、などが挙げられます。
小さいものであれば、身近にも無数にあるかと思います。

VUCAという言葉があるそうで、Volatility(変動)、Uncertainty(不確実)、Complexity(複雑)、Ambiguity(曖昧)の頭文字を並べた用語です。
これはサービスの領域そのもので、システム開発でも言えます。

システムは実世界に同調し続けなければいけません。
サービスの領域について絶対的な表現は無く、その時点での最善で最適な表現を見つけます。

f:id:livesense-made:20171003112752p:plain:w300

最後に

繰り返しになりますが、実世界は複雑です。
複雑な実世界を表現する作業であるシステム開発が複雑なのは、必然です。

ここで述べたことはサービスに関わるチーム全員が考えなければいけないことであり、エンジニアだけの問題ではありません。

抽象化が進まないと、強調したい箇所が分かり難くなりモデルの表現力が弱まります。
モデルの表現力が弱まると、サービスとコードの乖離が進み、小手先の技術的な解決が増えます。
柔軟性や拡張性が失われ、要求に応えることが難しくなり、保守が難しくなります。
複雑さの泥沼にはまり込み、障害やバグの頻発する価値の薄いシステムに成り下がる末路が待っています。

良いシステムを維持し続ける為に、常に実世界と向き合って、適切な抽象化を繰り返してモデル化していく必要があります。
適切な抽象化はサービスの表現に力を与えます。

これからのシステム開発の手助けになれば、幸いです。

f:id:livesense-made:20171003133424p:plain:w300

*1:いわゆる「おっさん」です。

*2:「こいつは何を言ってるんだ?」くらいに思われた気がします。

*3:このブログでの「システム開発」は「Webサービスのシステム開発」について語っていきます。

*4:「事業ドメイン」という言葉は聞き覚えがあるかもしれません。

*5:利害関係者やステークホルダーなどを指します。

*6:要らない箇所を捨てる取捨選択の作業です。

*7:手法は合ったものを適切に取り入れましょう。手法の原理主義者になってはいけません。

*8:たまにWhatやHowをコメントに書いているコードを見掛けますが、冗長になるのでやめた方が良いでしょう。

*9:https://twitter.com/t_wada/status/904916106153828352

*10:「丁寧」と「冗長」を混同してはいけません。

*11:実世界に則さない過度な共通化などは、そのひとつです。

*12:実際のコードを書くテクニックとしては、「条件分岐は短く」「否定の否定など書かない」などありますが、ここでは割愛します。

*13:もちろん、本来であればこの命名に営業の方を巻き込めるのが最適ではあります。

*14:それでも、その商品名自体が浸透してくれば、そちらを共通の言語として使用することもあります。

*15:必要以上に省略形を使ったり、新しい語彙を増やしたがる人は、注意が必要です。

CSSは簡単だなんて誰が言った

f:id:sueshin:20170915154014p:plain はじめまして!正社員転職サービス転職ナビ(旧ジョブセンスリンク)のフロントエンドを担当しているsueshinです。
CSSはプログラミング経験の浅い方でも扱いやすく、比較的習得が早い言語だと言われることが多いと感じている次第です。
もちろん、それはCSSの素晴らしい側面の一つです。
一方で、設計のアンチパターンと言われることが、CSSでは積極的に採用され、長期の保守になると難しいという側面もあります。
今回は企業様用採用管理ツールのCSSの保守で苦戦し、リファクタリングした時のお話をいたします。
お手柔らかにどうぞ。
尚、ソースコードは一部記事に合わせて表現を変えています。

なぜCSSをリファクタリングしたの?

f:id:sueshin:20170915172411j:plain 企業様用採用管理ツールのCSSをリファクタリングする前は以下のような大きな問題を抱えていました。

管理されていないCSS

転職ナビはリブセンスの創業初期からある歴史あるプロダクトです。
デザインリニューアルだけでなく、ブランド名変更によるリブランディング等、度重なる大規模変更が過去にあり、数々の負債を抱えながら成長してきました。
そのため、非常にプロダクトが複雑で、社内用の管理ツール向けのCSSを修正すると企業様用採用管理ツールのビジュアルが崩れる等、非常に保守コストがかかっていました。
また、CSSの格納ディレクトリは全てのアプリケーションのCSSを含んでいるため、40000行を超え尚肥大化し続けています。
以下はCSSディレクトリの抜粋です。

css
├── 2009/
├── file/
├── user/
├── htmlMail/
├── lp/
├── manage/
├── pc/
├── pr/
├── sp/
├── admin/
└── blog/

意味のないファイル名

下記は企業管理画面のディレクトリツリー抜粋です。
一見、トップページ用にしか見えない命名のファイルがあらゆるページで使用されていました。
他にもページ単体で使用されているように見える命名のCSSが、多数のアプリケーション全体で使用されたまま放置されており、開発は長らく混乱していました。

manage
├── recruit/
│   ├── top.css
│   ├── works.css
│   ├── works_hint_detail.css
│   └── works_title.css
├── scout/
└── vendor/

どこにいったDRY原則

開発メンバが既存コードに合わせて実装しようとして、フロントエンドエンジニアの私に質問してくれても、そもそもの保守方針はなく、残念ながら歯切れの悪い回答しかできませんでした。
結果、開発スピードを重視して繰り返されるハードコピー。
DRY原則を意識した再利用性のあるコードを書けず、私はずっと歯がゆく思っていました。

いまどき生CSSなんか触りたくないと入社2年目の後輩にいわれた

大人でも辛くて泣きたくなる時はあります。

要約すると

f:id:sueshin:20170915172407j:plain 問題点を並べましたが、成し遂げたいことを箇条書きにするとこのようになります。

  • 他のアプリケーションを修正したらバグがでるという状況を阻止する
  • 保守方針を立てる
  • CSSからSassへ移行することで、より保守を容易にする

具体的にしたこと

f:id:sueshin:20170915172418j:plain

以下の手順で進めました。

  1. コードリーディング
  2. Sassの導入
  3. アプリケーションをまたいでいるCSSをひっぺがし
  4. 各ページ単体で使用しているCSSをそれぞれディレクトリごとに分類
  5. リンター導入
  6. README.mdを作成

1.コードリーディング

まず手始めにひたすらコードを読みました。
そうすると、読み進めていくうちに既存コードの以下のような特徴に気づきました。

  • 要素タグに対するスタイル定義がCSSファイルの上部に固まっている
  • 多くのページで呼ばれているCSSファイルに組み合わせが存在する
  • (一部のCSSファイルでは)id属性とclass属性で汎用性別に使い分けられていそう

これらを踏まえると下記のようにCSSを分類できそうだと判断しました。

  • ブラウザ定義スタイルのリセット
  • 各要素タグ毎の基本的な装飾
  • グローバルで使用できるコンポーネント定義
  • 各ページ固有のコンポーネント定義
  • ヘッダーやフッターのレイアウト定義

2.Sass導入

f:id:sueshin:20170915172355p:plain コードリーディングの結果、大多数のURLで同じ組み合わせのCSSが呼ばれていることがわかったので、これらを一つのファイル(application.scss)として再定義しました。
これらはsymfonyやRoRではレイアウトファイルに記述がまとめられていることが多いと思うので、パスの置換作業などは比較的容易かと思います。
その後、作成したapplication.scssを複数のファイルに分割しました。
分割することで数千行あるCSSの可読性を高めることが狙いです。

3.アプリケーションをまたいでいるCSSをひっぺがし

別アプリケーション名のディレクトリに存在しているCSSがあったので、ファイルをコピーして作業対象の企業管理画面では、専用のディレクトリからしかCSSをよばないようにしました。

4.CSSを使用されているディレクトリごとに分類

この作業に一番時間がかかりました。
URL別にCSSを読んでいたのですが、top.cssなのにトップページ以外からも呼ばれており、判断に迷いました。
それらも踏まえて大別すると以下の3パターンに分類できました。
※尚、各ページのパスを/module/action/と考えています。(例えばトップページなら/home/indexとなります。)

  1. 複数のmoduleで使用しているがグローバルなCSSというほどではない
    • →commonディレクトリを作成
  2. 固有のmodule内でしか使用されていない
    • →module名のファイルを作成
  3. ひとつのactionでしか使用されていない
    • →moduleディレクトリにaction名のファイルを作成

実際のディレクトリ構成です。

├── common
│   ├── company.scss
│   ├── scout.scss
│   ├── top.scss
│   ├── view.scss
│   └── works-skill.scss
├── home.scss
├── info
│   ├── help.scss
│   ├── home.scss
│   └── kiyaku.scss
├── recruit
│   ├── plan.scss
│   ├── works.scss
│   └── works-title.scss
└── detail.scss

5.リンター導入

f:id:sueshin:20170915173758p:plain 今回成し遂げたいことの一つは保守性の向上。
これを逃すと機会がないと思いやや強引ですが、ユーザー側で導入しているstylelintを導入しました。 各ファイル1行1行の修正は大変なので、ファイルごとに例外処理を追加して導入しました。

コード例

/* stylelint-disable selector-no-id, declaration-no-important  */

.test {
    color: #fff;
}

なぜ、例外処理を追加してでもリンターを導入したかというと、実装方針さえ決まっていたら、守ることが容易なルールがファイル内でさえ統一できていなかったからです。
目立ったところでいうと以下のようなルールです。

  • インデントはソフトタブかハードタブか
  • インデントの深さ
  • カラーコードは大文字か小文字か
  • 空行の有無
  • セレクタの後の半角スペース

6.README.md作成

本来はプロダクションコードからコーディングルールやクラス・ディレクトリ命名方針が類推できることが良いと思います。
ただし、今回のリファクタリングでは実装方針が定まっただけであり、コードの品質が高まっただけではないので、補足説明を手厚く書きました。

躓いたポイント

f:id:sueshin:20170915172359j:plain 上記の手順を立て、リファクタリングを進めましたがスコープがあまりにも大きく、何度もつまずきました。
以下は躓いたポイントです。

1.CSSハック

設定を変更したら、変更できたのかもしれませんが、どうやらSCSSにも許せないCSSハックがあるようでした。
私はWEBを覚えて浅いこともあり、ブラウザ対応はIE8からしか対応したことがありません。
既存コードがどういった目的でCSSハックをしているのか、わからない記述も多かったです。
調べても中々良い情報に出会えず途方に暮れている中、信じられそうな情報に出会えた時は感動しました。

具体例としては、下記のようなスラッシュハックを

#footer {
  /zoom: 0;
}

こちらのアスタリスクハックに変更することで

#footer {
    *zoom: 0;
}

無事CSSへのプリコンパイルができました。

2.CSSファイルパスの変更

ファイルのパスを変えてCUIで一括置換していたのですが、以下のコードが存在する可能性が有るためにリファクタリング中の不安は拭えませんでした。

<link rel="stylesheet" type="text/css" href="<?php echo(''/css/manage/' . $val . '.css''); ?>">

このようにgrepしても検索にヒットしないファイルの存在による置換もれをどのように対応するかは最後まで悩みました。
他にいい方法が合ったのかもしれませんが、最終的に私はPHPディレクトリのCSSという文字列を全部grepして目視して確認しました。

3.CSS最大の難関、詳細度戦争

世界各地で問題になっているCSSの詳細度がやはり頭痛の種でした。
今回迷ったのは以下のような場合です。 例えばこのようなコードがあったとします。

//1
.modal {
    color: #aaa;
}
//2
#top-modal {
    color: #bbb;
}
//3
#container .modal {
    color: #ccc;
}
//4
.detail-modal {
    color: #ddd;
}

1のmodalと2のtop-modalの順番を変更した場合デザインに影響がある可能性はあるのでしょうか?

//2
#top-modal {
    color: #bbb;
}
//1
.modal {
    color: #aaa;
}
//3
#container .modal {
    color: #ccc;
}
//4
.detail-modal {
    color: #ddd;
}

答えは「可能性はない」です。
では、1のmodalを4のdetail-modalの下に変更した場合デザインに影響がある可能性はあるのでしょうか?

//2
#top-modal {
    color: #bbb;
}
//3
#container .modal {
    color: #ccc;
}
//4
.detail-modal {
    color: #ddd;
}
//1
.modal {
    color: #aaa;
}

答えは「可能性はある」です。
幸いID属性とクラス名は飛び飛びで固まっていたため、セレクタがID属性同士、class属性同士で順番を変更しないように整理しました。 可読性はあまりよくないですが、デグレーションを避けるため順番はできるだけ変えないようにしました。 application.scssの例

@import "layout/header";
@import "layout/container";
@import "layout/aside";
@import "layout/footer";
@import "object/project/modal";
.clearfix {
    *zoom: 1;
}
.clearfix:after {
    content: '';
    display: block;
    clear: both;
}
@import "object/project/tooltip";
@import "object/project/link";
@import "object/utility/margin";
ul.modBtn,
.modInfo dl {
    *zoom: 1;
}
ul.modBtn:after,
.modInfo dl:after {
    content: '';
    display: block;
    clear: both;
}

4.ユーティリティクラスがユーティリティじゃない

ユーティリティクラスとして定義されているけど、実際に使われていないユーティリティクラスをどのように分類していいか非常に悩みました。

.txtRed {
    color: #f44336;
}
.txtOrange {
    color: #f60;
}
.txtGreen {
    color: #53acac;
}
.txtGray {
    color: #999;
}

これらは開発メンバの誰も知らないクラスです。
ユーティリティクラスとして分類しても、開発メンバが余計に混乱すると考え、ユーティリティクラス専用のディレクトリに分類しませんでした。

5.リンター導入の作業は地道でした

一部例外処理として設定しましたが、可能な限りリンターのルールに違反する箇所は修正しました。
膨大なソースコードのカラーコードを小文字にしたり、ソフトタブとハードタブを統一したりと地味に膨大なコストがかかってしまいました。
守ってくれたら儲けものと思って、アプリケーションを作った際は、コーディング規約を真っ先に導入すべきだと思いました。

そしてリリース!!

f:id:sueshin:20170915165124j:plain やりました。
もう後輩にCSSなんか触りたくないなんて言われません。
数々の困難と組織的な諸事情もあり最初のコミットからリリースまで1年以上経ってしまい、隣の島にいた後輩はもう近くにはいませんが。。。
でも、問題ございません。
我々が欲しいのはハッピーエンドではなく、鍛え抜かれたハッピーマインドなのだから。(*1)

まとめ

f:id:sueshin:20170915172423j:plain

  • 学び
    • 古くなった情報でも、レガシーコードを改善する上で役に立つことがある
  • 課題
    • フロントエンドエンジニア以外には改善が実感しにくいリファクタリングになってしまった
    • 大規模改修になるため画面チェックにコストがかかってしまった
  • 効果
    • 今ならあまり心を痛めること無くレビューができる気がします。
    • ソースコード量の減少に向けて舵を切ることができた。
    • 企業管理画面を修正するとリブセンス用のツールでエラーがでるということはありません
    • 現状を整理できたことで、開発メンバの学習コストがへった。
    • 新しい開発メンバが入ってくる度に怯えなくていい

さいごに

f:id:sueshin:20170915172403j:plain このリファクタリングを進める上で、チームメンバは勿論のこと、沢山のサイトや書籍に助けられました。
特にCSSハックに対する知見を共有しているサイトを夜中に見つけたときは、本当に感動しました。
この記事が少しでも負債と戦うエンジニアの助けになれば幸いです。

*1: 元ネタは矢沢あい著「ご近所物語」です