username 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d15b4e55705a2cd5238ad7e92a4cfee36886f9f602b21967c59ac9e5d7d3dd6
+  data.tar.gz: ee13b30fe24e8f37deb62bef82f5b8f35430a76bfb94d95de8482962d4faad4a
+SHA512:
+  metadata.gz: 771c98c923b738bbedb939f5beda10349d38e76aaecd3874c484b7fde7dae0e5862870d4cbea97060e8ca631ae483a1382d55b7c299ed8ad4f64c04b41ec9ef2
+  data.tar.gz: e6198551b71dc0adff9d0540e15f22a0c2b6b73a29ade87f5e36005f0078b33f734a91f4feb92afae0f86798f27d93eff91439f357cf3be1d295db81ff7036e7

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0 - 2018/01/20
+
+* initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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,140 @@
+# Username
+
+[![Gem Version](https://badge.fury.io/rb/username.svg)](https://badge.fury.io/rb/username) <img src="https://travis-ci.org/jonhue/username.svg?branch=master" />
+
+Usernames for ActiveRecord model.
+
+---
+
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Methods](#methods)
+* [Configuration](#configuration)
+* [To Do](#to-do)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
+    * [Semantic versioning](#semantic-versioning)
+* [License](#license)
+
+---
+
+## Installation
+
+Username works with Rails 5 onwards. You can add it to your `Gemfile` with:
+
+```ruby
+gem 'username'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install username
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'username', github: 'jonhue/username'
+```
+
+Now run the generator:
+
+    $ rails g username
+
+---
+
+## Usage
+
+You can add usernames to an ActiveRecord model:
+
+```ruby
+class User < ApplicationRecord
+    has_username
+end
+```
+
+**Important:** Make sure to add a `username` string column to the corresponding database table.
+
+Username adds a validator to prevent the use of invalid usernames.
+
+### Methods
+
+```ruby
+# If a username is available for an ActiveRecord class
+User.username_valid? 'test'
+
+# If a username is available for an ActiveRecord model
+User.first.username_available? 'test'
+```
+
+---
+
+## Configuration
+
+You can configure Username by passing a block to `configure`. This can be done in `config/initializers/username.rb`:
+
+```ruby
+Username.configure do |config|
+    config.minlength = 1
+end
+```
+
+* `minlength` Minimum length for usernames. Takes an integer. Defaults to `1`.
+* `maxlength` Maximum length for usernames. Takes an integer. Defaults to `20`.
+* `regex` Strings not matching this regular expression are invalid as usernames. Takes a regular expression. Defaults to `/\A[a-zA-Z0-9_\.]*\z/`.
+* `global_uniqueness` Whether to validate usernames across all models or just the records model. Takes a boolean. Defaults to `true`.
+
+---
+
+## To Do
+
+[Here](https://github.com/jonhue/username/projects/1) is the full list of current projects.
+
+To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/username/issues/new).
+
+---
+
+## Contributing
+
+We hope that you will consider contributing to Username. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+
+### Contributors
+
+Give the people some :heart: who are working on this project. See them all at:
+
+https://github.com/jonhue/username/graphs/contributors
+
+### Semantic Versioning
+
+Username follows Semantic Versioning 2.0 as defined at http://semver.org.
+
+## License
+
+MIT License
+
+Copyright (c) 2018 Jonas Hübotter
+
+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/app/models/concerns/username/model.rb

@@ -0,0 +1,58 @@
+module Username
+    module Model
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+            def has_username
+                Username.configuration&.models << self.name
+                validate :username_validation
+            end
+
+            def username_valid? username
+                unless username.nil?
+                    valid = true
+                    if Username.configuration.global_uniqueness
+                        Username.configuration.models.each do |model|
+                            valid = false if model.constantize.all.where(username: username).any?
+                        end
+                    else
+                        valid = false if self.all.where(username: username).any?
+                    end
+                    valid = false if Username.configuration.forbidden.include?(username) || username.length < Username.configuration.minlength || username.length > Username.configuration.maxlength || username !~ Username.configuration.regex
+                    valid
+                else
+                    true
+                end
+            end
+        end
+
+        def username_available? username
+            unless username.nil?
+                valid = true
+                if Username.configuration.global_uniqueness
+                    Username.configuration.models.each do |model|
+                        if model == self.class.name
+                            valid = false if model.constantize.all.where(username: username).where.not(id: id).any?
+                        else
+                            valid = false if model.constantize.all.where(username: username).any?
+                        end
+                    end
+                else
+                    valid = false if self.class.all.where(username: username).where.not(id: id).any?
+                end
+                valid = false if Username.configuration.forbidden.include?(username) || username.length < Username.configuration.minlength || username.length > Username.configuration.maxlength || username !~ Username.configuration.regex
+                valid
+            else
+                true
+            end
+        end
+
+        private
+
+        def username_validation
+            errors.add(:username, 'has already been taken') unless self.username_available? self.username
+        end
+
+    end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,15 @@
+Username.configure do |config|
+
+    # Minimum length for usernames
+    # config.minlength = 1
+
+    # Maximum length for usernames
+    # config.maxlength = 20
+
+    # Strings not matching this regular expression are invalid as usernames.
+    # config.regex = /\A[a-zA-Z0-9_\.]*\z/
+
+    # Whether to validate usernames across all models or just the records model.
+    # config.global_uniqueness = true
+
+end

data/lib/generators/username_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class UsernameGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    source_root File.join File.dirname(__FILE__), 'templates'
+    desc 'Install Username'
+
+    def create_initializer
+        template 'initializer.rb', 'config/initializers/username.rb'
+    end
+
+end

data/lib/username/configuration.rb

@@ -0,0 +1,29 @@
+module Username
+
+    class << self
+        attr_accessor :configuration
+    end
+
+    def self.configure
+        self.configuration ||= Configuration.new
+        yield configuration
+    end
+
+    class Configuration
+
+        attr_accessor :models
+        attr_accessor :minlength
+        attr_accessor :maxlength
+        attr_accessor :regex
+        attr_accessor :global_uniqueness
+
+        def initialize
+            @models = []
+            @minlength = 1
+            @maxlength = 20
+            @regex = /\A[a-zA-Z0-9_\.]*\z/
+            @global_uniqueness = true
+        end
+
+    end
+end

data/lib/username/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/railtie'
+
+module Username
+    class Engine < Rails::Engine
+    end
+end

data/lib/username/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module Username
+    class Railtie < Rails::Railtie
+
+        initializer 'username.initialize' do
+            ActiveSupport.on_load :active_record do
+                include Username::Model
+            end
+        end
+
+    end
+end

data/lib/username/version.rb

@@ -0,0 +1,5 @@
+module Username
+
+    VERSION = '1.0.0'
+
+end

data/lib/username.rb

@@ -0,0 +1,10 @@
+require 'username/version'
+
+module Username
+
+    require 'username/configuration'
+
+    require 'username/engine'
+    require 'username/railtie'
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: username
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Hübotter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Usernames for ActiveRecord models.
+email: me@jonhue.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/models/concerns/username/model.rb
+- lib/generators/templates/initializer.rb
+- lib/generators/username_generator.rb
+- lib/username.rb
+- lib/username/configuration.rb
+- lib/username/engine.rb
+- lib/username/railtie.rb
+- lib/username/version.rb
+homepage: https://github.com/jonhue/username
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Usernames for ActiveRecord models
+test_files: []