choron_support 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f5e95a92c449d959b9e9522a05e244461e98fb078b5405c93ceb873fdc5c49b
-  data.tar.gz: cec6ee644f7813d21e24039aadd30a6047e3a708a48cced1412f593c68be626a
+  metadata.gz: 4ed418bdccc564f3988b17a0fe5571d7e7bde690de9381b7e562e9866b4cbf3a
+  data.tar.gz: 476fe2f299614945830acea6a253a630dab27b45250cb04c5b60d9dbe14cc831
 SHA512:
-  metadata.gz: a77b9097a63624fc09fdea17886eb85861c37272058938739692b812fd728d658602020c1b56f0ac3d2ed7f08e51f3b9b234dac28d23e9590620b81ac6794e08
-  data.tar.gz: 5ceff8def9787ebf4bdadf656173669f5ef1271cf27e08b41ec22b122b134f1f3e19ef70f59674a3a714eb4061e617fd381ea0a84a8c542b2bb6f9803fc02cba
+  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.10)
+    choron_support (0.1.11)
       activesupport
 
 GEM

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/lib/choron_support/as_props.rb

@@ -5,16 +5,21 @@ 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)
-      pass_params = params.except(:camel)
+      pass_params = params.except(:camel, :sti)
 
-      serializer = self.__get_props_class(type_symbol, pass_params)
+      serializer = __get_props_class(type_symbol, pass_params, sti: params[:sti])
       skip_camel = (params[:camel] == false)
       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 : serializer.as_props.as_camel
       end
@@ -22,24 +27,31 @@ module ChoronSupport
 
     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::Users::Common, Props::RealEstates::Buildings::FooBar
         props_class_name = "#{namespace}::#{class_name}"
       when Class
+        # Classが渡されているときはそのまま利用する
         given_class = type_symbol
-        if given_class.ancestors.include?(ChoronSupport::Props::Base)
-          props_class_name = given_class.to_s
-        else
-          raise ArgumentError, "invalid class: #{given_class}"
+        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, "invalid type_symbol: #{type_symbol}"
+        raise ArgumentError, "invalid type_symbol: #{type_symbol.inspect}. self: #{self.class}"
       end
 
       begin
@@ -48,9 +60,11 @@ module ChoronSupport
         props_class.new(self, params)
       rescue *rescue_errors
         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
 

data/lib/choron_support/props/attributes.rb

@@ -1,4 +1,3 @@
-require_relative "./private/type_builder"
 require_relative "./private/setting"
 module ChoronSupport::Props::Attributes
   unless defined?(ActiveSupport)
@@ -18,13 +17,7 @@ module ChoronSupport::Props::Attributes
     #      self.skip_meta_mark = true
     #    end
     class_attribute :skip_meta_mark, default: false
-    # Propsから自動でtypescriptの型を生成しないときはfalseを設定してください
-    # @example
-    #   class Props::Foos::Bar
-    #     self.skip_typescript = true
-    #   end
-    class_attribute :skip_typescript, default: false
-    #  他のPropsクラスの設定を継承するときに設定されます
+    #  他のPropsクラスの設定を継承するときに設定されます。設定できるのは1つだけです
     class_attribute :inherit_props_class, default: nil
     # ====================================================
 
@@ -32,12 +25,13 @@ module ChoronSupport::Props::Attributes
     # @param [Symbol] method モデル, もしくは to オプションで設定したオブジェクトに対して実行するメソッドを指定してください
     # @param [Keyword] options その他のオプションを指定してください
     #   @option [Symbol] :to 指定したメソッドを実行するオブジェクトを指定できます
+    #   @option [Symbol] :name Props化するときに出力する属性(Key)名を指定できます
     #   @option [Symbol | lambda] :if 属性を出力するための条件を指定できます
     #   @option [Symbol] :cast 属性を出力する前に指定したメソッドを実行できます。
     #   @option [Boolean] :default 属性値がnilのときに代わりに出力する値を指定できます
     #   @option [Proc] &block ブロックを渡すとそのブロックの戻り値を属性値として出力します
     def self.attribute(method, **options, &block)
-      setting_params = options.merge(method: method, block: block)
+      setting_params = options.merge(method:, block:)
       setting = ChoronSupport::Props::Private::Setting.new(setting_params)
 
       self.settings ||= []
@@ -52,34 +46,39 @@ module ChoronSupport::Props::Attributes
     #   end
     def self.inherit(props_class)
       # 継承するクラスはProps::Baseを継承している必要があります
-      unless props_class.ancestors.include?(ChoronSupport::Props::Base)
-        raise "inherit class must be ChoronSupport::Props::Base. got: #{props_class}"
+      unless props_class.method_defined?(:as_props)
+        raise "inherit class must be respond to :as_props. #{props_class} is not respond to :as_props"
       end
 
       # 既に継承先が設定されている場合はエラーにします
-      if self.inherit_props_class.present?
-        raise "inherit props inherit class already set: #{self.inherit_props_class}.(Only one class can be inherited)"
+      if inherit_props_class.present?
+        raise "inherit props inherit class already set: #{inherit_props_class}.(Only one class can be inherited)"
       end
 
       self.inherit_props_class = props_class
       self.settings ||= []
-      self.inherit_props_class.settings.to_a.each do |setting|
+      inherit_props_class.settings.to_a.each do |setting|
         self.settings << setting
       end
     end
 
     # Modelに対して関連付けされた別ModelのPropsを結合するためのDSLです
     # @param [Symbol] method to オプションで指定されたオブジェクトに実行されるメソッドを指定してください
-    # @param [ChoronSupport::Props::Base] props モデルをProps化するためのクラスを指定してください
+    # @param [ChoronSupport::Props::Base | Symbol] props_class モデルをProps化するためのクラス もしくはそれを示す Symbol を指定してください
+    # @param [Array<Symbol>] only 指定した属性のみを出力します
+    # @param [Array<Symbol>] except 指定した属性を除外して出力します
+    # @param [Symbol] sti 継承元のクラスのPropsを利用したいときにtrueを指定してください
     # @param [Keyword] options その他のオプションを指定してください。詳細は attribute と同じです
     # @example
     #   class Props::Users::General < ChoronSupport::Props::Base
-    #     relation :posts, props: Props::Posts::General
-    #     #=> { posts: user.posts.as_props(:general) } と同じ結果になる
+    #     relation :posts, :general, only: %i[id title]
+    #     #=> { posts: user.posts.as_props(:general, only: %i[id title]) } と同じ結果になる
     #   end
-    def self.relation(method, props_class, **options)
-      self.attribute(method, **options) do |model, params|
+    def self.relation(method, props_class, only: nil, except: nil, sti: false, **options)
+      attribute(method, **options) do |model, params|
         records = model.send(method)
+        # only等の設定はrelationで設定したものを適用する
+        params.merge!(only:, except:, sti:)
         records&.as_props(props_class, **params)
       end
     end
@@ -88,9 +87,16 @@ module ChoronSupport::Props::Attributes
   # @return [Hash] props
   def as_props
     _props = {}
+    only_params = params[:only].to_a.map(&:to_sym)
+    except_params = params[:except].to_a.map(&:to_sym)
 
     # DSLの設定を設定する
     self.class.settings.to_a.each do |setting|
+      # 除外設定がある場合はスキップ
+      next if except_params.include?(setting.method.to_sym)
+      # only設定がある場合はそれ以外をスキップ
+      next if only_params.present? && only_params.exclude?(setting.method.to_sym)
+
       _props.merge!(__build_props_attribute__(setting))
     end
 
@@ -105,22 +111,22 @@ module ChoronSupport::Props::Attributes
   private
 
   def model
-    raise NotImplementedError, "model method is not implemented"
+    raise NotImplementedError, "model method is not implemented. Please implement model method in your class"
   end
 
   def params
-    raise NotImplementedError, "params method is not implemented"
+    {}
   end
 
   FORMATS = {
     # HTMLのinput type="date"で使える形式
     date: "%Y-%m-%d",
-    datetime: "%Y-%m-%dT%H:%M",
+    datetime: "%Y-%m-%dT%H:%M"
   }.freeze
   # 型のキャスト指定があってもキャストはしないメソッド
   CAST_IGNORE_METHODS = [
     # id は数値のほうが良いため
-    :id,
+    :id
   ].freeze
   # @param [Array<Symbol>] Setting
   def __build_props_attribute__(setting)
@@ -139,27 +145,25 @@ module ChoronSupport::Props::Attributes
       key = "is_#{key}".to_sym unless key.start_with?("is_")
     end
 
