koelner_phonetic_encoder 1.0.3

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+group :test do
+  gem "rspec"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Michael Kohl, Anton Bangratz
+
+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.mkd

@@ -0,0 +1,21 @@
+# Koelner Phonetic Encoder
+
+by Michael Kohl <michi@tupalo.com>, Anton Bangratz <anton@tupalo.com>
+
+This is a ruby implementation of the [Kölner Phonetic (Kölner Verfahren)](http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik) phonetic algorithm that tries to match strings to a phonetic code. This should assist by comparing similar souding german words.
+
+Including the library will enhance the String class of the standard library with the __phonetic_code__ method.
+
+## Usage
+
+	require 'koelner_phonetic_encoder'
+
+	"Wikipedia".phonetic_code # => '3412'
+
+## LICENSE
+
+see LICENSE
+
+## HOMEPAGE
+
+[self](http://github.com/tupalo/koelner_phonetic_encoder)

data/lib/koelner_phonetic_encoder.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+require 'koelner_phonetic_encoder/koelner_phonetic_encoder'
+require 'koelner_phonetic_encoder/version'
+require 'koelner_phonetic_encoder/string'

data/lib/koelner_phonetic_encoder/koelner_phonetic_encoder.rb

@@ -0,0 +1,69 @@
+#encoding: utf-8
+module KoelnerPhoneticEncoder
+  def phonetic_code
+    code = KoelnerPhoneticEncoder.encode_string(self.to_str)
+    code = KoelnerPhoneticEncoder.reduce_multiples(code)
+    KoelnerPhoneticEncoder.remove_zeroes(code)
+  end
+
+  def self.encode_string(string)
+    string = string.downcase.gsub('ß','ss').gsub('ä', 'ae').gsub('ö', 'oe').gsub('ü', 'ue')
+    code = ''
+    syllable_onset = true
+    characters = string.split('') + %w[- -]
+    characters.each_cons(3) do |slice|
+      case slice.join
+      when /^[aeioujy]/ then
+        code << '0'
+      when /^b/ then
+        code << '1'
+      when /^p[^h]/  then
+          code << '1'
+      when /^ph/ then
+          code << '3'
+      when /^[dt][^csz]/ then
+          code << '2'
+      when /^[dt][csz]/ then
+          code << '8'
+      when /^[fvw]/
+        code << '3'
+      when /^[gkq]/
+        code << '4'
+      when /^c[ahkloqrux]/ && syllable_onset
+        code << '4'
+      when /^[^sz]c[ahkloqrux]/ 
+        code << '4'
+      when /^[^cqk]x/ 
+        code << '48'
+      when /^l/
+        code << '5'
+      when /^[mn]/
+        code << '6'
+      when /^r/
+        code << '7'
+      when /^[sz]/
+        code << '8'
+      when /^[sz]c/
+        code << '8'
+      when /^c[^ahkloqrux]/ && syllable_onset
+        code << '8'
+      when /^c[^ahkoqux]/ 
+        code << '8'
+      when /^[ckq]x/
+        code << '8'
+      end
+      syllable_onset = false
+    end
+    code
+  end
+  def self.reduce_multiples(code)
+    code.gsub /(\d)\1/, '\1'
+  end
+  def self.remove_zeroes(code)
+    unless code.empty?
+      code[0..0] << code[1..-1].delete('0') 
+    else
+      code
+    end
+  end
+end

data/lib/koelner_phonetic_encoder/string.rb

@@ -0,0 +1,3 @@
+class String
+  include KoelnerPhoneticEncoder
+end

data/lib/koelner_phonetic_encoder/version.rb

@@ -0,0 +1,3 @@
+module KoelnerPhoneticEncoder
+  VERSION = "1.0.2"
+end

data/spec/koelner_phonetic_encoder_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe KoelnerPhoneticEncoder do
+  it "should enhance string with the 'phonetic code' method" do
+    "MyString".should respond_to(:phonetic_code)
+  end
+  it "should return the correct values for the known strings" do
+    "Wikipedia".phonetic_code.should == '3412'
+    "Breschnew".phonetic_code.should == '17863'
+    "Müller-Lüdenscheidt".phonetic_code.should == '65752682'
+  end
+  it "should encode a string to a raw code string per letter (2 per umlaut)" do
+    KoelnerPhoneticEncoder.encode_string("Müller-Lüdenscheidt").should == '600550750020680022'
+    KoelnerPhoneticEncoder.encode_string("Müller-Lüdenscheidt").size.should == 18
+  end
+  it "should remove all duplicated codes from a code string" do
+    code = KoelnerPhoneticEncoder.encode_string("Müller-Lüdenscheidt")
+    KoelnerPhoneticEncoder.reduce_multiples(code).should == '6050750206802'
+  end
+  it "should remove all 0 codes except at the beginning" do
+    KoelnerPhoneticEncoder.remove_zeroes('6050750206802').should == '65752682'
+    KoelnerPhoneticEncoder.remove_zeroes('06050750206802').should == '065752682'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require './lib/koelner_phonetic_encoder'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: koelner_phonetic_encoder
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
+platform: ruby
+authors: 
+- Michael Kohl
+- Anton Bangratz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-23 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- michi@tupalo.com
+- tony@tupalo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/koelner_phonetic_encoder.rb
+- lib/koelner_phonetic_encoder/koelner_phonetic_encoder.rb
+- lib/koelner_phonetic_encoder/string.rb
+- lib/koelner_phonetic_encoder/version.rb
+- spec/koelner_phonetic_encoder_spec.rb
+- spec/spec_helper.rb
+- README.mkd
+- LICENSE
+- Gemfile
+has_rdoc: false
+homepage: https://github.com/tupalo/koelner_phonetic_encoder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "An implementation of the K\xC3\xB6lner Phonetik phonetic algorithm"
+test_files: []
+