2013-11-05

Rails3でflashにリンクを組み込む方法

Rails

flashでリンク出てきたほうが親切だなと思い、やってみました。
少しだけハマるとこありました。

# users_controller.rb

def update
  link = "<a href=\"#{url_for(:controller => 'users', :action => 'show')}\">#{@hoge.name}</a>"
  if @hoge.save
    flash[:success] = "保存されました。#{link}".html_safe
    redirect_to dashboard_path
  end
end

分かりやすくするため、link 部分を変数にしました。ポイントは以下。

'link_to' ではなく 'url_for' で指定してあげる
'.html_safe' でHTMLがエスケイプしないようにしてあげる（Rails3.x の時）

この2箇所かなと。
'link_to' を controller から利用するには、helper module が必要なので、'url_for' を採用。それから、Rails3では自動でエスケイプ処理が行われる仕様なので、それを'.html_safe'で制御。

おわり！

※ 無理矢理感は否めませんが、まあ動くというレベルですね…

2013-10-06

プログラミングと数学の証明の共通点

オピニオン

プログラミング初心者の雑感だけれど、たまにプログラミングは数学の証明と類似しているなーと思います。

両者の共通項は次のような感じ。

解くべき問題の条件が与えられており、

証明すべき命題（完成形）を示すことが目的であり、

その道筋は当事者に委ねられている

3点目の、「どのように導くか」という点で技量が試されたりするところも、プログラミングと数学の証明で共通していると言えるでしょう。

高校時代のお話 - たくさんの問題に触れて引き出しを増やすこと

そういえば、僕の通っていた高校は、理系重視の方針もあり在学生の7割ほどは理系だったかなという感じなのですが、クラスで数学の証明なんかをやると、普通なら20行くらい必要なはずのところを、スラっと5行くらいで書いてしまう人がいたりしました。

先生も苦笑い。彼はプログラミングをやらせてもきっと綺麗でスマートなコードを書くんじゃないかなと思います。

そういえば、彼が何をしていたかと思い返してみると、いつも「大学の数学」を解いていた気がします。きっと僕なんかよりずっとずっと多くの問題に触れていました。

「たくさんの問題に触れて引き出しを増やすこと」

数学教師が口を酸っぱくして言っていた言葉がふと蘇りました。

2013-10-05

Railsでサブドメイン間でログインを保持するためのセッション設定

Rails 開発メモ

Railsでサブドメインにアクセスすると、デフォルトの設定では、ログイン（セッション）が保持されません。

解決策は以下の通りです。
ググると間違った（or 古い）情報も散乱していたので、惑わされないようにそちらも一応のせておきます。

session_store.rbの設定

session_store.rb で以下のように設定します。

# session_store.rb
Appname::Application.config.session_store :cookie_store, key: '_user_session', domain: 'example.com'

少し解説すると、

domain: 'example.com'

のように、domainを指定するのがポイント。
production, staging, development で以下のように分岐してあげればいいかなと。

if Rails.env.production?
Appname::Application.config.session_store :cookie_store, key: '_user_session', domain: 'example.com'
elsif Rails.env.staging?
Appname::Application.config.session_store :cookie_store, key: '_user_session', domain: 'staging-example.com'
else
Appname::Application.config.session_store :cookie_store, key: '_user_session', domain: 'lvh.me'
end

ちなみに、stagingで用いている 'lvh.me' は、127.0.0.0 に割り当てらているドメインです。localhost だとサブドメインのチェックはできないので、lvh.me はすごく便利。

domainオプションを追記する際には、keyも変えるべし

ここはハマったところなのですが、domain: 'example.com' を追加すると、セッションの情報も変わります。しかし、keyの名前は同じ。

すると、既にログインしていたユーザーがログアウトできなくなるなどの不都合が生じてしまう可能性があります。（実装にも依ると思いますが）

なので、domainオプションを追加するタイミングで、session_key の名前も変更しておいたほうが無難だなーと思います。

Railsでカスタムサブドメイン機能を実装する時のルーティング設定

Rails - mockを使って1つの属性のみにvalidationを走らせてみる

Railsでカスタムサブドメイン-本サイトとサブドメイン間のURL設定

2013-10-05

Railsでカスタムサブドメイン-本サイトとサブドメイン間のURL設定

