safe_and_sound 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ea298c0193785c3c404e220a34f34bd30f00ced83729c1dc576010e015b7165
-  data.tar.gz: 38455c727045bccff6dfa5cb17795960fcd51356f942aed7c6b982de21267482
+  metadata.gz: 84fe70ccca99e40ef3520238a5d0228fbaba056a19d6ced57e0ec7c96054b899
+  data.tar.gz: 366a938712e572477d6065d7f56f31b8fbf88891438834c7812ab0bf2f59f93d
 SHA512:
-  metadata.gz: 395c899676cbd7656ace2655062f68b191798cec6ff9a68bdee5bf7b889b9cfd8ace657f74c1aaefc2d7a214fc1f8c4d6463f531064641e9febc31233a8b6b71
-  data.tar.gz: 749967441723e4dea3d01d43bb41cae4d6661a8826eb511b5431181098ad76a372c9634307a47069c2800d476f868202b3d823a2bdb5e74a6fa30b6ffbe30d2f
+  metadata.gz: 6b4b69ea28043773a8a508fc1d0b1f61b6ca580ebf8dfaf7af9725645b544d134c19381088a525541de6b597bfa92352e8daa2a26ed110eaa82c81587afdfb0c
+  data.tar.gz: a1c4937537fe9c000ae2c45a2d0120bf00ed808ffd4830fd570e1b8db44497d1cc769261ed307fc62769e60ada42dea66418ece4387129501c3d2d792429f8c1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.0.2 (17-Apr-22)
+
+* added `#to_json` and `#from_json` methods for serialization
+
+* Initial release
+
 ## 0.0.1 (04-Apr-22)
 
 * Initial release

data/README.md

@@ -7,7 +7,7 @@ It's inspired by the concise syntax to declare new types in [Elm](https://guide.
 These types share some properties with types referred to as _algebaric data types_, _sum types_ or _union types_.
 
 We can model similar relationships more verbosely in plain Ruby with classes and subclasses.
-This library provides some syntactic shortcuts to create these hierarchy.
+This library provides some syntactic shortcuts to create these hierarchies.
 
 ```ruby
 Vehicle = SafeAndSound.new(
@@ -40,8 +40,8 @@ include SafeAndSound::Functions
 
 def to_human(vehicle)
   chase vehicle do
-    Vehicle::Car,  -> { "I'm a car with #{horsepower} horsepower" }
-    Vehicle::Bike, -> { "I'm a bike with #{gears} gears" }
+    wenn Vehicle::Car,  -> { "I'm a car with #{horsepower} horsepower" }
+    wenn Vehicle::Bike, -> { "I'm a bike with #{gears} gears" }
   end
 end
 ```
@@ -58,5 +58,6 @@ episode of the _Destroy all software_ screencast.
 I'm not trying to change how Ruby code is written. This is merely an experiment how far the sum type concept can be taken in terms
 of making a syntax for it look like the syntax in languages where this concept is more central.
 
+Check out more examples in the [examples folder](examples).
 
 

data/lib/safe_and_sound/json.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+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)
+      end
+      hash
+    end
+
+    def to_json(*_args)
+      as_json.to_json
+    end
+  end
+
+  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
+
+      variant.new(**hash.except(:type))
+    end
+  end
+end

data/lib/safe_and_sound/type.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require 'safe_and_sound/json'
+
 module SafeAndSound
   class BaseTypeCannotBeInstantiated < StandardError; end
 
   ##
   # base class for the newly defined types
   class Type
+    extend FromJson
+
     def initialize
       raise BaseTypeCannotBeInstantiated, 'You cannot create instances of this type directly but only of its variants'
     end

data/lib/safe_and_sound/variant.rb

@@ -65,6 +65,8 @@ module SafeAndSound
       Class.new(parent_type) do
         include(Initializer)
         include(Functions)
+        include(ToJson)
+
         class << self
           attr_accessor :fields, :variant_name
         end

data/lib/safe_and_sound/version.rb

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

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: safe_and_sound
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Axel Tetzlaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '5.15'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,7 @@ files:
 - README.md
 - lib/safe_and_sound.rb
 - lib/safe_and_sound/functions.rb
+- lib/safe_and_sound/json.rb
 - lib/safe_and_sound/maybe.rb
 - lib/safe_and_sound/result.rb
 - lib/safe_and_sound/type.rb