choron_support 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e930829f733348afe1938ef857477f85bcc15695e67a31a491e50cd65cb3cc42
-  data.tar.gz: 41287fc1cdd25345988f03b2ba780e777e8d478413e7f78a907b7931ad362535
+  metadata.gz: 650ed706fe5c243363f5a83fc8029023897c19a2cfc6b8973abcd85a8ba8b28e
+  data.tar.gz: 96ee27b7f7ac4de9f717ad2ea8ec5076f2d08462f440bc6107175fc6fe1dd9fe
 SHA512:
-  metadata.gz: 426090be576fe116a04f6c939c89741868dd5b0b38e495d0fd6b1d613f02af280b8ac6046b0123504323fe2cbb6f7b938e6742863d7dc594626eb4436ccf38a4
-  data.tar.gz: fb03ba53c19263bffcb80b3aad9853c87cffd53410a8c3246b512625ca549fa7af15ec618ce2fca50d32a055a5fd92572b61fd8cc5e48008a51542b2ad71f476
+  metadata.gz: 5ae8dba1af0adfa9dac9adc55056dedcb7c9fc191ed2cbc3d2650eb6d992f1b3974f1d6138f76fea7a5fc616c51220782451abaa85aa12d01f8f7828b1ea0831
+  data.tar.gz: eb17113982a53b1ae1b888ad798ab22433bfb8b4e603cf0aaee767f51fe4e3bdc872cad18f178350bb5b8aa7f370fed6e5a13bec83c344802b09980b518f0113

data/Gemfile

@@ -9,4 +9,4 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    choron_support (0.1.8)
+    choron_support (0.1.9)
       activesupport
 
 GEM

data/Makefile

@@ -12,7 +12,7 @@ run:
 	docker-compose up
 
 web:
-	eval "docker exec -it `docker ps | grep _web_ | cut -d' ' -f1` /bin/bash"
+	eval "docker exec -it `docker ps | grep choron_support-web- | cut -d' ' -f1` /bin/bash"
 
 clean:
 	docker system prune
@@ -30,5 +30,8 @@ d-build-no-cache:
 install:
 	docker-compose run web bash -c "gem uninstall bundler && gem install bundler -v 2.3.13 && bundle install && yarn install"
 
+spec-db-create:
+	DB_CREATE=true bundle exec rspec spec/*
+
 spec-table-create:
 	bundle exec ridgepole --config ./spec/rails/config/database.yml --file ./spec/rails/config/schemafile --apply

data/README.md

@@ -27,50 +27,11 @@ ChoronSupport.using :all
 
 ### AsProps
 
-`#as_props` はオブジェクトやモデルをhashに変換するものです。
+モデルをJSON(キーがローキャメルケース)に変換するための仕組みです。
 
-名前の `props` の由来は `React` からきています。
-由来の通り、RailsからJS側へ値を渡す際にオブジェクトをJSON化するために作られました。
+* 詳細な使い方は [テストファイル](./spec/choron_support/as_props_spec.rb) を参照ください。
+* 詳細な実装は [こちら](./lib/choron_support/as_props.rb) です。
 
-#### 使い方
-
-* ActiveRecord
-
-```ruby
-class User < ApplicationRecord
-  include ChoronSupport::AsProps
-  # id: bigint
-  # name: string
-end
-
-# ActiveRecordから利用
-User.new.as_props
-#=> { id: nil, name: nil }
-
-User.create(id: 1, name: "tarou")
-
-User.find(1).as_props
-#=> { id: 1, name: "tarou" }
-
-# ActiveRecord::Relationからでも利用できます
-users = User.all.as_props
-#=> [
-#  { id: 1, name: "tarou" },
-# ]
-
-class Props::User < ChoronSupport::Props::Base
-  def as_props
-    model
-      .as_json
-      .merge(
-        name: "tanaka #{model.name}"
-      )
-  end
-end
-
-user = User.find(1).as_props
-#=> { id: 1, name: "tanaka tarou" }
-```
 
 ### Mask
 
@@ -81,15 +42,27 @@ user = User.find(1).as_props
 
 ### Domain
 
-* TODO
+モデルの処理をメソッド単位で別クラスに委譲するための仕組みです。
+クラスメソッド、インスタンスメソッドの両方で利用できます。
+
+* 詳細な実装と使い方は [こちら](./lib/choron_support/domain_delegate.rb) を確認してください。
 
 ### Forms
 
-* TODO
+ControllerでFormクラスのインスタンスを簡単に生成するための仕組みです。
+
+* 詳細な実装と使い方はいかを参照してください。
+  * [build_form](./lib/choron_support/build_form.rb)
+    * ControllerからFormクラスのインスタンスを簡単に生成するメソッドです
+  * [ChoronSupport::Forms::Base](lib/choron_support/forms/base.rb)
+    * Formクラスのベースとなるクラスです
 
 ### Query
 
-* TODO
+モデルのscope処理を別クラスに異常するための仕組みです。
+もともと存在する `queryパターン` を簡単に使えるようにしたものです。
+
+* 詳細な実装と使い方は [こちら](./lib/choron_support/scope_query.rb) を確認してください。
 
 ## Develop
 
@@ -101,46 +74,36 @@ Dockerを起動することで開発環境が整います
 make d-build
 ```
 
-* Docker コンテナの起動
+* Dockerコンテナの起動
 
 ```bash
 make run
 ```
 
-* テスト用のDBおよびテーブルの作成 & RSpecの実行
-  * spec/spec_helper.rb を開いて下記にあるDBの作成/Tableの作成のフラグを true に書き換えてから、テストを実行してください
-    * `bin/rspec spec`
-
+* コンテナ内部に入る
 
-## 本Gemの思想
-
-Railsにはこれまで多くのリファクタリング手法が、多くの人々から提案されてきました。
-その中で本Gemは以下の思想をサポートするようにしています
-
-* レイヤーを多く作らずにModelへ処理を凝集する
-  * Railsがデフォルトで用意してくれている `controllers`, `models`, `views` といったレイヤーのみをできるだけ使い、独自のレイヤーを**あまり**追加しない
-* Modelの見通しをよくするためにファイル内の処理を委譲させる
-  * 委譲先のクラスはModel以外からは直接呼び出さない(必ずModelにpublicなメソッドを経由させる)
-
-これによりドメインの知識をModelレイヤーに集めつつ、
-中規模以上のシステムになってきた際のファットモデルによる問題を解消する取り組みを行います
-
-### 具体的な取り組み
-
-Modelの中で行われる処理の中でも、本Gemは以下の処理を簡易に別クラスへ委譲させます
+```bash
+make web
+```
 
-* ビジネスロジック・ドメインロジック
-* DBへのアクセス・取得
-* データを表示するための加工(json化)
+* テスト用のDBおよびテーブルの作成
 
+※Dockerコンテナ内部で実行してくださ
 
----
+```bash
+make spec-db-create
+make spec-table-create
+```
 
-以下、TODO
+* RSpecの実行
 
----
+```bash
+bin/rspec spec
+```
 
+## 本Gemの思想
 
+* [こちら](docs/idea.md)を参照ください
 
 ## License
 

data/docs/idea.md

@@ -0,0 +1,24 @@
+# 本Gemの思想
+
+(記載中...)
+
+## 概要
+
+Railsにはこれまで多くのリファクタリング手法が、多くの人々から提案されてきました。
+その中で本Gemは以下の思想をサポートするようにしています
+
+* レイヤーを多く作らずにModelへ処理を凝集する
+  * Railsがデフォルトで用意してくれている `controllers`, `models`, `views` といったレイヤーのみをできるだけ使い、独自のレイヤーを**あまり**追加しない
+* Modelの見通しをよくするためにファイル内の処理を委譲させる
+  * 委譲先のクラスはModel以外からは直接呼び出さない(必ずModelにpublicなメソッドを経由させる)
+
+これによりドメインの知識をModelレイヤーに集めつつ、
+中規模以上のシステムになってきた際のファットモデルによる問題を解消する取り組みを行います
+
+### 具体的な取り組み
+
+Modelの中で行われる処理の中でも、本Gemは以下の処理を簡易に別クラスへ委譲させます
+
+* ビジネスロジック・ドメインロジック
+* DBへのアクセス・取得
+* データを表示するための加工(json化)

data/docs/props.md

@@ -0,0 +1,235 @@
+# Propsについて
+
+## 概要
+Propsは一言で言うとローキャメルケースのキーを持つJSON変換用のHashです。
+
+Choronでは画面側の処理をReact + Typescrip の組み合わせで実現しています。
+このときに、React側のProps(このpropsはReactの世界のpropsです)に、モデルの値や値クラスの値をJSON形式で渡す必要があります。
+
+本モジュールのPropsは上記のReactへの値の受け渡しをサポートします。
+
+一般的なJSON化ツールの違いとしては、Javascript側の記法・慣習を優先するため、
+JSONのキーをローキャメルケース(fullName, isAdult,など)に自動変換します
+
+## Choronでの使い方
+
+### 基本的な使い方
+
+ChoronにはChoronSupportにある
+* ChoronSupport::Props::Base
+* ChoronSupport::Props::Attributes
+の2つのクラス・モジュールを継承&includedしたProps用の基底クラスを用意しています。
+
+```app/models/props/base.rb
+class Props::Base < ChoronSupport::Props::Base
+  include ChoronSupport::Props::Attributes
+end
+```
+
+そして以下の命名ルールにより、モデルごとのPropsクラスを作成しています
+* app/models/props/${モデル名}.rb
+  * 例: app/models/props/user.rb
+これは ChoronSupport::AsProps モジュールがモデル名から自動で props/**/*.rb を探し出してインスタンスを生成してくれる処理に由来します。
+
+```app/models/props/user.rb
+class Props::Foo < Props::Base
+  attributes :id, :name, :full_name
+  attributes :full_name, to: :self
+  def full_name
+    "#{model.first_name} #{model.last_name}"
+  end
+end
+```
+
+これで準備は完了です。
+以下のようにController等で利用ができます
+
+```app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  def index
+    users = User.all
+    props = {
+      users: users.as_props
+    }
+
+    render react_file(props: props)
+  end
+
+  def show
+    user = User.find(params[:id])
+    props = {
+      user: user.as_props
+    }
+
+    render react_file(props: props)
+  end
+end
+```
+
+サンプルコードからわかるように `#as_props` というメソッドはモデルおよびRelationの両方で利用が可能なように拡張をしています。
+
+この拡張を使うためには ChoronSupport::AsProps モジュールを ApplicationRecord にinclude する必要があります。
+
+Choronではすでに実施済です。
+
+```app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  include ChoronSupport::AsProps
+end
+```
+
+もしPropsクラスをわざわざ作らず、モデルのカラムをそのまま全てローキャメルケースで出したい時もあると思います。そのときは
+
+```
+user.as_props(:model)
+```
+
+と第一引数で `:model` を渡すことで、カラム全てをprops化します。
+※これは個人情報など思わぬ値も出力してしまう可能性もあるため、安全な処理にだけ使うことを推奨します
+
+また、キーワード引数を使うことでパラメーターを渡すことも可能です。
+これを利用すれば、Props側を利用する側から細かいPropsの出力調整ができます。
+
+```app/models/props/foo.rb
+class Props::Foo < Props::Base
+  attributes :id, :name
+  attributes :full_name, if: :show_name?
+  def show_name?
+    # #params で as_props 実行時のキーワード引数にアクセスができる
+    params[:show_name].present?
+  end
+end
+```
+
+これは以下のように利用できます
+
+```
+foo = Foo.find(1)
+foo.as_props(show_name: true)
+```
+
+また、この `DSL` を使うことで以下の情報がメタ情報として自動的に出力されます。
+* type: Props化を行なったクラスの名前(名前空間あり)
+* modelName: Props化を行なったモデルの名前(名前空間なし)
+
+```app/models/props/foos/bar.rb
+class Props::Foos::Bar < Props::Base
+  attributes :id, :name
+end
+```
+
+Foos::Bar.new.as_props
+#=> { id: x, name: "xxx", type: "Foos::Bar", modelName: "Bar" }
+
+もし `RAILS_ENV=test` のときはさらに Props化を行なったクラスもメタ情報として付与されます。
+
+Foos::Bar.new.as_props
+#=> { id: x, name: "xxx", type: "Foos::Bar", modelName: "Bar", propsClassName: "Props::Foos::Bar" }
+
+このメタ情報を使うことでテストの簡略化も可能となります。
+
+例えば Controller のテストを以下のように書くことができます。
+
+```spec/requests/foos_controller_spec.rb
+describe FoosController, type: :request do
+  describe "GET /foos/:id" do
+    let!(:id) { foo.id }
+    let!(:foo) { create(:foo) }
+    it "詳細画面が表示されること" do
+      is_expected.to eq 200
+
+      react = rendered_react("foo/show")
+      props = react.props
+      # 細かい値の設定はProps側の単体テストで担保しているため、ここでは使われているPropsのみ検証する
+      expect(props[:foo][:propsClassName]).to eq "Props::Foos::Bar"
+      # Choron では専用のマッチャーがあるため以下のように記載も可能
+      expect(props[:foo]).to be_use_props(Props::Foos::Bar)
+    end
+  end
+end
+```
+
+### DSLの細かい使い方
+* ChoronSupport::Props::Attributesのソースコードを参照ください
+  * https://github.com/mksava/choron_support/blob/main/lib/choron_support/props/attributes.rb
+
+### Propsの設計思想
+ChoronでのPropsはattributesのDSLでif文の指定が可能です。
+そうでなくてもpropsメソッドをオーバーライドすることでさらに細かい調整が可能です。
+
+しかしPropsの設計思想は「1つのPropsで複数のパターンのJSONを作成する」よりも「複数のパターンがある分、Propsクラスを作成する」にあります。
+
+たとえば「User」には個人情報が含まれいるため、Propsの出力を制御したいときは
+
+* 一般的な利用
+  * `app/models/props/user.rb`
+* スタッフなど個人情報にアクセス可能なユーザからの利用
+  * `app/models/props/users/staff.rb`
+* ログインしているユーザ自身が自分自身の情報を見たいときに利用
+  * `app/models/props/users/current.rb`
+
+というようにPropsクラスを複数作成することを検討してください。
+このとき、各Propsクラスは以下のように `#as_props` の第一引数を指定することで利用できます
+
+```
+# app/models/props/users/general.rb
+users = Users.all.as_props(:general)
+# app/models/props/users/staff.rb
+users = Users.all.as_props(:staff)
+# app/models/props/users/current.rb
+users = Users.all.as_props(:current)
+```
+
+## サンプルコード
+
+* Props を作成するときはこのサンプルコードを優先的に参考にしてください
+* Sample の部分は適宜作成したいモデル名に変更してください
+
+### ActiveRecord
+
+```app/models/sample.rb
+class Sample < ApplicationRecord
+end
+```
+
+```app/controllers/samples_controller.rb
+class SamplesController < ApplicationController
+  def index
+    samples = Sample.all
+    props = {
+      samples: samples.as_props(:general)
+    }
+
+    render react_file(props: props)
+  end
+end
+```
+
+```app/models/props/sample.rb
+class Props::Sample < Props::Base
+  attributes :id, :name, :created_at, :updated_at
+  attributes :is_sample?, to: :self
+
+  def is_sample?
+    true
+  end
+end
+```
+
+```app/models/props/samples/general.rb
+class Props::Samples::Genral < Props::Base
+  attributes :id, :created_at, :updated_at
+  attributes :is_sample?, to: :self
+
+  def is_sample?
+    false
+  end
+end
+```
+
+```app/models/props/samples/staff.rb
+class Props::Samples::Staff < Props::Base
+  self.union = :default
+  attributes :salary
+end
+```

