scorpio 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c02ae6ac0aa557b45883e8b1261ed89cf7f98d65a4c3a1224144aefba1abe0e
-  data.tar.gz: 4961d26ac46421417cb40ca6929c7fca53007d773457860cb18006a1c38dbf49
+  metadata.gz: 772f6b246d831d6737118bed2f363358ac6b62dc055c3503f0a96e04d416985e
+  data.tar.gz: 20e4a1d856105a0c2f25d80fb252afd7b91bc35f71babc47f2d8ab3fbd46b2df
 SHA512:
-  metadata.gz: e7c669c5820372b7abc5d8a881b37c73d681f051a70309b68f61574be58f5b1eac4d3928a4419aecb59a2c415c29eeb329cdd4327b60cb31604a9a5ad63ef855
-  data.tar.gz: a435561553f6ab3c9fff2e122fbfed6d56126688f23ea7a7579a0999a281e66b046c224ff2ae398ffeb827e68f2a080867d364b0b8a3b6c586a4a8f01f41b854
+  metadata.gz: 8796f5f5227d3a70c374ae94b30cb6be1d7ad4dad71fb399c37c6c74e21117442d582a44d3417c828f156e42690d8f34a692bc3de5fcae4070431583ba1e5d88
+  data.tar.gz: 5d1b897306c6a43e16016e13f125e81d0408e3aca0c94009a2d8804aef0835b3a5cec144441de2979b51c9436e2fff016f0a1046e65d25dcc17471f60cda5869

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.2.2
+- Scorpio::SchemaInstanceJSONCoder
+
 # v0.2.1
 - SchemaInstanceBase#parent, #parents
 - compatibility fix #as_json

data/lib/scorpio.rb

@@ -91,4 +91,12 @@ module Scorpio
   autoload :ResourceBase,     'scorpio/resource_base'
   autoload :Schema,            'scorpio/schema'
   autoload :SchemaInstanceBase, 'scorpio/schema_instance_base'
+  autoload :SchemaClasses,       'scorpio/schema_instance_base'
+  autoload :ObjectJSONCoder,      'scorpio/schema_instance_json_coder'
+  autoload :StructJSONCoder,       'scorpio/struct_json_coder'
+  autoload :SchemaInstanceJSONCoder,'scorpio/schema_instance_json_coder'
+
+  def self.class_for_schema(*a, &b)
+    SchemaClasses.class_for_schema(*a, &b)
+  end
 end

data/lib/scorpio/schema.rb

@@ -87,6 +87,10 @@ module Scorpio
       end
     end
 
+    def schema_class
+      Scorpio.class_for_schema(self)
+    end
+
     def match_to_instance(instance)
       # matching oneOf is good here. one schema for one instance.
       # matching anyOf is okay. there could be more than one schema matched. it's often just one. if more

data/lib/scorpio/schema_instance_base.rb

@@ -156,13 +156,14 @@ module Scorpio
 
   # this module is just a namespace for schema classes.
   module SchemaClasses
+    extend Memoize
     def self.[](schema_id)
       @classes_by_id[schema_id]
     end
     @classes_by_id = {}
   end
 
-  def self.class_for_schema(schema_object)
+  def SchemaClasses.class_for_schema(schema_object)
     if schema_object.is_a?(Scorpio::Schema)
       schema__ = schema_object
     else

data/lib/scorpio/schema_instance_json_coder.rb

