url_field 0.0.1

data/README.textile

@@ -0,0 +1,53 @@
+h1. URL field
+
+Sometimes you want to accept a URL field on one of your models. Take for example a Company model with a website field. You want the URL to always have "http://" but sometimes users enter http://, sometimes they dont.
+
+Your app shouldn't care. Enter the URL field plugin.
+
+This simple plugin allows you to enter either "http://www.example.com" or just "www.example.com" and in either case it will store "http://www.example.com"
+
+h2. Usage
+
+<pre><code>class Company < ActiveRecord::Base
+  url_field :website
+end
+
+@company = Company.new
+@company.website = "www.example.com"
+@company.save
+@company.website # => "http://www.example.com"
+</code></pre>
+
+Https? That works too (but one way only)
+<pre><code>@company.website = "https://www.example.com"
+@company.save
+@company.website # => "https://www.example.com"
+</code></pre>
+
+h2. Extra
+
+If you want access to the correctly formatted URL at any time (for example if you're passing it to URI.parse, before you save your model), you can prefix your URL field method name with "cleaned_" eg. "cleaned_website" if your field name was website:
+
+<pre><code>class Company < ActiveRecord::Base
+  url_field :website
+end
+
+@company = Company.new
+@company.website = "www.example.com"
+@company.cleaned_website # => "http://www.example.com"
+</code></pre>
+
+h2. Install
+
+Easy!
+
+<pre><code>./script plugin install git://github.com/paulca/url_field.git
+</code></pre>
+
+h2. About me
+
+I'm Paul Campbell. I'm an avid Ruby on Rails web developer. Follow my ramblings at "http://www.pabcas.com":http://www.pabcas.com
+
+Follow me on Twitter "http://twitter.com/paulca":http://twitter.com/paulca
+
+Copyright (c) 2009 Paul Campbell, released under the MIT license

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'spec/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "url_field"
+  s.version = "0.0.1"
+  s.author = "Paul Campbell"
+  s.email = "paul@rslw.com"
+  s.homepage = "http://www.github.com/paulca/url_field"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "A simple ActiveRecord plugin to correctly format a URL in the database whether the user enters 'http://' or not"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.textile"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "url_field")

data/lib/url_field.rb

@@ -0,0 +1,31 @@
+module UrlField
+  def self.included(base) 
+    base.extend UrlFieldMethod
+  end
+
+  module UrlFieldMethod
+    def url_field(field)
+
+      before_save :clean_url_field
+
+      class_eval do        
+        
+        define_method(:clean_url_field) do
+          self.send("#{field}=", send("cleaned_#{field}"))
+        end
+        
+        private
+        
+        define_method("cleaned_#{field}") do
+          return nil if send(field).nil? or send(field).blank?
+          return "http://#{send(field)}" unless send(field).match(/https?:\/\/.*$/)
+          send(field)
+        end
+      end
+    end
+  end
+end
+
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Base.send(:include, UrlField)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+

data/spec/url_field_spec.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require File.dirname(__FILE__) + '/../lib/url_field'
+
+class TestModel < ActiveRecord::Base
+  url_field :shortcode_url
+
+  def self.table_name
+    'boojas'
+  end
+end
+
+describe TestModel do
+  before do
+    @test_model = TestModel.new
+  end
+  
+  it "should leave well enough alone" do
+    @test_model.save
+    @test_model.shortcode_url.should be_nil
+  end
+  
+  it "should REALLY leave well enough alone" do
+    @test_model.shortcode_url = ""
+    @test_model.save
+    @test_model.shortcode_url.should be_nil
+  end
+  
+  it "should add http://" do
+    @test_model.shortcode_url = "www.example.com"
+    @test_model.save
+    @test_model.shortcode_url.should == "http://www.example.com"
+  end
+  
+  it "should ignore http://" do
+    @test_model.shortcode_url = "http://www.example.com"
+    @test_model.save
+    @test_model.shortcode_url.should == "http://www.example.com"
+  end
+  
+  it "should allow https://" do
+    @test_model.shortcode_url = "https://www.example.com"
+    @test_model.save
+    @test_model.shortcode_url.should == "https://www.example.com"
+  end
+
+  it "should ignore https://" do
+    @test_model.shortcode_url = "https://www.example.com"
+    @test_model.save
+    @test_model.shortcode_url.should == "https://www.example.com"
+  end
+  
+  it "should expose the cleaned method" do
+    @test_model.shortcode_url = "www.example.com"
+    @test_model.cleaned_shortcode_url.should == "http://www.example.com"
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: url_field
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Paul Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: paul@rslw.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- init.rb
+- lib/url_field.rb
+- Rakefile
+- README.textile
+- spec/spec_helper.rb
+- spec/url_field_spec.rb
+has_rdoc: true
+homepage: http://www.github.com/paulca/url_field
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: A simple ActiveRecord plugin to correctly format a URL in the database whether the user enters 'http://' or not
+test_files: []
+