validates_hostname 1.0.13 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a217c6f18b34d7738f6a271bcd257f7a646e79765dc7d80499b4dc4817b8cb
-  data.tar.gz: 23a45da7c0c7ab2afb06c543410514887a231fb36bd256ceb651f30d8ec78e94
+  metadata.gz: 6651611a1d3ae3384586746c26493e22375bee2c0f113cc8c48c86357b4fc5ba
+  data.tar.gz: '062741916c49420ea4c6837911d42c8c359d4dbb6407d8a4cf287714132efd2c'
 SHA512:
-  metadata.gz: 1ad8e9409b9b6ad1500981eb07a71d888962681627decfcaa19bb7f17b4e7628ebbc3c53700e9489301f0b43d0c89141381858f422a3adca0c5f70bc2792187a
-  data.tar.gz: cfe149c6565f6b8a140ef50cf5e16a54039960f701860a5966dcac8e5b84b8b912cb60ccb99e155c6eea5bad882c45adfbbc5fe67ff5c6915030685763e82455
+  metadata.gz: bfcb29a9a7c09bfcbbe5cc3d5f77bff624dada6afc390231a319f76e6ff00526544fec53b228ff7ca9f58e26277fbd798872eae594faa9ec6df4eb8d152f6caf
+  data.tar.gz: f5f59f302cac79e116a5967d81e28debac146122aa4c212cd40eab2f93c6d3904ea684624011b8069c608e7bba05ec277ca0da1d6e3b749a138c244b1c372d50

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    tags: [v*]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "3.1", "3.2", "3.3", "3.4"]
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*"
+
+jobs:
+  release:
+    name: Release to RubyGems.org
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ".ruby-version"
+
+      - name: Configure RubyGems Credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+
+      - name: Build gem
+        run: gem build *.gemspec
+
+      - name: Push gem to RubyGems.org
+        run: gem push *.gem

data/.github/workflows/tld-update.yml

