validates_im 1.1.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cfe1d609f713d30dcf5b90085dab8637eab5698c0f6e4353339a2dc6665837c
+  data.tar.gz: 6c88205ae65806151b99b58825268ccb6e8b6be226ab0060438c116ec8c93f65
+SHA512:
+  metadata.gz: 90b9c447eedb4d79e1d03b61b3a9eaf9c8db9a1a8258461235b83a769223836fc7b160044d239a38f42187b7c643117bb77e55c0caeeab74dcbed8d521ee2fb1
+  data.tar.gz: c0a71cc4bcedc20b4d693afa6e989377219df7d365fb75e1c7576bb60803304ec306559f59dd7ed127522146d1b3bd3be5901013c07a389b1da98522913e4543

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2026-05-14
+
+### Added
+- `DiscordValidator` (`discord: true`) — modern Discord usernames (2-32 chars,
+  `a-z0-9._`, no leading/trailing or consecutive periods, no discriminator).
+- `TelegramValidator` (`telegram: true`) — 5-32 chars, alphanumeric + underscore,
+  must start with a letter, cannot end with `_`. Optional leading `@` is stripped.
+- `MatrixValidator` (`matrix: true`) — full Matrix user ID syntax
+  (`@localpart:domain.tld`) per the current Matrix specification; max 255 chars.
+- `SignalValidator` (`signal: true`) — Signal usernames (2024+), of the form
+  `<base>.<digits>` with a 2+ digit discriminator.
+- `min_length 3` / `max_length 12` on `XboxLiveValidator` so empty / overlong
+  gamertags now produce sensible errors instead of crashing on `nil[0]`.
+- Modern, hand-written gemspec with `rubygems_mfa_required` metadata.
+- `lib/validates_im/version.rb` exposing `ValidatesIm::VERSION`.
+- GitHub Actions matrix CI across Ruby 3.1-3.4 and ActiveModel 7.0-8.0.
+
+### Changed
+- Validator regex anchors use `\A` and `\z` instead of `^` and `$`, closing a
+  multi-line bypass where an embedded newline would cause obviously-invalid
+  values to pass.
+- Bumped minimum supported Ruby to 3.1, minimum ActiveModel/ActiveSupport to 6.1.
+- Replaced the activerecord runtime dependency with `activemodel` (and
+  `activesupport`); the gem never required ActiveRecord.
+- Replaced jeweler-driven packaging with a standard gemspec, `bin/console`,
+  `bin/setup`, modern `Gemfile` / `Rakefile`.
+
+### Fixed
+- `lib/validates_im.rb` no longer self-requires itself in an infinite loop.
+- Removed duplicate `add_dependency` entries (activerecord, rspec, yard, jeweler)
+  and stale `README.textile` references in the gemspec.
+- Gemfile now declares `redcarpet` consistently with the Rakefile's YARD setup
+  (previous mismatch with `RedCloth` in the gemspec).
+
+### Removed
+- Jeweler-managed gemspec template / `VERSION` text file.
+- The legacy `.travis.yml` and old `ruby.yml` workflow (superseded by `ci.yml`).
+
+## [1.1.0]
+
+Previous release. See git history.

data/README.md

@@ -0,0 +1,109 @@
+validates_im
+============
+
+[![CI](https://github.com/RISCfuture/validates_im/actions/workflows/ci.yml/badge.svg)](https://github.com/RISCfuture/validates_im/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/validates_im.svg)](https://rubygems.org/gems/validates_im)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+**Instant messenger account validators for ActiveModel / Rails**
+
+`validates_im` is a small gem that gives you a collection of
+`ActiveModel::EachValidator`s for common instant-messaging and gaming-service
+account names. Drop one onto an attribute and your model will reject malformed
+account IDs at validation time.
+
+Supported services
+------------------
+
+Modern services:
+
+| Validator              | DSL key       | Description                                                                  |
+|:-----------------------|:--------------|:-----------------------------------------------------------------------------|
+| `DiscordValidator`     | `discord:`    | Discord usernames (post-2023 format, no discriminator)                       |
+| `TelegramValidator`    | `telegram:`   | Telegram usernames (`@handle` style; leading `@` is stripped automatically)  |
+| `MatrixValidator`      | `matrix:`     | Matrix IDs of the form `@localpart:domain.tld` per the Matrix specification  |
+| `SignalValidator`      | `signal:`     | Signal usernames (`base.NN` with a 2+ digit discriminator)                   |
+| `SteamValidator`       | `steam:`      | Steam account IDs                                                            |
+| `XboxLiveValidator`    | `xbox_live:`  | Xbox Live gamertags                                                          |
+
+Legacy services (kept for backwards compatibility; these services are largely
+defunct):
+
+| Validator             | DSL key      | Description                          |
+|:----------------------|:-------------|:-------------------------------------|
+| `AimValidator`        | `aim:`       | AOL Instant Messenger screen names   |
+| `YahooImValidator`    | `yahoo_im:`  | Yahoo! Messenger screen names        |
+| `SkypeValidator`      | `skype:`     | Skype account names                  |
+
+Installation
+------------
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "validates_im"
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install validates_im
+```
+
+Requires Ruby 3.1+ and ActiveModel 6.1+. The gem works in any project that uses
+ActiveModel validations — Rails is not required, just ActiveModel.
+
+Usage
+-----
+
+The validators are standard `EachValidator`s. Use them via `validates`:
+
+```ruby
+class Account < ApplicationRecord
+  validates :discord_handle,  discord:   true, allow_blank: true
+  validates :telegram_handle, telegram:  true, allow_blank: true
+  validates :matrix_id,       matrix:    true, allow_blank: true
+  validates :signal_username, signal:    true, allow_blank: true
+  validates :steam_id,        steam:     true, allow_blank: true
+  validates :xbox_gamertag,   xbox_live: true, allow_blank: true
+end
+```
+
+The DSL key for a validator is its class name with the `Validator` suffix
+stripped and underscored — so `XboxLiveValidator` becomes `xbox_live:`.
+
+Each validator supports the usual `:allow_nil`, `:allow_blank`, and `:message`
+options. Error messages are localized via Rails i18n; the localization keys are
+documented in each validator's class comment.
+
+Writing your own validator
+--------------------------
+
+`AccountNameValidator` provides a small DSL for declarative account-name
+validators. To add a hypothetical "Talkalot" service:
+
+```ruby
+class TalkalotValidator < AccountNameValidator
+  min_length 5
+  max_length 64
+  valid_chars "A-Za-z0-9_"
+  first_char  "A-Za-z"
+
+  add_validation(:no_double_underscore) { |value| !value.include?("__") }
+end
+```
+
+For services whose IDs don't fit the simple "single account-name string" mould
+(like Matrix's full `@user:server.tld` syntax), subclass
+`ActiveModel::EachValidator` directly — see `MatrixValidator` for an example.
+
+License
+-------
+
+MIT. See `LICENSE`.

data/lib/account_name_validator.rb

@@ -1,4 +1,8 @@
-# Generic @EachValidator@ that validates account names on various communication
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/filters"
+
+# Generic `EachValidator` that validates account names on various communication
 # services such as Skype, Yahoo!, etc. This class provides a simple DSL for
 # describing valid account names on these sites, performing all validation for
 # you.
@@ -6,49 +10,51 @@
 # Subclass this class and use the provided DSL to describe account names on a
 # given site. An example for a fictional service called Talkalot:
 #
-# <pre><code>
+# ```` ruby
 # class TalkalotValidator < AccountNameValidator
 #   min_length 5
 #   max_length 64
 #   valid_chars "A-Z0-9_"
 # end
-# </code></pre>
+# ````
 #
 # With your validator defined you can now use it in your Active Record models
-# like any other @EachValidator@:
+# like any other `EachValidator`:
 #
-# <pre><code>
+# ```` ruby
 #   validates :talkalot_id,
 #             talkalot: true
-# </code></pre>
+# ````
 #
 # This class automatically handles the following options passed to the
-# @validates@ method:
+# `validates` method:
 #
-# | @:allow_nil@ | Allows @nil@ values. |
-# | @:message@ | Provide a custom error message. |
+# |              |                                 |
+# |:-------------|:--------------------------------|
+# | `:allow_nil` | Allows `nil` values.            |
+# | `:message`   | Provide a custom error message. |
 #
 # Error messages generated by this class are stored in the translation table.
 # The localization keys used are generated by the
-# @ActiveModel::Errors#generate_message@ method (see its documentation for more
+# `ActiveModel::Errors#generate_message` method (see its documentation for more
 # information). The lastmost element of the localization key is the error
 # message key. The error message key is a combination of a validator subclass's
 # {.error_key_prefix} and the error key suffix for a given constraint.
 #
 # By default the error key prefix is the underscored
 #
-# As an example, for the @TalkalotValidator@ example above, the error message
+# As an example, for the `TalkalotValidator` example above, the error message
 # key used in the event that a two-letter account name is given would be
-# @:talkalot_too_short@. If you wanted to override the prefix, you could do:
+# `:talkalot_too_short`. If you wanted to override the prefix, you could do:
 #
-# <pre><code>
+# ```` ruby
 # class TalkalotValidator < AccountNameValidator
 #   error_key_prefix :talky
 # end
-# </code></pre>
+# ````
 #
 # In this case the error message key for a two-letter account name would be
-# @:talky_too_short@. (You'd do this if Talkalot accounts were called "talkies,"
+# `:talky_too_short`. (You'd do this if Talkalot accounts were called "talkies,"
 # for example.)
 #
 # @abstract Subclass this validator to perform your specific account name
@@ -60,13 +66,12 @@ class AccountNameValidator < ActiveModel::EachValidator
 
   # @private
   def validate_each(record, attribute, value)
-    return if options[:allow_nil] and value.nil?
-    return if options[:allow_blank] and value.blank?
+    return if options[:allow_nil] && value.nil?
+    return if options[:allow_blank] && value.blank?
     return unless self.class.validations
-    self.class.validations.each { |block, key| record.errors.add(attribute, options[:message] || record.errors.generate_message(attribute, :"#{self.class.error_key_prefix}_#{key}")) if !block[value.to_s] }
-  end
 
-  protected
+    self.class.validations.each { |block, key| record.errors.add(attribute, options[:message] || record.errors.generate_message(attribute, :"#{self.class.error_key_prefix}_#{key}")) unless block[value.to_s] }
+  end
 
   # @overload error_key_prefix
   #   Returns the prefix for error message keys used by this class.
@@ -77,11 +82,9 @@ class AccountNameValidator < ActiveModel::EachValidator
   #   @param [Symbol] value The new error message key prefix.
 
   def self.error_key_prefix(value=nil)
-    if value then
-      @error_key_prefix = value
-    else
-      return @error_key_prefix || to_s.demodulize.sub(/Validator$/, '').underscore.to_sym
-    end
+    return @error_key_prefix || to_s.demodulize.sub(/Validator$/, "").underscore.to_sym unless value
+
+    @error_key_prefix = value
   end
 
   # Describes a custom restraint on account names.
@@ -89,12 +92,13 @@ class AccountNameValidator < ActiveModel::EachValidator
   # @param [Symbol] key The error message key suffix to use.
   # @yield [value] The custom validation.
   # @yieldparam [String] value The value to validate. This will have been
-  #   coerced into a @String@.
+  #   coerced into a `String`.
   # @yieldreturn [true, false] Whether or not the validation succeeded.
 
   def self.add_validation(key, &block)
-    return unless block_given?
-    self.validations += [[ block, key ]]
+    return unless block
+
+    self.validations += [[block, key]]
   end
 
   # Enforces a minimum length on account names. Uses the "too_short" error
@@ -122,7 +126,7 @@ class AccountNameValidator < ActiveModel::EachValidator
   #   format (e.g., "[A-Z0-9_]").
 
   def self.valid_chars(charlist)
-    add_validation(:invalid_chars) { |value| value =~ /^[#{charlist}]+$/ }
+    add_validation(:invalid_chars) { |value| value =~ /\A[#{charlist}]+\z/ }
   end
 
   # Enforces a valid set of characters for the first character of the account
@@ -132,6 +136,6 @@ class AccountNameValidator < ActiveModel::EachValidator
   #   format (e.g., "[A-Z0-9_]").
 
   def self.first_char(charlist)
-    add_validation(:invalid_first_char) { |value| value[0] =~ /^[#{charlist}]$/ }
+    add_validation(:invalid_first_char) { |value| value[0] =~ /\A[#{charlist}]\z/ }
   end
 end

data/lib/aim_validator.rb

@@ -1,25 +1,32 @@
+# frozen_string_literal: true
+
 # Validates AOL Instant Messenger screen names. According to the AOL website:
 #
-# bq. 3-16 letters or numbers. It must start with a letter.
+# > 3-16 letters or numbers. It must start with a letter.
 #
 # The following error message keys are used to localize invalid screen names:
 #
-# | @aim_too_short@ | Screen name is less than 3 characters. |
-# | @aim_too_long@ | Screen name is over 16 characters. |
-# | @aim_invalid_chars@ | Screen name contains invalid characters. |
-# | @aim_invalid_first_char@ | Screen name doesn't start with a letter. |
+# |                          |                                          |
+# |:-------------------------|:-----------------------------------------|
+# | `aim_too_short`          | Screen name is less than 3 characters.   |
+# | `aim_too_long`           | Screen name is over 16 characters.       |
+# | `aim_invalid_chars`      | Screen name contains invalid characters. |
+# | `aim_invalid_first_char` | Screen name doesn't start with a letter. |
 #
 # @example
 #   validates :aim_screen_name, aim: true
 #
-# h2. Options
+# Options
+# -------
 #
-# | @:message@ | A custom message to use if the email is invalid. |
-# | @:allow_nil@ | If true, @nil@ values are allowed. |
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the email is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
 
 class AimValidator < AccountNameValidator
   min_length 3
   max_length 16
-  valid_chars 'A-Za-z0-9'
-  first_char 'A-Za-z'
+  valid_chars "A-Za-z0-9"
+  first_char "A-Za-z"
 end

data/lib/discord_validator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Validates Discord usernames using the modern (post-2023) username format.
+# Discord eliminated the four-digit `#1234` discriminator system in 2023; usernames
+# are now globally unique and use the rules below:
+#
+# * 2-32 characters long
+# * Lowercase letters (`a`-`z`), digits (`0`-`9`), underscore (`_`), and period (`.`)
+# * No consecutive periods (`..`)
+# * Cannot start or end with a period
+#
+# The following error message keys are used to localize invalid usernames:
+#
+# |                              |                                                         |
+# |:-----------------------------|:--------------------------------------------------------|
+# | `discord_too_short`          | Username is less than 2 characters.                     |
+# | `discord_too_long`           | Username is over 32 characters.                         |
+# | `discord_invalid_chars`      | Username contains characters outside `[a-z0-9._]`.      |
+# | `discord_invalid_format`     | Username has consecutive periods or starts/ends with a period. |
+#
+# @example
+#   validates :discord, discord: true
+#
+# Options
+# -------
+#
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the username is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
+
+class DiscordValidator < AccountNameValidator
+  min_length 2
+  max_length 32
+  valid_chars "a-z0-9._"
+  add_validation(:invalid_format) do |value|
+    !value.include?("..") && !value.start_with?(".") && !value.end_with?(".")
+  end
+end

data/lib/matrix_validator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Validates Matrix user IDs in the form `@localpart:domain.tld` per the Matrix
+# specification (https://spec.matrix.org/latest/appendices/#user-identifiers).
+#
+# * Begins with `@`.
+# * Localpart consists of lowercase letters `a`-`z`, digits `0`-`9`, and any of
+#   `-`, `_`, `.`, `=`, `/`, `+`.
+# * `:` separator between the localpart and the server name (domain).
+# * The server name is a hostname (with optional port).
+# * The entire ID must be 255 characters or fewer.
+#
+# Historical Matrix IDs allowed additional characters in the localpart; this
+# validator enforces the current ("grammar") rules from the spec.
+#
+# The following error message keys are used to localize invalid IDs:
+#
+# |                          |                                       |
+# |:-------------------------|:--------------------------------------|
+# | `matrix_too_long`        | ID is over 255 characters.            |
+# | `matrix_invalid_format`  | ID does not match `@localpart:domain`. |
+#
+# @example
+#   validates :matrix_id, matrix: true
+#
+# Options
+# -------
+#
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the ID is invalid.    |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
+
+class MatrixValidator < ActiveModel::EachValidator
+  MAX_LENGTH = 255
+
+  # Localpart per the Matrix spec, restricted to the documented character set.
+  LOCALPART = %r{[a-z0-9._=/+\-]+}.freeze
+
+  # A reasonably-strict hostname or IP literal, optionally followed by `:port`.
+  HOSTNAME_LABEL = /[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?/.freeze
+  HOSTNAME = /#{HOSTNAME_LABEL}(?:\.#{HOSTNAME_LABEL})*/.freeze
+  IPV4 = /(?:\d{1,3}\.){3}\d{1,3}/.freeze
+  IPV6 = /\[[0-9A-Fa-f:.]+\]/.freeze
+  SERVERNAME = /(?:#{IPV6}|#{IPV4}|#{HOSTNAME})(?::\d{1,5})?/.freeze
+
+  FORMAT = /\A@#{LOCALPART}:#{SERVERNAME}\z/.freeze
+
+  def validate_each(record, attribute, value)
+    return if options[:allow_nil] && value.nil?
+    return if options[:allow_blank] && value.blank?
+
+    str = value.to_s
+
+    if str.length > MAX_LENGTH
+      record.errors.add(attribute, options[:message] || record.errors.generate_message(attribute, :matrix_too_long))
+    end
+
+    unless str.match?(FORMAT)
+      record.errors.add(attribute, options[:message] || record.errors.generate_message(attribute, :matrix_invalid_format))
+    end
+  end
+end

data/lib/signal_validator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Validates Signal usernames. Signal introduced usernames in 2024; they consist
+# of a base name and a numeric discriminator separated by a period:
+#
+#   <base>.<digits>
+#
+# * Base: starts with a letter, contains letters, digits, and underscores.
+# * Discriminator: two or more digits (leading zeros allowed, e.g. `0123`).
+# * Combined length 3-32 characters (matching Signal's UI constraints).
+#
+# The following error message keys are used to localize invalid usernames:
+#
+# |                              |                                                                |
+# |:-----------------------------|:---------------------------------------------------------------|
+# | `signal_too_short`           | Username is less than 3 characters.                            |
+# | `signal_too_long`            | Username is over 32 characters.                                |
+# | `signal_invalid_format`      | Username doesn't match `<base>.<digits>` with a valid base.    |
+#
+# @example
+#   validates :signal_username, signal: true
+#
+# Options
+# -------
+#
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the username is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
+
+class SignalValidator < AccountNameValidator
+  FORMAT = /\A[A-Za-z][A-Za-z0-9_]*\.\d{2,}\z/.freeze
+
+  min_length 3
+  max_length 32
+  add_validation(:invalid_format) { |value| value.match?(FORMAT) }
+end

data/lib/skype_validator.rb

@@ -1,26 +1,33 @@
+# frozen_string_literal: true
+
 # Validates Skype screen names. From the Skype website:
 #
-# bq. It must be between 6-32 characters, start with a letter and contain only
-# letters and numbers (no spaces or special characters).
+# > It must be between 6-32 characters, start with a letter and contain only
+# > letters and numbers (no spaces or special characters).
 #
 # The following error message keys are used to localize invalid screen names.
 #
-# | @skype_too_short@ | Skype name is less than 6 characters. |
-# | @skype_too_long@ | Skype name is over 32 characters. |
-# | @skype_invalid_chars@ | Skype name contains invalid characters. |
-# | @skype_invalid_first_char@ | Skype name doesn't start with a letter. |
+# |                            |                                         |
+# |:---------------------------|:----------------------------------------|
+# | `skype_too_short`          | Skype name is less than 6 characters.   |
+# | `skype_too_long`           | Skype name is over 32 characters.       |
+# | `skype_invalid_chars`      | Skype name contains invalid characters. |
+# | `skype_invalid_first_char` | Skype name doesn't start with a letter. |
 #
 # @example
 #   validates :skype_name, skype: true
 #
-# h2. Options
+# Options
+# -------
 #
-# | @:message@ | A custom message to use if the email is invalid. |
-# | @:allow_nil@ | If true, @nil@ values are allowed. |
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the email is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
 
 class SkypeValidator < AccountNameValidator
   min_length 6
   max_length 32
-  valid_chars 'A-Za-z0-9'
-  first_char 'A-Za-z'
+  valid_chars "A-Za-z0-9"
+  first_char "A-Za-z"
 end

data/lib/steam_validator.rb

@@ -1,18 +1,29 @@
+# frozen_string_literal: true
+
 # Validates steam account IDs. Steam IDs are between 3 and 63 characters long
 # and consist of letters, numbers, or underscores.
 #
 # The following error message keys are used to localize invalid screen names.
 #
-# | @steam_too_short@ | Steam ID is less than 6 characters. |
-# | @steam_too_long@ | Steam ID is over 32 characters. |
-# | @steam_invalid_chars@ | Steam ID contains invalid characters. |
-# | @steam_invalid_first_char@ | Steam ID doesn't start with a letter. |
+# |                       |                                       |
+# |:----------------------|:--------------------------------------|
+# | `steam_too_short`     | Steam ID is less than 6 characters.   |
+# | `steam_too_long`      | Steam ID is over 32 characters.       |
+# | `steam_invalid_chars` | Steam ID contains invalid characters. |
 #
 # @example
 #   validates :steam_id, steam: true
+#
+# Options
+# -------
+#
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the email is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
 
 class SteamValidator < AccountNameValidator
   min_length 3
   max_length 63
-  valid_chars 'A-Za-z0-9_'
+  valid_chars "A-Za-z0-9_"
 end

data/lib/telegram_validator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Validates Telegram usernames. Telegram usernames are 5-32 characters of
+# alphanumerics and underscores; they must start with a letter and cannot end
+# with an underscore. Username lookups are case-insensitive. A leading `@` is
+# stripped before validation.
+#
+# The following error message keys are used to localize invalid usernames:
+#
+# |                                |                                                       |
+# |:-------------------------------|:------------------------------------------------------|
+# | `telegram_too_short`           | Username is less than 5 characters.                   |
+# | `telegram_too_long`            | Username is over 32 characters.                       |
+# | `telegram_invalid_chars`       | Username contains characters outside `[A-Za-z0-9_]`.  |
+# | `telegram_invalid_first_char`  | Username doesn't start with a letter.                 |
+# | `telegram_trailing_underscore` | Username ends with an underscore.                     |
+#
+# @example
+#   validates :telegram, telegram: true
+#
+# Options
+# -------
+#
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the username is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
+
+class TelegramValidator < AccountNameValidator
+  min_length 5
+  max_length 32
+  valid_chars "A-Za-z0-9_"
+  first_char "A-Za-z"
+  add_validation(:trailing_underscore) { |value| !value.end_with?("_") }
+
+  # Overrides {AccountNameValidator#validate_each} to strip an optional leading
+  # `@` before applying validations.
+  def validate_each(record, attribute, value)
+    if value.is_a?(String) && value.start_with?("@")
+      value = value[1..]
+    end
+    super
+  end
+end

data/lib/validates_im/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ValidatesIm
+  VERSION = "2.0.0"
+end

data/lib/validates_im.rb

@@ -1,7 +1,16 @@
-require 'account_name_validator'
-require 'aim_validator'
-require 'skype_validator'
-require 'steam_validator'
-require 'validates_im'
-require 'xbox_live_validator'
-require 'yahoo_im_validator'
+# frozen_string_literal: true
+
+require "active_model"
+
+require "validates_im/version"
+
+require "account_name_validator"
+require "aim_validator"
+require "discord_validator"
+require "matrix_validator"
+require "signal_validator"
+require "skype_validator"
+require "steam_validator"
+require "telegram_validator"
+require "xbox_live_validator"
+require "yahoo_im_validator"

data/lib/xbox_live_validator.rb

@@ -1,23 +1,36 @@
+# frozen_string_literal: true
+
 # Validates Xbox Live gamertags. From the Xbox Live website:
 #
-# bq. Gamertags can only contain letters, numbers, and spaces, and can't begin
-# with a number.
+# > Gamertags can only contain letters, numbers, and spaces, and can't begin
+# > with a number.
 #
-# In addition we discovered that they have no minimum length but are no more
-# than 15 characters, and also cannot start with a space.
+# Xbox gamertags are 3-12 characters and cannot start with a space.
 #
 # The following error message keys are used to localize invalid screen names.
 #
-# | @xbox_too_long@ | Gamertag is over 15 characters. |
-# | @xbox_invalid_chars@ | Gamertag contains invalid characters. |
-# | @xbox_invalid_first_char@ | Gamertag doesn't start with a letter. |
+# |                           |                                       |
+# |:--------------------------|:--------------------------------------|
+# | `xbox_too_short`          | Gamertag is under 3 characters.       |
+# | `xbox_too_long`           | Gamertag is over 12 characters.       |
+# | `xbox_invalid_chars`      | Gamertag contains invalid characters. |
+# | `xbox_invalid_first_char` | Gamertag doesn't start with a letter. |
 #
 # @example
 #   validates :steam_account, steam: true
+#
+# Options
+# -------
+#
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the email is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
 
 class XboxLiveValidator < AccountNameValidator
-  error_key_prefix 'xbox'
-  max_length 15
-  valid_chars 'A-Za-z0-9 '
-  first_char 'A-Za-z'
+  error_key_prefix "xbox"
+  min_length 3
+  max_length 12
+  valid_chars "A-Za-z0-9 "
+  first_char "A-Za-z"
 end

data/lib/yahoo_im_validator.rb

@@ -1,30 +1,37 @@
+# frozen_string_literal: true
+
 # Validates Yahoo! Instant Messenger screen names. According to the Yahoo!
 # website:
 #
-# bq. Use 4 to 32 characters and start with a letter. You may use letters,
-# numbers, underscores, and one dot (.).
+# > Use 4 to 32 characters and start with a letter. You may use letters,
+# > numbers, underscores, and one dot (.).
 #
 # The following error message keys are used to localize invalid screen names:
 #
-# | @yim_too_short@ | Screen name is less than 3 characters. |
-# | @yim_too_long@ | Screen name is over 16 characters. |
-# | @yim_invalid_chars@ | Screen name contains invalid characters. |
-# | @yim_invalid_first_char@ | Screen name doesn't start with a letter. |
-# | @yim_multiple_periods@ | Screen name has more than one period in it. |
+# |                          |                                             |
+# |:-------------------------|:--------------------------------------------|
+# | `yim_too_short`          | Screen name is fewer than 3 characters.     |
+# | `yim_too_long`           | Screen name is over 16 characters.          |
+# | `yim_invalid_chars`      | Screen name contains invalid characters.    |
+# | `yim_invalid_first_char` | Screen name doesn't start with a letter.    |
+# | `yim_multiple_periods`   | Screen name has more than one period in it. |
 #
 # @example
 #   validates :yim_sn, yahoo_im: true
 #
-# h2. Options
+# Options
+# -------
 #
-# | @:message@ | A custom message to use if the email is invalid. |
-# | @:allow_nil@ | If true, @nil@ values are allowed. |
+# |              |                                                  |
+# |:-------------|:-------------------------------------------------|
+# | `:message`   | A custom message to use if the email is invalid. |
+# | `:allow_nil` | If true, `nil` values are allowed.               |
 
 class YahooImValidator < AccountNameValidator
-  error_key_prefix 'yim'
+  error_key_prefix "yim"
   min_length 4
   max_length 32
   valid_chars 'A-Za-z0-9_\\.'
-  first_char 'A-Za-z'
-  add_validation(:multiple_periods) { |value| value.count('.') < 2 }
+  first_char "A-Za-z"
+  add_validation(:multiple_periods) { |value| value.count(".") < 2 }
 end

data/validates_im.gemspec

@@ -1,63 +1,45 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{validates_im}
-  s.version = "1.1.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Tim Morgan}]
-  s.date = %q{2011-08-31}
-  s.description = %q{Adds ActiveModel validators for common instant messaging services like Skype and AIM.}
-  s.email = %q{git@timothymorgan.info}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.textile"
-  ]
-  s.files = [
-    "LICENSE",
-    "README.textile",
-    "lib/account_name_validator.rb",
-    "lib/aim_validator.rb",
-    "lib/skype_validator.rb",
-    "lib/steam_validator.rb",
-    "lib/validates_im.rb",
-    "lib/xbox_live_validator.rb",
-    "lib/yahoo_im_validator.rb",
-    "validates_im.gemspec"
-  ]
-  s.homepage = %q{http://github.com/riscfuture/validates_im}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.9}
-  s.summary = %q{A set of Rails validators for common instant messaging services}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, [">= 3.1"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_development_dependency(%q<RedCloth>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 3.0"])
-    else
-      s.add_dependency(%q<activerecord>, [">= 3.1"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<RedCloth>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<activerecord>, [">= 3.0"])
-    end
-  else
-    s.add_dependency(%q<activerecord>, [">= 3.1"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<RedCloth>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<activerecord>, [">= 3.0"])
-  end
-end
+# frozen_string_literal: true
+
+require_relative "lib/validates_im/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "validates_im"
+  spec.version       = ValidatesIm::VERSION
+  spec.authors       = ["Tim Morgan"]
+  spec.email         = "git@timothymorgan.info"
+
+  spec.summary       = "A set of Rails validators for common instant messaging services"
+  spec.description   = "Adds ActiveModel validators for common instant messaging services like Discord, Telegram, Matrix, and Signal (as well as legacy services like AIM, Yahoo!, and Skype)."
+  spec.homepage      = "https://github.com/riscfuture/validates_im"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 3.1"
 
+  spec.metadata = {
+    "homepage_uri"          => spec.homepage,
+    "source_code_uri"       => "#{spec.homepage}/tree/master",
+    "changelog_uri"         => "#{spec.homepage}/blob/master/CHANGELOG.md",
+    "bug_tracker_uri"       => "#{spec.homepage}/issues",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files = Dir.chdir(__dir__) do
+    candidates =
+      if system("git rev-parse --is-inside-work-tree > /dev/null 2>&1")
+        `git ls-files -z`.split("\x0").reject do |f|
+          f.start_with?(".github/", "spec/", ".idea/", ".claude/", "bin/") ||
+            f.match?(/\A(?:Gemfile|Gemfile\.lock|Rakefile|\.rspec|\.rubocop\.yml|\.travis\.yml|\.ruby-(?:gemset|version)|\.gitignore|\.document)/)
+        end
+      else
+        Dir["lib/**/*.rb"] + %w[LICENSE README.md CHANGELOG.md validates_im.gemspec]
+      end
+    candidates.select { |f| File.exist?(f) } +
+      Dir["lib/**/*.rb"].reject { |f| candidates.include?(f) } +
+      %w[CHANGELOG.md].reject { |f| candidates.include?(f) || !File.exist?(f) }
+  end.uniq
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel",   ">= 6.1"
+  spec.add_dependency "activesupport", ">= 6.1"
+end

metadata

@@ -1,126 +1,90 @@
 --- !ruby/object:Gem::Specification
 name: validates_im
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Tim Morgan
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-31 00:00:00.000000000Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: &2167709520 !ruby/object:Gem::Requirement
-    none: false
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '6.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2167709520
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &2167708860 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167708860
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &2167708280 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167708280
-- !ruby/object:Gem::Dependency
-  name: RedCloth
-  requirement: &2167707660 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2167707660
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2167707060 !ruby/object:Gem::Requirement
-    none: false
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '6.1'
+  type: :runtime
   prerelease: false
-  version_requirements: *2167707060
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: &2167706460 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2167706460
+        version: '6.1'
 description: Adds ActiveModel validators for common instant messaging services like
-  Skype and AIM.
+  Discord, Telegram, Matrix, and Signal (as well as legacy services like AIM, Yahoo!,
+  and Skype).
 email: git@timothymorgan.info
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.textile
+extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
-- README.textile
+- README.md
 - lib/account_name_validator.rb
 - lib/aim_validator.rb
+- lib/discord_validator.rb
+- lib/matrix_validator.rb
+- lib/signal_validator.rb
 - lib/skype_validator.rb
 - lib/steam_validator.rb
+- lib/telegram_validator.rb
 - lib/validates_im.rb
+- lib/validates_im/version.rb
 - lib/xbox_live_validator.rb
 - lib/yahoo_im_validator.rb
 - validates_im.gemspec
-homepage: http://github.com/riscfuture/validates_im
-licenses: []
-post_install_message: 
+homepage: https://github.com/riscfuture/validates_im
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/riscfuture/validates_im
+  source_code_uri: https://github.com/riscfuture/validates_im/tree/master
+  changelog_uri: https://github.com/riscfuture/validates_im/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/riscfuture/validates_im/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 221433530893937633
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.9
-signing_key: 
-specification_version: 3
+rubygems_version: 4.0.11
+specification_version: 4
 summary: A set of Rails validators for common instant messaging services
 test_files: []

data/README.textile

@@ -1,40 +0,0 @@
-h1. validates_im -- Instant messenger account validations for ActiveRecord
-
-| *Author* | Tim Morgan |
-| *Version* | 1.1 (Aug 31, 2011) |
-| *License* | Released under the MIT license. |
-
-h2. About
-
-@validates_im@ is a simple gem that gives you some @EachValidators@ that you can
-use to validate instant messenger account names in your Rails 3.0 application.
-Validators are provided for the most common IM services, like AIM, Yahoo! IM,
-and Skype.
-
-h2. Installation
-
-*Important Note:* This gem is for Rails 3 only.
-
-To install, simply add this gem to your Rails project's @Gemfile@:
-
-<pre><code>
-gem 'validates_im'
-</code></pre>
-
-h2. Usage
-
-The IM validators are @EachValidators@, meant to be used with the @validates@
-method. An example:
-
-<pre><code>
-validates :screen_name,
-          aim: true,
-          presence: true
-</code></pre>
-
-The name of the symbol key is taken from the name of the validator; as such, The
-@XboxLiveValidator@ would be invoked using @:xbox_live@. See the
-{AccountNameValidator} class docs for more information.
-
-The localization keys for validation errors are listed in the documentation for
-each validator class.