data/lib/choron_support/as_props.rb

@@ -1,4 +1,5 @@
 require_relative "props/base"
+require_relative "props/attributes"
 require_relative "props/ext/relation"
 require_relative "props/ext/hash"
 module ChoronSupport
@@ -8,7 +9,7 @@ module ChoronSupport
     # @param [Hash] params その他のパラメータ。camel: false を指定すると自動でキャメライズしない。
     # @return [Hash]
     def as_props(type_symbol = nil, **params)
-      serializer = self.__get_props_class(type_symbol, **params)
+      serializer = self.__get_props_class(type_symbol, params)
 
       skip_camel = (params[:camel] == false)
       pass_params = params.except(:camel)
@@ -21,7 +22,7 @@ module ChoronSupport
 
     private
 
-    def __get_props_class(type_symbol, **params)
+    def __get_props_class(type_symbol, params)
       case type_symbol
       when Symbol, String
         # 名前空間の例: Serialize::Users
@@ -43,7 +44,7 @@ module ChoronSupport
       begin
         props_class = props_class_name.constantize
 
-        props_class.new(self)
+        props_class.new(self, params)
       rescue *rescue_errors
         # もしmodelを指定しているときはnilを返し、as_jsonを利用させる
         if type_symbol == :model

data/lib/choron_support/props/attributes.rb

@@ -0,0 +1,381 @@
+# 本クラス は include 先のクラスに対してキャメルケースのJSONを設定するためのDSLやメソッドを提供するモジュールです
+# このモジュールをincludeしたクラスは以下のような形で使うことを想定しています
+# @examle
+#   [app/models/values/money.rb]
+#   class Values::Money
+#     include ChoronSupport::Props::Attributes
+#     attributes :amount, :amount_with_unit, to: :self
+#     def initialize(amount)
+#       @amount = amount.to_i
+#     end
+#     def amount
+#       @amount
+#     end
+#     def amount_with_unit
+#       "#{amount}円"
+#     end
+#   end
+# Choronではデフォルトで以下のようなBaseクラスが作成されて、読み込みがされています
+# @example
+#   class Props::Base < ChoronSupport::Props::Base
+#     include ChoronSupport::Props::Attributes
+#   end
+# [使い方]
+# @example 最も簡単な例
+#   [app/models/props/user.rb]
+#   class Props::User < Props::Base
+#     # id, full_name, ageを出力させる
+#     # retult: { id: 1, fullName: "John Smith", age: 20 }
+#     attributes :id, :full_name, :age
+#   end
+# @example メソッドのデリゲート先を指定する
+#   [app/models/props/user.rb]
+#   class Props::User < Props::Base
+#     # result: { fullName: "John Smith" }
+#     attributes :full_name, to: :self
+#     def full_name
+#       "#{model.first_name} #{model.last_name}"
+#     end
+#   end
+# @example 関連先のModelのPropsを結合する
+#   class Props::User < Props::Base
+#     # result: { posts: posts.as_props } => { posts: [{ id: 1, title: "foo" }, { id: 2, title: "bar" }] }
+#     relation :posts
+#   end
+#
+# これらの各種DSLは複数同時に設定することもできます
+# @example 複数設定
+#   [app/models/props/user.rb]
+#   class Props::User < Props::Base
+#     # id, full_name, ageを出力させる
+#     attributes :id, :age
+#     attributes :full_name, to: :self
+#     relation :posts
+#     def full_name
+#       "#{model.first_name} #{model.last_name}"
+#     end
+#   end
+#
+# default値の設定やifオプションを渡して出力有無を動的に変更もできます
+# @example default, ifの設定
+#   [app/models/props/user.rb]
+#   class Props::User < Props::Base
+#     # age が nil のときは 0 を出力する
+#     # age が 20 以上のときのみ出力する
+#     attributes :age, default: 0, if: :show_age?
+#     def show_age?
+#       model.age >= 20
+#     end
+#   end
+#
+#
+# 本DSLを利用するときは基本的には attributes を使って設定するのが良いと思います
+# 細かな使い方モジュールの該当DSL(self.xxxx)の説明を参照してください
+module ChoronSupport
+  module Props
+    module Attributes
+      FORMATS = {
+        # HTMLのinput type="date"で使える形式
+        date: "%Y-%m-%d",
+        datetime: "%Y-%m-%dT%H:%M",
+      }.freeze
+      # 型のキャスト指定があってもキャストはしないメソッド
+      CAST_IGNORE_METHODS = [
+        # id は数値のほうが良いため
+        :id,
+      ].freeze
+      # デフォルト値を設定しない場合に使う値
+      NO_DEFAULT = Object.new.freeze
+
+      extend ActiveSupport::Concern
+
+      included do
+        # 本moduleはActiveSupportが使える環境でのみ動作します
+        unless defined?(ActiveSupport)
+          raise "ActiveSupport is not defined. Please require 'active_support/all' in your Gemfile"
+        end
+
+        # DSLで設定できる設定値たち ==========================
+        #  Props作成時に設定されるキーと値を設定します。
+        #  この値はDSLを経由して内部的に設定されていきます
+        class_attribute :settings_attributes
+        #  Props作成時に自動で付与される元のクラスの文字列を設定しないときはtrueを設定してください
+        #  @example
+        #    class Props::Foo < Props::Base
+        #      self.skip_meta_mark = true
+        #    end
+        class_attribute :skip_meta_mark, default: false
+        #  他のPropsクラスの結果を結合するときに結合先のProps識別子を設定してください
+        # @example
+        #   class Props::Foos::General < Props::Base
+        #     # すべてのカラムを出す
+        #     self.union = :model
+        #     # as_props の結果を結合する
+        #     self.union = :default
+        #     # as_props(:secure) の結果を結合する
+        #     self.union = :secure
+        #   end
+        class_attribute :union, default: nil
+        # ====================================================
+
+        # Props作成時に設定されるキーと値を設定します。
+        # @param [Symbol] key Propsのキーを指定してください
+        # @param [Symbol] method 値を代入するためのメソッドを指定してください。指定がないときはkeyをメソッドとして扱います
+        # @param [Symbol] to メソッドのデリゲート先を指定してください。指定がないときはmodelをデリゲート先として扱います。:selfを指定すると自身をデリゲート先として扱います
+        # @param [Symbol] cast デリゲート先のメソッドの戻り値に対して、さらにメソッドを実行するときは指定してください。
+        # @param [Object] default 値がnilのときに設定されるデフォルト値を指定してください。指定がないときはnilになります。
+        # @param [Proc | Symbol] if その値を出すときの条件。Symbolだとselfに対してsendを実行します
+        def self.attribute(key, method: nil, to: :model, cast: nil, default: NO_DEFAULT, if: nil)
+          self.settings_attributes ||= []
+          self.settings_attributes << { key:, to:, method: (method || key), cast:, default:, if: }
+        end
+
+        # 一度にまとめて複数のattributeを設定します
+        # 基本的なパラメータの説明はattributeを参照してください
+        # @param [Array<Symbol>] methods 設定するキーと値のペアを指定してください
+        # @example
+        #   model = User.new(id: 1, name: "John", email: "JOHN@EXAMPLE", age: nil)
+        #   class Props::User::Foo < ChoronSupport::Props::Base
+        #     attributes :id, :name, :email, :age
+        #       #=> { id: 1, name: "John", email: "JOHN@EXAMPLE", age: nil }
+        #   end
+        # @note to, cast, defaultなどのパラメータについて
+        #   これらの値は全てのメソッド・キーに対して同じ値が設定されます
+        def self.attributes(*methods, to: :model, cast: nil, default: NO_DEFAULT, if: nil)
+          methods.each do |method|
+            attribute(method, method:, to:, cast:, default:, if:)
+          end
+        end
+
+        # Modelに対して関連付けされた別ModelのPropsを結合するためのDSLです
+        # to, cast, default, if については attribute と同じです
+        # @param [Symbol] key Propsのキーを指定してください
+        # @param [Symbol] relation 結合するModelのメソッドを指定してください。指定がないときはkeyをメソッドとして扱います
+        # @example
+        #   class Props::User < ChoronSupport::Props::Base
+        #     relation :posts
+        #     #=> { posts: user.posts.as_props } と同じ結果になる
+        #     relation :posts, props: :foo_bar
+        #     #=> { posts: user.posts.as_props(:foo_bar) } と同じ結果になる
+        #     relation :user_posts, relation: :posts
+        #     #=> { user_posts: user.posts.as_props } と同じ結果になる
+        #   end
+        def self.relation(key, relation: nil, to: :model, cast: nil, default: NO_DEFAULT, props: nil, if: nil)
+          relation ||= key
+          method = lambda { |model|
+            records = model.send(relation)
+            if props
+              records&.as_props(props) || {}
+            else
+              records&.as_props || {}
+            end
+          }
+          self.attribute(
+            key,
+            method:,
+            to:,
+            cast:,
+            default:,
+            if:,
+          )
+        end
+
+        # self.relation の複数同時に設定ができるversionです
+        # 基本は上記と一緒ですが、relationとkeyは同じである必要があります
+        # @example
+        #   class Props::User < ChoronSupport::Props::Base
+        #     relations :posts, :comments
+        #     #=> { posts: user.posts.as_props, comments: user.comments.as_props } と同じ結果になる
+        #   end
+        def self.relations(*keys, to: :model, cast: nil, default: NO_DEFAULT, props: nil, if: nil)
+          keys.each do |key|
+            method = lambda { |model|
+              records = model.send(key)
+              if props
+                records&.as_props(props) || {}
+              else
+                records&.as_props || {}
+              end
+            }
+            self.attribute(
+              key,
+              method:,
+              to:,
+              cast:,
+              default:,
+              if:,
+            )
+          end
+        end
+
+        # Propsに設定されるキーと値のペアを返します
+        # @param 各種パラメータは self.attribute に合わせているためそちらを参照してください
+        # @return [Hash] 設定されるPropsのキーと値のペア
+        # @note memo
+        #   if が予約語のため options として受け取っています。_ifも検討しましたが全体でキーワードの形を合わせたかったためoptionsの形にしています
+        def attribute(key, method: nil, to: :model, cast: nil, default: NO_DEFAULT, **options)
+          __build_props_attribute__(key, (method || key), to, cast, default, **options)
+        end
+
+        # 一度にまとめて複数のattributeを設定します
+        # パラメータは self.attributes に合わせているためそちらを参照してください
+        def attributes(*methods, to: :model, cast: nil, default: nil, **options)
+          _props = {}
+          methods.each do |method|
+            key = method.to_sym
+            unit_props = __build_props_attribute__(key, method, to, cast, default, **options)
+
+            _props.merge!(unit_props)
+          end
+
+          # ブロックが渡されていれば実行する
+          if block_given?
+            _props = yield(_props)
+          end
+
+          # Classのマークをつける(テスト用)
+          _props.merge!(__build_props_class_mark__)
+          # Modelのマークをつける
+          _props.merge!(__build_props_meta_mark__)
+
+          _props
+        end
+
+        # @override
+        #   Props::Base#as_props をオーバーライドしています
+        #   本モジュールを読み込んだクラスではas_propsはオーバーライドせず、DSLとpropsメソッドを上書きしてください
+        # @note 仕様
+        #   クラス側で設定されたattribute, attributesを元にPropsを作成します
+        #   もしくはオーバーライドされているであろう props の結果を設定します
+        #   もし両方を設定しているときはどちらの値も設定されます
+        #     キーがかぶっているときはprops側が優先されます
+        # @return [Hash] props
+        def as_props
+          _props = {}
+
+          # 結合先が指定されていればその結合先のpropsを取得する
+          if self.class.union.present?
+            if self.class.union == :default
+              _props.merge!(model.as_props)
+            else
+              _props.merge!(model.as_props(self.class.union))
+            end
+          end
+
+          # DSLの設定があればそれを設定する
+          self.class.settings_attributes.to_a.each do |settings|
+            _props.merge!(
+              attribute(settings[:key], method: settings[:method], to: settings[:to], cast: settings[:cast], default: settings[:default], if: settings[:if])
+            )
+          end
+
+          # Classのマークをつける(テスト用)
+          _props.merge!(__build_props_class_mark__)
+          # Modelのマークをつける
+          _props.merge!(__build_props_meta_mark__)
+          # Propsがオーバーライドされていればその値で上書きする
+          _props.merge!(self.props)
+
+          _props
+        end
+
+        # @return [Hash] props
+        # @note
+        # 　オーバーライドして使うことを想定しています
+        def props
+          {}
+        end
+      end
+
+      private
+
+      # @param [Array<Symbol>] methods
+      # @param [Symbol] key
+      # @param [Symbol] to メソッドのデリゲート先
+      # @param [Block] blockを渡すと実行結果をブロック引数でわたし、その中の戻り値を結果として返します
+      # @param [Symbol] cast デリゲート先のメソッドの戻り値に対して、さらにメソッドを実行する
+      # 複雑性を増す代わりに集約をさせています
+      def __build_props_attribute__(key, method, to, cast, default, **options)
+        props = {}
+
+        _if = options[:if]
+        if _if.present?
+          result = _if.is_a?(Proc) ? _if.call(model) : send(_if)
+          return {} unless result
+        end
+
+        # javascriptは?をキーとして使えないので削除しつつ、isXxx形式に変換する
+        if key.to_s.end_with?("?")
+          key = key.to_s.gsub("?", "").to_sym
+          key = "is_#{key}".to_sym unless key.start_with?("is_")
+        end
+
+        # valはこの後の工程で書き換えの可能性があるため注意
+        if to == :self
+          if method.is_a?(Proc)
+            val = method.call(self)
+          else
+            val = send(method)
+          end
+        else
+          if method.is_a?(Proc)
+            val = method.call(send(to))
+          else
+            val = send(to)&.send(method)
+          end
+        end
+
+        case val
+        when Date
+          val = val.strftime(FORMATS[:date])
+        when ActiveSupport::TimeWithZone, Time
+          # 日付系であればjsで使えるようにhtmlに変換する
+          val = val.strftime(FORMATS[:datetime])
+        else
+          if cast.present? && CAST_IGNORE_METHODS.exclude?(key)
+            val = cast.to_s.split(".").inject(val) do |lval, cast_method|
+              lval.send(cast_method)
+            end
+          end
+        end
+
+        if val.nil? && default != NO_DEFAULT
+          val = default
+        end
+
+        props[key] = val
+
+        props
+      end
+
+      # テストモードのときはどのPropsを実行したかを判定できるように属性をつけたします
+      def __build_props_class_mark__
+        mark = {}
+        if ENV["RAILS_ENV"] == "test"
+          mark[:props_class_name] = self.class.name
+          if self.class.union.present?
+            mark[:union_type_name] = self.class.union
+          end
+        end
+
+        mark
+      end
+
+      # どのモデルのPropsかを判定できるように属性をつけたします
+      def __build_props_meta_mark__
+        return {} if self.class.skip_meta_mark
+
+        type_target = begin
+          model
+        rescue StandardError
+          self
+        end
+
+        {
+          type: type_target.class.try(:name).to_s,
+          model_name: type_target.class.try(:name).try(:demodulize).to_s,
+        }
+      end
+    end
+  end
+end