@@ -0,0 +1,59 @@
+name: Automated TLD Update and Release
+
+on:
+  schedule:
+    - cron: "0 0 * * 0"
+  workflow_dispatch:
+
+jobs:
+  update_and_release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          token: ${{ secrets.GH_PAT }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ".ruby-version"
+          bundler-cache: true
+
+      - name: Update TLD list from IANA
+        run: bundle exec rake tlds:update
+
+      - name: Check for changes
+        id: git_diff
+        run: |
+          git diff --quiet data/tlds.txt || echo "changed=true" >> $GITHUB_OUTPUT
+
+      - name: Configure Git
+        if: steps.git_diff.outputs.changed == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Bump version and push changes
+        if: steps.git_diff.outputs.changed == 'true'
+        run: |
+          # Extract the current version string, e.g., '2.0.0'
+          current_version=$(grep -oP "VERSION = '\K[^']+" lib/validates_hostname/version.rb)
+          echo "Current version: $current_version"
+
+          # Bump the patch version using Ruby
+          new_version=$(ruby -e "v = '$current_version'.split('.'); v[-1] = v[-1].to_i + 1; puts v.join('.')")
+          echo "New version: $new_version"
+
+          # Update the version file
+          sed -i "s/VERSION = '$current_version'/VERSION = '$new_version'/" lib/validates_hostname/version.rb
+
+          # Commit the changes
+          git add data/tlds.txt lib/validates_hostname/version.rb
+          git commit -m "chore: Update TLD list and bump version to v${new_version}" -m "This is an automated commit."
+
+          # Tag the new version
+          git tag "v${new_version}"
+
+          # Push the commit and the tag, triggering the release workflow
+          git push origin main --follow-tags

data/.gitignore

@@ -0,0 +1,18 @@
+/pkg/
+/tmp/
+*.gem
+
+.DS_Store
+.vscode/
+.idea/
+.env
+
+Gemfile.lock
+
+/.yardoc/
+/doc/
+/rdoc/
+
+/.rspec_status
+coverage
+/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "bin/*"
+    - "db/**/*"
+    - "config/**/*"
+    - "script/**/*"
+    - "vendor/**/*"
+    - "tmp/**/*"
+    - "node_modules/**/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "lib/validates_hostname.rb"
+
+Metrics/AbcSize:
+  Exclude:
+    - "lib/validates_hostname.rb"
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "lib/validates_hostname.rb"
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - "lib/validates_hostname.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/hostname_validator_spec.rb"
+    - "validates_hostname.gemspec"

data/.ruby-version

@@ -0,0 +1 @@
+3.4.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+- 2.0.0 [2025-09-22] - new major release - decouple from ActiveRecord and modernize for ActiveModel
+- 1.0.13 [2022-10-14] - allow for conditional validation, controlled with model method
+- 1.0.11 [2020-08-18] - fixes for ruby 2.7
+- 1.0.0 [2011-01-12]
+- Initial commit

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'guard', '~> 2.19'
+  gem 'guard-rspec', '~> 4.7'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.13'
+  gem 'rspec-collection_matchers', '~> 1.2'
+  gem 'rubocop', '~> 1.80'
+  gem 'rubocop-rake', '~> 0.7'
+  gem 'rubocop-rspec', '~> 3.7'
+  gem 'simplecov', '~> 0.21'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'rbenv exec bundle exec rspec' do
+  # Watch spec files
+  watch(%r{^spec/.+_spec\.rb$})
+
+  # Watch lib files and run the corresponding spec
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+
+  # Watch the spec_helper and run all specs
+  watch('spec/spec_helper.rb') { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2009-2025 Kim Nørgaard
+
+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,349 @@
+# ValidatesHostname
+
+[![Gem Version](https://badge.fury.io/rb/validates_hostname.svg)](https://badge.fury.io/rb/validates_hostname)
+[![CI](https://github.com/KimNorgaard/validates_hostname/actions/workflows/ci.yml/badge.svg)](https://github.com/KimNorgaard/validates_hostname/actions/workflows/ci.yml)
+
+## Description
+
+Extension to ActiveModel for validating hostnames and domain names.
+
+## Requirements
+
+- Ruby >= 3.0.0
+- Active Model >= 6.0
+
+## Features
+
+- Adds validation for hostnames to ActiveModel
+- Supports I18n for the error messages
+
+## Installation
+
+As a gem:
+
+```bash
+# in Gemfile
+gem 'validates_hostname', '~> 2.0'
+
+# Run bundler
+bundle install
+```
+
+## Validations Performed
+
+The following validations are performed on the hostname:
+
+- The maximum length of the hostname is 255 characters.
+- The maximum length of each hostname label is 63 characters.
+- The allowed characters in hostname labels are `a-z`, `A-Z`, `0-9` and hyphen (`-`).
+- Labels do not begin or end with a hyphen.
+- Labels do not consist of numeric values only.
+
+## Options
+
+The validator can be configured with the following options:
+
+- `allow_underscore`: Allows for underscores in hostname labels.
+- `require_valid_tld`: Requires that the last label is a valid TLD.
+- `valid_tlds`: A list of valid TLDs. This option requires `require_valid_tld` to be `true`.
+- `allow_numeric_hostname`: Allows numeric values in the first label of the hostname.
+- `allow_wildcard_hostname`: Allows for a wildcard hostname in the first label.
+- `allow_root_label`: Allows for a trailing dot (root label) in the hostname.
+
+See also http://www.zytrax.com/books/dns/apa/names.html
+
+## How to Use
+
+Simple usage:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: true
+end
+```
+
+With options:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: { allow_underscore: true }
+end
+```
+
+## Options and Their Defaults
+
+- `allow_underscore`: Permits underscore characters (`_`) in hostname labels. (default: `false`)
+- `require_valid_tld`: Ensures that the hostname's last label is a recognized Top-Level Domain (TLD). (default: `false`)
+- `valid_tlds`: An array of specific Top-Level Domains (TLDs) that are considered valid. This option requires `require_valid_tld` to be `true` to take effect. (default: List from `data/tlds.txt`)
+- `allow_numeric_hostname`: Allows hostname labels to consist solely of numeric digits (e.g., `123.example.com`). Note: A hostname cannot consist of a single numeric label (e.g., `123` is always invalid). (default: `false`)
+- `allow_wildcard_hostname`: Permits a wildcard character (`*`) as the first label of the hostname (e.g., `*.example.com`). (default: `false`)
+- `allow_root_label`: Permits a trailing dot (root label) in the hostname (e.g., `example.com.`). (default: `false`)
+
+## Examples
+
+Without options:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: true
+end
+
+>> @record = Record.new(name: "horse")
+>> @record.save
+=> true
+
+>> @record2 = Record.new(name: "_horse")
+>> @record2.save
+=> false
+```
+
+With `:allow_underscore`:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: { allow_underscore: true }
+end
+
+>> @record3 = Record.new(name: "_horse")
+>> @record3.save
+=> true
+```
+
+With `:require_valid_tld`:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: { require_valid_tld: true }
+end
+
+>> @record4 = Record.new(name: "horse")
+>> @record4.save
+=> false
+
+>> @record5 = Record.new(name: "horse.com")
+>> @record5.save
+=> true
+```
+
+With `:valid_tlds`:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: { require_valid_tld: true, valid_tlds: %w(com org net) }
+end
+
+>> @record6 = Record.new(name: "horse.info")
+>> @record6.save
+=> false
+```
+
+With `:allow_numeric_hostname`:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: { allow_numeric_hostname: false }
+end
+
+>> @record7 = Record.new(name: "123.info")
+>> @record7.save
+=> false
+```
+
+With `:allow_wildcard_hostname`:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: { allow_wildcard_hostname: true }
+end
+
+>> @record8 = Record.new(name: "*.123.info")
+>> @record8.save
+=> true
+```
+
+With `:allow_root_label`:
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, hostname: { allow_root_label: true }
+end
+
+>> @record9 = Record.new(name: "example.com.")
+>> @record9.save
+=> true
+```
+
+## Extra Validators
+
+A few extra validators are included.
+
+### domainname
+
+Sets `require_valid_tld` to `true`.
+
+Sets `allow_numeric_hostname` to `true`. This option cannot be changed by the user.
+
+Returns error if there is only one label and this label is numeric.
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, domainname: true
+end
+
+>> @record = Record.new(name: "123.com")
+>> @record.save
+=> true
+
+>> @record2 = Record.new(name: "123")
+>> @record2.save
+=> false
+```
+
+### fqdn
+
+Sets `require_valid_tld` to `true`.
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, fqdn: true
+end
+
+>> @record = Record.new(name: "example.com")
+>> @record.save
+=> true
+
+>> @record2 = Record.new(name: "example")
+>> @record2.save
+=> false
+```
+
+### wildcard
+
+Sets `allow_wildcard_hostname` to `true`.
+
+```ruby
+class Record
+  include ActiveModel::Validations
+  attr_accessor :name
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, "Record")
+  end
+
+  validates :name, wildcard: true
+end
+
+>> @record = Record.new(name: "*.example.com")
+>> @record.save
+=> true
+```
+
+## Error Messages
+
+The gem uses the I18n system for error messages. You can provide your own
+translations in your application's locale files (e.g., `config/locales/en.yml`).
+
+Example of a custom error message in `config/locales/en.yml`:
+
+```yaml
+en:
+  errors:
+    messages:
+      invalid_hostname_length: "is not a valid hostname length"
+```
+
+The gem comes with the following built-in translations:
+
+- English (en)
+- Spanish (es)
+- German (de)
+- French (fr)
+- Simplified Chinese (zh)
+
+The `%{valid_chars}` interpolator is available for the
+`label_contains_invalid_characters` message.
+
+## Maintainers
+
+- [Kim Nørgaard](mailto:jasen@jasen.dk)
+
+## License
+
+Copyright (c) 2009-2025 Kim Nørgaard, released under the MIT license.