validates_not_shouting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47526e07aaebbf01f2c81d7b36a3882c1bb2e5e9
+  data.tar.gz: 1d297c90370169b4d83cb518a66af3bea7020b97
+SHA512:
+  metadata.gz: 77a93d81652381c33568b563517604a1e1bb3d51702faaad3340274f26550a4d617d43af5b2b3833af2f726d4c5d910f1a89aa36ff846e6684dfc042b56852f6
+  data.tar.gz: df2d5d612fb337faaa25171a86c01f85c38c93e7f403249c4cf52f03f766af33e65b61ab156b46d72956305eaf1ad289fb6abe1a2dbd669bf5d5bd5d01751890

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=e60275947ae5fe3e0042bc2a3a0e3324a779ae4eb37f90ac787129cde9f36508
+  matrix:
+    - "AM_VERSION=3.2.0"
+    - "AM_VERSION=4.0.0"
+    - "AM_VERSION=4.1.0"

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in validates_not_shouting.gemspec
+gemspec
+
+am_version = ENV["AM_VERSION"] || "default"
+
+am_version = case am_version
+when "default"
+  ">= 3.2.0"
+else
+  "~> #{am_version}"
+end
+
+gem "activesupport", am_version
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeff Ching
+
+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,49 @@
+# ValidatesNotShouting [![Build Status](https://travis-ci.org/avvo/validates_not_shouting.png)](https://travis-ci.org/avvo/validates_not_shouting) [![Code Climate](https://codeclimate.com/github/avvo/validates_not_shouting.png)](https://codeclimate.com/github/avvo/validates_not_shouting) [![Code Coverage](https://codeclimate.com/github/avvo/validates_not_shouting/coverage.png)](https://codeclimate.com/github/avvo/validates_not_shouting)
+
+To prevent noobs from being uber noobs.
+
+Originally idea conceived by [bvandenbos](https://github.com/bvandenbos). ActiveModel::Validator
+to prevent the percentage of capital letters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validates_not_shouting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validates_not_shouting
+
+## Usage
+
+```
+
+class Foo
+  include ActiveModel::Validations
+  attr_accessor :foo
+
+  validates :foo, not_shouting: true
+end
+
+```
+
+## Configuration
+
+You can set the message and threshold as configuration for the validator. The default threshold is 0.5 (half of the characters).
+
+    validates :foo, not_shouting: {threshold: 0.1, message: 'cannot be so shouty.'}
+
+## Contributing
+
+1. Fork it ( https://github.com/avvo/validates_not_shouting/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/validates_not_shouting.rb

@@ -0,0 +1,7 @@
+require 'active_model'
+require 'validates_not_shouting/version'
+require 'validates_not_shouting/not_shouting_validator'
+
+module ValidatesNotShouting
+  # Your code goes here...
+end

data/lib/validates_not_shouting/not_shouting_validator.rb

@@ -0,0 +1,16 @@
+# this is not namespaced so that we can do
+#   validates :body, not_shouting: true
+class NotShoutingValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return true if value.blank?
+
+    if shouting?(value)
+      record.errors[attribute] << options.fetch(:message, "cannot be mostly caps. It's not polite to shout.")
+    end
+  end
+
+  def shouting?(value)
+    threshold = options.fetch(:threshold, 0.5)
+    (value.gsub(/[^A-Z]/, '').length.to_f / value.length) > threshold
+  end
+end

data/lib/validates_not_shouting/version.rb

@@ -0,0 +1,3 @@
+module ValidatesNotShouting
+  VERSION = "0.0.1"
+end

data/test/model_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+class ModelTest < MiniTest::Unit::TestCase
+
+  class TestModel
+    attr_accessor :body, :subject, :blurb
+    include ActiveModel::Validations
+
+    validates :body, :subject, not_shouting: {threshold: 0.1}
+  end
+
+  class TestModelNoThreshold
+    attr_accessor :body, :subject, :blurb
+    include ActiveModel::Validations
+
+    validates :body, :subject, not_shouting: true
+  end
+
+  def test_validates_nil
+    m = TestModel.new
+    assert(m.valid?)
+  end
+
+  def test_validates_shouting
+    m = TestModel.new
+    m.body = "THIS IS SHOUTING AND SHOULD NOT BE OK"
+    m.subject = "THIS IS NOT OK"
+    assert !m.valid?
+    assert m.errors[:body].present?
+    assert m.errors[:subject].present?
+  end
+
+  def test_validates_with_threshold
+    m = TestModel.new
+    m.subject = "This is actually ok" # < 10%
+    assert m.valid?
+
+    m = TestModel.new
+    m.subject = "THIs is actually ok" # > 10%
+    assert !m.valid?
+  end
+
+  def test_without_threshold
+    m = TestModelNoThreshold.new
+    m.body = "ABCabc" # 50% ok
+    assert(m.valid?)
+
+    m.body = "ABCDabc" # >50% not ok
+    assert(!m.valid?)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+Bundler.require(:default, :test)
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'minitest/autorun'

data/validates_not_shouting.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validates_not_shouting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "validates_not_shouting"
+  spec.version       = ValidatesNotShouting::VERSION
+  spec.authors       = ["Jeff Ching"]
+  spec.email         = ["jching@avvo.com"]
+  spec.summary       = "To prevent noobs from being uber noobs"
+  spec.description   = "To prevent noobs from being uber noobs"
+  spec.homepage      = ""
+  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", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: validates_not_shouting
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: To prevent noobs from being uber noobs
+email:
+- jching@avvo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/validates_not_shouting.rb
+- lib/validates_not_shouting/not_shouting_validator.rb
+- lib/validates_not_shouting/version.rb
+- test/model_test.rb
+- test/test_helper.rb
+- validates_not_shouting.gemspec
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: To prevent noobs from being uber noobs
+test_files:
+- test/model_test.rb
+- test/test_helper.rb
+has_rdoc: