validators 3.0.5 → 3.1.0

data/lib/validators/locale/en.yml

@@ -0,0 +1,27 @@
+---
+en:
+  activemodel: &activemodel
+    errors:
+      messages:
+        disposable_email: "is not allowed (high-bounce domain)"
+        invalid_cnpj: "is not a valid CNPJ"
+        invalid_cpf: "is not a valid CPF"
+        invalid_date: "is not a valid date"
+        invalid_date_after: "needs to be after %{date}"
+        invalid_date_before: "needs to be before %{date}"
+        invalid_email: "is not a valid address"
+        invalid_hostname: "does not have a valid hostname"
+        invalid_ip_address: "is not a valid IP address"
+        invalid_ipv4_address: "is not a valid IPv4 address"
+        invalid_ipv6_address: "is not a valid IPv6 address"
+        invalid_owner: "is not associated with your user"
+        invalid_ssh_private_key: "is not a valid private SSH key"
+        invalid_ssh_private_key_bits: "needs to be at least %{required} bits; got %{value} bits instead"
+        invalid_ssh_private_key_type: "must be a %{value} key"
+        invalid_ssh_public_key: "is not a valid public SSH key"
+        invalid_url: "is not a valid address"
+        reserved_hostname: "%{value} is a reserved hostname"
+        reserved_username: "%{value} is a reserved username"
+
+  activerecord:
+    <<: *activemodel

data/lib/validators/locale/pt-BR.yml

@@ -0,0 +1,27 @@
+---
+pt-BR:
+  activemodel: &activemodel
+    errors:
+      messages:
+        disposable_email: "não é permitido (e-mail temporário)"
+        invalid_cnpj: "não é um CNPJ válido"
+        invalid_cpf: "não é um CPF válido"
+        invalid_date: "não é uma data válida"
+        invalid_date_after: "precisa ser depois de %{date}"
+        invalid_date_before: "precisa ser antes de %{date}"
+        invalid_email: "não parece ser um e-mail válido"
+        invalid_hostname: "não é um hostname válido"
+        invalid_ip_address: "não é um endereço IP válido"
+        invalid_ipv4_address: "não é um endereço IPv4 válido"
+        invalid_ipv6_address: "não é um endereço IPv6 válido"
+        invalid_owner: "não está associado ao seu usuário"
+        invalid_ssh_private_key: "não é uma chave privada de SSH válida"
+        invalid_ssh_private_key_bits: "precisa ter pelo menos %{required} bits; a sua chave tem %{value} bits"
+        invalid_ssh_private_key_type: "precisa ser uma chave %{value}"
+        invalid_ssh_public_key: "não é uma chave pública de SSH válida"
+        invalid_url: "não parece ser uma URL válida"
+        reserved_hostname: "%{value} é um hostname reservado"
+        reserved_username: "%{value} é nome de usuário reservado"
+
+  activerecord:
+    <<: *activemodel

data/lib/validators/reserved_hostnames.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Validators
+  class ReservedHostnames
+    FILE_PATH = File.expand_path("../../data/reserved_hostnames.json", __dir__)
+
+    def self.reserved?(hostname, matchers = nil)
+      matchers = parse_list(matchers) if matchers
+      matchers ||= all
+      match_any?(matchers, hostname)
+    end
+
+    def self.all
+      @all ||= JSON
+               .parse(File.read(FILE_PATH))
+               .map {|matcher| parse(matcher) }
+    end
+
+    def self.parse(matcher)
+      return matcher unless matcher.start_with?("/")
+
+      Regexp.compile(matcher[%r{/(.*?)/}, 1])
+    end
+
+    def self.parse_list(matchers)
+      matchers.map {|matcher| parse(matcher) }
+    end
+
+    def self.match_any?(matchers, hostname)
+      hostname = normalize(hostname)
+      matchers.any? {|matcher| match?(matcher, hostname) }
+    end
+
+    def self.normalize(hostname)
+      hostname.downcase.gsub(/[_-]/, "")
+    end
+
+    def self.match?(matcher, hostname)
+      case matcher
+      when String
+        matcher == hostname
+      when Regexp
+        hostname =~ matcher
+      else
+        raise "Unknown matcher type: #{matcher.class}"
+      end
+    end
+  end
+end

data/lib/validators/validates_reserved_hostname.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    class ReservedHostnameValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank? && options[:allow_blank]
+        return if value.nil? && options[:allow_nil]
+        return unless reserved?(value.to_s)
+
+        record.errors.add(
+          attribute,
+          :"reserved_#{options[:error_name]}",
+          message: options[:message],
+          value: value
+        )
+      end
+
+      def reserved?(subdomain)
+        ::Validators::ReservedHostnames.reserved?(subdomain, options[:in])
+      end
+    end
+
+    module ClassMethods
+      # Validates whether or not the specified hostname is valid.
+      # The `in: array` can have strings and patterns. A pattern is everything
+      # that starts with `/` and will be parsed as a regular expression.
+      #
+      # Notice that subdomains will be normalized; it'll be downcased and have
+      # its underscores and hyphens stripped.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_reserved_hostname :site
+      #
+      #     # Validates against a custom list.
+      #     validates_reserved_hostname :site, in: %w[www]
+      #   end
+      #
+      def validates_reserved_hostname(*attr_names)
+        options = _merge_attributes(attr_names).merge(error_name: :hostname)
+        validates_with ReservedHostnameValidator, options
+      end
+    end
+  end
+end

