activemodel-url_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee022d1df731078c7581ee23a470e85e3f0c8ac4
+  data.tar.gz: 2f222fe4833bd0ad91bb699751a171bc0bfa6256
+SHA512:
+  metadata.gz: 97e028792ea3f33e250ce41b8b1692237250f6210c1faa326bdfed16f8125122d795eaa02dc9cf68444418869a7ccda1c74e52f6c5112f347fa5387c1f905256
+  data.tar.gz: cc1138bd0d63c4e38e5330f6991376408045914abd76f535c23e091eaa936033f3e589e42526f4dba29e775cff3713a12d83d122b9a2109e30138f22b7e4af9a

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.0.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,42 @@
+# activemodel-url_validator
+
+[![Build Status](https://travis-ci.org/increments/activemodel-url_validator.svg?branch=master)](https://travis-ci.org/increments/activemodel-url_validator)
+
+## Usage
+
+Add to your Gemfile:
+
+```rb
+gem 'activemodel-url_validator'
+```
+
+Run:
+
+```
+bundle install
+```
+
+Then add the following to your model:
+
+```rb
+validates :my_url_attribute, url: true
+```
+
+### Custom options
+
+Name | Value | Default | Desc.
+----|----|----|----
+`scheme` | Array of String | nil | Specify allowed scheme types.
+`allow_no_scheme` | Boolean | false | Whether scheme less URI is allowed.
+
+```rb
+validates :my_url_attribute, url: { scheme: ['https'] }
+```
+
+## Validation outside a model
+
+If you need to validate a url outside a model, you can do that:
+
+```rb
+UrlValidator.valid?(string, options)
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/activemodel-url_validator.gemspec

@@ -0,0 +1,22 @@
+file = File.open(File.expand_path('../lib/url_validator/version.rb', __FILE__))
+version = file.read.scan(/\d+\.\d+\.\d+/).first
+file.close
+
+Gem::Specification.new do |spec|
+  spec.name            = 'activemodel-url_validator'
+  spec.version         = version
+  spec.authors         = ['Yuku Takahashi']
+  spec.email           = ['yuku@qiita.com']
+  spec.summary         = 'A url validator for Rails 3 and 4.'
+  spec.homepage        = 'https://github.com/increments/activemodel-url_validator'
+  spec.license         = 'MIT'
+
+  spec.files           = `git ls-files -z`.split("\x0")
+  spec.require_paths   = ['lib']
+
+  spec.add_dependency 'activemodel'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/activemodel-url_validator.rb

@@ -0,0 +1,2 @@
+require 'url_validator/version'
+require 'url_validator/engine'

data/lib/url_validator.rb

@@ -0,0 +1,25 @@
+class UrlValidator < ActiveModel::EachValidator
+  class << self
+    def valid?(value, options = {})
+      options = default_options.merge(options)
+      uri = URI.parse(value)
+      if uri.scheme.nil?
+        !!options[:allow_no_scheme]
+      else
+        options[:scheme] ? options[:scheme].include?(uri.scheme) : true
+      end
+    rescue URI::Error
+      false
+    end
+
+    def default_options
+      { scheme: nil, allow_no_scheme: false }
+    end
+  end
+
+  def validate_each(record, attribute, value)
+    unless self.class.valid?(value, options)
+      record.errors.add(attribute, options[:message] || :invalid_url)
+    end
+  end
+end

data/lib/url_validator/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+class UrlValidator
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/url_validator/version.rb

@@ -0,0 +1,3 @@
+class UrlValidator
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'active_model'
+require 'url_validator'
+
+RSpec.configure do |config|
+  config.color = true
+  config.run_all_when_everything_filtered = true
+end
+
+class TestModel
+  include ActiveModel::Validations
+
+  def self.name
+    'TestModel'
+  end
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

data/spec/url_validator_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+# Shared examples for value.
+
+shared_examples_for 'invalid value is given', given: :invalid do
+  let(:value) do
+    'This is invalid URI'
+  end
+end
+
+shared_examples_for 'scheme less value is given', given: :scheme_less do
+  let(:value) do
+    '//example.com/scheme/less'
+  end
+end
+
+[:http, :https].each do |scheme|
+  shared_examples_for "#{scheme} URI is given", given: scheme do
+    let(:value) do
+      "#{scheme}://example.com/#{scheme}/scheme"
+    end
+  end
+end
+
+# Shared examples for options
+
+shared_examples_for 'allow_no_scheme is true', allow_no_scheme: true do
+  let(:allow_no_scheme) do
+    true
+  end
+end
+
+shared_examples_for 'scheme includes http', scheme: :http do
+  let(:scheme) do
+    ['http']
+  end
+end
+
+shared_examples_for 'scheme is an empty array', scheme: :empty do
+  let(:scheme) do
+    []
+  end
+end
+
+describe UrlValidator do
+  describe '.valid?' do
+    subject do
+      described_class.valid?(value, options)
+    end
+
+    let(:options) do
+      options = {}
+      described_class.default_options.keys.each do |option_name|
+        options[option_name] = send(option_name) if respond_to? option_name
+      end
+      options
+    end
+
+    context 'when invalid value is given', given: :invalid do
+      it { should be_falsey }
+    end
+
+    context 'when a scheme less URI is given', given: :scheme_less do
+      it { should be_falsey }
+
+      context 'and scheme less URI is allowed', allow_no_scheme: true do
+        it { should be_truthy }
+
+        context 'and scheme option is given', scheme: :http do
+          it { should be_truthy }
+        end
+      end
+    end
+
+    context 'when a HTTP URI is given', given: :http do
+      it { should be_truthy }
+
+      context 'and http scheme is allowed', scheme: :http do
+        it { should be_truthy }
+      end
+
+      context 'and http scheme is not allowed', scheme: :empty do
+        it { should be_falsey }
+      end
+    end
+
+    context 'when a HTTPS URI is given', given: :https do
+      it { should be_truthy }
+
+      context "and http scheme is allowed but https isn't", scheme: :http do
+        it { should be_falsey }
+      end
+    end
+  end
+
+  describe 'validation' do
+    subject do
+      model_class.new(attr: value)
+    end
+
+    context 'when custom option is not specified' do
+      let(:model_class) do
+        Class.new(TestModel) do
+          validates :attr, url: true
+        end
+      end
+
+      context 'and a valid scheme less value is given', given: :scheme_less do
+        it { should be_invalid }
+      end
+
+      context 'and a valid http value is given', given: :http do
+        it { should be_valid }
+      end
+
+      context 'and an invalid value is given', given: :invalid do
+        it { should be_invalid }
+      end
+    end
+
+    context 'when allow_no_scheme is true' do
+      let(:model_class) do
+        Class.new(TestModel) do
+          validates :attr, url: { allow_no_scheme: true }
+        end
+      end
+
+      context 'and a valid scheme less value is given', given: :scheme_less do
+        it { should be_valid }
+      end
+    end
+
+    context 'when http scheme is allowed', scheme: :http do
+      let(:model_class) do
+        Class.new(TestModel) do
+          validates :attr, url: { scheme: ['http'] }
+        end
+      end
+
+      context 'and a valid scheme less value is given', given: :scheme_less do
+        it { should be_invalid }
+      end
+
+      context 'and a valid http value is given', given: :http do
+        it { should be_valid }
+      end
+
+      context 'and a valid https value is given', given: :https do
+        it { should be_invalid }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-url_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuku Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 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: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !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: 
+email:
+- yuku@qiita.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activemodel-url_validator.gemspec
+- lib/activemodel-url_validator.rb
+- lib/url_validator.rb
+- lib/url_validator/engine.rb
+- lib/url_validator/version.rb
+- spec/spec_helper.rb
+- spec/url_validator_spec.rb
+homepage: https://github.com/increments/activemodel-url_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: A url validator for Rails 3 and 4.
+test_files: []