serdes 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00cf00141d9d3b1ed522f32261e653b73a7cd0dea98654974bc4e08844474c3b
-  data.tar.gz: ee2953c0dd44a798eb9ee2bb61e0b7652ed4f1a3d4d24ab3897159b12ef51fca
+  metadata.gz: 28edbdb79c30f1f680e78f89b179372e2c947f755e192b4fb4e4e1fc1de88815
+  data.tar.gz: 61b27b8fa680feefe6d90e217cb26f729c36dcdb4c3703ab2b788824af6ffce1
 SHA512:
-  metadata.gz: 354f6647e6323ccd23967429d07649da43ddcde185fcbe8a5f9503c4d319096f10cc43784d91da78a4734ec4f368e57e19b29fa59dc7a4fb52f110092e14763a
-  data.tar.gz: bbf2db71e91a585a89a06ccaff47fa050e688ec9af9048c1d042e60d4e9cfe671f6ca42deb396786de18495d5d76022d2555ecf8fe76e42734e3c20178d4f951
+  metadata.gz: 57776409c4ebc410ec94d3a07723f280fa029d3f5950dcf132f220e153406cd1eaef2e717249bc691aebf8252de087f051844b27ee974582def946b859d29949
+  data.tar.gz: 94a768e64bb467d8acc7fa88184dff9e576d0dfb65600e0f5e95eef2f8c3e58c294d79c4e3ecd3c0a8527bf2c51f8f9dc3905abe1ed4b8a52f4e1a4f50eb5fe5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.5]
+
+- Add `default` option for attribute definitions.
+
+## [0.1.4]
+
+- Add skip serializing attribute feature.
+
 ## [0.1.3] - 2025-02-12
 
 - Add `only` option which adds value constraint.

data/README.md

@@ -61,7 +61,7 @@ User.from(user_hash) # => raise Serdes::TypeError
 - `<class>.from(obj)`: Deserialize object to <class> instance.
   - `from` will call `from_<obj.class>` method if it exists. if not, it returns obj as it is.
 - `<class>#to_hash`: Serialize <class> instance to Hash.
-  - There is no support for serializaion, as only you need to do is just implement `to_<class>` method where you want.
+  - There is no support for serialization, as only you need to do is just implement `to_<class>` method where you want.
 
 ### Types
 
@@ -72,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.3"
+  VERSION = "0.1.5"
 end

data/lib/serdes.rb

@@ -102,6 +102,25 @@ 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
+
+      # Validate default value type if provided
+      if @options.key?(:default)
+        default_value = @options[:default]
+        # Use permit? to validate both type and only constraint
+        # permit? will raise TypeError if only constraint is violated
+        unless @attr_type.permit?(default_value)
+          raise TypeError, "Wrong type for default value of #{class_name}##{name}. Expected type #{@attr_type}, got #{default_value.class} (val: '#{default_value}')."
+        end
+        # Check only constraint
+        if @options[:only] && !@options[:only].include?(default_value)
+          raise TypeError, "Wrong value for #{class_name}##{name}. Expected value is #{@options[:only]}, got '#{default_value}'."
+        end
+      end
     end
 
     def permit?(value)
@@ -183,9 +202,15 @@ module Serdes
           key = attr.serialized_name(_serde_rename_strategy)
           key = key.to_sym if _serde_symbolized_all_keys
 
-          serialized_value = hash[key]
-
-          value = Functions.from__proxy(attr.attr_type, serialized_value)
+          if hash.key?(key)
+            serialized_value = hash[key]
+            value = Functions.from__proxy(attr.attr_type, serialized_value)
+          elsif attr.options.key?(:default)
+            value = attr.options[:default]
+          else
+            serialized_value = hash[key]
+            value = Functions.from__proxy(attr.attr_type, serialized_value)
+          end
 
           instance.__send__("#{attr.name}=", value)
         end
@@ -214,8 +239,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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: serdes
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Shia
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Serdes is a tool for serializing and deserializing class.
 email:
@@ -43,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Serdes is a tool for serializing and deserializing class.
 test_files: []