data/lib/validators/validates_reserved_username.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    class ReservedUsernameValidator < ReservedHostnameValidator
+    end
+
+    module ClassMethods
+      # Validates whether or not the specified username is valid.
+      # The `in: array` can have strings and patterns. A pattern is everything
+      # that starts with `/` and will be parsed as a regular expression.
+      #
+      # Notice that subdomains will be normalized; it'll be downcased and have
+      # its underscores and hyphens stripped.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_reserved_hostname :site
+      #
+      #     # Validates against a custom list.
+      #     validates_reserved_hostname :site, in: %w[www]
+      #   end
+      #
+      def validates_reserved_username(*attr_names)
+        options = _merge_attributes(attr_names).merge(error_name: :username)
+        validates_with ReservedHostnameValidator, options
+      end
+    end
+  end
+end

data/lib/validators/version.rb

@@ -3,8 +3,8 @@
 module Validators
   module Version
     MAJOR = 3
-    MINOR = 0
-    PATCH = 5
+    MINOR = 1
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/validators.rb

@@ -8,6 +8,8 @@ module Validators
   require "validators/tld"
   require "validators/hostname"
   require "validators/disposable_hostnames"
+  require "validators/reserved_hostnames"
+
   require "validators/validates_datetime"
   require "validators/validates_ip_address"
   require "validators/validates_email_format_of"
@@ -18,4 +20,8 @@ module Validators
   require "validators/validates_ssh_private_key"
   require "validators/validates_ssh_public_key"
   require "validators/validates_hostname_format_of"
+  require "validators/validates_reserved_hostname"
+  require "validators/validates_reserved_username"
+
+  I18n.load_path += Dir[File.join(__dir__, "validators/locale/*.yml")]
 end

data/test/support/models.rb

@@ -1,5 +1,17 @@
 # frozen_string_literal: true
 
+def build_model(&block)
+  Class.new do
+    include ActiveModel::Model
+
+    def self.name
+      "SomeModel"
+    end
+
+    instance_eval(&block)
+  end
+end
+
 class User < ActiveRecord::Base
   has_many :tasks
   has_many :categories

data/test/test_helper.rb

@@ -1,16 +1,9 @@
 # frozen_string_literal: true
 
-require "simplecov"
-require "simplecov-console"
-
-SimpleCov.minimum_coverage 100
-SimpleCov.minimum_coverage_by_file 100
-SimpleCov.refuse_coverage_drop
+$VERBOSE = nil
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::Console,
-  SimpleCov::Formatter::HTMLFormatter
-])
+require "simplecov"
+SimpleCov.start
 
 SimpleCov.start do
   add_filter "test/support"
@@ -33,9 +26,6 @@ Dir[File.join(__dir__, "support/**/*.rb")].sort.each {|f| require f }
 ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 load "schema.rb"
 
-I18n.enforce_available_locales = false
-I18n.load_path << File.join(__dir__, "support/translations.yml")
-
 module Minitest
   class Test
     setup do

data/test/validators/disposable_email_test.rb

@@ -21,7 +21,8 @@ class DisposableEmailTest < Minitest::Test
       user = User.new(email: "user@custom.#{domain}")
       user.valid?
 
-      assert_includes user.errors[:email], I18n.t("activerecord.errors.messages.disposable_email")
+      assert_includes user.errors[:email],
+                      "is not allowed (high-bounce domain)"
     end
   end
 

data/test/validators/validates_reserved_hostname_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ValidatesReservedHostnameTest < Minitest::Test
+  test "rejects reserved hostname" do
+    model = build_model do
+      attr_accessor :hostname
+      validates_reserved_hostname :hostname
+    end
+
+    instance = model.new(hostname: "www")
+
+    refute instance.valid?
+    assert_includes instance.errors[:hostname],
+                    "www is a reserved hostname"
+  end
+
+  test "rejects reserved hostname with pattern" do
+    model = build_model do
+      attr_accessor :hostname
+      validates_reserved_hostname :hostname
+    end
+
+    instance = model.new(hostname: "www1234")
+
+    refute instance.valid?
+  end
+
+  test "uses custom list" do
+    model = build_model do
+      attr_accessor :hostname
+      validates_reserved_hostname :hostname, in: %w[nope]
+    end
+
+    instance = model.new(hostname: "nope")
+
+    refute instance.valid?
+  end
+end

