what_you_say 0.4.3-x86_64-darwin → 0.5.1-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 824c12d2e08e3152e0fb0d521cbd147ec3a43255e50a95d8246c7354d3911863
-  data.tar.gz: 6a6dd5c27ce8599c2d87ba985d81fc03a2b46b8e8e8d608a49ba587c80cf5d1d
+  metadata.gz: f8529c4c4cadd6db13ed114c7d58d6e498b5264937eef7b930565e9915ec00ac
+  data.tar.gz: b9c23271028d154b987330589c36d012473007a55ae350ee095d73e367492937
 SHA512:
-  metadata.gz: 1e9230514575afa3960a7ef14e4030b1ac591125ffeda97c8c405c68e3e498907331ee3e514ba6c0202c391adbc3b8ff8222d37698a66c8ae869294c0932b48c
-  data.tar.gz: f561a737710116a6fe2d91c6e42d5f59181cbbdb2d12acb2f7eeffd7d241a5ed913a3efd477fb1ebd751545fbe1661030e6273521dc48cd60b37e2d47d15877e
+  metadata.gz: fb4198f3f7d86cb20960fb925a29bbeb2cbe2af3b207c987b063d17a9d5221ad15989999eb36e68378c944c1dcad73e3b158deb8d90d4a67e3961ef38a9f1b7e
+  data.tar.gz: 02c3626d0151c52481fb503c4ffd201fb13fd4c6874cb27a4052bbfea207d6ed18f34bd9879fd6a7a1c5fa4d2e585ecd5a62beaec063c468b42bf8f21a12db9b

data/README.md

@@ -1,14 +1,12 @@
 # WhatYouSay
 
-Quick and easy natural language detection wrapping the [Whatlang Rust crate](https://github.com/greyblake/whatlang-rs). Instantly identify the source language of a piece of text.
+Quick and easy natural language detection wrapping the [lingua-rs Rust crate](https://github.com/pemistahl/lingua-rs). Instantly identify the source language of a piece of text.
 
 ![What you say!!](https://user-images.githubusercontent.com/64050/224237944-ceb2570c-d544-474a-8c91-41433efdee43.png)
 
-- Supports [69 languages](https://github.com/greyblake/whatlang-rs/blob/master/SUPPORTED_LANGUAGES.md) (nice!)
+- Supports [75+ languages](https://github.com/pemistahl/lingua-rs/tree/main#3-which-languages-are-supported)
 - Core library is written in Rust; this is a Ruby wrapper to it
 - Lightweight, fast, and simple
-- Recognizes not only a language, but also a script (Latin, Cyrillic, etc)
-- Provides reliability information
 
 ## Installation
 
@@ -22,25 +20,52 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-The method to call is `_?`. Why? Because. Pass in the text whose language you want to detect:
+The method to call is `detect_language`.
+
+Pass in the text whose language you want to detect:
 
 ```ruby
 require "what_you_say"
 
 text = "Ĉu vi ne volas eklerni Esperanton? Bonvolu! Estas unu de la plej bonaj aferoj!"
 
-result = WhatYouSay._?(text)
+result = WhatYouSay.new.detect_language(text)
 
-assert_equal("epo", result.code)
-assert_equal("esperanto", result.eng_name)
+assert_equal("epo", result.lang.code)
+assert_equal("esperanto", result.lang.eng_name)
 ```
 
 You also have to opportunity to `inspect` some output:
 
 ```ruby
 text = "Եվ ահա ես ստանում եմ մի զանգ պատահական տղայից"
-WhatYouSay._?(text).inspect
-#=> #<WhatYouSay::Lang code="hye" eng_name="Armenian">
+WhatYouSay.new.detect_language(text).inspect
+#=> #<WhatYouSay::Lang code="hye" eng_name="armenian">
+```
+
+Not everything in life is perfect, and neither is this lib. Sometimes language detection will be wildly mistaken. You
+can attempt to correct this by passing in an `allowlist` of supported languages:
+
+```ruby
+text = "สวัสดี Rágis hello"
+result = WhatYouSay.new.detect_language(text)
+
+assert_equal("spanish", result.eng_name)
+
+result = WhatYouSay.new(allowlist: ["English", "Thai"]).detect_language(text)
+
+assert_equal("eng", result.code)
+```
+
+If a language truly cannot be detected, the `Unknown` language type is returned:
+
+```ruby
+text = "日本語"
+
+result = WhatYouSay.new(allowlist: ["English", "Thai"]).detect_language(text)
+
+assert_equal("???", result.code)
+assert_equal("unknown", result.eng_name)
 ```
 
 ## Development

data/lib/what_you_say/lang.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module WhatYouSay
+class WhatYouSay
   class Lang
   end
 end

data/lib/what_you_say/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module WhatYouSay
-  VERSION = "0.4.3"
+class WhatYouSay
+  VERSION = "0.5.1"
 end

data/lib/what_you_say.rb

@@ -9,13 +9,11 @@ if ENV.fetch("DEBUG", false)
   require "debug"
 end
 
-module WhatYouSay
-  class << self
-    def _?(text)
-      raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)
-      raise TypeError, "text must be UTF-8 encoded; got #{text.encoding}!" unless text.encoding.name == "UTF-8"
+class WhatYouSay
+  def detect_language(text)
+    raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)
+    raise TypeError, "text must be UTF-8 encoded; got #{text.encoding}!" unless text.encoding.name == "UTF-8"
 
-      detect(text, options: {})
-    end
+    detect_text(text)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: what_you_say
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.1
 platform: x86_64-darwin
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Natural language detectio with a focus on simplicity and performance.
-  Currently wraps the whatlang Rust crate.
+description: Natural language detection with a focus on simplicity and performance.
+  Currently wraps the lingua-rs Rust crate.
 email:
 - gjtorikian@users.noreply.github.com
 executables: []