yasl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ede09b21493ce4855f31b11dace169aeb8a218d2f524c86758ca5643fcfe29e5
-  data.tar.gz: 9c34b64eea2244ba1673a2d643872832d694f07c6b644a413824607c9be6469b
+  metadata.gz: 5c4491f82bad72b2981e4bbbf35001f30c95be844ebf4bc3c8f904e019d1e0cd
+  data.tar.gz: eb27247b7913c181fb409f8e07f8735d42bf1ac73e55fb6905ed9c931826449b
 SHA512:
-  metadata.gz: 6afd16380e645f3b972508747b3e41c1254058e25f2f55ab7a872140b4f06aa566a165687c162777c6dcae470d4a1b91aea25a5e82d321ae720644a4b927b353
-  data.tar.gz: f976082dea29c4b130bb6394cc7f1d7a6d71bbef708b9312d61bad265a62e6e6519c12159a6667dcf50618475fdd5474542d959cb415e0984e7ed14355d4946e
+  metadata.gz: 199b1226c4a33b6bc4c1daa6ab04c34c7beecfc2c8eb82bdf27d7cc434b7c2537f1d0b806886f2f1dcd83df1a3a55d5af9be9a9b589d5cc7c06b39d508c01446
+  data.tar.gz: eb167b327b5041ff1087381d2f999c9d42f8942ff617ef850700a3be282732a017af0e9cdcfe04e0527979c531bfc9db31d250e64a82a8c46a91af5e9f5c36f6

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.2.0
+
+- Support Boolean serialization in Opal (instead of TrueClass and FalseClass)
+- Support BigDecimal serialization
+- Include optional pure Ruby reimplementaiton of Struct to avoid JS issues in Opal Struct when needed
+- Fix issue with dumping not working when some ruby basic data type libraries (e.g. 'date') are not loaded by comparing to class name string instead of actual class object
+
 ## 0.1.0
 
 - Serialize JSON basic data types

data/README.md

