associate_jsonb 0.0.4 → 0.0.10

data/lib/associate_jsonb/connection_adapters/schema_definitions/table.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module AssociateJsonb
+  module ConnectionAdapters
+    module Table
+      def constraint(**opts)
+        @base.add_constraint(name, **opts)
+      end
+    end
+  end
+end

data/lib/associate_jsonb/connection_adapters/schema_definitions/table_definition.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module AssociateJsonb
+  module ConnectionAdapters
+    module TableDefinition
+      attr_reader :constraints
+
+      def initialize(*,**)
+        super
+        @constraints = []
+      end
+
+      def constraint(name = nil, **opts)
+        unless opts[:value].present?
+          raise ArgumentError.new("Invalid Drop Constraint Options")
+        end
+
+        @constraints << ConstraintDefinition.new(
+          **opts.reverse_merge(name: name)
+        )
+      end
+    end
+  end
+end

data/lib/associate_jsonb/connection_adapters/schema_statements.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module AssociateJsonb
+  module ConnectionAdapters
+    module SchemaStatements
+      def add_jsonb_nested_set_function
+        execute schema_creation.accept(AddJsonbNestedSetFunction.new)
+      end
+
+      def add_jsonb_foreign_key_function
+        execute schema_creation.accept(AddJsonbForeignKeyFunction.new)
+      end
+
+      def create_table(table_name, **options)
+        td = create_table_definition(table_name, **options)
+
+        if options[:id] != false && !options[:as]
+          pk = options.fetch(:primary_key) do
+            ActiveRecord::Base.get_primary_key table_name.to_s.singularize
+          end
+
+          if pk.is_a?(Array)
+            td.primary_keys pk
+          else
+            td.primary_key pk, options.fetch(:id, :primary_key), **options.except(:comment)
+          end
+        end
+
+        yield td if block_given?
+
+        if options[:force]
+          drop_table(table_name, **options, if_exists: true)
+        end
+
+        result = execute schema_creation.accept td
+
+        td.indexes.each do |column_name, index_options|
+          add_index(table_name, column_name, index_options)
+        end
+
+        td.constraints.each do |ct|
+          add_constraint(table_name, **ct)
+        end
+
+        if table_comment = options[:comment].presence
+          change_table_comment(table_name, table_comment)
+        end
+
+        td.columns.each do |column|
+          change_column_comment(table_name, column.name, column.comment) if column.comment.present?
+        end
+
+        result
+      end
+
+      def add_constraint(table_name, **options)
+        at = create_alter_table table_name
+        at.add_constraint(**options)
+        execute schema_creation.accept at
+      end
+
+      def constraints(table_name) # :nodoc:
+        scope = quoted_scope(table_name)
+
+        result = query(<<~SQL, "SCHEMA")
+          SELECT
+            con.oid,
+            con.conname,
+            con.connamespace,
+            con.contype,
+            con.condeferrable,
+            con.condeferred,
+            con.convalidated,
+            pg_get_constraintdef(con.oid) as consrc
+          FROM pg_catalog.pg_constraint con
+          INNER JOIN pg_catalog.pg_class rel
+                     ON rel.oid = con.conrelid
+          INNER JOIN pg_catalog.pg_namespace nsp
+                     ON nsp.oid = connamespace
+          WHERE nsp.nspname = #{scope[:schema]}
+          AND rel.relname = #{scope[:name]}
+          ORDER BY rel.relname
+        SQL
+
+        result.map do |row|
+          {
+            oid: row[0],
+            name: row[1],
+            deferrable: row[4],
+            deferred: row[5],
+            validated: row[6],
+            definition: row[7],
+            type:
+              case row[3].to_s.downcase
+              when "c"
+                "CHECK"
+              when "f"
+                "FOREIGN KEY"
+              when "p"
+                "PRIMARY KEY"
+              when "u"
+                "UNIQUE"
+              when "t"
+                "TRIGGER"
+              when "x"
+                "EXCLUDE"
+              else
+                "UNKNOWN"
+              end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/associate_jsonb/persistence.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module AssociateJsonb
+  module Persistence
+    private
+      def _update_row(attribute_names, attempted_action = "update")
+        self.class._update_record(
+          attributes_with_info(attribute_names),
+          @primary_key => id_in_database
+        )
+      end
+  end
+end

data/lib/associate_jsonb/predicate_builder.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module AssociateJsonb
+  module PredicateBuilder # :nodoc:
+    def build_bind_attribute(column_name, value)
+      if value.respond_to?(:value_before_type_cast)
+        attr = ActiveRecord::Relation::QueryAttribute.new(column_name.to_s, value.value_before_type_cast, table.type(column_name), value)
+      else
+        attr = ActiveRecord::Relation::QueryAttribute.new(column_name.to_s, value, table.type(column_name))
+      end
+      Arel::Nodes::BindParam.new(attr)
+    end
+  end
+end

data/lib/associate_jsonb/reflection.rb

@@ -60,7 +60,7 @@ module AssociateJsonb
           Arel::Nodes::NamedFunction.new(
             "CAST",
             [
-              Arel::Nodes::Jsonb::DashArrow.
+              Arel::Nodes::Jsonb::DashDoubleArrow.
                 new(table, table[foreign_store_attr], foreign_store_key || key).
                 as(foreign_klass.columns_hash[foreign_key.to_s].sql_type)
             ]
@@ -83,7 +83,7 @@ module AssociateJsonb
           Arel::Nodes::NamedFunction.new(
             "CAST",
             [
-              Arel::Nodes::Jsonb::DashArrow.
+              Arel::Nodes::Jsonb::DashDoubleArrow.
                 new(foreign_table, foreign_table[jsonb_store_attr], jsonb_store_key || foreign_key).
                 as(klass.columns_hash[key.to_s].sql_type)
             ]

data/lib/associate_jsonb/relation/where_clause.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module AssociateJsonb
   module Relation
     module WhereClause

data/lib/associate_jsonb/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module AssociateJsonb
-  VERSION = "0.0.4"
+  VERSION = "0.0.10"
 end

data/lib/associate_jsonb/with_store_attribute.rb

@@ -34,7 +34,7 @@ module AssociateJsonb
     end
 
     included do
-      instance_eval <<-CODE, __FILE__, __LINE__ + 1
+      instance_eval <<~CODE, __FILE__, __LINE__ + 1
         initialize_store_column_attribute_tracker
 
         after_initialize &set_store_column_attribute_values_on_init
@@ -106,7 +106,7 @@ module AssociateJsonb
         array = attribute_opts[:array]
         attribute attr, cast_type, **attribute_opts
 
-        instance_eval <<-CODE, __FILE__, __LINE__ + 1
+        instance_eval <<~CODE, __FILE__, __LINE__ + 1
           add_store_column_attribute_name("#{attr}", :#{store}, "#{key}", { sql_type: sql_type, type: cast_type, opts: attribute_opts })
         CODE
 
@@ -117,44 +117,52 @@ module AssociateJsonb
     class InstanceMethodsOnActivation < Module
       def initialize(mixin, store, attribute, key, is_array)
         is_array = !!(is_array && attribute.to_s =~ /_ids$/)
-        on_attr_change =
-           is_array \
-            ? "write_attribute(:#{attribute}, Array(given))" \
-            : "super(given)"
-        on_store_change = ->(var) {
-          "write_attribute(:#{attribute}, #{
-            is_array \
-             ? "Array(#{var})" \
-             : var
-          })"
-        }
 
+        array_or_attr = ->(value) {
+          is_array \
+           ? %Q(Array(#{value})) \
+           : %Q(#{value})
+         }
+
+        on_store_change = "_write_attribute(:#{attribute}, #{array_or_attr.call %Q(#{store}["#{key}"])})"
+        on_attr_change = "super(#{array_or_attr.call %Q(given)})"
 
         if is_array
-          mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
+          mixin.class_eval <<~CODE, __FILE__, __LINE__ + 1
             def #{attribute}
               _read_attribute(:#{attribute}) || []
             end
           CODE
         end
 
-        mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
+        mixin.class_eval <<~CODE, __FILE__, __LINE__ + 1
           def #{store}=(given)
-            super(given || {})
-            write_attribute(:#{attribute}, #{on_store_change.call %Q(#{store}["#{key}"])})
-            if #{attribute}.blank?
-              #{store}.delete("#{key}")
+            if given.is_a?(::String)
+              given = ActiveSupport::JSON.decode(given) rescue nil
+            end
+
+            if AssociateJsonb.merge_hash?(self.class.attribute_types["#{store}"])
+              if !given
+                given = {}
+                #{store}.keys.each do |k|
+                  given[k] = nil
+                end
+              end
+              super(#{store}.deep_merge(given.deep_stringify_keys))
+
+              self.#{attribute}= #{store}["#{key}"] if #{store}.key?("#{key}")
             else
-              #{store}["#{key}"] = #{attribute}
+              super given || {}
+              self.#{attribute}= #{store}["#{key}"]
             end
+
             #{store}
           end
 
           def #{attribute}=(given)
             #{on_attr_change}
-            value = #{store}["#{key}"] = #{attribute}
-            #{store}.delete("#{key}") if value.nil?
-            _write_attribute(:#{store}, #{store})
+            value = #{store}["#{key}"] = #{attribute}.presence
+            #{store}.delete("#{key}") unless !value.nil? || AssociateJsonb.merge_hash?(self.class.attribute_types["#{store}"])
             value
           end
         CODE

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: associate_jsonb
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.10
 platform: ruby
 authors:
 - Sampson Crowley
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -96,22 +96,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
-description: |2
-      This gem extends ActiveRecord to let you use PostgreSQL JSONB data for associations
+        version: '3.9'
+description: |
+  This gem extends ActiveRecord to add additional functionality to JSONB
 
-      Inspired by activerecord-jsonb-associations, but for use in Rails 6+ and
-      ruby 2.7+ and with some unnecessary options and features (HABTM) removed
+  - use PostgreSQL JSONB data for associations
+  - thread-safe single-key updates to JSONB columns using `jsonb_set`
+  - extended `table#references` for easy migrations and indexes
+  - virtual JSONB foreign keys using check constraints
+    (NOTE: real foreign key constraints are not possible with PostgreSQL JSONB)
 
-      BONUS: extended `table#references` for easy migrations and indexes
-      (NOTE: real foreign key constraints are not possible with PostgreSQL JSONB)
+  Inspired by activerecord-jsonb-associations, but for use in Rails 6+ and
+  ruby 2.7+ and with some unnecessary options and features (HABTM) removed
+  and some additional features added
 email:
 - sampsonsprojects@gmail.com
 executables: []
@@ -125,6 +129,7 @@ files:
 - lib/associate_jsonb/arel_extensions/nodes/binary.rb
 - lib/associate_jsonb/arel_extensions/nodes/table_alias.rb
 - lib/associate_jsonb/arel_extensions/table.rb
+- lib/associate_jsonb/arel_extensions/visitors/postgresql.rb
 - lib/associate_jsonb/arel_extensions/visitors/visitor.rb
 - lib/associate_jsonb/arel_nodes/jsonb/at_arrow.rb
 - lib/associate_jsonb/arel_nodes/jsonb/attribute.rb
@@ -147,8 +152,20 @@ files:
 - lib/associate_jsonb/associations/has_many_association.rb
 - lib/associate_jsonb/associations/join_dependency.rb
 - lib/associate_jsonb/associations/preloader/association.rb
+- lib/associate_jsonb/attribute_methods.rb
+- lib/associate_jsonb/attribute_methods/read.rb
 - lib/associate_jsonb/connection_adapters.rb
-- lib/associate_jsonb/connection_adapters/reference_definition.rb
+- lib/associate_jsonb/connection_adapters/schema_creation.rb
+- lib/associate_jsonb/connection_adapters/schema_definitions/add_jsonb_foreign_key_function.rb
+- lib/associate_jsonb/connection_adapters/schema_definitions/add_jsonb_nested_set_function.rb
+- lib/associate_jsonb/connection_adapters/schema_definitions/alter_table.rb
+- lib/associate_jsonb/connection_adapters/schema_definitions/constraint_definition.rb
+- lib/associate_jsonb/connection_adapters/schema_definitions/reference_definition.rb
+- lib/associate_jsonb/connection_adapters/schema_definitions/table.rb
+- lib/associate_jsonb/connection_adapters/schema_definitions/table_definition.rb
+- lib/associate_jsonb/connection_adapters/schema_statements.rb
+- lib/associate_jsonb/persistence.rb
+- lib/associate_jsonb/predicate_builder.rb
 - lib/associate_jsonb/reflection.rb
 - lib/associate_jsonb/relation/where_clause.rb
 - lib/associate_jsonb/supported_rails_version.rb
@@ -173,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Store database references in PostgreSQL Jsonb columns

data/lib/associate_jsonb/connection_adapters/reference_definition.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module AssociateJsonb
-  module ConnectionAdapters
-    module ReferenceDefinition #:nodoc:
-      # rubocop:disable Metrics/ParameterLists
-      def initialize(
-        name,
-        store: false,
-        **options
-      )
-        @store = store && store.to_sym
-
-        super(name, **options)
-      end
-      # rubocop:enable Metrics/ParameterLists
-
-      def add_to(table)
-        return super unless store
-
-        should_add_col = false
-        if table.respond_to? :column_exists?
-          should_add_col = !table.column_exists?(store)
-        elsif table.respond_to? :columns
-          should_add_col = table.columns.none? {|col| col.name.to_sym == store}
-        end
-
-        table.column(store, :jsonb, null: false, default: {}) if should_add_col
-
-        return unless index
-
-        # should_add_idx = false
-        # if table.respond_to? :index_exists?
-        #   should_add_idx = !table.index_exists?([ store ], using: :gin)
-        # elsif table.respond_to? :indexes
-        #   should_add_idx = table.indexes.none? do |idx, opts|
-        #     (idx == [ store ]) \
-        #     && (opts == { using: :gin })
-        #   end
-        # end
-        #
-        # table.index([ store ], using: :gin) if should_add_idx
-
-        column_names.each do |column_name|
-          table.index(
-            "CAST (\"#{store}\"->'#{column_name}' AS #{@type || :bigint})",
-            using: :btree,
-            name: "index_#{table.name}_on_#{store}_#{column_name}"
-          )
-
-          table.index(
-            "(#{store}->>'#{column_name}')",
-            using: :btree,
-            name: "index_#{table.name}_on_#{store}_#{column_name}_text"
-          )
-        end
-      end
-
-      protected
-
-      attr_reader :store
-    end
-  end
-end