activejsonmodel 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b7eed61989b4be5a09f4d258b54c3d5cdda35c3b129f21596e6a33dbf82347
-  data.tar.gz: d62f8023f6e64689c4cf01998e8f1fed2b4acfc5654ecb5fed073e69bf1075aa
+  metadata.gz: e7dc0c113f2d8bd650b237c5888d8cfdc8e0bb7747dc994eacc88bed98ed86fd
+  data.tar.gz: 88ef99a717976d7ba37de7523f101fbff1f49ec848bd6e216f33f7a33482d530
 SHA512:
-  metadata.gz: 04c87f280772d42105d22547deb96d7920536469f4656fa1541c95a67145e95e7c210aa0b8054e3406058604ad303fd635732e6f560c56651d75fe9d40b57d66
-  data.tar.gz: 03fc5c92a441bc639c23e194eaaab53f86fe37a1d427d689c305aa898d7ec247a6f52db991961c9224cdfdeaa6f30ba55d7692e4ad8fefbea6f8c8a4e9527618
+  metadata.gz: '09bb083c925bed9b1efdf6fa7b343cb85e3b7ac5419d614218590980657bce605ff444a1012680c20e97639ae535ebc0a413f7b2eb51f90f8ad5518a11f7a0eb'
+  data.tar.gz: 74455ab06735cfb9b27d68cbe44d6457cb968b3eeaae2dc79e691f1bc5a36f161aa015403cf6effdd0f970b8d1d2f7dc25e46f7637a0ec5b74ad0746f12e3521

data/README.md

@@ -1,14 +1,17 @@
-# activejsonmodel
+# Active JSON Model
 
 [![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)
+![Github Actions CI](https://github.com/rmorlok/activejsonmodel/actions/workflows/ci.yaml/badge.svg)
 
-TODO: Description of this gem goes here.
+A library for creating Active Models that can serialize/deserialize to JSON. This includes full support for validation
+and change detection through nested models.
+
+Active JSON Model can optionally be combined with Active Record to create nested child models via JSON/JSONB columns. 
 
 ---
 
 - [Quick start](#quick-start)
+- [Gem on RubyGems](https://rubygems.org/gems/activejsonmodel)
 - [Support](#support)
 - [License](#license)
 - [Code of conduct](#code-of-conduct)
@@ -16,14 +19,109 @@ TODO: Description of this gem goes here.
 
 ## Quick start
 
+Install the gem:
+
 ```
 $ gem install activejsonmodel
 ```
 
+If not using in an auto-loading context (i.e. Rails), import it:
+
 ```ruby
 require "active_json_model"
 ```
 
+define a model:
+
+```ruby
+class Point
+  include ActiveJsonModel::Model
+  
+  json_attribute :x, Integer
+  json_attribute :y, Integer
+end
+```
+
+create an instance of a model:
+
+```ruby
+origin = Point.new(x: 0, y:0)
+# => #<Point:0x00007f9f0d0e6538 @mutations_before_last_save=nil, @mutations_from_database=nil, @x=0, @x_is_default=false, @y=0, @y_is_default=false>
+```
+
+export it to a JSON-like hash:
+
+```ruby
+data = origin.dump_to_json
+# => {:x=>0, :y=>0}
+```
+
+encode it as JSON:
+
+```ruby
+JSON.dump(origin.dump_to_json)
+# => "{\"x\":0,\"y\":0}"
+```
+
+load data from a hash object:
+
+```ruby
+point2 = Point.load({x: 17, y:42})
+# => #<Point:0x00007f9f0d10d5c0 @_active_json_model_loaded=true, @mutations_before_last_save=nil, @mutations_from_database=nil, @x=17, @x_is_default=false, @y=42, @y_is_default=false>
+```
+
+load from a raw JSON string:
+
+```ruby
+point3 = Point.load("{\"x\":12,\"y\":19}")
+# => #<Point:0x00007fe9c0113c88 @_active_json_model_loaded=true, @mutations_before_last_save=nil, @mutations_from_database=nil, @x=12, @x_is_default=false, @y=19, @y_is_default=false>
+```
+
+nest models:
+
+```ruby
+class Rectangle
+  include ActiveJsonModel::Model
+
+  json_attribute :top_left, Point
+  json_attribute :bottom_right, Point
+  
+  def contains(point)
+    point.x >= top_left.x && 
+      point.x <= bottom_right.x &&
+      point.y <= top_left.y &&
+      point.y >= bottom_right.y
+  end
+end
+```
+
+If you are using Active Record, use the model as an attribute:
+
+```ruby
+# db/migrate/20220101000001_create_image_annotations.rb
+class CreateImageAnnotations < ActiveRecord::Migration[7.0]
+  def change
+    create_table :image_annotations do |t|
+      t.jsonb      :region_of_interest, null: false, default: {}
+      t.string     :note, null: false, default: ''
+    end
+  end
+end
+
+# app/models/image_annotation.rb
+class ImageAnnotation < ActiveRecord::Base 
+  attribute :region_of_interest, Rectangle.attribute_type
+end
+
+# use...
+rect = Rectangle.new(
+  top_left: Point.new(x: 10, y: 100),
+  bottom_right: Point.new(x: 110, y: 0)
+)
+ia = ImageAnnotation.new(region_of_interest: rect, note: "Check out this mistake")
+ia.save
+```
+
 ## 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!
@@ -76,4 +174,53 @@ Active JSON Model uses [minitest](https://github.com/minitest/minitest). To run
 
 ```bash
 rake test
-```
+```
+
+### Building Gem Locally
+
+Build the gem to `pkg/activejsonmodel-x.x.x.gem`:
+
+```bash
+rake build
+```
+
+Install the gem locally and import it:
+
+```bash
+$ gem install ./pkg/activejsonmodel-x.x.x.gem
+Successfully installed activejsonmodel-x.x.x
+Parsing documentation for activejsonmodel-x.x.x
+Installing ri documentation for activejsonmodel-x.x.x
+Done installing documentation for activejsonmodel after 0 seconds
+1 gem installed
+
+$ irb
+irb(main):001:0> require 'active_json_model'
+=> true 
+```
+
+### Releasing a new version
+
+1. Update `lib/activejsonmodel/version.rb`
+
+```ruby
+module ActiveJsonModel
+  VERSION = "x.x.x".freeze
+end
+```
+
+2. Commit all changes
+3. Release the changes using rake:
+
+```bash
+$ rake release
+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: 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!
+```
+
+Note that this pushes changes to github and creates a draft release on github. 

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
 

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

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'active_support'
+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
@@ -274,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+.
@@ -289,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
 
@@ -572,7 +585,7 @@ module ActiveJsonModel
         end
 
         # Get the data to a hash, regardless of the starting data type
-        data = json_data.is_a?(String) ? JSON.parse(json_data) : json_data
+        data = json_data.is_a?(String) ? ::JSON.parse(json_data) : json_data
 
         # Recursively make the value have indifferent access
         data = ::ActiveJsonModel::Utils.recursively_make_indifferent(data)

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveJsonModel
-  VERSION = "0.1.1".freeze
+  VERSION = "0.1.4".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.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Ryan Morlok
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2022-09-03 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
@@ -85,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="