array_enum 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: decd290271c41c2193a1e63f98a0df618c9a95813570aa01a32f27bd68d25865
-  data.tar.gz: da107aae087d6592ce0b33d8186170f41438b7be199737103a0b3bea4c13e53e
+  metadata.gz: 5d2df08c37b57f1ab526c97e96687aaa26d6f4cdbbd7cf189a1671b4fc2ad309
+  data.tar.gz: a4a87c06b773f5b8210d67e869372e99e838853962789a5d030bd8ec2fbc9a9e
 SHA512:
-  metadata.gz: 8a4e5a2c6cf33ec8fa943d13d0b1b852f20671598556abd638c7fb72d9175e83b355cc122b615c3aa1e109511313b4e163f30808ec0a9d4cdb9f422571cdac49
-  data.tar.gz: d984bfdf1addd82a03fc1098453c9141f6ca3fb3b13ba8f9b2e4cde5d9d7244379d1677a248dbae93c3f272fee6e679c15ada79136ca6c9ea71da9e55d1ef56f
+  metadata.gz: 153d73f33212247cba61d862b31948bd66c50c352f2984fbfbe00c71ce77a8086a8925e3256bfa03013a32050442a6be7014da888493a3c422256ac85d24108a
+  data.tar.gz: 273ababe94efae433b8577e872cc44f0a69e85b482b9deda86dc83b39f0440d973e2755ca2bc85b7e36ab90d2313b77e0ed0dc94e932a4b681a26eeaf592a908

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: [2.7, '3.0', 3.1]
+
+    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@v2
+
+    - name : Ruby Setup
+      uses: ruby/setup-ruby@v1
+      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,56 @@
 name: CI
 
-on: [push, pull_request]
+on: [pull_request]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.7, '3.0', 3.1]
+
     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@v2
 
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
+    - name : Ruby Setup
+      uses: ruby/setup-ruby@v1
       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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    array_enum (1.3.0)
+    array_enum (1.4.0)
       activemodel
 
 GEM
@@ -40,4 +40,4 @@ DEPENDENCIES
   rake (>= 10.0)
 
 BUNDLED WITH
-   2.0.2
+   2.2.3

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/lib/array_enum/version.rb

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

data/lib/array_enum.rb

@@ -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, MISSING_VALUE_MESSAGE % {value: value, attr: attr_name})
+          end
+          where("#{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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_enum
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Wojciech Wnętrzak
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -103,6 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci-on-merge.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile