choron_support 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40ef4a2eb00c8d0c4b5d5066eaa7e31cac622c334db5c5cb3d1e1148f911459a
-  data.tar.gz: 16cc0ae3bebfd84c59c719b979ef64ded66576345252a33370ddb44f24216504
+  metadata.gz: e930829f733348afe1938ef857477f85bcc15695e67a31a491e50cd65cb3cc42
+  data.tar.gz: 41287fc1cdd25345988f03b2ba780e777e8d478413e7f78a907b7931ad362535
 SHA512:
-  metadata.gz: e513dd0ba14ca1df5a4a845885e5b5e0125f47ca568c338ae4f38c6b39ff1e55a21be17ff4cdf8d57994224827ff91d40db8de37ab39e8ab902343188229f65f
-  data.tar.gz: c3a527888d13b32efcff166c0af46352c3e57d604837ed86f2c09d5aa2db7482f45ade6004f923887181f31f12da9e3668ae8df648ad5117d7509fd8569c7f9d
+  metadata.gz: 426090be576fe116a04f6c939c89741868dd5b0b38e495d0fd6b1d613f02af280b8ac6046b0123504323fe2cbb6f7b938e6742863d7dc594626eb4436ccf38a4
+  data.tar.gz: fb03ba53c19263bffcb80b3aad9853c87cffd53410a8c3246b512625ca549fa7af15ec618ce2fca50d32a055a5fd92572b61fd8cc5e48008a51542b2ad71f476

data/CHANGELOG.md

@@ -2,4 +2,14 @@
 
 ## [0.1.0] - 2022-12-04
 
-- Initial release
+* Initial release
+
+## [0.1.8] - 2023-06-04
+
+### `as_props`
+
+* もしPropsクラスが見つからなかった場合にエラーをraiseするように修正
+
+### `set_mask_for`
+
+* マスク処理のAPIを提供開始

data/Gemfile.lock

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

data/README.md

@@ -72,6 +72,13 @@ user = User.find(1).as_props
 #=> { id: 1, name: "tanaka tarou" }
 ```
 
+### Mask
+
+モデルに対してマスク処理をかけ、セキュリティを強くするための仕組みです。
+
+* 詳細な使い方は [テストファイル](./spec/choron_support/set_mask_for_spec.rb) を参照ください。
+* 詳細な実装は [こちら](./lib/choron_support/set_mask_for.rb) です。
+
 ### Domain
 
 * TODO

data/lib/choron_support/as_props.rb

@@ -45,8 +45,13 @@ module ChoronSupport
 
         props_class.new(self)
       rescue *rescue_errors
-        if type_symbol.blank?
+        # もし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."
         else
           raise ChoronSupport::AsProps::NameError, "Props class not found: #{props_class_name}. Got type symbol: #{type_symbol}."
         end

data/lib/choron_support/domain_delegate.rb

@@ -6,19 +6,7 @@ module ChoronSupport
     extend ActiveSupport::Concern
 
     included do
-      extend Forwardable
-
-      # Forwardable が ActiveSupport#delegate を上書きしてしまうため、間違って使ったときのためエラーをraiseするようにしています
-      def self.delegate(*params, **keyparams)
-        # delegate :hoge, to: :fuga という形で呼び出された場合は、エラーをraiseする
-        if keyparams[:to].present?
-          raise DelegationError, "ActiveSupport#delegate is not usable. Please use Forwardable#delegate.\n@example\n  delegate size: :array"
-        else
-          super
-        end
-      end
-
-      # QueryオブジェクトパターンをEasyに使うためのクラスメソッドです
+      # 処理を別クラスに委任する設定をEasyに使うためのクラスメソッドです
       # @param [Symbol] method_name Modelに定義されるメソッド名
       # @param [Choron::Domains::Base] option domain Domainクラスを文字列で直接指定することができます。シンボルを渡すとクラス化を自動で行います。デフォルトはnilです。
       # @param [Symbol] option domain_to_method 委譲先のDomainクラスの呼び出しメソッドを指定できます。デフォルトは :call です
@@ -60,7 +48,9 @@ module ChoronSupport
         # ドメインオブジェクトにデリゲートさせます
         # 例: def_delegator :__domains_users_purchase_object__, :call, :purchase
         #    purchase メソッドを __domains_xxx__ の call メソッドにデリゲートする
-        def_delegator domain_object_method_name, to, method_symbol
+        define_method(method_symbol) do |*args, **keyparams, &block|
+          send(domain_object_method_name).send(to, *args, **keyparams, &block)
+        end
       end
 
       # domain_delegate とほぼ同じ動きですが、こちらはクラスメソッドをデリゲートするものです。
@@ -88,18 +78,8 @@ module ChoronSupport
       def self.class_domain_delegate(method_symbol, specific: true, class_name: nil, to: :call)
         domain_class = __generate_choron_domain_class(method_symbol, specific, class_name)
 
-        # どのような引数でもデリゲートできるようにしています
-        define_singleton_method(method_symbol) do |*params, **keyparams|
-          case [!params.empty?, !keyparams.empty?]
-          when [true, true]
-            domain_class.new(self).send(to, *params, **keyparams)
-          when [true, false]
-            domain_class.new(self).send(to, *params)
-          when [false, true]
-            domain_class.new(self).send(to, **keyparams)
-          else
-            domain_class.new(self).send(to)
-          end
+        define_singleton_method(method_symbol) do |*params, **keyparams, &block|
+          domain_class.new(self).send(to, *params, **keyparams, &block)
         end
       end
 

data/lib/choron_support/set_mask_for.rb

@@ -0,0 +1,77 @@
+module ChoronSupport
+  module SetMaskFor
+    extend ActiveSupport::Concern
+
+    class NameError < StandardError; end
+    class CanNotMaskError < StandardError; end
+
+    WITH_OUT_MASK_FLAG_VARIABLE_NAME = :__choron_with_out_mask_flag__
+    MASKING_VALUES = { string: "****", else: nil }.freeze
+
+    included do
+      def self.set_mask_for(*method_symbols, condition: nil)
+        method_symbols.each do |method_symbol|
+          self.instance_eval { private attr_accessor WITH_OUT_MASK_FLAG_VARIABLE_NAME }
+          define_method(method_symbol) do
+            origin = super()
+
+            # そもそも元の値がnilの場合はそのまま返し、validation等の妨げにならないようにしています
+            return nil if origin.nil?
+
+            type = :else
+            case origin
+            when String
+              type = :string
+            end
+
+            if without_mask?
+              origin
+            else
+              # 型によってマスクする値を変えています
+              MASKING_VALUES[type]
+            end
+          end
+
+          # マスクの値に関係なく元の値を取得するためのメソッドです。
+          define_method("danger_without_mask_#{method_symbol}") do
+            val = nil
+            self.without_mask do |model|
+              val = model.send(method_symbol)
+            end
+            val
+          end
+        end
+
+        unless method_defined?(:danger_without_mask!)
+          define_method(:danger_without_mask!) do
+            send("#{WITH_OUT_MASK_FLAG_VARIABLE_NAME}=", true)
+
+            self
+          end
+        end
+
+        unless method_defined?(:without_mask)
+          define_method(:without_mask) do |&block|
+            self.danger_without_mask!
+            block.call(self)
+            self.wear_mask
+          end
+        end
+
+        unless method_defined?(:wear_mask)
+          define_method(:wear_mask) do
+            send("#{WITH_OUT_MASK_FLAG_VARIABLE_NAME}=", false)
+
+            self
+          end
+        end
+
+        unless method_defined?(:without_mask?)
+          define_method(:without_mask?) do
+            !!send(WITH_OUT_MASK_FLAG_VARIABLE_NAME)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/choron_support/version.rb

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

data/lib/choron_support.rb

@@ -6,6 +6,7 @@ module ChoronSupport
     queries: "choron_support/scope_query",
     forms: "choron_support/build_form",
     props: "choron_support/as_props",
+    masks: "choron_support/set_mask_for",
   }
   private_constant :SUPPORT_FILES
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choron_support
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - mksava
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -211,6 +211,7 @@ files:
 - lib/choron_support/props/ext/relation.rb
 - lib/choron_support/queries/base.rb
 - lib/choron_support/scope_query.rb
+- lib/choron_support/set_mask_for.rb
 - lib/choron_support/version.rb
 - sig/choron_support.rbs
 - tmp/.keep