Category Archives: Code

In Rails, I upgraded Cells gem from 3.11.3 to 4.0.2. And I upgraded Rails from 4.1.9 to 4.2.4 together. Here, I wrote what I did about Cells upgrade.

Basic instruction is in From Cells 3 to Cells 4 Upgrading Guide. It’s not easy to upgrade it.

Environment

Ruby 2.2.3
Template Engine: Slim

Story

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

その Rails のアプリケーションにテストコードは一切なかった。

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

What I did

Create ApplicationCell
Change helper to include
Change render_cell to cell
Change file name
Change partial view rendering way

Create ApplicationCell

If you use functions relates to device or form tags, the application will stop working after upgrading to Cells 4. Then I created ApplicationCell as a parent class of all Cell class.

アプリケーションを見ながら次のような 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 is called by devise, so it is necessary. Cells では既に意味のないメソッドになっているので、何も処理は行いません。

Change helper to include

In each cell class, there was a line “helper ApplicationHelper“.

Webrick を実行してページを開くと undefined method と表示されました。 Then, change helper statement to include statement with sed command.

Change render_cell to cell

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

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

Before

= 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

After

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

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

Change file name

There were cell templates named like method_name.html.slim, but Cells 4 method cell(:cell_name).(:method_name) search template named method_name.slim. It caused exception.

In cells/lib/cell/view_model.rb of Cells 4, find_template method generates template name. Generated template name by that method doesn’t contain the string 'html'.

I removed “html” from template file name.

Change partial view rendering way

I know what I did is quick and dirty way.

In old code, cell template renders partial view app/views/shared/something.html.slim.

Before

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

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

But it doesn’t work in Cells 4.

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

After

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

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

I had not only to create prefixes and view value, but change view value.

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

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

Alternative

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

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

Code

(日本語) アルゴリズムの評価

Sunday October 25th, 2015 Kenji

Sorry, this entry is only available in 日本語.

Code

The way to connect Bitbucket to Slack

Thursday October 22nd, 2015 Kenji

I wrote the code to push notification to Slack when someone create an issue, when someone created a comment, etc. in Bitbucket.

Story

The mechanism to send notification to Slack when some action is taken in Bitbucket, is prepared in Bitbucket, called webhooks. It can be turned on in each project setting page.

In Slack, we can connect to Bitbucket easily in setting page. But Slack can only receive push notification of Bitbucket, can’t receive comment or issue notification, at that time (Sep. 2015).

I want to be notified issue and comment creation rather than push action, and created such code in Google Apps Script.

Code

Copy the following script to Google Apps Script, and deploy as web app, which is in “publish” menu. Then, it’s url would be shown and set it as webhook url in Bitbucket console panel.

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

If I had had time, I would’ve create object model and factory, etc. But in real, the code is not so clean.

(And I put the code to Github Bitbucket To Slack Gas. Contribution is welcomed.)

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);

}

First, Bitbucket send post request to the app and doPost will be executed. Then, it creates message to post to Slack in createSlackMessage function, from the data posted.

After that, it posts to Slack.

Caution

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

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

If you can use Heroku or AWS or other hosting service, it would be good to create in PHP, Ruby, etc. which can handle request header.

Code

RSpec: Test Helper Method using current_user function

Thursday October 15th, 2015 Kenji

I’ll introduce the way to test rails helper code that uses current_user method provided by device gem.

Environment

Ruby 2.2.2
Rails 4.1.8
RSpec 3.1.0

Test Target

The function we are going to test is below. It compare the return value of current_user method and user_id given as argument, and check the argument user_id is of current login user or not.

module ExampleHelper
# check if the id is of current user
# ==== Parameter
# * +user_id+
# ==== Return
# Boolean
def is_current_user?(user_id)
if current_user && current_user.id == user_id
return true
end
return false
end
end

module ExampleHelper

# check if the id is of current user

# ==== Parameter

# * +user_id+

# ==== Return

# Boolean

def is_current_user?(user_id)

if current_user && current_user.id == user_id

return true

end

return false

end

Continue reading →

Linux, Code

shell: set up crontab programmatically

Tuesday October 13th, 2015 Kenji

I’ll introduce how to set up crontab programmatically with shell script.

Continue reading →

The Life

Category Archives: Code

Rails: Upgrade Cells 3 to Cells 4

Environment

Story

What I did

Create ApplicationCell

Change helper to include

Change render_cell to cell

Before

After

Change file name

Change partial view rendering way

Before

After

Alternative

(日本語) アルゴリズムの評価

The way to connect Bitbucket to Slack

Story

Code

Caution

RSpec: Test Helper Method using current_user function

Environment

Test Target

shell: set up crontab programmatically

A Life Summary of an Gypsy