器用貧乏です。はげたかです。日記です。

どうも、はげたかです。今まで器用貧乏に生きてきました。ジェネラリスト・フルスタックエンジニアを目指しています。

今日の一言:カテゴリ分けをしっかりしたらPVあがるかな?

Slackに分ぽうを綴り、日報を作成する。メッセージ取得編

概要

きっかけ

Slack に分報を書こうかなと思い、せっかくだし分報をためて日報を Slack に貯めようと思った。

分報チャンネル => 日報チャンネル Slack#分報 => Slack#日報

思ったこと・感じたことを分報にし、本日分のメッセージを取得して日報にするという仕組みなのだが、作ってて必要なのか、と思い始めた。

メモ・ログみたいなのは重要だと思うのだが結局、Slack という流れるチャットに投稿するだけ…。単純に振り返りたいなら分報を見直せばよいのでは…。

Slackではなく、Evernote に貯めればよいのかな…。もう一度考え直そう。

とりあえず、Slackのメッセージを取得するまでのプログラムを書いたので共有する。

ソースコード

とりあえずテスト用なので、github にもあげるほどでもないです。

#!/bin/ruby
# Slack のメッセージを取得する

require 'slack' # gem install slack-api 
require 'json'
require 'time'

# https://api.slack.com/docs/oauth-test-tokens
SLACK_ACCESS_TOKEN = {{YOUR_ACCESS_TOKEN}}
# not channel id(C****).
# ex) general
SLACK_CHANNEL_NAME = {{YOUR_CHANNEL_NAME}}

# Slack.configure に token を設定
Slack.configure do |config|
  config.token = SLACK_ACCESS_TOKEN
end

# Message Class
class Message
  attr_reader :username, :text, :channel, :timestamp

  def initialize(obj)
    @username = obj["username"]
    @text = obj["text"]
    @channel = obj["channel"]["name"]
    @timestamp = obj["ts"]
  end

  def put_message()
    time = Time.at(@timestamp.to_i()).strftime("%T")
    "[#{time}]: #{@text}"
  end

end

# fetch_today_channel_message
# Slack API を用いて、本日のメッセージを取得する
def fetch_today_channel_message()
  client = Slack.client
  # 昨日の日付を取得 => 本日付のデータが取得できる(?)
  # API仕様がわからず
  query = "on:" + (DateTime.now - 1).strftime('%Y-%m-%d') + " "
  option = {
      :query => query,
  }
  res = client.search_all(option)
end

json = fetch_today_channel_message()
target_messages = json["messages"]["matches"].select{|k| k["type"] == "message" }

messages = []
target_messages.each do |message|
  messages.push(Message.new(message))
end

messages.select{|m| m.channel == SLACK_CHANNEL_NAME}.reverse.each do |mm|
    puts mm.put_message
end

実行結果

$ ruby slack-daily-report-for-public.rb
[11:57:19]: slack で日報を作成する
[12:30:07]: slack-api 分かりづらい。

<https://api.slack.com/methods/search.messages>

query で色々取得できるかと思ったけど、何がなんだかさっぱり。
コピペでゲットした、 `“on:2017-02-27 “ `しか使えない
[12:47:59]: そもそも、分報 =&gt; 日報にする意味、振り返るだけなら slack を見れば良いじゃないか…

仕事の日報は進捗報告だから、この分報使えないだろうな〜。

Slack入門 [ChatOpsによるチーム開発の効率化]

Slack入門 [ChatOpsによるチーム開発の効率化]

たのしいRuby 第5版

たのしいRuby 第5版

CakePHP のプロジェクトでコーディング規約に沿っているか自動チェックをする

CakePHP のプロジェクトでコーディング規約に沿っているか自動チェックをする

概要

よくプルリクエストで、コーディング規約に沿っていない箇所をご指摘頂く。コーディング規約はあらかじめ決まっているため、事前に気づくことができる。

プルリク => レビュー => 修正(コーディング規約に沿っていない箇所) => レビュー => ・・・

1サイクル(レビュー => 修正)が増えるので、当然、自分やレビュー者にも負担がかかり、時間も無駄にしてしまう。(そしてコミットログを汚すことにもなる)