Rails 開発メモ

Railsでサブドメインを実装した際に、本サイトとサブドメインサイト間の受け渡しで少しハマりました。

サブドメインサイトにいる状態で、root_path や root_url でリンク先を指定しても、本サイトではなく、そのサブドメインのトップに飛ばされます。

この記事では、url_for メソッドを利用して、サブドメインサイトと本サイト間を行き来する方法をご紹介します。

url_forでメソッド作成

subdomain_url_helper を以下のように作成

module SubdomainUrlHelper
  def with_subdomain(subdomain)
    subdomain ||= 'www'
    subdomain += "."
    [subdomain, request.domain].join
  end

  # - remove subdomain and go to the original site
  #    url_for(:subdomain => false)
  # - go to the specific subdomain site
  #    url_for(:requested_subdomain => 'subdomain')
  def url_for(options = nil)
    if options.kind_of?(Hash) && options.has_key?(:subdomain)
      options[:host] = with_subdomain(options.delete(:subdomain))
    elsif options.kind_of?(Hash) && options.has_key?(:requested_subdomain)
      options[:host] = with_subdomain(options.delete(:requested_subdomain))
      options[:controller] = 'users'
      options[:action] = 'show'
    end
    super
  end
end

メインは、2つめのurl_forメソッド。
with_subdomainメソッドは、引数の subdomain と request.domain を合わせるためのもの。なお、subdomain が存在しなければ、www が代わりに入る。
そのため、

url_for(:subdomain => false)

とすると、

# if request.domain is "example.com"
www.example.com

のようになる。

url_for については、渡された hashのkey で条件分岐してあるのは、見ての通りです。

コードがなかなか汚いのでだれかリファクタお願いします。

Railsでカスタムサブドメイン機能を実装する時のルーティング設定

Rails - mockを使って1つの属性のみにvalidationを走らせてみる

2013-10-05

Railsでカスタムサブドメイン機能を実装する時のルーティング設定

Rails 開発メモ

運営中のサービス「BoxToYou（https://www.box2you.com）」でカスタムサブドメイン機能をリリースしました。

いくつかハマったところがあったので、数回に分けてメモしていきまする。

今回は、routingの設定とリンクの設定方法について。

サブドメインの条件定義

まず、subdomain.rb でサブドメインの条件をかきかき。

#subdomain.rb 

class Subdomain
  def self.matches?(request)
    request.subdomain.present? && request.subdomain != "www"
  end
end

RailsのRequestオブジェクトにsubdomainメソッドが定義されているので、

request.subdomain

という風にリクエストのサブドメイン部分「http://◯◯◯.example.com」の◯◯◯を簡単に呼び出せます。ただし、「www」もサブドメインとして処理されますので、カスタムサブドメインの設定としては不適切として、

request.subdomain != "www"

という風にmatchの条件から排除しています。

ルーティングの設定

次に、routesファイルの設定。

#routes.rb

# routes setting of subdomain
# should be placed above the "root :to" path
require "#{Rails.root}/app/helpers/subdomain"
  constraints(Subdomain) do
    match "/" => 'users#show'
    match "/*a" => 'application#render_error404'
  end

# other routes settings
root :to => "users#index" #

上記のsubdomain.rbを読み込み、
constraints で条件がマッチした際には、別のactionに飛ばすようにしています。

match "/" => 'users#show'
match "/*a" => 'application#render_error404'

については、アプリの仕様で、root_path の後ろには何も来ない場合の処理です。404 error のページへ飛ぶようにcontroller側で設定しています。

コントローラー側の制御

ちなみに、subdomain の controller 側の処理はこんな感じです。

# users_controller.rb

# if no users exist who has the requested.subdomain, 
# redirect the request to the top page.
unless User.where(:subdomain => request.subdomain).present?
  return redirect_to url_for(:subdomain => false)
 end

# specific a user from request.subdomain
@user = User.where(:subdomain => request.subdomain).first

リクエストされたサブドメインを持ったユーザーが存在しなかった場合は、トップページにリダイレクトしています。
url_for(:subdomain => false)に関しては、subdomain_url_helper.rb というヘルパーを作って設定しています。（詳細はこちら）

そして、次に、subdomain は各ユーザーがユニークで持てるようにしているので、

@user = User.where(:subdomain => request.subdomain).first

で特定のユーザーを特定して、インスタンス変数に入れています。

こんな感じで、だいたいの設定はできるかと。

Rails - mockを使って1つの属性のみにvalidationを走らせてみる

Railsでカスタムサブドメイン-本サイトとサブドメイン間のURL設定

Railsでサブドメイン間でログインを保持するためのセッション設定

参考記事

#221 Subdomains in Rails 3 ( Rails Cast）

Rails Tutorial for Subdomains with Devise

Setting Up User Subdomains in Rails 3

herokuアプリで任意のサブドメインを使う。DNSまわりの設定編

2013-09-17

Rails - mockを使って1つの属性のみにvalidationを走らせてみる

開発メモ Rails

ユニークなユーザー名やサブドメインを付与するときに、ajaxで入力されたその場で有効な値かどうかを判断してあげれば、ユーザビリティは向上するだろう。ツイッターなど大規模なウェブサービスでは実装されていることが多いかと思う。

しかし、.valid? メソッドを使ってしまうと、そのオブジェクト全体にvalidationがかかってしまい不都合が生じてしまうので、今回は、1つの属性に対してvalidationをする方法について扱う。

具体的には、以下のように、検証を行いたい1つの属性を持った新しいオブジェクト（ここでは、mock）を作り、mock.valid? でエラーを発生させ、そのエラーに調べたい属性のkeyがあるかどうかを見る。

def valid_attribute?(attr, value, present_username)
  mock = User.new(attr => value)
  unless mock.valid?
    if mock.errors.has_key?(attr) && value != present_username
      return false
    else
      return true
    end
  end
  true
end

attr が調べたい属性の名前、value がその属性に与えられた値。
さらに、ここでは、ユーザーネームの検証を行うと仮定して、present_username という引数を与えてみた。

ポイントは、

mock = User.new(attr => value)

で、ユーザーが入力した値を用いて、新しいユーザー mock を擬似的につくり、

unless mock.valid?

で、エラーを発生させ（全ての属性の検証にクリアすれば true が返る）、

if mock.errors.has_key?(attr) && value != present_username

で、エラーに attr という key があり、かつ、入力された値 value が現在のユーザーネーム present_username と異なる、という条件で value が不正な条件を作り出している点。

個人的に、mock をつくるのと、errors.has_key? を使うあたり、勉強になった。

色んな方法があるのだなーと。

参考にしたのは、stackoverflow の以下の記事。
Is there a way to validate a specific attribute on an ActiveRecord without instantiating an object first?

また、ActiveRecord を使用している場合は、以下の記事で触れられている方法が使えそう。
Rails - 状況によってsave時に実行するバリデーションを切り替える

view側の実装は別記事にする予定。

2013-08-25

Rails で jquery.cookie.js を使って閲覧履歴を表示してみた

Rails 勉強開発メモ

jquery.cookie.js と Rails の cookies を使うと、簡単に履歴表示機能を実装することができた。
item オブジェクトが id 属性と name 属性を持っている場合の実装例を書いてみた。

jquery.cookie.jsでクッキーを保存

$(function(){
  var item = "<%= @item.id %>";
  var cookie_name = 'recently_viewed_items';
  var viewed_items = [];
  var delete_item = false;
  $.cookie.defaults.path = "/";

  // 既にクッキーが存在している場合は、ストリングを配列にする
  if($.cookie(cookie_name)){
    viewed_items = $.cookie(cookie_name).split(",");
  }

  // 重複していなければ、itemを配列に追加
  if($.inArray(item, viewed_items)<0){
    viewed_items.push(item);
  }

  // 5個以上ならば1つ削除
  if (viewed_items.length >= 5){
    viewed_items.shift();
  }

  // 配列をクッキ―に保存
  $.cookie(cookie_name, viewed_items);

});

Railsのcookiesを利用してview側で表示を制御

<h2>
  最近チェックしたアイテム
</h2>
<% items = [] %>
<% items = cookies[:recently_viewed_items].split(",") unless cookies[:recently_viewed_items].nil? %>
<% items.each do |id| %>
  <% item = Item.find(id) %>
    <%= item.name %>
<% end %>