-    # valはこの後の工程で書き換えの可能性があるため注意
-    val = nil
+    # javascriptは!をキーとして使えないので削除する
+    key = key.to_s.gsub("!", "").to_sym if key.to_s.end_with?("!")
+
     method = setting.method
     to = setting.to
-    if setting.block.present?
-      val = setting.block.call(model, params)
-    else
-      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
-    end
+    # valはこの後の工程で書き換えの可能性があるため注意
+    val = if setting.block.present?
+            setting.block.call(model, params)
+          elsif to == :self
+            if method.is_a?(Proc)
+              method.call(self)
+            else
+              send(method)
+            end
+          elsif method.is_a?(Proc)
+            method.call(send(to))
+          else
+            send(to)&.send(method)
+          end
 
     case val
     when Date
@@ -175,9 +179,7 @@ module ChoronSupport::Props::Attributes
       end
     end
 
-    if val.nil? && setting.set_default?
-      val = setting.default
-    end
+    val = setting.default if val.nil? && setting.set_default?
 
     attribute[key] = val
 
@@ -190,7 +192,8 @@ module ChoronSupport::Props::Attributes
     if ENV["RAILS_ENV"] == "test"
       mark[:props_class_name] = self.class.name
       if self.class.inherit_props_class.present?
-        mark[:inherit_props_class_name] = self.class.inherit_props_class.try(:name) || self.class.inherit_props_class.to_s
+        mark[:inherit_props_class_name] =
+          self.class.inherit_props_class.try(:name) || self.class.inherit_props_class.to_s
       end
     end
 
@@ -209,7 +212,7 @@ module ChoronSupport::Props::Attributes
 
     {
       type: type_target.class.try(:name).to_s,
-      model_name: type_target.class.try(:name).try(:demodulize).to_s,
+      model_name: type_target.class.try(:name).try(:demodulize).to_s
     }
   end
 end

data/lib/choron_support/props/base.rb

@@ -7,25 +7,20 @@ module ChoronSupport
 
       # @param [ActiveRecord::Base] model Props対象のモデルのインスタンス
       # @param [Hash] params その他のパラメータ
+      # @param [Boolean] params params[:only] 指定した属性のみを出力します
+      # @param [Boolean] params params[:except] 指定した属性を出力しません
       def initialize(model, params = {})
         @model = model
-        @params = params
+        @params = params.to_h
       end
 
       private
 
       # @override
-      def model
-        @model
-      end
+      attr_reader :model
 
       # @override
-      def params
-        @params
-      end
+      attr_reader :params
     end
   end
 end
-
-__END__
-abcd

data/lib/choron_support/props/ext/hash.rb

@@ -6,4 +6,4 @@ class Hash
   def to_camel_json
     as_camel_json.to_json
   end
-end
+end

data/lib/choron_support/props/ext/relation.rb

@@ -5,6 +5,6 @@ class ActiveRecord::Relation
       return {}
     end
 
-    records.map {|record| record.as_props(type_symbol, **params) }
+    records.map { |record| record.as_props(type_symbol, **params) }
   end
 end

data/lib/choron_support/props/private/setting.rb

@@ -4,14 +4,14 @@ class ChoronSupport::Props::Private::Setting
   NO_DEFAULT = Object.new.freeze
   private_constant :NO_DEFAULT
   SETTING_ATTRIBUTES = %i[method name to cast default if block].freeze
-  private_constant :SETTING_ATTRIBUTES
 
-  SETTING_ATTRIBUTES.each {|atr_name| attr_reader atr_name }
+  SETTING_ATTRIBUTES.each { |atr_name| attr_reader atr_name }
 
   def initialize(params)
     # 不正なオプションがあれば例外を発生させる
     if (params.keys - SETTING_ATTRIBUTES).present?
-      raise Error, "invalid params: #{(params.keys - SETTING_ATTRIBUTES).join(", ")}, valid params are #{SETTING_ATTRIBUTES.join(", ")}"
+      raise Error,
+            "invalid params: #{(params.keys - SETTING_ATTRIBUTES).join(', ')}, valid params are #{SETTING_ATTRIBUTES.join(', ')}"
     end
 
     @method = params[:method]
@@ -26,17 +26,15 @@ class ChoronSupport::Props::Private::Setting
   end
 
   def set_default?
-    self.default != NO_DEFAULT
+    default != NO_DEFAULT
   end
 
   private
 
   def check_params!