ということで、コーディング規約チェッカー(PHP_CodeSniffer 2.0.0)を導入してみては?と提案いただいたので導入してみる。

ココで得られること

  • PHP_CodeSniffer のインストール
  • CakePHP 用のルールをセット
  • 簡単なカスタマイズができる(インデントに Tabを許可する)
    • Tabs must be used to indent lines; spaces are not allowed

コーディング規約一覧

PSR-0

http://www.infiniteloop.co.jp/docs/psr/psr-0.html

PSR-1

http://www.infiniteloop.co.jp/docs/psr/psr-1-basic-coding-standard.html

PSR-2

http://www.infiniteloop.co.jp/docs/psr/psr-2-coding-style-guide.html

CakePHP2

https://book.cakephp.org/2.0/ja/contributing/cakephp-coding-conventions.html

PHP_CodeSniffer 2.0.0

Composer のインストール

Composer とは、PHPのパッケージ管理ツールである。詳しくは、以下を参照すること。

http://qiita.com/atwata/items/d6f1cf95ce96ebe58010

# composer のインストール ※ 既にインストール済みの場合はSKIPすること
curl http://getcomposer.org/installer | php 

# 利用している shell の設定ファイルに環境設定を書き込み
vim ~/.zshrc

################ 以下を記述 #####################

# For Composer, Uses vendor's bin.
export PATH="$PATH:$HOME/.composer/vendor/bin"

################ ここまで #######################

# 変更した設定ファイルを読みこむ
source ~/.zshrc

CodeSniffer をインストール

composer global require "squizlabs/php_codesniffer"
composer global show --installed | grep php_codesniffer

