ar_doc_store 2.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5e0f3b286ab52eebdb032146c7bd7c368f76888221e3bdf1c01f3a7d088d5ef
-  data.tar.gz: 96e38a0850648b7eb8af1f7b1ebadc44c136b0633f0c33a398ab3e632d734f88
+  metadata.gz: 4b2fadd8bf7bb78682cabb980f852ecbe91eb65013138f63521542e9ed42c972
+  data.tar.gz: 8e12ab14feab7fbf3c2b922612911502c253971f50a555d77c39a2aeb07d3f03
 SHA512:
-  metadata.gz: 5d4cc8a28403eaf2f42277b1c5d1f2d702380c3a90b2dbce9a80aec55d02af3c716dcd15075eb513c8ac1d48f83db3a20e1006770d539eb81be16c2709f04b10
-  data.tar.gz: f7c4ab93d371cf71a7e8a29542e9a00a8a84d64910b9df8763ab56622531bcf5f4545f703c8755ec70bf18b49208ee1ac6996c93e7e44e54243fca8fd95bdecf
+  metadata.gz: fe6118c156f464c6f36dd5b011813648a95f6c23112c133b40f32ad47968d91d973cbcb9de7865c7b5ce61463be03de1bfa404c2feed11f1a1d0ecdb5e75eb4a
+  data.tar.gz: 3c9fc5af5db270403ee35c701e8557f76c94990bbd11372b41cd04df942de52fe2fb501bf47982b354aff3002207dc3a0856a3064fef996f197e82c08a1046c7

data/.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: '3.1'
+            rails: '~> 6.1.0'
+          - ruby: '3.1'
+            rails: '~> 7.0.0'
+          - ruby: '3.2'
+            rails: '~> 7.1.0'
+          - ruby: '3.2'
+            rails: '~> 7.2.0'
+          - ruby: '3.4'
+            rails: '~> 8.0.0'
+          - ruby: '3.4'
+            rails: '~> 8.1.0'
+          - ruby: '4.0'
+            rails: '~> 8.1.0'
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: ar_doc_store_test
+        ports: ['5432:5432']
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+      DATABASE_URL: postgresql://postgres:postgres@localhost/ar_doc_store_test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ar_doc_store.gemspec
 gemspec
+
+gem 'activerecord', ENV.fetch('RAILS_VERSION', '~> 8.1.0')

data/README.md

@@ -294,6 +294,28 @@ end
 
 ## Contributing
 
