sudachi-installer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5be00dfec1022cf22ca79d58fd9f6ba35b93a9838702488bb9b1ab02c635f1ec
+  data.tar.gz: 1ec8b2fb22c9eede2afd75f03b36ad86632a11dcec6ed5716074f73cdc5532a7
+SHA512:
+  metadata.gz: 4083d52259612beaba507b8195f7cdd5e8ff85ede0483f329f6eb45ebe01cf6fdf38f81e83e76cd19f9c512d7c64e6ff7e4184672901f972b9d41721118399d6
+  data.tar.gz: db7d82354a8dc8f08bd0700afe641d99bc6831330a6d4f8f0f353e1654b06d070185403c3a05f91fc217292a2fce6a1869e39d79aa4e622a43f68babbaa53e30

data/.editorconfig

@@ -0,0 +1,5 @@
+[*]
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-16
+
+ * Initial Release

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sudachi-installer.gemspec
+gemspec
+
+group :development do
+  gem "rake", "~> 13.0"
+  gem "standard", "~> 1.3"
+  gem "solargraph", "> 0.38"
+  gem "yard", ">= 0.9.30"
+end
+
+group :development, :test do
+  gem "minitest", "~> 5.0"
+  gem "minitest-reporters", "~> 1"
+  gem "minitest-power_assert"
+  gem "minitest-skip"
+  gem "vcr", "~> 6"
+  gem "webmock", "~> 3"
+end

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2023 wtnabe
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,58 @@
+# SudachiInstaller
+
+A helper gem to downloading and extracting Sudachi executable and dictionary files.
+
+Use with [rudachi-rb](https://github.com/songcastle/rudachi-rb) :)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add sudachi-installer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install sudachi-installer
+
+## Usage
+
+```ruby
+require "sudachi-installer/releases"
+require "sudachi-installer/dicts"
+require "rudachi-rb"
+
+SudachiInstaller.configure do |c|
+  c.jar_dir = "/path/to/jar_dir"
+  c.dict_dir = "/path/to/dict_dir"
+end
+
+releases = SudachiInstaller::Releases.new
+# releases.minimum_list
+releases.download("v0.7.1")
+
+dicts = SudachiInstaller::Dicts.new
+# dicts.revisions(:dict)
+dicts.download(:dict, "20230110", "small")
+
+resolver = SudachiInstaller::Resolver.new
+
+Rudachi.configure do |c|
+  config.jar_path = resolver.jar_path("0.7.1")
+end
+
+Rudachi::Option.configure do |c|
+  c.s = {"systemDict": resolver.dict_path(revision: "20230110", edition: "small")
+  c.a = true
+  c.m = "C"
+end
+```
+
+## 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/wtnabe/sudachi-installer.

data/Rakefile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb", "spec/**/*.rb"]
+  t.stats_options = ["--list-undoc"]
+end
+
+require "standard/rake"
+
+desc "tmp:clear"
+task "tmp:clear" do
+  Dir.glob(File.join(__dir__, "/tmp/*")).each { |f|
+    FileUtils.rm_rf(f)
+  }
+end
+
+task default: %i[spec standard]

data/lib/sudachi-installer/dicts.rb

@@ -0,0 +1,111 @@
+require "faraday"
+require "rexml"
+require "xmlhasher"
+require_relative "./downloader"
+
+module SudachiInstaller
+  #
+  # dictionary index and download
+  #
+  class Dicts
+    #
+    # @param [Object] httpclient
+    #
+    def initialize(httpclient: Faraday)
+      @http = httpclient
+      @endpoint = {
+        index: "https://sudachi.s3-ap-northeast-1.amazonaws.com",
+        zip: "http://sudachi.s3-website-ap-northeast-1.amazonaws.com"
+      }
+    end
+
+    #
+    # @return [string]
+    #
+    def fetch
+      @http.get(@endpoint[:index]).body
+    end
+
+    #
+    # @return [Array]
+    #
+    def prefixes
+      [:dict, :synonym]
+    end
+
+    #
+    # @param [Symbol] type
+    # @return [RegExp]
+    #
+    def re_template(type)
+      case type
+      when :dict
+        %r{\Asudachidict/sudachi-dictionary-(latest|[0-9.]+)-(core|full|small)\.zip\z}
+      when :synonym
+        %r{\Asudachisynonym/sudachi-synonym-(latest|[0-9.]+)\.zip\z}
+      end
+    end
+
+    #
+    # @overload url(type, param1, ...)
+    #   @param [Symbol] type
+    #   @param [string] param1
+    #   @param [string] ...
+    # @return [String]
+    #
+    def url(type, *param)
+      case type
+      when :dict
+        "sudachidict/sudachi-dictionary-#{param[0]}-#{param[1]}.zip"
+      when :synonym
+        "sudachisynonym/sudachi-synonym-#{param[0]}.zip"
+      end
+    end
+
+    #
+    # parse xml Contents/ 以下
+    #
+    # @param [String] document
+    # @return [Array]
+    #
+    def index(document = fetch)
+      if !@index
+        doc = REXML::Document.new(document)
+        @index = REXML::XPath.match(doc, "//Contents").map { |content|
+          XmlHasher.parse(content.to_s)[:Contents]
+        }
+      end
+
+      @index
+    end
+
+    #
+    # @param [Symbol] type
+    # @return [Array]
+    #
+    def revisions(type)
+      index.map { |e|
+        re_template(type).match(e[:Key])
+      }.compact.map { |m|
+        m.to_a[1..]
+      }
+    end
+
+    #
+    # @overload download(type, param1, ...)
+    #   @param [Symbol] type
+    #   @param [String] param1
+    #   @param [String] ...
+    #
+    def download(type, *param)
+      source = url(type, *param)
+      filename = File.basename(source)
+
+      Downloader.new.download(
+        File.join(@endpoint[:zip], source),
+        filename,
+        SudachiInstaller.config.dict_dir
+      )
+    end
+  end
+end

data/lib/sudachi-installer/downloader.rb

@@ -0,0 +1,41 @@
+require "dry-configurable"
+require "down"
+require "fileutils"
+require "zip"
+
+module SudachiInstaller
+  #
+  # download and expand archive if it is zip archive
+  #
+  class Downloader
+    extend Dry::Configurable
+
+    #
+    # @param [string] url
+    # @param [string] filename
+    # @param [string] dest_dir
+    #
+    def download(url, filename, dest_dir)
+      FileUtils.mkdir_p(dest_dir)
+
+      Down.download(url, destination: File.join(dest_dir, filename))
+      expand(File.join(dest_dir, filename), force: true) if filename.match?(/\.zip\z/i)
+    end
+
+    #
+    # @param [String] path
+    # @param [boolean] force
+    #
+    def expand(path, force: false)
+      dir = File.dirname(path)
+
+      Zip::File.open(path) { |zip|
+        zip.each { |entry|
+          dest = File.join(dir, entry.name)
+          FileUtils.rm_rf dest if File.exist?(dest) && force
+          entry.extract(File.join(dir, entry.name))
+        }
+      }
+    end
+  end
+end

data/lib/sudachi-installer/faraday_fake.rb

@@ -0,0 +1,18 @@
+#
+# fake class for Faraday.get
+#
+class FaradayFake
+  class << self
+    #
+    # @param [string] endpoint
+    # @return [Object]
+    #
+    def get(endpoint)
+      if !@xml
+        @xml = Struct.new(:body).new(File.read(endpoint))
+      end
+
+      @xml
+    end
+  end
+end

data/lib/sudachi-installer/releases.rb

@@ -0,0 +1,159 @@
+require "octokit"
+require_relative "../sudachi-installer"
+require_relative "./downloader"
+
+module SudachiInstaller
+  #
+  # GitHub releases
+  #
+  class Releases
+    class ReleaseNotExist < Error; end # rubocop:disable
+    class AssetsAmbiguous < Error; end # rubocop:disable
+
+    def initialize(httpclient: Faraday)
+      @octokit = Octokit::Client.new
+      @http = httpclient
+    end
+
+    #
+    # @return [string]
+    #
+    def repo
+      "WorksApplications/Sudachi"
+    end
+
+    #
+    # @param [Hash] release
+    # @return [Hash]
+    #
+    def compact_release(release)
+      {
+        id: release[:id],
+        name: release[:name],
+        tag_name: release[:tag_name],
+        url: release[:url],
+        html_url: release[:html_url],
+        target_commitish: release[:target_commitish],
+        created_at: release[:created_at],
+        published_at: release[:published_at],
+        assets: release[:assets].map { |asset| compact_asset(asset) }
+      }
+    end
+
+    #
+    # @param [Hash] asset
+    # @return [Hash]
+    #
+    def compact_asset(asset)
+      {
+        url: asset[:url],
+        name: asset[:name],
+        content_type: asset[:content_type],
+        created_at: asset[:created_at],
+        updated_at: asset[:updated_at],
+        browser_download_url: asset[:browser_download_url],
+        body: asset[:body]
+      }
+    end
+
+    #
+    # setup octokit
+    #
+    def prefetch
+      @repo = @octokit.repo(repo)
+      @endpoint = @repo.rels[:releases]
+    end
+
+    #
+    # fetch releases
+    #
+    def fetch
+      if !@releases
+        prefetch
+        @releases = @endpoint.get.data
+      end
+    end
+
+    #
+    # @return [Array]
+    #
+    def list(type: "compact")
+      fetch
+
+      case type
+      when "minimum"
+        minimum_list
+      when "compact"
+        @releases.map { |release| compact_release(release) }
+      else
+        @releases
+      end
+    end
+
+    #
+    # @return [Array]
+    #
+    def minimum_list
+      fetch
+
+      @releases.map { |release|
+        {
+          id: release[:id],
+          tag_name: release[:tag_name]
+        }
+      }
+    end
+
+    #
+    # @param [boolean] compact
+    # @return [Hash]
+    #
+    def latest(compact: true)
+      prefetch
+      release = @octokit.get(@endpoint.href + "/latest")
+
+      if compact
+        compact_release(release)
+      else
+        release
+      end
+    end
+
+    #
+    # @param [String] tag
+    # @param [boolean] compact
+    # @return [<Hash, nil>]
+    #
+    def version(tag, compact: false)
+      release = minimum_list.find { |r| r[:tag_name] == tag }
+
+      if release
+        release_info = @octokit.get(@endpoint.href + "/#{release[:id]}")
+        if compact
+          compact_release(release_info)
+        else
+          release_info
+        end
+      else
+        raise ReleaseNotExist.new(tag)
+      end
+    end
+
+    #
+    # @param [String] tag
+    # @return [void]
+    #
+    def download(tag)
+      rel = version(tag, compact: true)
+      assets = rel[:assets]
+
+      raise AssetsAmbiguous.new(tag) if assets.size > 1
+
+      Downloader.new.download(
+        assets.first[:browser_download_url],
+        assets.first[:name],
+        SudachiInstaller.config.jar_dir
+      )
+    end
+  end
+end

data/lib/sudachi-installer/resolver.rb

@@ -0,0 +1,78 @@
+require_relative "../sudachi-installer"
+
+module SudachiInstaller
+  #
+  # downloaded file resolver
+  #
+  class Resolver
+    include SudachiInstaller
+
+    class ExecutableVersionNotDownloaded < Error; end # rubocop:disable
+    class DictionaryNotDownloaded < Error; end # rubocop:disable
+
+    #
+    # @return [string]
+    #
+    def jar_dir
+      self.class.ancestors[1].config.jar_dir
+    end
+
+    #
+    # @return [String]
+    #
+    def dict_dir
+      self.class.ancestors[1].config.dict_dir
+    end
+
+    #
+    # @return [Array]
+    #
+    def executable_jars
+      Dir.chdir(jar_dir) {
+        Dir.glob("sudachi-*-executable").select { |f|
+          FileTest.directory? f
+        }
+      }
+    end
+
+    #
+    # @param [String] revision
+    # @return [String]
+    #
+    def jar_path(revision)
+      dir = executable_jars.find { |e| e == "sudachi-#{revision}-executable" }
+
+      if dir
+        File.join(jar_dir, dir, "sudachi-#{revision}.jar")
+      else
+        raise ExecutableVersionNotDownloaded.new(dir)
+      end
+    end
+
+    #
+    # @return [Array]
+    #
+    def dictionaries
+      Dir.chdir(dict_dir) {
+        Dir.glob("sudachi-dictionary-*").select { |f|
+          FileTest.directory? f
+        }
+      }
+    end
+
+    #
+    # @param [String] revision
+    # @param [String] edition
+    # @return [String]
+    #
+    def dict_path(revision:, edition: "core")
+      dir = dictionaries.find { |e| e == "sudachi-dictionary-#{revision}" }
+
+      if dir
+        File.join(dict_dir, dir, "system_#{edition}.dic")
+      else
+        raise DictionaryNotDownloaded.new({revision: revision, edition: edition}.to_s)
+      end
+    end
+  end
+end

data/lib/sudachi-installer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SudachiInstaller
+  VERSION = "0.1.0" # rubocop:disable
+end

data/lib/sudachi-installer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "dry-configurable"
+require_relative "sudachi-installer/version"
+
+#
+# Download and deploy Sudachi exectable and dictionary
+#
+module SudachiInstaller
+  extend Dry::Configurable
+
+  setting :dict_dir
+  setting :jar_dir
+
+  class Error < StandardError; end # rubocop:disable
+  # Your code goes here...
+end

data/sig/sudachi-installer/sudachi-installer.rbs

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

data/sudachi-installer.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/sudachi-installer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sudachi-installer"
+  spec.version = SudachiInstaller::VERSION
+  spec.authors = ["wtnabe"]
+  spec.email = ["18510+wtnabe@users.noreply.github.com"]
+
+  spec.summary = "download and store Sudachi jar and dict files"
+  spec.homepage = "https://github.com/wtnabe/sudachi-installer-rb"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "octokit", "~> 6"
+  spec.add_dependency "faraday-follow_redirects", "~> 0"
+  spec.add_dependency "down", "~> 5"
+  spec.add_dependency "xmlhasher", "~> 1"
+  spec.add_dependency "dry-configurable", "~> 0"
+  spec.add_dependency "rubyzip", "~> 2"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: sudachi-installer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wtnabe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: xmlhasher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description:
+email:
+- 18510+wtnabe@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sudachi-installer.rb
+- lib/sudachi-installer/dicts.rb
+- lib/sudachi-installer/downloader.rb
+- lib/sudachi-installer/faraday_fake.rb
+- lib/sudachi-installer/releases.rb
+- lib/sudachi-installer/resolver.rb
+- lib/sudachi-installer/version.rb
+- sig/sudachi-installer/sudachi-installer.rbs
+- sudachi-installer.gemspec
+homepage: https://github.com/wtnabe/sudachi-installer-rb
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wtnabe/sudachi-installer-rb
+  source_code_uri: https://github.com/wtnabe/sudachi-installer-rb
+  changelog_uri: https://github.com/wtnabe/sudachi-installer-rb/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: download and store Sudachi jar and dict files
+test_files: []