active_model_validators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61e6ec307e6ea3098d03cad4856de654fe1a2961
+  data.tar.gz: 4dd44eab4a2e3803bf478edd82d4789700e9f498
+SHA512:
+  metadata.gz: e862af0adebbc890ded460477ec2f7b1db4a5376387d573b88c7e294f2ed811512ac8d048d0d38e848a636688f9ba2223055a70d31f539bdbd71f730551d095d
+  data.tar.gz: d5e96ac6c19be4200c475cc6cf88de16bbeedcb803270354b7aac4157c69a9f1e63cfebc6fa278581c4a37c69019f6c1d9777ad292b6ed6b4a5896fef528b82f

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018 OnApp Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,55 @@
+<!-- [gem]: [TODO] -->
+[travis]: https://travis-ci.org/OnApp/active_model_validators
+
+# ActiveModelValidators
+
+<!-- [![Gem Version](TODO)][gem] -->
+[![Build Status](https://travis-ci.org/OnApp/active_model_validators.svg?branch=master)][travis]
+
+### Installation
+Add the following code to your `Gemfile`
+
+```ruby
+# Gemfile
+gem 'active_model_validators'
+```
+and run `bundle install`
+
+### Incuded validators:
+  Email validator, Url validator, Immutability validator, NumericArray validator.
+
+### Usage
+
+```ruby
+class Model < ActiveRecord::Base
+  validates :my_email, :'active_model_validators/email' => true
+  # my_model_instance = MyModel.create(my_email: 'valid@email.com')
+  # my_model_instance.valid? # => true
+  # my_model_instance.my_email = 'invalid email'
+  # my_model_instance.valid? # => false
+
+  validates :my_immutable_attribute, :'active_model_validators/immutability' => true
+  # my_model_instance = MyModel.create(my_immutable_attribute: 'foo')
+  # my_model_instance.my_immutable_attribute = 'bar'
+  # my_model_instance.valid? # => false
+
+  validates :my_atribute_with_array, :'active_model_validators/numeric_array' => true
+  # my_model_instance = MyModel.create(my_attribute_with_array: [1,2,3])
+  # my_model_instance.valid? # => true
+  # my_model_instance.my_attribute_with_array = 'I am not an array'
+  # my_model_instance.valid? # => false
+
+  validates :my_url_attribue, :'active_model_validators/url' => true
+  # by default it works with +http+ and +https+
+  # It can be easily extended with +protocols+ param
+  # :'active_model_validators/url' => { protocols: [URI::HTTP, URI::HTTPS, URI::FTP] }
+  # valid_url = 'https://www.valid.com'
+  # my_model_instance = MyModel.create(my_url_attribue: valid_url)
+  # my_model_instance.valid? # => true
+  # my_model_instance.my_url_attribue = 'invalid url'
+  # my_model_instance.valid? # => false
+end
+```
+
+### Licence
+See [`LICENSE`](LICENSE) file.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/lib/active_model_validators.rb

@@ -0,0 +1,6 @@
+require 'active_model'
+
+require_relative 'active_model_validators/email_validator'
+require_relative 'active_model_validators/url_validator'
+require_relative 'active_model_validators/immutability_validator'
+require_relative 'active_model_validators/numeric_array_validator'

data/lib/active_model_validators/email_validator.rb

@@ -0,0 +1,24 @@
+module ActiveModelValidators #:nodoc:
+
+  # == Email addresses validator
+  class EmailValidator < ::ActiveModel::EachValidator
+
+    # Regular expression used for validation
+    #   EMAIL_ADDRESS_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+    EMAIL_ADDRESS_REGEX = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+
+    # * +record+ - ActiveRecord model
+    # * +attr+   - model attribute where email address will be stored
+    # * +value+  - entered email address
+    #
+    # ==== Example
+    #   class Model < ActiveRecord::Base
+    #     validates :my_email, :'active_model_validators/email' => true
+    #   end
+    def validate_each(record, attr, value)
+      unless value =~ EMAIL_ADDRESS_REGEX
+        record.errors.add(attr, :invalid)
+      end
+    end
+  end
+end

data/lib/active_model_validators/immutability_validator.rb

@@ -0,0 +1,28 @@
+module ActiveModelValidators #:nodoc:
+
+  # == Attributes immutability validator
+  class ImmutabilityValidator < ActiveModel::EachValidator
+
+    # Adds error if there an attempt to change an immutable attribute
+    #
+    # * +record+ - ActiveRecord model
+    # * +attr+   - model attribute which is supposed to be immutable
+    # * +value+  - value
+    #
+    # ==== Example
+    #   class Model < ActiveRecord::Base
+    #     validates :my_atribute, :'active_model_validators/immutability' => true
+    #   end
+    #
+    #   my_model_instance = MyModel.create(my_attribute: 'foo')
+    #   my_model_instance.my_attribute = 'bar'
+    #   my_model_instance.valid? # => false
+    def validate_each(record, attribute, value)
+      return if record.new_record?
+
+      if record.public_send("#{attribute}_changed?")
+        record.errors.add(attribute, :immutability)
+      end
+    end
+  end
+end

data/lib/active_model_validators/numeric_array_validator.rb

@@ -0,0 +1,42 @@
+module ActiveModelValidators #:nodoc:
+
+  # == Validator of numerical array
+  class NumericArrayValidator < ActiveModel::EachValidator
+
+    # Adds error if there an attribute with not a numerical array provided
+    #
+    # * +record+ - ActiveRecord model
+    # * +attr+   - model attribute to store an array
+    # * +value+  - value, supposed to be a numerical array
+    #
+    # ==== Example
+    #   class MyModel < ActiveRecord::Base
+    #     validates :my_atribute, :'active_model_validators/numeric_array' => true
+    #   end
+    #
+    #   my_model_instance = MyModel.create(my_attribute: [1,2,3])
+    #   my_model_instance.valid? # => true
+    #   my_model_instance.my_attribute = 'bar'
+    #   my_model_instance.valid? # => false
+    def validate_each(record, attribute, value)
+      unless array_numeric?(value)
+        record.errors.add(attribute, options[:message] || numeric_message)
+      end
+    end
+
+    private
+
+    def array_numeric?(values) #:nodoc:
+      return false unless values.is_a? Array
+
+      values.all? { |value| value.is_a?(Integer) && value > 0 }
+    end
+
+    def numeric_message #:nodoc:
+      I18n.t(
+        'activerecord.errors.messages.not_numeric_array',
+        default: 'Should be an array of integers'
+      )
+    end
+  end
+end

data/lib/active_model_validators/url_validator.rb

@@ -0,0 +1,56 @@
+require 'uri'
+
+module ActiveModelValidators #:nodoc:
+
+  # == URL validator
+  class UrlValidator < ::ActiveModel::EachValidator
+    # Default protocols used for validation if no custom protocols provided
+    #    DEFAULT_PROTOCOLS = [::URI::HTTP, ::URI::HTTPS]
+    DEFAULT_PROTOCOLS = [::URI::HTTP, ::URI::HTTPS].freeze
+
+    # Adds error if there is invalid URL address.
+    #
+    # By default it works with +http+ and +https+.
+    #
+    # It can be easily extended with protocols param
+    #
+    # * +record+ - ActiveRecord model
+    # * +attr+   - model attribute to store an URL
+    # * +value+  - value, supposed to be a valid URL-adress
+    #
+    # ==== Example
+    #
+    #   class MyModel < ActiveRecord::Base
+    #     # default usage
+    #     validates :my_url, :'active_model_validators/url' => true
+    #   end
+    #
+    #   class MyModel < ActiveRecord::Base
+    #     # with custom URL protocols
+    #     validates :my_url, :'active_model_validators/url' => { protocols: [URI::HTTP, URI::HTTPS, URI::FTP] }
+    #   end
+    #
+    #   valid_url = 'https://www.valid.com'
+    #   my_model_instance = MyModel.create(my_url: valid_url)
+    #   my_model_instance.valid? # => true
+    #   my_model_instance.my_attribute = 'invalid_url'
+    #   my_model_instance.valid? # => false
+    def validate_each(record, attribute, value)
+      record.errors.add(attribute, error_message) unless url_valid?(value)
+    end
+
+    private
+
+    def url_valid?(url) #:nodoc:
+      options.fetch(:protocols, DEFAULT_PROTOCOLS).any? { |type| URI.parse(url).kind_of?(type) }
+    rescue URI::InvalidURIError
+      false
+    end
+
+    def error_message #:nodoc:
+      options.fetch(:message) do
+        I18n.t('activerecord.errors.messages.url', default: 'must be valid URL')
+      end
+    end
+  end
+end

data/lib/active_model_validators/version.rb

@@ -0,0 +1,3 @@
+module ActiveModelValidators #:nodoc:
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: active_model_validators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OnApp Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-09 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: rspec
+  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: OnApp ActiveModel validators.
+email: support@onapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_model_validators.rb
+- lib/active_model_validators/email_validator.rb
+- lib/active_model_validators/immutability_validator.rb
+- lib/active_model_validators/numeric_array_validator.rb
+- lib/active_model_validators/url_validator.rb
+- lib/active_model_validators/version.rb
+homepage: https://github.com/OnApp/active_model_validators
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A small handy library to validate active_record models
+test_files: []