+### Running tests
+
+The development bundle defaults to Rails 8.1. The gem's runtime requirement
+remains Active Record 6.1 or newer. CI covers Rails 6.1, 7.0, 7.1, 7.2, 8.0,
+and 8.1 with compatible Ruby versions.
+
+Create a dedicated PostgreSQL database and run:
+
+```sh
+bundle install
+DATABASE_URL=postgresql://postgres:postgres@localhost/ar_doc_store_test bundle exec rake test
+```
+
+The tests recreate the `buildings` and `purchase_orders` tables. Always use a
+dedicated test database. To test a different Rails series, resolve the bundle
+with that version and use the same variable when running tests:
+
+```sh
+RAILS_VERSION='~> 7.2.0' bundle update
+RAILS_VERSION='~> 7.2.0' bundle exec rake test
+```
+
 1. Fork it ( https://github.com/dfurber/ar_doc_store/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/Rakefile

@@ -8,8 +8,11 @@ end
 
 namespace :test do
   task :prepare_ar_doc_store do
+    config = ENV.fetch('DATABASE_URL', 'postgresql://postgres:postgres@localhost/ar_doc_store_test')
+    require 'logger'
     require 'active_record'
-    ActiveRecord::Base.establish_connection(adapter: 'postgresql', database: 'ar_doc_store_test', username: 'postgres', password: 'postgres')
+    ActiveRecord::Tasks::DatabaseTasks.create(config)
+    ActiveRecord::Base.establish_connection(config)
 
     ActiveRecord::Schema.define do
       self.verbose = false
@@ -21,4 +24,4 @@ namespace :test do
       end
     end
   end
-end
+end

data/ar_doc_store.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activerecord", ">=6.1"
   spec.add_dependency "pg"
-  spec.add_development_dependency "bundler", "~> 2.2"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.2"
+  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "ransack"
 end

data/lib/ar_doc_store/attributes/base.rb

@@ -34,13 +34,6 @@ module ArDocStore
         options.merge!(default: default) if default.present?
         model.class_eval do
           attribute attribute_name, attribute_type.new, **options
-          # define_method "#{attribute_name}=".to_sym, -> (value) {
-          #   value = nil if value == '' || value == ['']
-          #   write_attribute attribute_name, value
-          #   # new_value = read_attribute attribute_name
-          #   # write_store_attribute(json_column, attribute_name, new_value)
-          #   attributes[attribute_name]
-          # }
         end
       end
 

data/lib/ar_doc_store/attributes/embeds_many.rb

@@ -93,6 +93,7 @@ module ArDocStore
 
     class AssignEmbedsManyAttributes
       attr_reader :models, :assn_name, :parent, :class_name
+
       def initialize(parent, class_name, assn_name, models, values)
         @parent, @class_name, @assn_name, @models, @values = parent, class_name, assn_name, models, values
         @models ||= ArDocStore::EmbeddedCollection.new
@@ -109,8 +110,8 @@ module ArDocStore
 
       private
 
-      attr_writer :models, :values
-      attr_reader :values, :assn_name
+      attr_accessor :values
+      attr_writer :models
 
       def process_existing_model(value)
         return false unless value.key?(:id)

data/lib/ar_doc_store/attributes/enumeration.rb

@@ -28,12 +28,21 @@ module ArDocStore
           define_singleton_method "#{key}_choices" do
             dictionary
           end
+          # if respond_to?(:ransacker)
+          #   ransacker key do |parent|
+          #     Arel.sql "#{parent.table[json_column].name}->'#{key}'"
+          #   end
+          # end
         end
       end
 
       def type
         :string
       end
+
+      def add_ransacker
+        raise 'hello'
+      end
     end
   end
 end

data/lib/ar_doc_store/embeddable_model.rb

@@ -22,8 +22,8 @@ module ArDocStore
         attr_accessor :parent
         attr_accessor :embedded_as
 
-        class_attribute :json_attributes
-        self.json_attributes = HashWithIndifferentAccess.new
+        # class_attribute :json_attributes
+        # self.json_attributes = HashWithIndifferentAccess.new
 
         json_attribute :id, :string #, default: -> { SecureRandom.uuid }
 
@@ -92,7 +92,7 @@ module ArDocStore
       end
 
       def write_attribute(attribute, value)
-        attributes[attribute.to_s] = value
+        @attributes.write_from_user(attribute.to_s, value)
       end
 
       def to_param

data/lib/ar_doc_store/embedding.rb

@@ -25,10 +25,8 @@ module ArDocStore
       # enabled records if they're marked_for_destruction? or destroyed.
       def embed_valid?(assn_name, record)
         unless valid = record.valid?
-          record.errors.each do |attribute, message|
-            attribute = "#{assn_name}.#{attribute}"
-            errors[attribute] << message
-            errors[attribute].uniq!
+          record.errors.each do |error|
+            errors.import(error, attribute: "#{assn_name}.#{error.attribute}")
           end
         end
         valid

data/lib/ar_doc_store/model.rb

@@ -8,6 +8,7 @@ module ArDocStore
       mod.send :include, InstanceMethods
       mod.after_initialize :assign_json_data
       mod.before_validation :save_json_data
+      mod.before_save :ensure_json_data_saved
       mod.before_save :mark_embeds_as_persisted
     end
 
@@ -28,6 +29,12 @@ module ArDocStore
         json_attributes.each do |key, value|
           write_store_attribute(json_column, key, read_attribute(key)) if changes.key?(key)
         end
+        @json_data_saved = true
+      end
+
+      def ensure_json_data_saved
+        save_json_data unless defined?(@json_data_saved)
+        @json_data_saved = nil
       end
 
       def mark_embeds_as_persisted

data/lib/ar_doc_store/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArDocStore
-  VERSION = "2.1.2"
+  VERSION = "2.1.4"
 end

data/test/attributes/array_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class ArrayAttributeTest < MiniTest::Test
+class ArrayAttributeTest < Minitest::Test
   
   def test_attribute_on_model_init
     architects = %W{Bob John Billy Bob}

data/test/attributes/boolean_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class BooleanAttributeTest < MiniTest::Test
+class BooleanAttributeTest < Minitest::Test
   
   def test_attribute_on_model_init
     b = Building.new finished: true

data/test/attributes/date_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class DateAttributeTest < MiniTest::Test
+class DateAttributeTest < Minitest::Test
 
   def test_attribute_on_model_init
     finished_on = Date.new(1984, 3, 6)

data/test/attributes/datetime_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class DatetimeAttributeTest < MiniTest::Test
+class DatetimeAttributeTest < Minitest::Test
 
   def test_attribute_on_model_init
     inspected_at = Time.new(1984, 3, 6)

data/test/attributes/decimal_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class DecimalAttributeTest < MiniTest::Test
+class DecimalAttributeTest < Minitest::Test
   
   def test_attribute_on_model_init
     b = Building.new cost: 5.42

data/test/attributes/embeds_many_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class EmbedsManyAttributeTest < MiniTest::Test
+class EmbedsManyAttributeTest < Minitest::Test
 
   def test_initialized_on_model_init
     r = Restroom.new name: 'Foo'

data/test/attributes/embeds_one_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class EmbedsOneAttributeTest < MiniTest::Test
+class EmbedsOneAttributeTest < Minitest::Test
 
   def test_initialized_on_model_init
     entrance = Entrance.new name: 'Foo'

data/test/attributes/enumeration_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class EnumerationAttributeTest < MiniTest::Test
+class EnumerationAttributeTest < Minitest::Test
   
   def test_simple_enumeration_attribute
     b = Building.new construction: 'wood'

data/test/attributes/float_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class FloatAttributeTest < MiniTest::Test
+class FloatAttributeTest < Minitest::Test
   
   def test_attribute_on_model_init
     b = Building.new height: 5.42

data/test/attributes/integer_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class IntegerAttributeTest < MiniTest::Test
+class IntegerAttributeTest < Minitest::Test
   
   def test_string_attribute_on_model_init
     b = Building.new stories: 5

data/test/attributes/string_attribute_test.rb

@@ -1,6 +1,6 @@
 require_relative './../test_helper'
 
-class StringAttributeTest < MiniTest::Test
+class StringAttributeTest < Minitest::Test
   
   def test_attribute_on_model_init
     b = Building.new name: 'test'

data/test/model_test.rb

@@ -0,0 +1,31 @@
+require_relative './test_helper'
+
+class ModelTest < Minitest::Test
+  def test_save_with_validation
+    b = Building.new name: 'test'
+    assert b.save
+    b.reload
+    assert_equal 'test', b.name
+  end
+
+  def test_save_without_validation
+    b = Building.new name: 'test'
+    assert b.save(validate: false)
+    b.reload
+    assert_equal 'test', b.name
+  end
+
+  def test_ransack_finds_string
+    Building.create name: 'test'
+    search = Building.ransack(name_eq: 'test').result
+    assert search.size > 0
+  end
+
+  def test_ransack_finds_array
+    Building.create multiconstruction: %w[brick wood]
+    # search = Building.construction_in(['brick'])
+    search = Building.ransack(multiconstruction_jin: ['brick', 'wood']).result
+    puts search.to_sql
+    assert search.size > 0
+  end
+end

data/test/rails_compatibility_test.rb

@@ -0,0 +1,66 @@
+require_relative 'test_helper'
+
+class CompatibilityLeaf
+  include ArDocStore::EmbeddableModel
+  json_attribute :name, :string
+  validates :name, presence: true
+end
+
+class CompatibilityBranch
+  include ArDocStore::EmbeddableModel
+  embeds_one :leaf, class_name: 'CompatibilityLeaf'
+  embeds_many :items, class_name: 'CompatibilityLeaf'
+end
+
+class CompatibilityDocument < ActiveRecord::Base
+  self.table_name = 'buildings'
+  include ArDocStore::Model
+  embeds_one :branch, class_name: 'CompatibilityBranch'
+  embeds_many :items, class_name: 'CompatibilityLeaf'
+end
+
+class RailsCompatibilityTest < Minitest::Test
+  def test_invalid_nested_child_prevents_save_and_preserves_error_details
+    document = CompatibilityDocument.new
+    document.build_branch.build_leaf
+
+    refute document.save
+    assert document.new_record?
+    assert_equal ["can't be blank"], document.errors[:'branch.leaf.name']
+    assert_equal [{ error: :blank }], document.errors.details[:'branch.leaf.name']
+    refute document.valid?
+    assert_equal 1, document.errors.size
+  end
+
+  def test_invalid_collection_child_prevents_save
+    document = CompatibilityDocument.new
+    document.build_item
+
+    refute document.save
+    assert_equal ["can't be blank"], document.errors[:'items.name']
+  end
+
+  def test_nested_one_and_many_survive_save_reload_and_updates
+    document = CompatibilityDocument.new
+    branch = document.build_branch
+    branch.build_leaf(name: 'one')
+    branch.items = [{ name: 'many' }]
+    document.save!
+    document.reload
+
+    assert_equal 'one', document.branch.leaf.name
+    assert_equal 'many', document.branch.items.first.name
+    assert document.branch.leaf.persisted?
+    assert document.branch.items.first.persisted?
+    refute document.branch.leaf.name_changed?
+    assert_same document.branch, document.branch.leaf.parent
+    assert_same document.branch, document.branch.items.parent
+
+    document.branch.leaf.name = 'updated one'
+    document.branch.items.first.name = 'updated many'
+    document.save!
+    document.reload
+    assert_equal 'updated one', document.branch.leaf.name
+    assert_equal 'updated many', document.branch.items.first.name
+  end
+end

data/test/test_helper.rb

@@ -1,27 +1,76 @@
 gem 'activerecord'
-gem 'minitest'
+gem 'minitest', '~> 5.0'
+gem 'ransack'
 
 require 'minitest/autorun'
+require 'logger'
 require 'active_record'
+require 'ransack'
 
 require_relative './../lib/ar_doc_store'
-ActiveRecord::Base.establish_connection(adapter: 'postgresql', database: 'ar_doc_store_test', username: 'postgres', password: 'postgres')
+ActiveRecord::Base.establish_connection(ENV.fetch('DATABASE_URL', 'postgresql://postgres:postgres@localhost/ar_doc_store_test'))
 
 require 'active_record/migration'
 
-ActiveRecord::Migration[4.2].execute "DROP TABLE IF EXISTS purchase_orders"
-ActiveRecord::Migration.execute "DROP TABLE IF EXISTS buildings"
-ActiveRecord::Migration.create_table :buildings do |t|
-  t.jsonb :data
-end
-ActiveRecord::Migration.create_table :purchase_orders do |t|
-  t.jsonb :data
-  t.belongs_to :building, index: true, foreign_key: true
+ActiveRecord::Schema.define do
+  drop_table :purchase_orders, if_exists: true
+  drop_table :buildings, if_exists: true
+  create_table :buildings do |t|
+    t.jsonb :data
+  end
+  create_table :purchase_orders do |t|
+    t.jsonb :data
+    t.belongs_to :building, index: true, foreign_key: true
+  end
 end
 
 # require 'simplecov'
 # SimpleCov.start
 
+# module Arel
+#   module Nodes
+#     class Contains < Arel::Nodes::InfixOperation
+#       def initialize(left, right)
+#         super(:'@>', left, right)
+#       end
+#     end
+#   end
+#
+#   module Visitors
+#     class PostgreSQL < Arel::Visitors::ToSql
+#       alias_method :visit_Arel_Nodes_Contains, :visit_Arel_Nodes_InfixOperation
+#     end
+#   end
+# end
+
+#
+# module ActiveRecord
+#   module QueryMethods
+#     def contains(predicates)
+#       predicates.map do |column, predicate|
+#         column = table[column]
+#         predicate = column.type_cast_for_database(predicate)
+#         predicate = Arel::Nodes.build_quoted(predicate)
+#
+#         where Arel::Nodes::Contains.new(column, predicate)
+#       end
+#     end
+#   end
+#
+#   module Querying
+#     delegate :contains, to: :all
+#   end
+# end
+
+# Ransack.configure do |config|
+#   # config.add_predicate 'jin', arel_predicate: 'contains', formatter: proc { |v| Arel.sql(v.to_json).gsub(/^"|"$/, "'") }
+#   config.add_predicate 'jin', arel_predicate: 'contains', formatter: proc { |v|
+#     value = Arel.sql(v.to_json).gsub(/^"|"$/, "'")
+#     puts value
+#     value
+#   }
+# end
+
 class Route
   include ArDocStore::EmbeddableModel
   json_attribute :is_route_unobstructed, as: :boolean
@@ -75,5 +124,20 @@ class Building < ActiveRecord::Base
   embeds_many :restrooms
 
   validates :stories, numericality: { allow_nil: true }
-end
 
+  scope :multiconstruction_jin, -> (*values) {
+    where("data->'multiconstruction' @> ?", values.to_json)
+  }
+  def self.ransackable_scopes(_auth_object = nil)
+    %i[multiconstruction_jin]
+  end
+
+  def self.ransackable_attributes(_auth_object = nil)
+    %w[name]
+  end
+
+  def self.ransackable_associations(_auth_object = nil)
+    []
+  end
+
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ar_doc_store
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.4
 platform: ruby
 authors:
 - David Furber
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,33 +38,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '12.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '12.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +79,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ransack
+  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: 'Provides an easy way to do something that is possible in Rails but still
   a bit close to the metal using store_accessor: create typecasted, persistent attributes
   that are not columns in the database but stored in the JSON "data" column. Also
@@ -90,6 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -130,12 +144,13 @@ files:
 - test/attributes/float_attribute_test.rb
 - test/attributes/integer_attribute_test.rb
 - test/attributes/string_attribute_test.rb
+- test/model_test.rb
+- test/rails_compatibility_test.rb
 - test/test_helper.rb
 homepage: https://github.com/dfurber/ar_doc_store
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A document storage gem meant for ActiveRecord PostgresQL JSON storage.
 test_files:
@@ -166,4 +180,6 @@ test_files:
 - test/attributes/float_attribute_test.rb
 - test/attributes/integer_attribute_test.rb
 - test/attributes/string_attribute_test.rb
+- test/model_test.rb
+- test/rails_compatibility_test.rb
 - test/test_helper.rb