what_you_say 0.4.4-x64-mingw-ucrt → 0.5.1-x64-mingw-ucrt

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74bd0b10ec966b572217602243446715dcc3a2efa4679a0938316c8b468b36dd
-  data.tar.gz: 61c6c310338b26dad2bd081a69aed34d6d388991cb00229f8bdd878282304b38
+  metadata.gz: 4a3eebfcd2cdf1377d60b3deb8e1c6aa0a8ea23aa22a30768223efcc2533e30b
+  data.tar.gz: 169c7347a3c39525a68217a5c5ba9365624e600e720a68078227446f8a7aa564
 SHA512:
-  metadata.gz: 674645a28186c1ea835786cd9a6ee4a4d53f003c4f2910ca909697a62ace511e3be235b9d741cf8fd71bddc315b44618e0e8cb31900c8c3219cc64aaed8b8b02
-  data.tar.gz: 474ace8d7d7d7f7c369b53ee1ae9510afe82f4906e7032206a8815535a0b8e139553c79b4a83abb4c4e1278648c0fd6aaf634593f90a19e7af2805a72f4fccdc
+  metadata.gz: bb173ee280b022d7c97ef25a5518b4e98a9ccd10cf96cf09ab536b3e0539ce77f7d1af3e9e62e58c1eb055ddd8799babce1eee145d86c58763631db87514df91
+  data.tar.gz: 3ca78fe5487913a953194abb384eed9f8aa55c7d6e3f7517f3e9ac0ce822e2d723d16afed73716dfe30db368b5eeb91075f94785826c223e8866c1f779222aa0

data/README.md

@@ -20,7 +20,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-The method to call is `_?`. Why? Because it looked nice.
+The method to call is `detect_language`.
 
 Pass in the text whose language you want to detect:
 
@@ -29,7 +29,7 @@ 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.lang.code)
 assert_equal("esperanto", result.lang.eng_name)
@@ -39,10 +39,35 @@ You also have to opportunity to `inspect` some output:
 
 ```ruby
 text = "Եվ ահա ես ստանում եմ մի զանգ պատահական տղայից"
-WhatYouSay._?(text).inspect
+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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake compile test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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.4"
+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.4
+  version: 0.5.1
 platform: x64-mingw-ucrt
 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: []