シラサギハンズオン東京

Ruby/Rails/mongoDBで動作する中・大規模サイト向けCMS「シラサギ」のハンズオン

登壇者
ウェブチップス
1. 野原
2. 中野
3. 伊藤

ハンズオンの狙い
1. シラサギの概要を理解する。
2. シラサギの仕組みを理解する。
3. シラサギの機能追加と機能拡張の方法を理解する。

ハンズオン目次
1. シラサギの紹介 [10min]
2. ハンズオンの導入 [15min]
3. ハンズオン [60min]
1. 開発サンプル紹介
2. 準備
3. ブログページ作成
4. 天気入力フォーム作成
5. 一覧フォルダー作成

会社概要
会社名
設立
資本金
所在地
役員
株式会社ウェブチップス
２０１３年９月２０日
５００万円
〒770-0872 徳島県徳島市北沖洲三丁目6番58号石本ビル202
代表取締役社長CEO 野原直一
技術担当取締役CTO 谷沢和寿
５名（役員含む）２０１５年１月から６名に
オープンソースソフトウェア開発事業
オープンソースを使った導入・カスタマイズ事業
オープンソースを使ったクラウドサービス事業
社員数
事業内容

名称の由来
サギ科の鳥のうち、全身の羽毛が白いものを「シラサギ」と呼びます。
徳島県では1965年10月から「シラサギ」を県の鳥に指定しています。
サギ類は、他の種類のサギたちと一緒に巣を作り、繁殖するという特徴が
あります。
その様子が、様々な企業と技術者でコミュニティを形成し、ソフトウェアを
開発していくというコンセプトと一致したためこの名称を採用しました。
「シラサギ」は、みんなで育てるＣＭＳです。

ＭＩＴライセンス
誰でも自由にカスタマイズできます。
誰でも自由にフォークできます。
拡張機能を公開するかどうかを自由に選べます。

Webアプリ開発プラットフォーム
ＣＭＳですが、コアの設計は汎用ＳＮＳになっており、Ｗｅｂアプリ開発プラットフォーム
として利用できます。
将来的にグループウェア、ＳＮＳなどの様々なアプリケーションの開発ができます。

モデルアドオン設計
下記をカプセル化して任意のコレクションに
取り付けられます。
・DBのフィールド
・データ検証や保存ロジック
・編集画面
・詳細画面
アドオンをうまく使うことで、モジュールの
肥大化を抑えられます。
結果、ソース管理が非常に楽になります。

ＭｏｎｇｏＤＢ
NoSQLであるMongoDBを採用し、高速化を
実現しています。
公開されているフォルダ・ページには、リレー
ションによる関連付けはなく、それぞれがファ
イル名（ＵＲＬ）を保持しています。
そのため、MongoDBの強みである前方一致
検索のパフォーマンスを最大限に引き出せ
ます。そのため、任意のフォルダ内の検索も
非常に高速かつ効率的に行えます。

動作環境
Internet Explorer (ver.8 以上)、Firefox、Chrome、Safariの最新バージョンを想定しています。
対象バージョンなど
OS CentOS 6.5 64bit
Webサーバ nginx + unicorn
DBシステム MongoDB
Ruby 2.1.2
Ruby on Rails 4.1.4

初期データ
市町村向けの自治体サンプルデータ、企業サンプル
データを初期データとして提供しています。
インストール時に初期データを切り替えられます。
今後も様々なサンプルデータを提供していきます。
・子育てサイトサンプル
・大学サンプル
・県向け自治体サンプル
など

初期データを使ったホームページ作成（１）
初期データ「企業サンプル」企業向けホームページ
ロゴ
写真
色
レイアウト
を調整

初期データを使ったホームページ作成（２）
初期データ「自治体サンプル」自治体向けホームページ
ロゴ
写真
色
レイアウト
を調整

拡張プラグイン
独自の拡張プラグイン機能「egg（エッグ）」があります。
モジュールとして追加したコンテンツのプラグイン化、デプロイが行えます。

地図データベース機能
表示項目
検索条件
などを調整
バリアフリーマップ
拡張プラグインを使ったウェブシステム開発

