「コード」カテゴリーアーカイブ

Rails のアプリケーションで Cells gem を 3.11.3 から 4.0.2 にアップグレードしました。一緒に Rails も 4.1.9 から 4.2.4 にアップグレードしました。ここでは Cells についてやったことを書きます。

基本的なやり方は From Cells 3 to Cells 4 Upgrading Guide に説明がありますのでご参照ください。バージョン 4 に変更するのは結構大変です。

環境

Ruby 2.2.3
テンプレートエンジン: Slim

経緯

ある人が外注に出していたプログラムをなぜか私がデザイン、マークアップ含めて更新することになり、 Rails と Gem のバージョンを更新しました。

その Rails のアプリケーションにテストコードは一切ありませんでした。

リリース前のプログラムに対して変更を行いました。

やったこと

ApplicationCell 作成
helper を include に変更
render_cell を cell に変更
ファイル名変更
app/views 内のテンプレート呼び出し部分を変更

ApplicationCell 作成

cell のテンプレートの中で device 関連のメソッドを使っていたり、フォームタグ関連のメソッドを使っていると途端に動かなくなります。そこで、 ApplicationCell を作成して全ての Cell がそれを継承するように変更しました。

アプリケーションを見ながら次のような ApplicationCell を作りました。 include で取り込んでいるモジュールは、エラーが出る度に順次取り込んでいったものです。

class ApplicationCell < Cell::ViewModel
include Cell::Slim
include ActionView::Helpers::DateHelper
include ActionView::Helpers::TextHelper
include ActionView::Helpers::NumberHelper
include ActionView::Helpers::FormHelper
include ActionView::Helpers::FormOptionsHelper
include ERB::Util
def self.helper_method(*)
end
def dom_class(record, prefix = nil)
ActionView::RecordIdentifier.dom_class(record, prefix)
end
def dom_id(record, prefix = nil)
ActionView::RecordIdentifier.dom_id(record, prefix)
end
end

class ApplicationCell < Cell::ViewModel

include Cell::Slim

include ActionView::Helpers::DateHelper

include ActionView::Helpers::TextHelper

include ActionView::Helpers::NumberHelper

include ActionView::Helpers::FormHelper

include ActionView::Helpers::FormOptionsHelper

include ERB::Util

def self.helper_method(*)

end

def dom_class(record, prefix = nil)

ActionView::RecordIdentifier.dom_class(record, prefix)

end

def dom_id(record, prefix = nil)

ActionView::RecordIdentifier.dom_id(record, prefix)

end

self.helper_method は devise が呼び出しているため、呼べるようにしておくために作っています。 Cells では既に意味のないメソッドになっているので、何も処理は行いません。この記述については一部 Rails: Cells 3 から Cells 4 へのアップグレード時に遭遇したエラーにも関連情報を書きました。

helper を include に変更

各 Cell クラスに helper ApplicationHelper というのが記述されていました。

Webrick を実行してページを開くと undefined method と表示されました。そこで、 helper を include に変更しました。

sedコマンドを使って、複数ファイルを一度に変更しました。

render_cell を cell に変更

Cells 4 からメソッドが変わりました。ビューの中で使用されている render_cell を cell に書き換えました。

いままで書いていた人がコードを綺麗に保っていたので、 sedコマンドを使って簡単に変更できました。書き方が何通りもある場合は、簡単にはいきません。

変更前コード

= render_cell :cell_name, :method_name, option_1: 1, option_2: 2

1	= render_cell :cell_name, :method_name, option_1: 1, option_2: 2

変更後コード

= cell(:cell_name).(:method_name, option_1: 1, option_2: 2)

1	= cell(:cell_name).(:method_name, option_1: 1, option_2: 2)

ファイル名変更

cell のテンプレートが method_name.html.slim となっていましたが、 cell(:cell_name).(:method_name) で呼び出した場合、 method_name.slim のテンプレートを探してエラーとなりました。

cells/lib/cell/view_model.rb 内の find_template メソッドでテンプレートの名前を組み立てていますが、そこでは文字列 'html' を結合していません。

そこで、テンプレートファイルの名前から html を抜きました。

app/views 内のテンプレート呼び出し部分を変更

こちらも間に合わせの対応でした。

過去のコードでは過去のコード cell のテンプレートから app/views/shared/something.html.slim を呼び出していました。

変更前コード

= render partial: 'shared/something', locals: {something: true}

1	= render partial: 'shared/something', locals: {something: true}

この呼び出し方だと、 Cells 4 ではうまくいきません。

cells/lib/cell/templates.rb と cells/lib/cell/view_model.rb を見ながら次のようにコードを変更しました。

変更後コード

= render prefixes: ['app/views'], view: 'shared/_something.html', locals: {something: true}

1	= render prefixes: ['app/views'], view: 'shared/_something.html', locals: {something: true}

prefixes と view を作るだけではなくて、 view の値も変える必要があります。

app/views内のテンプレートを呼び出す際のメソッドを ApplicationCell に作ったほうがよかったかもしれません。

Cell の中に self.view_paths += ['app/views'] を加えると、 app/views/cell_name の中でテンプレートを探すようになります。つまり、次のように変更しても動くようになります。

コード変更案

= render view: '../shared/_something.html', locals: {something: true}

1	= render view: '../shared/_something.html', locals: {something: true}

コード

アルゴリズムの評価

2015年10月25日 Kenji

いいアルゴリズムとはどのようなアルゴリズムでしょうか。アルゴリズムの良し悪しを決める基準のことをアルゴリズムの評価基準といいます。ここではそのアルゴリズムの評価基準について考えてみましょう。

続きを読む →

コード

Bitbucket と Slack を連携させる方法

2015年10月22日 Kenji

Bitbucket で Pull Request(プルリクエスト) やコメント、 Issue(イシュー) が追加・作成されたときに Slack に連携するコードを書きました。

経緯

Bitbucket で Issue 作成などが行われた際に外部に連携する仕組みは Bitbucket で提供されています。それは各プロジェクトの設定画面 Webhooks から設定ができます。

Slack でも設定画面から簡単に Bitbucket と連携することができました。しかし、そのとき (2015年9月頃) は Bitbucket の push しか Slack が対応していませんでした。

push よりも Issue 作成や Pull Request やコメントを連携してほしいと思った私は、 Google Apps Script を使って Bitbucket と Slack を繋ぐスクリプトを作ったのでした。

コード

本当ならオブジェクトモデルを作って Factory を作ってとやりたいところだったのですが、業務が忙しくてそんなことやってられなかったため間に合わせの品質でコードを作りました。

下記のスクリプトを Google Apps Script で作成し、メニュー Publish から Deploy as web app をクリックして公開します。するとウェブアプリの URL が表示されるので、それを Bitbucket の設定画面から Push 先の URL として登録します。

Bitbucket で何らかの操作が行われるたびに Google Apps Script の処理が実行され、 Slack に投稿されるようになります。

(コードは Github Bitbucket To Slack Gas にもあります。 Contribute 歓迎です。)

function createSlackMessage(contents) {
var message = {};
if (contents.hasOwnProperty('push')) {
// Push
message['text'] = 'pushed to ' + contents.repository.name; 
var info = '';
var l = contents.push.changes.length;
for (var i = 0; i < l; ++i) {
info += '\n';
if (contents.push.changes[i].old == null) {
info += 'created new branch: ' + contents.push.changes[i]['new'].name;
} else {
// deleted
if(contents.push.changes[i]['new']==null) {
info += 'deleted branch: '+contents.push.changes[i]['old'].name;
}else{
info += 'from ' + contents.push.changes[i]['old'].name + ' to ' + contents.push.changes[i]['new'].name ;
}
}      
}
message['text'] += info;
} else if (contents.hasOwnProperty('fork')) {
message['fork'] = 'forked.';
} else if (contents.hasOwnProperty('pullrequest')) {
// PullRequest
var pr = contents.pullrequest;
var to   = pr.destination.repository.full_name + '/' + pr.destination.branch.name;
var from = pr.source.repository.full_name + '/' + pr.source.branch.name;
if (contents.hasOwnProperty('approve')) {
// Approve
var prLink = '<' + contents.pullrequest.links.html.href + '|' + contents.pullrequest.title + '>';
message['text'] = 'approved the PR.\n' + prLink;
} else if (contents.hasOwnProperty('comment')) {
// Comment
var prLink = '<' + contents.comment.links.html.href + '|' + contents.pullrequest.title + ' comment>';
message['text'] = 'commented on the PR.\n' + contents.comment.content.raw + '\n' + prLink;
} else {
var prLink = '<' + contents.pullrequest.links.html.href + '|' + contents.pullrequest.title + '>';
if (pr.updated_on == null) {
// Create
message['text'] = 'created new PR[' + from + '-&gt;' + to + '].\n' + prLink;
} else {
// Update or Merge
message['text'] = 'updated PR (' + pr.state + ') [' + from + '-&gt;' + to + '].\n' + prLink;
}
}
} else if (contents.hasOwnProperty('issue')) {
// Issue
var issueLink = '<' + contents.issue.links.html.href + '|#' + contents.issue.id + ' ' + contents.issue.title + '>';
if (contents.hasOwnProperty('comment')) {
if (contents.hasOwnProperty('changes')) {
message['text'] = 'updated issue: ' + issueLink;
} else {
// Comment created
message['text'] = 'commented on ' + issueLink + '\n' + contents.comment.content.raw + '\n<' + contents.comment.links.html.href + '|More Detail>';
}
} else {
// Created
message['text'] = 'created new issue: ' + issueLink;
}
}
message['username'] = contents.actor.display_name;
return message;
}
function post(payload, url) {
var options;
options = {
method: 'post',
payload: payload
};
return UrlFetchApp.fetch(url, options);
}
function doPost(e) {
var contents = JSON.parse(e.postData.contents);
var slackMessage = createSlackMessage(contents);
var url = 'https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX';
post(JSON.stringify(slackMessage), url);
}

