name_tamer 0.6.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc005aab6cf23f19cf21ee423d7e3c0b61e820e1dd115eaee6e058c93bfb29ca
-  data.tar.gz: e1a792e62234a8a2fc49f3bde8596627d895a3dc035763b42f4c31c174adab2c
+  metadata.gz: 6297841f503f7afdd7c53dba7fd5393818a476a430f5af73e655553f4258f9da
+  data.tar.gz: cd6a297d247f13eb4c9c7d547c3d7001f4b2d8edf4d92943fa9e33405cb59ba8
 SHA512:
-  metadata.gz: eeb9dba6eb6b560a1d58b54211db386d79d1dee64f761a78230f64847f53dea2786052daf7ec2ea33d5792f7148dbaadd97d074ca7e9a479e8bd8239a842e8eb
-  data.tar.gz: a2776328194cc8ff76d9d201b0ca8f0d9e8b902a718223bf449afd5e298ef8006a2b8a1f9ed0ac32aefa8e27db38e2eae4e46689b11fa54e9f2cf993325621b9
+  metadata.gz: b3957fa8569fc8e85c0bacc26ae310d3b6f5a9b9ee1ac935bc1d2325d9a6197f94bd53ed4ecd61ccc59ad084785b3deb85b6dc333bb87ce4d3248ff9ad614ac1
+  data.tar.gz: 66b26c34e7e3da845a37256f32eb000b7142ab6ca5fb8728fd3169cc2136ec80513de0cf10ddb59a413578ce7c0c9441cd383769776fd14ee4b0777d7a8f1de3

