username_not_reserved_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc2fdca3103a23947c32a6080cba6de41359f707
+  data.tar.gz: 80bcdff40701a0197619fa4721f3251591d912cf
+SHA512:
+  metadata.gz: 784fd21e15ff61183eaf295f654e31eedb6acf2543f519ec249eb9221a3573c59e73f64b81ac4f47c972838b9468b899a0ca1044b69788846e5a32cd187edffc
+  data.tar.gz: 5041c47d94c0268c6329d9e4aab211500cd58bcbbeb0943260423cb0cbed16b784295d621f8d190583957adf9fadbb6cf662f79eb8846c700f6bfa4508753409

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: WKDKB5K2vIiPuFD1KApoVPJjT4LPkoPIT

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in username_not_reserved_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SHIOYA, Hiromu
+
+MIT License
+
+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,64 @@
+# UsernameNotReservedValidator
+
+[![Build Status](https://travis-ci.org/kwappa/username_not_reserved_validator.png)](https://travis-ci.org/kwappa/username_not_reserved_validator)
+
+[![Coverage Status](https://coveralls.io/repos/kwappa/username_not_reserved_validator/badge.png?branch=master)](https://coveralls.io/r/kwappa/username_not_reserved_validator?branch=master)
+
+[![Code Climate](https://codeclimate.com/github/kwappa/username_not_reserved_validator.png)](https://codeclimate.com/github/kwappa/username_not_reserved_validator)
+
+custom validator for ActiveModel.
+
+validates that username is not included in the reserved name list.
+
+e.g:
+
+* index
+* home
+* top
+* ...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'username_not_reserved_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install username_not_reserved_validator
+
+## Usage
+
+### validation settings
+
+write validation setting on your ActiveModel
+
+
+```
+class User < ActiveRecord::Base
+  validates(:name, username_not_reserved: true)
+)
+```
+
+### options
+
+* `additional_reserved_names` (Array of String / default: `[]`)
+ * specify additional reserved names
+* `case_insencitve` (Boolean / default: `true`)
+ * if set to `false`, comparison is case insencitive
+* `message` (Symbol / default: `:invalid`)
+ * specify key of error message
+
+## Referenced resources
+
+* http://qiita.com/phimcall/items/4c559b70f70ea7f1953b
+* http://bitarts.jp/blog/archives/004363.html
+* https://github.com/balexand/email_validator
+
+with tons of thanks :sushi:

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+Bundler.setup
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc "run spec"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-fd"]
+end

data/lib/username_not_reserved_validator/reserved_names.rb

@@ -0,0 +1,264 @@
+module UsernameNotReservedValidator::ReservedNames
+  def self.list
+    RESERVED_NAMES
+  end
+
+  RESERVED_NAMES = %w[
+    index
+    home
+    top
+    help
+    about
+    security
+    contact
+    connect
+    support
+    faq
+    form
+    mail
+    update
+    mobile
+    phone
+    portal
+    tour
+    tutorial
+    navigation
+    navi
+    manual
+    doc
+    company
+    store
+    shop
+    topic
+    news
+    information
+    info
+    howto
+    pr
+    press
+    release
+    sitemap
+    plan
+    price
+    business
+    premium
+    member
+    term
+    privacy
+    rule
+    inquiry
+    legal
+    policy
+    icon
+    image
+    img
+    photo
+    css
+    stylesheet
+    style
+    script
+    src
+    js
+    javascript
+    dist
+    asset
+    source
+    static
+    file
+    flash
+    swf
+    xml
+    json
+    sag
+    cgi
+    account
+    user
+    item
+    entry
+    article
+    page
+    archive
+    tag
+    category
+    event
+    contest
+    word
+    product
+    project
+    download
+    video
+    blog
+    diary
+    site
+    popular
+    i
+    my
+    me
+    owner
+    profile
+    self
+    old
+    first
+    last
+    start
+    end
+    special
+    design
+    theme
+    purpose
+    book
+    read
+    organization
+    community
+    group
+    all
+    status
+    state
+    search
+    explore
+    share
+    feature
+    upload
+    rss
+    atom
+    widget
+    api
+    wiki
+    bookmark
+    captcha
+    comment
+    jump
+    ranking
+    setting
+    config
+    tool
+    connect
+    notify
+    recent
+    report
+    system
+    sys
+    message
+    msg
+    log
+    analysis
+    query
+    call
+    calendar
+    friend
+    graph
+    watch
+    cart
+    activity
+    password
+    auth
+    session
+    register
+    login
+    logout
+    signup
+    signin
+    signout
+    forgot
+    admin
+    root
+    secure
+    get
+    show
+    create
+    edit
+    update
+    post
+    destroy
+    delete
+    remove
+    reset
+    error
+    new
+    dashboard
+    recruit
+    join
+    offer
+    career
+    corp
+    cgi-bin
+    server-status
+    balancer-manager
+    ldap-status
+    server-info
+    svn
+    as
+    by
+    if
+    is
+    on
+    or
+    add
+    dir
+    off
+    out
+    put
+    case
+    else
+    find
+    then
+    when
+    count
+    order
+    select
+    switch
+    school
+    developer
+    dev
+    test
+    bug
+    code
+    guest
+    app
+    maintenance
+    roc
+    id
+    bot
+    game
+    forum
+    contribute
+    usage
+    feed
+    ad
+    service
+    official
+    language
+    repository
+    spec
+    license
+    asct
+    dictionary
+    dict
+    version
+    ver
+    gift
+    alpha
+    beta
+    tux
+    year
+    public
+    private
+    default
+    request
+    req
+    data
+    master
+    die
+    exit
+    eval
+    issue
+    thread
+    diagram
+    undef
+    nan
+    null
+    empty
+    0
+    www
+  ]
+end

data/lib/username_not_reserved_validator.rb

@@ -0,0 +1,27 @@
+class UsernameNotReservedValidator < ActiveModel::EachValidator
+  require 'username_not_reserved_validator/reserved_names'
+
+  @@default_options = { case_insencitive: true }
+
+  def self.default_options
+    @@default_options
+  end
+
+  def validate_each(record, attribute, value)
+    options = @@default_options.merge(self.options)
+    additional_reserved_names = options[:additional_reserved_names] || []
+    words = ReservedNames.list + additional_reserved_names
+    words += words.map(&:pluralize)
+
+    if options[:case_insencitive]
+      words.map!(&:downcase)
+      username = value.downcase
+    else
+      username = value
+    end
+
+    if words.include?(username)
+      record.errors[attribute] << (options[:message] || :invalid)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rspec'
+require 'active_model'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'username_not_reserved_validator'
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end
+
+class WithoutValidationUser < TestModel
+end
+
+class WithValidationUser < TestModel
+  validates :name, username_not_reserved: true
+end
+
+class WithCaseInsencitiveValidationUser < TestModel
+  validates :name, username_not_reserved: { case_insencitive: false }
+end
+
+class WithAdditionalReservedNamesValidationUser < TestModel
+  validates :name, username_not_reserved: { additional_reserved_names: %w[additional_reserved_username] }
+end

data/spec/username_not_reserved_validator_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe UsernameNotReservedValidator do
+
+  let(:reserved_usernames) { UsernameNotReservedValidator::ReservedNames.list }
+  let(:valid_username) { 'valid_username' }
+  let(:invalid_username) { reserved_usernames.first(30).sample }
+  let(:invalid_camelized_username) { reserved_usernames.first(30).sample.camelize }
+  let(:invalid_pluralized_username) { reserved_usernames.first(30).sample.pluralize }
+  let(:invalid_additional_username) { 'additional_reserved_username' }
+
+
+  describe 'sample user name' do
+    context 'when valid' do
+      it 'does not included in reserved list' do
+        expect(reserved_usernames.map(&:downcase)).to_not include(valid_username)
+        expect(reserved_usernames.map(&:downcase).map(&:pluralize)).to_not include(valid_username)
+      end
+    end
+
+    context 'when invalid' do
+      it 'included in reserved list' do
+        expect(reserved_usernames).to include(invalid_username)
+      end
+
+      context 'when camelized invalid name' do
+        it 'included only downcase list' do
+          expect(reserved_usernames).to_not include(invalid_camelized_username)
+          expect(reserved_usernames.map(&:downcase)).to include(invalid_camelized_username.downcase)
+        end
+      end
+
+      context 'when pluarized invalid name' do
+        it 'included in pluralized list' do
+          expect(reserved_usernames).to include(invalid_pluralized_username.singularize)
+        end
+      end
+
+      context 'when additional invalid name' do
+        it 'does not included in reserved list' do
+          expect(reserved_usernames.map(&:downcase)).to_not include(invalid_additional_username)
+          expect(reserved_usernames.map(&:downcase).map(&:pluralize)).to_not include(invalid_additional_username)
+        end
+      end
+    end
+  end
+
+  shared_examples_for 'accepts username' do
+    it { expect(user).to be_valid }
+  end
+
+  shared_examples_for 'rejects username' do
+    it { expect(user).to_not be_valid }
+  end
+
+
+  describe 'model without validation' do
+    subject(:user) { WithoutValidationUser.new(name: username) }
+
+    context 'with valid username' do
+      let(:username) { valid_username }
+      include_examples 'accepts username'
+    end
+
+    context 'with invalid username' do
+      let(:username) { invalid_username }
+      include_examples 'accepts username'
+    end
+
+        context 'with invalid camelized username' do
+      let(:username) { invalid_camelized_username }
+      include_examples 'accepts username'
+    end
+
+    context 'with invalid pluralized username' do
+      let(:username) { invalid_pluralized_username }
+      include_examples 'accepts username'
+    end
+
+    context 'with additionals invalid username' do
+      let(:username) { invalid_additional_username }
+      include_examples 'accepts username'
+    end
+  end
+
+  describe 'model with validation' do
+    subject(:user) { WithValidationUser.new(name: username) }
+
+    context 'with valid username' do
+      let(:username) { valid_username }
+      include_examples 'accepts username'
+    end
+
+    context 'with invalid username' do
+      let(:username) { invalid_username }
+      include_examples 'rejects username'
+    end
+
+    context 'with invalid camelized username' do
+      let(:username) { invalid_camelized_username }
+      include_examples 'rejects username'
+    end
+
+    context 'with invalid pluralized username' do
+      let(:username) { invalid_pluralized_username }
+      include_examples 'rejects username'
+    end
+  end
+
+  describe 'model with case insencitive validation' do
+    subject(:user) { WithCaseInsencitiveValidationUser.new(name: username) }
+
+    context 'with valid username' do
+      let(:username) { valid_username }
+      include_examples 'accepts username'
+    end
+
+    context 'with invalid username' do
+      let(:username) { invalid_username }
+      include_examples 'rejects username'
+    end
+
+    context 'with invalid camelized username' do
+      let(:username) { invalid_camelized_username }
+      include_examples 'accepts username'
+    end
+
+    context 'with invalid pluralized username' do
+      let(:username) { invalid_pluralized_username }
+      include_examples 'rejects username'
+    end
+  end
+
+  describe 'model with validation and additional reserved username' do
+    subject(:user) { WithAdditionalReservedNamesValidationUser.new(name: username) }
+
+    context 'with additionals invalid username' do
+      let(:username) { invalid_additional_username }
+      include_examples 'rejects username'
+    end
+  end
+end

data/username_not_reserved_validator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "username_not_reserved_validator"
+  spec.version       = "0.1.0"
+  spec.authors       = ["SHIOYA, Hiromu"]
+  spec.email         = ["kwappa.856@gmail.com"]
+  spec.summary       = "validates that username is not included in reserved list."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/kwappa/username_not_reserved_validator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: username_not_reserved_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SHIOYA, Hiromu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: validates that username is not included in reserved list.
+email:
+- kwappa.856@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/username_not_reserved_validator.rb
+- lib/username_not_reserved_validator/reserved_names.rb
+- spec/spec_helper.rb
+- spec/username_not_reserved_validator_spec.rb
+- username_not_reserved_validator.gemspec
+homepage: https://github.com/kwappa/username_not_reserved_validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: validates that username is not included in reserved list.
+test_files:
+- spec/spec_helper.rb
+- spec/username_not_reserved_validator_spec.rb