usernames 0.1.3

data/sig/usernames.rbs

@@ -0,0 +1,75 @@
+# The public surface of the usernames gem: the module functions, the result
+# of a check, the errors, and the has_username macro.
+module Usernames
+  VERSION: String
+  ROUTE: Regexp
+
+  class Error < StandardError
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class NoFreeNameError < Error
+  end
+
+  class DataError < Error
+  end
+
+  type rule = :impersonation | :exact | :route | :custom | :severe | :strong | :hate_number | :adapter
+
+  # Usernames.check("Ad_min") # => #<data Usernames::Result ok?=false, reason=:username_reserved, …>
+  class Result
+    def ok?: () -> bool
+    def reason: () -> Symbol?
+    def rule: () -> rule?
+    def canonical: () -> String
+    def message: () -> String?
+  end
+
+  def self.configuration: () -> Configuration
+  def self.configuration=: (Configuration) -> Configuration
+  def self.configure: () { (Configuration) -> void } -> Configuration
+
+  def self.check: (untyped value, **untyped options) -> Result
+  def self.allowed?: (untyped value, **untyped options) -> bool
+  def self.normalize: (untyped value, **untyped options) -> String
+  def self.comparison_key: (untyped value, **untyped options) -> String
+  def self.normalizer: (**untyped options) -> ^(untyped) -> String?
+  def self.route: () -> Regexp
+  def self.rules_for_browser: (**untyped options) -> Array[{ rule: Symbol, pattern: String, message: String }]
+  def self.generate: (?from: String?, **untyped options) -> String
+  def self.candidates_for: (String? seed, count: Integer, **untyped options) -> Array[String]
+
+  class Configuration
+    attr_accessor length: Range[Integer]
+    attr_accessor separators: Array[String]
+    attr_accessor edge_separators: bool
+    attr_accessor case: :lowercase | :preserve
+    attr_accessor first_character: :alphanumeric | :letter
+    attr_accessor reserve_routes: bool
+    attr_accessor app_name: String | false | nil
+    attr_accessor reserved: Array[String]
+    attr_accessor forbidden: Array[String]
+    attr_accessor allowed: Array[String]
+    attr_accessor on_adapter_failure: :allow | :reject
+    attr_accessor unique_index: (String | Symbol)?
+    def offensive: () -> untyped
+    def generator: () -> untyped
+    def generator=: (untyped callable) -> untyped
+    def validate!: () -> self
+  end
+
+  # has_username(column = :username, required: false, generate: nil, **rules)
+  #
+  # required: and generate: take true, false, a method name or a proc,
+  # evaluated on the record like Rails' if:. generate: nil (the default)
+  # means: wherever a name is not required.
+  #
+  # Also defines, named after the column: <column>_available?, suggest_<column>s,
+  # generate_<column>, find_by_<column>, find_by_<column>!, <column>_options, check_<column>,
+  # <column>_rules_for_browser, and <column>_generated? on instances.
+  module Model
+    def has_username: (?(Symbol | String) column, ?required: (bool | Symbol | Proc), ?generate: (bool | Symbol | Proc)?, **untyped rules) -> void
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: usernames
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- rameerez
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Add correct, secure usernames to any Rails model with one line (`has_username`).
+  Format rules that read like English (no symbols at the edges, no two in a row, not
+  all digits), a bundled list of reserved names (admin, root, login, your own routes)
+  matched the way impersonators actually type them (ad.min, adm1n, admin2), offensive-word
+  screening in severity tiers per language, case-insensitive uniqueness that actually
+  uses your index, a free generated name for every account, suggestions when a name
+  is taken, and a live availability check. No table, no network, no API key.
+email:
+- rubygems@rameerez.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- SECURITY.md
+- config/locales/usernames.en.yml
+- config/locales/usernames.es.yml
+- config/locales/usernames.pt.yml
+- data/LICENSES/allprofanity.txt
+- data/LICENSES/big-username-blocklist.txt
+- data/LICENSES/corpora.txt
+- data/LICENSES/cuss.txt
+- data/LICENSES/django-registration.txt
+- data/LICENSES/dsojevic-profanity-list.txt
+- data/LICENSES/forwardemail.txt
+- data/LICENSES/friendly-words.txt
+- data/LICENSES/gitea.txt
+- data/LICENSES/gitlab.txt
+- data/LICENSES/iana-well-known-uris.txt
+- data/LICENSES/imsky-wordlists.txt
+- data/LICENSES/mottie-github-reserved-names.txt
+- data/LICENSES/obscenity.txt
+- data/LICENSES/petname.txt
+- data/LICENSES/rfc2142.txt
+- data/LICENSES/shouldbee.txt
+- data/LICENSES/usernames.txt
+- data/NOTICE
+- data/offensive/README.md
+- data/offensive/allowlist/en.txt
+- data/offensive/allowlist/es.txt
+- data/offensive/en.json
+- data/offensive/es.json
+- data/offensive/hate.yml
+- data/offensive/leet.yml
+- data/reserved/ALLOWLIST_EXCEPTIONS.txt
+- data/reserved/impersonation.txt
+- data/reserved/mailboxes.txt
+- data/reserved/system.txt
+- data/reserved/web.txt
+- data/words/adjectives.txt
+- data/words/animals.txt
+- lib/generators/usernames/availability_generator.rb
+- lib/generators/usernames/existing_schema.rb
+- lib/generators/usernames/install_generator.rb
+- lib/generators/usernames/install_messages.rb
+- lib/generators/usernames/locale_generator.rb
+- lib/generators/usernames/templates/add_username.rb.erb
+- lib/generators/usernames/templates/availability/_field.html.erb.tt
+- lib/generators/usernames/templates/availability/availability_controller.rb.tt
+- lib/generators/usernames/templates/availability/username_check_controller.js.tt
+- lib/generators/usernames/templates/usernames.rb
+- lib/tasks/usernames.rake
+- lib/usernames.rb
+- lib/usernames/adapters/moderate.rb
+- lib/usernames/audit.rb
+- lib/usernames/audit/output.rb
+- lib/usernames/audit/values.rb
+- lib/usernames/candidates.rb
+- lib/usernames/comparison.rb
+- lib/usernames/comparison/index_contract.rb
+- lib/usernames/comparison/index_expression.rb
+- lib/usernames/configuration.rb
+- lib/usernames/data.rb
+- lib/usernames/engine.rb
+- lib/usernames/errors.rb
+- lib/usernames/generator.rb
+- lib/usernames/model.rb
+- lib/usernames/normalizer.rb
+- lib/usernames/offensive.rb
+- lib/usernames/offensive/hate.rb
+- lib/usernames/offensive/lexicon.rb
+- lib/usernames/offensive/name.rb
+- lib/usernames/phrase.rb
+- lib/usernames/reserved.rb
+- lib/usernames/reserved/listing.rb
+- lib/usernames/result.rb
+- lib/usernames/rules.rb
+- lib/usernames/rules/options.rb
+- lib/usernames/unique_violation.rb
+- lib/usernames/validator.rb
+- lib/usernames/version.rb
+- lib/usernames/words.rb
+- sig/usernames.rbs
+homepage: https://github.com/rameerez/usernames
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rameerez/usernames
+  source_code_uri: https://github.com/rameerez/usernames
+  changelog_uri: https://github.com/rameerez/usernames/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/rameerez/usernames/issues
+  documentation_uri: https://github.com/rameerez/usernames#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: 'Add usernames with validations to your Rails app: block reserved names,
+  screen profanity, enforce case-insensitive uniqueness, suggest alternatives and
+  generate default names'
+test_files: []