phonetics 4.0.0-x86_64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c663433a5586f7094351b94e1122dc8b6eb9c0f54865173da74b3807003d143b
+  data.tar.gz: 6492f4be7ac860c5e610ed1d6ba2bd5de01271545d620300b3b528f7727c836e
+SHA512:
+  metadata.gz: ba6120dd761a21daad7c52535c9f3e1177182445723188decadb89fe429cd2c8d171569765649cc8281df8fdd65a05735aeefa4e0021be8951516bb118b0aa4d
+  data.tar.gz: 7c13fa4c9d5584a7043a60c076c33fdaae356d609df9dc2b3e36cad5c2d2c97b5694d2c1b0009287cd0aca8dcff6aa42ae461f2eb380f520bb549dd34f06a824

data/.gitignore

@@ -0,0 +1,32 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ruby-version
+*.so
+Gemfile.lock
+*.bundle
+*.bundle.dSYM
+
+# Rust extension build artifacts (mkmf-generated)
+ext/phonetics_ruby/Makefile
+ext/phonetics_ruby/Cargo.lock
+ext/phonetics_ruby/target/
+ext/phonetics_ruby/mkmf.log
+
+# Vendored Rust core. Populated by `rake vendor_rust`; shipped in
+# the .gem tarball but not tracked in git (single source of truth
+# lives at <repo>/rust/phonetics).
+ext/phonetics_ruby/vendor/
+
+# Cargo workspace build artifacts (the gem-local workspace at
+# ruby/Cargo.toml puts its target/ at ruby/target).
+target/
+Cargo.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+---
+AllCops:
+  Exclude:
+    - Rakefile
+    - tmp/**/*
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: separator
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/CHANGELOG

