octojson 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f942e2da4cb45bfacb5affe69154c4431b85a61d1d99c98740daf71af0a4442
+  data.tar.gz: 4b8c165ef9fb600bfb99a43f6dd5559fcebb31f40869371fdc99bd5127baf72e
+SHA512:
+  metadata.gz: a26204c160edda006f5a3a49a8bc1b8fc5c83887119dafd063d30460ff1a5e00f2ae86d25d584fccd8a757cf4ab015e2f95f6e3f29e1372fda3b637012d9165e
+  data.tar.gz: cfaea459b9959e537f6ebc49b43d822bf3cbcd2ed6847cb3bf23512a74c41cb87727b1a257c44a781c9d3918884c02cf582078bf1831a557939aadf3496222b6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Chris Bacon
+
+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/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Octojson'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+require "standalone_migrations"
+StandaloneMigrations::Tasks.load_tasks
+
+task default: :test

data/lib/octojson.rb

@@ -0,0 +1,71 @@
+require 'active_record'
+
+module ActiveRecord
+  module Octojson
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def octojson(json_attribute, schema, schema_key)      
+        schema.each do |attribute,data|
+          data.each do |key,value|
+            define_method("#{json_attribute}_#{attribute}_#{key}") do 
+              self[json_attribute][key.to_s]
+            end
+
+            if value[:validates]
+              validates "#{json_attribute}_#{attribute}_#{key}", value[:validates].merge(if: -> { send(schema_key.to_s) == attribute.to_s })
+            end
+          end
+        end
+
+        after_initialize do 
+          if new_record? && has_attribute?(json_attribute) && instance_eval(schema_key.to_s)
+            field_types = schema[instance_eval(schema_key.to_s).to_sym]
+            write_attributes(json_attribute, field_types) unless field_types.nil?
+          end
+        end
+
+        before_validation do
+          if has_attribute?(json_attribute) 
+            field_types = schema[instance_eval(schema_key.to_s).to_sym]
+            write_attributes(json_attribute, field_types) unless field_types.nil?
+          end
+        end
+
+        define_method("#{json_attribute}_strong_params") do 
+          if has_attribute?(json_attribute)
+            field_types = schema[instance_eval(schema_key.to_s).to_sym]
+            
+            return nil if field_types.nil?
+            
+            field_types.map do |k,v|
+              v[:type] == :json ? { k => v[:nested_attributes] } : k
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def write_attributes(json_attribute, field_types)
+      if self.send("#{json_attribute}_changed?") && !self.send("#{json_attribute}_change")[0].blank?
+        self[json_attribute] = self.send("#{json_attribute}_change")[0].merge(self[json_attribute])
+      end
+
+      self[json_attribute] = {} if self[json_attribute].blank?
+      new_settings = {}
+      field_types.each do |key,value|
+        if self[json_attribute][key.to_s] == nil
+          new_settings[key] = value[:default]
+        else
+          new_settings[key] = self[json_attribute][key.to_s]        
+        end
+      end
+
+      self[json_attribute] = new_settings
+    end
+  end
+end
+
+ActiveRecord::Base.include(ActiveRecord::Octojson)

data/lib/octojson/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Octojson
+    VERSION = "0.0.2"
+  end
+end

data/test/db/config.yml

@@ -0,0 +1,9 @@
+default: &default
+  adapter: postgresql
+  database: octojson
+
+development:
+  <<: *default
+
+test:
+  <<: *default

data/test/db/migrate/20200407031737_build_test_db.rb

@@ -0,0 +1,8 @@
+class BuildTestDb < ActiveRecord::Migration[6.0]
+  def change
+    create_table :posts do |t|
+      t.string :post_type
+      t.jsonb :settings
+    end
+  end
+end

data/test/db/schema.rb