@@ -0,0 +1,83 @@
+module Scorpio
+  # this is a ActiveRecord serialization class intended to store JSON in the
+  # database column and expose a ruby class once loaded on a model instance.
+  # this allows for better ruby idioms to access to properties, and definition
+  # of related methods on the loaded class.
+  #
+  # the first argument, `loaded_class`, is the class which will be used to
+  # instantiate the column data. properties of the loaded class will correspond
+  # to keys of the json object in the database.
+  #
+  # the column data may be either a single instance of the loaded class
+  # (represented as one json object) or an array of them (represented as a json
+  # array of json objects), indicated by the keyword argument `array`.
+  #
+  # the column behind the attribute may be an actual JSON column (postgres json
+  # or jsonb - hstore should work too if you only have string attributes) or a
+  # serialized string, indicated by the keyword argument `string`.
+  class ObjectJSONCoder
+    class Error < StandardError
+    end
+    class LoadError < Error
+    end
+    class DumpError < Error
+    end
+
+    def initialize(loaded_class, string: false, array: false, next_coder: nil)
+      @loaded_class = loaded_class
+      # this notes the order of the keys as they were in the json, used by dump_object to generate
+      # json that is equivalent to the json/jsonifiable that came in, so that AR's #changed_attributes
+      # can tell whether the attribute has been changed.
+      @loaded_class.send(:attr_accessor, :object_json_coder_keys_order)
+      @string = string
+      @array = array
+      @next_coder = next_coder
+    end
+
+    def load(column_data)
+      return nil if column_data.nil?
+      data = @string ? ::JSON.parse(column_data) : column_data
+      object = if @array
+        unless data.respond_to?(:to_ary)
+          raise TypeError, "expected array-like column data; got: #{data.class}: #{data.inspect}"
+        end
+        data.map { |el| load_object(el) }
+      else
+        load_object(data)
+      end
+      object = @next_coder.load(object) if @next_coder
+      object
+    end
+
+    def dump(object)
+      object = @next_coder.dump(object) if @next_coder
+      return nil if object.nil?
+      jsonifiable = begin
+        if @array
+          unless object.respond_to?(:to_ary)
+            raise DumpError, "expected array-like attribute; got: #{object.class}: #{object.inspect}"
+          end
+          object.map do |el|
+            dump_object(el)
+          end
+        else
+          dump_object(object)
+        end
+      end
+      @string ? ::JSON.generate(jsonifiable) : jsonifiable
+    end
+  end
+  # this is a ActiveRecord serialization class intended to store JSON in the
+  # database column and expose a given SchemaInstanceBase subclass once loaded
+  # on a model instance.
+  class SchemaInstanceJSONCoder < ObjectJSONCoder
+    private
+    def load_object(data)
+      @loaded_class.new(data)
+    end
+
+    def dump_object(object)
+      Scorpio::Typelike.as_json(object)
+    end
+  end
+end

data/lib/scorpio/struct_json_coder.rb

@@ -0,0 +1,30 @@
+module Scorpio
+  # this is a ActiveRecord serialization class intended to store JSON in the
+  # database column and expose a Struct subclass once loaded on a model instance.
+  class StructJSONCoder < ObjectJSONCoder
+    private
+    def load_object(data)
+      if data.is_a?(Hash)
+        good_keys = @loaded_class.members.map(&:to_s)
+        bad_keys = data.keys - good_keys
+        unless bad_keys.empty?
+          raise LoadError, "expected keys #{good_keys}; got unrecognized keys: #{bad_keys}"
+        end
+        instance = @loaded_class.new(*@loaded_class.members.map { |m| data[m.to_s] })
+        instance.object_json_coder_keys_order = data.keys
+        instance
+      else
+        raise LoadError, "expected instance(s) of #{Hash}; got: #{data.class}: #{data.inspect}"
+      end
+    end
+
+    def dump_object(object)
+      if object.is_a?(@loaded_class)
+        keys = (object.object_json_coder_keys_order || []) | @loaded_class.members.map(&:to_s)
+        keys.map { |member| {member => object[member]} }.inject({}, &:update)
+      else
+        raise TypeError, "expected instance(s) of #{@loaded_class}; got: #{object.class}: #{object.inspect}"
+      end
+    end
+  end
+end

data/lib/scorpio/version.rb

@@ -1,3 +1,3 @@
 module Scorpio
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorpio
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-04 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -264,6 +264,8 @@ files:
 - lib/scorpio/schema.rb
 - lib/scorpio/schema_instance_base.rb
 - lib/scorpio/schema_instance_base/to_rb.rb
+- lib/scorpio/schema_instance_json_coder.rb
+- lib/scorpio/struct_json_coder.rb
 - lib/scorpio/typelike_modules.rb
 - lib/scorpio/util.rb
 - lib/scorpio/util/faraday/response_media_type.rb