atomic_json 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0.pre.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'.freeze
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in atomic_json.gemspec
+gemspec
+
+gem 'pg'

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    atomic_json (0.1.0)
+      activerecord (>= 5.0)
+      activesupport (~> 5.0)
+      pg (~> 0.18, >= 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    erubi (1.7.1)
+    factory_bot (4.10.0)
+      activesupport (>= 3.0.0)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    pg (0.21.0)
+    powerpack (0.1.2)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (10.4.2)
+    rubocop (0.58.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    standalone_migrations (5.2.5)
+      activerecord (>= 4.2.7, < 5.3.0)
+      railties (>= 4.2.7, < 5.3.0)
+      rake (>= 10.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  atomic_json!
+  bundler (~> 1.16.a)
+  byebug (~> 10.0, >= 10.0.2)
+  factory_bot (~> 4.0)
+  minitest (~> 5.0)
+  pg
+  rake (~> 10.0)
+  rubocop (~> 0.58.1)
+  standalone_migrations (~> 5.2, >= 5.2.5)
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Antoine Macia
+
+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,83 @@
+# AtomicJson
+
+Expose a simple set of methods to allow fast atomic updates of `json`/`jsonb` columns of ActiveRecord models using PostgresQL `jsonb_set` [function](https://www.postgresql.org/docs/9.5/static/functions-json.html) 
+
+- Support updates of `json` and `jsonb` columns
+- Support update of deeply nested fields
+- Support update of multiple fields at once
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'atomic_json'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+To update a `json` or `jsonb` column, simply pass a Hash to the bellow method call, 
+using the column name as top level key and a nested hash of the value(s) you're willing to update
+
+Only the fields you've specified will be updated
+
+``` 
+order.data
+=> { amount: 50.00, first_name: 'Milkpie', last_name: 'Starlord' }
+
+order.jsonb_update(data: { amount: 10.00 })
+
+order.data
+=> { amount: 10.00, first_name: 'Milkpie', last_name: 'Starlord' }
+``` 
+
+For the sake of simplicity, AtomicJson mimic the behavior of standard ActiveRecord query methods to update database fields
+
+### jsonb_update_columns
+
+Same as ActiveRecord `update_columns`, this method will make a straight database update
+- Validations are skipped
+- Callbacks are skipped
+- `updated_at` is not updated
+
+```
+order.jsonb_update_columns(data: { paid: false })
+=> true
+```
+
+### jsonb_update
+
+Same as ActiveRecord `update`, this method will
+- Invoke validations
+- Invoke callbacks
+- Touch record `updated_at`
+
+```
+order.jsonb_update(data: { paid: false, product_id: 3772389212 })
+=> false
+```
+
+### jsonb_update!
+
+Same as the above `json_update!`, but will raise an `ActiveRecord::RecordInvalid` exception 
+if a custom validation fails
+
+```
+order.jsonb_update!(data: { paid: false, product_id: 3772389212 })
+=> ActiveRecord::RecordInvalid Exception: Validation failed: data product_id can't be changed
+```
+## Todo's
+
+- Support update of `json`/`jsonb` arrays via index and key/value id
+
+## Requierements
+
+- PostgresQL version 9.5 minimum
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'standalone_migrations'
+
+StandaloneMigrations::Tasks.load_tasks
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+Rake::TestTask.new(:benchmark) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_benchmark.rb']
+end
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/atomic_json.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atomic_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'atomic_json'
+  spec.version       = AtomicJson::VERSION
+  spec.authors       = ['Antoine Macia']
+  spec.email         = ['antoine@discolabs.com']
+
+  spec.summary       = 'Atomic update of JSON/JSONB fields for ActiveRecord models'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5.0'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0'
+  spec.add_runtime_dependency 'pg', '~> 0.18', '>= 0.18.1'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 10.0', '>= 10.0.2'
+  spec.add_development_dependency 'factory_bot', '~> 4.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58.1'
+  spec.add_development_dependency 'standalone_migrations', '~> 5.2', '>= 5.2.5'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'atomic_json'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/db/config.yml

@@ -0,0 +1,8 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+
+test:
+  <<: *default
+  database: atomic_json

data/db/migrate/20180715062407_create_mock_test_table.rb

@@ -0,0 +1,11 @@
+class CreateMockTestTable < ActiveRecord::Migration[5.1]
+
+  def change
+    create_table :orders do |t|
+      t.jsonb :jsonb_data
+      t.json :json_data
+      t.timestamps
+    end
+  end
+
+end

data/db/schema.rb

@@ -0,0 +1,25 @@
+# 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.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20180715062407) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "orders", force: :cascade do |t|
+    t.jsonb "jsonb_data"
+    t.json "json_data"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end

data/lib/atomic_json.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_record/connection_adapters/postgresql_adapter'
+require 'atomic_json/query_methods'
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.public_send(:include, AtomicJson::QueryMethods)
+end

data/lib/atomic_json/errors.rb

@@ -0,0 +1,28 @@
+module AtomicJson
+
+  ##
+  # Base error class
+  class Error < StandardError
+  end
+
+  ##
+  # Thrown when attributes
+  class TypeError < Error
+  end
+
+  ##
+  # Thrown when top level keys provided does not correspond to a JSON/JSONB column
+  # on the updated ActiveRecord model
+  class InvalidColumnTypeError < Error
+  end
+
+  ##
+  # Thrown when the attributes to update are flagged as read-only
+  class ReadOnlyAttributeError < Error
+  end
+
+  ##
+  # Thrown on specific ActiveRecord errors
+  class ActiveRecordError < Error
+  end
+end

data/lib/atomic_json/json_query_helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module AtomicJson
+  module JsonQueryHelpers
+
+    def jsonb_quote_keys(keys)
+      "'{#{keys.map(&:to_s).join(',')}}'"
+    end
+
+    def jsonb_quote_value(value)
+      %('#{value.to_json}')
+    end
+
+    def concatenation(target, keys, value)
+      "#{target}->#{keys.map { |x| quote(x) }.join('->')} || #{jsonb_quote_value(value)}"
+    end
+
+  end
+end

data/lib/atomic_json/query.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'atomic_json/validations'
+require 'atomic_json/query_builder'
+
+module AtomicJson
+  class Query
+
+    include Validations
+
+    attr_reader :record, :connection, :query_builder
+    attr_accessor :query_string
+
+    delegate :quote_column_name, :quote_table_name, :quote, to: :connection
+
+    def initialize(record)
+      validate_record!(record)
+      @record = record
+      @connection = ActiveRecord::Base.connection
+      @query_builder = QueryBuilder.new(@record, @connection)
+    end
+
+    def build(attributes, touch: false)
+      validate_attributes!(record, attributes)
+      self.query_string = query_builder.build(attributes, touch)
+      self
+    end
+
+    def execute!
+      connection.exec_update(query_string, 'SQL')
+    rescue ActiveRecord::StatementInvalid => e
+      raise Error, e.message
+    end
+
+    def to_s
+      query_string
+    end
+
+  end
+end