url_format 0.0.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1805e62ee4b7a41087fe084c7602dbb8d7514910
-  data.tar.gz: 9ca2331032efbac625d71ad10ef30350dff9e79d
+  metadata.gz: 3297d45a6ae1932a9de8ff8bd8b5a3b5636d6ea4
+  data.tar.gz: b646131d7c98760dc919355eb2b1fd669a2c601d
 SHA512:
-  metadata.gz: 6b2414aa83d1919196a7e14cacc03b03600663864258e45920ac6cd55cfee80788368ea025f6b1d8f85a5077cff7b549d21e0f44306d81735bb85fed1c2d1743
-  data.tar.gz: e59d7902ea52328bcdeeaa147890c132f820d5dc8db09b4343505a47323db5125b15fbff2270e1abf3d10d1cf51389a92016ee1b51bec2b4bb7da35b7c19d5c4
+  metadata.gz: e0d462f83aaf7b4bed83ec50ec73e5a04f90772779e2877998511747f4cf68c512403cf3aae9460c36c085699898b493ec0cabc767e8be7c022b1ef7b899740e
+  data.tar.gz: a74483679fb45b6679b790e5145ddc7671f580c488da65437b4903d12b091c88c63e75212af393cc9dc31b263aa23a357ddb37c6ad231f9dd147dd723fd00d65

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+
+notifications:
+  email:
+    - johnotander@gmail.com

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 John Otander
+Copyright (c) 2013-2015 John Otander
 
 MIT License
 

data/README.md

@@ -1,6 +1,8 @@
 # UrlFormat
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/johnotander/url_format.svg?branch=master)](https://travis-ci.org/johnotander/url_format)
+
+This gem validates a URL, adds the `http://` prefix if not included, and provides a `get_domain` method.
 
 ## Installation
 
@@ -18,7 +20,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Using it is as simple as using the `validates` keyword in your model:
+
+```ruby
+class User < ActiveRecord::Base
+  
+  # ...
+
+  validates :url, url_format: true
+
+  # ...
+
+end
+```
+
+Now the url attribute will be validated accordingly:
+
+```ruby
+User.new(url: 'http://example.com').valid? # => true
+User.new(url: 'invalid_url..com').valid?    # => false
+```
+
+Also, the model in question doesn't need to inherit from ActiveRecord::Base, you only need to `include ActiveModel::Validations` in your class:
+
+```ruby
+require 'url_format'
+
+class Awesome
+  include ActiveModel::Validations
+
+  attr_accessor :url
+
+  validates :url, url_format: true
+
+  def domain
+    UrlFormat.get_domain(url)
+  end
+end
+
+awesome = Awesome.new
+
+awesome.url = "www.example.com"
+awesome.valid? # => true
+awesome.url    # => 'http://www.example.com'
+awesome.domain # => 'example.com'
+
+awesome.url = "invalid_url"
+awesome.valid? # => false
+```
+
+The gem can ensure that a url is prefixed with `http://` as well:
+
+```ruby
+UrlFormat.ensure_http_prefix('google.com')         # => 'http://google.com'
+UrlFormat.ensure_http_prefix('https://google.com') # => 'https://google.com'
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/url_format.rb

@@ -5,8 +5,13 @@ require "uri"
 module UrlFormat
 
   def self.get_domain(url)
-    host = URI.parse(url).host.downcase
+    host = URI.parse(ensure_http_prefix(url)).host.downcase
     host.start_with?('www.') ? host[4..-1] : host
-  rescue URI::InvalidURIError
+  rescue URI::InvalidURIError, NoMethodError
+  end
+
+  def self.ensure_http_prefix(url)
+    return url if url =~ /\Ahttps?:\/\//
+    "http://#{url}"
   end
 end

data/lib/url_format/url_format_validator.rb

@@ -9,8 +9,7 @@ class UrlFormatValidator < ActiveModel::EachValidator
   end
 
   def format_value(record, attribute, value)
-    return value if value =~ /\Ahttps?:\/\//
-    record.send("#{attribute}=","http://#{value}")
+    record.send("#{attribute}=",UrlFormat.ensure_http_prefix(value))
   end
 
   # Thanks to Dean Perry and Ryan Bates 

data/lib/url_format/version.rb

@@ -1,3 +1,3 @@
 module UrlFormat
-  VERSION = "0.0.8"
+  VERSION = '1.0.0'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'active_model'
+require 'url_format'
+
+class FakeModel
+  include ActiveModel::Validations
+  attr_accessor :url
+  validates :url, url_format: true, allow_blank: true
+end

data/spec/url_format_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe UrlFormat do
+
+  subject { UrlFormat }
+
+  describe '.get_domain' do
+
+    let(:urls_with_domains) {
+      {
+        'http://google.com' => 'google.com',
+        'https://fake.google.com' => 'fake.google.com',
+        'www.fake.google.com/fake_stuff' => 'fake.google.com',
+        'fake.fake.google.com' => 'fake.fake.google.com'
+      }
+    }
+
+    it 'should return the proper domain' do
+      urls_with_domains.each do |url, domain|
+        expect(subject.get_domain(url)).to eq(domain)
+      end
+    end
+  end
+
+  describe '.ensure_http_prefix' do
+
+    context 'without a prefix' do
+
+      let(:url) { 'www.google.com' }
+
+      it 'should prefix with http://' do
+        expect(subject.ensure_http_prefix(url)).to eq("http://#{ url }")
+      end
+    end
+
+    context 'with a prefix' do
+
+      let(:urls) { %w(http://google.com https://google.com) }
+
+      it 'should not modify the url' do
+        urls.each do |url|
+          expect(subject.ensure_http_prefix(url)).to eq(url)
+        end
+      end
+    end
+  end
+end

data/spec/url_format_validator_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe UrlFormatValidator do
+
+  let(:fake_model) { FakeModel.new }
+
+  context 'with valid urls' do
+
+    let(:valid_urls) { %w(http://google.com https://www.google.com www.google.com google.com) }
+
+    it 'should be happy' do
+      valid_urls.each do |url|
+        fake_model.url = url
+        expect(fake_model.valid?).to be_truthy
+      end
+    end
+  end
+
+  context 'with invalid urls' do
+
+    let(:invalid_urls) { %w(invalid http://invalid..com, invalid..com) }
+
+    it 'should not be happy' do
+      invalid_urls.each do |invalid_url|
+        fake_model.url = invalid_url
+        expect(fake_model.valid?).to be_falsey
+      end
+    end
+  end
+end

data/url_format.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activemodel"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

metadata

@@ -1,55 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: url_format
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
 platform: ruby
 authors:
 - John Otander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2015-01-27 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.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: Validate the url format of an attribute.
@@ -59,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,6 +82,9 @@ files:
 - lib/url_format.rb
 - lib/url_format/url_format_validator.rb
 - lib/url_format/version.rb
+- spec/spec_helper.rb
+- spec/url_format_spec.rb
+- spec/url_format_validator_spec.rb
 - url_format.gemspec
 homepage: https://github.com/johnotander/url_format
 licenses:
@@ -78,18 +96,21 @@ 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.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Validate the url format of an attribute.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/url_format_spec.rb
+- spec/url_format_validator_spec.rb