activejsonmodel 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f2bf815c387423461ead46e38e315eb8ad0c866f4745ae9d67882a36e7e0b0c
-  data.tar.gz: 59abf0fbc153f61787fd422962e5f23c74d69276de65d0483d82b3b8b1d618ac
+  metadata.gz: 6358d312dd78f6dec607bfcc0417e3bb716c8029d19502701d2c96704107d0f7
+  data.tar.gz: 0da1d126eead2748545c9455ac94a4b79c94e4278526ef9f78332104c63f121a
 SHA512:
-  metadata.gz: db6f3794674d502cdc6ffc2b7c25e23e93685cb1255eba0c5a42fb3b431f170b6e70b874d630eaa3319a5a4f81660aa24ab4141b92f864f2a478f5931f67a660
-  data.tar.gz: 8ca90836a7bae3ef2cc78bfe10035486c3612fc3f6c8117568320de1082b0b447fb08d4cc909e23253328396b336e0a194b98db9c0d4a5c421737106186df42d
+  metadata.gz: 3e9d4ec02edfcdfc3ac5eea8ed235094e37d18be43e4980d1fc789219856c73fe442116c53362f5e36e91ca1a79f3a5845f7da85e6a0822dc0271e7a2b6c7e45
+  data.tar.gz: 78b47a73bc4f50e8309655b01dbac8851377630941e1e85fba9c30e02e4f5a7c0c0a326c1bfd5e6fc3f0c0f04437a23e8b948a1295e235d609abfa91d0b2a40f

data/README.md

@@ -214,12 +214,12 @@ end
 
 ```bash
 $ rake release
-activejsonmodel x.x.x built to pkg/activejsonmodel-x.x.x.gem.
+active_json_model x.x.x built to pkg/active_json_model-x.x.x.gem.
 Tagged vx.x.x.
 Pushed git commits and release tag.
 Pushing gem to https://rubygems.org...
-Successfully registered gem: activejsonmodel (x.x.x)
-Pushed activejsonmodel x.x.x to rubygems.org
+Successfully registered gem: active_json_model (x.x.x)
+Pushed active_json_model x.x.x to rubygems.org
 Don't forget to publish the release on GitHub!
 ```
 

data/lib/{activejsonmodel → active_json_model}/active_record_encrypted_type.rb

@@ -18,25 +18,29 @@ if Gem.find_files("symmetric-encryption").any? &&
     #      end
     #    end
     #
-    #    class Integration < ActiveRecord::Base
+    #    class User < ActiveRecord::Base
     #      attribute :credentials, Credentials.encrypted_attribute_type
     #    end
+    #
+    # Alternatively, the type can be registered ahead of time:
+    #
+    #    # config/initializers/types.rb
+    #    ActiveRecord::Type.register(:credentials_encrypted_type, Credentials.encrypted_attribute_type)
+    #
+    # Then the custom type can be used as:
+    #
+    #    class User < ActiveRecord::Base
+    #      attribute :credentials, :credentials_encrypted_type
+    #    end
+    #
     class ActiveRecordEncryptedType < ::ActiveJsonModel::ActiveRecordType
       def type
         :string
       end
 
-      def cast(value)
-        if value.is_a?(@clazz)
-          value
-        elsif value.is_a?(::Array)
-          @clazz.load(value)
-        end
-      end
-
       def deserialize(value)
         if String === value
-            decoded = SymmetricEncryption.decrypt(value, type: :json) rescue nil
+          decoded = SymmetricEncryption.decrypt(value, type: :json) rescue nil
           @clazz.load(decoded)
         else
           super
@@ -46,9 +50,17 @@ if Gem.find_files("symmetric-encryption").any? &&
       def serialize(value)
         case value
         when @clazz
-          ::ActiveSupport::JSON.encode(@clazz.dump(value))
-        when Array, Hash
-          ::ActiveSupport::JSON.encode(value)
+          SymmetricEncryption.encrypt(
+            @clazz.dump(value),
+            random_iv: true,
+            type: :json
+          )
+        when ::Hash, ::HashWithIndifferentAccess, ::Array
+          SymmetricEncryption.encrypt(
+            value,
+            random_iv: true,
+            type: :json
+          )
         else
           super
         end

data/lib/{activejsonmodel → active_json_model}/active_record_type.rb

@@ -15,10 +15,21 @@ if Gem.find_files("active_record").any?
     #      end
     #    end
     #
-    #    class Integration < ActiveRecord::Base
+    #    class User < ActiveRecord::Base
     #      attribute :credentials, Credentials.attribute_type
     #    end
     #
+    # Alternatively, the type can be registered ahead of time:
+    #
+    #    # config/initializers/types.rb
+    #    ActiveRecord::Type.register(:credentials_type, Credentials.attribute_type)
+    #
+    # Then the custom type can be used as:
+    #
+    #    class User < ActiveRecord::Base
+    #      attribute :credentials, :credentials_type
+    #    end
+    #
     # This is based on:
     # https://jetrockets.pro/blog/rails-5-attributes-api-value-objects-and-jsonb
     class ActiveRecordType < ::ActiveRecord::Type::Value
@@ -39,11 +50,7 @@ if Gem.find_files("active_record").any?
       end
 
       def cast(value)
-        if value.is_a?(@clazz)
-          value
-        elsif value.is_a?(::Array)
-          @clazz.load(value)
-        end
+        @clazz.active_json_model_cast(value)
       end
 
       def deserialize(value)
@@ -59,7 +66,7 @@ if Gem.find_files("active_record").any?
         case value
         when @clazz
           ::ActiveSupport::JSON.encode(@clazz.dump(value))
-        when Array, Hash
+        when ::Hash, ::HashWithIndifferentAccess, ::Array
           ::ActiveSupport::JSON.encode(value)
         else
           super

data/lib/{activejsonmodel → active_json_model}/array.rb

@@ -6,7 +6,7 @@ require 'active_support'
 require_relative './json_attribute'
 require_relative './after_load_callback'
 
-if defined?(::ActiveRecord)
+if Gem.find_files("active_record").any?
   require_relative './active_record_type'
   require_relative './active_record_encrypted_type'
 end
@@ -238,7 +238,11 @@ module ActiveJsonModel
         #
         # Note that this array_data would be stored as jsonb in the database
         def attribute_type
-          @attribute_type ||= ActiveModelJsonSerializableType.new(self)
+          if Gem.find_files("active_record").any?
+            @attribute_type ||= ::ActiveJsonModel::ActiveRecordType.new(self)
+          else
+            raise RuntimeError.new('ActiveRecord must be installed to use attribute_type')
+          end
         end
 
         # Allow this model to be used as ActiveRecord attribute type in Rails 5+.
@@ -253,7 +257,15 @@ module ActiveJsonModel
         # Note that this array_data would be stored as a string in the database, encrypted using
         # a symmetric key at the application level.
         def encrypted_attribute_type
-          @encrypted_attribute_type ||= ActiveModelJsonSerializableEncryptedType.new(self)
+          if Gem.find_files("active_record").any?
+            if Gem.find_files("symmetric-encryption").any?
+              @encrypted_attribute_type ||= ::ActiveJsonModel::ActiveRecordEncryptedType.new(self)
+            else
+              raise RuntimeError.new('symmetric-encryption must be installed to use attribute_type')
+            end
+          else
+            raise RuntimeError.new('active_record must be installed to use attribute_type')
+          end
         end
       end
 
@@ -605,6 +617,26 @@ module ActiveJsonModel
         end
       end
 
+      # Convert a value that might already be an instance of this class from underlying data.
+      # Used to delegate potential loading from ActiveRecord attributes
+      #
+      # @param vals either an instance of this model or an array-like object
+      def active_json_model_cast(vals)
+        if vals.is_a?(self)
+          vals
+        elsif vals.is_a?(::Array)
+          if vals.length == 0
+            self.new(values: vals)
+          elsif vals[0].respond_to?(:dump_to_json)
+            self.new(values: vals)
+          else
+            self.load(vals)
+          end
+        elsif vals.nil?
+          self.new(values: [])
+        end
+      end
+
       # Define a polymorphic factory to choose the concrete class for the list model. Note that because the array_data passed
       # to the block is an array of models, you must account for what the behavior is if there are no elements.
       #

data/lib/{activejsonmodel → active_json_model}/model.rb

@@ -5,7 +5,7 @@ require 'json'
 require_relative './json_attribute'
 require_relative './after_load_callback'
 
-if defined?(::ActiveRecord)
+if Gem.find_files("active_record").any?
   require_relative './active_record_type'
   require_relative './active_record_encrypted_type'
 end
@@ -275,7 +275,11 @@ module ActiveJsonModel
         #
         # Note that this data would be stored as jsonb in the database
         def attribute_type
