translitter 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da46961c02a493d89f02c894de694d04bc73b28fdfbed37f54d37097e520ab84
-  data.tar.gz: 3c5c89f76410fb591f325533f284ca381b34fed83466f4cfd885f1e8b1c58118
+  metadata.gz: 0aa4e817b0f70def9668e77516e9dcd105d87b6454339c5e64b194a33973fc04
+  data.tar.gz: 8e1a0bd1a07b5e7da59292c6649ed27628ffcdf219aa7a63edba6233b29d32bf
 SHA512:
-  metadata.gz: 71147165ed9b68c17a32c29d8f8fb1f689e66a685e3b9a194442f9cbb3c4c4882b5fbca4e628ea33716db7a6a798216a3ee84cc5722a8a9137f6f78ebf7c559a
-  data.tar.gz: 1d3248f3e9e1275932dc0f54fe5eb4e8cee31627c009cd64bc52b05619999fb2943d4d1536f879d86a3365babfa6413be7b778f860cf6447fc825bc523596df8
+  metadata.gz: 0a2637b943cbe9a7bf5d951890a4738391331dba6b4edd9594f839639330f9e0ebd565ab26ac48e912caeda995aeb35055d32e002a3b97205bf75f022c1710c0
+  data.tar.gz: fe97f73afaf3d7f4710907247b38df4c1b1d321adb69312f65ffacc4e8d28cfbb7fc2ef2aa2a3fc4f83fca2bcc09155c67a2394e8c7fdbeb17b10de6d14f7e11

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+# v1.1.0
+
+* Add `replacement` option to initializer as well
+* Keep special characters when `replacement` is `nil`
+
 # v1.0.0
 
 * Initial release

data/Gemfile

@@ -6,5 +6,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    translitter (1.0.0)
+    translitter (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -19,13 +19,19 @@ Using translitter is super easy. For german you'd e.g. do:
 ```ruby
 translitter = Translitter.new(
   default_rules: true,
-  custom_rules: { 'Ä' => 'Ae', 'Ö' => 'Oe', 'Ü' => 'Ue', 'ä' => 'ae', 'ö' => 'oe', 'ü' => 'ue', 'ß' => 'ss' }
+  custom_rules: { 'Ä' => 'Ae', 'Ö' => 'Oe', 'Ü' => 'Ue', 'ä' => 'ae', 'ö' => 'oe', 'ü' => 'ue', 'ß' => 'ss' },
+  replacement: "?"
 )
 
-translitter.transliterate("Äpfél") #=> "Aepfel"
+translitter.transliterate("Äpfél 🍎") #=> "Aepfel ?"
 ```
 
-The default rules are taken from `i18n-ruby`.
+The default rules are taken from `i18n-ruby`. If you pass `nil` as
+`replacement`, special characters will be kept in the result.
+
+```ruby
+translitter.transliterate("Äpfél 🍎", replacement: nil) #=> "Aepfel 🍎"
+```
 
 ## Development
 

data/lib/translitter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Translitter
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/translitter.rb

@@ -34,15 +34,17 @@ class Translitter
     "Ž" => "Z", "ž" => "z"
   }.freeze
 
-  def initialize(default_rules: true, custom_rules: {})
+  def initialize(default_rules: true, custom_rules: {}, replacement: "?")
     @rules = {}
     @rules.merge!(DEFAULT_RULES) if default_rules
     @rules.merge!(custom_rules)
+
+    @replacement = replacement
   end
 
-  def transliterate(str, replacement: "?")
+  def transliterate(str, replacement: @replacement)
     str.gsub(/[^\x00-\x7f]/u) do |char|
-      @rules[char] || replacement
+      @rules[char] || replacement || char
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translitter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2024-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop