とーますメモ

Ruby on Rails / Goなどの学習メモ

【Rails】サービスクラスについて自分なりにまとめてみた

Rails 設計

最近、設計した画面が４〜５個のモデルが絡む画面があった。
その時コントローラー内で実装した場合、肥大化することが容易に想像でき、
またどれか一つのモデル内で実装する処理としては複雑なため「サービスクラス」が必要なのではないかと思い調べてみた。

いろいろ調べているとこのページの内容がすごい良かった。
肥大化したActiveRecordモデルをリファクタリングする7つの方法（翻訳）

自分のケースの処理だと、入出力とバリデーションに対しての処理がメインになるため
この記事内で言う「Form Object」のパターンで対応することにした。
他にも「ActiveRecord」のオブジェクトを"装飾"して使用するDecoratorパターンは今後使えそう。

しかし、今後サービスクラス（Service Object）のケースを使用するケースが
あるかもしれないのでこの機会に詳細を調べてみる。
色々と検索すると、「サービスクラス」を安易に使用すると、逆にカオスになるので
使用は注意したほうが良いという記事が沢山見つかった。

サービスクラスを使用しようと思うケースは以下のパターンがあると思う。

１）肥大化したモデルのメソッドをサービスクラスに移す

本来モデルが持つべき知識を移しているので、サービスクラス内のコードが再利用しにくい。
この場合、「Value Object」や、同じグループのロジックを切り出したバニラクラスを継承や「コンポジション（または集約）」として使用するケースを
一度考えてみる。そのためにRailsにはdelegateやcomposed_ofなどの便利な機能がある。
単一モデルが肥大化した場合は、サービスクラスは使用しない方が良いと思う。

⭐Railsアンチパターン<モデル編>②Fat model - Qiita
継承のMix-inについて - Kazunori Kamiya - Medium
俺が悪かった。素直に間違いを認めるから、もうサービスクラスとか作るのは止めてくれ - Qiita

２）複数モデルを触るのでサービスクラスを作る

まずは本来モデルが持つべき責務ではないか？、誰が担う責務なのかを考える。
なぜならサービスクラスの責務を強制する仕組みがないため、実装者によっては、まったく意図しないコードができる可能性があるため。
そのため本来モデルにあるべきコードがサービスクラスに実装されてしまう状態が発生する。

ここでサービスクラス内ではなく、モデルクラス内にビジネスロジックを書けばよいのでは？という疑問もあると思うが
自分の場合、サービスクラスを使用する判断としては、「モデルが３つ以上絡む」場合に使用する方針にする。
それモデルが２つ程度で、リレーションがあるモデルなら、責務範囲として、いずれかのモデル内で完結させる。

また独自の計算ロジック、認証、外部API連携、プッシュ通知、メール送信など、「どのモデルにも属さないロジック」がある場合は、
サービスクラス内で書く。

Form Objectとの使い分けは以下

Form Object: 入出力がメインな処理
Serivce Object: ビジネスロジック

サービスクラスを使用する場合は、以下のルールに従って作成

クラス名: #{動詞}#{目的語}Service（#{名詞}#{動詞}er/orという命名方法もあるが、自分は誰が見ても、役割がすぐに分かるServiceを名前に入れる）
メソッド: publichメソッドは、execute(callやrunもあるが、自分はexecuteが好み)の１つのみ。他はprivateメソッドにしてカプセル化する。（単一責任の原則）
配置場所: app/services/内
責務: １つのビジネスロジックのみ。

Service Objectでありがちなアンチパターンとしては、たとえばManageUserというserviceがユーザーの作成と削除の両方を引き受けてしまうというものがあります。そもそもmanageという言葉だけでは責務があいまいになってしまい、オブジェクトがどんなアクションを実行すべきかを制御する方法も明確になりません。代わりにDeleteUserとCreateUserという2つのserviceに分けて導入すれば、コードも読みやすくなり、より自然になります。

Railsで重要なパターンpart 1: Service Object（翻訳）

以下のモジュールをincludeすることでXXXXService.new.call(params)と呼び出さず、XXXXService.call(params)と呼び出すことができる。
またexecuteの戻り値はサービスクラスのインスタンスを返す。
※以下のモジュールの読み込みもとにもexecuteのインスタンスメソッドが必要

module Service
  extend ActiveSupport::Concern
  class_methods do
    def execute(*args)
      service = new(*args)
　  service.execute
      service
    end
  end
end

[参考]
RailsのService層とうまく付き合うにはどうすればいいのか調べてみた - 男女比はカレーと福神漬けと同じくらい
Railsで重要なパターンpart 1: Service Object（翻訳）
Railsプロジェクトにサービスクラスを導入して4ヶ月たったので振り返る - Qiita
Railsでやってしまいがちな保守性を下げてしまうコードとその解決策 - Qiita
Ruby (off|with) the Rails - Speaker Deck

追記

エラー設計の良記事：
blogs.msdn.microsoft.com

【Rails】Rails4で親モデル用のサブディレクトリを作成し、STI（単一テーブル継承）をやってみる

Rails

サブディレクトリの作成

サブディレクトリを配置する場所は
app/models内。

ディレクトリ名はここでは「app/models/parents」とした。

Rails4ではmodels直下しか読み込まれないので
「config/application.rb」内に以下を追加し、models内のサブディレクトリ内のファイルも読み込まれるようにする。

config.autoload_paths += Dir["#{config.root}/app/models/**/"]

STIの設定

STIの説明については、以下のページが詳しい。
Railsでスーパータイプ/サブタイプを表現する方法を比較してみる - Qiita
[Rails]Model/テーブル設計で必ず覚えておきたいSTI | Raccoon Tech Blog [株式会社ラクーンホールディングス 技術戦略部ブログ]
みんなRailsのSTIを誤解してないか!? - Qiita

STIではなく具象クラスで対応する場合は以下の方法も使えそう。
[Rails 5] モデルの継承元がActiveRecord::BaseからApplicationRecordに変更された
[Rails] self.abstract_class = true の意味と挙動 « Codaholic

まずはモデルが参照するテーブルにtypeカラムを追加する。
XXXXXはテーブル名

$ bundle exec rails g migration AddTypeToXXXXX type:string

このtypeには「サブクラス名」が保存される。
サブクラスでnewすると、そのサブクラス名が自動的に保存され
allやfindすると自動的に、条件文にtype IN ('サブクラス名')が指定される。

すごい便利。

[その他参考]
サブディレクトリに配置したモデルクラスの名前を変更する - Ruby1.9とRails3で何か作ってみる
モデルをサブディレクトリに分割する Rails 3.2 - Qiita
https://qiita.com/yebihara/items/9ecb838893ad99be0561

【Laravel】Mac上で環境構築をしてみる

CakePHP Laravel

[前提]
※1 homebrewが既にインストールされている
※2 DBはMySQLを使用する

Composerのインストール

Railsでいうgemみたいなパッケージ管理ツールであるComposerをインストールし
ComposerからLaravelをインストール

インストール

$ brew install composer

確認

$ brew info composer

Laravelインストーラのインストール

Composerを利用しインストール

$ composer global require "laravel/installer"

Laravelのインストーラのパスが「$HOME/.composer/vendor/bin」に作成されるので
ここにパスを通す。

~/.bash_profile

export PATH="$PATH:$HOME/.composer/vendor/bin"

.bash_profileの再読込

$ source ~/.bash_profile

確認

$ laravel --version

Laravelで新規プロジェクトの作成

新規プロジェクトを作成したディレクトリに移動し、
そのディレクトリ内で、以下のコマンドでプロジェクトを作成

$ laravel new test_app

※composer経由でインストールする方法もあるが、こちらのほうが覚えやすい。
インストール 5.8 Laravel


しばらくすると、test_appディレクトリが作成され、その中に全てがインストールされるので
test_app内へ移動し、以下のコマンドでWebサーバーを起動させる

$ cd test_app
$ php artisan serve

そしてブラウザで「http://127.0.0.1:8000」にアクセスし、Laravelのトップページが表示されればインストール成功

またLaravel自体のバージョンを確認するには以下のコマンド

$ php artisan --version

各種設定

言語と時刻の設定

config/app.phpで設定

'timezone' => 'Asia/Tokyo',
...
'locale' => 'ja',

DB接続設定

アプリ用のデータベースを予め作成しておく。
※ここでは「test_db」を作成しておく。

ルートディレクトリにある「.env」の以下を編集
※ユーザ名とパスワードは任意

DB_DATABASE=test_db
DB_USERNAME=root
DB_PASSWORD=password

後は以下のコマンドを流して、エラーがでなければOK

$ php artisan migrate

[参考]
Mac OSにLaravelローカル開発環境構築 - Qiita
macOSに Laravel 5.6 をインストールする手順をまとめてみる - Qiita
Laravel ローカル環境構築（for XAMPP） - Laravel学習帳

デバック用ツール（laravel-debugbar）のインストール

インストール

$ composer require barryvdh/laravel-debugbar

config/app.phpの編集

'providers' => [
    ...
    Barryvdh\Debugbar\ServiceProvider::class,
    ...
],

...

'aliases' => [
    ...
    'Debugbar' => Barryvdh\Debugbar\Facade::class,
    ...
],

ルートディレクトリの.envを編集

APP_DEBUG=true

キャッシュをクリア

$ php artisan config:cache

ブラウザで127.0.0.1:8000にアクセスし、ブラウザ下部にデバックバーが出ればOK

アプリ作成の基本

基本的には以下の流れ

１）artisanコマンドでモデル、コントローラ、マイグレーションファイルを作成
２）マイグレーションの定義を記述し、migrate
３）モデルを作成
４）ルーティング設定
５）コントローラとVIEW(resources)を紐づけ
６）画面表示及びデバッグ

モデル作成は以下のサイトを参考に１行ブログを作成するときの例
Webアプリ開発入門 Laravel編のレッスン一覧 | プログラミング学習サービス【paizaラーニング】

１）記事を保存するテーブル作成のためのmigrationファイル
２）記事情報にCRUDに関するDB操作を行うためのmodelファイル
３）モデルにアクセスするためにリクエストを行うcontrollerファイル

を以下のコマンドで一気に作成。

$ php artisan make:model Article -m -c -r
  • m ... migrationも同時作成
  • c ... controllerも同時作成
  • r ... controllerを作成する場合、CRUD用のアクションもコントローラ内に作成される

ルーティングはこんな感じ。以下ではリストページと詳細ページを作成し
後でリンクで呼び出せるように、name関数を使用している。
routes/web.php

Route::get('/articles', 'ArticleController@index')->name('article.list');
Route::get('/article/{id}', 'ArticleController@show')->name('article.show');

【CakePHP2.x】メンテナンスページを作成する方法

PHP CakePHP

今更だが、古いCakePHP2.x系のソースを修正する必要があり、
メンテナンスモードを簡単に実装するため、以下のプラグインを使用。

github.com

ただ、TOPページはCakePHP3.x系のものっぽいので、
branchesをたどり、以下の2.x系のソースをダウンロードして使用する。
GitHub - fusic/maintenance at master

ソースコード一式をダンロードし、解凍後のフォルダを「Maintenance」とリネームして
app/Pluginに入れる。また自分の場合は、メンテナンス用のレイアウトも使用したかったため
以下のようにソースを修正または追加した。

[修正] app/Config/bootstrap.php

<?php
// メンテナンスモードプラグインの導入
CakePlugin::load('Maintenance');
// trueにするとメンテナンスモードになる
Configure::write('Maintenance.enable', false);

[修正] app/Controller/AppController.php

詳細は後述するが、
・メンテナンス用のコントローラ
・メンテナンス用のビュー
・メンテナンス用のレイアウト
を作成し、自分の開発環境からのIPを除外する前提で、AppController.phpを編集する。
controllerに「メンテナンス用のコントローラ」、actionに「メンテナンス用のビュー」を設定
そして自分の開発環境IPを「xxx.xxx.xxx.xxx」に設定する。

<?php

        class AppController extends Controller {
            public $components = array(
               'Maintenance.Maintenance' => array(
                  'maintenanceUrl' => array(
                     'controller' => 'maitenance',
                     'action' => 'index'
                  ),
                  'allowedIp' => array('xxx.xxx.xxx.xxx', '127.0.0.1'), // allowed IP address when maintanance status
                  # 'allowedAction' => array('posts' => array('index'), 'users' => array('*')) // allowed action when maintanance status
                )
             );
        }

[追加] app/Plugin/Maintenance/Controller/MaintenanceController.php

<?php
App::uses('AppController', 'Controller');

class MaintenanceController extends AppController {
	public function index() {
		$this->autoLayout = false;
		$this->layout = 'maintenance';
	}
}

[追加] app/Plugin/Maintenance/View/Maintenance/index.ctp

※任意の文字を設定

現在システムメンテナンス中です。今しばらくお待ち下さい。

[追加] app/Plugin/Maintenance/View/Layouts/default.ctp

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>メンテンナンス</title>
</head>
<body>
  <?php echo $this->fetch('content'); ?>
</body>
</html>


これで準備は完了。
メンテナンスモードにするには、
app/Config/bootstrap.phpの以下をtrueにすればOK

<?php
Configure::write('Maintenance.enable', true);

タイマー設定もでき、「app/tmp/maintanance」のファイルを作成し、
ファイル内に以下のように設定できることでタイマー設定ができる。

例1: Maintenance 2011/1/1 ~ 2011/1/3

2011-01-01 00:00:00,2011-01-03 23:59:59

例2: Maintenance 2011/12/28 ~

2011-12-28 00:00:00,

例3: Maintenance ~ 2011/3/31 12:00

,2011-03-31 12:00:00

[参考]
GitHub - fusic/maintenance at master
メンテナンスモードを簡単実装できるMaintenance plugin | CakePHPクッキング
Maintenance plugin for CakePHPの組み込み : 儲かる気がしないスマホアプリ開発日誌

【Python】Pythonを学習してみて思ったこと

Python

自分用メモ。

普段はRubyを使っているので、
以下の本を読みながら思ったことをメモしていく。
なにかの言語を既に触っているんだったら、１日あれば十分読める。

独学プログラマー Python言語の基本から仕事のやり方まで

独学プログラマー Python言語の基本から仕事のやり方まで

Rubyとの違い

・bool値がtureやfalseの小文字ではなく、先頭の文字を大文字にしたTrueとFalseが使用される。
Pythonは大文字と小文字を識別するので、tureやfalseと書いた場合エラーになる。
・nilではなく、None
・定数がない。慣習的に大文字とアンダーバー(_)で定数であることを表現する場合が多い。
・論理演算子で「&&」「|| 」「!」が使用できない。「and」「or」「not」を使用する。
・elsifではなくelif。elseは同じ。
・関数宣言のキーワードは、rubyと同じdef。
・if、elif、else、for、関数宣言の前などの最後にコロン(:)を書く。
・例外処理はtry - except - finally
・リストへの作成はlist = []で同じだが、追加はlist.appendという文法を使う。(<<できない）
・タプルというRubyでいう配列要素をfreezeしたようなものが使える。
・穴埋め文字列はPythondだとこんな感じ。"{}は{}年に生まれました。".format(author, year_born)。{}が文字が埋まる場所になる。
・Pythonのクラスでは、プライベート変数はない。Pythonの変数全てパブリックなので、アンダーバーを変数につけて名前規約でカバーする。
・x.nil?ではなくx is None

【Python】簡単な開発環境構築

Python

Pythonの基本環境構築は前回の記事で書いたので、その続き。
thoames.hatenadiary.jp

アプリの起動を逐一「pipenv shell」=> 「python app.py」とかするのが面倒くさいので
Pipfileに以下のように書いておけば、「pipenv run start」とすることでアプリを一発で起動できる。
何度の入力するコマンドなので、登録しておいたほうが良い。

[scripts]
start = "python app.py"

１）静的解析

他のツールであるpep8やpyflakesなどを包括している便利なラッパーなのでflake8を使用。
開発環境のみでしようするので「--dev」オプションを付けてインストール

$ pipenv install --dev flake8

flakeの設定ファイル（setup.cfgまたは.flake8）に以下の設定を追加
ここでは、Lint対象から除外するファイル及びディレクトリの設定、
１行あたりの文字数を設定、それとインデントをPEP8デフォルトの4にするルールを無視し、
インデント幅を2にしている。これは完全に好み。

[flake8]
exclude = .git, .tox, .venv, .eggs, build, dist, docs, tests/*
max-line-length = 120
ignore = E111, E114
indent-size = 2

普通に使う方法は「pipenv run flake8」を打つだけ。
自分の場合は「--show-source」オプションを付けて、ソースコードのどの部分を修正すればよいか詳しく
知りたいので、Pipfileの編集しショートカットを登録。

[scripts]
 :
lint = "flake8 --show-source ."
 :

以下のコマンドでflake8を起動

$ pipenv run lint

flake8には他にも便利なプラグインがあるので使用する。

[flake8-todo]: ソース内のTODO、FIXME、XXXを検出してくれる。
[flake8-quotes]: ダブルクオーテーションを使用しているかをチェックする。
※flake8-double-quotesも使用してみたが、動作しなかった。。。※python 3.7.2で検証
[flake8-print]: printデバックしてる箇所を見つける。（使用しないようにする）

flake8のプラグインは「pip search flake8-」で検索すると大量に表示される。

以下ではflake8-todoをインストールする例を示す。

インストール

$ pipenv install --dev flake8-todo

確認

$ pipenv run flake8 --version

後は普通にflake8を実行すれば、TODO箇所を抽出してくれる。

２）コードフォーマット

autopep8を使用する。

インストール

$ pipenv install --dev autopep8

インデント幅などの設定を書きたいときは、setup.cfg, tox.ini, .pep8または.flake8に書く。
また設定セクションはpep8, pycodestyleまたはflake8をセクションとして使用できる。
自分は以下のように設定

[pycodestyle]
indent-size = 2

Pipfileにショートカットを登録（i: 上書き, v: 実行時の詳細情報を表示, r: 再帰実行)

[scripts]
 :
fix = "autopep8 -ivr ."
 :

実行

$ pipenv run fix

備考:
Atomを利用している場合で、[atom-beautify]プラグインを入れている場合は、
autopep8と連動し、Ctrl + Option + bで自動整形してくれる。
また[atom-beautify]の設定画面でPythonを選ぶと、「保存時に自動整形」してくれるオプションがあるので
それにチェックを入れると、保存時に自動整形してくれるようになる。
※注意点としては、setup.cfgにインデントや無視するPEP8ルールの設定を書いていても、
それとは別にatom-beautify独自に別に設定を書く必要があること。

※ 追記 2019/04/04
pipenvのような仮想環境を使用し、atom-beautifyを使用している場合、
「Could not find 'autopep8'. The program may not be installed.」と表示される場合がある。
以下URL内のようなもの。
https://github.com/hhatto/autopep8/issues/363

この場合は、エラー内の説明にあるように
「Atom Beautify」 => 「Settings」 => 「Executable」=> 「autopep8」内に
仮想環境内のautopep8のパスを実行パスとして設定すれば良い。

仮想環境内のautopep8のパスの確認方法

$ pipenv run which autopep8

表示されたパスを、実行パスに設定すれば動作するようになる。






[参考]
Pythonのパッケージ周りのベストプラクティスを理解する - エムスリーテックブログ
Pythonのスタイルガイドとそれを守るための各種Lint・解析ツール5種まとめ！ - Sider Blog
Pythonでインデントをスペース2つにした際の周辺ツールの設定 | タロスカイ公式ブログ
[Python] コードの自動整形でインデントレベルを2に設定する - Qiita
Python の Lint (文法チェッカ) まとめ - flake8 + hacking を使う - - Qiita
2018年のPythonプロジェクトのはじめかた - Qiita