url_formatter 0.0.1.alpha → 0.0.1

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Bates
+
+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,34 @@
+# URL Formatter
+
+Format and validate a URL attribute in Active Record. This is an example gem created for [RailsCasts episode #301](http://railscasts.com/episodes/301-extracting-a-ruby-gem).
+
+
+## Installation
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem "url_formatter"
+```
+
+**Requires Ruby 1.9.2 or later.**
+
+
+## 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 Comment < 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.
+
+
+## Development
+
+Questions or problems? Please post them on the [issue tracker](https://github.com/ryanb/url_formatter/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests passing by running `bundle` and `rake`.
+
+This gem is created by Ryan Bates and is under the MIT License.

data/lib/url_formatter/model_additions.rb

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

data/lib/url_formatter/railtie.rb

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

data/lib/url_formatter/version.rb

@@ -1,3 +1,3 @@
 module UrlFormatter
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.0.1"
 end

data/spec/spec_helper.rb

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

data/spec/url_formatter/model_additions_spec.rb

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

data/spec/url_formatter_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe UrlFormatter do
+  describe ".format_url" do
+    it "adds http:// to a URL if not provided" do
+      UrlFormatter.format_url("example.com").should eq("http://example.com")
+    end
+
+    it "does not add http:// to a URL if already provided" do
+      UrlFormatter.format_url("http://example.com").should eq("http://example.com")
+    end
+
+    it "returns an invalid URL unchanged" do
+      UrlFormatter.format_url("foo bar").should eq("foo bar")
+      UrlFormatter.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(UrlFormatter.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(UrlFormatter.url_regexp)
+      end
+    end
+  end
+end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: url_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
-  prerelease: 6
+  version: 0.0.1
+  prerelease: 
 platform: ruby
 authors:
 - Ryan Bates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-21 00:00:00.000000000 Z
+date: 2011-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70221063413020 !ruby/object:Gem::Requirement
+  requirement: &70208597576560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221063413020
+  version_requirements: *70208597576560
 - !ruby/object:Gem::Dependency
   name: supermodel
-  requirement: &70221063412600 !ruby/object:Gem::Requirement
+  requirement: &70208597575760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221063412600
+  version_requirements: *70208597575760
 description: ! 'Example of creating a Ruby Gem for RailsCasts episode #301'
 email:
 - ryan@railscasts.com
@@ -41,10 +41,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- CHANGELOG.md
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/url_formatter.rb
+- lib/url_formatter/model_additions.rb
+- lib/url_formatter/railtie.rb
 - lib/url_formatter/version.rb
+- spec/spec_helper.rb
+- spec/url_formatter/model_additions_spec.rb
+- spec/url_formatter_spec.rb
 - url_formatter.gemspec
 homepage: https://github.com/ryanb/url_formatter
 licenses: []
@@ -58,16 +67,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1712855206576306572
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: 1712855206576306572
 requirements: []
 rubyforge_project: url_formatter
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Format and validate a URL in Active Record
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/url_formatter/model_additions_spec.rb
+- spec/url_formatter_spec.rb