-    if name.blank?
-      raise Error, "name is required"
-    end
-    if method.blank?
-      raise Error, "method is required"
-    end
+    raise Error, "name is required" if name.blank?
+    return unless method.blank?
+
+    raise Error, "method is required"
   end
 end

data/lib/choron_support/queries/base.rb

@@ -7,7 +7,7 @@ module ChoronSupport
         @records = model_class.try!(:all)
       end
 
-        # 各種このメソッドをオーバーライドしてください
+      # 各種このメソッドをオーバーライドしてください
       def call
         raise NotImplementedError
         # @example 実装例

data/lib/choron_support/scope_query.rb

@@ -16,12 +16,12 @@ module ChoronSupport
 
       def self.scope_query(query, specific: true, class_name: nil)
         # 直接Queryクラスを指定されていたらすぐにscopeにプロキシして返す
-        if !class_name.to_s.empty?
-          query_class = class_name.to_s.constantize
-        else
+        if class_name.to_s.empty?
           namespace = "Queries"
           model_name = specific ? self.to_s : nil
           query_class = ChoronSupport::Helper.generate_choron_class(namespace, model_name, query)
+        else
+          query_class = class_name.to_s.constantize
         end
 
         # ActiveRecordのscopeメソッドを呼びます

data/lib/choron_support/set_mask_for.rb

@@ -9,7 +9,7 @@ module ChoronSupport
     MASKING_VALUES = { string: "****", else: nil }.freeze
 
     included do
-      def self.set_mask_for(*method_symbols, condition: nil)
+      def self.set_mask_for(*method_symbols)
         method_symbols.each do |method_symbol|
           self.instance_eval { private attr_accessor WITH_OUT_MASK_FLAG_VARIABLE_NAME }
           define_method(method_symbol) do
@@ -34,11 +34,11 @@ module ChoronSupport
 
           # マスクの値に関係なく元の値を取得するためのメソッドです。
           define_method("danger_without_mask_#{method_symbol}") do
-            val = nil
+            origin = nil
             self.without_mask do |model|
-              val = model.send(method_symbol)
+              origin = model.send(method_symbol)
             end
-            val
+            origin
           end
         end
 
@@ -74,4 +74,4 @@ module ChoronSupport
       end
     end
   end
-end
+end

data/lib/choron_support/version.rb

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

data/lib/choron_support.rb

@@ -27,7 +27,7 @@ module ChoronSupport
     module_names.to_a.each do |module_name|
       case module_name.to_sym
       when :all
-        SUPPORT_FILES.each do |key, file_name|
+        SUPPORT_FILES.each do |_key, file_name|
           require file_name
         end
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choron_support
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - mksava
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ridgepole
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: spring
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: spring-commands-rspec
+  name: pry-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-rails
+  name: ridgepole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec-parameterized
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot_rails
+  name: spring
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: spring-commands-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-parameterized
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -188,6 +188,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
@@ -213,8 +214,6 @@ files:
 - lib/choron_support/props/ext/hash.rb
 - lib/choron_support/props/ext/relation.rb
 - lib/choron_support/props/private/setting.rb
-- lib/choron_support/props/private/type_builder.rb
-- lib/choron_support/props/private/type_generator.rb
 - lib/choron_support/queries/base.rb
 - lib/choron_support/scope_query.rb
 - lib/choron_support/set_mask_for.rb
@@ -229,6 +228,7 @@ metadata:
   homepage_uri: https://github.com/mksava/choron_support
   source_code_uri: https://github.com/mksava/choron_support
   changelog_uri: https://github.com/mksava/choron_support/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -237,7 +237,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/choron_support/props/private/type_builder.rb

