array_enum 0.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bf65753b1960e7d732e9dbef138a7adb0f2873ea8ecd02a48623e837ce95fc2
-  data.tar.gz: 2adaa2064958a2d39933c1803070493db15e55602b8311b80255cea1d1cf5604
+  metadata.gz: decd290271c41c2193a1e63f98a0df618c9a95813570aa01a32f27bd68d25865
+  data.tar.gz: da107aae087d6592ce0b33d8186170f41438b7be199737103a0b3bea4c13e53e
 SHA512:
-  metadata.gz: e2a40dff60e27e34b11226ba300def97adcf6859ad6b6dfdb46539de8e7433b0b47db8a4a61cc727ff30bc091800d0e09c577d29065219c9e4a0f4298f4f7668
-  data.tar.gz: 9efc6ad57fd3faa33f80dfb087246e894cec0d54bf83cc87a39b6cc680a52df32e82e581454e33feb1dd68b8d0e65fe4f3b8b5ad65a31bd82244d1de29a4e967
+  metadata.gz: 8a4e5a2c6cf33ec8fa943d13d0b1b852f20671598556abd638c7fb72d9175e83b355cc122b615c3aa1e109511313b4e163f30808ec0a9d4cdb9f422571cdac49
+  data.tar.gz: d984bfdf1addd82a03fc1098453c9141f6ca3fb3b13ba8f9b2e4cde5d9d7244379d1677a248dbae93c3f272fee6e679c15ada79136ca6c9ea71da9e55d1ef56f

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:11
+        ports:
+        - 5432:5432
+        env:
+          POSTGRES_PASSWORD: ""
+
+    steps:
+    - name: Install libraries
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libpq-dev postgresql-client
+
+    - name: Configure database
+      run: |
+        echo "PostgreSQL"
+        psql -h localhost -c 'create database "array_enum_test";' -U postgres
+
+    - uses: actions/checkout@v1
+
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Build and test
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    array_enum (0.1.0)
+    array_enum (1.3.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.4.0)
+      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.3)
-    rake (12.3.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    pg (1.1.4)
+    rake (12.3.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -40,4 +40,4 @@ DEPENDENCIES
   rake (>= 10.0)
 
 BUNDLED WITH
-   1.17.3
+   2.0.2

data/README.md

@@ -8,6 +8,8 @@ Extension for `ActiveRecord` that adds support for `PostgreSQL` array columns, m
 
 ## Usage
 
+### 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.
 
@@ -26,12 +28,29 @@ 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]
 ```
 
-## Development
+### Subset Validator
+
+Additionally `subset` validator is provided that can help to ensure correct values are passed during validation.
+
+```ruby
+class CreateUser
+  include ActiveModel::Model
+
+  attr_accessor :favourite_colors
 
-[![Build Status](https://travis-ci.com/freeletics/array_enum.svg?branch=master)](https://travis-ci.com/freeletics/array_enum)
+  validates :favourite_colors, subset: ["green", "blue"]
+  # or:
+  # validates :favourite_colors, subset: { in: ->(record) { Color.pluck(:name) } }
+end
+
+CreateUser.new(favourite_colors: ["black"]).valid? # => false
+```
+
+## Development
 
 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.
 

data/array_enum.gemspec

@@ -33,6 +33,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.3"
+
+  spec.add_dependency "activemodel"
+
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "pg"
   spec.add_development_dependency "bundler", ">= 1.17"

data/lib/array_enum.rb

@@ -1,21 +1,37 @@
 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
+  private_constant :MISSING_VALUE_MESSAGE
+
   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(attr_name.to_s.pluralize) do
+        mapping_hash
+      end
 
       define_singleton_method("with_#{attr_name}".to_sym) do |values|
-        db_values = Array(values).map { |value| mapping.fetch(value.to_s) }
+        db_values = Array(values).map do |value|
+          mapping_hash[value] || raise(ArgumentError, MISSING_VALUE_MESSAGE % {value: value, attr: attr_name})
+        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 { |value| mapping.fetch(value.to_s) }.uniq
+        self[attr_symbol] = Array(values).map do |value|
+          mapping_hash[value] || raise(ArgumentError, MISSING_VALUE_MESSAGE % {value: value, attr: attr_name})
+        end.uniq
       end
     end
   end

data/lib/array_enum/railtie.rb

@@ -0,0 +1,8 @@
+require "rails/railtie"
+
+class ArrayEnum::Railtie < Rails::Railtie
+  initializer "array_enum.subset_validator" do
+    # ActiveModel expects top level class name for validator to have syntax "validates subset: []"
+    ::SubsetValidator = ArrayEnum::SubsetValidator unless defined?(::SubsetValidator)
+  end
+end

data/lib/array_enum/subset_validator.rb

@@ -0,0 +1,20 @@
+require "active_model/validator"
+
+class ArrayEnum::SubsetValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    wrapped_value = [value].flatten # Handles nil value
+    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))
+    end
+  end
+
+  private
+
+  def delimiter
+    @delimiter ||= options[:in] || options[:within]
+  end
+end

data/lib/array_enum/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: array_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Wojciech Wnętrzak
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -89,8 +103,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -100,6 +114,8 @@ files:
 - bin/console
 - bin/setup
 - lib/array_enum.rb
+- lib/array_enum/railtie.rb
+- lib/array_enum/subset_validator.rb
 - lib/array_enum/version.rb
 homepage: https://github.com/freeletics/array_enum
 licenses:
@@ -107,7 +123,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
@@ -115,15 +131,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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