groonga-synonym 1.0.0

data/README.md

@@ -0,0 +1,21 @@
+# Groonga synonym
+
+## Description
+
+Groonga synonym provides tools for synonym of Groonga families.
+
+## Install
+
+```bash
+gem install groonga-synonym
+```
+
+## Usage
+
+```bash
+groonga-synonym-generate --source sudachi --format groonga
+```
+
+## License
+
+GPLv3 or later. See `LICENSE.txt` for details.

data/Rakefile

@@ -0,0 +1,36 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "rubygems"
+require "bundler/gem_helper"
+
+base_dir = File.join(__dir__)
+
+helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
+end
+
+helper.install
+spec = helper.gemspec
+
+desc "Run tests"
+task :test do
+  ruby("test/run.rb")
+end
+
+task default: :test

data/bin/groonga-synonym-generate

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "../lib/groonga-synonym"
+
+generator = GroongaSynonym::CommandLine::Generator.new
+exit(generator.run(ARGV))

data/groonga-synonym.gemspec

@@ -0,0 +1,51 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+require_relative "lib/groonga-synonym/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "groonga-synonym"
+  spec.version = GroongaSynonym::VERSION
+  spec.homepage = "https://github.com/groonga/groonga-synonym"
+  spec.authors = ["Sutou Kouhei"]
+  spec.email = ["kou@clear-code.com"]
+
+  readme = File.read("README.md")
+  readme.force_encoding("UTF-8")
+  entries = readme.split(/^\#\#\s(.*)$/)
+  clean_white_space.call(entries[entries.index("Description") + 1])
+  description = clean_white_space.call(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "GPL-3.0+"
+  spec.files = [
+    "README.md",
+    "LICENSE.txt",
+    "Rakefile",
+    "Gemfile",
+    "#{spec.name}.gemspec",
+  ]
+  spec.files += Dir.glob("lib/**/*.rb")
+  Dir.chdir("bin") do
+    spec.executables = Dir.glob("*")
+  end
+
+  spec.add_runtime_dependency("red-datasets", ">= 0.1.3")
+end

data/lib/groonga-synonym.rb

@@ -0,0 +1,20 @@
+# Copyright (C) 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "groonga-synonym/command-line/generator"
+require_relative "groonga-synonym/groonga-generator"
+require_relative "groonga-synonym/pgroonga-generator"
+require_relative "groonga-synonym/sudachi"
+require_relative "groonga-synonym/version"

data/lib/groonga-synonym/command-line/generator.rb

@@ -0,0 +1,176 @@
+# Copyright (C) 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "optparse"
+
+module GroongaSynonym
+  module CommandLine
+    class Generator
+      AVAILABLE_SOURCES = [
+        :sudachi,
+      ]
+
+      AVAILABLE_FORMATS = [
+        :groonga,
+        :pgroonga,
+      ]
+
+      def initialize(output=nil)
+        @source = AVAILABLE_SOURCES.first
+        @format = AVAILABLE_FORMATS.first
+        @table = nil
+        @term_column = nil
+        @synonyms_column = nil
+        @synonyms_column_is_vector = true
+        @output = output || "-"
+        @defaults = {
+          groonga: {
+            table: "Thesaurus",
+            term_column: "_key",
+            synonyms_column: "synonyms",
+          },
+          pgroonga: {
+            table: "thesaurus",
+            term_column: "term",
+            synonyms_column: "synonyms",
+          },
+        }
+      end
+
+      def run(args)
+        catch do |tag|
+          parse_args(args, tag)
+          source = create_source
+          open_output do |output|
+            generator = create_generator(source, output)
+            generator.generate
+            true
+          end
+        end
+      end
+
+      private
+      def format_availables(availables)
+        "[" + availables.join(", ") + "]"
+      end
+
+      def format_defaults(key)
+        AVAILABLE_FORMATS.collect do |format|
+          "#{format}: (#{@defaults[format][key]})"
+        end
+      end
+
+      def parse_args(args, tag)
+        parser = OptionParser.new
+        parser.on("--source=SOURCE",
+                  AVAILABLE_SOURCES,
+                  "Synonym source",
+                  format_availables(AVAILABLE_SOURCES),
+                  "(#{@source})") do |source|
+          @source = source
+        end
+        parser.on("--format=FORMAT",
+                  AVAILABLE_FORMATS,
+                  "Output format",
+                  format_availables(AVAILABLE_FORMATS),
+                  "(#{@format})") do |format|
+          @format = format
+        end
+        parser.on("--table=TABLE",
+                  "Synonyms table's name",
+                  *format_defaults(:table)) do |table|
+          @table = table
+        end
+        parser.on("--term-column=COLUMN",
+                  "Term column's name",
+                  *format_defaults(:term_column)) do |column|
+          @term_column = column
+        end
+        parser.on("--synonyms-column=COLUMN",
+                  "Synonyms column's name",
+                  *format_defaults(:synonyms_column)) do |column|
+          @synonyms_column = column
+        end
+        parser.on("--no-synonyms-column-is-vector",
+                  "Synonyms column isn't a vector column",
+                  "This is only for 'groonga' source") do |boolean|
+          @synonyms_column_is_vector = boolean
+        end
+        parser.on("--output=OUTPUT",
+                  "Output path",
+                  "'-' means the standard output",
+                  "(#{@output})") do |output|
+          @output = output
+        end
+        parser.on("--version",
+                  "Show version and exit") do
+          puts(VERSION)
+          throw(tag, true)
+        end
+        parser.on("--help",
+                  "Show this message and exit") do
+          puts(parser.help)
+          throw(tag, true)
+        end
+        parser.parse!(args.dup)
+      end
+
+      def open_output(&block)
+        case @output
+        when "-"
+          yield($stdout)
+        when String
+          File.open(@output, "w", &block)
+        else
+          yield(@output)
+        end
+      end
+
+      def create_source
+        case @source
+        when :sudachi
+          Sudachi.new
+        end
+      end
+
+      def create_generator(source, output)
+        options = {
+          output: output,
+        }
+        case @format
+        when :groonga
+          default = @defaults[:groonga]
+          term_column = @term_column || default[:term_column]
+          synonyms_column = @synonyms_column || default[:synonyms_column]
+          options[:synonyms_column_is_vector] = @synonyms_column_is_vector
+          GroongaGenerator.new(source,
+                               term_column,
+                               synonyms_column,
+                               **options)
+        when :pgroonga
+          default = @defaults[:pgroonga]
+          table = @table || default[:table]
+          term_column = @term_column || default[:term_column]
+          synonyms_column = @synonyms_column || default[:synonyms_column]
+          PGroongaGenerator.new(source,
+                                table,
+                                term_column,
+                                synonyms_column,
+                                **options)
+        end
+      end
+    end
+  end
+end

data/lib/groonga-synonym/groonga-generator.rb

@@ -0,0 +1,55 @@
+# Copyright (C) 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "json"
+
+module GroongaSynonym
+  class GroongaGenerator
+    def initialize(source,
+                   term_column,
+                   synonyms_column,
+                   synonyms_column_is_vector: true,
+                   output: $stdout)
+      @source = source
+      @term_column = term_column
+      @synonyms_column = synonyms_column
+      @synonyms_column_is_vector = synonyms_column_is_vector
+      @output = output
+    end
+
+    def generate
+      @output.print("[\n")
+      @output.print([@term_column, @synonyms_column].to_json)
+      @source.each do |term, synonyms|
+        @output.print(",\n")
+        record = [term]
+        formatted_synonyms = synonyms.collect do |synonym|
+          formatted_synonym = synonym.to_groonga
+          unless @synonyms_column_is_vector
+            formatted_synonym = "(#{formatted_synonym})"
+          end
+          formatted_synonym
+        end
+        if @synonyms_column_is_vector
+          record << formatted_synonyms
+        else
+          record << formatted_synonyms.join(" OR ")
+        end
+        @output.print(record.to_json)
+      end
+      @output.print("\n]\n")
+    end
+  end
+end

data/lib/groonga-synonym/pgroonga-generator.rb

@@ -0,0 +1,59 @@
+# Copyright (C) 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "json"
+
+module GroongaSynonym
+  class PGroongaGenerator
+    def initialize(source,
+                   table,
+                   term_column,
+                   synonyms_column,
+                   output: $stdout)
+      @source = source
+      @table = table
+      @term_column = term_column
+      @synonyms_column = synonyms_column
+      @output = output
+    end
+
+    def generate
+      @output.print("INSERT INTO #{@table} ")
+      @output.print("(#{@term_column}, #{@synonyms_column}) ")
+      @output.print("VALUES")
+      i = 0
+      @source.each do |term, synonyms|
+        i += 1
+        @output.print(",") unless i == 1
+        @output.print("\n")
+        formatted_synonyms = synonyms.collect do |synonym|
+          escape(synonym.to_groonga)
+        end
+        @output.print("  (#{escape(term)}, ARRAY[")
+        @output.print(formatted_synonyms.join(", "))
+        @output.print("])")
+      end
+      @output.print(";\n")
+    end
+
+    private
+    def escape(string)
+      escaped = "'"
+      escaped << string.gsub("'", "''")
+      escaped << "'"
+      escaped
+    end
+  end
+end