what_you_say 0.6.7

data/Cargo.toml

@@ -0,0 +1,7 @@
+# This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
+# a Rust project. Your extensions depedencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["ext/what_you_say"]
+resolver = "2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Garen J. Torikian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# WhatYouSay
+
+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 [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
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add what_you_say
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install what_you_say
+
+## Usage
+
+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.new.detect_language(text)
+
+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.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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and merge that change into `main`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gjtorikian/what_you_say.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/ext/what_you_say/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "what_you_say"
+version = "1.0.0"
+edition = "2021"
+rust-version = "1.75.0"
+publish = false
+
+[dependencies]
+lingua = "1.6"
+magnus = "0.6"
+
+[lib]
+name = "what_you_say"
+crate-type = ["cdylib"]

data/ext/what_you_say/extconf.rb

@@ -0,0 +1,4 @@
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("what_you_say/what_you_say")

data/ext/what_you_say/src/lang.rs

@@ -0,0 +1,46 @@
+use lingua::Language;
+
+#[magnus::wrap(class = "WhatYouSay::Lang")]
+pub struct WhatYouSayLang {
+    code: String,
+    eng_name: String,
+}
+
+// this is safe as WhatYouSayLang does not contain any Ruby types
+unsafe impl magnus::IntoValueFromNative for WhatYouSayLang {}
+
+impl WhatYouSayLang {
+    pub fn new(lang: Option<Language>) -> WhatYouSayLang {
+        match lang {
+            Some(lang) => WhatYouSayLang {
+                code: lang.iso_code_639_3().to_string(),
+                eng_name: lang.to_string(),
+            },
+            None => WhatYouSayLang {
+                code: "???".to_string(),
+                eng_name: "unknown".to_string(),
+            },
+        }
+    }
+    pub fn all() -> Vec<WhatYouSayLang> {
+        Language::all()
+            .into_iter()
+            .map(|lang| WhatYouSayLang::new(Some(lang)))
+            .collect::<Vec<_>>()
+    }
+
+    pub fn code(&self) -> &str {
+        self.code.as_str()
+    }
+
+    pub fn eng_name(&self) -> &str {
+        self.eng_name.as_str()
+    }
+
+    pub fn inspect(&self) -> String {
+        format!(
+            "#<WhatYouSay::Lang code=\"{0}\" eng_name=\"{1}\">",
+            self.code, self.eng_name
+        )
+    }
+}

data/ext/what_you_say/src/lib.rs

@@ -0,0 +1,88 @@
+extern crate core;
+
+use std::str::FromStr;
+
+use lang::WhatYouSayLang;
+use lingua::{Language, LanguageDetector, LanguageDetectorBuilder};
+
+use magnus::{
+    define_class, exception, function, method, scan_args, Error, Module, Object, RArray, Value,
+};
+
+#[magnus::wrap(class = "WhatYouSay")]
+struct WhatYouSay {
+    detector: LanguageDetector,
+}
+
+impl WhatYouSay {
+    fn new(args: &[Value]) -> Result<Self, magnus::Error> {
+        let args = scan_args::scan_args::<(), (), (), (), _, ()>(args)?;
+
+        let kwargs = scan_args::get_kwargs::<_, (), (Option<RArray>,), ()>(
+            args.keywords,
+            &[],
+            &["allowlist"],
+        )?;
+        let (rb_allowlist,) = kwargs.optional;
+
+        let mut builder = match rb_allowlist {
+            Some(languages) => {
+                let mut allowed_languages = vec![];
+                for allowed in languages.each() {
+                    let allowed = match allowed {
+                        Ok(allowed) => allowed.to_string(),
+                        Err(_) => {
+                            return Err(magnus::Error::new(
+                                exception::runtime_error(),
+                                format!("{allowed:?}"),
+                            ))
+                        }
+                    };
+
+                    // if !Ok, it maeans the language could not be found
+                    if let Ok(language) = Language::from_str(&allowed) {
+                        allowed_languages.push(language)
+                    }
+                }
+                LanguageDetectorBuilder::from_languages(&allowed_languages)
+            }
+            None => LanguageDetectorBuilder::from_all_languages(),
+        };
+
+        // FIXME: this doesn't seem to work when tests are run in parallel
+        // builder.with_preloaded_language_models();
+
+        let detector = builder.build();
+
+        Ok(WhatYouSay { detector })
+    }
+
+    pub fn detect_text(&self, rb_text: String) -> Result<WhatYouSayLang, magnus::Error> {
+        match self.detector.detect_language_of(rb_text) {
+            Some(lang) => {
+                let result = WhatYouSayLang::new(Some(lang));
+
+                Ok(result)
+            }
+            None => Ok(WhatYouSayLang::new(None)),
+        }
+    }
+}
+
+#[magnus::init]
+fn init() -> Result<(), Error> {
+    let c_whatyousay = define_class("WhatYouSay", magnus::class::object())?;
+
+    c_whatyousay.define_singleton_method("new", function!(WhatYouSay::new, -1))?;
+    c_whatyousay.define_method("detect_text", method!(WhatYouSay::detect_text, 1))?;
+
+    let c_lang = c_whatyousay.define_class("Lang", magnus::class::object())?;
+    c_lang.define_singleton_method("all", function!(WhatYouSayLang::all, 0))?;
+    c_lang.define_method("code", method!(WhatYouSayLang::code, 0))?;
+    c_lang.define_method("eng_name", method!(WhatYouSayLang::eng_name, 0))?;
+    c_lang.define_method("inspect", method!(WhatYouSayLang::inspect, 0))?;
+
+    Ok(())
+}
+
+pub mod lang;

data/lib/what_you_say/extension.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+begin
+  # native precompiled gems package shared libraries in <gem_dir>/lib/what_you_say/<ruby_version>
+  # load the precompiled extension file
+  ruby_version = /\d+\.\d+/.match(RUBY_VERSION)
+  require_relative "#{ruby_version}/what_you_say"
+rescue LoadError
+  # fall back to the extension compiled upon installation.
+  # use "require" instead of "require_relative" because non-native gems will place C extension files
+  # in Gem::BasicSpecification#extension_dir after compilation (during normal installation), which
+  # is in $LOAD_PATH but not necessarily relative to this file (see nokogiri#2300)
+  require "what_you_say/what_you_say"
+end

data/lib/what_you_say/lang.rb

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

data/lib/what_you_say/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class WhatYouSay
+  VERSION = "0.6.7"
+end

data/lib/what_you_say.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "what_you_say/extension"
+
+require "what_you_say/lang"
+require "what_you_say/version"
+
+if ENV.fetch("DEBUG", false)
+  require "debug"
+end
+
+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(text)
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: what_you_say
+version: !ruby/object:Gem::Version
+  version: 0.6.7
+platform: ruby
+authors:
+- Garen J. Torikian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  force_ruby_platform: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+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: []
+extensions:
+- ext/what_you_say/extconf.rb
+extra_rdoc_files: []
+files:
+- Cargo.lock
+- Cargo.toml
+- LICENSE.txt
+- README.md
+- ext/what_you_say/Cargo.toml
+- ext/what_you_say/extconf.rb
+- ext/what_you_say/src/lang.rs
+- ext/what_you_say/src/lib.rs
+- lib/what_you_say.rb
+- lib/what_you_say/extension.rb
+- lib/what_you_say/lang.rb
+- lib/what_you_say/version.rb
+homepage: https://github.com/gjtorikian/what_you_say
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  funding_uri: https://github.com/sponsors/gjtorikian/
+  source_code_uri: https://github.com/gjtorikian/what_you_say
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: Fast and lightweight language identification library. Written in Rust, wrapped
+  in Ruby.
+test_files: []