atomic_json 0.1.0

data/lib/atomic_json/query_builder.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'atomic_json/json_query_helpers'
+
+module AtomicJson
+  class QueryBuilder
+
+    include JsonQueryHelpers
+
+    attr_reader :record, :connection
+
+    delegate :quote_column_name, :quote_table_name, :quote, to: :connection
+
+    def initialize(record, connection)
+      @record = record
+      @connection = connection
+    end
+
+    def build(attributes, touch)
+      <<~SQL
+        UPDATE #{quote_table_name(record.class.table_name)}
+        SET #{build_set_subquery(attributes, touch)}
+        WHERE id = #{quote(record.id)};
+      SQL
+    end
+
+    private
+
+      def build_set_subquery(attributes, touch)
+        updates = json_updates_agg(attributes)
+        updates << timestamp_update_string if touch && record.has_attribute?(:updated_at)
+        updates.join(',')
+      end
+
+      def json_updates_agg(attributes)
+        attributes.map do |column, payload|
+          "#{quote_column_name(column)} = #{json_deep_merge(column, payload)}"
+        end
+      end
+
+      def timestamp_update_string
+        "#{quote_column_name(:updated_at)} = #{quote(Time.now)}"
+      end
+
+      def json_deep_merge(target, payload)
+        loop do
+          keys, value = traverse_payload(Hash[*payload.shift])
+          target = jsonb_set_query_string(target, keys, value)
+          break target if payload.empty?
+        end
+      end
+
+      ##
+      # Traverse the Hash payload, incrementally
+      # aggregating all hash keys into an array
+      # and use the last child as value
+      def traverse_payload(key_value_pair, keys = [])
+        loop do
+          key, val = key_value_pair.flatten
+          keys << key.to_s
+          break [keys, val] unless single_value_hash?(val)
+          key_value_pair = val
+        end
+      end
+
+      def jsonb_set_query_string(target, keys, value)
+        <<~EOF
+          jsonb_set(
+            #{target}::jsonb,
+            #{jsonb_quote_keys(keys)},
+            #{multi_value_hash?(value) ? concatenation(target, keys, value) : jsonb_quote_value(value)}
+          )::jsonb
+        EOF
+      end
+
+      def multi_value_hash?(value)
+        value.is_a?(Hash) && value.keys.count > 1
+      end
+
+      def single_value_hash?(value)
+        value.is_a?(Hash) && value.keys.count == 1
+      end
+  end
+end

data/lib/atomic_json/query_methods.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'atomic_json/query'
+
+module AtomicJson
+  module QueryMethods
+
+    extend ActiveSupport::Concern
+
+    def json_update(input)
+      run_callbacks(:save) do
+        Query.new(self)
+          .build(input, touch: true)
+          .execute!
+        reload.validate
+      end
+    end
+
+    def json_update!(input)
+      run_callbacks(:save) do
+        Query.new(self)
+          .build(input, touch: true)
+          .execute!
+        reload.validate!
+      end
+    end
+
+    def json_update_columns(input)
+      Query.new(self)
+        .build(input)
+        .execute!
+    end
+
+  end
+end

data/lib/atomic_json/validations.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'atomic_json/errors'
+
+module AtomicJson
+  module Validations
+
+    def validate_record!(record)
+      raise ActiveRecordError, 'cannot update a new record' if record.new_record?
+      raise ActiveRecordError, 'cannot update a destroyed record' if record.destroyed?
+    end
+
+    def validate_attributes!(record, attributes)
+      raise TypeError, 'Payload to update must be a hash' unless attributes.is_a?(Hash)
+      attributes.each_key do |key|
+        raise ReadOnlyAttributeError, "#{key} is marked as readonly" if read_only_attribute?(record, key)
+        raise InvalidColumnTypeError, 'ActiveRecord column needs to be of type JSON or JSONB' unless valid_column_type?(record, key)
+      end
+    end
+
+    private
+
+      def read_only_attribute?(record, key)
+        record.class.readonly_attributes.include?(key.to_s)
+      end
+
+      def valid_column_type?(record, key)
+        %i[json jsonb].include?(record.type_for_attribute(key.to_s).type)
+      end
+  end
+end

data/lib/atomic_json/version.rb

@@ -0,0 +1,5 @@
+module AtomicJson
+
+  VERSION = '0.1.0'.freeze
+
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: atomic_json
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Antoine Macia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.1
+- !ruby/object:Gem::Dependency
+  name: standalone_migrations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.5
+description: ''
+email:
+- antoine@discolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- atomic_json.gemspec
+- bin/console
+- bin/setup
+- db/config.yml
+- db/migrate/20180715062407_create_mock_test_table.rb
+- db/schema.rb
+- lib/atomic_json.rb
+- lib/atomic_json/errors.rb
+- lib/atomic_json/json_query_helpers.rb
+- lib/atomic_json/query.rb
+- lib/atomic_json/query_builder.rb
+- lib/atomic_json/query_methods.rb
+- lib/atomic_json/validations.rb
+- lib/atomic_json/version.rb
+homepage: ''
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Atomic update of JSON/JSONB fields for ActiveRecord models
+test_files: []