choron_support 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 650ed706fe5c243363f5a83fc8029023897c19a2cfc6b8973abcd85a8ba8b28e
-  data.tar.gz: 96ee27b7f7ac4de9f717ad2ea8ec5076f2d08462f440bc6107175fc6fe1dd9fe
+  metadata.gz: 4ed418bdccc564f3988b17a0fe5571d7e7bde690de9381b7e562e9866b4cbf3a
+  data.tar.gz: 476fe2f299614945830acea6a253a630dab27b45250cb04c5b60d9dbe14cc831
 SHA512:
-  metadata.gz: 5ae8dba1af0adfa9dac9adc55056dedcb7c9fc191ed2cbc3d2650eb6d992f1b3974f1d6138f76fea7a5fc616c51220782451abaa85aa12d01f8f7828b1ea0831
-  data.tar.gz: eb17113982a53b1ae1b888ad798ab22433bfb8b4e603cf0aaee767f51fe4e3bdc872cad18f178350bb5b8aa7f370fed6e5a13bec83c344802b09980b518f0113
+  metadata.gz: 716153850aa6324f6ad3619b83d9f27694ee9c1a8cea669ecd73e37e0f29212bd5ef9cae7871e3046aac80d55054fef17200dfe48de9a6c8a18c7b0ac3a955a7
+  data.tar.gz: 3a68ee8bcfa75ff86b99abd97da1dc662ba7d832b36e1cc56e8d3cd6c9f70dd905886a95f71e94fb32fa2fb86776e8398612a9eef8db9172c31fb0cde1a8b1b6

data/.rubocop.yml

@@ -1,13 +1,145 @@
+# 参考
+#   * デフォルト値の設定ファイル
+#   https://github.com/rubocop/rubocop/blob/master/config/default.yml
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.1.3
+  # Rubocop更新時に新しいルールがあれば適用する
+  NewCops: enable
+  # 使用しているgemに対して拡張ツールを提案してくれるか。
+  # 特に不要(そこまでrubocopに頼っていないため)
+  SuggestExtensions: false
+  Exclude:
+    # デフォルトの設定
+    - "vendor/**/*"
+    - "node_modules/**/*"
+    # テストファイルは対象外にしています
+    - "spec/**/*"
+    # 設定ファイルは特に変更することがないため
+    - "config/**/*"
+    # スクリプトファイルは除外(プロダクトとは関係ないため)
+    - "scripts/**/*"
+    # bin系はあまり変更することがないため
+    - "bin/**/*"
 
+# ドキュメントの無い public class は許可
+Style/Documentation:
+  Enabled: false
+# 空のメソッドを許可
+Style/EmptyMethod:
+  Enabled: false
+# if 内での個別変数代入を許可
+Style/ConditionalAssignment:
+  Enabled: false
+# else 内での if の許可
+Style/IfInsideElse:
+  Enabled: false
+# bad: [1,2,3].map { _1.to_s }, good: [1,2,3].map(&:to_s)
+#   _1.xxx のほうが読みやすいことが多いので false に変更しています
+Style/SymbolProc:
+  Enabled: false
+# 空の else を許可
+Style/EmptyElse:
+  Enabled: false
+# １行の場合に後置ifの強制を許可
+Style/IfUnlessModifier:
+  Enabled: false
+# not禁止を許可
+Style/Not:
+  Enabled: false
+# ガード句の強制を許可
+Style/GuardClause:
+  Enabled: false
+# if文等の空ブロックを許可
+Lint/EmptyConditionalBody:
+  Enabled: false
+# 使い分けが面倒なのでダブルで統一
 Style/StringLiterals:
-  Enabled: true
   EnforcedStyle: double_quotes
+# Hashやメソッドの階層化はスペース分だけ
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Metrics/ModuleLength:
+  Max: 400
+Metrics/BlockLength:
+  Max: 100
+Metrics/AbcSize:
+  Max: 65
+Metrics/ClassLength:
+  Max: 300
+Metrics/CyclomaticComplexity:
+  Max: 30
+Metrics/PerceivedComplexity:
+  Max: 30
 
 Layout/LineLength:
-  Max: 120
+  Max: 200
+Layout/TrailingEmptyLines:
+  Enabled: false
+Layout/HashAlignment:
+  Enabled: false
+
+# クラスとモジュール名を分けて記載するかどうか
+# 検索容易性を加味してfalseにする
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# frozen literal をコメントで書くかどうか
+# Ruby3系からデフォルトtrueなのでfalseにする
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# 1行の長さ。基本長くてもOK
+# Layout/LineLength:
+#   Max: 300
+
+# メソッド名の長さ
+# わかりやすさ重視とするので長さは考慮しない
+Metrics/MethodLength:
+  Enabled: false
+
+# Hashの最後の項目にカンマを許すかどうか
+# カンマあったほうが便利なのでfalse
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+# ブロックコメントを許可するかどうか
+# 使ってもいいではないかということで許可
+Style/BlockComments:
+  Enabled: false
+
+# self. をつけたほうがわかりやすいときもあるのでfalse(可読性重視)
+Style/RedundantSelf:
+  Enabled: false
+
+# 大文字の時点で定数と読み取れるので無理にmutableにしなくても良い
+Style/MutableConstant:
+  Enabled: false
+
+# _つきのメソッドを内部メソッドとしてはやすことがあるため
+Naming/VariableNumber:
+  Enabled: false
+
+# unless よりも if のほうが見やすいときがあるため
+Style/NegatedIf:
+  Enabled: false
+
+# _ 始まりの変数を許可するか
+# スコープの狭い変数として利用することがあるため許可する
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+# get とか set という名前のついたメソッドを許可するか
+# DSL的なものを利用するときに利用することもあるため許可する
+Naming/AccessorMethodName:
+  Enabled: false
+
+# DSL的なものを使うためパラメータは7個まで許可
+Metrics/ParameterLists:
+  Max: 7