data/test/validators/validates_reserved_username_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ValidatesReservedUsernameTest < Minitest::Test
+  test "rejects reserved username" do
+    model = build_model do
+      attr_accessor :username
+      validates_reserved_username :username
+    end
+
+    instance = model.new(username: "www")
+
+    refute instance.valid?
+    assert_includes instance.errors[:username],
+                    "www is a reserved username"
+  end
+
+  test "rejects reserved username with pattern" do
+    model = build_model do
+      attr_accessor :username
+      validates_reserved_username :username
+    end
+
+    instance = model.new(username: "www1234")
+
+    refute instance.valid?
+  end
+
+  test "uses custom list" do
+    model = build_model do
+      attr_accessor :username
+      validates_reserved_username :username, in: %w[nope]
+    end
+
+    instance = model.new(username: "nope")
+
+    refute instance.valid?
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validators
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -196,12 +196,16 @@ files:
 - bin/sync-disposable-hostnames
 - bin/sync-tld
 - data/disposable.json
+- data/reserved_hostnames.json
 - data/tld.json
 - lib/validators.rb
 - lib/validators/constants.rb
 - lib/validators/disposable_hostnames.rb
 - lib/validators/hostname.rb
 - lib/validators/ip.rb
+- lib/validators/locale/en.yml
+- lib/validators/locale/pt-BR.yml
+- lib/validators/reserved_hostnames.rb
 - lib/validators/tld.rb
 - lib/validators/validates_cnpj_format_of.rb
 - lib/validators/validates_cpf_format_of.rb
@@ -210,6 +214,8 @@ files:
 - lib/validators/validates_hostname_format_of.rb
 - lib/validators/validates_ip_address.rb
 - lib/validators/validates_ownership_of.rb
+- lib/validators/validates_reserved_hostname.rb
+- lib/validators/validates_reserved_username.rb
 - lib/validators/validates_ssh_private_key.rb
 - lib/validators/validates_ssh_public_key.rb
 - lib/validators/validates_url_format_of.rb
@@ -220,7 +226,6 @@ files:
 - test/support/hostnames.rb
 - test/support/ips.rb
 - test/support/models.rb
-- test/support/translations.yml
 - test/support/urls.rb
 - test/test_helper.rb
 - test/validators/disposable_email_test.rb
@@ -237,6 +242,8 @@ files:
 - test/validators/validates_ip_address/ipv6_test.rb
 - test/validators/validates_ip_address_test.rb
 - test/validators/validates_ownership_of_test.rb
+- test/validators/validates_reserved_hostname_test.rb
+- test/validators/validates_reserved_username_test.rb
 - test/validators/validates_ssh_private_key/bits_test.rb
 - test/validators/validates_ssh_private_key/common_test.rb
 - test/validators/validates_ssh_private_key/dsa_test.rb
@@ -275,7 +282,6 @@ test_files:
 - test/support/hostnames.rb
 - test/support/ips.rb
 - test/support/models.rb
-- test/support/translations.yml
 - test/support/urls.rb
 - test/test_helper.rb
 - test/validators/disposable_email_test.rb
@@ -292,6 +298,8 @@ test_files:
 - test/validators/validates_ip_address/ipv6_test.rb
 - test/validators/validates_ip_address_test.rb
 - test/validators/validates_ownership_of_test.rb
+- test/validators/validates_reserved_hostname_test.rb
+- test/validators/validates_reserved_username_test.rb
 - test/validators/validates_ssh_private_key/bits_test.rb
 - test/validators/validates_ssh_private_key/common_test.rb
 - test/validators/validates_ssh_private_key/dsa_test.rb

data/test/support/translations.yml

@@ -1,39 +0,0 @@
-en:
-  activerecord: &activerecord
-    errors:
-      messages:
-        record_invalid: "Errors: %{errors}"
-        invalid_date: "is not a valid date"
-        invalid_date_before: "needs to be before %{date}"
-        invalid_date_after: "needs to be after %{date}"
-        invalid_email: "is not a valid address"
-        invalid_url: "is not a valid address"
-        invalid_ipv4_address: "is not a valid IPv4 address"
-        invalid_ipv6_address: "is not a valid IPv6 address"
-        invalid_address: "is not a valid IP address"
-        invalid_owner: "is not associated with your user"
-        invalid_cpf: "is not a valid CPF"
-        invalid_cnpj: "is not a valid CNPJ"
-        disposable_email: "is not allowed (high-bounce domain)"
-        invalid_hostname: "does not have a valid hostname"
-
-  activemodel:
-    <<: *activerecord
-
-pt-BR:
-  activerecord: &activerecord
-    errors:
-      messages:
-        record_invalid: "Erros: %{errors}"
-        invalid_email: "não parece ser um e-mail válido"
-        invalid_url: "não parece ser uma URL válida"
-        invalid_owner: "não está associado ao seu usuário"
-        invalid_cpf: "não é um CPF válido"
-        invalid_cnpj: "não é um CNPJ válido"
-        invalid_ssh_public_key: "não é uma chave pública de SSH válida"
-        invalid_ssh_private_key: "não é uma chave privada de SSH válida"
-        invalid_ssh_private_key_type: "precisa ser uma chave %{value}"
-        invalid_ssh_private_key_bits: "precisa ter pelo menos %{required} bits; a sua chave tem %{value} bits"
-
-  activemodel:
-    <<: *activerecord