array_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b026957a9197f90b480fdcb3a9202b13e42f6e89
+  data.tar.gz: c8e2997b85250c3ccffdc08ccd90ce5c485212a2
+SHA512:
+  metadata.gz: bc40bfd0ca9c205f81d0244f80854cd37ab8e0ebac1b924ccc3f378623d6cf9c13a5d6fdf80f59c0b1131847a99ce1b83c16c85a96c13360b84b346937e63305
+  data.tar.gz: 209f8e6efb556d6ad27f517e2e42c9ce6e384f62425c45b3fc6496b3c05956859298a28221b06e1784c42066660a951a4bf84b83c1e99744feb075409467acb7

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at damir.svrtan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Damir Svrtan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# ArrayValidator
+
+ActiveModel Validations for array attributes (e.g. Postgres JSONB).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'array_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Validate the content of the array is a subset of a predefined list:
+
+```ruby
+class Plant < ActiveRecord::Base
+  validates :categories, array: { subset_of: ['trees', 'flowers'] }
+end
+```
+
+Don't allow duplicates:
+
+```ruby
+class Plant < ActiveRecord::Base
+  validates :watering_times, array: { subset_of: ['trees', 'flowers'], duplicates: false }
+end
+```
+
+Validate each element matches a format:
+
+```ruby
+class Plant < ActiveRecord::Base
+  HH_MM_REGEX = /(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]/
+  validates :watering_times, array: { format: HH_MM_REGEX }
+end
+```
+
+## TODO
+
+- array elements are sorted
+- length of the array
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the `gemspec`, 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/array_validator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/array_validator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'array_validator'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Damir Svrtan']
+  spec.email         = ['damir.svrtan@gmail.com']
+
+  spec.summary       = 'Array validations for Rails'
+  spec.description   = 'Array validations for Rails (e.g. Postgres jsonb columns)'
+  spec.homepage      = 'https://github.com/infinum/array_validator'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '~> 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "array_validator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/array_validator.rb

@@ -0,0 +1,53 @@
+require 'active_model'
+require 'active_support/i18n'
+I18n.load_path += Dir[File.dirname(__FILE__) + "/locale/*.yml"]
+
+class ArrayValidator < ActiveModel::EachValidator
+  I18N_SCOPE = 'activerecord.errors.messages.array'.freeze
+
+  def validate_each(record, attribute, values)
+    unless values.is_a? Array
+      record.errors[attribute] << (options[:message] || 'is not an array')
+      return
+    end
+
+    check_subset(record, attribute, values) if options[:subset_of].present?
+    check_format(record, attribute, values) if options[:format].present?
+    check_duplicates(record, attribute, values) if options[:duplicates] == false
+  end
+
+  private
+
+  def check_subset(record, attribute, values)
+    unlisted_values = values - options[:subset_of]
+    return if unlisted_values.empty?
+
+    record.errors[attribute] << subset_error_message(unlisted_values)
+  end
+
+  def subset_error_message(unlisted_values)
+    I18n.t('subset_of', scope: I18N_SCOPE, invalid_values: unlisted_values.join(', '))
+  end
+
+  def check_format(record, attribute, values)
+    invalid_values = values.select { |value| value !~ options[:format] }
+    return if invalid_values.empty?
+
+    record.errors[attribute] << format_error_message(invalid_values)
+  end
+
+  def format_error_message(invalid_values)
+    I18n.t('format', scope: I18N_SCOPE, invalid_values: invalid_values.join(', '))
+  end
+
+  def check_duplicates(record, attribute, values)
+    duplicates = values.select { |value| values.count(value) > 1 }.uniq
+    return if duplicates.none?
+
+    record.errors[attribute] << duplicates_error_message(duplicates)
+  end
+
+  def duplicates_error_message(duplicates)
+    I18n.t('duplicates', scope: I18N_SCOPE, invalid_values: duplicates.join(', '))
+  end
+end

data/lib/array_validator/subset_validator.rb

@@ -0,0 +1,18 @@
+class ArrayValidator
+  module SubsetValidator
+    def self.call(record, attribute, values, options)
+      return if options[:subset_of].nil?
+
+      unlisted_values = values - options[:subset_of]
+      return if unlisted_values.empty?
+
+      error_message = if unlisted_values.size == 1
+                        "#{unlisted_values.first} is not in the list"
+                      else
+                        "#{unlisted_values.join(', ')} are not in the list"
+                      end
+
+      record.errors[attribute] << error_message
+    end
+  end
+end

data/lib/locale/en.yml

@@ -0,0 +1,8 @@
+en:
+  activerecord:
+    errors:
+      messages:
+        array:
+          subset_of: 'has invalid values: %{invalid_values}'
+          format: 'not in a valid format: %{invalid_values}'
+          duplicates: 'has duplicates: %{invalid_values}'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: array_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damir Svrtan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Array validations for Rails (e.g. Postgres jsonb columns)
+email:
+- damir.svrtan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- array_validator.gemspec
+- bin/console
+- bin/setup
+- lib/array_validator.rb
+- lib/array_validator/subset_validator.rb
+- lib/locale/en.yml
+homepage: https://github.com/infinum/array_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Array validations for Rails
+test_files: []