@@ -0,0 +1,4 @@
+
+3.2.0
+
+Weighing the vowels at half the cost for phonetic edit distance

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at github@jackcanty.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:latest
+
+RUN apt update
+RUN apt install -y valgrind
+
+RUN mkdir /app
+WORKDIR /app
+
+COPY Gemfile /app/Gemfile
+COPY Gemfile.lock /app/Gemfile.lock
+COPY phonetics.gemspec /app/phonetics.gemspec
+COPY VERSION /app/VERSION
+
+RUN bundle
+RUN apt install -y vim

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phonetics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jack Danger
+
+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,50 @@
+# Phonetics
+
+This library currently provides three utilities for anyone working with the International Phonetic Alphabet:
+* An index of vowels and consonants with their linguistic features
+* A phonetic implementation of the Levenshtein distance calculation
+* English transcriptions for ~140,000 words from a variety of sources
+
+## Exploring vowels and consonants
+
+Vowels are sounds with unimpeded airflow. We categorize them by the resonant frequencies they make in our vocal tract. When a person changes their tongue position or the rounding of their lips they change the way the sound reverberates in their skull. 
+
+The primary classification for vowels is the frequency of their lowest two resonant frequencies (called 'formants'). When we plot these on an x/y axis we get a vowel chart like this:
+
+![IPA vowel chart with 'b' words](_site/vowel_chart_b_words.jpg)
+
+
+## Phonetic Levenshtein Distance 
+Using a typical 'edit distance' algorithm, we can calculate how many
+orthographic changes are needed to transform one string into another.
+```
+require 'damerau-levenshtein'
+Levenshtein.distance('coorslight', 'budlight')
+=> 5
+```
+
+The `phonetics` gem provides a (very fast) implementation of an edit distance
+algorithm that uses phonetic feature sets (for consonants) and precise formant
+measurements (for vowels) as weights. It's a modified version of [Using
+Phonologically Weighted Levenshtein Distances for the Prediction of Microscopic
+Intelligibility](https://hal.archives-ouvertes.fr/hal-01474904/document) by
+Lionel Fontan, Isabelle Ferrané, Jérôme Farinas, Julien Pinquier, Xavier
+Aumont, 2016
+
+With this, the input strings must be valid IPA notation and the output is a phonetic-weighted distance:
+
+```
+require 'phonetics'
+Phonetics::Levenshtein.distance('kuɹzlɑɪt', 'bədlɑɪt')
+=> 1.388384
+```
+
+## Contributing
+
+Patches welcome, forks celebrated.
+
+Everyone interacting in the Phonetics project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JackDanger/phonetics/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the wide-open terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Rake tasks for the Rust-backed Ruby gem.
+#
+#   rake compile          build the native extension via cargo
+#   rake spec             run rspec
+#   rake build            assemble the source gem (vendor + package)
+#
+# Cross-platform native gem builds use rb-sys-dock; see
+# .github/workflows/release.yml for the published recipe.
+
+require 'fileutils'
+require 'bundler/gem_tasks'
+
+# ---------------------------------------------------------------
+# Vendoring of the Rust core into the gem directory.
+#
+# A gem can't ship files from outside its own directory (rubygems
+# policy), and `cargo` can't follow a path dependency that points
+# up into the parent of a `gem install`-extracted source tree. So
+# we keep the canonical Rust core at <repo>/rust/phonetics and
+# copy it into <repo>/ruby/ext/phonetics_ruby/vendor/ for builds
+# that need to ship it (gem-build, gem-install, CI).
+#
+# The vendor copy is git-ignored — single source of truth is the
+# /rust/ tree. It IS bundled into the .gem tarball at build time.
+# ---------------------------------------------------------------
+
+RUST_CORE_SRC    = File.expand_path('../rust/phonetics', __dir__)
+RUST_CORE_VENDOR = File.expand_path('ext/phonetics_ruby/vendor/phonetics', __dir__)
+
+def vendor_rust_core
+  return if File.directory?(RUST_CORE_SRC).nil?
+
+  unless File.directory?(RUST_CORE_SRC)
+    warn "(skipping vendor: #{RUST_CORE_SRC} not present)" if ENV['VERBOSE']
+    return
+  end
+  FileUtils.rm_rf(RUST_CORE_VENDOR)
+  FileUtils.mkdir_p(File.dirname(RUST_CORE_VENDOR))
+  FileUtils.cp_r(RUST_CORE_SRC, RUST_CORE_VENDOR)
+  # Strip the CLI bin and any stale build artifacts.
+  FileUtils.rm_rf(File.join(RUST_CORE_VENDOR, 'src', 'bin'))
+  FileUtils.rm_rf(File.join(RUST_CORE_VENDOR, 'target'))
+end
+
+# The downstream Cargo workspace at ruby/Cargo.toml lists the ext
+# crate as a member, and that crate's Cargo.toml has a path
+# dependency on vendor/phonetics. `cargo metadata` (which
+# `rb_sys/extensiontask` runs at load time) would fail before our
+# tasks even register. Vendor synchronously here, before any
+# require touches cargo.
+vendor_rust_core
+
+require 'rb_sys/extensiontask'
+require 'rspec/core/rake_task'
+
+desc 'Re-copy the Rust core into ext/phonetics_ruby/vendor/'
+task(:vendor_rust) { vendor_rust_core }
+
+GEMSPEC = Gem::Specification.load(File.expand_path('phonetics.gemspec', __dir__))
+
+RbSys::ExtensionTask.new('phonetics_ruby', GEMSPEC) do |ext|
+  ext.lib_dir = 'lib/phonetics'
+end
+
+# build / compile both depend on a fresh vendor copy.
+task compile: :vendor_rust
+task build:   :vendor_rust
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[compile spec]

data/VERSION

@@ -0,0 +1 @@
+4.0.0

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << '../lib'
+
+require 'bundler/setup'
+require 'pry-byebug'
+require 'phonetics'
+require 'phonetics/levenshtein'
+require 'phonetics/ruby_levenshtein'
+require 'phonetics/code_generator'
+
+Phonetics.pry

data/bin/gempush-if-changed

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -x
+
+# 'latest' is a git tag that we recreate every time we release a new
+# version. If the VERSION file has changed since `latest` then we release a
+# new version.
+git pull --tags
+if git diff --name-only HEAD latest -- VERSION | egrep -q .; then
+  # The VERSION file changed since 'latest', build the gem and push
+  gem build *.gemspec
+  gem push *.gem
+
+  git tag -f latest HEAD
+  git tag -f "v$(cat VERSION)"
+
+  git push -f origin latest
+  git push --tags
+fi

data/bin/phonetics

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Phonetics CLI — implementation-agnostic contract.
+#
+# The integration tests in spec/phonetics/cli_spec.rb shell out to this
+# binary (or any other one — set PHONETICS_BIN). What matters is
+# stdin/stdout/exit-code behaviour, not which language fields the
+# Phonetics module. With the Rust port live, this script is a thin
+# layer over the Magnus binding.
+
+$stdout.set_encoding('UTF-8')
+$stderr.set_encoding('UTF-8')
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'phonetics'
+
+USAGE = <<~USAGE
+  Usage: phonetics <command> [args...]
+
+  Phrase-level distances (input: IPA strings, possibly with spaces):
+    distance    <ipa1> <ipa2>     Strict phonetic Levenshtein.
+    confusion   <ipa1> <ipa2>     Listener-confusion distance.
+    similarity  <ipa1> <ipa2>     0..1 normalised similarity.
+
+  Phoneme-level distances (input: single phonemes):
+    phoneme         <a> <b>       Acoustic distance.
+    phoneme-conf    <a> <b>       Perceptual distance (with overlay).
+
+  Tokenisation:
+    tokenize    [--boundaries] <ipa>     Phoneme stream, one per line.
+
+  Numeric output is a single line. With --json, output is a JSON object.
+USAGE
+
+def die(message, code = 2)
+  warn message
+  exit code
+end
+
+def format_number(value, json:)
+  return JSON.dump(value: value) if json
+
+  value.to_s
+end
+
+json   = !ARGV.delete('--json').nil?
+bounds = !ARGV.delete('--boundaries').nil?
+
+command, *args = ARGV
+require 'json' if json
+
+case command
+when 'distance'
+  die USAGE unless args.size == 2
+  puts format_number(Phonetics.levenshtein(args[0], args[1]), json: json)
+
+when 'confusion'
+  die USAGE unless args.size == 2
+  puts format_number(Phonetics.confusion(args[0], args[1]), json: json)
+
+when 'similarity'
+  die USAGE unless args.size == 2
+  puts format_number(Phonetics.similarity(args[0], args[1]), json: json)
+
+when 'phoneme'
+  die USAGE unless args.size == 2
+  puts format_number(Phonetics.distance(args[0], args[1]), json: json)
+
+when 'phoneme-conf'
+  die USAGE unless args.size == 2
+  puts format_number(Phonetics.sub_cost(args[0], args[1]), json: json)
+
+when 'tokenize'
+  die USAGE unless args.size == 1
+
+  tokens = Phonetics.tokenize(args[0], boundaries: bounds)
+  if json
+    puts JSON.dump(tokens: tokens)
+  else
+    puts tokens
+  end
+
+when '--help', '-h', nil
+  puts USAGE
+
+else
+  die "phonetics: unknown command #{command.inspect}\n\n#{USAGE}"
+end

data/ext/phonetics_ruby/vendor/phonetics/README.md

@@ -0,0 +1,29 @@
+# phonetics
+
+IPA-based phonetic distance metrics for Rust.
+
+Two scores live in this crate:
+
+* **`distance(a, b)`** — strict per-phoneme acoustic distance over IPA
+  phonemes (Bark-space vowel distance, 2D consonant place embedding,
+  approximant–vowel bridge, diphthong/affricate handling).
+* **`Confusion::distance(s1, s2)`** — listener-confusion distance over
+  whole phonemic strings, calibrated against Mad Gab puzzle data and
+  English speech-perception literature.
+
+The split is the point. The first is a claim about the waveform; the
+second is a claim about how a listener parses it. They give different
+answers to different questions.
+
+This is a port of the Ruby gem of the same name; see the parent
+repository for an extended write-up of the metric design.
+
+## Status
+
+Pre-1.0. Core data tables and the per-phoneme acoustic distance are
+parity-tested against the Ruby reference. Levenshtein and Confusion DPs
+are landing module-by-module.
+
+## License
+
+MIT.