wordnet_japan_diagram 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4145d51875511103723ee93644ecadc5928b5e982eb05a5fcd962757cb49ae20
-  data.tar.gz: fb261b20e10cb7e94b10162d2a35efe41a5419544efb8ce2a5c0b2dc7048c65f
+  metadata.gz: 150dbe4fda2512307197d07428fbbcefb68c90800d30aa23082f26ac5bd8e634
+  data.tar.gz: 43c1e41f5565170eb028767510a1fc8b0b916a1bf4998da1f7bab877be3ca1fd
 SHA512:
-  metadata.gz: 896da652b626b66d3a8cc8ad6bab2bdf8a561afb8746be85f430f89f5a73b6b7d0dc077bce8a83469743d4bff1479413df2aac45387e9a65d48f3ccf09ef3a23
-  data.tar.gz: 941153880f615cd18d2a70f81a53b5656fa4345fb96fbe7390c96c2333047d99c7a75d01e62f8fafafbac27be1f6a2f4bb3a2e300808a0178dd52565ab737325
+  metadata.gz: a6eb1855cd58e5ec4e0740b057337cb7f068704d98487ca8b220276246d951b5b0949f91bbe32568e9165d9811a1c555b07934d2a186d44df3b6f7f76b0df8df
+  data.tar.gz: 4224c2ae5f4babc4643b0d7cf4e14c35e930391e5f60bde22df8d3b0062b3c424b13d10aa10a4d979c3750e34066e61391eefca01fd65a25086959ed055ed11a

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "pry-byebug"

data/README.md

@@ -1,8 +1,8 @@
 # WordnetJapanDiagram
 
