charubya 0.2.0

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 dependencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["./ext/charubya"]
+resolver = "2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Marce Coll
+
+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,38 @@
+# Charubya
+
+This is a wrapper around the meilisearch [`Charabia`](https://github.com/meilisearch/charabia) library.
+
+It doesn't implement the whole API, only what is needed for our usecase (segmentation).
+
+It exposes a single method in the `Charabia` module: `segment`, it takes a string and returns
+a list of strings.
+
+```ruby
+Charubya.segment('昨日すき焼きを食べました')
+# => ['昨日', 'すき焼き', 'を', '食べ', 'まし', 'た']
+```
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add charubya
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install charubya
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake 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 then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/happyscribe/charabia-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rb_sys/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("charubya.gemspec")
+
+RbSys::ExtensionTask.new("charubya", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/charubya"
+end
+
+task default: %i[compile test rubocop]
+
+
+desc "Build native extension for a given platform (i.e. `rake 'native[x86_64-linux]'`)"
+task :native, [:platform] do |_t, platform:|
+  build_native_gem platform
+end
+
+task :publish do |_t|
+  %w[x86_64-linux arm64-darwin x86_64-darwin].each do |arch|
+    build_native_gem arch
+  end
+end
+
+def build_native_gem(arch)
+  sh "bundle", "exec", "rb-sys-dock", "--platform", arch, "--build", "-r", "3.3,3.2,3.1"
+end
+

data/ext/charubya/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "charubya"
+version = "0.1.0"
+edition = "2021"
+authors = ["Marce Coll <marce@dziban.net>"]
+license = "MIT"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+magnus = { version = "0.6.2" }
+charabia = "0.8.2"

data/ext/charubya/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("charubya/charubya")

data/ext/charubya/src/lib.rs

@@ -0,0 +1,17 @@
+use magnus::{function, prelude::*, Error, Ruby};
+use charabia::Segment;
+
+fn segment(text: String) -> Vec<String> {
+    text
+      .as_str()
+      .segment_str()
+      .map(|s| s.to_owned())
+      .collect()
+}
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let module = ruby.define_module("Charubya")?;
+    module.define_singleton_method("segment", function!(segment, 1))?;
+    Ok(())
+}

data/lib/charubya/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Charubya
+  VERSION = "0.2.0"
+end

data/lib/charubya.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "charubya/version"
+begin
+  ruby_version = /\d+\.\d+/.match(RUBY_VERSION)
+  require_relative "charubya/#{ruby_version}/charubya"
+rescue LoadError
+  require_relative "charubya/charubya"
+end
+
+module Charubya
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/shell.nix

@@ -0,0 +1,15 @@
+{ pkgs ? import <nixpkgs> {} }:
+pkgs.mkShell {
+  buildInputs = [
+    pkgs.clang
+    pkgs.libclang
+    pkgs.rbspy
+  ];
+
+  shellHook = ''
+    export NODE_OPTIONS=--openssl-legacy-provider
+    export LD_LIBRARY_PATH="${pkgs.lib.makeLibraryPath([pkgs.libclang.lib])}"
+    export LIBCLANG_PATH = "${pkgs.libclang.lib}/lib";
+    source ~/.bashrc
+  '';
+}

data/sig/charubya.rbs

@@ -0,0 +1,4 @@
+module Charubya
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/test.rb

@@ -0,0 +1,6 @@
+puts RUBY_VERSION
+ruby_version = /\d+\.\d+/.match(RUBY_VERSION)
+puts ruby_version
+require 'charubya'
+puts Charubya::VERSION
+puts Charubya.segment('hola que tal')

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: charubya
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Marce Coll
+autorequire:
+bindir: exe
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- marce@dziban.net
+executables: []
+extensions:
+- ext/charubya/Cargo.toml
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Cargo.lock
+- Cargo.toml
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/charubya/Cargo.toml
+- ext/charubya/extconf.rb
+- ext/charubya/src/lib.rs
+- lib/charubya.rb
+- lib/charubya/version.rb
+- shell.nix
+- sig/charubya.rbs
+- test.rb
+homepage: https://github.com/happyscribe/charubya
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/happyscribe/charubya
+  source_code_uri: https://github.com/happyscribe/charubya
+  changelog_uri: https://github.com/happyscribe/charubya/CHANGELOG.md
+  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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.5.15
+signing_key:
+specification_version: 4
+summary: A wrapper around meilisearch's charabia rust library
+test_files: []