マルチテナント対応
同一データベース同一スキーマ方式を採用しています。
これにより管理者の運用コストを軽減できます。

マルチテナントを使ったサービス提供
シラサギのクラウドサービスを立ち上げ、同じコンテンツサイトを横並びで構築していく。
例：徳島県オープンデータポータルサイトと各市町村オープンデータサイト

Ajaxレイアウト（バージョン0.5.0でAjaxパーツに）
即時反映と低負荷を実現します。
ページは、検索クローラーを想定して静的ＨＴＭＬファイルを書き出します。
レイアウト、記事リストなどのパーツは、動的表示となります。

マルチデバイス対応
公開画面及び管理画面は、ＰＣ、スマホ、携帯、
タブレットなど様々なデバイスに対応。

GitHubによる公開開発
既にシラサギの開発に共感してくれている個人のエンジニアの方から、
プルリクエスト（開発したプログラムを取り込む依頼）を定期的にいただいています。

シラサギ公式サイト
新着情報
リリースノート
よくある質問
ダウンロード
オンラインデモ
導入事例
開発情報
など
http://ss-proj.org/

シラサギプロジェクト開発コミュニティ
シラサギプロジェクトの開発コミュ
ニティをfacebook上の公開グルー
プとして立ち上げています。
リリース詳細や他のエンジニアの
方からのレポートなども掲載され
ていますので、是非ご参加くださ
い。

導入
管理画面
1. メニューやコンテキストメニューの操作方法
2. フォルダ
3. レイアウト
4. パーツ
5. ページ
6. アドオン

シラサギデモ
http://ss-proj.org/download/demo.html
Googleで「shirasagi demo」を検索してもOK

管理画面 – システム管理

管理画面 – サイト管理

管理画面 – フォルダ一覧

管理画面 – フォルダ詳細

管理画面 – レイアウト一覧

管理画面 – レイアウト詳細

Rails モデルクラスでのアドオン
class Article::Page
include Cms::Page::Model
include Cms::Addon::Meta
include Cms::Addon::Body
include Cms::Addon::File
include Cms::Addon::Release
include Cms::Addon::ReleasePlan
include Cms::Addon::RelatedPage
include Category::Addon::Category
include Event::Addon::Date
include Map::Addon::Page
include Workflow::Addon::Approver
include Contact::Addon::Page
include History::Addon::Backup
…

振り返り
管理画面
1. メニューやコンテキストメニューの操作方法
2. フォルダ – イベントカレンダーフォルダ、記事フォルダ、...
3. レイアウト
4. パーツ
5. ページ – イベントページ、記事ページ、…
6. アドオン

ハンズオンの環境構築
環境構築
1. VirtualBox インストール
2. Vagrant インストール
3. Windows の方だけ
1. git のインストール
2. Tera Term インストール
4. シラサギ・ハンズオン環境のインストール

VirtualBox & Vagrant インストール
■VirtualBox
https://www.virtualbox.org/wiki/Downloads
Googleで「virtualbox download」を検索してもOK
■Vagrant
https://www.vagrantup.com/downloads.html
Googleで「vagrant download」を検索してもOK

Windows の方だけ
■Git
https://msysgit.github.io/
Googleで「windows git」を検索してもOK
■Tera Term
http://sourceforge.jp/projects/ttssh2/releases/
Googleで「teraterm download」を検索してもOK

ハンズオン用Github
https://github.com/itowtips/ss-handson
Googleで「github itowtips」を検索してもOK
SSID: XXXXXXXX
PASS： xxxxxxxx

ハンズオン用Github
Vagrantfile をダウンロード

ハンズオン環境の起動
> cd Vagrantfile をダウンロードしたディレクトリ
> vagrant up

ハンズオン環境へログイン
■Windowsの方
IPアドレス: localhost
ポート: 2222
User: vagrant
Password: vagrant
■Mac, Linux の方
$ vagrant ssh

ハンズオン目次
1. 開発サンプル紹介
2. 準備
5. 一覧フォルダー作成

開発サンプル紹介
SHIRASAGI Wiki
https://github.com/shirasagi/shirasagi/wiki
開発サンプル：ブログページ
https://github.com/shirasagi/shirasagi/wiki/開発サンプル：ブログページ
今回のハンズオンで使用するリポジトリ、コマンド集などあります
※これを見ながら進めていきます

シラサギWiki：開発サンプルブログページ
シラサギにはページを作成し公開できる機能がいくつかあります
• 記事ページ
• 固定ページ
• イベントページ
• FAQページ

シラサギにはページを作成し公開できる機能がいくつかあります
• 記事ページ
• 固定ページ
• イベントページ
• FAQページ
• ブログページ ← 今回はこれを追加します

今回の開発の流れ
0. 開発用のシラサギインストール
シラサギのインストール、デモデータの登録ができるようになります
ページの追加を行います独自のページが作れるようになります
アドオンの追加を行います入力フォームの拡張ができるようになります
3. フォルダーの追加
作成したページ用一覧フォルダーの追加を行います
新しいタイプのフォルダー作成ができるようになります

準備前提知識
シラサギで使っている技術
• Ruby & Ruby On Rails
• Javascript & CoffeeScript
• Css & Scss
• Git
• MongoDB

準備 Gitとソースコード
シラサギの動く環境がある方はGitHubからソースコードを取得してください
#cd $HOME
#git clone https://github.com/itowtips/ss-handson sample
#cd sample

必要な設定ファイル(各種ymlとunicorn.rb)をコピーします
#cd $HOME
#cd sample
#cp config/samples/* config/

bundle install
#cd $HOME
#cd sample
#cp config/samples/* config/
#bundle install

準備 MongoDB設定
# vi config/mongoid.yml
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# mongodb configuration
production:
sessions:
default:
database: ss
development:
# Configure available database sessions. (required)
sessions:
# Defines the default session. (required)
default:
# Defines the name of the default database that Mongoid can connect to.
# (required).
database: ss
使用するデータベース名を変更します production & development

準備 MongoDB設定
# vi config/mongoid.yml
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# mongodb configuration
production:
sessions:
default:
database: ss_sample
development:
# Configure available database sessions. (required)
sessions:
# Defines the default session. (required)
default:
# Defines the name of the default database that Mongoid can connect to.
# (required).
database: ss_sample
使用するデータベース名を変更します production & development

準備 RAILS_ENV
# vi config/environment.yml
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# default environment
RAILS_ENV: production
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Railsをdevelopmentモードに

準備 RAILS_ENV
# vi config/environment.yml
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# default environment
RAILS_ENV: development
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Railsをdevelopmentモードに

準備サンプルデータ
#rake db:create_indexes
MongoDB インデックス作成

#rake ss:create_user data='{ name: "システム管理者", email: "sys@example.jp", password: "pass" }'
システム管理者作成

#rake ss:create_site data='{ name: "サイト名", host: "www", domains: "ドメイン:3000" }'
サイト作成
ローカル環境のＩＰ
例) 192.168.182.128

#rake db:seed name=users site=www
サンプルユーザ＆グループ作成

#rake db:seed name=demo site=www
自治体サンプルデータ投入

#rake db:seed name=demo site=www
#rake unicorn:start
unicorn起動

準備確認
http://ドメイン:3000/

ブログページ作成
シラサギWiki：ブログページ作成

※管理画面でブログページが作成できるようになります。

※公開画面での表示。
まずは既存のページを参考に、同様のものを作成します。

ブログページ作成シラサギの構成
/ – app
├ models
├ views
└ controllers
└ config – locales
└ routes
ソースコードをエディタで開いてみてください

/ – app
├ models
├ views
└ controllers
└ routes
シラサギ独特な構成
• 公開画面、管理画面がある
• 再利用可能なプログラムがある
• 静的ＨＴＭＬ書き出し機能がある …

/ – app
├ models
├ views
└ controllers
└ routes
• routes
• addon
• agents

ブログページ作成 routes
/ – app
├ models
├ views
└ controllers
└ routes
• routes
• addon
• agents

/ – app
├ models
├ views
└ controllers
└ routes
config/route.rb
config/route/モジュール名/routes.rb

/ – app
├ models
├ views
└ controllers
└ routes
config/route.rb
config/route/article/routes.rb

/ – app
├ models
├ views
└ controllers
└ routes
config/route.rb
記事モジュール
SS::Application.routes.draw do
…
content "article" do
get "/" => redirect { |p, req| "#{req.path}/pages" }, as: :main
get "generate" => "generate#index“
post "generate" => "generate#run“
resources :pages, concerns: :deletion
end
…
node "article" do
get "page/(index.:format)" => "public#index", cell: "nodes/page“
get "page/rss.xml" => "public#rss", cell: "nodes/page", format: "xml“
end
part "article" do
get "page" => "public#index", cell: "parts/page"
end
page "article" do
get "page/:filename.:format" => "public#index", cell: "pages/page“
end
end

/ – app
├ models
├ views
└ controllers
└ routes
config/route.rb
ルーティング追加ブロック
管理画面 content
公開画面 node, page, part
…
end
…
node "article" do
end
part "article" do
end
page "article" do
end
end

ルーティングを確認してみます
#rake routes | grep article

/ – app
├ models
├ views
└ controllers
└ routes
config/route.rb
ルーティング追加ブロック
管理画面 content
公開画面 node, page, part
…
end
…
node "article" do
end
part "article" do
end
page "article" do
end
end
cell: " pages/page " とは??

ブログページ作成 agents
/ – app
├ models
├ views
└ controllers
└ routes
• routes
• addon
• agents

• agents
• コントローラーからコントローラーを呼び出す仕組み
• シラサギ独自実装
• lib/ss/agent.rb
• 利用箇所
• 公開側のコントローラー (cms/public_controller)
公開側（利用者）のアクセスを各コンテンツに振り分ける
例）http://ドメイン/docs/page.html → 記事ページ
http://ドメイン/calendar/ → イベントカレンダー
• ページ書き出し

公開側ルーティング config/routes/cms/routes_end.rb#L73-78
※glob ルーティング（Route Globbing）
match "*public_path" => "cms/public#index", public_path: /[^.].*/,
via: [:get, :post, :put, :patch, :delete], format: true
via: [:get, :post, :put, :patch, :delete], format: false
root "cms/public#index", defaults: { format: :html }

公開画面"記事"にアクセス
http://ドメイン/docs/page.html

Controller
cms/public#index

Controller
cms/public#index → agents

Controller
cms/public#index → agents → article/agents/pages/page_controller#index

Controller
cms/public#index → agents → article/agents/pages/page_controller#index
cell: " pages/page "

/ – app
├ models
├ views
└ controllers
└ routes
ブログモジュールを追加していきます。

/ – app
├ models – blog
├ views – blog
└ controllers – blog
└ config – locales – blog
└ routes – blog
ブログモジュールを追加していきます。

/ – app
├ models – blog
├ views – blog
└ routes – blog
→ それぞれにソースコードを追加していきます。

/ – app
├ models – blog
├ views – blog
└ routes – blog
→ それぞれにソースコードを追加していきます。
手動でソースを追加するのは面倒…
#git checkout -b sample-blog-page origin/sample-blog-page
#rake unicorn:stop
#rake unicorn:start

Blog Page Model
/ – app
├ models – blog – page.rb
├ views – blog
└ routes – blog
• include Cms::Page::Model
• app/models/concerns/cms/node/model.rb
class Blog::Page
before_save :seq_filename, if: ->{ basename.blank? }
default_scope ->{ where(route: "blog/page") }
private
def validate_filename
(@basename && @basename.blank?) ? nil : super
end
def seq_filename
self.filename = dirname ? "#{dirname}#{id}.html" : "#{id}.html"
end
end

Blog Page Model
/ – app
├ views – blog
└ routes – blog
• 使用するAddonを追加
• 本文、添付ファイル等々
class Blog::Page
private
end
def seq_filename
end
end
Addonをinclude

Blog Page Model
/ – app
├ views – blog
└ routes – blog
• default_scopeを設定
• field :route
• コンテンツを識別する値
• “blog/page” → ブログ/ブログページ
class Blog::Page
private
end
def seq_filename
end
end
Addonをinclude
default_scope
route: " blog/page "

