dynamoid_advanced_where 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81b5cff1e68596d951a94a59b5bdba3e21bf032229b79d3adfae32d7abbb9613
-  data.tar.gz: 3764fc26d9e63c7543f9d49d9eb5b3e4fc0e532d2be7b2ded69855e7c9740277
+  metadata.gz: 1b7427e4321a6c8c50704320ff3912868bd50d3471dae090a26059c107f25210
+  data.tar.gz: e87fbb9ac716caefdc16bf3190b2cbd0075263dae6aff9e88154271717055691
 SHA512:
-  metadata.gz: '08a0e6c52f255817fa42a213aff15943f624f5657c7e24a01d370f54f0bad8d030e3a7587e8994a27bbdb68a8c6d05bbf6396dc22215470d28adf0ab8f1f6e85'
-  data.tar.gz: 61a2d7b5f5de111ea8e7677de91e1120b17085ca4d3c13c104828ee01066a0ffc8b40bad45d90af4db4c29704bffb1b4122816ab174f7f140ed72ce305ee7310
+  metadata.gz: 33c0c156eef5278bc77f7679bf56762f23937e2dc949da35a4dd16b8c4d0e3fa4e4f20d864faaac9b0e4ec99a9befe56994d87287c96452570582b93921e649f
+  data.tar.gz: 1b0eab5b78254e4352d72d2930daf2aa1645b27e2759e87024387dd6efeaa9ed9bc70536e3fc0fd1c0fe0cdafcf4c2b22f8548672d0d3496ebb1c64687efe0ec

data/.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: 'Lint'
+
+on: push
+
+jobs:
+  run-rubocop:
+    name: Lint code
+    strategy:
+      fail-fast: false
+      matrix:
+        rubyVersion: ["2.7.6"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.rubyVersion }}
+          bundler-cache: true
+          cache-version: "${{ matrix.rubyVersion }}-0"
+      - name: Run RuboCop
+        run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: Test
+
+on: push
+
+jobs:
+  run-tests:
+    name: Test code
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.0.4
+          - 2.7.6
+          - 3.1.2
+    services:
+      dynamodb:
+        image: amazon/dynamodb-local
+        ports:
+          - 8000/tcp
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          cache-version: ${{ matrix.ruby }}-0
+      - name: Run RSpec
+        env:
+          AWS_ACCESS_KEY_ID: asdf
+          AWS_SECRET_ACCESS_KEY: asdf
+          CI: true
+          DYNAMODB_HOST: http://localhost:${{job.services.dynamodb.ports[8000]}}/
+        run: bundle exec rspec
+      - name: Coveralls
+        uses: coverallsapp/github-action@v1.1.2
+        continue-on-error: true
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop-https---raw-githubusercontent-com-GetTerminus-ruby-shared-configs-master--rubocop-3-1-yml

@@ -0,0 +1,5 @@
+inherit_from:
+  - https://raw.githubusercontent.com/GetTerminus/ruby_shared_configs/master/.rubocop.yml
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either

data/.rubocop-https---raw-githubusercontent-com-GetTerminus-ruby-shared-configs-master--rubocop-yml

@@ -0,0 +1,91 @@
+AllCops:
+  Exclude:
+    - Makefile
+    - vendor/**/*
+    - bin/**/*
+
+Layout/EndOfLine:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Layout/LineLength:
+  Enabled: true
+  Max: 280
+  IgnoreCopDirectives: true
+  AllowedPatterns: ['\A#', '\A\s*sig { .* }\Z']
+  Exclude:
+    - '**/*_pb.rb'
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 48
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 32
+
+Layout/ParameterAlignment:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Naming/MethodParameterName:
+  Enabled: true
+  AllowedNames: ['io', 'id', 'to', 'by', 'on', 'in', 'at', '_'] # Defaults + _
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Style/ParallelAssignment:
+  Enabled: true
+
+Metrics/ClassLength:
+  Max: 240
+
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - spec/**/*.rb
+    - '**/*_pb.rb'
+
+Metrics/ParameterLists:
+  Max: 6
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*.rb
+
+Style/BlockDelimiters:
+  Enabled: true
+  Exclude:
+    - spec/**/*

data/.rubocop.yml

@@ -1,3 +1,9 @@
+inherit_from:
+  - .rubocop_todo.yml
+  - https://raw.githubusercontent.com/GetTerminus/ruby_shared_configs/master/.rubocop-3-1.yml
+
+
+
 AllCops:
   Exclude:
     - bin/*

data/.rubocop_todo.yml

@@ -0,0 +1,42 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-10-31 20:09:20 UTC using RuboCop version 1.18.4.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'dynamoid_advanced_where.gemspec'
+
+# Offense count: 6
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/dynamoid_advanced_where/nodes/and_node.rb'
+    - 'lib/dynamoid_advanced_where/nodes/exists_node.rb'
+    - 'lib/dynamoid_advanced_where/nodes/field_node.rb'
+    - 'lib/dynamoid_advanced_where/nodes/operation_node.rb'
+    - 'lib/dynamoid_advanced_where/nodes/or_node.rb'
+    - 'lib/dynamoid_advanced_where/nodes/root_node.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowComments, AllowNil.
+Lint/SuppressedException:
+  Exclude:
+    - 'lib/dynamoid_advanced_where/batched_updater.rb'
+
+# Offense count: 1
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/dynamoid_advanced_where/batched_updater.rb'
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/dynamoid_advanced_where/nodes/root_node.rb'

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.4

data/Appraisals

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 
-appraise "dynamoid-3.4" do
-  gem "dynamoid", "~> 3.4.0"
+appraise 'dynamoid-3.4' do
+  gem 'dynamoid', '~> 3.4.0'
 end
 
-appraise "dynamoid-latest" do
-  gem "dynamoid", "~> 3.0"
+appraise 'dynamoid-latest' do
+  gem 'dynamoid', '~> 3.0'
 end

data/Gemfile

@@ -1,9 +1,10 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in dynamoid-advanced-where.gemspec
 gemspec
 
 gem 'pry'
-

data/Gemfile.lock

@@ -1,104 +1,115 @@
 PATH
   remote: .
   specs:
-    dynamoid_advanced_where (1.3.0)
+    dynamoid_advanced_where (1.5.0)
       dynamoid (>= 3.2, < 4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    appraisal (2.4.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    appraisal (2.4.1)
       bundler
       rake
       thor (>= 0.14.0)
     ast (2.4.2)
-    aws-eventstream (1.1.0)
-    aws-partitions (1.430.0)
-    aws-sdk-core (3.112.0)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.654.0)
+    aws-sdk-core (3.166.0)
       aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.239.0)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-dynamodb (1.78.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
       aws-sigv4 (~> 1.1)
-      jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.59.0)
-      aws-sdk-core (~> 3, >= 3.112.0)
-      aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.2.2)
+    aws-sigv4 (1.5.2)
       aws-eventstream (~> 1, >= 1.0.2)
-    bundler-audit (0.7.0.1)
+    bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
-      thor (>= 0.18, < 2)
-    childprocess (4.0.0)
+      thor (~> 1.0)
+    childprocess (4.1.0)
     coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.8)
-    diff-lcs (1.4.4)
-    dynamoid (3.7.0)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dynamoid (3.7.1)
       activemodel (>= 4)
       aws-sdk-dynamodb (~> 1.0)
       concurrent-ruby (>= 1.0)
-    fasterer (0.9.0)
+    fasterer (0.10.0)
       colorize (~> 0.7)
-      ruby_parser (>= 3.14.1)
-    i18n (1.8.9)
+      ruby_parser (>= 3.19.1)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     iniparse (1.5.0)
-    jmespath (1.4.0)
+    jmespath (1.6.1)
+    json (2.6.2)
     method_source (1.0.0)
-    minitest (5.14.4)
-    overcommit (0.57.0)
+    minitest (5.16.3)
+    overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+      rexml (~> 3.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
     rake (10.5.0)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.11.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.37.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    ruby_parser (3.15.1)
-      sexp_processor (~> 4.9)
-    sexp_processor (4.15.2)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+    ruby_parser (3.19.1)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.1)
+    thor (1.2.1)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -116,6 +127,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop
+  webmock
 
 BUNDLED WITH
-   2.1.4
+   2.3.12

data/README.md

@@ -114,6 +114,16 @@ Valid on field types: `string`, or `set/array` of `String` / `Integer`
 #### Example
 `where{|r| r.foo.includes?(123) }` and `where{|r| r.foo.includes?('foo') }`
 
+### In?
+This operator may be used to check if:
+
+* A string field is one of an enumerable set of values
+
+Valid on field types: `string`
+
+#### Example
+`where{|r| r.foo.in?(['foo', 'bar']) }`
+
 ### Working with Map and Raw types
 When it comes to map and raw attribute types, DAW takes the approach of
 trusting you, since the exact format is not explicitly defined or enforced.
@@ -249,6 +259,23 @@ if it successfully updates. If it fails to update, it will return nil.
 If the specified hash key, or hash/range key combination is not already present
 it will be inserted with the desired mutations (if possible).
 
+### Referencing a field
+To identify the field to be updated, either through set, increment, decrement, or append you may just use the field name
+for top level keys. When you use the top level single symbol key DAW will use the built in Dynamoid dumper.
+
+If you need to reference the sub-key of a map, or custom serialized object you may pass an array of keys. Since DAW
+looses context to the "type" it is up to you to ensure you are writing out the correct values. The only exception to 
+this is if you are set the field to a class which implements `dynamoid_dump`.
+
+#### Example
+```ruby
+Model.where{ conditions }.batch_update
+  .set_values([:map_or_custom_type, :sub_field, :foo] => 'value', [:map_or_custom_type2, :foo] => MyDumpableClass.new(test))
+  .increment([:some_map, :attempts], by: 1)
+  .decrement([:some_map, :attempts_remaining], by: 1)
+  .apply(hash_key, range_key)
+```
+
 ### Setting a single field
 The batch updated method `set_values(attr_name: new_attr_value, other_atter: val)`
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/dynamoid_advanced_where.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dynamoid_advanced_where/version'
@@ -30,12 +32,13 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'dynamoid', '>= 3.2', '< 4'
 
-  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'bundler-audit'
   spec.add_development_dependency 'fasterer'
   spec.add_development_dependency 'overcommit'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'webmock'
 end

data/gemfiles/dynamoid_3.4.gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "pry"
-gem "dynamoid", "~> 3.4.0"
+gem 'dynamoid', '~> 3.4.0'
+gem 'pry'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/dynamoid_3.5.gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "pry"
-gem "dynamoid", "~> 3.5.0"
+gem 'dynamoid', '~> 3.5.0'
+gem 'pry'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/dynamoid_3.6.gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "pry"
-gem "dynamoid", "~> 3.6.0"
+gem 'dynamoid', '~> 3.6.0'
+gem 'pry'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/dynamoid_latest.gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "pry"
-gem "dynamoid", "~> 3.0"
+gem 'dynamoid', '~> 3.0'
+gem 'pry'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/dynamoid_master.gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "pry"
-gem "dynamoid", git: "https://github.com/Dynamoid/dynamoid.git"
+gem 'dynamoid', git: 'https://github.com/Dynamoid/dynamoid.git'
+gem 'pry'
 
-gemspec path: "../"
+gemspec path: '../'