urlify 0.2.0

data/README.md

@@ -0,0 +1,74 @@
+URLify
+======
+
+A tiny library to convert diacritical marks to unaccented equivalents, for
+ASCII-safe URI creation. It also includes a utility method to remove subtitles.
+
+
+Installation
+------------
+
+    sudo gem install urlify
+
+URLify is available from [Gemcutter][gc] and in source form on [GitHub][gh].
+
+[gc]: http://gemcutter.org/gems/stylish
+[gh]: http://github.com/ionfish/urlify
+
+
+API
+---
+
+    URLify.deaccentuate "Kurt Gödel"        # => "Kurt Godel"
+    
+    URLify.strip_subtitle "Begriffsschrift:
+      eine der arithmetischen nachgebildete
+      Formelsprache des reinen Denkens"     # => "Begriffsschrift"
+    
+    URLify.urlify "Über Sinn und Bedeutung" # => "uber_sinn_und_bedeutung"
+    
+    URLify.urlify "Moses Schönfinkel", "-"  # => "moses-schoenfinkel"
+
+The `URLify` module may be mixed into the `String` class to add the above class
+methods--`deaccentuate`, `strip_subtitle` and `urlify`--as instance methods on
+the `String` class. It is not mixed in by default, for obvious reasons.
+
+    class String
+      include URLify
+    end
+    
+    "Grundzüge der theoretischen Logik".urlify
+      # => "grundzuge_der_theoretischen_logik"
+
+Please note that non-`a-z` characters are removed by the `deaccentuate` and
+`urlify` methods, and only characters in URLify's accent library will be
+replaced by their ASCII counterparts. If the library doesn't include a
+particular conversion, please consider forking the project and adding it.
+
+
+Licence
+-------
+
+Copyright (c) 2009, Benedict Eastaugh. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+*   Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+*   Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+*   The name of the author may not be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'lib/urlify'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "urlify"
+    s.summary = "Convert accented characters to their ASCII equivalents"
+    s.email = "benedict@eastaugh.net"
+    s.homepage = "http://ionfish.github.com/urlify/"
+    s.description = "A small library for converting accented characters " +
+                    "to their ASCII equivalents."
+    s.authors = ["Benedict Eastaugh"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install " +
+       "technicalpickles-jeweler -s http://gems.github.com"
+end
+
+task :default => :test
+
+desc "Run the URLify test suite"
+task :test do
+  require 'test/unit'
+  
+  testdir = "test"
+  Dir.foreach(testdir) do |f|
+    path = "#{testdir}/#{f}"
+    if File.ftype(path) == "file" && File.basename(f).match(/_test.rb$/)
+      load path
+    end
+  end
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 0
+:major: 0

data/lib/urlify.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+module URLify
+  
+  URLIFY_PATH = File.expand_path(File.dirname(__FILE__)) + '/urlify/'
+  require URLIFY_PATH + 'accents'
+  
+  # Converts an input string into a URL-safe string.
+  # 
+  # * Leading and trailing whitespace is removed.
+  # * Diacritics are removed from all characters.
+  # * All letters are converted to lower case.
+  # * Remaining whitespace is replaced with separators.
+  # * Any remaining character which is not a letter, a digit or a valid
+  #   separator is removed.
+  # 
+  # Only underscores, dashes, plus signs and the empty string are allowed as
+  # separators, although combinations are permitted, so "_", "--", "+_-" and ""
+  # are all valid separators.
+  def self.urlify(string, separator = "_")
+    unless separator =~ /^[\-\_\+]*$/
+      separator = "_"
+    end
+    
+    deaccentuate(strip_subtitle(string.strip)).
+      downcase.
+      gsub(/\s/, separator).
+      gsub(/[^a-z\d\_\-\+]/, "")
+  end
+  
+  # Removes everything from a string after the first colon.
+  #
+  # Ensures that titles with really long subtitles don't convert to equally
+  # long permalinks.
+  def self.strip_subtitle(string)
+    string.split(/\s*\:\s*/).first
+  end
+  
+  # Removes diacritics from an input string's characters.
+  # 
+  # So a lowercase 'u' with an umlaut, ü, becomes u, while an uppercase 'A'
+  # with an acute accent, Á, becomes A. This method is UTF-8 safe.
+  def self.deaccentuate(string)
+    (RUBY_VERSION >= "1.9.0" ? string.chars : string.split(//u)).map {|c|
+      ACCENTMAP[c] || c
+    }.join("")
+  end
+  
+  # Instance method version of URLify.urlify, so that the library can be used
+  # as a mixin for the String class.
+  def urlify(separator = "_")
+    URLify.urlify(self, separator)
+  end
+  
+  # Instance method version of URLify.strip_subtitle, so that the library can
+  # be used as a mixin for the String class.
+  def strip_subtitle
+    URLify.strip_subtitle(self)
+  end
+  
+  # Instance method version of URLify.deaccentuate, so that the library can be
+  # used as a mixin for the String class.
+  def deaccentuate
+    URLify.deaccentuate(self)
+  end
+end

data/lib/urlify/accents.rb

@@ -0,0 +1,79 @@
+# encoding: UTF-8
+
+module URLify
+  
+  ACCENTMAP = {
+    'À' => 'A',
+    'Á' => 'A',
+    'Â' => 'A',
+    'Ã' => 'A',
+    'Ä' => 'A',
+    'Å' => 'AA',
+    'Æ' => 'AE',
+    'Ç' => 'C',
+    'È' => 'E',
+    'É' => 'E',
+    'Ê' => 'E',
+    'Ë' => 'E',
+    'Ì' => 'I',
+    'Í' => 'I',
+    'Î' => 'I',
+    'Ï' => 'I',
+    'Ð' => 'D',
+    'Ł' => 'L',
+    'Ñ' => 'N',
+    'Ò' => 'O',
+    'Ó' => 'O',
+    'Ô' => 'O',
+    'Õ' => 'O',
+    'Ö' => 'O',
+    'Ø' => 'OE',
+    'Ù' => 'U',
+    'Ú' => 'U',
+    'Ü' => 'U',
+    'Û' => 'U',
+    'Ý' => 'Y',
+    'Þ' => 'Th',
+    'ß' => 'ss',
+    'à' => 'a',
+    'á' => 'a',
+    'â' => 'a',
+    'ã' => 'a',
+    'ä' => 'a',
+    'å' => 'aa',
+    'æ' => 'ae',
+    'ç' => 'c',
+    'è' => 'e',
+    'é' => 'e',
+    'ê' => 'e',
+    'ë' => 'e',
+    'ì' => 'i',
+    'í' => 'i',
+    'î' => 'i',
+    'ï' => 'i',
+    'ð' => 'd',
+    'ł' => 'l',
+    'ñ' => 'n',
+    'ń' => 'n',
+    'ò' => 'o',
+    'ó' => 'o',
+    'ô' => 'o',
+    'õ' => 'o',
+    'ō' => 'o',
+    'ö' => 'o',
+    'ø' => 'oe',
+    'ś' => 's',
+    'ù' => 'u',
+    'ú' => 'u',
+    'û' => 'u',
+    'ū' => 'u',
+    'ü' => 'u',
+    'ý' => 'y',
+    'þ' => 'th',
+    'ÿ' => 'y',
+    'ż' => 'z',
+    'Œ' => 'OE',
+    'œ' => 'oe',
+    '&' => 'and'}
+  
+end

data/pkg/.gitignore

@@ -0,0 +1 @@
+*.gem

data/test/urlify_test.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+class String
+  include URLify
+end
+
+class URLifyTest < Test::Unit::TestCase
+  
+  def setup
+    @philosopher = "Søren Kierkegaard"
+    @biography   = "Boyd: The Fighter Pilot Who Changed the Art of War"
+  end
+  
+  def test_subtitle_stripping
+    assert_equal("Boyd", URLify.strip_subtitle(@biography))
+  end
+  
+  def test_mixin_subtitle_stripping
+    assert_equal("Boyd", @biography.strip_subtitle)
+  end
+  
+  def test_deaccentuation
+    assert_equal("Soeren Kierkegaard", URLify.deaccentuate(@philosopher))
+    assert_equal("Tomek Bartoszynski", URLify.deaccentuate("Tomek Bartoszyński"))
+    assert_equal("Jozef Maria Bochenski", URLify.deaccentuate("Józef Maria Bocheński"))
+    assert_equal("Jerzy Los", URLify.deaccentuate("Jerzy Łoś"))
+    assert_equal("Jan Lukasiewicz", URLify.deaccentuate("Jan Łukasiewicz"))
+    assert_equal("Chaim Perelman", URLify.deaccentuate("Chaïm Perelman"))
+  end
+  
+  def test_mixin_deaccentuation
+    assert_equal("Soeren Kierkegaard", @philosopher.deaccentuate)
+  end
+  
+  def test_urlification
+    assert_equal("soeren_kierkegaard", URLify.urlify(@philosopher))
+    assert_equal("boyd", URLify.urlify(@biography))
+  end
+  
+  def test_mixin_urlification
+    assert_equal("soeren_kierkegaard", @philosopher.urlify)
+    assert_equal("boyd", @biography.urlify)
+  end
+end

data/urlify.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{urlify}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Benedict Eastaugh"]
+  s.date = %q{2009-10-09}
+  s.description = %q{A small library for converting accented characters to their ASCII equivalents.}
+  s.email = %q{benedict@eastaugh.net}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/urlify.rb",
+     "lib/urlify/accents.rb",
+     "pkg/.gitignore",
+     "test/urlify_test.rb",
+     "urlify.gemspec"
+  ]
+  s.homepage = %q{http://ionfish.github.com/urlify/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Convert accented characters to their ASCII equivalents}
+  s.test_files = [
+    "test/urlify_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: urlify
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Benedict Eastaugh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-09 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A small library for converting accented characters to their ASCII equivalents.
+email: benedict@eastaugh.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION.yml
+- lib/urlify.rb
+- lib/urlify/accents.rb
+- pkg/.gitignore
+- test/urlify_test.rb
+- urlify.gemspec
+has_rdoc: true
+homepage: http://ionfish.github.com/urlify/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.5
+signing_key: 
+specification_version: 3
+summary: Convert accented characters to their ASCII equivalents
+test_files: 
+- test/urlify_test.rb