-          @attribute_type ||= ActiveModelJsonSerializableType.new(self)
+          if Gem.find_files("active_record").any?
+            @attribute_type ||= ::ActiveJsonModel::ActiveRecordType.new(self)
+          else
+            raise RuntimeError.new('ActiveRecord must be installed to use attribute_type')
+          end
         end
 
         # Allow this model to be used as ActiveRecord attribute type in Rails 5+.
@@ -290,7 +294,15 @@ module ActiveJsonModel
         # Note that this data would be stored as a string in the database, encrypted using
         # a symmetric key at the application level.
         def encrypted_attribute_type
-          @encrypted_attribute_type ||= ActiveModelJsonSerializableEncryptedType.new(self)
+          if Gem.find_files("active_record").any?
+            if Gem.find_files("symmetric-encryption").any?
+              @encrypted_attribute_type ||= ::ActiveJsonModel::ActiveRecordEncryptedType.new(self)
+            else
+              raise RuntimeError.new('symmetric-encryption must be installed to use attribute_type')
+            end
+          else
+            raise RuntimeError.new('active_record must be installed to use attribute_type')
+          end
         end
       end
 
@@ -547,6 +559,18 @@ module ActiveJsonModel
         end
       end
 
+      # Convert a value that might already be an instance of this class from underlying data.
+      # Used to delegate potential loading from ActiveRecord attributes
+      #
+      # @param val either an instance of this model or a Hash like object
+      def active_json_model_cast(val)
+        if val.is_a?(self)
+          val
+        elsif val.is_a?(::Hash) || val.is_a?(::HashWithIndifferentAccess)
+          self.load(val)
+        end
+      end
+
       # Register a new after load callback which is invoked after the instance is loaded from JSON
       #
       # @param method_name [Symbol, String] the name of the method to be invoked

data/lib/{activejsonmodel → active_json_model}/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveJsonModel
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.5".freeze
 end

data/lib/active_json_model.rb

@@ -1,8 +1,13 @@
 require 'active_model'
+require "active_support"
 
 module ActiveJsonModel
-  autoload :VERSION, "activejsonmodel/version"
-  autoload :Model, "activejsonmodel/model"
-  autoload :Array, "activejsonmodel/array"
-  autoload :Utils, "activejsonmodel/utils"
+  extend ActiveSupport::Autoload
+
+  autoload :ActiveRecordEncryptedType, "active_json_model/active_record_encrypted_type" unless Gem.find_files("active_record").none? || Gem.find_files("symmetric-encryption").none?
+  autoload :ActiveRecordType, "active_json_model/active_record_type" unless Gem.find_files("active_record").none?
+  autoload :Array, "active_json_model/array"
+  autoload :Model, "active_json_model/model"
+  autoload :Utils, "active_json_model/utils"
+  autoload :VERSION, "active_json_model/version"
 end

data/lib/activejsonmodel.rb

@@ -0,0 +1,4 @@
+# This file is here to make sure Rail's autoloading of gems works
+# When requiring manually, use:
+#   require 'active_json_model'
+require_relative './active_json_model'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejsonmodel
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Ryan Morlok
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -50,7 +50,12 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
-description:
+description: |
+  A library for creating Active Models that can serialize/deserialize to JSON. This includes full support for validation
+  and change detection through nested models. You can write polymorphic models or arrays of models and get full support
+  for natural serialization.
+
+  Active JSON Model can optionally be combined with Active Record to create nested child models via JSON/JSONB columns.
 email:
 - ryan.morlok@morlok.com
 executables: []
@@ -60,14 +65,15 @@ files:
 - LICENSE.txt
 - README.md
 - lib/active_json_model.rb
-- lib/activejsonmodel/active_record_encrypted_type.rb
-- lib/activejsonmodel/active_record_type.rb
-- lib/activejsonmodel/after_load_callback.rb
-- lib/activejsonmodel/array.rb
-- lib/activejsonmodel/json_attribute.rb
-- lib/activejsonmodel/model.rb
-- lib/activejsonmodel/utils.rb
-- lib/activejsonmodel/version.rb
+- lib/active_json_model/active_record_encrypted_type.rb
+- lib/active_json_model/active_record_type.rb
+- lib/active_json_model/after_load_callback.rb
+- lib/active_json_model/array.rb
+- lib/active_json_model/json_attribute.rb
+- lib/active_json_model/model.rb
+- lib/active_json_model/utils.rb
+- lib/active_json_model/version.rb
+- lib/activejsonmodel.rb
 homepage: https://github.com/rmorlok/activejsonmodel
 licenses:
 - MIT