baptist 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@baptist --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Niklas Holmgren, Sutajio
+
+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,44 @@
+Generates a well-formed and unique URI from an array of strings.
+
+Usage
+-----
+
+    Baptist.generate('Arthur Russell')                             => 'Arthur-Russell'
+    Baptist.generate('Arthur Russell', :space => '_')              => 'Arthur_Russell'
+    Baptist.generate(['Arthur Russell', 'Calling Out of Context']) => 'Arthur-Russell/Calling-Out-of-Context'
+
+Percent encoding
+----------------
+
+Baptist will percent encode any character (except the delimiter characters explicitly added by Baptist) that is not an unreserved URI character according to RFC3986.
+
+Uniqueness
+----------
+
+To guarantee the generated URI is unique:
+
+    Baptist.generate('Arthur Russell', :multiplier => '*') do |uri|
+      Resource.find_by_uri(uri)
+    end
+
+Will take the <code>:multiplier</code> character and multiply it for each time
+the block returns <code>false</code> and add that to the end of the URI. So if
+there were three name collisions when running the code above the resulting
+URI would be <code>'Arthur-Russell-\*\*\*'</code>.
+
+The default multiplier is simply the Integer 1, which will result in an
+incrementing number being added to the end of the URI.
+
+Options
+-------
+
+* <code>:space</code> - Space character (default: '-')
+* <code>:separator</code> - Separator character (default: '/')
+* <code>:multiplier</code> - The object to multiply with to find a unique URI (default: 1)
+* <code>:encoding</code> - Force this encoding (default: 'UTF-8')
+
+Author
+------
+
+Baptist was created by Niklas Holmgren (niklas@sutajio.se) and released under
+the MIT license.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :default => [:test]
+
+task :test do
+  Dir.glob('test/**/*_test.rb').each do |file|
+    require File.expand_path(file)
+  end
+end

data/baptist.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "baptist/version"
+
+Gem::Specification.new do |s|
+  s.name        = "baptist"
+  s.version     = Baptist::VERSION
+  s.authors     = ["Niklas Holmgren"]
+  s.email       = ["niklas@sutajio.se"]
+  s.homepage    = "https://github.com/sutajio/baptist"
+  s.summary     = %q{A tool for generating unique and well-formed URIs.}
+  s.description = %q{Baptist creates well-formed relative URIs from a set of strings.}
+
+  s.rubyforge_project = "baptist"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/baptist/version.rb

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

data/lib/baptist.rb

@@ -0,0 +1,111 @@
+require "baptist/version"
+
+# A tool for generating unique and well-formed URIs.
+module Baptist
+
+  SEPARATOR = '/'
+  SPACE = '-'
+  MULTIPLIER = 1
+  ENCODING = 'UTF-8'
+
+  # Generates a well-formed and unique URI from an array of strings.
+  #
+  # === Usage
+  #
+  #   Baptist.generate('Arthur Russell')                             # => 'Arthur-Russell'
+  #   Baptist.generate('Arthur Russell', :space => '_')              # => 'Arthur_Russell'
+  #   Baptist.generate(['Arthur Russell', 'Calling Out of Context']) # => 'Arthur-Russell/Calling-Out-of-Context'
+  #
+  # === Uniqueness
+  #
+  # To guarantee the generated URI is unique:
+  #
+  #   Baptist.generate('Arthur Russell', :multiplier => '*') do |uri|
+  #     Resource.find_by_uri(uri)
+  #   end
+  #
+  # Will take the <tt>:multiplier</tt> character and multiply it for each time
+  # the block returns <tt>false</tt> and add that to the end of the URI. So if
+  # there were three name collisions when running the code above the resulting
+  # URI would be 'Arthur-Russell-***'.
+  #
+  # The default multiplier is simply the Integer 1, which will result in an
+  # incrementing number being added to the end of the URI.
+  #
+  # === Options
+  #
+  #   :space - Space character (default: '-')
+  #   :separator - Separator character (default: '/')
+  #   :multiplier - The object to multiply with to find a unique URI (default: 1)
+  #   :encoding - Force this encoding (default: 'UTF-8')
+  #
+  def generate(names, options = {})
+    options = { :space => SPACE,
+                :separator => SEPARATOR,
+                :multiplier => MULTIPLIER,
+                :encoding => ENCODING }.merge(options)
+
+    names = names.is_a?(Array) ? names : [names]
+    names = names.map do |name|
+      escape(name, options)
+    end
+
+    uri = names.join(options[:separator]) +
+      (options[:modifier] ? "#{options[:space]}(#{escape(options[:modifier], options)})" : '')
+
+    if block_given?
+      (1..100).each do |i|
+        s = uri + options[:space] + (options[:multiplier] * i).to_s
+        if yield(s)
+          return s
+        end
+      end
+    end
+
+    uri
+  end
+  module_function :generate
+
+protected
+
+  def escape(s, options = {})
+    s = encode(s, options[:encoding])
+    regexp = case
+      when RUBY_VERSION >= "1.9" && s.encoding === Encoding.find('UTF-8')
+        /([^ a-zA-Z0-9_.-]+)/u
+      else
+        /([^ a-zA-Z0-9_.-]+)/n
+      end
+    s.to_s.gsub(regexp) {
+      '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
+    }.tr(' ', options[:space])
+  end
+  module_function :escape
+
+  # Converts string to given encoding; uses String#encode under Ruby 1.9 and
+  # does nothing under 1.8.
+  if ''.respond_to?(:encode)
+    def encode(s, encoding)
+      s.to_s.encode(encoding)
+    end
+  else
+    def encode(s, encoding)
+      s.to_s
+    end
+  end
+  module_function :encode
+
+  # Return the bytesize of String; uses String#size under Ruby 1.8 and
+  # String#bytesize under 1.9.
+  if ''.respond_to?(:bytesize)
+    def bytesize(string)
+      string.bytesize
+    end
+  else
+    def bytesize(string)
+      string.size
+    end
+  end
+  module_function :bytesize
+
+end

data/test/baptist_test.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+require 'test/unit'
+require 'baptist'
+
+class BaptistTest < Test::Unit::TestCase
+
+  def test_spaces
+    assert_equal 'Arthur-Russell', Baptist.generate('Arthur Russell')
+    assert_equal 'Arthur_Russell', Baptist.generate('Arthur Russell', :space => '_')
+    assert_equal 'Maher-Shalal-Hash-Baz', Baptist.generate('Maher Shalal Hash Baz')
+  end
+
+  def test_multiple_names
+    assert_equal 'Arthur-Russell/Calling-Out-of-Context', Baptist.generate(['Arthur Russell', 'Calling Out of Context'])
+    assert_equal 'Arthur-Russell|Calling-Out-of-Context', Baptist.generate(['Arthur Russell', 'Calling Out of Context'], :separator => '|')
+  end
+
+  def test_strange_characters
+    assert_equal 'Tr%C3%A4d%2C-Gr%C3%A4s-och-Stenar', Baptist.generate('Träd, Gräs och Stenar')
+  end
+
+  def test_modifier
+    assert_equal 'Rihanna/Loud-(Explicit)', Baptist.generate(['Rihanna', 'Loud'], :modifier => 'Explicit')
+  end
+
+  def test_unique
+    assert_equal 'John-Doe-3', Baptist.generate('John Doe') {|uri| uri == 'John-Doe-3' }
+    assert_equal 'John-Doe-1000', Baptist.generate('John Doe', :multiplier => 10) {|uri| uri == 'John-Doe-1000' }
+    assert_equal 'John-Doe-***', Baptist.generate('John Doe', :multiplier => '*') {|uri| uri == 'John-Doe-***' }
+  end
+
+end

data/test/encoding_test.rb

@@ -0,0 +1,12 @@
+# encoding: ISO-8859-1
+
+require 'test/unit'
+require 'baptist'
+
+class BaptistTest < Test::Unit::TestCase
+
+  def test_forces_utf_8
+    assert_equal 'Tr%C3%A4d-Gr%C3%A4s-och-Stenar', Baptist.generate('Tr�d Gr�s och Stenar')
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: baptist
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Niklas Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-15 00:00:00 Z
+dependencies: []
+
+description: Baptist creates well-formed relative URIs from a set of strings.
+email: 
+- niklas@sutajio.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- baptist.gemspec
+- lib/baptist.rb
+- lib/baptist/version.rb
+- test/baptist_test.rb
+- test/encoding_test.rb
+homepage: https://github.com/sutajio/baptist
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: baptist
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A tool for generating unique and well-formed URIs.
+test_files: 
+- test/baptist_test.rb
+- test/encoding_test.rb