what_you_say 0.4.4-arm64-darwin → 0.5.1-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34baf6a05420a8249f7eb87c892d9df218f8261d6b9be2a4edf17269259e0b8
-  data.tar.gz: 16b5c6666da6762feedb835e1d6488e77fa25a5f207fa3e162543eb31beb7d54
+  metadata.gz: f7d570cb4b6b9a472cd947ddbe722bdaa967e4aaa3847bdb8888a21fa4e69273
+  data.tar.gz: cda9d9914f50a087d0f15602a99f0ed87dbee65264679ca92e12f170245a04e5
 SHA512:
-  metadata.gz: 5155b23d535f888d675d2853cd577800ffccaeee344c4ede1af28a84f3be215e5660e1e522687a73d03c814daa82a4e518b909bd4e6d11f64d9f03a8b76e2fc8
-  data.tar.gz: 37c6efb45767ba37112eb03c84d29b44d02ffdbac0ff6c637a07ea8c03862f33b5c5801f1e030cb1a55720d6d2ee23321ca31e41a41ccca39ac3602e53bdb24c
+  metadata.gz: 519b83eca28c92b4732a87a36092bf2de412508a2005d0a56754b014de411a78982da19daea2ccf4b191ed7eaba863d16fbca62bcc6ffcfdcb91c675dab14287
+  data.tar.gz: e5291764ea9387e723d7120b2c34def7e099baecbb98791eb7a2538267640b153d10c35b6484a470aebfcd8ee91525fc613a6a44d0202f5c9bffb3da0abb15d2

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: arm64-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: []