immosquare-extensions 0.1.29 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1984569911ed1d2de9da6d04bbe044c867fe96f320ddf9404c14f3d31109c6c
-  data.tar.gz: 25ee04e6d1fe8cd87b27740e5d9ff8eb7bd284b580bd67a72a665baf321961dc
+  metadata.gz: e9afbb3a9b644f11a9ed1991329844f00ecce1866bcde28ea55fe6264759b9ad
+  data.tar.gz: 7fbfa0feaa9ee228d7291749754209621a2d7064a8c922261c7362a8b460f83a
 SHA512:
-  metadata.gz: 0a740a6bc43b6c0b2364ab7b686dd490cb0aba768dc05a6f1d0ee5cb49cb2a486b201d6d5249c5a255ef57fdc89bc3a8b40f4bafab73ce93db30dc05787e4b83
-  data.tar.gz: 88e7380675de96e3ea6cb9bc407cd4b1c0819728e91f6b79c303594b6d792ccbf29645ef657b9597317af3fca8f07e74872ac8810798575e79b5dbb56b7a6714
+  metadata.gz: d640776fdcb79276cf7ea5347ea17384ededc0a804fdc97e12ab5454798f4f16dc34a049c60ed199d93621809bd8a74be053704d0cf96d6c332fd418ff9053e3
+  data.tar.gz: f4921568ed88a374d3ead74f9d96b5dff63d4d33204002ff84a416177066d3250c8e21710da94c135855f4f6825753ef59913060c181080c6693fdaf4180e4f1

data/lib/immosquare-extensions/array.rb

@@ -33,7 +33,7 @@ class Array
   def to_beautiful_json(**options)
     options               = {}.merge(options)
     options[:align]       = true if ![true, false].include?(options[:align])
-    options[:indent_size] = 2    if options[:indent_size].to_i == 0 || options[:indent_size].to_i > 10
+    options[:indent_size] = 2    if options[:indent_size].to_i <= 0 || options[:indent_size].to_i > 10
 
     dump_beautify_json(self, options[:align], options[:indent_size])
   end

data/lib/immosquare-extensions/hash.rb

@@ -89,7 +89,7 @@ class Hash
   def to_beautiful_json(**options)
     options               = {}.merge(options)
     options[:align]       = true if ![true, false].include?(options[:align])
-    options[:indent_size] = 2    if options[:indent_size].to_i == 0 || options[:indent_size].to_i > 10
+    options[:indent_size] = 2    if options[:indent_size].to_i <= 0 || options[:indent_size].to_i > 10
 
     dump_beautify_json(self, options[:align], options[:indent_size])
   end

data/lib/immosquare-extensions/string.rb

@@ -3,6 +3,24 @@
 ##============================================================##
 class String
 
+  ##============================================================##
+  ## Particles that stay lowercase inside a place name, unless they
+  ## open it. `d` and `l` cover the elided forms `d'` and `l'`.
+  ##============================================================##
+  TITLEIZE_PARTICLES_FRENCH = ["à", "au", "aux", "d", "de", "des", "du", "en", "ès", "et", "l", "la", "le", "les", "lès", "sous", "sur"].freeze
+
+  ##============================================================##
+  ## A capital after an apostrophe belongs to an elision or a
+  ## patronymic prefix (d'Orcino, O'Brien, N'Djamena), never to an
+  ## English clitic (King's, It's). Both sides are closed sets, so
+  ## the rule needs no language detection: the prefix decides and
+  ## the suffix vetoes.
+  ##============================================================##
+  TITLEIZE_ELISIONS = ["c", "d", "j", "l", "m", "n", "o", "qu", "s", "t"].freeze
+  TITLEIZE_CLITICS  = ["d", "ll", "m", "re", "s", "t", "ve"].freeze
+
+  private_constant(:TITLEIZE_PARTICLES_FRENCH, :TITLEIZE_ELISIONS, :TITLEIZE_CLITICS)
+
   ##============================================================##
   ## Convert the string 'true' to true and 'false' to false.
   ## Any other value will return nil.
@@ -25,19 +43,95 @@ class String
   end
 
   ##============================================================##
-  ## Provide a custom titleize method to handle strings
-  ## especially ones with hyphens more appropriately.
-  ## Standard titleize does not preserve hyphens in the desired manner.
+  ## Titleize a PLACE NAME under French typographic rules: the
+  ## letter after an apostrophe carries the capital, and particles
+  ## stay lowercase unless they open the name. Hyphenated toponyms
+  ## are the case standard `titleize` gets wrong.
   ##