Changed current directory to /Users/{{USER_NAME}_/.composer
You are using the deprecated option "installed". Only installed packages are shown by default now. The --all option can be used to show all packages.
squizlabs/php_codesniffer    2.8.0   PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined s...

# 使えるかチェック
phpcbf --version
PHP_CodeSniffer version 2.6.1 (stable) by Squiz (http://www.squiz.net)

CakePHP2 用のルールを取得

上記のインストールの他に、CakePHP用のコーディング規約ルールを取得しなければいけない。

https://github.com/cakephp/cakephp-codesniffer/

CakePHP2 のルールを取得するには、 update-fxer-2 を取得する。

master は CakePHP3用でPSR-2 を準拠しているため全く異なる

# 好みの場所にインストールする
# 僕の場合は、 ~/.sniffs/{{Intalled Coding Rules}}
cd ~/
curl -LO https://github.com/cakephp/cakephp-codesniffer/archive/update-fxer-2.zip
unzip update-fxer-2.zip -d sniffs
cd ~/.sniffs/

# ~/.sniffs/{{NAME}} になるので正しい名前を命名する
# ※ ここでバージョン指定{{CakePHP2}} したいが、エラーになる.><;
mv cakephp-codesniffer-update-fxer-2 CakePHP

# 削除忘れずに
rm ~/update-fxer-2.zip

取得したルールを反映させる

# 取得したルールセットを反映させる
phpcs --config-set installed_paths ~/.sniffs/                           

# 反映を確認する
phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend and CakePHP2

phpcbf -i
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend and CakePHP2

実際に使ってみよう。

phpcs --standard=CakePHP /PATH/TO/CAKEPHP_APP/app/Controller/AppController.php

----------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 5 LINES
----------------------------------------------------------------------
 33 | ERROR   | [ ] Expected 1 space before curly opening bracket
 36 | ERROR   | [x] Tabs must be used to indent lines; spaces are not
    |         |     allowed
 36 | WARNING | [ ] Possible useless method overriding detected
 36 | ERROR   | [ ] Missing function doc comment
 37 | ERROR   | [x] Tabs must be used to indent lines; spaces are not
    |         |     allowed
 37 | ERROR   | [x] Opening brace should be on the same line as the
    |         |     declaration
 38 | ERROR   | [x] Tabs must be used to indent lines; spaces are not
    |         |     allowed
 39 | ERROR   | [x] Tabs must be used to indent lines; spaces are not
    |         |     allowed
----------------------------------------------------------------------
PHPCBF CAN FIX THE 5 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

インデントのタブの指摘が多すぎる。うあああああ。

インデントにタブ利用を許可するカスタマイズする

cd ~/.sniffs/CakePHP 
cp ruleset.xml ruleset.xml.org                                                      

# 62行目の'<rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>'をコメントアウト
vim ruleset.xml

### こうする
 <!-- <rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/> -->

diff ruleset.xml ruleset.xml.org 
62c62
<  <!-- <rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/> -->
---
>  <rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>
phpcs --standard=CakePHP /PATH/TO/CAKEPHP_APP/app/Controller/AppController.php

----------------------------------------------------------------------
FOUND 3 ERRORS AND 1 WARNING AFFECTING 3 LINES
----------------------------------------------------------------------
 33 | ERROR   | [ ] Expected 1 space before curly opening bracket
 36 | WARNING | [ ] Possible useless method overriding detected
 36 | ERROR   | [ ] Missing function doc comment
 37 | ERROR   | [x] Opening brace should be on the same line as the
    |         |     declaration
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

これで、インデントのエラーが消え、本質的なコーディング規約を見ることができる。

CakePHP2 実践入門 (WEB+DB PRESS plus)

CakePHP2 実践入門 (WEB+DB PRESS plus)

CakePHPで学ぶ継続的インテグレーション

CakePHPで学ぶ継続的インテグレーション

PHPフレームワーク CakePHP 3入門

PHPフレームワーク CakePHP 3入門

あけましておめでとうございます

はじめに

あけましておめでとうございます。 昨年は、ブログを余り更新できませんでした。

目標

仕事面

  • 技術面を伸ばしていく
  • ミスを無くす
  • レガシーな運用を変えていく
  • 一つ以上何かしらを提案し実行する

プライベート

  • ブログ1ヶ月連続投稿
  • 今あるサービスを成長させていく
  • 四季に旅行行く

明日の記事は、それぞれを実行に移してく計画などを書く。

AtomユーザがPHPStormに乗り換え、PHPStormのキーマップをAtomで説明

AtomユーザがPHPStormに乗り換え、PHPStormのキーマップをAtomで説明

概要

これまでAtomユーザだったが、会社でPHPStormを買ってもらった。PHPStormは、PHPに特化したIDEである。これで捗る...と思いきや、PHPStormとAtomのショートカットの違いで少し苦戦。

ということで、本記事はAtomでよく使うショートカットキーを、PHPStormに当てはめ説明していく。

f:id:hagetak:20161118173714p:plain

基本操作

最近開いたファイルを一覧

これは便利すぎる。

Command + E

同一単語を選択

Atom でいう、「Command + D」。同一単語を編集するときにすごく便利。 変数名をあとから変える時とか、これを多用しています。

Control + G

同一単語を全選択

上のControl + G を強化したもの。一括置換的なのは危険なので、基本的に同一単語を選択しまくって、編集が多いですね。

Control + Command + G

警告の解決方法を提示

Alt + Enter

最初のうちはかなり警告が来ますが、いらない警告はどんどん無効にする。 で、この無効にする作業を含めて、すべてキーボードで完結できるのはすごく便利。

コマンドパレット的な

Atom の コマンドパレット的(Command + Shift + P)な。 Plugin のあの機能を使いたい。でもショートカットがわからないって時によく使うやつ。 補完(検索)が強力なので、基本的にこの検索で飛べますよね。

Command + Shift + A

例えば、「左に行番号ほしい」と思ったら、

  • コマンドパレットを表示

Command + Shift + A

  • それっぽいワードで検索

number

  • それっぽいワードを発見

Show: Line number

まさにそれっぽい。それを選択すると、Preferences に飛ぶので、チェックを付ける。 (Enable, Disable 選択をココでできれば最高なのだが)

git Command

Git command などもここでちゃちゃっとできますね。

検索

おなじみ

Command + F

全検索

Command + Shift + F

全検索機能が強力で、結果も一瞬でその場に飛べてプレビューできるので素敵。ただ、下の検索結果が邪魔。Escape 連打しても消えない。。。

下にコンソールとか検索結果が出てうざい

Shift + Escape

ちょっとしたTerminal を使いたい

Alt + F12

こんなん覚えられない。F12までやりたくないって場合は、コマンドパレットを使っちゃいましょう。一瞬です。

Command + Shift + A ===> terminal

編集中

定義されているメソッド・クラスの内容を確認

このメソッドってなんだっけ、何が返ってくるんだっけって時に利用。 これを使わなくても良いようなメソッド名をつけるべきだが、現実はうまくいかない。

Command + Y

リファレンス表示

きほんてきい

Control + J

コード補完

入力中補完は効きますが、一度止めてしまうと補完が効かなりますよね。 再補完させるためのショートカットキー。

Contorl + Space

(自分の環境ではSpotLight がでてきたので、Spotlight のキーボードショートカットキーを変更した。 ※ 厳密には Alfred を別のショートカットキーを使っているので、無効にした。)

やさしいPHP 第3版 (「やさしい」シリーズ)

やさしいPHP 第3版 (「やさしい」シリーズ)

アップロードされたファイルをどこまでバリデーションするか(PHP)

アップロードされたファイルをどこまでバリデーションするか(PHP

概要

CakePHP1.3プロジェクト で、アップロードされたファイルを加工する必要があった。その際、アップロードされたものをどこまでバリデーションを行うか、が問題である。

ここが長すぎたら Controller が肥大化し( ValidationClass を作っても良いが)、 簡単なバリデーションだといつか痛い目にあう。

スクリプト

簡易的ではあるが、僕は以下のようにバリデーションを行う.

class AdminController {

    /**
     * アップロードファイル([].csv)を受け取る.
     * @return 
     */
    public upload_file()
    {
        // POST 以外は受け付けない(cake1.3)
        if (empty($this->data)) {
            echo 'POST ではありません.';
            return false;
        }

        // 変数が存在しているか確認.
        // これを抜きにすると, `is_uploaded_file()` で Warning が発生
        if ( !isset($data['ThisModel']['row_file']['tmp_name']) || !isset($data['ThisModel']['row_file']['name'])) {
            echo 'ファイルが見つかりません.';
            return;
        } 

        // アップロードファイルか確認
        if ( !is_uploaded_file($data['ThisModel']['row_file']['tmp_name'])) {
            echo '不正なアップロードです.';
            return;
        }

        // アップロードファイルをゴニョゴニョ
        $uploaded_fp = fopen($this->data['ThisModel']['row_file' ]['tmp_name'], 'r');
    }
}

良いアイディアが有りましたら、コメント頂けると幸いです。

メタプログラミングとは - Rubyを例に説明

[メタプログラミング]最近良く聞く、メタプログラミングとは

最近、メタプログラミングという言葉をよく聞く。といっても、結構前からだが、意識し始めたのは最近。

メタってなんだよ、メタってと思っていた時期がありましたが、ようやくなんぞやと調べる気になった。

ruby の技術力を少しずつ上げていきたいので、ruby を例に説明する。

メタプログラミングとは

meta_programming_08.rb

class Rabbit
  class << self
    def colors
      [:black, :brown, :white, :mixed]
    end
  end
end
 
p Rabbit.colors

また、クラスメソッドを定義することは、現場のコードでしばしば見られるパターンなのに、> 実際は複雑であることも理由の一つです。Ruby初心者からすると、「class << self」のよう> なコードを見たら、ギョッとすることでしょう(私もそうでした)。

コンパイルなしに実行できる

ゲッターとセッターを自動生成

いくつものインスタンス変数があり、それぞれにゲッター/セッターを定義するのは面倒である

そこで、このメタプログラミングを用いて、(実行時に)自動生成させる

class Item
    def get_price
        @price
    end
    def set_price v
        @price = v    
    end

    def get_name
        @name
    end
    def set_name v
        @name = v        
    end
    # インスタンス変数の数だけセッターとゲッターが存在する
end
class Item
    def define_accessor *plist
        self.class.class_eval do
            plist.each do | property|
                define_method "get_#{property}" do
                    @property
                end
                define_method "set_#{property}" do |v|
                    @property = v
                end
            end
        end
    end
end

item = Item.new
item.define_accessor "price", "name", "category"
item.methods.grep(:get_price)

個人的にこれはよく書けたな、と自画自賛をしたいところだが、ネストが深い。

さいごに

ざっくりメタプログラミングというものを知った。動的にメソッドを追加することなのかな。初見では、メリットが分かりづらかったが、セッター・ゲッターの例から少し便利さを知ることができた。

こうしたほうが Ruby っぽい。こうしたほうが綺麗。テクニックなど、教えて下さい。

メタプログラミングRuby 第2版

メタプログラミングRuby 第2版

冪等性(べきとうせい)とは:新卒エンジニアが界隈の単語を調べる

冪等性(べきとうせい)とは:新卒エンジニアが界隈で有名な単語を調べる

ココ1年くらいで、冪等性(べきとうせい)という言葉を何度も聞いた。 ついに業務でもこの言葉が出てきたので、改めて意味を調べてみることにする。

冪等性とは

冪等性とは、ある操作を1回行っても複数回行っても結果が同じであることをいう概念である。

よく例にあげられるのは、i = 0i = i + 1 である。

var i = 0; // i は必ず 0 になる:冪等性が保たれる


// 実行する度に i が 1 足される。(実行回数によって、 i の値が変わってしまう)
// :冪等性が保たれない
i = i + 1 

他に例を挙げるなら、 copy も同様である。

copy a.txt b.txt # copy できた

copy a.txt b.txt # 既に b.txt があるため、copy できない overwrite b.txt? (y/n [n])

インフラと冪等性

この概念をインフラ構成に組み込んだのが、ChefAnsible などである。 システムの機能を変更するなら、サーバーをぶっ壊して、新しく作りなおすというものである。

サーバに nginx がインストールされていれば、繰り返しインストールすると、エラーが返ってくる

を何度実行しても Nginx がインストールされて起動した状態に収束し、何回も繰り返しインストールされたり、既にインストールされているからといってエラーになったりすることはありません。
ほとんどの場合、 Chef の動作は冪等性が保証されていますが、 Script や Execute などの DSL は書き方によっては冪等性が保証されないことがあります。
ですのでレシピを書く際は冪等性が保証されるように意識的に作り込んでください。

from: http://blog.schoolwith.me/chef-re-introduction/

REST と冪等性

  • GET

/show/1

API の種類にもよるが)これは、必ず ID の値が 1 のデータが返ってくる。 何度も、show/1 にリクエストを送っても、 1 のデータが返ってくる。

  • DELETE

/delete/1

id が 1 であるデータが削除される。これも冪等性が保たれる。

おわかりだろうか。

冪等とは「ある操作を何回行っても結果が同じこと」を意味する数学用語です。たとえばPUTとDELETEは冪等ですので、PUTやDELETEを同じリソースに何回発行しても、必ず同じ結果(リソースの内容が更新されている、リソースが削除されている)が得られます。
安全とは「操作対象のリソースの状態を変化させないこと」を意味します。リソースの状態に変化を与えることを副作用といいますので、安全は「操作対象のリソースに副作用がないこと」とも言います。たとえばGETには副作用がないので、GETを同じリソースに何回発行してもリソースの状態は変化しません。

http://blog.ruedap.com/2011/03/25/http-method-post-put-idempotence

Webを支える技術 -HTTP、URI、HTML、そしてREST (WEB+DB PRESS plus)

Webを支える技術 -HTTP、URI、HTML、そしてREST (WEB+DB PRESS plus)

実践編

さいごに

冪等性。冪等性を理解するのは、難しい。実際に AnsibleChef を使ってみることで、有り難みが理解できるのかな。

Chef実践入門 ~コードによるインフラ構成の自動化 (WEB+DB PRESS plus)

Chef実践入門 ~コードによるインフラ構成の自動化 (WEB+DB PRESS plus)