-Draw a diagram of [Japanese WordNet](https://bond-lab.github.io/wnja/jpn/index.html) about the hypernyms and hyponyms of the search word.
+[日本語 WordNet](https://bond-lab.github.io/wnja/jpn/index.html)を利用して、検索キーワードの上位語・下位語を可視化します。
 
-example: search プログラミング
+例えば、「プログラミング」を可視化した結果は以下になります。
 
 ![wordnet_japan_diagram_20240218193942](https://github.com/tommy-012/wordnet_japan_diagram/assets/46615665/d5c58962-f1e4-4174-9a9f-47407b72f3e1)
 
@@ -18,11 +18,15 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-### 1. Prepare Japanese WordNet SQLite3 file
-Download [Japanese WordNet SQLite3 file](https://github.com/bond-lab/wnja/releases/download/v1.1/wnjpn.db.gz), unzip the file.
+### 1. 「日本語 WordNet（SQLite3）」を用意します
+[Japanese WordNet SQLite3 file](https://github.com/bond-lab/wnja/releases/download/v1.1/wnjpn.db.gz) をダウンロードして解凍します。
 
-### 2. Execute the command using the above file
-If the above file path is `./tmp/wnjpn.db`, specify the path with `--wordnet_japan_db_file_path` option.
+解凍したファイルを適切なパスに移動します。
+
+### 2. コマンドを実行します
+「日本語 WordNet（SQLite3）」のデフォルトパスは、`./wnjpn.db` になります。
+
+もしパスを指定したい場合は、`--wordnet_japan_db_file_path` オプションで指定します。
 
 ```
 $ wordnet_japan_diagram --wordnet_japan_db_file_path ./tmp/wnjpn.db --search_word サウナ
@@ -31,19 +35,19 @@ $ wordnet_japan_diagram --wordnet_japan_db_file_path ./tmp/wnjpn.db --search_wor
 $ bundle exec wordnet_japan_diagram --wordnet_japan_db_file_path ./tmp/wnjpn.db --search_word サウナ
 ```
 
-### 3. Check the diagram that is the result of the command execution
-The diagram is located under the same path as the command execution.
+### 3. コマンド実行結果を確認します
+可視化した画像は、コマンド実行したパス配下に作られます。
 
-The diagram name is `wordnet_japan_diagram_[%Y%m%d%H%M%S].png`.
+もしパスを指定したい場合は、`--output_diagram_path` オプションで指定します。
 
-※ If you want to specify the diagram path, use `--output_diagram_path` option.
+画像の名前フォーマットは、`wordnet_japan_diagram_[%Y%m%d%H%M%S].png` になります。
 
 ![wordnet_japan_diagram_20240218193545](https://github.com/tommy-012/wordnet_japan_diagram/assets/46615665/afbe25cd-2c3b-4662-a1d0-4bc16517b6a0)
 
-### 4. As needed, use options for the command
+### 4. (必要に応じて) 他オプションを確認できます
 ```
 $ wordnet_japan_diagram --help
-Usage: wordnet_japan_diagram
+Usage: wordnet_japan_diagram [-v]
 
 Specific options:
         --wordnet_japan_db_file_path=text
@@ -63,7 +67,10 @@ Specific options:
         --depth_from_target=number   Sets depth from target node
         --output_diagram_path=text   Sets output diagram path (The file extension is either .pdf, .png, .jpg, or .svg)
                                      default: wordnet_japan_diagram_[%Y%m%d%H%M%S].png
+
+Common options:
         --help                       Show this options information
+    -v, --version                    Show version and quit.
 ```
 
 ## Development

data/exe/wordnet_japan_diagram

@@ -1,5 +1,84 @@
 #!/usr/bin/env ruby
 
+require 'choice'
+
 require 'wordnet_japan_diagram'
 
-WordnetJapanDiagram::CLI.execute
+Choice.options do
+  header ''
+  header 'Specific options:'
+
+  option :wordnet_japan_db_file_path do
+    long '--wordnet_japan_db_file_path=text'
+    desc "Sets wordnet japan db file path\n" \
+         '                                     default: ./wnjpn.db'
+    default 'wnjpn.db'
+  end
+
+  option :search_word, required: true do
+    long '--search_word=text'
+    desc '[Required] Sets japanese word to search'
+    validate /\p{Hiragana}+|\p{Katakana}+|\p{Han}+/
+  end
+
+  option :graph_rankdir do
+    long '--graph_rankdir=[TB|BT|LR|RL]'
+    desc "Sets direction of graph layout\n" \
+         "                                     default: BT\n" \
+         "                                     TB: Top to bottom\n" \
+         "                                     BT: Bottom to top\n" \
+         "                                     LR: Left to right\n" \
+         '                                     RL: Right to left'
+    default 'BT'
+    valid %w(TB BT LR RL)
+  end
+
+  option :node_contents do
+    long '--node_contents=[synset|synset_and_words]'
+    desc "Sets node contents\n" \
+         '                                     default: synset_and_words'
+    default 'synset_and_words'
+    valid %w(synset synset_and_words)
+  end
+
+  option :height_from_target do
+    long '--height_from_target=number'
+    desc 'Sets height from target node'
+    validate /\d+/
+  end
+
+  option :depth_from_target do
+    long '--depth_from_target=number'
+    desc 'Sets depth from target node'
+    validate /\d+/
+  end
+
+  option :output_diagram_path do
+    long '--output_diagram_path=text'
+    desc "Sets output diagram path (The file extension is either .pdf, .png, .jpg, or .svg)\n" \
+         '                                     default: wordnet_japan_diagram_[%Y%m%d%H%M%S].png'
+    default "wordnet_japan_diagram_#{Time.current.strftime('%Y%m%d%H%M%S')}.png"
+    validate /[pdf|png|jpg|svg]$/
+  end
+
+  separator ''
+  separator 'Common options: '
+
+  option :help do
+    long '--help'
+    desc 'Show this options information'
+  end
+
+  option :version do
+    short '-v'
+    long '--version'
+    desc 'Show version and quit.'
+    action do
+      require 'wordnet_japan_diagram/version'
+      puts WordnetJapanDiagram::BANNER
+      exit
+    end
+  end
+end
+
+WordnetJapanDiagram::CLI.execute(options: Choice.choices)

data/lib/wordnet_japan_diagram/cli.rb

@@ -1,101 +1,36 @@
 # frozen_string_literal: true
 
-require 'choice'
+require_relative "command_options"
+require_relative "diagram_creater"
 
-require_relative 'command_options'
-require_relative 'diagram_creater'
-
-require_relative 'wordnet_japan/database'
-require_relative 'wordnet_japan/sense'
-require_relative 'wordnet_japan/synlink'
-require_relative 'wordnet_japan/synset'
-require_relative 'wordnet_japan/synset_def'
-require_relative 'wordnet_japan/word'
-
-Choice.options do
-  header ''
-  header 'Specific options:'
-
-  option :wordnet_japan_db_file_path do
-    long '--wordnet_japan_db_file_path=text'
-    desc "Sets wordnet japan db file path\n" \
-         '                                     default: ./wnjpn.db'
-    default 'wnjpn.db'
-  end
-
-  option :search_word, required: true do
-    long '--search_word=text'
-    desc '[Required] Sets japanese word to search'
-    validate /\p{Hiragana}+|\p{Katakana}+|\p{Han}+/
-  end
-
-  option :graph_rankdir do
-    long '--graph_rankdir=[TB|BT|LR|RL]'
-    desc "Sets direction of graph layout\n" \
-         "                                     default: BT\n" \
-         "                                     TB: Top to bottom\n" \
-         "                                     BT: Bottom to top\n" \
-         "                                     LR: Left to right\n" \
-         '                                     RL: Right to left'
-    default 'BT'
-    valid %w(TB BT LR RL)
-  end
-
-  option :node_contents do
-    long '--node_contents=[synset|synset_and_words]'
-    desc "Sets node contents\n" \
-         '                                     default: synset_and_words'
-    default 'synset_and_words'
-    valid %w(synset synset_and_words)
-  end
-
-  option :height_from_target do
-    long '--height_from_target=number'
-    desc 'Sets height from target node'
-    validate /\d+/
-  end
-
-  option :depth_from_target do
-    long '--depth_from_target=number'
-    desc 'Sets depth from target node'
-    validate /\d+/
-  end
-
-  option :output_diagram_path do
-    long '--output_diagram_path=text'
-    desc "Sets output diagram path (The file extension is either .pdf, .png, .jpg, or .svg)\n" \
-         '                                     default: wordnet_japan_diagram_[%Y%m%d%H%M%S].png'
-    default "wordnet_japan_diagram_#{Time.current.strftime('%Y%m%d%H%M%S')}.png"
-    validate /[pdf|png|jpg|svg]$/
-  end
-
-  option :help do
-    long '--help'
-    desc 'Show this options information'
-  end
-end
+require "wordnet_japan"
 
 module WordnetJapanDiagram
   class CLI
     class << self
-      def execute
-        connect_database
-        create_diagram
+      def execute(options:)
+        new(options).execute
       end
+    end
+
+    def initialize(options)
+      @command_options = CommandOptions.new(options: options)
+    end
 
-      private
+    def execute
+      connect_database
 
-      def connect_database
-        WordnetJapan::Database.connect(command_options)
-      end
+      create_diagram
+    end
 
-      def create_diagram
-        DiagramCreater.new(command_options).create
-      end
+    private
 
-      def command_options
-        @command_options ||= CommandOptions.new(options: Choice.choices)
-      end
+    def connect_database
+      WordnetJapan::Database.connect(database: @command_options.wordnet_japan_db_options[:database])
+    end
+
+    def create_diagram
+      DiagramCreater.new(@command_options).create
     end
   end
 end

data/lib/wordnet_japan_diagram/command_options.rb

@@ -18,7 +18,7 @@ module WordnetJapanDiagram
         output_diagram_path: @options[:output_diagram_path],
         node_contents: @options[:node_contents],
         height_from_target: @options[:height_from_target].nil? ? nil : @options[:height_from_target].to_i,
-        depth_from_target: @options[:depth_from_target].nil? ? nil : @options[:depth_from_target].to_i,
+        depth_from_target: @options[:depth_from_target].nil? ? nil : @options[:depth_from_target].to_i
       }
     end
 

data/lib/wordnet_japan_diagram/diagram_creater.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'graph_viz'
+require_relative "graph_viz"
 
 module WordnetJapanDiagram
   class DiagramCreater
@@ -10,25 +10,22 @@ module WordnetJapanDiagram
     end
 
     def create
-      word = WordnetJapan::Word.find_by(lemma: @options[:search_word], pos: 'n')
+      draw_diagram
 
-      word.synsets.each do |synset|
-        draw(synset)
-      end
-
-      @graph_viz.output(
-        file_type: File.extname(@options[:output_diagram_path]).delete('.').to_sym,
-        file_path: @options[:output_diagram_path]
-      )
+      output_diagram
     end
 
     private
 
-    def draw(synset)
-      draw_target(synset)
+    def draw_diagram
+      word = WordnetJapan::Word.find_by(lemma: @options[:search_word], pos: "n")
+
+      word.synsets.each do |synset|
+        draw_target(synset)
 
-      draw_hype(synset, @options[:height_from_target])
-      draw_hypo(synset, @options[:depth_from_target])
+        draw_hype(synset, @options[:height_from_target])
+        draw_hypo(synset, @options[:depth_from_target])
+      end
     end
 
     def draw_target(synset)
@@ -36,8 +33,9 @@ module WordnetJapanDiagram
     end
 
     def draw_hype(synset, height)
-      dest_synsets = synset.synlinks.where(link: '上位語').map(&:dest_synset)
+      dest_synsets = synset.synlinks.where(link: "上位語").map(&:dest_synset)
 
+      # NOTE: オプション指定がない場合は height が nil になる
       return if (height.present? && height <= 0) || dest_synsets.blank?
 
       dest_synsets.each do |dest_synset|
@@ -49,8 +47,9 @@ module WordnetJapanDiagram
     end
 
     def draw_hypo(synset, depth)
-      dest_synsets = synset.synlinks.where(link: '下位語').map(&:dest_synset)
+      dest_synsets = synset.synlinks.where(link: "下位語").map(&:dest_synset)
 
+      # NOTE: オプション指定がない場合は depth が nil になる
       return if (depth.present? && depth <= 0) || dest_synsets.blank?
 
       dest_synsets.each do |dest_synset|
@@ -62,13 +61,20 @@ module WordnetJapanDiagram
     end
 
     def node_contents(synset)
-      synset_def = synset.synset_defs.where(lang: 'jpn').first&.def
+      synset_def = synset.synset_defs.where(lang: "jpn").first&.def
 
-      return synset_def if @options[:node_contents] == 'synset'
+      return synset_def if @options[:node_contents] == "synset"
 
-      words = synset.words.where(pos: "noun").map(&:lemma).join(',')
+      words = synset.words.where(pos: "noun").map(&:lemma).join(",")
 
       "#{synset_def}\n(#{words})"
     end
+
+    def output_diagram
+      @graph_viz.output(
+        file_type: File.extname(@options[:output_diagram_path]).delete(".").to_sym,
+        file_path: @options[:output_diagram_path]
+      )
+    end
   end
 end

data/lib/wordnet_japan_diagram/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module WordnetJapanDiagram
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
+  BANNER  = "WordnetJapanDiagram #{VERSION}"
 end

data/lib/wordnet_japan_diagram.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "wordnet_japan_diagram/version"
+require_relative 'wordnet_japan_diagram/version'
 
-require_relative "wordnet_japan_diagram/cli"
+require_relative 'wordnet_japan_diagram/cli'

data/wordnet_japan_diagram.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name = "wordnet_japan_diagram"
   spec.version = WordnetJapanDiagram::VERSION
   spec.authors = ["tommy-012"]
-  spec.email = ["lonnlilonn@googlemail.com"]
+  spec.email = ["lonnlilonn@gmail.com"]
 
   spec.summary = "Draw a diagram of Japanese WordNet."
   spec.description = "Draw a diagram of Japanese WordNet about the hypernyms and hyponyms of the search word."
@@ -35,8 +35,7 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
 
-  spec.add_dependency "activerecord", "~> 7.0.4"
-  spec.add_dependency "sqlite3", "~> 1.5.4"
-  spec.add_dependency "ruby-graphviz", "~> 1.2.5"
   spec.add_dependency "choice", "~> 0.2.0"
+  spec.add_dependency "ruby-graphviz", "~> 1.2.5"
+  spec.add_dependency "wordnet_japan"
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wordnet_japan_diagram
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - tommy-012
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 7.0.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 7.0.4
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: choice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
@@ -53,23 +39,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.5
 - !ruby/object:Gem::Dependency
-  name: choice
+  name: wordnet_japan
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
 description: Draw a diagram of Japanese WordNet about the hypernyms and hyponyms of
   the search word.
 email:
-- lonnlilonn@googlemail.com
+- lonnlilonn@gmail.com
 executables:
 - wordnet_japan_diagram
 extensions: []
@@ -90,12 +76,6 @@ files:
 - lib/wordnet_japan_diagram/diagram_creater.rb
 - lib/wordnet_japan_diagram/graph_viz.rb
 - lib/wordnet_japan_diagram/version.rb
-- lib/wordnet_japan_diagram/wordnet_japan/database.rb
-- lib/wordnet_japan_diagram/wordnet_japan/sense.rb
-- lib/wordnet_japan_diagram/wordnet_japan/synlink.rb
-- lib/wordnet_japan_diagram/wordnet_japan/synset.rb
-- lib/wordnet_japan_diagram/wordnet_japan/synset_def.rb
-- lib/wordnet_japan_diagram/wordnet_japan/word.rb
 - sig/wordnet_japan_diagram.rbs
 - wordnet_japan_diagram.gemspec
 homepage: https://github.com/tommy-012/wordnet_japan_diagram

data/lib/wordnet_japan_diagram/wordnet_japan/database.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_record'
-
-module WordnetJapanDiagram
-  module WordnetJapan
-    class Database < ActiveRecord::Base
-      self.abstract_class = true
-
-      def self.connect(command_options)
-        establish_connection(
-          adapter: 'sqlite3',
-          **command_options.wordnet_japan_db_options
-        )
-      end
-    end
-  end
-end

data/lib/wordnet_japan_diagram/wordnet_japan/sense.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module WordnetJapanDiagram
-  module WordnetJapan
-    class Sense < Database
-      self.table_name = 'sense'
-
-      belongs_to :word, foreign_key: :wordid, primary_key: :wordid
-      belongs_to :synset, foreign_key: :synset, primary_key: :synset
-    end
-  end
-end

data/lib/wordnet_japan_diagram/wordnet_japan/synlink.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module WordnetJapanDiagram
-  module WordnetJapan
-    class Synlink < Database
-      self.table_name = 'synlink'
-
-      enum :link, {
-        '上位語' => 'hype',
-        '下位語' => 'hypo',
-        '被構成要素（部分）' => 'mprt',
-        '構成要素（部分）' => 'hprt',
-        '被構成要素（構成員）' => 'mmem',
-        '構成要素（構成員）' => 'hmem',
-        '被構成要素（物質・材料）' => 'msub',
-        '構成要素（物質・材料）' => 'hsub',
-        '被包含領域（カテゴリ）' => 'dmnc',
-        '包含領域（カテゴリ）' => 'dmtc',
-        '被包含領域（語法）' => 'dmnu',
-        '包含領域（語法）' => 'dmtu',
-        '被包含領域（地域）' => 'dmnr',
-        '包含領域（地域）' => 'dmtr',
-        '例' => 'inst',
-        '例あり' => 'hasi',
-        '含意' => 'enta',
-        '引き起こし' => 'caus',
-        '関連' => 'also',
-        '属性' => 'attr',
-        '近似' => 'sim',
-      }
-
-      has_one :src_synset, class_name: 'Synset', foreign_key: :synset, primary_key: :synset1
-      has_one :dest_synset, class_name: 'Synset', foreign_key: :synset, primary_key: :synset2
-      has_many :senses, through: :dest_synset
-      has_many :words, through: :senses
-    end
-  end
-end

data/lib/wordnet_japan_diagram/wordnet_japan/synset.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module WordnetJapanDiagram
-  module WordnetJapan
-    class Synset < Database
-      self.table_name = 'synset'
-
-      has_many :synset_defs, foreign_key: :synset, primary_key: :synset
-      has_many :senses, foreign_key: :synset, primary_key: :synset
-      has_many :words, through: :senses
-      has_many :synlinks, foreign_key: :synset1, primary_key: :synset
-    end
-  end
-end

data/lib/wordnet_japan_diagram/wordnet_japan/synset_def.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module WordnetJapanDiagram
-  module WordnetJapan
-    class SynsetDef < Database
-      self.table_name = 'synset_def'
-
-      belongs_to :synset, foreign_key: :synset, primary_key: :synset
-    end
-  end
-end

data/lib/wordnet_japan_diagram/wordnet_japan/word.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module WordnetJapanDiagram
-  module WordnetJapan
-    class Word < Database
-      self.table_name = 'word'
-
-      enum :pos, {
-        noun:      'n', # NOTE 名詞
-        verb:      'v', # NOTE 動詞
-        adjective: 'a', # NOTE 形容詞
-        adverb:    'r'  # NOTE 副詞
-      }
-
-      has_many :senses, foreign_key: :wordid, primary_key: :wordid
-      has_many :synsets, through: :senses
-    end
-  end
-end