function createSlackMessage(contents) {

var message = {};

if (contents.hasOwnProperty('push')) {

// Push

message['text'] = 'pushed to ' + contents.repository.name;

var info = '';

var l = contents.push.changes.length;

for (var i = 0; i < l; ++i) {

info += '\n';

if (contents.push.changes[i].old == null) {

info += 'created new branch: ' + contents.push.changes[i]['new'].name;

} else {

// deleted

if(contents.push.changes[i]['new']==null) {

info += 'deleted branch: '+contents.push.changes[i]['old'].name;

}else{

info += 'from ' + contents.push.changes[i]['old'].name + ' to ' + contents.push.changes[i]['new'].name ;

}

message['text'] += info;

} else if (contents.hasOwnProperty('fork')) {

message['fork'] = 'forked.';

} else if (contents.hasOwnProperty('pullrequest')) {

// PullRequest

var pr = contents.pullrequest;

var to = pr.destination.repository.full_name + '/' + pr.destination.branch.name;

var from = pr.source.repository.full_name + '/' + pr.source.branch.name;

if (contents.hasOwnProperty('approve')) {

// Approve

var prLink = '<' + contents.pullrequest.links.html.href + '|' + contents.pullrequest.title + '>';

message['text'] = 'approved the PR.\n' + prLink;

} else if (contents.hasOwnProperty('comment')) {

// Comment

var prLink = '<' + contents.comment.links.html.href + '|' + contents.pullrequest.title + ' comment>';

message['text'] = 'commented on the PR.\n' + contents.comment.content.raw + '\n' + prLink;

} else {

var prLink = '<' + contents.pullrequest.links.html.href + '|' + contents.pullrequest.title + '>';

if (pr.updated_on == null) {

// Create

message['text'] = 'created new PR[' + from + '->' + to + '].\n' + prLink;

} else {

// Update or Merge

message['text'] = 'updated PR (' + pr.state + ') [' + from + '->' + to + '].\n' + prLink;

}

} else if (contents.hasOwnProperty('issue')) {

// Issue

var issueLink = '<' + contents.issue.links.html.href + '|#' + contents.issue.id + ' ' + contents.issue.title + '>';

if (contents.hasOwnProperty('comment')) {

if (contents.hasOwnProperty('changes')) {

message['text'] = 'updated issue: ' + issueLink;

} else {

// Comment created

message['text'] = 'commented on ' + issueLink + '\n' + contents.comment.content.raw + '\n<' + contents.comment.links.html.href + '|More Detail>';

}

} else {

// Created

message['text'] = 'created new issue: ' + issueLink;

}

message['username'] = contents.actor.display_name;

return message;

}

function post(payload, url) {

var options;

options = {

method: 'post',

payload: payload

};

return UrlFetchApp.fetch(url, options);

}

function doPost(e) {

var contents = JSON.parse(e.postData.contents);

var slackMessage = createSlackMessage(contents);

var url = 'https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX';

post(JSON.stringify(slackMessage), url);

}

まず Bitbucket から通知(Post Request)が来ると、 doPost が実行されます。そして Post されたデータから、 Slack へのペイロードデータを作成します。上では createSlackMessage がその処理を行っています。

createSlackMessage では、届いたデータから操作内容を割り出し、通知したい情報をまとめます。

送信したいデータがまとまったら、 Slack に送信します。

注意点

createSlackMessage では、 Issue の場合、 Pull Request の場合などパターン分けしていますが、上で分けてある以上に細かくパターンが分かれます。今回は私の業務上必要だろうと思われる分岐にとどめています。そのパターンを正確に判断するには Bitbucket から送信されるヘッダの中を確認するのがいいのですが、 Google Apps Script ではリクエストヘッダを確認することができないためペイロード部分のデータで分岐を行っています。

実際のところ Pull Request の approved のあたりはまだ検証中のため、正しく判別できているという保証がないです。

もし、 Heroku や AWS 、その他レンタルサーバなど自由に使えるサーバがある場合は、 PHP, Ruby 等で作成したほうがリクエストヘッダも使えて便利だと思います。

コード

RSpec: Helper の current_user を使ったメソッドのテスト

2015年10月15日 Kenji

Rails の Helper(ヘルパー) に書いた current_user を使ったメソッドを RSpec でテストするときのやり方を書きます。

続きを読む →

Linux, コード

crontab をコマンドで登録する方法

2015年10月13日 Kenji

Rails などで、 setup を自動にしている人は多いと思います。 Rails だと whenever という gem を使って crontab をプログラムから設定してしまうことができるのですが、メールサーバなど Rails をインストールしていない、インストールするのも煩わしい環境だとそうはいきません。そこで本記事では、 shell を使って crontab を設定する方法を紹介します。

続きを読む →

The Life

「コード」カテゴリーアーカイブ

Rails: Cells 3 から Cells 4 へのアップグレード

環境

経緯

やったこと

ApplicationCell 作成

helper を include に変更

render_cell を cell に変更

変更前コード

変更後コード

ファイル名変更

app/views 内のテンプレート呼び出し部分を変更

変更前コード

変更後コード

コード変更案

アルゴリズムの評価

Bitbucket と Slack を連携させる方法

経緯

コード

注意点

RSpec: Helper の current_user を使ったメソッドのテスト

crontab をコマンドで登録する方法

A Life Summary of an Gypsy