unicode_script_detector 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d80a777771e5076bfb67e1b63ea3a0900f9ca53b16b0e90224608b60c06c78bc
-  data.tar.gz: 266e4ca3ad0728cacbd4a4f37819f271b22205a893f5750c14c862bda8d5cdc2
+  metadata.gz: 4795cdb246ac34ccb0ee5183ff0e704d25e4e67410acee321f36f4446dd28356
+  data.tar.gz: 0c7b9c4c835718f2fc7509225204e38c0a7148949c5745f1448b299c27e0e88d
 SHA512:
-  metadata.gz: a0d6741c40ae5adfde691ec742b1bc5440e2b45f265d448cda9b6c40978843404b05419e82ebad258ef40e752bcaffb26c985e625cb52025de7ae37b7aee505a
-  data.tar.gz: 2c81a22c0cb25ec024eb875f4da5a19891bff344acf7daaaa8a4155caf89e0ba77021d5b475b3b3f8e986eaf1b6be8bf8e20747a88afdbd0bfdd083d344c2680
+  metadata.gz: 5da7422c57295f4ac3dee3ac9ccfaa99b5586418de956a88876035541da023e9fa4afe609a4aa79d4c3a1a5f9b1ffe64370984657844c06fc6a575578beb5ee2
+  data.tar.gz: aa9fecf48386b6eb5a0074cbbec8819af80153c6111e042debd9e9c312145bc11a936b3003a406370a28e8a27a48b2bd0409c0cf043b26fe465f4c58ee9669e2

data/README.md

@@ -20,23 +20,45 @@ $ gem install unicode_script_detector
 UnicodeScriptDetector.detect_characters "Hel6б"
 
 #Output:
-[#<UnicodeScriptDetector::Character:0x00007768fefdead8 @char="H", @name="Latin", @script=:Latin>,
- #<UnicodeScriptDetector::Character:0x00007768fefdea10 @char="e", @name="Latin", @script=:Latin>,
- #<UnicodeScriptDetector::Character:0x00007768fefde970 @char="l", @name="Latin", @script=:Latin>,
- #<UnicodeScriptDetector::Character:0x00007768fefde8d0 @char="6", @name="Digit", @script=:Digit>,
- #<UnicodeScriptDetector::Character:0x00007768fefde830 @char="б", @name="Cyrillic", @script=:Cyrillic>]
+[
+  #<UnicodeScriptDetector::Character:0x00007768fefdead8 @char="H", @name="Latin", @script=:Latin>,
+  #<UnicodeScriptDetector::Character:0x00007768fefdea10 @char="e", @name="Latin", @script=:Latin>,
+  #<UnicodeScriptDetector::Character:0x00007768fefde970 @char="l", @name="Latin", @script=:Latin>,
+  #<UnicodeScriptDetector::Character:0x00007768fefde8d0 @char="6", @name="Digit", @script=:Digit>,
+  #<UnicodeScriptDetector::Character:0x00007768fefde830 @char="б", @name="Cyrillic", @script=:Cyrillic>
+]
 ```
 
 ## Detect if a script contains certain scripts
 ```ruby
 # This will return true because it contains Latin and Cyrillic
-UnicodeScriptDetector.contains? "Hellб🔥", [:Latin, :Cyrillic]
+UnicodeScriptDetector.contains? "Helб🔥", [:Latin, :Cyrillic]
 ```
 
 ## Detect if a script contains only certain scripts
 ```ruby
 # This will return false because it contains an Emoji as well
-UnicodeScriptDetector.contains_only? "Hellб🔥", [:Latin, :Cyrillic]
+UnicodeScriptDetector.contains_only? "Helб🔥", [:Latin, :Cyrillic]
+```
+
+## Detect all the characters of a string, grouped by the script
+```ruby
+UnicodeScriptDetector.script_groups("Hel6б how are you?").each do |group|
+  puts "#{group.name}: #{group.text} (#{group.length} characters)"
+end
+
+#Output:
+
+Latin: Hel (3 characters)
+Digit: 6 (1 characters)
+Cyrillic: б (1 characters)
+Whitespace:   (1 characters)
+Latin: how (3 characters)
+Whitespace:   (1 characters)
+Latin: are (3 characters)
+Whitespace:   (1 characters)
+Latin: you (3 characters)
+Punctuation: ? (1 characters)
 ```
 
 ## Development
@@ -47,4 +69,4 @@ Run the tests with `bin/test`.
 You're welcome to contribute to this project. See https://github.com/davidarendsen/unicode_script_detector.
 
 ## License
-This software is released under the [MIT license](LICENSE).
+This software is released under the [MIT license](LICENSE).

data/lib/unicode_script_detector/character.rb

@@ -15,5 +15,17 @@ module UnicodeScriptDetector
     def hiragana?
       @script === :Hiragana
     end
+
+    def punctuation?
+      @script === :Punctuation
+    end
+
+    def emoji?
+      @script === :Emoji
+    end
+
+    def digit?
+      @script === :Digit
+    end
   end
-end
+end

data/lib/unicode_script_detector/detector.rb

@@ -41,5 +41,15 @@ module UnicodeScriptDetector
 
       @scripts.uniq.sort == scripts.uniq.sort
     end
+
+    def script_groups
+      @characters
+        .chunk { |char| char.script }
+        .map { |script, chars| ScriptGroup.new(script, chars) }
+    end
+
+    def grouped_scripts_hash
+      script_groups.map { |group| [group.script, group.text] }.to_h
+    end
   end
-end
+end

data/lib/unicode_script_detector/script_group.rb

@@ -0,0 +1,19 @@
+module UnicodeScriptDetector
+  class ScriptGroup
+    attr_reader :script, :characters, :text
+
+    def initialize(script, characters)
+      @script = script
+      @characters = characters
+      @text = characters.map(&:char).join
+    end
+
+    def length
+      @characters.length
+    end
+
+    def name
+      @characters.first&.name
+    end
+  end
+end

data/lib/unicode_script_detector/scripts.rb

@@ -11,6 +11,11 @@ module UnicodeScriptDetector
         name: "Digit",
         regex: /\d/
       },
+      {
+        script: :Punctuation,
+        name: "Punctuation",
+        regex: /[[:punct:]]/
+      },
       { 
         script: :Adlam, 
         name: "Adlam", 

data/lib/unicode_script_detector/version.rb

@@ -1,3 +1,3 @@
 module UnicodeScriptDetector
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/unicode_script_detector.rb

@@ -9,6 +9,10 @@ module UnicodeScriptDetector
       UnicodeScriptDetector::Detector.new(string).characters
     end
 
+    def script_groups(string)
+      UnicodeScriptDetector::Detector.new(string).script_groups
+    end
+
     def contains?(string, scripts)
       UnicodeScriptDetector::Detector.new(string).contains?(scripts)
     end
@@ -17,4 +21,4 @@ module UnicodeScriptDetector
       UnicodeScriptDetector::Detector.new(string).contains_only?(scripts)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unicode_script_detector
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - David Arendsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2025-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -55,6 +55,7 @@ files:
 - lib/unicode_script_detector.rb
 - lib/unicode_script_detector/character.rb
 - lib/unicode_script_detector/detector.rb
+- lib/unicode_script_detector/script_group.rb
 - lib/unicode_script_detector/scripts.rb
 - lib/unicode_script_detector/version.rb
 homepage: https://github.com/davidarendsen/unicode_script_detector
@@ -79,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Unicode Script Detector