@@ -1,17 +1,20 @@
 # YASL - Yet Another Serialization Library
 [![Gem Version](https://badge.fury.io/rb/yasl.svg)](http://badge.fury.io/rb/yasl)
-[![Ruby](https://github.com/AndyObtiva/yasl/workflows/Ruby/badge.svg)](https://github.com/AndyObtiva/yasl/actions?query=workflow%3ARuby)
+[![rspec](https://github.com/AndyObtiva/yasl/workflows/rspec/badge.svg)](https://github.com/AndyObtiva/yasl/actions?query=workflow%3Arspec)
 [![Coverage Status](https://coveralls.io/repos/github/AndyObtiva/yasl/badge.svg?branch=master)](https://coveralls.io/github/AndyObtiva/yasl?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/e8d043b8c78c801f0aa3/maintainability)](https://codeclimate.com/github/AndyObtiva/yasl/maintainability)
 
-A pure Ruby serialization library that works across different Ruby implementations like Opal and JRuby as an alternative to YAML/Marshal.
+A pure Ruby serialization library that works across different Ruby implementations like [Opal](https://opalrb.com/) and [JRuby](https://www.jruby.org/) as an alternative to YAML/Marshal.
+
+(Note: this is an early alpha gem, so please use with caution, and report any encountered issues or feature suggestions to help improve)
 
 ## Requirements
 
-- Portablity across different Ruby implementations, especially Opal and JRuby.
-- Zero configuration. Developers are too busy solving business domain problems to worry about low-level serialization details.
-- Silently ignore non-serializable objects like `Proc`, `Binding`, and `IO`.
-- Support serializing classes and modules, not just object instances.
+- Portablity across different Ruby implementations, especially [Opal](https://opalrb.com/) in the web browser and [JRuby](https://www.jruby.org/).
+- Zero required configuration. Developers are too busy solving business domain problems to worry about low-level serialization details.
+- Silently ignore non-serializable objects (unlike Marshal), such as `Proc`, `Binding`, and `IO`.
+- No special performance requirements. No high throughput usage. Average Internet speeds.
+- Ensure system safety through secure deserialization.
 - JSON encoding is good enough. No need for premature optimization.
 
 ## Usage Instructions
@@ -23,7 +26,7 @@ Run:
 Or add to Gemfile:
 
 ```ruby
-gem 'yasl', '~> 0.1.0'
+gem 'yasl', '~> 0.2.0'
 ```
 
 And, run:
@@ -40,9 +43,9 @@ require 'yasl'
 
 To serialize, use the `YASL#dump(object)` method.
 
-Keep in mind that `YASL::UNSERIALIZABLE_DATA_TYPES` classes are unserializable, and will serialize as `nil` (feel free to add more classes that you would like filtered out):
+Keep in mind that `YASL::UNSERIALIZABLE_DATA_TYPES` class names are unserializable, and will serialize as `nil` (feel free to add more class names that you would like filtered out):
 
-`Proc`, `Binding`, `IO`, `File::Stat`, `Dir`, `BasicSocket`, `MatchData`, `Method`, `UnboundMethod`, `Thread`, `ThreadGroup`, `Continuation`
+`'Proc'`, `'Binding'`, `'IO'`, `'File::Stat'`, `'Dir'`, `'BasicSocket'`, `'MatchData'`, `'Method'`, `'UnboundMethod'`, `'Thread'`, `'ThreadGroup'`, `'Continuation'`
 
 Example (from [samples/dump_basic.rb](samples/dump_basic.rb)):
 
@@ -148,7 +151,7 @@ puts dump.inspect
 
 ### Deserialize
 
-To deserialize, use the `YASL#load(data, whitelist_classes: [])` method. The value of `whitelist_classes` must mention all classes expected to appear in the serialized data to load. This is required to ensure software security by not allowing arbitrary unexpected classes to be deserialized.
+To deserialize, use the `YASL#load(data, whitelist_classes: [])` method. The `whitelist_classes` array must mention all classes expected to appear in the serialized data to load. This is required to ensure software security by not allowing arbitrary unexpected classes to be deserialized.
 
 By default, only `YASL::RUBY_BASIC_DATA_TYPES` classes are deserialized:
 
@@ -302,6 +305,18 @@ puts car2.inspect
 # => #<Car:0x00007ffdf008e120 @make="Mitsubishi", @model="Eclipse", @year="2002", @owner=#<Person:0x00007ffdf008dc20 @name="Sean Hux", @dob=2017-10-17 10:03:04 -0400, @cars=[#<Car:0x00007ffdf008e120 ...>]>>
 ```
 
+### Struct
+
+Struct serialization/deserialization works out of the box in standard [MRI Ruby](https://www.ruby-lang.org/) and [JRuby](https://www.jruby.org/).
+
+To avoid some JS and `keyword_init` issues with `Struct` in [Opal](https://opalrb.com/), you may use the optional pure Ruby Struct re-implementation that comes with YASL:
+
+```ruby
+require 'yasl/ext/struct'
+```
+
+This ensures successful serialization in YASL.
+
 ## Contributing
 
 -   Check out the latest master to make sure the feature hasn't been

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/yasl.rb

@@ -25,8 +25,8 @@ require 'yasl/dumper'
 require 'yasl/loader'
 
 module YASL
-  JSON_BASIC_DATA_TYPES = ['NilClass', 'String', 'Integer', 'Float', 'TrueClass', 'FalseClass']
-  RUBY_ONLY_BASIC_DATA_TYPES = ['Time', 'Date', 'Complex', 'Rational', 'Regexp', 'Symbol', 'Set', 'Range', 'Array', 'Hash']
+  JSON_BASIC_DATA_TYPES = ['NilClass', 'String', 'Integer', 'Float', 'TrueClass', 'FalseClass', 'Boolean']
+  RUBY_ONLY_BASIC_DATA_TYPES = ['Time', 'Date', 'BigDecimal', 'Complex', 'Rational', 'Regexp', 'Symbol', 'Set', 'Range', 'Array', 'Hash']
   RUBY_BASIC_DATA_TYPES = RUBY_ONLY_BASIC_DATA_TYPES + JSON_BASIC_DATA_TYPES
   UNSERIALIZABLE_DATA_TYPES = ['Proc', 'Binding', 'IO', 'File::Stat', 'Dir', 'BasicSocket', 'MatchData', 'Method', 'UnboundMethod', 'Thread', 'ThreadGroup', 'Continuation']
   

data/lib/yasl/dumper.rb

@@ -75,19 +75,19 @@ module YASL
     
     def dump_ruby_basic_data_type_data(object)
       case object
-      when Time
+      when class_ancestor_names_include?('Time')
         object.to_datetime.marshal_dump
-      when Date
+      when class_ancestor_names_include?('Date')
         object.marshal_dump
-      when Complex, Rational, Regexp, Symbol
+      when class_ancestor_names_include?('Complex', 'Rational', 'Regexp', 'Symbol', 'BigDecimal')
         object.to_s
-      when Set
+      when class_ancestor_names_include?('Set')
         object.to_a.uniq.map {|element| dump_structure(element) unless unserializable?(element)}
-      when Range
+      when class_ancestor_names_include?('Range')
         [object.begin, object.end, object.exclude_end?]
-      when Array
+      when class_ancestor_names_include?('Array')
         object.map {|element| dump_structure(element) unless unserializable?(element)}
-      when Hash
+      when class_ancestor_names_include?('Hash')
         object.reject do |key, value|
           [key, value].detect {|element| unserializable?(element)}
         end.map do |pair|
@@ -188,6 +188,14 @@ module YASL
       class_objects[object_class].index(object) + 1
     end
         
+    def class_ancestor_names_include?(*class_names)
+      lambda do |object|
+        class_names.reduce(false) do |result, class_name|
+          result || object.class.ancestors.map(&:name).include?(class_name)
+        end
+      end
+    end
+    
   end
   
 end

data/lib/yasl/ext/struct.rb

@@ -0,0 +1,127 @@
+# Copyright (c) 2020 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Object.send(:remove_const, :Struct) if Object.constants.include?(:Struct)
+
+# Optional re-implmentation of Struct in Pure Ruby (to get around JS issues in Opal Struct)
+class Struct
+  class << self
+    def new(*class_name_and_or_attributes, keyword_init: false)
+      class_name = class_name_and_or_attributes.shift if class_name_and_or_attributes.first.to_s.chars.first.to_s.upcase?
+      attributes = class_name_and_or_attributes.compact.map(&:to_s).map(&:to_sym)
+      struct_class = Class.new do
+        members_array = attributes
+        
+        define_method(:members) do
+          members_array
+        end
+        
+        def []=(attribute, value)
+          normalized_attribute = attribute.to_s.to_sym
+          raise NameError, "no member #{attribute} in struct" unless members.include?(normalized_attribute)
+          @member_values[normalized_attribute] = value
+        end
+        
+        def [](attribute)
+          normalized_attribute = attribute.to_s.to_sym
+          raise NameError, "no member #{attribute} in struct" unless members.include?(normalized_attribute)
+          @member_values[normalized_attribute]
+        end
+        
+        def each(&block)
+          to_a.each(&block)
+        end
+        
+        def each_pair(&block)
+          @member_values.each_pair(&block)
+        end
+        
+        def to_h
+          @member_values.clone
+        end
+        
+        def to_a
+          @member_values.values
+        end
+        
+        def size
+          members.size
+        end
+        alias length size
+        
+        def dig(*args)
+          @member_values.dig(*args)
+        end
+        
+        def select(&block)
+          @to_a.select(&block)
+        end
+        
+        def eql?(other)
+          instance_of?(other.class) && members.all? { |key| __send__(key).public_send(:eql?, other.__send__(key)) }
+        end
+        
+        def ==(other)
+          other = coerce(other).first if respond_to?(:coerce, true)
+          other.kind_of?(self.class) && members.all? { |key| __send__(key).public_send(:==, other.__send__(key)) }
+        end
+        
+        if keyword_init
+          def initialize(struct_class_keyword_args = {})
+            @member_values = {}
+            members.each do |attribute|
+              singleton_class.define_method(attribute) do
+                self[attribute]
+              end
+              singleton_class.define_method("#{attribute}=") do |value|
+                self[attribute] = value
+              end
+            end
+            struct_class_keyword_args.each do |attribute, value|
+              self[attribute] = value
+            end
+          end
+        else
+          def initialize(*attribute_values)
+            @member_values = {}
+            members.each do |attribute|
+              singleton_class.define_method(attribute) do
+                self[attribute]
+              end
+              singleton_class.define_method("#{attribute}=") do |value|
+                self[attribute] = value
+              end
+            end
+            attribute_values.each_with_index do |value, i|
+              attribute = members[i]
+              self[attribute] = value
+            end
+          end
+        end
+      end
+      if class_name.nil?
+        struct_class
+      else
+        const_set(class_name, struct_class)
+      end
+    end
+  end
+end

data/lib/yasl/loader.rb

@@ -85,6 +85,8 @@ module YASL
       case class_name
       when 'Time'
         DateTime.new.marshal_load(data.map(&:to_r)).to_time
+      when 'BigDecimal'
+        BigDecimal(data)
       when 'Date'
         Date.new.marshal_load(data.map(&:to_r))
       when 'DateTime'

data/yasl.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: yasl 0.1.0 ruby lib
+# stub: yasl 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "yasl".freeze
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2020-12-30"
+  s.date = "2020-12-31"
   s.description = "A pure Ruby serialization library that works across different Ruby implementations like Opal and JRuby as an alternative to YAML/Marshal.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/yasl.rb",
     "lib/yasl/dumper.rb",
+    "lib/yasl/ext/struct.rb",
     "lib/yasl/loader.rb",
     "yasl.gemspec"
   ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yasl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -124,6 +124,7 @@ files:
 - VERSION
 - lib/yasl.rb
 - lib/yasl/dumper.rb
+- lib/yasl/ext/struct.rb
 - lib/yasl/loader.rb
 - yasl.gemspec
 homepage: http://github.com/AndyObtiva/yasl