data/.rubocop_todo.yml

@@ -0,0 +1 @@
+# 必要に応じて記載していってください

data/CHANGELOG.md

@@ -2,14 +2,22 @@
 
 ## [0.1.0] - 2022-12-04
 
-* Initial release
+- Initial release
 
 ## [0.1.8] - 2023-06-04
 
 ### `as_props`
 
-* もしPropsクラスが見つからなかった場合にエラーをraiseするように修正
+- もしPropsクラスが見つからなかった場合にエラーをraiseするように修正
 
 ### `set_mask_for`
 
-* マスク処理のAPIを提供開始
+- マスク処理のAPIを提供開始
+
+## [0.1.11] - 2024-08-24
+
+- `Props` の改善を実施
+  - `STI` のサポートを追加
+  - `only` や `except` で既存のPropsの一部の値だけを利用できるように修正
+- `Domain` の改善を実施
+  - `!` で終わるメソッドもデリゲートできるように修正

data/Gemfile.lock

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

data/README.md

@@ -25,13 +25,9 @@ ChoronSupport.using :all
 
 * 必要に応じて各種モジュールをincludeすることで利用できます
 
-### AsProps
-
-モデルをJSON(キーがローキャメルケース)に変換するための仕組みです。
-
-* 詳細な使い方は [テストファイル](./spec/choron_support/as_props_spec.rb) を参照ください。
-* 詳細な実装は [こちら](./lib/choron_support/as_props.rb) です。
+### Props
 
+* [Props ドキュメント](./docs/props.md)を参照ください
 
 ### Mask
 

data/choron_support.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "By using this library, you can incorporate some useful functions into Ruby on Rails."
   spec.homepage = "https://github.com/mksava/choron_support"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -34,17 +34,18 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "activesupport"
   spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "ridgepole"
+  spec.add_development_dependency "factory_bot_rails"
   spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry-rails"
+  spec.add_development_dependency "ridgepole"
+  spec.add_development_dependency "rspec-parameterized"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "spring"
   spec.add_development_dependency "spring-commands-rspec"
-  spec.add_development_dependency "pry-rails"
-  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "yard"
-  spec.add_development_dependency "factory_bot_rails"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "rspec-parameterized"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/docs/props.md

@@ -11,225 +11,25 @@ Choronでは画面側の処理をReact + Typescrip の組み合わせで実現
 一般的な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
+```ruby
+class Props::Samples::Foo < Props::Base
+  attribute :id
+  attribute :full_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
+sample = Sample.new(id: 100, full_name: "mksava")
+sample.as_props(:foo)
+#=> { id: 100, fullName: "mksava", type: "Foo", modelName: "Foo" }
 ```
 
-```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
-```
+* 詳細な使い方はテストファイルを参照ください。
+  * [一般的な使い方](../spec/choron_support/as_props/general_spec.rb)
+  * [エッジケース](../spec/choron_support/as_props/edge_spec.rb)
+  * [attribute DSLの使い方](../spec/choron_support/as_props/attribute_spec.rb)
+  * [inherit DSL の使い方](../spec/choron_support/as_props/inherit_spec.rb)
+  * [relation DSLの使い方](../spec/choron_support/as_props/relation_spec.rb)
+* 実装は以下を参照ください
+  * [as_props.rb](../lib/choron_support/as_props.rb)
+  * [props/](../lib/choron_support/props/)

data/lib/choron_support/as_props.rb

@@ -5,40 +5,53 @@ require_relative "props/ext/hash"
 module ChoronSupport
   module AsProps
     class NameError < StandardError; end
+
     # @param [Symbol, String, nil] type_symbol どのPropsクラスを利用してPropsを生成するかを指定するシンボル。nilのときはデフォルトのPropsクラスを利用する。
-    # @param [Hash] params その他のパラメータ。camel: false を指定すると自動でキャメライズしない。
+    # @param [Hash] params その他のパラメータ
+    # @param [Hash] params params[:camel] false を指定すると自動でキャメライズしない。
+    # @param [Hash] params params[:only] 指定した属性のみを出力します
+    # @param [Hash] params params[:except] 指定した属性を出力しません
+    # @param [Hash] params params[:sti] true を指定すると継承クラスのPropsを利用する
     # @return [Hash]
     def as_props(type_symbol = nil, **params)
-      serializer = self.__get_props_class(type_symbol, params)
+      pass_params = params.except(:camel, :sti)
 
+      serializer = __get_props_class(type_symbol, pass_params, sti: params[:sti])
       skip_camel = (params[:camel] == false)
-      pass_params = params.except(:camel)
       if serializer.nil?
-        skip_camel ? self.as_json : self.as_json.as_camel
+        skip_camel ? as_json : as_json.as_camel
       else
-        skip_camel ? serializer.as_props(**pass_params) : serializer.as_props(**pass_params).as_camel
+        skip_camel ? serializer.as_props : serializer.as_props.as_camel
       end
     end
 
     private
 
-    def __get_props_class(type_symbol, params)
+    def __get_props_class(type_symbol, params, sti:)
       case type_symbol
       when Symbol, String
-        # 名前空間の例: Serialize::Users
-        namespace = "Props::#{self.class.to_s.pluralize}"
-        # クラス名の例: :foo_bar => FooBar
+        model_namespace = if sti
+                            # STIのときは継承クラスのPropsを利用する
+                            self.class.superclass.to_s.pluralize
+                          else
+                            self.class.to_s.pluralize
+                          end
+        # 名前空間の例: Props::Users, Props::RealEstates::Buildings
+        namespace = "Props::#{model_namespace}"
+        # クラス名の例: :common => Common, :foo_bar => FooBar
         class_name = type_symbol.to_s.classify
-        # 例: Serialize::Users::FooBar
-        props_class_name = "#{namespace}::#{class_name}"
-      when nil
-        namespace = "Props"
-        # 例: User / Master::Plan
-        class_name = self.class.to_s
-        # 例: Props::User
+        # 例: Props::Users::Common, Props::RealEstates::Buildings::FooBar
         props_class_name = "#{namespace}::#{class_name}"
+      when Class
+        # Classが渡されているときはそのまま利用する
+        given_class = type_symbol
+        unless given_class.method_defined?(:as_props)
+          raise ArgumentError, "invalid class: #{given_class}, must be respond to :as_props. self: #{self.class}"
+        end
+
+        props_class_name = given_class.to_s
       else
-        raise ArgumentError
+        raise ArgumentError, "invalid type_symbol: #{type_symbol.inspect}. self: #{self.class}"
       end
 
       begin
@@ -46,15 +59,12 @@ module ChoronSupport
 
         props_class.new(self, params)
       rescue *rescue_errors
-        # もしmodelを指定しているときはnilを返し、as_jsonを利用させる
-        if type_symbol == :model
-          return nil
-        end
-
         if type_symbol.blank?
-          raise ChoronSupport::AsProps::NameError, "Props class not found: #{props_class_name}. Please create props class."
+          raise ChoronSupport::AsProps::NameError,
+                "Props class not found: #{props_class_name}. Please create props class. self: #{self.class}"
         else
-          raise ChoronSupport::AsProps::NameError, "Props class not found: #{props_class_name}. Got type symbol: #{type_symbol}."
+          raise ChoronSupport::AsProps::NameError,
+                "Props class not found: #{props_class_name}. Got type symbol: #{type_symbol}. self: #{self.class}"
         end
       end
     end

data/lib/choron_support/domain_delegate.rb

@@ -35,7 +35,7 @@ module ChoronSupport
 
         # 被ることがないようにど__をつけてメソッド名を定義します
         # 例: :__domains_users_purchase_object__
-        domain_object_method_name = ("__" + domain_class.to_s.underscore.gsub("/", "_") + "_object__").to_sym
+        domain_object_method_name = "__#{domain_class.to_s.underscore.gsub('/', '_')}_object__".to_sym
 
         define_method(domain_object_method_name) do
           # ドメインオブジェクトをインスタンス化したものを返します
@@ -83,8 +83,6 @@ module ChoronSupport
         end
       end
 
-      private
-
       def self.__generate_choron_domain_class(method_symbol, specific, class_name)
         # クラス名指定なしのときはメソッド名からクラスを推測する
         if class_name.to_s.empty?

data/lib/choron_support/helper.rb

@@ -5,21 +5,19 @@ module ChoronSupport
     class << self
       def generate_choron_class(namespaces, model_name, class_symbol, exception: true)
         # 命名規則に従いQueryクラスを自動で探して scope を設定する
-        namespace = begin
-          if namespaces.is_a?(Array)
-            namespaces.join("::")
-          else
-            namespaces.to_s
-          end
-        end
+        namespace = if namespaces.is_a?(Array)
+                      namespaces.join("::")
+                    else
+                      namespaces.to_s
+                    end
 
         unless model_name.to_s.empty?
           namespace = "#{namespaces}::#{model_name.pluralize}"
         end
 
         target_class_name = "#{namespace}::#{class_symbol.to_s.camelize}"
-        # ? 終わりはクラスに変換できないため
-        if target_class_name.end_with?("?")
+        # ? や ! 終わりはクラスに変換できないため
+        if target_class_name.end_with?("?") || target_class_name.end_with?("!")
           target_class_name.chop!
         end