@@ -0,0 +1,23 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `rails
+# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 2020_04_07_031737) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "posts", force: :cascade do |t|
+    t.string "post_type"
+    t.jsonb "settings"
+  end
+
+end

data/test/fixtures/models/post.rb

@@ -0,0 +1,22 @@
+class Post < ActiveRecord::Base
+  SCHEMA = { 
+    type_one: {
+      title: { type: :string, default: 'Title -- one' },
+      text_one: { type: :string, default: 'something cool -- one' },
+      boolean_one: { type: :boolean, default: false },
+      number_one: { type: :integer, default: 3, validates: { numericality: { only_integer: true, greater_than_or_equal_to: 1, less_than_or_equal_to: 5 } } },
+      json_one: { type: :json, default: {}, nested_attributes: [:nested_one, :nested_two, :nested_three] },
+    },  
+    type_two: {
+      title: { type: :string, default: 'Title -- two' },
+      text_two: { type: :string, default: 'something cool -- two' },
+      boolean_two: { type: :boolean, default: true },
+    },
+    type_three: {
+      title: { type: :string, default: 'Title -- three' },
+      text_three: { type: :string, default: 'something cool -- three' }
+    }
+  }.freeze
+
+  octojson :settings, SCHEMA, :post_type
+end

data/test/octojson_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper'
+
+class OctojsonTest < ActiveSupport::TestCase
+  
+  test '#new with defaults' do
+    post = Post.new(post_type: 'type_one')
+
+    assert_equal post.settings['title'], 'Title -- one'
+    assert_equal post.settings['text_one'], 'something cool -- one'
+    assert_equal post.settings['boolean_one'], false
+    assert_equal post.settings['number_one'], 3
+    assert_equal post.settings['json_one'], {}
+
+    post_two = Post.new(post_type: 'type_two')
+
+    assert_equal post_two.settings['title'], 'Title -- two'
+    assert_equal post_two.settings['text_two'], 'something cool -- two'
+    assert_equal post_two.settings['boolean_two'], true
+    assert_nil post_two.settings['text_one']
+  end
+
+  test '#new with attributes' do
+    post = Post.new(post_type: 'type_one', settings: { title: 'Not default' })
+    assert_equal post.settings['title'], 'Not default'
+  end
+
+  test '#new with attributes not in schema' do
+    post = Post.new(post_type: 'type_one', settings: { something: 'Not default' })
+    assert_nil post.settings['something']
+  end
+
+  test '#create' do
+    post = Post.create(post_type: 'type_one', settings: { title: 'Created title' })
+    assert_equal post.settings['title'], 'Created title'
+    assert_equal post.settings['text_one'], 'something cool -- one'
+  end
+
+  test '#save with defaults' do
+    post = Post.new
+    post.post_type = 'type_one'
+    post.save
+
+    assert_equal post.settings['title'], 'Title -- one'
+    assert_equal post.settings['text_one'], 'something cool -- one'
+    assert_equal post.settings['boolean_one'], false
+    assert_equal post.settings['number_one'], 3
+    assert_equal post.settings['json_one'], {}
+
+    post_two = Post.new
+    post_two.post_type = 'type_two'
+    post_two.save
+    assert_equal post_two.settings['title'], 'Title -- two'
+    assert_equal post_two.settings['text_two'], 'something cool -- two'
+    assert_equal post_two.settings['boolean_two'], true
+    assert_nil post_two.settings['text_one']
+  end
+
+  test '#update' do
+    post = Post.create(post_type: 'type_one')
+    assert_equal post.settings['title'], 'Title -- one'
+
+    post.update(settings: { title: 'testing 123' })
+    assert_equal post.settings['title'], 'testing 123'
+  end
+
+  test '#update should use default if assigning nil' do
+    post = Post.create(post_type: 'type_one', settings: { title: 'testing' })
+    assert_equal post.settings['title'], 'testing'
+
+    post.update(settings: { title: nil })
+    assert_equal post.settings['title'], 'Title -- one'
+  end
+
+  test '#{json_attribute}_strong_params' do
+    post = Post.new
+    post.post_type = 'type_one'
+    post.save
+
+    assert_equal post.settings_strong_params, [
+        :title, 
+        :text_one, 
+        :boolean_one, 
+        :number_one, 
+        { :json_one=> [:nested_one, :nested_two, :nested_three] }
+      ]
+  end
+
+  test 'valid on initialize' do
+    post = Post.new(post_type: 'type_one')
+    assert_equal post.valid?, true
+  end
+
+  test 'invalid when settings attribute out of range' do
+    post = Post.new(post_type: 'type_one', settings: { number_one: 99 })
+    assert_equal post.valid?, false
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require "rubygems"
+require "octojson"
+require "minitest/autorun"
+require "minitest/unit"
+require "pry"
+
+Dir[File.join(__dir__, 'fixtures', 'models', '*.rb')].each { |file| require file }
+
+dbconfig = YAML.load(File.open(File.join(__dir__,'db','config.yml')))
+ActiveRecord::Base.establish_connection(dbconfig["test"])

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: octojson
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Chris Bacon
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standalone_migrations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Set a schema, defaults, and validations for your json attributes
+email:
+- chris@crispybacon.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/octojson.rb
+- lib/octojson/version.rb
+- test/db/config.yml
+- test/db/migrate/20200407031737_build_test_db.rb
+- test/db/schema.rb
+- test/fixtures/models/post.rb
+- test/octojson_test.rb
+- test/test_helper.rb
+homepage: https://github.com/baconck/octojson
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Set a schema, defaults, and validations for your json attributes
+test_files:
+- test/octojson_test.rb
+- test/db/schema.rb
+- test/db/migrate/20200407031737_build_test_db.rb
+- test/db/config.yml
+- test/fixtures/models/post.rb
+- test/test_helper.rb