Blog Page Initializer
/ – app
└ initializer.rb
├ views – blog
└ routes – blog
• "blog/page" content をpluginに登録
module Blog
class Initializer
Cms::Node.plugin "blog/page"
end
end

Blog Page Agents View & Controller
/ – app
└ initializer.rb
├ views – blog – agents – pages – index.html.erb
└ controllers – blog – agents – pages – page_controller.rb
└ routes – blog
• ブログページ公開側
• コントローラー
• ビュー
• agentsの下に配置
class Blog::Agents::Pages::PageController < ApplicationController
include Cms::PageFilter::View
end
<%= render file: "cms/agents/pages/page/index" %>

Blog Page Navi View
/ – app
└ initializer.rb
└ main – _navi.html.erb
└ routes – blog
• ブログモジュールnavi viewを追加
<%= node_navi do %>
<nav class="sub-menu">
<header><h1><%=t"modules.blog" %></h1></header>
<div>
<%= link_to :"blog.page", blog_pages_path,
class: "icon-page" %>
</div>
</nav>
<% end %>

Blog Page Controller
/ – app
└ initializer.rb
└ pages_controller.rb
└ routes – blog
• ブログページ管理側コントローラー
class Blog::PagesController < ApplicationController
include Cms::BaseFilter
include Cms::PageFilter
include Workflow::PageFilter
model Blog::Page
append_view_path "app/views/cms/pages“
navi_view "blog/main/navi“
private
def fix_params
{ cur_user: @cur_user, cur_site: @cur_site,
cur_node: @cur_node }
end
#public
# Cms::PageFilter
end

Blog Page Controller
/ – app
└ initializer.rb
└ routes – blog
• 必要なFilterをincludeします。
• Index show new…
class Blog::PagesController < ApplicationController
include Cms::BaseFilter
include Cms::PageFilter
include Workflow::PageFilter
model Blog::Page
append_view_path "app/views/cms/pages“
navi_view "blog/main/navi“
private
def fix_params
{ cur_user: @cur_user, cur_site: @cur_site,
cur_node: @cur_node }
end
#public
# Cms::PageFilter
end
Filterをinclude

Blog Config Locales
/ – app
└ initializer.rb
└ config – locales – blog – ja.yml
└ routes – blog
• ブログモジュールのlocaleを追加
ja:
blog:
page: ブログページ
modules:
blog: ブログ
" blog/page "
ブログ/ブログページ

