has_url 1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Pickabee
+
+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.rdoc

@@ -0,0 +1,49 @@
+= HasUrl
+
+Adds validations on URL attributes for ActiveRecord models.
+URL scheme will be checked and added before updating the database if necessary.
+A raw_#{attribute} method will also be added to display the url without HTTP(S) scheme or trailing slash.
+
+== Usage
+
+In your AR model:
+        has_url :attribute, options
+
+Options :
+* valid_schemes : Array of schemes or single scheme accepted for the attribute. Default ['http', 'https']
+* default_scheme : Scheme appended to the attribute if none found (supply the scheme string without '://'). Default 'http'
+* message : Provide a error string or symbol (which will be translated, see ActiveRecord::Errors#generate_message). Default :invalid
+
+== Example
+
+        class Person < ActiveRecord::Base
+          has_url :blog_link
+        end
+
+        person.blog_link = 'example.com'
+        person.save
+        person.blog_link #=> 'http://example.com/'
+        person.raw_blog_link #=> 'example.com'
+
+        class Person < ActiveRecord::Base
+          has_url [:blog_link, :website_url], :default_scheme => 'https', :valid_schemes => ['http', 'https', 'ftp']
+        end
+
+== Requirements
+
+* Addressable for URI parsing
+
+== TODO
+
+* Refactor using ActiveModel::Validator
+* More tests
+* Improve the raw_ method stripping, and have it accept an option to specify which schemes to strip (schemes array or boolean to strip all valid schemes)
+* Add a shoulda macro (should_have_url)
+* Check existence of the given attributes ?
+* Optionally test the url validity with an HTTP request ?
+
+== Notes and Copyright
+
+This plugin was inspired by the {url_validation}[link:https://github.com/RISCfuture/url_validation] and {validates_url_of}[link:https://github.com/ihower/validates_url_of] plugins.
+
+Copyright (c) 2012 Pickabee. Released under the MIT licence, see LICENSE for details.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default  => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "HasUrl"
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README*', 'LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--line-numbers'
+  rdoc.options << '--charset=UTF-8'
+end
+
+desc 'Test the paperclip plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/has_url.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_url/version"
+
+Gem::Specification.new do |s|
+  s.name        = "has_url"
+  s.version     = HasUrl::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pickabee"]
+  s.email       = [""]
+  s.homepage    = "https://github.com/skateinmars/has_url"
+  s.summary     = %q{Validation on URL attributes for ActiveRecord models}
+  s.description = <<-EOL
+  Adds validations on URL attributes for ActiveRecord models.
+  URL scheme will be checked and added before updating the database if necessary.
+  A raw_attribute method will also be added to display the url without HTTP(S) scheme or trailing slash.
+  EOL
+
+  s.add_dependency "activerecord", '>= 3.0.0'
+  s.add_dependency "addressable", '>= 2.2.0'
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "shoulda", '>= 3.0.0'
+
+  s.files = Dir["LICENSE", "README.rdoc", "Gemfile", "Rakefile", "has_url.gemspec", "{lib}/**/*.rb"]
+  s.test_files = Dir["{spec}/**/*.rb"]
+  s.rdoc_options = ["--line-numbers", "--charset=UTF-8", "--title", "HasUrl", "--main", "README.rdoc"]
+  s.extra_rdoc_files = %w[LICENSE]
+  s.require_paths = ["lib"]
+end

data/lib/has_url.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'has_url/railtie' if defined?(Rails)

data/lib/has_url/hooks.rb

@@ -0,0 +1,10 @@
+module HasUrl
+  class Hooks # :nodoc:
+    def self.init
+      if defined?(ActiveRecord)
+        require 'has_url/validations'
+        ActiveRecord::Base.send(:extend, HasUrl::Validations)
+      end
+    end
+  end
+end

data/lib/has_url/railtie.rb

@@ -0,0 +1,14 @@
+module HasUrl
+  require 'rails'
+
+  class Railtie < Rails::Railtie # :nodoc:
+    railtie_name :has_url
+
+    initializer 'has_url.insert_into_active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        require 'has_url/hooks'
+        HasUrl::Hooks.init
+      end
+    end
+  end
+end

data/lib/has_url/validations.rb

@@ -0,0 +1,93 @@
+require 'addressable/uri'
+
+module HasUrl # :nodoc:
+  module Validations
+
+    # This allows you to specify attributes you want to define as containing
+    # a url. This will validate the URI and prepend a http scheme if needed.
+    # Provide this with a required attributes array (or a single attribute symbol) and an options hash.
+    #
+    # ==== Examples
+    #
+    #   class Person < ActiveRecord::Base
+    #     has_url :blog_link
+    #   end
+    #
+    #   class Person < ActiveRecord::Base
+    #     has_url [:blog_link, :website_url]
+    #   end
+    #
+    # ===== Using options
+    #
+    #   class Person < ActiveRecord::Base
+    #     has_url :blog_link, {:valid_schemes => ['http', 'https', 'ftp'], :default_scheme => 'http', :message => 'does not look like a valid url'}
+    #   end
+    #
+    def has_url(attributes, options = {})
+      attributes = [attributes].flatten
+      
+      options.reverse_merge!({:valid_schemes => ['http', 'https'], :default_scheme => 'http' })
+      
+      raise ArgumentError, "default scheme does not match a valid scheme" unless options[:valid_schemes].include?(options[:default_scheme])
+      
+      attributes.each do |attribute|
+        #Doesnt work, raises ActiveRecord::ConnectionNotEstablished
+        #raise ArgumentError, "attribute #{attribute} does not exist" if self.columns.select{|c| c.name == attribute }.empty?
+        
+        default_scheme_accessor = "#{attribute}_default_scheme".to_sym
+        valid_schemes_accessor = "#{attribute}_valid_schemes".to_sym
+        cattr_accessor default_scheme_accessor
+        self.send("#{default_scheme_accessor}=", options[:default_scheme])
+        cattr_accessor valid_schemes_accessor
+        self.send("#{valid_schemes_accessor}=", options[:valid_schemes])
+        
+        define_method( "fix_#{attribute}_url") do
+          value = read_attribute(attribute)
+          if value.blank?
+            value = nil
+          else
+            begin
+              default_scheme = self.class.send("#{attribute}_default_scheme".to_sym)
+              uri = Addressable::URI.heuristic_parse(value, {:scheme => default_scheme}).normalize
+              value = uri.to_s
+            rescue Addressable::URI::InvalidURIError
+            end
+          end
+          write_attribute( attribute, value )
+        end
+        
+        define_method( "raw_#{attribute}") do
+          value = read_attribute(attribute)
+          if value.blank?
+            return nil
+          else
+            return value.sub('http://', '').sub('https://', '').sub(/\/$/, '')
+          end
+        end
+        
+        before_validation "fix_#{attribute}_url".to_sym
+      end
+      
+      validates_each attributes do |record, attr, value|
+        if !value.nil?
+          if defined?(I18n)
+            message = options[:message] ? options[:message] : :invalid
+            error_args = [attr, message, {:value => value}]
+          else
+            error_args = [attr]
+            error_args << options[:message] if options[:message]
+          end
+          
+          begin
+            uri = Addressable::URI.heuristic_parse(value).normalize
+            scheme_is_valid = self.send("#{attr}_valid_schemes".to_sym).include?(uri.scheme)
+            record.errors.add(*error_args) unless scheme_is_valid
+          rescue Addressable::URI::InvalidURIError
+            record.errors.add(*error_args)
+          end
+        end
+      end
+    end
+      
+  end
+end

data/lib/has_url/version.rb

@@ -0,0 +1,3 @@
+module HasUrl
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: has_url
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pickabee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: ! "  Adds validations on URL attributes for ActiveRecord models.\n  URL
+  scheme will be checked and added before updating the database if necessary.\n  A
+  raw_attribute method will also be added to display the url without HTTP(S) scheme
+  or trailing slash.\n"
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- LICENSE
+- README.rdoc
+- Gemfile
+- Rakefile
+- has_url.gemspec
+- lib/has_url/validations.rb
+- lib/has_url/railtie.rb
+- lib/has_url/hooks.rb
+- lib/has_url/version.rb
+- lib/has_url.rb
+homepage: https://github.com/skateinmars/has_url
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --charset=UTF-8
+- --title
+- HasUrl
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Validation on URL attributes for ActiveRecord models
+test_files: []