safe_and_sound 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84fe70ccca99e40ef3520238a5d0228fbaba056a19d6ced57e0ec7c96054b899
-  data.tar.gz: 366a938712e572477d6065d7f56f31b8fbf88891438834c7812ab0bf2f59f93d
+  metadata.gz: 9890b2b829aa88cdea2c36e78a032c747d148acf3f6e48c2fc3146db811309b5
+  data.tar.gz: 92316a4c52f9cb868615e219172cdc04392e12af889353612e11eb6aef9a4ed9
 SHA512:
-  metadata.gz: 6b4b69ea28043773a8a508fc1d0b1f61b6ca580ebf8dfaf7af9725645b544d134c19381088a525541de6b597bfa92352e8daa2a26ed110eaa82c81587afdfb0c
-  data.tar.gz: a1c4937537fe9c000ae2c45a2d0120bf00ed808ffd4830fd570e1b8db44497d1cc769261ed307fc62769e60ada42dea66418ece4387129501c3d2d792429f8c1
+  metadata.gz: e41b58b277085199a6fa2b70bedae6323cfaae551f56198da26ef6d004c0f63a2109ae4589f002eb139464da5e6ffcb6e8738608720ea4f00379bc96f30ebb41
+  data.tar.gz: f38e036748e434f4fca480c973b26b1eb8dbb385df483456ef78f89fa88f2f2a74117bfd20f62beb8d0a0fc7d608c8f93f9bbb99ad1c7a61e34264f08d9c0a3b

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.0.3 (21-Apr-22)
+
+* Add serialization support for array fields
+* Add ability to declare Array types
+* Allow to omit 'type' specifier in JSON when type has only one variant
+* Test and fix deserialization
+* Update minimum Ruby version to 3 
+* Make sure JSON serialization works on nested types
+* Add deserialization for nested types
+
 ## 0.0.2 (17-Apr-22)
 
 * added `#to_json` and `#from_json` methods for serialization

data/README.md

@@ -32,6 +32,8 @@ bike = Vehicle.bike(gears: 'twentyone')
 
 To add polymorphic behavior we can write functions __without__ having to touch the new types themselves.
 
+## Safe, polymorphic functions
+
 By including the `SafeAndSound::Functions` module we get access to the `chase` function.
 It immitates the `case` statement but uses the knowledge about our types to make it more safe.
 
@@ -60,4 +62,20 @@ of making a syntax for it look like the syntax in languages where this concept i
 
 Check out more examples in the [examples folder](examples).
 
+## JSON serialization/deserialization included
+
+```ruby
+irb(main)> car = Vehicle.Car(horsepower: 100)
+
+irb(main)> car.as_json # converts to a Hash of primitives
+=> {"type"=>"Car", "horsepower"=>100}
 
+irb(main)> puts car.to_json # converts to actual JSON string
+{"type":"Car","horsepower":100}
+
+irb(main)> Vehicle.from_hash({"type"=>"Car", "horsepower"=>100})
+=> #<Vehicle::Car:0x000000010ef49a48 @horsepower=100>
+
+irb(main)> Vehicle.from_json('{"type":"Car","horsepower":100}')
+=> #<Vehicle::Car:0x000000010ef6ae00 @horsepower=100>
+```

data/lib/safe_and_sound/json.rb

@@ -1,11 +1,27 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module SafeAndSound
   module ToJson
     def as_json
       hash = { 'type' => self.class.variant_name.to_s }
       self.class.fields.each do |field_name, _|
-        hash[field_name.to_s] = send(field_name)
+        value = send(field_name)
+        hash[field_name.to_s] =
+          if value.is_a?(Array)
+            value.map do |item|
+              if item.respond_to?(:as_json)
+                item.as_json
+              else
+                item
+              end
+            end
+          elsif value.respond_to?(:as_json)
+            value.as_json
+          else
+            value
+          end
       end
       hash
     end
@@ -17,13 +33,19 @@ module SafeAndSound
 
   module FromJson
     def from_json(json_string)
-      hash =
-        JSON
-        .parse(json_string)
-        .transform_keys(&:to_sym)
-      variant_name = hash[:type]
-      variant = variants.find { |v| v.name.gsub(/.*::/, '') == variant_name }
-      raise ArgumentError, "Unable to find #{variant_name} for #{type.name}" unless variant
+      from_hash(JSON.parse(json_string))
+    end
+
+    def from_hash(hash_)
+      hash = hash_.transform_keys(&:to_sym)
+      variant_name = hash[:type].to_sym if hash[:type]
+      variant =
+        if variant_name.nil? && variants.length == 1
+          variants.first
+        else
+          variants.find { |v| v.variant_name == variant_name }
+        end
+      raise ArgumentError, "Unable to find #{variant_name} for #{name}" unless variant
 
       variant.new(**hash.except(:type))
     end

data/lib/safe_and_sound/variant.rb

@@ -41,11 +41,47 @@ module SafeAndSound
                 "#{self.class.name} does not have a constructor argument #{field_name}"
         end
 
-        unless value.is_a?(field_type)
+        if field_type_matches?(field_type, field_name, value)
+          instance_variable_set("@#{field_name}", value)
+        else
+          instance_variable_set("@#{field_name}", try_to_initialize_from_hash(field_type, field_name, value))
+        end
+      end
+
+      def field_type_matches?(field_type, field_name, value)
+        return value.is_a?(field_type) unless field_type.is_a?(Array)
+
+        expected_item_type = field_type.first
+        unless value.is_a?(Array)
+          raise WrgonConstructorArgType,
+                "#{field_name} must be an Array of #{expected_item_type} but was #{value.class}"
+        end
+
+        mismatched_types =
+          value.map do |item|
+            if item.is_a?(expected_item_type)
+              nil
+            else
+              item.class
+            end
+          end.compact
+        mismatched_types.empty?
+      end
+
+      def try_to_initialize_from_hash(field_type, field_name, value)
+        if field_type.is_a?(Array)
+          item_type = field_type.first
+          return value.map { |item_hash| item_type.from_hash(item_hash) } if item_type.superclass == Type
+
+          raise WrgonConstructorArgType,
+                "#{field_name} must be array of type #{item_type}"
+
+        end
+        unless field_type.superclass == Type && value.is_a?(Hash)
           raise WrgonConstructorArgType,
                 "#{field_name} must be of type #{field_type} but was #{value.class.name}"
         end
-        instance_variable_set("@#{field_name}", value)
+        field_type.from_hash(value)
       end
     end
 

data/lib/safe_and_sound/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafeAndSound
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: safe_and_sound
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Axel Tetzlaff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-17 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +103,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,15 +111,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.1.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Sum Data Types
 test_files: []