Blog Page Routes
/ – app
└ initializer.rb
└ routes – blog – routes.rb
• ブログモジュールのroutesを追加
Blog::Initializer
concern :deletion do
get :delete, on: :member
end
content "blog" do
get “/” => redirect { |p, req| “#{req.path}/pages” },
as: :main
end
page "blog" do
get "page/:filename.:format" => "public#index",
cell: "pages/page"
end
end

ブログページ作成確認
作成したブログページを使ってみます。
1. 適当なフォルダー下でモジュールをブログに切り替え
2. 新規作成
→ ブログページが作成できます。

作成したブログページのMongoドキュメント(レコード)をチェックしてみます。
#mongo

#mongo
#use ss_sample

#mongo
#use ss_sample
#db.cms_pages.find({route: "blog/page"})

#mongo
#use ss_sample
#db.cms_pages.find({route: "blog/page"})
{
"_id" : 43,
"permission_level" : 1,
"group_ids" : [1],
"state" : "public",
"order" : 0,
"category_ids" : [ ],
"file_ids" : [ ],
"related_page_ids" : [ ],
"route" : "blog/page",
“name” : “ページサンプル",
“layout_id” : 10, …

/ – app
└ initializer.rb

ここまでで新しいページが作成できるようになりました。
しかし、これでは記事ページと変わらないので..
→ 入力フォームをカスタマイズします。
#git checkout -b sample-blog-addon origin/sample-blog-addon
#rake unicorn:restart

天気入力フォーム作成
シラサギWiki：天気入力フォーム作成

※ページのアドオンを追加し入力フォームを追加します。

※公開側では入力した天気と日付を表示します。

Blog Weather Addon
/ – app
├ models – blog – addon.rb
├ views – blog
└ routes – blog
• 天気アドオンを追加
module Blog::Addon
module Weather
extend ActiveSupport::Concern
extend SS::Addon
set_order 190
included do
field :weather, type: String
permit_params :weather
public
def weather_options
[ ["晴れ", "sunny"], ["曇り", "cloudy"],
["雨", "rain"], ["雪", "snow"], ]
end
end
end
end
addonの表示順
fieldを定義

Blog Page Model
/ – app
└ page.rb
├ views – blog
└ routes – blog
class Blog::Page
include Blog::Addon::Weather
private
end
def seq_filename
end
end
Include Weather Addon

Blog Weather Addon Index View
/ – app
└ page.rb
├ views – blog – addons – weather – _form.html.erb
├ _show.html.rb
└ controllers – blog └ index.html.erb
└ routes – blog
• アドオンのviewを作成

Blog Weather Addon Index View
/ – app
└ page.rb
├ _show.html.rb
└ routes – blog
• アドオンのviewを作成
管理画面入力フォーム
管理画面表示
公開画面表示

Blog Config Locales
/ – app
└ page.rb
├ _show.html.rb
└ routes – blog
• localeを追記
ja:
blog:
page: ブログページ
sunny: ☀
cloudy: ☁
rain: ☂
snow: ☃
modules:
blog: ブログ
addons:
blog/weather: 今日の天気
mongoid:
attributes:
cms/page/model: weather: 天気

管理画面から"今日の天気"を入力してみます

/ – app
└ page.rb
├ _show.html.rb
└ routes – blog

天気入力フォーム作成練習
1. 天気マークを追加してみてください（雷注意報、にわか雨、お花見日和…
2. 別の入力フォームを作ってみてください（別のアドオンを作成
3. 修正したコードをローカルでcommitしてみてください（おまけ

独自の入力フォームを作成しました。
最後にフォルダーの作成を説明します。
#git checkout -b sample-blog-node origin/sample-blog-node
#rake unicorn:restart

一覧フォルダー作成
シラサギWiki：一覧フォルダー作成

※「フォルダー属性」ブログページリストが作成できるようになります

※公開側のページ一覧を変更し独自のものを作成します

Blog Node Model
/ – app
├ models – blog – node.rb
├ views – blog
└ routes – blog
• ブログ一覧フォルダーを作成
module Blog::Node
class Base
include Cms::Node::Model
default_scope ->{ where(route: /^blog//) }
end
class Page
include Cms::Node::Model
include Cms::Addon::PageList
end
end

Blog Agents Nodes/Page Controller
/ – app
├ views – blog – agents – nodes – page – index.html.erb
└ controllers – blog – agents – nodes – page_controller.rb
└ routes – blog
• 公開側コントローラー、一覧ビューを作成
• agents/nodes/page

Blog Agents Nodes/Page Controller
/ – app
└ routes – blog
• 公開側コントローラー、一覧ビューを作成
• agents/nodes/page
class Blog::Agents::Nodes::PageController < ApplicationController
include Cms::NodeFilter::View
helper Cms::ListHelper
Public
def pages
Blog::Page.site(@cur_site).public(@cur_date).
where(@cur_node.condition_hash)
end
def index
@items = pages.
order_by(@cur_node.sort_hash).
page(params[:page]). per(@cur_node.limit)
render_with_pagination @items
end
end

Blog Config Locales
/ – app
└ routes – blog
• localeに追記
ja:
…
cms:
nodes:
blog/page: ブログページリスト
…

Blog Config Locales
/ – app
• routesにnodeを追記
…
node "blog" do
get "page/(index.:format)" => "public#index",
cell: "nodes/page "
end
…
end

/ – app

管理画面から一覧フォルダーを作成してみます

まとめ
• 新しいページ、アドオン、フォルダーを作りました
• 既存のコードを変更せずにコンテンツを追加できます

最後に
長い時間ありがとうございました！
是非SHIRASAGIをカスタマイズしてみてください！

シラサギハンズオン東京

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

En vedette

En vedette (6)

Similaire à シラサギハンズオン東京

Similaire à シラサギハンズオン東京 (20)