array_enum 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: decd290271c41c2193a1e63f98a0df618c9a95813570aa01a32f27bd68d25865
-  data.tar.gz: da107aae087d6592ce0b33d8186170f41438b7be199737103a0b3bea4c13e53e
+  metadata.gz: 532d9c63da0d5670890af1f3236821651e5df2939a360086138af660363f7917
+  data.tar.gz: 296725907a06887551117c12a554bc1b3b1c0d6852bd7ab714be2cbcda6cbbae
 SHA512:
-  metadata.gz: 8a4e5a2c6cf33ec8fa943d13d0b1b852f20671598556abd638c7fb72d9175e83b355cc122b615c3aa1e109511313b4e163f30808ec0a9d4cdb9f422571cdac49
-  data.tar.gz: d984bfdf1addd82a03fc1098453c9141f6ca3fb3b13ba8f9b2e4cde5d9d7244379d1677a248dbae93c3f272fee6e679c15ada79136ca6c9ea71da9e55d1ef56f
+  metadata.gz: adb8025e3538639f748d2752d5cf05facb3494ced82c550a40d6a400f5569fffe3e977a7159d0e3a0c685b76c887c7b14158d854863761ec3f444310552aa45b
+  data.tar.gz: d9d7f665c33d61254bdbc758f0b4ccd998f9b81cd974e1d17b4345184ce41f1a29d137a070c2f9bdc5bf9ea118222d68cd0c4e7006ef3d3d55820326592b5a1f

data/.github/workflows/ci-on-merge.yml

@@ -0,0 +1,59 @@
+name: BUILD
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.0, 3.1, 3.3]
+
+    services:
+      postgres:
+        image: postgres
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+    - name: Install libraries
+      run: |
+        sudo apt-get install -y libpq-dev postgresql-client
+
+    - name: Configure database
+      env:
+        PGPASSWORD: postgres
+        PGUSER: postgres
+        PGHOST: localhost
+      run: |
+        echo "Configuring PostgresSQL"
+        psql -c 'create database "array_enum_test";'
+
+    - name: Checkout code
+      uses: actions/checkout@v4.1.1
+
+    - name : Ruby Setup
+      uses: ruby/setup-ruby@v1.173.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run test
+      env:
+        PGPASSWORD: postgres
+        PGUSER: postgres
+        PGHOST: localhost
+      run: bundle exec rake -s test

data/.github/workflows/ci.yml

@@ -1,38 +1,58 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  - pull_request
+  - push
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.0, 3.1, 3.3]
+
     services:
       postgres:
-        image: postgres:11
+        image: postgres
         ports:
-        - 5432:5432
+          - 5432:5432
         env:
-          POSTGRES_PASSWORD: ""
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
 
     steps:
     - name: Install libraries
       run: |
-        sudo apt-get update
         sudo apt-get install -y libpq-dev postgresql-client
 
     - name: Configure database
+      env:
+        PGPASSWORD: postgres
+        PGUSER: postgres
+        PGHOST: localhost
       run: |
-        echo "PostgreSQL"
-        psql -h localhost -c 'create database "array_enum_test";' -U postgres
+        echo "Configuring PostgresSQL"
+        psql -c 'create database "array_enum_test";'
 
-    - uses: actions/checkout@v1
+    - name: Checkout code
+      uses: actions/checkout@v4.1.1
 
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+    - name : Ruby Setup
+      uses: ruby/setup-ruby@v1.173.0
       with:
-        ruby-version: 2.6.x
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
 
-    - name: Build and test
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake test
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Run test
+      env:
+        PGPASSWORD: postgres
+        PGUSER: postgres
+        PGHOST: localhost
+      run: bundle exec rake -s test

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.tool-versions
+.byebug_history

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in array_enum.gemspec
 gemspec

data/Gemfile.lock

@@ -1,32 +1,42 @@
 PATH
   remote: .
   specs:
-    array_enum (1.3.0)
+    array_enum (1.5.0)
       activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    concurrent-ruby (1.1.8)
-    i18n (1.8.9)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    drb (2.2.1)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    pg (1.1.4)
-    rake (12.3.3)
-    tzinfo (2.0.4)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    pg (1.5.6)
+    rake (13.2.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -40,4 +50,4 @@ DEPENDENCIES
   rake (>= 10.0)
 
 BUNDLED WITH
-   2.0.2
+   2.5.6

data/README.md

@@ -1,3 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/array_enum.svg)](https://badge.fury.io/rb/array_enum)
+[![BUILD](https://github.com/freeletics/array_enum/actions/workflows/ci-on-merge.yml/badge.svg)](https://github.com/freeletics/array_enum/actions/workflows/ci-on-merge.yml)
+
+
 # ArrayEnum
 
 Extension for `ActiveRecord` that adds support for `PostgreSQL` array columns, mapping string values to integers.
@@ -11,7 +15,6 @@ Extension for `ActiveRecord` that adds support for `PostgreSQL` array columns, m
 ### ActiveRecord extension
 
 Database will store integers that after reading will map to string values.
-Additionally scope is generated with `with_` prefix that will query database for any matching passed value.
 
 ```ruby
 ActiveRecord::Schema.define do
@@ -23,13 +26,43 @@ end
 class User < ActiveRecord::Base
   extend ArrayEnum
 
-  array_enum favourite_colors: {"red" => 1, "blue" => 2}
+  array_enum favourite_colors: {"red" => 1, "blue" => 2, "green" => 3}
 end
 
 user = User.create!(favourite_colors: ["red", "green"])
 user.favourite_colors # => ["red", "green"]
-User.favourite_colors # => {"red" => 1, "blue" => 2}
-User.with_favourite_colors("red") # => [user]
+User.favourite_colors # => {"red" => 1, "blue" => 2, "green" => 3}
+```
+
+Several scopes are made available on your model to find records based on a value or an array of values:
+
+```ruby
+user1 = User.create!(favourite_colors: ["red", "green"])
+user2 = User.create!(favourite_colors: ["red"])
+
+# Find a record that has _all_ the provided values in the array enum attribute
+User.with_favourite_colors("red") # => [user1, user2]
+User.with_favourite_colors(%w[red green]) # => [user1]
+User.with_favourite_colors(%w[red blue]) # => []
+User.with_favourite_colors(%w[green blue]) # => []
+
+# Find a record that has the provided values, and _only those values_, in the array enum attribute
+User.only_with_favourite_colors("red") # => [user2]
+User.only_with_favourite_colors(%w[red green]) # => [user1]
+User.only_with_favourite_colors(%w[red blue]) # => []
+User.only_with_favourite_colors(%w[green blue]) # => []
+
+# Find a record that has _at least one_ of the provided values in the array enum attribute
+User.with_any_of_favourite_colors("red") # => [user1, user2]
+User.with_any_of_favourite_colors(%w[red green]) # => [user1, user2]
+User.with_any_of_favourite_colors(%w[red blue]) # => [user1, user2]
+User.with_any_of_favourite_colors(%w[green blue]) # => [user1]
+```
+
+Attempting to find a record with a value that is not in the enum will fail:
+
+```ruby
+User.with_favourite_colors("yellow") # => ArgumentError["yellow is not a valid value for favourite_colors"]
 ```
 
 ### Subset Validator

data/array_enum.gemspec

@@ -1,45 +1,44 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "array_enum/version"
+require 'array_enum/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "array_enum"
+  spec.name          = 'array_enum'
   spec.version       = ArrayEnum::VERSION
-  spec.authors       = ["Wojciech Wnętrzak"]
-  spec.email         = ["w.wnetrzak@gmail.com", "eng@freeletics.com"]
+  spec.authors       = ['Wojciech Wnętrzak']
+  spec.email         = ['w.wnetrzak@gmail.com', 'eng@freeletics.com']
 
-  spec.summary       = %q{String to integer mapping for PostgreSQL array columns.}
-  spec.description   = %q{Extension for ActiveRecord that adds support for PostgreSQL array columns, mapping string values to integers.}
-  spec.homepage      = "https://github.com/freeletics/array_enum"
-  spec.license       = "MIT"
+  spec.summary       = 'String to integer mapping for PostgreSQL array columns.'
+  spec.description   = 'Extension for ActiveRecord that adds support for PostgreSQL array columns, mapping string values to integers.'
+  spec.homepage      = 'https://github.com/freeletics/array_enum'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/freeletics/array_enum"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/freeletics/array_enum'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = ">= 2.3"
+  spec.required_ruby_version = '>= 3.0'
 
-  spec.add_dependency "activemodel"
+  spec.add_dependency 'activemodel'
 
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "pg"
-  spec.add_development_dependency "bundler", ">= 1.17"
-  spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "minitest", ">= 5.0"
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'minitest', '>= 5.0'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rake', '>= 10.0'
 end

data/lib/array_enum/version.rb

@@ -1,3 +1,3 @@
 module ArrayEnum
-  VERSION = "1.3.0"
+  VERSION = '1.5.0'
 end

data/lib/array_enum.rb

@@ -1,11 +1,11 @@
-require "array_enum/version"
-require "array_enum/subset_validator"
-require "array_enum/railtie" if defined?(Rails::Railtie)
-require "active_support/hash_with_indifferent_access"
-require "active_support/core_ext/string/inflections"
+require 'array_enum/version'
+require 'array_enum/subset_validator'
+require 'array_enum/railtie' if defined?(Rails::Railtie)
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/string/inflections'
 
 module ArrayEnum
-  MISSING_VALUE_MESSAGE = "%{value} is not a valid value for %{attr}".freeze
+  MISSING_VALUE_MESSAGE = '%<value>s is not a valid value for %<attr>s'.freeze
   private_constant :MISSING_VALUE_MESSAGE
 
   def array_enum(definitions)
@@ -17,11 +17,17 @@ module ArrayEnum
         mapping_hash
       end
 
-      define_singleton_method("with_#{attr_name}".to_sym) do |values|
-        db_values = Array(values).map do |value|
-          mapping_hash[value] || raise(ArgumentError, MISSING_VALUE_MESSAGE % {value: value, attr: attr_name})
+      {
+        "with_#{attr_name}" => '@>',
+        "only_with_#{attr_name}" => '=',
+        "with_any_of_#{attr_name}" => '&&'
+      }.each do |method_name, comparison_operator|
+        define_singleton_method(method_name.to_sym) do |values|
+          db_values = Array(values).map do |value|
+            mapping_hash[value] || raise(ArgumentError, format(MISSING_VALUE_MESSAGE, value: value, attr: attr_name))
+          end
+          where("#{table_name}.#{attr_name} #{comparison_operator} ARRAY[:db_values]", db_values: db_values)
         end
-        where("#{attr_name} @> ARRAY[:db_values]", db_values: db_values)
       end
 
       define_method(attr_symbol) do
@@ -30,7 +36,7 @@ module ArrayEnum
 
       define_method("#{attr_name}=".to_sym) do |values|
         self[attr_symbol] = Array(values).map do |value|
-          mapping_hash[value] || raise(ArgumentError, MISSING_VALUE_MESSAGE % {value: value, attr: attr_name})
+          mapping_hash[value] || raise(ArgumentError, format(MISSING_VALUE_MESSAGE, value: value, attr: attr_name))
         end.uniq
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_enum
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Wojciech Wnętrzak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2024-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -39,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
 description: Extension for ActiveRecord that adds support for PostgreSQL array columns,
   mapping string values to integers.
 email:
@@ -103,6 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci-on-merge.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
@@ -131,14 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: String to integer mapping for PostgreSQL array columns.