format_url 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01401f671d38bf76fdc22da5c9f0aaea4595d93d
+  data.tar.gz: 0fdc81d55b5fb80b8beb688c150afb1181c6b212
+SHA512:
+  metadata.gz: 7f9cb2ade538ad4668d0694caae880eed88463d3a7dbb1413e302d4d0cad04c597c49cb8bba62f7d53d1c5d230ae81f72b966df21ec2f36a6abafee2862a51c5
+  data.tar.gz: cdf8136751c2057aae94e75b9ec1daf2e1901e20aa83c9bf6053d1c5429bc8fba65d85017762982fe315ae0210c902ae17a26528d00ae1ac6a637a38de4a4c43

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Hopkinson
+
+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,36 @@
+# FormatUrl
+
+Format and validate a URL attribute in Active Record. This is an example gem created and based on [RailsCasts episode #301](http://railscasts.com/episodes/301-extracting-a-ruby-gem).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'format_url'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install format_url
+
+## Usage
+Call `format_url` in an ActiveRecord class and pass the name of the attribute you wish to format into a URL and validate.
+
+```ruby
+class MyClass < ActiveRecord::Base
+	format_url :website
+end
+```
+ 
+This will automatically add "http://" to the beginning of the `website` attribute upon saving if no protocol is present. It will also do validation to ensure it looks like a URL.
+ 
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/format_url.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'format_url/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "format_url"
+  spec.version       = FormatUrl::VERSION
+  spec.authors       = ["David Hopkinson"]
+  spec.email         = ["david@pinchtozoom.co.uk"]
+  spec.description   = %q{Format and validation a URL in active record}
+  spec.summary       = %q{An example of formatting a url based on Railscast Episode #301. Ryan Rocks!}
+  spec.homepage      = "https://github.com/pinchtozoom/format_url"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "rspec"
+  spec.add_development_dependency "supermodel"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/format_url.rb

@@ -0,0 +1,17 @@
+require "format_url/version"
+require "format_url/model_additions"
+require "format_url/railtie" if defined? Rails
+
+module FormatUrl
+  def self.format_url(url)
+    if url.to_s !~ url_regexp && "http://#{url}" =~ url_regexp
+      "http://#{url}"
+    else
+      url
+    end
+  end
+
+  def self.url_regexp
+    /^https?:\/\/([^\s:@]+:[^\s:@]*@)?[-[[:alnum:]]]+(\.[-[[:alnum:]]]+)+\.?(:\d{1,5})?([\/?]\S*)?$/iux
+  end
+end

data/lib/format_url/model_additions.rb

@@ -0,0 +1,10 @@
+module FormatUrl
+  module ModelAdditions
+    def format_url(attribute)
+      before_validation do
+        send("#{attribute}=", FormatUrl.format_url(send(attribute)))
+      end
+      validates_format_of attribute, with: FormatUrl.url_regexp, message: "is not a valid URL"
+    end
+  end
+end

data/lib/format_url/railtie.rb

@@ -0,0 +1,9 @@
+module FormatUrl
+  class Railtie < Rails::Railtie
+    initializer 'format_url.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/format_url/version.rb

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

data/spec/format_url/model_additions_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+class User < SuperModel::Base
+  include ActiveModel::Validations::Callbacks
+  extend FormatUrl::ModelAdditions
+  format_url :website
+end
+
+describe FormatUrl::ModelAdditions do
+  it "adds http:// to URL upon saving" do
+    User.create!(website: "example.com").website.should eq("http://example.com")
+    User.create!(website: "http://example.com").website.should eq("http://example.com")
+  end
+
+  it "validates URL format" do
+    user = User.new(website: "foo bar")
+    user.should_not be_valid
+    user.errors[:website].should eq(["is not a valid URL"])
+    user.website = "example.com"
+    user.should be_valid
+  end
+end

data/spec/format_url_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe FormatUrl do
+  describe ".format_url" do
+    it "adds http:// to a URL if not provided" do
+      FormatUrl.format_url("example.com").should eq("http://example.com")
+    end
+
+    it "does not add http:// to a URL if already provided" do
+      FormatUrl.format_url("http://example.com").should eq("http://example.com")
+    end
+
+    it "returns an invalid URL unchanged" do
+      FormatUrl.format_url("foo bar").should eq("foo bar")
+      FormatUrl.format_url(nil).should eq(nil)
+    end
+  end
+
+  describe ".url_regexp" do
+    it "matches valid URLs" do
+      [
+        'http://example.com/',
+        'HTTP://E-XAMLE.COM',
+        'https://example.co.uk./foo',
+        'http://example.com:8080',
+        'http://www.example.com/anything/after?slash',
+        'http://www.example.com?anything_after=question',
+        'http://user123:sEcr3t@example.com',
+        'http://user123:@example.com',
+        'http://example.com/~user',
+        'http://1.2.3.4:8080',
+        'http://ütf8.com',
+      ].each do |url|
+        url.should match(FormatUrl.url_regexp)
+      end
+    end
+
+    it "does not match invalid URLs" do
+      [
+        "www.example.com",
+        "http://",
+        "http://example..com",
+        "http://e xample.com",
+        "http://example.com/foo bar",
+        "http://example", # technically valid but not what we want from user
+        "other://example.com", # we also don't want other protocols
+      ].each do |url|
+        url.should_not match(FormatUrl.url_regexp)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'format_url'
+require 'supermodel'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: format_url
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Hopkinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  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: 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'
+description: Format and validation a URL in active record
+email:
+- david@pinchtozoom.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- format_url.gemspec
+- lib/format_url.rb
+- lib/format_url/model_additions.rb
+- lib/format_url/railtie.rb
+- lib/format_url/version.rb
+- spec/format_url/model_additions_spec.rb
+- spec/format_url_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pinchtozoom/format_url
+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.0.3
+signing_key: 
+specification_version: 4
+summary: 'An example of formatting a url based on Railscast Episode #301. Ryan Rocks!'
+test_files:
+- spec/format_url/model_additions_spec.rb
+- spec/format_url_spec.rb
+- spec/spec_helper.rb