jsonb_accessor 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b446e2b5fcf294a928c055c00334951830d068f7161437ec8fcab443cf2cee5
-  data.tar.gz: 443355750846f163a89307f662cd06d5034b5b922e7305209e8101b879f75b3e
+  metadata.gz: f098f30fabf2c5bbbe39acaecc6487c84516837bb8f55ff1ecfcde0bdda24e2f
+  data.tar.gz: 9dd89e98ec2937007ca3a11794ad3c0b3d48f8510a8f2836e0a1276b9ba8d5e0
 SHA512:
-  metadata.gz: 98019ca7f52229b5ca88a11b29ece4919bdd308a4c101dbc3a1b53ffa9d783ab90d9c09219be7ff7de37641a4545593851ed60da69cfc57dd53dfe6b7ee04238
-  data.tar.gz: 0e7b87df70bc3fdd71f4e384857970863b89bf60931c623b15b0983e554875cc1581672977bb274f0104fb393052d81447e05db4759826f83255d8cf03f355bd
+  metadata.gz: 2f7ca35afa36d13d4907b7e81ccf9c380c9eba36d7a18c6b6a10a1dcc6e423096fd39ab7c69ef372d9a217a01f31530b271e2f5a72ed482be1faa4dcc43806ea
+  data.tar.gz: 7389bebb7a9f7d6d4fcbde9cecc339f8505ae5cda68a6dbdd0489f10bcb1172919c9bd60d8bddee9be9a1053867ba99eefafce0be7cbf0022a151f9207fac069

data/.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: ['**']
+
+jobs:
+  tests:
+    services:
+      db:
+        image: postgres:9.4
+        env:
+          POSTGRES_HOST_AUTH_METHOD: trust
+          POSTGRES_DB: jsonb_accessor
+        ports: ['5432:5432']
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - gemfile: activerecord_5.0.0
+            ruby: 2.4.5
+
+          - gemfile: activerecord_5.1.0
+            ruby: 2.4.5
+
+          - gemfile: activerecord_5.0.0
+            ruby: 2.5.3
+
+          - gemfile: activerecord_5.1.0
+            ruby: 2.5.3
+
+          - gemfile: activerecord_6.1.0
+            ruby: 2.5.3
+
+          - gemfile: activerecord_5.0.0
+            ruby: 2.6.1
+
+          - gemfile: activerecord_5.1.0
+            ruby: 2.6.1
+
+          - gemfile: activerecord_6.1.0
+            ruby: 2.6.1
+
+          - gemfile: activerecord_5.0.0
+            ruby: 2.7.2
+
+          - gemfile: activerecord_5.1.0
+            ruby: 2.7.2
+
+          - gemfile: activerecord_6.1.0
+            ruby: 2.7.2
+
+          - gemfile: activerecord_7.0.1
+            ruby: 2.7.2
+
+          - gemfile: activerecord_6.1.0
+            ruby: 3.0.0
+
+          - gemfile: activerecord_7.0.1
+            ruby: 3.0.0
+
+          - gemfile: activerecord_7.0.1
+            ruby: 3.1.0
+
+    name: ${{ matrix.gemfile }}, ruby ${{ matrix.ruby }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Bundle install
+      run: |
+        bundle config set gemfile "${GITHUB_WORKSPACE}/gemfiles/${{ matrix.gemfile }}.gemfile"
+        bundle install --jobs 4 --retry 3
+
+    - name: Setup DB
+      run: |
+        bundle exec rake db:create db:schema:load
+
+    - name: Run tests
+      run: |
+        bundle exec rake spec

data/.rubocop.yml

@@ -30,8 +30,6 @@ Metrics/PerceivedComplexity:
   Enabled: false
 Metrics/BlockLength:
   Enabled: false
-Security/YAMLLoad:
-  Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
 Style/ClassVars:
@@ -60,3 +58,5 @@ Naming/VariableNumber:
   Enabled: false
 Gemspec/RequiredRubyVersion:
   Enabled: false
+Gemspec/RequireMFA:
+  Enabled: false

data/Appraisals

@@ -11,3 +11,7 @@ end
 appraise "activerecord-6.1.0" do
   gem "activerecord", "~> 6.1"
 end
+
+appraise "activerecord-7.0.1" do
+  gem "activerecord", "~> 7.0.1"
+end

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+## [Unreleased]
+
+## [1.3.3] - 2022-01-29
+### Fixed
+
+- Bug fix: DateTime objects are now correctly written without timezone
+information [#137](https://github.com/madeintandem/jsonb_accessor/pull/137).
+Thanks @caiohsramos

data/README.md

@@ -2,7 +2,7 @@
 
 Created by &nbsp;&nbsp;&nbsp; [<img src="https://raw.githubusercontent.com/madeintandem/jsonb_accessor/master/tandem-logo.png" alt="Tandem Logo" />](https://www.madeintandem.com/)
 
-[![Gem Version](https://badge.fury.io/rb/jsonb_accessor.svg)](http://badge.fury.io/rb/jsonb_accessor) &nbsp;&nbsp;&nbsp;[![Build Status](https://travis-ci.org/madeintandem/jsonb_accessor.svg)](https://travis-ci.org/madeintandem/jsonb_accessor) <img src="https://raw.githubusercontent.com/madeintandem/jsonb_accessor/master/json-bee.png" alt="JSONb Accessor Logo" align="right" />
+[![Gem Version](https://badge.fury.io/rb/jsonb_accessor.svg)](http://badge.fury.io/rb/jsonb_accessor) &nbsp;&nbsp;&nbsp;![CI](https://github.com/madeintandem/jsonb_accessor/actions/workflows/ci.yml/badge.svg) <img src="https://raw.githubusercontent.com/madeintandem/jsonb_accessor/master/json-bee.png" alt="JSONb Accessor Logo" align="right" />
 
 Adds typed `jsonb` backed fields as first class citizens to your `ActiveRecord` models. This gem is similar in spirit to [HstoreAccessor](https://github.com/madeintandem/hstore_accessor), but the `jsonb` column in PostgreSQL has a few distinct advantages, mostly around nested documents and support for collections.
 

data/Rakefile

@@ -19,7 +19,7 @@ root = File.expand_path __dir__
 db_dir = File.join(root, "db")
 DatabaseTasks.root = root
 DatabaseTasks.db_dir = db_dir
-DatabaseTasks.database_configuration = YAML.load(ERB.new(File.read(File.join(db_dir, "config.yml"))).result)
+DatabaseTasks.database_configuration = YAML.safe_load(ERB.new(File.read(File.join(db_dir, "config.yml"))).result, aliases: true)
 DatabaseTasks.migrations_paths = [File.join(db_dir, "migrate")]
 DatabaseTasks.env = "test"
 

data/bin/console

@@ -6,7 +6,7 @@ require "jsonb_accessor"
 require "rspec"
 require File.expand_path("../spec/spec_helper.rb", __dir__)
 
-dbconfig = YAML.load(File.open("db/config.yml"))
+dbconfig = YAML.safe_load(ERB.new(File.read(File.join("db", "config.yml"))).result, aliases: true)
 ActiveRecord::Base.establish_connection(dbconfig["development"])
 
 # rubocop:disable Lint/UselessAssignment

data/docker-compose.yml

@@ -13,6 +13,7 @@ services:
     depends_on:
       - postgres
 
+
   postgres:
     image: postgres:12
     environment:
@@ -21,6 +22,8 @@ services:
       - PGDATA=/var/lib/postgresql/data/pgdata
     volumes:                                                                                    
       - pg_data:/var/lib/postgresql/data/pgdata
+    ports:
+      - 5432:5432
 
 volumes:                                                                                        
   pg_data:

data/gemfiles/activerecord_7.0.1.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pg"
+gem "activerecord", "~> 7.0.1"
+
+gemspec path: "../"

data/jsonb_accessor.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-doc"
   spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "psych", "~> 3"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.6.0"
   spec.add_development_dependency "rubocop", "~> 1"

data/lib/jsonb_accessor/attribute_query_methods.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module JsonbAccessor
+  class AttributeQueryMethods
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def define(store_key_mapping_method_name, jsonb_attribute)
+      return if klass.superclass.respond_to? store_key_mapping_method_name
+
+      # <jsonb_attribute>_where scope
+      klass.define_singleton_method "#{jsonb_attribute}_where" do |attributes|
+        store_key_attributes = ::JsonbAccessor::QueryHelper.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
+        jsonb_where(jsonb_attribute, store_key_attributes)
+      end
+
+      # <jsonb_attribute>_where_not scope
+      klass.define_singleton_method "#{jsonb_attribute}_where_not" do |attributes|
+        store_key_attributes = ::JsonbAccessor::QueryHelper.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
+        jsonb_where_not(jsonb_attribute, store_key_attributes)
+      end
+
+      # <jsonb_attribute>_order scope
+      klass.define_singleton_method "#{jsonb_attribute}_order" do |*args|
+        ordering_options = args.extract_options!
+        order_by_defaults = args.each_with_object({}) { |attribute, config| config[attribute] = :asc }
+        store_key_mapping = all.model.public_send(store_key_mapping_method_name)
+
+        order_by_defaults.merge(ordering_options).reduce(all) do |query, (name, direction)|
+          key = store_key_mapping[name.to_s]
+          order_query = jsonb_order(jsonb_attribute, key, direction)
+          query.merge(order_query)
+        end
+      end
+    end
+
+    private
+
+    attr_reader :klass
+  end
+end

data/lib/jsonb_accessor/helpers.rb

@@ -0,0 +1,9 @@
+module JsonbAccessor
+  module Helpers
+    module_function
+
+    def active_record_default_timezone
+      ActiveRecord.try(:default_timezone) || ActiveRecord::Base.default_timezone
+    end
+  end
+end

data/lib/jsonb_accessor/macro.rb

@@ -65,7 +65,14 @@ module JsonbAccessor
           names_and_store_keys.each do |name, store_key|
             define_method("#{name}=") do |value|
               super(value)
-              new_values = (public_send(jsonb_attribute) || {}).merge(store_key => public_send(name))
+
+              attribute_value = public_send(name)
+              # Rails always saves time based on `default_timezone`. Since #as_json considers timezone, manual conversion is needed
+              if attribute_value.acts_like?(:time)
+                attribute_value = (::JsonbAccessor::Helpers.active_record_default_timezone == :utc ? attribute_value.utc : attribute_value.in_time_zone).strftime("%F %R:%S.%L")
+              end
+
+              new_values = (public_send(jsonb_attribute) || {}).merge(store_key => attribute_value)
               write_attribute(jsonb_attribute, new_values)
             end
           end
@@ -74,21 +81,20 @@ module JsonbAccessor
           define_method("#{jsonb_attribute}=") do |value|
             value ||= {}
             names_to_store_keys = self.class.public_send(store_key_mapping_method_name)
-            store_keys_to_names = names_to_store_keys.invert
 
             # this is the raw hash we want to save in the jsonb_attribute
-            value_with_store_keys = value.transform_keys do |k|
-              names_to_store_keys[k.to_s] || k
-            end
+            value_with_store_keys = ::JsonbAccessor::QueryHelper.convert_keys_to_store_keys(value, names_to_store_keys)
             write_attribute(jsonb_attribute, value_with_store_keys)
 
             # this maps attributes to values
-            value_with_named_keys = value.transform_keys do |k|
-              store_keys_to_names[k.to_s] || k
-            end
+            value_with_named_keys = ::JsonbAccessor::QueryHelper.convert_store_keys_to_keys(value, names_to_store_keys)
 
             empty_named_attributes = names_to_store_keys.transform_values { nil }
             empty_named_attributes.merge(value_with_named_keys).each do |name, attribute_value|
+              # Undefined keys: There might be things in the JSON that haven't been defined using jsonb_accessor
+              # It should still be possible to save arbitrary data in the JSON
+              next unless has_attribute? name
+
               write_attribute(name, attribute_value)
             end
           end
@@ -97,42 +103,19 @@ module JsonbAccessor
 
         # Makes sure new objects have the appropriate values in their jsonb fields.
         after_initialize do
-          if has_attribute?(jsonb_attribute)
-            jsonb_values = public_send(jsonb_attribute) || {}
-            jsonb_values.each do |store_key, value|
-              name = names_and_store_keys.key(store_key)
-              next unless name
-
-              write_attribute(name, value)
-              clear_attribute_change(name) if persisted?
-            end
+          next unless jsonb_attribute
+
+          jsonb_values = public_send(jsonb_attribute) || {}
+          jsonb_values.each do |store_key, value|
+            name = names_and_store_keys.key(store_key)
+            next unless name
+
+            write_attribute(name, value)
+            clear_attribute_change(name) if persisted?
           end
         end
 
-        # <jsonb_attribute>_where scope
-        scope("#{jsonb_attribute}_where", lambda do |attributes|
-          store_key_attributes = ::JsonbAccessor::QueryHelper.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
-          jsonb_where(jsonb_attribute, store_key_attributes)
-        end)
-
-        # <jsonb_attribute>_where_not scope
-        scope("#{jsonb_attribute}_where_not", lambda do |attributes|
-          store_key_attributes = ::JsonbAccessor::QueryHelper.convert_keys_to_store_keys(attributes, all.model.public_send(store_key_mapping_method_name))
-          jsonb_where_not(jsonb_attribute, store_key_attributes)
-        end)
-
-        # <jsonb_attribute>_order scope
-        scope("#{jsonb_attribute}_order", lambda do |*args|
-          ordering_options = args.extract_options!
-          order_by_defaults = args.each_with_object({}) { |attribute, config| config[attribute] = :asc }
-          store_key_mapping = all.model.public_send(store_key_mapping_method_name)
-
-          order_by_defaults.merge(ordering_options).reduce(all) do |query, (name, direction)|
-            key = store_key_mapping[name.to_s]
-            order_query = jsonb_order(jsonb_attribute, key, direction)
-            query.merge(order_query)
-          end
-        end)
+        ::JsonbAccessor::AttributeQueryMethods.new(self).define(store_key_mapping_method_name, jsonb_attribute)
       end
     end
   end

data/lib/jsonb_accessor/query_helper.rb

@@ -57,13 +57,18 @@ module JsonbAccessor
         raise InvalidDirection, "`#{option}` is not a valid direction for ordering, only `asc` and `desc` are accepted" if ORDER_DIRECTIONS.exclude?(option)
       end
 
+      # Replaces all keys in `attributes` that have a defined store_key with the store_key
       def convert_keys_to_store_keys(attributes, store_key_mapping)
-        attributes.each_with_object({}) do |(name, value), new_attributes|
-          store_key = store_key_mapping[name.to_s]
-          new_attributes[store_key] = value
+        attributes.stringify_keys.transform_keys do |key|
+          store_key_mapping[key] || key
         end
       end
 
+      # Replaces all keys in `attributes` that have a defined store_key with the named key (alias)
+      def convert_store_keys_to_keys(attributes, store_key_mapping)
+        convert_keys_to_store_keys(attributes, store_key_mapping.invert)
+      end
+
       def number_query_arguments?(arg)
         arg.is_a?(Hash) && arg.keys.map(&:to_s).all? { |key| NUMBER_OPERATORS.include?(key) }
       end

data/lib/jsonb_accessor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonbAccessor
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

data/lib/jsonb_accessor.rb

@@ -5,9 +5,11 @@ require "active_record"
 require "active_record/connection_adapters/postgresql_adapter"
 
 require "jsonb_accessor/version"
+require "jsonb_accessor/helpers"
 require "jsonb_accessor/macro"
 require "jsonb_accessor/query_helper"
 require "jsonb_accessor/query_builder"
+require "jsonb_accessor/attribute_query_methods"
 
 module JsonbAccessor
   extend ActiveSupport::Concern

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonb_accessor
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Michael Crismali
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2022-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -138,6 +138,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -189,12 +203,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -211,8 +226,11 @@ files:
 - gemfiles/activerecord_5.0.0.gemfile
 - gemfiles/activerecord_5.1.0.gemfile
 - gemfiles/activerecord_6.1.0.gemfile
+- gemfiles/activerecord_7.0.1.gemfile
 - jsonb_accessor.gemspec
 - lib/jsonb_accessor.rb
+- lib/jsonb_accessor/attribute_query_methods.rb
+- lib/jsonb_accessor/helpers.rb
 - lib/jsonb_accessor/macro.rb
 - lib/jsonb_accessor/query_builder.rb
 - lib/jsonb_accessor/query_helper.rb

data/.travis.yml

@@ -1,30 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.5
-  - 2.5.3
-  - 2.6.1
-  - 2.7.2
-  - 3.0.0
-addons:
-  postgresql: "9.4"
-before_install:
-  - gem update --system
-  - gem --version
-  - gem install bundler:2.1.4
-before_script:
-  - bundle exec rake db:create
-  - bundle exec rake db:migrate
-install: bundle _2.1.4_ install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}
-cache: bundler
-gemfile:
-  - gemfiles/activerecord_5.0.0.gemfile
-  - gemfiles/activerecord_5.1.0.gemfile
-  - gemfiles/activerecord_6.1.0.gemfile
-jobs:
-  exclude:
-    - rvm: 2.4.5
-      gemfile: gemfiles/activerecord_6.1.0.gemfile
-    - rvm: 3.0.0
-      gemfile: gemfiles/activerecord_5.0.0.gemfile
-    - rvm: 3.0.0
-      gemfile: gemfiles/activerecord_5.1.0.gemfile