name_formatter 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6037e2a676981c2ef2026b3387a0e21a7e36db146449d51ba4710068e316473e
-  data.tar.gz: cbc2fd01074904d6d1225f0901b16adc941aa41a2c64f6f6b49e743a17b8c3fd
+  metadata.gz: b86a54e891bc3744eab6bbaa8b7382f01a83d94fc401c93065d54e22f04409ac
+  data.tar.gz: 104a77f0c37cbf0ac10ef5bc0fddba44b3f2180faa8fdb03d36f99ae0fe97561
 SHA512:
-  metadata.gz: a748dfe1cb4cb20fae52eb78a741281ba946f153b38acd35e520d2c5b858104f59701566dd7cedbaa2bdbbcec7201ac858b05463d9d09a5285481324cf510057
-  data.tar.gz: 266a1de96fd71ba93d85677eb694d6ebcbcf23744ac1c2d6030b20fde0ab3ff0a6c7ca784ca857810960abb13bca41866c8f9da77fbfcce3f53069291774c854
+  metadata.gz: 491fa9a588dc94789f9145cf89286442bea60ccfefbb8381c603c411eb0ebd017cb33fc31cdedd941b827406fc7d8e543d7302c89798403d979b9ac9cea2c662
+  data.tar.gz: f1daf07814e8a0511e6c9505bea88a16072dc6700e3ec88060956d1e439a0e4bb0532d9a89e1965e10a8b05b167e0068b38f56bcd646cb2aeb48f09a1fbf2581

data/CHANGELOG.md

@@ -5,6 +5,18 @@ 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).
 
+## [0.2.1] - 2024-06-29
+
+### Changed
+- Minimum Required Ruby Version - Gem doesn't work on Ruby 2
+
+## [0.2.0] - 2024-06-28
+
+### Added
+
+- Support for parsing Gaelic names
+- Allow formatting for Last Name only
+
 ## [0.1.0] - 2024-06-28
 Initial realase
 
@@ -12,4 +24,6 @@ Initial realase
 
 - Support for parsing complex names with prefixes, suffixes, particles and beyond.
 
+[0.2.1]: https://github.com/kylewelsby/name_formatter/releases/tag/v0.2.1
+[0.2.0]: https://github.com/kylewelsby/name_formatter/releases/tag/v0.2.0
 [0.1.0]: https://github.com/kylewelsby/name_formatter/releases/tag/v0.1.0

data/README.md

@@ -6,7 +6,7 @@ NameFormatter is a Ruby gem that provides robust name parsing and formatting cap
 
 ## ✨ Features
 
-- Handles personal names from various cultures (Western, Spanish, German, etc.)
+- Handles personal names from various cultures (Gaelic, Western, Spanish, German, etc.)
 - Supports company names and legal entities
 - Correctly formats prefixes, suffixes, and particles (e.g., "van", "de", "von")
 - Preserves capitalization for names like "McDonald" or "DeVito"
@@ -44,7 +44,7 @@ formatted = formatter.format("JOHN DOE")
 puts formatted  # Output: "John Doe"
 
 # Parse and Format a name
-parsed = formatter.parse_formatted("Dr. Jane Smith Jr.")
+parsed = formatter.parse_formatted("DR. JANE SMITH JR.")
 puts parsed
 # Output: {
 #   prefix: "Dr.",
@@ -54,13 +54,13 @@ puts parsed
 # }
 
 # Parse skip formatting a name
-parsed = formatter.parse("Dr. Jane Smith Jr.")
+parsed = formatter.parse("DR. JANE SMITH JR.")
 puts parsed
 # Output: {
-#   prefix: "Dr.",
-#   first_name: "Jane",
-#   last_name: "Smith",
-#   suffix: "Jr."
+#   prefix: "DR.",
+#   first_name: "JANE",
+#   last_name: "SMITH",
+#   suffix: "JR."
 # }
 
 # Handle complex names

data/lib/gaelic_name_formatter.rb

@@ -0,0 +1,92 @@
+class GaelicNameFormatter
+  PREFIXES = %w[Mac Mc Ó O' Ní Nic Bean Mhic Vuic Uí De Dè Gil Gille].freeze
+  SUFFIXES = %w[ach an àr nam riss aigh aidh ain án éis ín].freeze
+
+  PREFIX_PATTERNS = [
+    /^(Gill)(An.*)/i,
+    /^(Gill)(Ea.*)/i,
+    /^(Gille)(Ch.*)/i,
+    /^(Gill[e'])([IOèÈ].*)/i,
+    /^(Mc)([acdefgiklmnpqrstv][aeiou lnrvw].*)/i,
+    /^(Mc)([DPS]h.*)/i,
+
+    /^(Mac)([Ùùfstu].*)/i,
+    /^(Mac)([AÀà][bimnos].*)/i,
+    /^(Mac)([AÀà]la.*)/i,
+    /^(Mac)([AÀà]d[ah].*)/i,
+    /^(Mac)([AÀà]r(?:a|ta).*)/i,
+    /^(Mac)(B(?:h|ea).*)/i,
+    /^(Mac)(C[aÀàehinlruòÒÙù].*)/i,
+    /^(Mac)(Co[dilmnsr].*)/i,
+    /^(Mac)(Dh.*)(Sh.*)/i,
+    /^(Mac)([DPH]h.*)/i,
+    /^(Mac)(Di.*)/i,
+    /^(Mac)(E[aòÒ].*)/i,
+    /^(Mac)((?:Gi|I)ll[e'])([EFÉéèÈ].+)/i,
+    /^(Mac)((?:Gi|I)ll[e']?)(A[no].+)/i,
+    /^(Mac)(Ill[e']?)((?:Ea|[CBDFGIÌìMNOPRSTU][haiumon]).+)/i,
+
+    /^(Mac)(Gill[e'])(O[in].+)/i,
+    /^(Mac)(Gi.*)(Ri.+)/i,
+    /^(Mac)(Gi.*)(Se.+)/i,
+    /^(Mac)(Gi.*)(Ios.+)/i,
+    /^(Mac)(Gi.*)([BCDFM]h.+)/i,
+    /^(Mac)(Gi.*)(Ghl.+)/i,
+    /^(Mac)(G[ahilou].*)/i,
+    /^(Mac)(Gri.*)/i,
+    /^(Mac)(Gy.*)/i,
+    /^(Mac)([IÌì][lo].*)/i,
+    /^(Mac)([IÌì]ai.*)/i,
+    /^(Mac)([L]a[bcgmot].*)/i,
+    /^(Mac)([L]e[òÒ].*)/i,
+    /^(Mac)([L][ioÙùu].*)/i,
+    /^(Mac)([N][aiÌìo].*)/i,
+    /^(Mac)(Nea.*)/i,
+    /^(Mac)(Neis)/i,
+    /^(Mac)(N[eèÈ]ill)/i,
+    /^(Mac)(N[eèÈ]i(ll|s).+)/i,
+    /^(Mac)(Mh.+)(Bh.+)/i,
+    /^(Mac)(Mh.+)(Chal.+)/i,
+    /^(Mac)(Mh.+)(D[òÒ].+)/i,
+    /^(Mac)(Mh.+)([Ìì].+)/i,
+    /^(Mac)([gdpms]h.*)/i,
+    /^(Mac)(R[iÌìou].*)/i,
+    /^(Mac)(R[Ààa][bgiot].*)/i
+  ].freeze
+
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def gaelic?
+    return false if name.nil? || name.strip.empty?
+
+    parts = name.split(/[\s]+/)
+    parts.any? do |part|
+      PREFIX_PATTERNS.any? { |pattern| part.match?(pattern) }
+    end
+  end
+
+  def format
+    parts = name.split(/[\s]+/)
+    parts.map do |part|
+      pattern = PREFIX_PATTERNS.find do |pattern|
+        part.match?(pattern)
+      end
+      if pattern && (match = part.match(pattern))
+        match.captures.map do |capture|
+          capture = capture.capitalize
+          hyphenated_parts = capture.split("-")
+          if hyphenated_parts.size > 1
+            capture = hyphenated_parts.map(&:capitalize).join("-")
+          end
+          capture
+        end.join
+      else
+        part
+      end
+    end.join(" ")
+  end
+end

data/lib/name_formatter/version.rb

@@ -1,3 +1,3 @@
 module NameFormatterModule
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/name_formatter.rb

@@ -1,4 +1,6 @@
 require "name_formatter/version"
+require "gaelic_name_formatter"
+
 class NameFormatter
   VERSION = NameFormatterModule::VERSION
   PREFIXES = Set.new(["Mr", "Mrs", "Ms", "Miss", "The Hon", "Rev", "Dr", "Fr", "Pres", "Prof", "Msgr", "Sen", "Gov", "Rep", "Amb"]).freeze
@@ -22,11 +24,9 @@ class NameFormatter
   DUNAME_REGEX = /^Du[b](?=[aeiou])/i
   DENAME_REGEX = /^De[bfghjlmnpvw][aeioulr](?!(?:sik|a)(?:[-,])?$)/i
 
-  MCNAME_REGEX = /^Mc[a-z]+/i
-  MACNAME_REGEX = /^Mac(?:[aà][bdilmnors]|b[eh]|c[aeioruò]|d[h]|e[aò]|f[hiru]|g[ahilouy]|i[alo]|l[aeiouù]|m[hiua]|n[aeèiìo]|p[h]|r[aiìou]|s[hipu]|t[hiu]|u[airs])+/i
   PARTICLE_REGEX = /^(de[rsl]|d[aiu]|v[oa]n|te[nr]|la|les|y|and|zu|dell[ao])$/i
 
-  def parse(name)
+  def parse(name, last_name_only: false)
     return parse_company_name(name) if company_name?(name)
 
     parts = name.strip.split(/\s+/)
@@ -34,7 +34,11 @@ class NameFormatter
     prefix = extract_prefix_or_suffix(parts, PREFIXES)
     suffix = extract_prefix_or_suffix(parts.reverse, SUFFIXES)
 
-    if parts.size > 1
+    if last_name_only
+      first_name = nil
+      last_name = parts.reject { |part| part == suffix }.join(" ")
+    elsif parts.size > 1
+
       first_name = parts.shift
       last_name = parts.reject { |part| part == suffix }.join(" ")
       last_name = nil if last_name.empty?
@@ -54,8 +58,8 @@ class NameFormatter
     }
   end
 
-  def parse_formatted(name)
-    parsed = parse(name)
+  def parse_formatted(name, **)
+    parsed = parse(name, **)
     {
       prefix: format_prefix(parsed[:prefix]),
       first_name: format_first_name(parsed[:first_name]),
@@ -64,8 +68,8 @@ class NameFormatter
     }
   end
 
-  def format(name)
-    parse_formatted(name).values.compact.join(" ")
+  def format(name, **)
+    parse_formatted(name, **).values.compact.join(" ")
   end
 
   private
@@ -127,6 +131,11 @@ class NameFormatter
   end
 
   def format_last_name_part(part, next_part)
+    gaelic_formatter = GaelicNameFormatter.new(part)
+    if gaelic_formatter.gaelic?
+      return gaelic_formatter.format
+    end
+
     case part.downcase
     when /^(v[ao]n|te|ter|de)$/i
       next_part&.match?(/der/i) ? part.downcase : part.capitalize
@@ -134,9 +143,9 @@ class NameFormatter
       next_part ? part.downcase : part.capitalize
     when /^dell'\w+/i
       part[0..4].capitalize + part[5..].capitalize
-    when MCNAME_REGEX, DUNAME_REGEX, DENAME_REGEX, /^[od]'\w+/i
+    when DUNAME_REGEX, DENAME_REGEX, /^[od]'\w+/i
       part[0..1].capitalize + part[2..].capitalize
-    when /^von[r]+/i, MACNAME_REGEX
+    when /^von[r]+/i
       part[0..2].capitalize + part[3..].capitalize
     else
       part.capitalize

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: name_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Kyle Welsby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-06-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +52,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- lib/gaelic_name_formatter.rb
 - lib/name_formatter.rb
 - lib/name_formatter/version.rb
 homepage: https://github.com/kylewelsby/name_formatter
@@ -73,6 +60,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kylewelsby/name_formatter
   changelog_uri: https://github.com/kylewelsby/name_formatter/blob/main/CHANGELOG.md
   funding_uri: https://github.com/sponsors/kylewelsby
 post_install_message: 
@@ -83,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="