data/lib/choron_support/props/base.rb

@@ -1,17 +1,40 @@
+# 本クラスはChoronSupportを利用しているRailsで継承されることを想定して作成されてます
+# Choronでは以下のようにBaseクラスがデフォルトで作成されています
+# @example
+#   [app/models/props/base.rb]
+#   class Props::Base < ChoronSupport::Props::Base
+#     include ChoronSupport::Props::Attributes
+#   end
+# そして各種モデルのPropsは上記のBaseクラスを継承して作成されています
+# @example
+#   [app/models/props/user.rb]
+#   class Props::User < Props::Base
+#     attributes :id, :name, :age
+#   end
+#   [app/models/props/users/secure.rb]
+#   class Props::Users::Secure < Props::Base
+#     # secure側はageは非表示
+#     attributes :id, :name
+#   end
 module ChoronSupport
   module Props
     class Base
-      def initialize(model)
+      # @param [ActiveRecord::Base] model Props対象のモデルのインスタンス
+      # @param [Hash] params その他のパラメータ
+      def initialize(model, params = {})
         @model = model
+        @params = params
       end
 
+      # 継承先で実装されることを想定しています
+      # ChoronSupport::Props::Attributes を読み込んでいるときは、そちらでオーバーライドされています
       def as_props
         raise NotImplementedError
       end
 
       private
 
-      attr_reader :model
+      attr_reader :model, :params
     end
   end
-end
+end

data/lib/choron_support/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChoronSupport
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choron_support
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - mksava
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -199,6 +199,8 @@ files:
 - Rakefile
 - choron_support.gemspec
 - docker-compose.yml
+- docs/idea.md
+- docs/props.md
 - lib/choron_support.rb
 - lib/choron_support/as_props.rb
 - lib/choron_support/build_form.rb
@@ -206,6 +208,7 @@ files:
 - lib/choron_support/domains/base.rb
 - lib/choron_support/forms/base.rb
 - lib/choron_support/helper.rb
+- lib/choron_support/props/attributes.rb
 - lib/choron_support/props/base.rb
 - lib/choron_support/props/ext/hash.rb
 - lib/choron_support/props/ext/relation.rb