init

DarkKowalski · DarkKowalski · commit 9442df486e00 · 2025-03-04T17:35:56.000+08:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.4.2'
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install mecab
+        run: |
+          sudo apt-get update
+          sudo apt-get install libmecab-dev mecab-ipadic-utf8
+      - name: Run the default task
+        run: bundle exec rake
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,15 @@
+/.bundle/
+/.vscode/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Gemfile.lock
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,13 @@
+plugins:
+  - rubocop-rake
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mecab.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rake-compiler"
+
+gem "minitest", "~> 5.16"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-minitest"
+gem "rubocop-rake"
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Xinyu Wang
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,5 @@
+# Mecab.rb
+
+Ruby binding for [MeCab](https://github.com/markburns/mecab).
+
+It only supports segmentation feature for now.
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rake/extensiontask"
+
+desc "Build Ruby Gem"
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("mecab.gemspec")
+
+Rake::ExtensionTask.new("mecab", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/mecab"
+end
+
+task default: %i[clobber compile test rubocop]
diff --git a/bin/console b/bin/console
@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mecab"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)
diff --git a/bin/setup b/bin/setup
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here
diff --git a/ext/mecab/extconf.rb b/ext/mecab/extconf.rb
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+begin
+  find_executable("mecab-config") or abort "mecab-config not found"
+rescue SystemExit
+  install_text = case RUBY_PLATFORM
+                 when /linux/
+                   "apt install libmecab-dev mecab-ipadic-utf8"
+                 when /darwin/
+                   "brew install mecab mecab-ipadic"
+                 else
+                   "We don't know how to install mecab on your platform"
+                 end
+
+  abort <<~MSG
+    mecab is missing. You can install it by running:
+    #{install_text}
+  MSG
+end
+
+mecab_config = with_config("mecab-config", "mecab-config")
+enable_config("mecab-config")
+
+append_cflags("-fvisibility=hidden -std=c11 -O3 -g")
+append_cflags(`#{mecab_config} --cflags`.chomp)
+
+append_cppflags("-fvisibility=hidden -std=c++11 -O3 -g")
+append_cppflags(`#{mecab_config} --cflags`.chomp)
+
+append_ldflags(`#{mecab_config} --libs`.chomp)
+
+includes = [RbConfig::CONFIG["includedir"]]
+includes += `#{mecab_config} --inc-dir`.chomp.split
+libs = [RbConfig::CONFIG["libdir"]]
+dir_config("mecab", includes, libs)
+
+create_makefile("mecab/mecab")
diff --git a/ext/mecab/mecab.c b/ext/mecab/mecab.c
@@ -0,0 +1,14 @@
+#include <ruby.h>
+
+#include <mecab.h>
+
+#include "segment.h"
+
+RUBY_FUNC_EXPORTED void
+Init_mecab(void)
+{
+  VALUE rb_mMecab = rb_define_module("Mecab");
+  rb_define_const(rb_mMecab, "CPP_VERSION", rb_str_new2(mecab_version()));
+
+  init_segment(rb_mMecab);
+}
diff --git a/ext/mecab/segment.cc b/ext/mecab/segment.cc
@@ -0,0 +1,111 @@
+#include "segment.h"
+
+#include <string>
+#include <vector>
+
+#include <ruby/encoding.h>
+
+#include <mecab.h>
+
+namespace ext_mecab
+{
+    // Only support UTF-8 encoding
+    static rb_encoding *utf8_encoding;
+
+    struct SegmentWrapper
+    {
+        MeCab::Model *model;
+        MeCab::Tagger *tagger;
+    };
+
+    void segment_free(void *data)
+    {
+        SegmentWrapper *wrapper = (SegmentWrapper *)data;
+
+        if (wrapper->tagger)
+        {
+            delete wrapper->tagger;
+        }
+
+        if (wrapper->model)
+        {
+            delete wrapper->model;
+        }
+        delete wrapper;
+    }
+
+    size_t segment_size(const void *data)
+    {
+        return sizeof(SegmentWrapper);
+    }
+
+    static const rb_data_type_t segment_data_type = {
+        .wrap_struct_name = "MeCabSegment",
+        .function = {
+            .dmark = NULL,
+            .dfree = segment_free,
+            .dsize = segment_size,
+        },
+    };
+
+    VALUE segment_alloc(VALUE self)
+    {
+        SegmentWrapper *wrapper = new SegmentWrapper();
+        return TypedData_Wrap_Struct(self, &segment_data_type, wrapper);
+    }
+
+    void segment_initialize(VALUE self, VALUE model_argv)
+    {
+        SegmentWrapper *wrapper;
+        TypedData_Get_Struct(self, SegmentWrapper, &segment_data_type, wrapper);
+
+        wrapper->model = MeCab::Model::create(StringValueCStr(model_argv));
+        if (!wrapper->model)
+        {
+            rb_raise(rb_eRuntimeError, "Failed to create MeCab model: %s", MeCab::getLastError());
+        }
+
+        wrapper->tagger = wrapper->model->createTagger();
+        if (!wrapper->tagger)
+        {
+            rb_raise(rb_eRuntimeError, "Failed to create MeCab tagger: %s", MeCab::getLastError());
+        }
+    }
+
+    VALUE segment_cut(VALUE self, VALUE text_rb_str)
+    {
+        std::string text = StringValueCStr(text_rb_str);
+
+        SegmentWrapper *wrapper;
+        TypedData_Get_Struct(self, SegmentWrapper, &segment_data_type, wrapper);
+
+        VALUE surface = rb_ary_new();
+        const MeCab::Node *node = wrapper->tagger->parseToNode(text.c_str());
+        for (; node; node = node->next)
+        {
+            if (node->stat == MECAB_BOS_NODE || node->stat == MECAB_EOS_NODE)
+            {
+                continue;
+            }
+
+            rb_ary_push(surface, rb_enc_str_new(node->surface, node->length, utf8_encoding));
+        }
+
+        return surface;
+    }
+} // End of namespace ext_mecab
+
+extern "C"
+{
+    void init_segment(VALUE rb_mMecab)
+    {
+        // Initialize UTF-8 encoding
+        ext_mecab::utf8_encoding = rb_utf8_encoding();
+
+        VALUE cSegment = rb_define_class_under(rb_mMecab, "Segment", rb_cObject);
+
+        rb_define_alloc_func(cSegment, ext_mecab::segment_alloc);
+        rb_define_method(cSegment, "_initialize", RUBY_METHOD_FUNC(ext_mecab::segment_initialize), 1);
+        rb_define_method(cSegment, "_cut", RUBY_METHOD_FUNC(ext_mecab::segment_cut), 1);
+    }
+} // End of extern "C"
diff --git a/ext/mecab/segment.h b/ext/mecab/segment.h
@@ -0,0 +1,17 @@
+#ifndef MECAB_SEGMENT_H
+#define MECAB_SEGMENT_H 1
+
+#include <ruby.h>
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+    void init_segment(VALUE rb_mMeCab);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/lib/mecab.rb b/lib/mecab.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "mecab/version"
+require_relative "mecab/mecab"
+require_relative "mecab/segment"
+
+module Mecab
+  class Error < StandardError; end
+  # Your code goes here...
+end
diff --git a/lib/mecab/segment.rb b/lib/mecab/segment.rb
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Mecab
+  # Ruby wrapper for the native extension
+  class Segment
+    attr_reader :model_argv
+
+    # https://manpages.org/mecab for argument details
+    # Example:
+    # Mecab::Segment.new('-d /opt/homebrew/opt/mecab-ipadic/lib/mecab/dic/ipadic')
+    def initialize(model_argv = "")
+      @model_argv = model_argv
+
+      _initialize(model_argv)
+    end
+
+    def cut(sentence)
+      _cut(sentence)
+    end
+  end
+end
diff --git a/lib/mecab/version.rb b/lib/mecab/version.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mecab
+  VERSION = "0.1.0"
+end
diff --git a/mecab.gemspec b/mecab.gemspec
diff --git a/sig/mecab.rbs b/sig/mecab.rbs
diff --git a/test/test_helper.rb b/test/test_helper.rb
diff --git a/test/test_mecab.rb b/test/test_mecab.rb
diff --git a/test/test_segment.rb b/test/test_segment.rb