-  ## Reference:
-  ## https://stackoverflow.com/questions/29784873/titleize-a-hyphenated-name
+  ## Use `titleize_name` for anything that is not a place — there,
+  ## no particle is lowered.
   ##
   ## Examples:
-  ## "SANT-ANDREA-D'ORCINO".titleize_custom => Sant-Andrea-D'orcino
-  ## "SANT-ANDREA-D'ORCINO".titleize        => Sant Andrea D'orcino
+  ## "SANT-ANDREA-D'ORCINO".titleize_place     => Sant-Andrea-d'Orcino
+  ## "saint-jean-sur-richelieu".titleize_place => Saint-Jean-sur-Richelieu
+  ## "st john's".titleize_place                => St John's
+  ## "SANT-ANDREA-D'ORCINO".titleize            => Sant Andrea D'orcino
+  ##============================================================##
+  def titleize_place
+    titleize_words(:lower_particles => true)
+  end
+
+  ##============================================================##
+  ## Titleize a proper name or a label — a person, an agency, a
+  ## building, an enumeration value. Same apostrophe and accent
+  ## handling as `titleize_place`, but every word is capitalized.
+  ##
+  ## Examples:
+  ## "o'brien".titleize_name          => O'Brien
+  ## "MAISON DE VILLE".titleize_name  => Maison De Ville
+  ##============================================================##
+  def titleize_name
+    titleize_words(:lower_particles => false)
+  end
+
+  ##============================================================##
+  ## The helpers below are private on every String in the process:
+  ## a new public extension must be added ABOVE this line.
   ##============================================================##
-  def titleize_custom
-    humanize.gsub(/\b('?[a-z])/) { ::Regexp.last_match(1).capitalize }
+  private
+
+  ##============================================================##
+  ## `humanize` normalizes first: it folds underscores into spaces
+  ## and downcases the tail, so an all-caps source comes back
+  ## readable.
+  ##
+  ## The scan keeps letters, digits and apostrophes in a single
+  ## match, so `d'howard` arrives as ONE word and its two halves
+  ## can be ruled on separately. Hyphens and spaces stay untouched
+  ## between the matches, which is how the shape of the original
+  ## string survives.
+  ##
+  ## Known limits of that pair, each frozen by a characterization
+  ## test: internal capitals are flattened (MacDonald → Macdonald),
+  ## a dotted abbreviation reads as a particle (`n.-d.-de-grâce` →
+  ## `N.-d.-de-Grâce`) and roman numerals are recapitalized (Louis
+  ## XIV → Louis Xiv).
+  ##============================================================##
+  def titleize_words(lower_particles:)
+    first = true
+
+    humanize.gsub(/[\p{L}\p{N}'’]+/) do |word|
+      titleized = titleize_single_word(word, :first => first, :lower_particles => lower_particles)
+      first     = false
+      titleized
+    end
+  end
+
+  def titleize_single_word(word, first:, lower_particles:)
+    ##============================================================##
+    ## Split on the FIRST apostrophe only — a second one belongs to
+    ## the name itself. The prefix follows the particle rule; the
+    ## suffix takes a capital only after an elision, so a
+    ## possessive stays intact: "King's", never "King'S".
+    ##============================================================##
+    if word =~ /['’]/
+      separator      = word[/['’]/]
+      prefix, suffix = word.split(/['’]/, 2)
+      suffix         = suffix.capitalize if elision?(prefix, suffix)
+      return "#{titleize_particle(prefix, :first => first, :lower_particles => lower_particles)}#{separator}#{suffix}"
+    end
+
+    titleize_particle(word, :first => first, :lower_particles => lower_particles)
+  end
+
+  def elision?(prefix, suffix)
+    TITLEIZE_ELISIONS.include?(prefix.downcase) && !TITLEIZE_CLITICS.include?(suffix.downcase)
+  end
+
+  def titleize_particle(word, first:, lower_particles:)
+    return word.downcase if lower_particles && !first && TITLEIZE_PARTICLES_FRENCH.include?(word.downcase)
+
+    word.capitalize
   end
 
 end

data/lib/immosquare-extensions/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareExtensions
-  VERSION = "0.1.29".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.29
+  version: 0.2.0
 platform: ruby
 authors:
 - immosquare
@@ -46,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Utility extensions for Ruby core classes
 test_files: []