array_enum 1.0.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc3f9133c5efe0de0320c4b83e650969ab9b647b29b242f2d44dfb58d2a726f
-  data.tar.gz: 9a9ee4607992a52138f6fea70e0eb329554b50e675b37f8e700305b04ff161b9
+  metadata.gz: 5d2df08c37b57f1ab526c97e96687aaa26d6f4cdbbd7cf189a1671b4fc2ad309
+  data.tar.gz: a4a87c06b773f5b8210d67e869372e99e838853962789a5d030bd8ec2fbc9a9e
 SHA512:
-  metadata.gz: 3f96c19d50fac52b7bc2041d4983c9880807944226074132ce3c16b3a7ad99a1f00648f501d5535b8edaba1a932216ff0fb6196531dae7c9d09e3eb0bb06f6b9
-  data.tar.gz: 43e71fc9ba6e47fd70b4fadad42d6b901d03f5e92238201e6e157338212db3d710ffcbffbb10fa8be0cf5be444a4c584de6c09d2272d42ace912d32087224321
+  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

@@ -0,0 +1,56 @@
+name: CI
+
+on: [pull_request]
+
+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/Gemfile.lock

@@ -1,33 +1,32 @@
 PATH
   remote: .
   specs:
-    array_enum (1.0.1)
+    array_enum (1.4.0)
       activemodel
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.2)
-      activesupport (= 5.2.2)
-    activerecord (5.2.2)
-      activemodel (= 5.2.2)
-      activesupport (= 5.2.2)
-      arel (>= 9.0)
-    activesupport (5.2.2)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    concurrent-ruby (1.1.4)
-    i18n (1.5.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     pg (1.1.4)
-    rake (12.3.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    rake (12.3.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -41,4 +40,4 @@ DEPENDENCIES
   rake (>= 10.0)
 
 BUNDLED WITH
-   1.17.3
+   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,12 +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.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
@@ -42,6 +76,8 @@ class CreateUser
   attr_accessor :favourite_colors
 
   validates :favourite_colors, subset: ["green", "blue"]
+  # or:
+  # validates :favourite_colors, subset: { in: ->(record) { Color.pluck(:name) } }
 end
 
 CreateUser.new(favourite_colors: ["black"]).valid? # => false
@@ -49,8 +85,6 @@ CreateUser.new(favourite_colors: ["black"]).valid? # => false
 
 ## Development
 
-[![Build Status](https://travis-ci.com/freeletics/array_enum.svg?branch=master)](https://travis-ci.com/freeletics/array_enum)
-
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/array_enum/subset_validator.rb

@@ -3,10 +3,12 @@ require "active_model/validator"
 class ArrayEnum::SubsetValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     wrapped_value = [value].flatten # Handles nil value
-    diff = wrapped_value.reject { |element| delimiter.include?(element) }
+    subset = delimiter.respond_to?(:call) ? delimiter.call(record) : delimiter
+
+    diff = wrapped_value.reject { |element| subset.include?(element) }
 
     unless diff.empty?
-      record.errors.add(attribute, :inclusion, options.except(:in, :within).merge!(value: diff))
+      record.errors.add(attribute, :inclusion, **options.except(:in, :within).merge!(value: diff))
     end
   end
 

data/lib/array_enum/version.rb

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

data/lib/array_enum.rb

@@ -1,6 +1,8 @@
 require "array_enum/version"
 require "array_enum/subset_validator"
-require "array_enum/railtie" if defined?(Rails)
+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
@@ -9,21 +11,32 @@ module ArrayEnum
   def array_enum(definitions)
     definitions.each do |attr_name, mapping|
       attr_symbol = attr_name.to_sym
+      mapping_hash = ActiveSupport::HashWithIndifferentAccess.new(mapping)
 
-      define_singleton_method("with_#{attr_name}".to_sym) do |values|
-        db_values = Array(values).map do |value|
-          mapping[value.to_s] || raise(ArgumentError, MISSING_VALUE_MESSAGE % {value: value, attr: attr_name})
+      define_singleton_method(attr_name.to_s.pluralize) do
+        mapping_hash
+      end
+
+      {
+        "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
-        Array(self[attr_symbol]).map { |value| mapping.key(value) }
+        Array(self[attr_symbol]).map { |value| mapping_hash.key(value) }
       end
 
       define_method("#{attr_name}=".to_sym) do |values|
         self[attr_symbol] = Array(values).map do |value|
-          mapping[value.to_s] || raise(ArgumentError, MISSING_VALUE_MESSAGE % {value: value, attr: attr_name})
+          mapping_hash[value] || raise(ArgumentError, 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.0.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Wojciech Wnętrzak
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -103,8 +103,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci-on-merge.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -123,7 +124,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/freeletics/array_enum
   source_code_uri: https://github.com/freeletics/array_enum
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: String to integer mapping for PostgreSQL array columns.
 test_files: []

data/.travis.yml

@@ -1,16 +0,0 @@
-dist: xenial
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.0
-
-addons:
-  postgresql: "10"
-
-before_script:
-  - psql -c 'create database "array_enum_test";' -U postgres
-
-script: "bundle exec rake"
-
-notifications:
-  disabled: true