bmatch 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 731552d40e900fde0658bcd649f5d5fa95d903a7
+  data.tar.gz: adcb836f48404f2a7631740155bc0e9d2ad4cdf7
+SHA512:
+  metadata.gz: 7e71ed9e202edb6d14c6d123fbf1b62c0976ea333c2ade13e0ef16a0fc5eedde824f1167fcf03e5b99406817140b1e82c65d7ea0d2128a8c4257dedf26613caa
+  data.tar.gz: 88a5715d6643d0fdac36e61d818f68289c37c7b44fb128ede9007ec6fb19a983638c6beec7b3c9b22e58d17e3a27244d6350b9ad3971d0fa033de59b164cec97

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+# .ruby-gemset
+spec/examples.txt
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+ext/*.so
+ext/*.h

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Udo Groebner
+
+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,33 @@
+# bmatch
+
+[![Build
+Status](https://semaphoreci.com/api/v1/projects/d08731e1-78d1-4bfa-9cd5-3789d02e369d/558462/badge.svg)](https://semaphoreci.com/udo-groebner/bmatch)
+[![Gem
+Version](https://badge.fury.io/rb/bmatch.svg)](http://badge.fury.io/rb/bmatch)
+
+Approximate string matching library (with native bindings)
+
+Inspired by
+* http://blog.paracode.com/2015/08/28/ruby-and-go-sitting-in-a-tree/
+* https://github.com/flori/amatch
+* https://blog.jcoglan.com/2012/07/29/your-first-ruby-native-extension-c/
+* http://yorickpeterse.com/articles/hacking-extconf-rb/
+
+Levenshtein implementation taken from: https://github.com/arbovm/levenshtein
+
+## Why
+
+Because amatch unfortunately produces segfaults. I hope golang-to-C doesn't do that.
+
+## Usage
+
+```ruby
+  require 'bmatch/similarities'
+  Similarities.levenshtein_distance("aa", "aü")
+  Similarities.dice_similarity("night", "nacht")
+```
+
+## Contributing
+
+Just send me a github pull request.
+

data/bmatch.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require File.expand_path('../lib/bmatch/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "bmatch"
+  s.version = Bmatch::VERSION
+  s.authors = ["Udo Groebner"]
+  s.email = "udo.groebner@crealytics.com"
+  s.homepage = "https://github.com/udl/bmatch"
+  s.licenses = ["MIT"]
+  s.summary = "Library for string similarities."
+  s.description = "Provides string similarity functions like levenshtein distance or dice's coefficient as native extensions."
+  s.rubygems_version = ">= 1.3"
+  s.required_ruby_version = ">= 1.9.3"
+  s.platform    = Gem::Platform::RUBY
+  s.extensions = ['ext/extconf.rb']
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+
+  s.add_dependency 'ffi', '~> 1.9'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'rspec', '~> 3.3'
+end

data/ext/Makefile

@@ -0,0 +1,5 @@
+all:
+	true
+
+install:
+	true

data/ext/build.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+go build -buildmode=c-shared -o similarities.so similarities.go

data/ext/extconf.rb

@@ -0,0 +1,23 @@
+require 'mkmf'
+
+# Stops the installation process if one of these commands is not found in
+# $PATH.
+find_executable('go')
+
+# Create a dummy extension file. Without this RubyGems would abort the
+# installation process. On Linux this would result in the file "bmatch.so"
+# being created in the current working directory.
+#
+# Normally the generated Makefile would take care of this but since we
+# don't generate one we'll have to do this manually.
+#
+File.open(File.join(Dir.pwd, 'bmatch.' + RbConfig::CONFIG['DLEXT']), "w") {}
+
+Dir.chdir(File.dirname(__FILE__)) do
+  `go build -buildmode=c-shared -o similarities.so similarities.go`
+end
+
+# This is normally set by calling create_makefile() but we don't need that
+# method since we'll provide a dummy Makefile. Without setting this value
+# RubyGems will abort the installation.
+$makefile_created = true

data/ext/similarities.go

@@ -0,0 +1,115 @@
+package main
+
+import (
+	"C"
+)
+
+type BiGram struct{ a, b rune }
+
+func CreateBiGrams(s string) map[BiGram]bool {
+	result := make(map[BiGram]bool)
+	end := rune(0)
+	for i, c := range s {
+		if i > 0 {
+			result[BiGram{end, c}] = true
+		}
+		end = c
+	}
+	return result
+}
+
+//export dice_similarity
+func dice_similarity(s1in, s2in *C.char) float32 {
+	s1 := C.GoString(s1in)
+	s2 := C.GoString(s2in)
+	bigram1, bigram2 := CreateBiGrams(s1), CreateBiGrams(s2)
+	// ruby only supports float32
+	var numIntersects float32
+	for first, _ := range bigram1 {
+		if bigram2[first] {
+			numIntersects += 1
+		}
+	}
+	return 2.0 * numIntersects / float32(len(bigram1)+len(bigram2))
+}
+
+func main() {}
+
+// all of the following is taken and slightly adjusted to compile with exported function
+// from https://github.com/arbovm/levenshtein/blob/master/levenshtein.go
+
+//Copyright (c) 2015, Arbo von Monkiewitsch All rights reserved.
+
+//Redistribution and use in source and binary forms, with or without
+//modification, are permitted provided that the following conditions are
+//met:
+
+//1. Redistributions of source code must retain the above copyright
+//notice, this list of conditions and the following disclaimer.
+
+//2. 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.
+
+//3. Neither the name of the copyright holder nor the names of its
+//contributors may 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
+//HOLDER 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.
+
+// Calculate the Levenshtein distance between two strings
+
+//export levenshtein_distance
+func levenshtein_distance(s1in, s2in *C.char) int {
+	s1 := C.GoString(s1in)
+	s2 := C.GoString(s2in)
+	var cost, lastdiag, olddiag int
+	len_s1 := len([]rune(s1))
+	len_s2 := len([]rune(s2))
+
+	column := make([]int, len_s1+1)
+
+	for y := 1; y <= len_s1; y++ {
+		column[y] = y
+	}
+
+	for x := 1; x <= len_s2; x++ {
+		column[0] = x
+		lastdiag = x - 1
+		for y := 1; y <= len_s1; y++ {
+			olddiag = column[y]
+			cost = 0
+			if s1[y-1] != s2[x-1] {
+				cost = 1
+			}
+			column[y] = min(
+				column[y]+1,
+				column[y-1]+1,
+				lastdiag+cost)
+			lastdiag = olddiag
+		}
+	}
+	return column[len_s1]
+}
+func min(a, b, c int) int {
+	if a < b {
+		if a < c {
+			return a
+		}
+	} else {
+		if b < c {
+			return b
+		}
+	}
+	return c
+}

data/lib/bmatch/similarities.rb

@@ -0,0 +1,7 @@
+require 'ffi'
+module Similarities
+  extend FFI::Library
+  ffi_lib File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "ext", "similarities.so"))
+  attach_function :dice_similarity, [:string, :string], :float
+  attach_function :levenshtein_distance, [:string, :string], :int
+end

data/lib/bmatch/version.rb

@@ -0,0 +1,3 @@
+module Bmatch
+    VERSION = "0.0.2"
+end

data/spec/bmatch/similarities_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'bmatch/similarities'
+RSpec.describe Similarities do
+
+  context "#dice_similarity" do
+    it "has a similarity of 1 for the same string" do
+      expect(Similarities.dice_similarity("aa", "aa")).to be 1.0
+    end
+
+    it "has a similarity of 1/4 for 'night' and 'nacht'" do
+      expect(Similarities.dice_similarity("night", "nacht")).to be 0.25
+    end
+
+    it "also works for utf-8" do
+      expect(Similarities.dice_similarity("münchen", "munich")).to be 0.1818181872367859
+    end
+  end
+
+  context "#levenshtein_distance" do
+    it "has a distance of 0 for the same string" do
+      expect(Similarities.levenshtein_distance("aa", "aa")).to be 0
+    end
+
+    it "has a distance of 1 for a one-off string" do
+      expect(Similarities.levenshtein_distance("aa", "ab")).to be 1
+    end
+
+    it "also works for utf-8" do
+      expect(Similarities.levenshtein_distance("aa", "aü")).to be 1
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: bmatch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Udo Groebner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Provides string similarity functions like levenshtein distance or dice's
+  coefficient as native extensions.
+email: udo.groebner@crealytics.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- bmatch.gemspec
+- ext/Makefile
+- ext/build.sh
+- ext/extconf.rb
+- ext/similarities.go
+- lib/bmatch/similarities.rb
+- lib/bmatch/version.rb
+- spec/bmatch/similarities_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/udl/bmatch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Library for string similarities.
+test_files: []