activejsonmodel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bc1e18ab1cb9a6672dc6ab19a0a05340f4761b5cb51ef626d36800846f85a5c
+  data.tar.gz: 847077d254ef430b85ee5853f8d882e0df84f12b34494d1d47868aa32198989c
+SHA512:
+  metadata.gz: 79b717de46de263cc15a03ca0bad9c636bf12458f037078c66b61bcf7c31fbead8106b4506b54731cf44d9a1a267a62e062f900ca37a0d30e79520f9b44e1ee3
+  data.tar.gz: 02cdb543f99326a32c4645898cc99bded4e3136a9b4b3e2d9b09f61792f6761db091ea52f6acf52ec8b4a8f0d1ad4575ddfa74e29ba6e561ea25251f3b1d4630

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ryan Morlok
+
+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.

data/README.md

@@ -0,0 +1,79 @@
+# activejsonmodel
+
+[![Gem Version](https://badge.fury.io/rb/activejsonmodel.svg)](https://rubygems.org/gems/activejsonmodel)
+[![Circle](https://circleci.com/gh/rmorlok/activejsonmodel/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/rmorlok/activejsonmodel?branch=main)
+[![Code Climate](https://codeclimate.com/github/rmorlok/activejsonmodel/badges/gpa.svg)](https://codeclimate.com/github/rmorlok/activejsonmodel)
+
+TODO: Description of this gem goes here.
+
+---
+
+- [Quick start](#quick-start)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Quick start
+
+```
+$ gem install activejsonmodel
+```
+
+```ruby
+require "active_json_model"
+```
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/rmorlok/activejsonmodel/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!
+
+### Development Setup
+
+```bash
+brew install rbenv
+```
+
+Add the following to `~/.zshrc`:
+
+```bash
+RBENV=`which rbenv`
+if [ $RBENV ] ; then
+  export PATH=$HOME/.rbenv/bin:$PATH
+  eval "$(rbenv init -)"
+fi
+```
+
+Reload the `~/.zshrc`.
+
+Install development ruby version:
+
+```bash
+cat .ruby-version | xargs rbenv install
+```
+
+Exit and re-enter the directory to make sure the current version of ruby is used. Install dependencies:
+
+```bash
+bundle install
+```
+
+### Running Tests
+
+Active JSON Model uses [minitest](https://github.com/minitest/minitest). To run tests, use rake:
+
+```bash
+rake test
+```

data/lib/active_json_model.rb

@@ -0,0 +1,8 @@
+require 'active_model'
+
+module ActiveJsonModel
+  autoload :VERSION, "activejsonmodel/version"
+  autoload :Model, "activejsonmodel/model"
+  autoload :Array, "activejsonmodel/array"
+  autoload :Utils, "activejsonmodel/utils"
+end

data/lib/activejsonmodel/active_record_encrypted_type.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Only available if the symmetric-encryption gem is installed
+# https://github.com/reidmorrison/symmetric-encryption
+if Gem.find_files("symmetric-encryption").any? &&
+  Gem.find_files("active_record").any?
+
+  require "symmetric-encryption"
+  require 'active_support'
+  require_relative './active_record_type'
+
+  module ActiveJsonModel
+    # Allows instances of ActiveJsonModels to be serialized JSONB columns for ActiveRecord models.
+    #
+    #    class Credentials < ::ActiveJsonModel
+    #      def self.encrypted_attribute_type
+    #        ActiveRecordEncryptedType.new(Credentials)
+    #      end
+    #    end
+    #
+    #    class Integration < ActiveRecord::Base
+    #      attribute :credentials, Credentials.encrypted_attribute_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
+          @clazz.load(decoded)
+        else
+          super
+        end
+      end
+
+      def serialize(value)
+        case value
+        when @clazz
+          ::ActiveSupport::JSON.encode(@clazz.dump(value))
+        when Array, Hash
+          ::ActiveSupport::JSON.encode(value)
+        else
+          super
+        end
+      end
+
+      # Override to handle issues comparing hashes encoded as strings, where the actual order doesn't matter.
+      def changed_in_place?(raw_old_value, new_value)
+        if raw_old_value.nil? || new_value.nil?
+          raw_old_value == new_value
+        else
+          # Decode is necessary because postgres can change the order of hashes. Round-tripping on the new value side
+          # is to handle any dates that might be rendered as strings.
+          decoded_raw = ::ActiveSupport::JSON.decode(raw_old_value)
+          round_tripped_new = ::ActiveSupport::JSON.decode(new_value.class.dump(new_value))
+
+          decoded_raw != round_tripped_new
+        end
+      end
+    end
+  end
+end

data/lib/activejsonmodel/active_record_type.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Only available if the active record is installed, generally in a rails environment
+if Gem.find_files("active_record").any?
+
+  require 'active_record'
+  require 'active_support'
+
+  module ActiveJsonModel
+    # Allows instances of ActiveJsonModels to be serialized JSONB columns for ActiveRecord models.
+    #
+    #    class Credentials < ::ActiveJsonModel
+    #      def self.attribute_type
+    #        ActiveRecordType.new(Credentials)
+    #      end
+    #    end
+    #
+    #    class Integration < ActiveRecord::Base
+    #      attribute :credentials, Credentials.attribute_type
+    #    end
+    #
+    # This is based on:
+    # https://jetrockets.pro/blog/rails-5-attributes-api-value-objects-and-jsonb
+    class ActiveRecordType < ::ActiveRecord::Type::Value
+      include ::ActiveModel::Type::Helpers::Mutable
+
+      # Create an instance bound to a ActiveJsonModel class.
+      #
+      # e.g.
+      #    class Credentials < ::ActiveJsonModel; end
+      #    #...
+      #    return ActiveRecordType.new(Credentials)
+      def initialize(clazz)
+        @clazz = clazz
+      end
+
+      def type
+        :jsonb
+      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 = ::ActiveSupport::JSON.decode(value) rescue nil
+          @clazz.load(decoded)
+        else
+          super
+        end
+      end
+
+      def serialize(value)
+        case value
+        when @clazz
+          ::ActiveSupport::JSON.encode(@clazz.dump(value))
+        when Array, Hash
+          ::ActiveSupport::JSON.encode(value)
+        else
+          super
+        end
+      end
+
+      # Override to handle issues comparing hashes encoded as strings, where the actual order doesn't matter.
+      def changed_in_place?(raw_old_value, new_value)
+        if raw_old_value.nil? || new_value.nil?
+          raw_old_value == new_value
+        else
+          # Decode is necessary because postgres can change the order of hashes. Round-tripping on the new value side
+          # is to handle any dates that might be rendered as strings.
+          decoded_raw = ::ActiveSupport::JSON.decode(raw_old_value)
+          round_tripped_new = ::ActiveSupport::JSON.decode(new_value.class.dump(new_value))
+
+          decoded_raw != round_tripped_new
+        end
+      end
+    end
+  end
+end

data/lib/activejsonmodel/after_load_callback.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ActiveJsonModel
+  class AfterLoadCallback
+    attr_reader :method_name
+    attr_reader :block
+
+    # Data holder for an after-load callback
+    #
+    # @param method_name [Symbol] the name of method to be invoked as a callback
+    # @param block [Proc] block to be executed as the callback
+    def initialize(method_name:, block:)
+      raise "ActiveJsonModel after load callback must either be a block or a method name" if method_name && block
+      raise "ActiveJsonModel after load callback must either specify a block or method name" unless method_name || block
+
+      @method_name = method_name&.to_sym
+      @block = block
+    end
+
+    # Invoke this callback on <code>on_object</code> the object just loaded from JSON
+    #
+    # @param on_object [Object] the object just loaded from JSON
+    def invoke(on_object)
+      if method_name
+        on_object.send(method_name)
+      else
+        if block.arity == 1
+          block.call(on_object)
+        else
+          block.call
+        end
+      end
+    end
+  end
+end