data/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.2] - 2026-07-22
+
+### Added
+
+- Contributor documentation covering setup, testing, linting, adfix
+  maintenance, releases and changelog conventions.
+- SonarQube Cloud project binding for SonarLint connected mode.
+
+### Changed
+
+- The repository's maintenance tasks and prefix/suffix data files moved from
+  `doc/` to `docs/`.
+- SonarQube analysis now imports SimpleCov 1.0 coverage reports after they are
+  normalised to absolute paths.
+- GitHub Actions release, test and analysis workflows now use updated Ruby,
+  checkout, artifact upload, Ruby setup and SonarQube scan actions.
+- The release workflow uses Ruby 4.0.6, while the test matrix continues to
+  cover Ruby 3.3, 3.4 and 4.0.
+- Gem metadata and the lockfile now identify the released library as version
+  `1.0.1`.
+- Generated planning documents under `docs/plans` are excluded from version
+  control.
+
+## [1.0.1] - 2026-07-20
+
+### Fixed
+
+- The mangled-Á entry in the bad-encoding table is written with an escape
+  sequence, so source scanners no longer flag the file as corrupted.
+
+### Changed
+
+- The `NameTamer::Strings` modules use `extend self` instead of
+  `module_function`; no public API change.
+  
+## [1.0.0] - 2026-07-18
+
+### Changed
+
+- **Breaking:** Ruby 3.3 or newer is required; Ruby 2.7–3.2 are no longer
+  supported.
+- **Breaking:** `name_tamer` no longer defines methods on core classes. The
+  `String` helpers (`whitespace_to!`, `approximate_latin_chars!` and friends)
+  are now pure functions on `NameTamer::Strings`, and `Array#neighbours` has
+  become an internal helper of `NameTamer::Text`. The public API —
+  `NameTamer[]`, `NameTamer::Name`, `NameTamer.parameterize` — is unchanged.
+- **Breaking:** the terminal-colour `String` methods (`"text".yellow` etc.)
+  have been removed; they were unrelated to name taming.
+
+### Fixed
+
+- Multi-word prefixes and suffixes (for example `Chartered F.C.S.I.`,
+  `Private Limited`) are stripped correctly again, restoring the behaviour
+  of the released 0.6.1 gem after a regression when the adfix lists moved
+  into data files.
+- The test suite runs on Ruby 3.4+ again (`yaml` is now required explicitly
+  and fixtures load under Psych 4's safe defaults).
+
+### Added
+
+- Continuous integration on GitHub Actions: RuboCop plus RSpec on Ruby 3.3,
+  3.4 and 4.0, with 100% line and branch coverage enforced.
+- SonarQube Cloud analysis with imported coverage and RuboCop reports.
+- Releases are published to RubyGems via trusted publishing (OIDC) from a
+  gated GitHub Actions environment.
+
+## [0.6.1] and earlier
+
+See the [commit history](https://github.com/dominicsayers/name_tamer/commits/main).

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Dominic Sayers
+Copyright (c) 2017-2026 Dominic Sayers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,27 +1,31 @@
-## NameTamer
+# NameTamer
 
 [![Gem version](https://badge.fury.io/rb/name_tamer.svg)](https://rubygems.org/gems/name_tamer)
 [![Gem downloads](https://img.shields.io/gem/dt/name_tamer.svg)](https://rubygems.org/gems/name_tamer)
-[![Build Status](https://travis-ci.org/dominicsayers/name_tamer.svg?branch=master)](https://travis-ci.org/dominicsayers/name_tamer)
-[![Code Climate](https://codeclimate.com/github/dominicsayers/name_tamer/badges/gpa.svg)](https://codeclimate.com/github/dominicsayers/name_tamer)
-[![Test Coverage](https://codeclimate.com/github/dominicsayers/name_tamer/badges/coverage.svg)](https://codeclimate.com/github/dominicsayers/name_tamer/coverage)
-[![Security](https://hakiri.io/github/dominicsayers/name_tamer/master.svg)](https://hakiri.io/github/dominicsayers/name_tamer/master)
+[![Test](https://github.com/dominicsayers/name_tamer/actions/workflows/test.yml/badge.svg)](https://github.com/dominicsayers/name_tamer/actions/workflows/test.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dominicsayers_name_tamer&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dominicsayers_name_tamer)
 
 NameTamer: making sense of names
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the gem to your application:
 
-    gem 'name_tamer'
+```console
+bundle add name_tamer
+```
 
-And then execute:
+Or install it yourself:
 
-    $ bundle
+```console
+gem install name_tamer
+```
 
-Or install it yourself as:
+## Supported Ruby versions
 
-    $ gem install name_tamer
+`name_tamer` supports the Ruby versions in [normal or security maintenance
+upstream](https://www.ruby-lang.org/en/downloads/branches/) — currently
+Ruby 3.3, 3.4 and 4.0. The test suite runs against all of them.
 
 ## Usage
 
@@ -41,41 +45,64 @@ name_tamer.nice_name # => John Q. Smith
 name_tamer.contact_type # => :person
 ```
 
-NameTamer will make an intelligent guess at the type of the name but it's not infallible. NameTamer likes it if you tell it whether the name is a person or an organization:
+NameTamer will make an intelligent guess at the type of the name but it's
+not infallible. NameTamer likes it if you tell it whether the name is a
+person or an organization:
 
 ```ruby
-name_tamer = NameTamer::Name.new 'Di Doo Doo d.o.o.', contact_type: :organization
-name_tamer.simple_name # => Di Doo Doo
+name_tamer = NameTamer::Name.new 'Acme Group Private Limited', contact_type: :organization
+name_tamer.simple_name # => Acme Group
 ```
 
+## Upgrading from 0.x
+
+Version 1.0.0 makes three breaking changes:
+
+- Ruby 3.3 or newer is required.
+- The gem no longer defines methods on `String` or `Array`. The helpers are
+  pure functions on `NameTamer::Strings` (e.g.
+  `NameTamer::Strings.approximate_latin_chars('Reñé')`), and each returns a
+  new string instead of mutating the receiver.
+- The terminal-colour `String` methods (`'text'.yellow` and friends) are
+  gone; use a dedicated gem such as `rainbow` if you need them.
+
+The documented API — `NameTamer[]`, `NameTamer::Name`,
+`NameTamer.parameterize` — is unchanged.
+
 ## Contributing
 
-There must be lots of name suffixes and prefixes that I haven't catered for, so please get in touch if `name_tamer` doesn't recognise one that you've found.
+There must be lots of name suffixes and prefixes that I haven't catered
+for, so please get in touch if `name_tamer` doesn't recognise one that
+you've found.
 
-If there are any other common two-word family names that I've missed then please let me know. `name_tamer` tries to make sure Helena Bonham Carter gets slugified to `helena-bonham-carter` and not `helena-carter`, but I'm sure there are loads of two-word family names I don't know about.
+If there are any other common two-word family names that I've missed then
+please let me know. `name_tamer` tries to make sure Helena Bonham Carter
+gets slugified to `helena-bonham-carter` and not `helena-carter`, but I'm
+sure there are loads of two-word family names I don't know about.
 
 Please read all the following articles before contributing:
 
-* [Personal names around the world](https://www.w3.org/International/questions/qa-personal-names)
-* [Falsehoods Programmers Believe About Names](https://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/)
-* [Last Name First](http://www.solidether.net/article/last-name-first/)
-* [Namae (名前)](https://github.com/berkmancenter/namae)
-* [Matts Name Parser](https://github.com/mericson/people)
-* [Types of business entity](http://en.wikipedia.org/wiki/Types_of_business_entity)
-* [List of professional designations in the United States](http://en.wikipedia.org/wiki/List_of_post-nominal_letters_(USA))
-* [List of post-nominal letters (United Kingdom)](http://en.wikipedia.org/wiki/List_of_post-nominal_letters_(United_Kingdom))
-* [Nobiliary particle](http://en.wikipedia.org/wiki/Nobiliary_particle)
-* [Spanish naming customs](http://en.wikipedia.org/wiki/Spanish_naming_customs)
-* [Unified style sheet for linguistics](http://linguistlist.org/pubs/tocs/JournalUnifiedStyleSheet2007.pdf) [PDF]
+- [Personal names around the world](https://www.w3.org/International/questions/qa-personal-names)
+- [Falsehoods Programmers Believe About Names](https://www.kalzumeus.com/2010/06/17/falsehoods-programmers-believe-about-names/)
+- [Last Name First](http://www.solidether.net/article/last-name-first/)
+- [Namae (名前)](https://github.com/berkmancenter/namae)
+- [Matts Name Parser](https://github.com/mericson/people)
+- [Types of business entity](http://en.wikipedia.org/wiki/Types_of_business_entity)
+- [List of professional designations in the United States](http://en.wikipedia.org/wiki/List_of_post-nominal_letters_(USA))
+- [List of post-nominal letters (United Kingdom)](http://en.wikipedia.org/wiki/List_of_post-nominal_letters_(United_Kingdom))
+- [Nobiliary particle](http://en.wikipedia.org/wiki/Nobiliary_particle)
+- [Spanish naming customs](http://en.wikipedia.org/wiki/Spanish_naming_customs)
+- [Unified style sheet for linguistics](http://linguistlist.org/pubs/tocs/JournalUnifiedStyleSheet2007.pdf) [PDF]
 
 ### How to contribute
 
-1.  Fork it
-1.  Create your feature branch (`git checkout -b my-new-feature`)
-1.  Commit your changes (`git commit -am 'Add some feature'`)
-1.  Push to the branch (`git push origin my-new-feature`)
-1.  Create new Pull Request
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
 
 ## Acknowledgements
 
-1.  Thanks to Ryan Bigg for the guide to making your first gem https://github.com/radar/guides/blob/master/gem-development.md
+1. Thanks to Ryan Bigg for the
+   [guide to making your first gem](https://github.com/radar/guides/blob/master/gem-development.md)

data/lib/name_tamer/constants/adfixes_prefix_person

@@ -0,0 +1,44 @@
+Baroness
+Capt.
+Captain
+Col.
+Colonel
+Dame
+Doctor
+Doktor
+Dr.
+Frau
+Herr
+Judge
+Justice
+Lady
+Lieut.
+Lieutenant
+Lord
+Madame
+Major
+Master
+Matron
+Messrs.
+Mgr.
+Miss
+Mister
+Mlle.
+Mme.
+Mons.
+Mr. & Mrs.
+Mr. and Mrs.
+Mr.
+Mrs.
+Ms.
+Msgr.
+Prof.
+Professor
+Rev.
+Reverend
+Sir
+Sister
+The Hon.
+The Lady.
+The Lord
+The Rt. Hon.

data/lib/name_tamer/constants/adfixes_suffix_organization

@@ -0,0 +1,213 @@
+S. de R.L. de C.V.
+S.A.P.I. de C.V.
+y. Cía. S. en C.
+Private Limited
+S.M. Pte. Ltd.
+Cía. S. C. A.
+y. Cía. S. C.
+S.A. de C.V.
+spol. s.r.o.
+(Pty.) Ltd.
+(Pvt.) Ltd.
+A.D.S.I.Tz.
+S.p. z.o.o.
+(Pvt.)Ltd.
+akc. spol.
+Cía. Ltda.
+E.B.V.B.A.
+P. Limited
+S. de R.L.
+S.I.C.A.V.
+S.P.R.L.U.
+А.Д.С.И.Ц.
+(P.) Ltd.
+C. por A.
+Comm.V.A.
+Ltd. Şti.
+Plc. Ltd.
+Pte. Ltd.
+Pty. Ltd.
+Pvt. Ltd.
+Soc. Col.
+A.M.B.A.
+A.S.B.L.
+A.V.E.E.
+B.V.B.A.
+B.V.I.O.
+C.V.B.A.
+C.V.O.A.
+E.E.I.G.
+E.I.R.L.
+E.O.O.D.
+E.U.R.L.
+F.M.B.A.
+G.m.b.H.
+Ges.b.R.
+K.G.a.A.
+L.L.L.P.
+Ltd. Co.
+Ltd. Co.
+M.E.P.E.
+n.y.r.t.
+O.V.E.E.
+P.E.E.C.
+P.L.L.C.
+P.L.L.C.
+S. en C.
+S.a.p.a.
+S.A.R.L.
+S.à.R.L.
+S.A.S.U.
+S.C.e.I.
+S.C.O.P.
+S.C.p.A.
+S.C.R.I.
+S.C.R.L.
+S.M.B.A.
+S.P.R.L.
+Е.О.О.Д.
+&. Cie.
+and Co.
+Comm.V.
+Limited
+P. Ltd.
+Part.G.
+Sh.p.k.
+&. Co.
+C.X.A.
+d.n.o.
+d.o.o.
+E.A.D.
+e.h.f.
+E.P.E.
+E.S.V.
+F.C.P.
+F.I.E.
+G.b.R.
+G.I.E.
+G.M.K.
+G.S.K.
+H.U.F.
+K.D.A.
+k.f.t.
+k.h.t.
+k.k.t.
+L.L.C.
+L.L.P.
+o.h.f.
+O.H.G.
+O.O.D.
+O.y.j.
+p.l.c.
+P.S.U.
+S.A.E.
+S.A.S.
+S.C.A.
+S.C.E.
+S.C.S.
+S.E.M.
+S.E.P.
+s.e.s.
+S.G.R.
+S.N.C.
+S.p.A.
+S.P.E.
+S.R.L.
+s.r.o.
+Unltd.
+V.O.F.
+V.o.G.
+v.o.s.
+V.Z.W.
+z.r.t.
+А.А.Т.
+Е.А.Д.
+З.А.Т.
+К.Д.А.
+О.О.Д.
+Т.А.А.
+股份有限公司
+Ap.S.
+Corp.
+ltda.
+Sh.A.
+st.G.
+Ultd.
+a.b.
+A.D.
+A.E.
+A.G.
+A.S.
+A.Ş.
+A.y.
+B.M.
+b.t.
+B.V.
+C.A.
+C.V.
+d.d.
+e.c.
+E.E.
+e.G.
+E.I.
+E.P.
+E.T.
+E.U.
+e.v.
+G.K.
+G.P.
+h.f.
+Inc.
+K.D.
+K.G.
+K.K.
+k.s.
+k.v.
+K.y.
+L.C.
+L.P.
+Ltd.
+N.K.
+N.L.
+N.V.
+O.E.
+O.G.
+O.Ü.
+O.y.
+P.C.
+p.l.
+Pty.
+PUP.
+Pvt.
+r.t.
+S.A.
+S.D.
+S.E.
+s.f.
+S.L.
+S.P.
+S.s.
+T.K.
+T.Ü.
+U.Ü.
+Y.K.
+А.Д.
+І.П.
+К.Д.
+ПУП.
+С.Д.
+בע"מ
+任意組合
+匿名組合
+合同会社
+合名会社
+合資会社
+有限会社
+有限公司
+株式会社
+A/S
+G/S
+I/S
+K/S
+P/S
+S/A

data/lib/name_tamer/constants/adfixes_suffix_person

@@ -0,0 +1,131 @@
+A.A.M.S.
+A.C.A.
+A.C.C.
+A.C.C.A.
+A.C.M.A.
+A.E.P.
+A.I.F.
+A.I.F.A.
+A.S.A.
+A.W.M.A.
+B.A.
+B.Ed.
+B.Eng.
+B.Sc.
+B.Tech.
+C.A.
+C.A.I.A.
+C.A.P.M.
+C.B.V.
+C.C.I.M.
+C.D.F.A.
+C.E.M.
+C.E.P.P.
+C.Eng.
+C.F.A.
+C.F.B.S.
+C.F.F.
+C.F.P.
+C.F.S.
+C.G.A.
+C.G.B.
+C.G.M.A.
+C.G.P.
+C.I.M.
+C.I.S.S.P.
+C.I.T.P.
+C.L.P.
+C.L.T.C.
+C.L.U.
+C.M.A.
+C.M.T.
+C.P.A.
+C.P.C.C.
+C.R.P.C.
+C.R.P.S.
+C.S.O.X.
+C.S.S.D.
+C.T.A.
+C.W.S.
+Cantab.
+Ch.F.C.
+Chartered F.C.S.I.
+Chartered M.C.S.I.
+D.B.E.
+D.D.S.
+D.Phil.
+D.V.M.
+Dip. D.M.
+E.A.
+E.R.P.
+Ed.D.
+Ed.M.
+Eng.D.
+Esq.
+F.B.C.S.
+F.C.A.
+F.C.C.A.
+F.C.I.P.S.
+F.C.M.I.
+F.C.S.I.
+F.I.E.T.
+F.I.R.P.
+F.Inst.L.M.
+F.P.C.
+F.R.M.
+F.R.M.
+G.S.P.
+Hons.
+I.F.R.S. Certified
+I.T.I.L. v3
+II
+III
+IV
+J.D.
+Jr.
+K.C.
+L.P.S.
+LL.B.
+LL.D.
+LL.M.
+M.A.
+M.B.A.
+M.B.E.
+M.D.
+M.E.P.
+M.Ed.
+M.Eng.
+M.I.E.T.
+M.Io.D.
+M.Jur.
+M.P.
+M.P.A.
+M.R.I.C.S.
+M.S.
+M.S.F.
+M.S.F.S.
+M.S.P.
+M.Sc. D.
+M.Sc.
+O.B.E.
+O.K.
+O.R.S.C.
+Oxon.
+P.A.
+P.C.C.
+P.F.S.
+P.H.R.
+P.M.C.
+P.M.P.
+P.M.P.
+P.S.P.
+Ph.D.
+Q.C.
+R.D.
+R.F.C.
+R.I.C.P.
+S.C.M.P
+Sr.
+T.M.I.E.T.
+V
+V.M.D.