serdes 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3fda61b6d5f8b491822d777eb171a34ccaa130e001634a4328a81113def4183
-  data.tar.gz: 6151fcc98e9ed477fde75a49f30df2b26d74ea14722a3ca1705e73a4e7bd84bb
+  metadata.gz: bc5a0f39e261348c4f4d222f795e09de9dc6f5166d070214b0ffc48ab5615da6
+  data.tar.gz: f0c40e4eb6fec6227754dedb5ab984a87a35e9bbdba1f8dd0e72e77e3a7145fe
 SHA512:
-  metadata.gz: dfb5ef4378c8c2ac18fad467e76c26aea7d6a67709ecf9ff206ce378c08ebaebba1dbe384c4bacd342c7f2f550a6ce35b44d67cdedc30fc4ef47b5ae0a03b255
-  data.tar.gz: 1a90bbb57045ecccdb0e7282d5ce29e082917cf64033bb7f3b46a286c492d86914657f8b9459d3fe0ff40a7478ebf38ea2ee4e8879e35e86bb6c958dfc5e4be1
+  metadata.gz: 5607b8aac8a10e6251c530cf39447dd5a9da5754b30b96b5d52f9e87db899085561c2533891183d2d9c3b8137fb22cc29efd69f137c1c19eca569b9fc8f3fe62
+  data.tar.gz: bd25c27df789a9361d9fb8f35cb34dfc14d6181e763682f1af3ed2a18ba52e01aaf482ccdc1b7309b83ae26d404689ea95857b49809d034b28bec90a1c1f7464

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.4]
+
+- Add skip serializing attribute feature.
+
+## [0.1.3] - 2025-02-12
+
+- Add `only` option which adds value constraint.
+
 ## [0.1.2] - 2025-02-09
 
 - Fix `Boolean` type not working.

data/README.md

@@ -34,6 +34,7 @@ class User
   attribute :profile, optional(String)
   attribute :tags, array(String)
   attribute :has_pet, Boolean
+  attribute :plan, String, only: ["free", "premium"]
 end
 
 user_hash = {
@@ -71,10 +72,21 @@ User.from(user_hash) # => raise Serdes::TypeError
 
 ### Macro
 
+#### Global macro
+
 - `rename_all_attributes`: Rename all attributes when serializing and deserializing.
   - Supported: `:snake_case`, `:PascalCase`
 - `symbolize_all_keys`: Symbolize all keys when serializing and deserializing Hash, and vice versa.
 
+#### Attribute macro
+
+You can also use macro for each attribute by specifying 3rd argument of `attribute`.
+
+- `only`: Only allow given values.
+- `skip_serializing`: Skip serializing attribute by setting truthy value. it will ignore `skip_serializing_if`, `skip_serializing_if_nil` when this set.
+- `skip_serializing_if`: Skip serializing if given proc call returns true.
+- `skip_serializing_if_nil`: alias of `skip_serializing_if: ->(v) { v.nil? }`. It will ignore `skip_serializing_if` when this set.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/serdes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Serdes
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/serdes.rb

@@ -102,6 +102,23 @@ module Serdes
       @name = name
       @attr_type = attr_type
       @options = options
+
+      if @options[:skip_serializing_if_nil]
+        @options.delete(:skip_serializing_if_nil)
+        @options[:skip_serializing_if] = ->(v) { v.nil? }
+      end
+    end
+
+    def permit?(value)
+      return false if !attr_type.permit?(value)
+
+      return true if @options[:only].nil?
+
+      if @options[:only].include?(value)
+        true
+      else
+        raise TypeError, "Wrong value for #{class_name}##{name}. Expected value is #{@options[:only]}, got '#{value}'."
+      end
     end
 
     def serialized_name(rename_strategy = nil)
@@ -202,8 +219,13 @@ module Serdes
       self.class.__send__(:_serde_attrs).each_with_object({}) do |(name, attr), hash|
         key = attr.serialized_name(self.class.__send__(:_serde_rename_strategy))
         key = key.to_sym if self.class.__send__(:_serde_symbolized_all_keys)
+
+        next if attr.options[:skip_serializing]
+
         value = __send__(name)
 
+        next if attr.options[:skip_serializing_if] && attr.options[:skip_serializing_if].call(value)
+
         hash[key] =
           if value.respond_to?(:to_hash)
             value.to_hash
@@ -266,27 +288,11 @@ module Serdes
     end
 
     def validate_type!(attr, value)
-      valid = attr.attr_type.permit?(value)
-      return if valid
-
-      actual_type = humanize_type(value)
+      return if attr.permit?(value)
 
       raise TypeError, "Wrong type for #{attr.class_name}##{attr.name}. Expected type #{attr.attr_type}, got #{value.class} (val: '#{value}')."
     end
 
-    def humanize_type(value)
-      if value.is_a?(Array)
-        "array(" + value.map { |el| humanize_type(el) }.join(", ") + ")"
-      else
-        case value
-        when NilClass then "nil"
-        when TrueClass then "boolean"
-        when FalseClass then "boolean"
-        else value.class.to_s
-        end
-      end
-    end
-
     def skip_to_hash?(value)
       case value
       when NilClass, String, Numeric, TrueClass, FalseClass

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: serdes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Shia
 bindir: bin
 cert_chain: []
-date: 2025-02-09 00:00:00.000000000 Z
+date: 2025-03-02 00:00:00.000000000 Z
 dependencies: []
 description: Serdes is a tool for serializing and deserializing class.
 email: