jsonb_accessor 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12a9ef2a6ecf012dd86338b0962ea0338ac8950f
-  data.tar.gz: ffb75c6ce59fa8eeb1a6917c822853f0aa63cead
+SHA256:
+  metadata.gz: e0206aa16a6170326c1c5683a894715d6466cce4fb4b53f0bbd4326619608aed
+  data.tar.gz: e806fe994b60d0e9a4f8d46bda8df39a44266292010f2b4706bd2be3dfe46d44
 SHA512:
-  metadata.gz: ddb76f1639699f471680602e9d3f7601eca9666e7c3c03d2f3dce80d8e810a22940712668e0190f2469bccb54f9ae10a7f0b2fb7e763ea8818da32c34893ea91
-  data.tar.gz: 11e77edee1f60874eb313da3301483beb5cc4a962ad14b8f202e923511a1378a10b664fcb00fb4eae161e06f73b4f3c20878871753a693cc5fd733665a0dd2c4
+  metadata.gz: 443182674b5fd917ea91c8a7813756e43b85678343833845db054a4814ccbb9e20598794c2ee44ad44715258a5e957a1fe2cbcdbf2758b2a01200adf266c7381
+  data.tar.gz: 7f604bebd874c410c78e554c4e724f18d0c816fe035ebc1d8e470cede3d8d3497f9443a4a25a4d611f0395eb5215063e211aada8ef9d8df8e4ee7502b352eb81

data/.rubocop.yml

@@ -1,11 +1,16 @@
 AllCops:
-  Include:
-    - "**/Rakefile"
+  NewCops: enable
+  TargetRubyVersion: 2.7.2
+  SuggestExtensions: false
   Exclude:
-    - db/**/*
-    - gemfiles/**/*
-    - vendor/**/*
-Style/SpaceBeforeFirstArg:
+    - "db/**/*"
+    - "gemfiles/**/*"
+    - "vendor/**/*"
+Layout/SpaceBeforeFirstArg:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Layout/SpaceAroundEqualsInParameterDefault:
   Enabled: false
 Lint/UnusedBlockArgument:
   Enabled: false
@@ -17,8 +22,6 @@ Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
   Enabled: false
-Metrics/LineLength:
-  Enabled: false
 Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:
@@ -29,8 +32,6 @@ Metrics/BlockLength:
   Enabled: false
 Security/YAMLLoad:
   Enabled: false
-Style/AlignParameters:
-  Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
 Style/ClassVars:
@@ -39,25 +40,23 @@ Style/Documentation:
   Enabled: false
 Style/DoubleNegation:
   Enabled: false
-Style/FileName:
+Naming/FileName:
   Enabled: false
 Style/GuardClause:
   Enabled: false
-Style/IndentHash:
-  Enabled: false
 Style/NilComparison:
   Enabled: false
-Style/OpMethod:
-  Enabled: false
 Style/RescueModifier:
   Enabled: false
 Style/SignalException:
   Enabled: false
 Style/SingleLineMethods:
   Enabled: false
-Style/SpaceAroundEqualsInParameterDefault:
-  Enabled: false
 Style/StringLiterals:
   EnforcedStyle: double_quotes
-Performance/EndWith:
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+Naming/VariableNumber:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.7.2

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.3.8
   - 2.4.5
   - 2.5.3
   - 2.6.1
@@ -23,8 +22,6 @@ gemfile:
   - gemfiles/activerecord_6.1.0.gemfile
 jobs:
   exclude:
-    - rvm: 2.3.8
-      gemfile: gemfiles/activerecord_6.1.0.gemfile
     - rvm: 2.4.5
       gemfile: gemfiles/activerecord_6.1.0.gemfile
     - rvm: 3.0.0

data/Dockerfile

@@ -0,0 +1,12 @@
+ARG RUBY_VERSION=latest
+FROM ruby:${RUBY_VERSION}
+
+WORKDIR /usr/src/app
+
+RUN mkdir -p lib/jsonb_accessor
+COPY lib/jsonb_accessor/version.rb ./lib/jsonb_accessor/
+COPY *.gemspec Gemfile* ./
+
+RUN bundle install
+
+COPY . .

data/README.md

@@ -10,15 +10,15 @@ It also adds generic scopes for querying `jsonb` columns.
 
 ## Table of Contents
 
-* [Installation](#installation)
-* [Usage](#usage)
-* [Scopes](#scopes)
-* [Single-Table Inheritance](#single-table-inheritance)
-* [Dependencies](#dependencies)
-* [Validations](#validations)
-* [Upgrading](#upgrading)
-* [Development](#development)
-* [Contributing](#contributing)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Scopes](#scopes)
+- [Single-Table Inheritance](#single-table-inheritance)
+- [Dependencies](#dependencies)
+- [Validations](#validations)
+- [Upgrading](#upgrading)
+- [Development](#development)
+- [Contributing](#contributing)
 
 ## Installation
 
@@ -158,6 +158,7 @@ Product.all.jsonb_where(:data, reviewed_at: { before: Time.current }, p: { great
 
 Product.all.data_where(reviewed_at: { before: Time.current }, price: { greater_than: 5 })
 ```
+
 This scope makes use of the `jsonb_contains`, `jsonb_number_where`, and `jsonb_time_where` `scope`s.
 
 ### `jsonb_where_not`
@@ -219,14 +220,14 @@ Product.all.jsonb_number_where(:data, :price_in_cents, :greater_than, 300)
 
 It supports:
 
-* `>`
-* `>=`
-* `greater_than`
-* `greater_than_or_equal_to`
-* `<`
-* `<=`
-* `less_than`
-* `less_than_or_equal_to`
+- `>`
+- `>=`
+- `greater_than`
+- `greater_than_or_equal_to`
+- `<`
+- `<=`
+- `less_than`
+- `less_than_or_equal_to`
 
 and it is indifferent to strings/symbols.
 
@@ -259,9 +260,9 @@ Product.all.jsonb_time_where_not(:data, :reviewed_at, :before, 2.days.ago)
 ## Single-Table Inheritance
 
 One of the big issues with `ActiveRecord` single-table inheritance (STI)
-is sparse columns.  Essentially, as sub-types of the original table
+is sparse columns. Essentially, as sub-types of the original table
 diverge further from their parent more columns are left empty in a given
-table.  Postgres' `jsonb` type provides part of the solution in that
+table. Postgres' `jsonb` type provides part of the solution in that
 the values in an `jsonb` column does not impose a structure - different
 rows can have different values.
 
@@ -305,7 +306,7 @@ end
 ```
 
 From here any attributes specific to any sub-class can be stored in the
-`jsonb` column avoiding sparse data.  Indices can also be created on
+`jsonb` column avoiding sparse data. Indices can also be created on
 individual fields in an `jsonb` column.
 
 This approach was originally conceived by Joe Hirn in [this blog
@@ -326,12 +327,24 @@ See the [upgrade guide](UPGRADE_GUIDE.md).
 
 ## Development
 
+### On your local machine
+
 After checking out the repo, run `bin/setup` to install dependencies (make sure postgres is running first).
 
 Run `bin/console` for an interactive prompt that will allow you to experiment.
 
 `rake` will run Rubocop and the specs.
 
+### With Docker
+
+```
+# setup
+docker-compose build
+docker-compose run ruby rake db:migrate
+# run test suite
+docker-compose run ruby rake spec
+```
+
 ## Contributing
 
 1. [Fork it](https://github.com/madeintandem/jsonb_accessor/fork)

data/Rakefile

@@ -5,18 +5,21 @@ require "bundler/setup"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
+require "active_record"
+require "erb"
 
 RSpec::Core::RakeTask.new
 RuboCop::RakeTask.new
 
-require "active_record"
+# rubocop:disable Style/MixinUsage
 include ActiveRecord::Tasks
+# rubocop:enable Style/MixinUsage
 
-root = File.expand_path "..", __FILE__
+root = File.expand_path __dir__
 db_dir = File.join(root, "db")
 DatabaseTasks.root = root
 DatabaseTasks.db_dir = db_dir
-DatabaseTasks.database_configuration = YAML.load(File.read(File.join(db_dir, "config.yml")))
+DatabaseTasks.database_configuration = YAML.load(ERB.new(File.read(File.join(db_dir, "config.yml"))).result)
 DatabaseTasks.migrations_paths = [File.join(db_dir, "migrate")]
 DatabaseTasks.env = "test"
 

data/bin/console

@@ -1,16 +1,16 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# rubocop:disable Lint/UselessAssignment
-
 require "bundler/setup"
 require "jsonb_accessor"
 require "rspec"
-require File.expand_path("../../spec/spec_helper.rb", __FILE__)
+require File.expand_path("../spec/spec_helper.rb", __dir__)
 
 dbconfig = YAML.load(File.open("db/config.yml"))
 ActiveRecord::Base.establish_connection(dbconfig["development"])
 
+# rubocop:disable Lint/UselessAssignment
 x = Product.new
+# rubocop:enable Lint/UselessAssignment
 
 Pry.start

data/db/config.yml

@@ -1,7 +1,7 @@
 default: &default
   adapter: postgresql
   database: jsonb_accessor
-  host: 127.0.0.1
+  host: <%= ENV.fetch("DATABASE_HOST") { "127.0.0.1" } %>
   user: postgres
 
 test:

data/db/migrate/20150407031737_set_up_testing_db.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SetUpTestingDb < ActiveRecord::Migration[5.0]
   def change
     create_table :products do |t|

data/db/schema.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
+
 # 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.
 #
-# This file is the source Rails uses to define your schema when running `rails
-# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
-# be faster and is potentially less error prone than running all of your
-# migrations from scratch. Old migrations may fail to apply correctly if those
-# migrations use external dependencies or application code.
+# 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: 2015_04_07_031737) do
-
+ActiveRecord::Schema.define(version: 20_150_407_031_737) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -32,5 +33,4 @@ ActiveRecord::Schema.define(version: 2015_04_07_031737) do
     t.datetime "datetime_type"
     t.decimal "decimal_type"
   end
-
 end

data/docker-compose.yml

@@ -0,0 +1,26 @@
+version: '3'
+
+services:
+  ruby:
+    environment:
+      - DATABASE_HOST=postgres
+    build:
+      args:
+        - RUBY_VERSION=${RUBY_VERSION:-2.7.2}
+      context: .
+    volumes:
+      - '.:/usr/src/app'
+    depends_on:
+      - postgres
+
+  postgres:
+    image: postgres:12
+    environment:
+      - POSTGRES_HOST_AUTH_METHOD=trust
+      - POSTGRES_DB=jsonb_accessor
+      - PGDATA=/var/lib/postgresql/data/pgdata
+    volumes:                                                                                    
+      - pg_data:/var/lib/postgresql/data/pgdata
+
+volumes:                                                                                        
+  pg_data:

data/jsonb_accessor.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "jsonb_accessor/version"
 
@@ -27,12 +26,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "pg", ">= 0.18.1"
 
   spec.add_development_dependency "appraisal", "~> 2.2.0"
-  spec.add_development_dependency "database_cleaner", "~> 1.6.0"
   spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "database_cleaner", "~> 1.6.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-doc"
   spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.6.0"
-  spec.add_development_dependency "rubocop", "~> 0.48.1"
+  spec.add_development_dependency "rubocop", "~> 1"
 end

data/lib/jsonb_accessor.rb

@@ -15,6 +15,6 @@ module JsonbAccessor
 end
 
 ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.send(:include, JsonbAccessor)
-  ActiveRecord::Base.send(:include, JsonbAccessor::QueryBuilder)
+  ActiveRecord::Base.include JsonbAccessor
+  ActiveRecord::Base.include JsonbAccessor::QueryBuilder
 end

data/lib/jsonb_accessor/macro.rb

@@ -55,7 +55,7 @@ module JsonbAccessor
         # each time it is evaluated.
         all_defaults_mapping_proc =
           if all_defaults_mapping.present?
-            -> { all_defaults_mapping.map { |key, value| [key, value.respond_to?(:call) ? value.call : value] }.to_h }
+            -> { all_defaults_mapping.transform_values { |value| value.respond_to?(:call) ? value.call : value }.to_h.compact }
           end
         attribute jsonb_attribute, :jsonb, default: all_defaults_mapping_proc if all_defaults_mapping_proc.present?
 
@@ -79,7 +79,7 @@ module JsonbAccessor
             empty_named_attributes = names_to_store_keys.keys.each_with_object({}) { |name, defaults| defaults[name] = nil }
 
             store_key_attributes = ::JsonbAccessor::QueryHelper.convert_keys_to_store_keys(value, names_to_store_keys)
-            write_attribute(jsonb_attribute, empty_store_key_attributes.merge(store_key_attributes))
+            write_attribute(jsonb_attribute, empty_store_key_attributes.merge(store_key_attributes).compact)
 
             empty_named_attributes.merge(value).each { |name, attribute_value| write_attribute(name, attribute_value) }
           end

data/lib/jsonb_accessor/query_builder.rb

@@ -61,9 +61,7 @@ module JsonbAccessor
         excludes_attributes = {}
 
         attributes.each do |name, value|
-          if value.is_a?(Range)
-            raise JsonbAccessor::QueryHelper::NotSupported, "`jsonb_where_not` scope does not accept ranges as arguments. Given `#{value}` for `#{name}` field"
-          end
+          raise JsonbAccessor::QueryHelper::NotSupported, "`jsonb_where_not` scope does not accept ranges as arguments. Given `#{value}` for `#{name}` field" if value.is_a?(Range)
 
           if JsonbAccessor::QueryHelper.number_query_arguments?(value)
             value.each { |operator, query_value| query = query.jsonb_number_where_not(column_name, name, operator, query_value) }

data/lib/jsonb_accessor/query_helper.rb

@@ -42,9 +42,7 @@ module JsonbAccessor
 
     class << self
       def validate_column_name!(query, column_name)
-        if query.model.columns.none? { |column| column.name == column_name.to_s }
-          raise InvalidColumnName, "a column named `#{column_name}` does not exist on the `#{query.model.table_name}` table"
-        end
+        raise InvalidColumnName, "a column named `#{column_name}` does not exist on the `#{query.model.table_name}` table" if query.model.columns.none? { |column| column.name == column_name.to_s }
       end
 
       def validate_field_name!(query, column_name, field_name)
@@ -56,9 +54,7 @@ module JsonbAccessor
       end
 
       def validate_direction!(option)
-        if ORDER_DIRECTIONS.exclude?(option)
-          raise InvalidDirection, "`#{option}` is not a valid direction for ordering, only `asc` and `desc` are accepted"
-        end
+        raise InvalidDirection, "`#{option}` is not a valid direction for ordering, only `asc` and `desc` are accepted" if ORDER_DIRECTIONS.exclude?(option)
       end
 
       def convert_keys_to_store_keys(attributes, store_key_mapping)

data/lib/jsonb_accessor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonb_accessor
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Michael Crismali
@@ -69,33 +69,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -172,14 +172,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: '1'
 description: Adds typed jsonb backed fields to your ActiveRecord models.
 email:
 - michael@crismali.com
@@ -196,6 +196,7 @@ files:
 - ".travis.yml"
 - Appraisals
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -206,6 +207,7 @@ files:
 - db/config.yml
 - db/migrate/20150407031737_set_up_testing_db.rb
 - db/schema.rb
+- docker-compose.yml
 - gemfiles/activerecord_5.0.0.gemfile
 - gemfiles/activerecord_5.1.0.gemfile
 - gemfiles/activerecord_6.1.0.gemfile
@@ -234,8 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Adds typed jsonb backed fields to your ActiveRecord models.