@@ -1,129 +0,0 @@
-# @deprecated
-class ChoronSupport::Props::Private::TypeBuilder
-  RESULT =  Struct.new(:file_path, :body, :type_name, :attributes)
-
-  # @return [String]
-  # @memo
-  #   必要に応じてoverrideしてください
-  def self.output_dir
-    "app/javascript/types/props"
-  end
-
-  # @return [String]
-  # @memo
-  #   必要に応じてoverrideしてください
-  def self.file_path(props_class)
-    self.default_build_file_path(props_class)
-  end
-
-  def initialize(props_class)
-    @body_buffer = []
-    @attributes_buffer = []
-    @props_class = props_class
-  end
-
-  # 設定値やクラス名からTypeScriptの型を生成する
-  # @return [RESULT]
-  # @example
-  #   class Foo::Bars::Staff < Props::Base
-  #     attribute :id, type: "number | null"
-  #     attribute :name, type: "string"
-  #     attribute :is_super, type: "boolean",
-  #     attribute :license_names, type: "Array<string>"
-  #   end
-  #   builder = ChoronSupport::Props::Private::TypeBuilder.new(Foo::Bars::Staff)
-  #   builder.build
-  #   ####====#####
-  #   type Foo_Bars_StaffProps = {
-  #     id: number | null,
-  #     name: string,
-  #     is_super: boolean,
-  #     license_names: Array<string>,
-  #     type: "Foo::Bars::Staff"
-  #     modelName: "Foo::Bar"
-  #   }
-  #   ####====#####
-  def build
-    set_type_buffer
-
-    file_path = self.class.file_path(props_class)
-    body = body_buffer.join("\n")
-    type_name = build_type_name(props_class)
-    attributes = attributes_buffer.join("\n")
-
-    RESULT.new(file_path, body, type_name, attributes)
-  end
-
-  # buildされたTypeScriptの型をファイルに出力する
-  # @return [RESULT]
-  def generate
-    result = self.build
-
-    # 出力用のディレクトリがなければ作成する
-    if !Dir.exist?(self.class.output_dir)
-      FileUtils.mkdir_p(self.class.output_dir)
-    end
-
-    # ファイルを作成する
-    File.open(result.file_path, "w") do |f|
-      f.puts(result.body)
-    end
-
-    result
-  end
-
-  def __body_buffer__
-    body_buffer
-  end
-
-  private
-
-  attr_reader :props_class, :body_buffer, :attributes_buffer
-
-  def self.default_build_file_path(props_class)
-    # 分かりやすいようにそのままtypenameをファイル名にする
-    file_name = props_class.name.gsub("::", "_") + ".d.ts"
-
-    if defined?(Rails) && Rails.root.present?
-      Rails.root.join(self.output_dir, file_name).to_s
-    else
-      File.join(self.output_dir, file_name)
-    end
-  end
-
-  def set_type_buffer
-    body_buffer << "type #{build_type_name(props_class)} = {"
-    attributes_buffer = "{"
-
-    build_attributes(props_class).each do |attr_val|
-      body_buffer << "  #{attr_val}"
-      attributes_buffer << "  #{attr_val}"
-    end
-
-    body_buffer << "}"
-    attributes_buffer << "}"
-  end
-
-  def build_attributes(props_class)
-    attributes = []
-    props_class.settings.each do |setting|
-      attributes << build_attribute(setting)
-    end
-
-    attributes
-  end
-
-  def build_attribute(setting)
-    name = setting.name
-    _if  = setting.if
-    name_val = "#{name}#{_if ? "?" : ""}"
-
-    type = setting.type
-
-    "#{name_val}: #{type}"
-  end
-
-  def build_type_name(props_class)
-    props_class.name.gsub("::", "_")
-  end
-end

data/lib/choron_support/props/private/type_generator.rb

@@ -1,62 +0,0 @@
-# @deprecated
-class ChoronSupport::Props::Private::TypeGenerator
-  def run
-    start_output
-
-    results = []
-    targer_props.each do |props_class|
-      result = builder_class.new(props_class).generate
-      results << result
-    end
-
-    output_results(results)
-
-    results
-  end
-
-  private
-
-  def target_props_class?(props_class)
-    props_class.respond_to?(:skip_typescript) && props_class.respond_to?(:settings)
-  end
-
-  def self.props_base
-    Props::Base
-  end
-
-  def targer_props
-    props_list = []
-    self.class.props_base.descendants.each do |props_class|
-      next unless target_props_class?(props_class)
-      next if props_class.skip_typescript
-
-      props_list << props_class
-    end
-
-    props_list
-  end
-
-  def builder_class
-    ChoronSupport::Props::Private::TypeBuilder
-  end
-
-  def start_output
-    log("Start generating TypeScript Props...: #{targer_props.size}")
-  end
-
-  def output_results(results)
-    log("Generated TypeScript Props: #{results.size}")
-    log("for...")
-    results.each do |result|
-      log("  #{result.file_path}")
-    end
-
-    log("Done.")
-  end
-
-  def log(str)
-    @logger_method ||= defined?(Rails) ? Rails.logger.method(:info) : method(:puts)
-
-    @logger_method.call(str)
-  end
-end