epub-translator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d3a2097137099f87c52a3cfa7358d9ba79d12288631267913371df4ba8e9eb2
+  data.tar.gz: d212b682ab130cca1d1740946b36f25d0537d22b9f85929aab12895c57980e96
+SHA512:
+  metadata.gz: 051da38c1df90cc5da8a37541dc404906c7a4f45023088cbf3c72c3bf8525d390ca59c470977929a819f31a27d284a6bab4447ba66699c0a9e2ae183d00f5291
+  data.tar.gz: 7b39119783ac14f4487728fd2bcf5fa6c200bc75f7e38e7c18c8d980fea98947892e2eed104cc182cba46fd322375e6279b4cea70aed09531b747cdd326f0f0d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,91 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'lib/monkey_patch/*'
+
+Style/StringLiterals:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/UnlessLogicalOperators:
+  Enabled: true
+  EnforcedStyle: forbid_logical_operators
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-02
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in epub-translator.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem 'rib'
+
+# gem 'natsukantou', path: '../natsukantou'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 lulalala
+
+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,59 @@
+# Epub::Translator
+
+Translate Epub file with machine translation services such as DeepL.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add epub-translator
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install epub-translator
+
+## Usage
+
+To run it as a command:
+
+    $ epub-translator [EPUB_FILE]
+
+It's a wizard that guides you through setting up a translator configuration...
+
+![Wizard](./docs/eg_wizard_config.png)
+
+and then asks you how to translate:
+
+![Wizard](./docs/eg_wizard_translate.png)
+
+After you have the translated file, you can choose to interlace it against the original by running:
+
+    $ epub-interlace [EPUB_FILE_1] [EPUB_FILE_2]
+
+It will generate another EPUB file, with translated paragraphs next to their sources.
+
+![Interlaced result](./docs/eg_interlace.png)
+
+## Feature
+
+Epub::Translator utilized [Natsukantou](https://gitlab.com/lulalala/natsukantou) gem, which aims to be configurable. For example, it comes with its own glossary middleware, and can handle HTML Ruby Markup. The wizard will ask you which you want to use, but you can read [here](https://gitlab.com/lulalala/natsukantou#middlewares) to learn more about them.
+
+### Translators
+
+[List of supported translation services](https://gitlab.com/lulalala/natsukantou#translators)
+
+## Development
+
+The XML related operations are purposefully extracted into its own gem: [Natsukantou](https://gitlab.com/lulalala/natsukantou).
+
+This gem uses [Oga XML parser](https://gitlab.com/yorickpeterse/oga) and [epub-parser](https://gitlab.com/KitaitiMakoto/epub-parser) (both hosted on GitLab, yay!).
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/lulalala/epub-translator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The EPUB included in the repository is [The Madman by Khalil Gibran](https://standardebooks.org/ebooks/khalil-gibran/the-madman), which is licensed under [public domain](https://creativecommons.org/publicdomain/zero/1.0/). I use it for testing purposes because it is a very short book.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/epub-translator.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/epub/translator/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "epub-translator"
+  spec.version = Epub::Translator::VERSION
+  spec.authors = ["lulalala"]
+  spec.email = ["mark@goodlife.tw"]
+
+  spec.summary = "Tools to translate EPUB books"
+  spec.homepage = "http://gitlab.com/lulalala/epub-translator"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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 "epub-maker", "~> 0.1.7"
+  spec.add_dependency "epub-parser", "~> 0.4.6"
+  spec.add_dependency "middleware", "~> 0.1.0"
+  spec.add_dependency "natsukantou", "~> 0.1.2"
+  spec.add_dependency "tty-prompt", "~> 0.23"
+
+  spec.add_development_dependency "debug", ">= 1.0.0"
+  spec.add_development_dependency "pry"
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/epub-interlace

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require 'optparse'
+require "natsukantou"
+require "epub/translator/prompt/interlace"
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: epub-interlace EPUB_FILE_1 EPUB_FILE_2"
+end
+
+optparse.parse!
+if ARGV.empty?
+  puts optparse
+  exit(-1)
+end
+
+prompt = TTY::Prompt.new
+
+Epub::Translator::Prompt::Interlace.new.execute(
+  prompt: prompt,
+  epub_paths: [ARGV[0], ARGV[1]],
+)

data/exe/epub-translator

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "epub/translator"
+require "epub/translator/prompt/translate"
+require 'optparse'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: epub-translator [options] EPUB_FILE"
+
+  opts.on("-c", "--config CONFIG_FILE",
+    "Config file generated after the first time this is run") do |v|
+    options[:config_path] = v
+  end
+end
+
+optparse.parse!
+if ARGV.empty?
+  puts optparse
+  exit(-1)
+end
+
+epub_path = ARGV[0]
+
+prompt = TTY::Prompt.new
+
+Epub::Translator::Prompt::Translate.new.execute(
+  prompt: prompt,
+  epub_path: epub_path,
+  config_path: options[:config_path]
+)

data/lib/epub/translator/prompt/interlace.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'epub/maker'
+require 'oga'
+require 'fileutils'
+require 'rake/ext/string'
+require 'tty-prompt'
+
+module Epub
+  module Translator
+    module Prompt
+      class Interlace
+        attr_reader :epub_paths, :interlace_level, :prompt
+
+        def execute(
+          epub_paths:,
+          prompt: ::TTY::Prompt.new
+        )
+          @epub_paths = epub_paths
+          @prompt = prompt
+
+          epub_paths.each do |path|
+            return unless valid_epub?(path) # rubocop:disable Lint/NonLocalExitFromIterator
+          end
+
+          new_epub_path = prompt.ask(
+            'Where do you want to save the result?',
+            value: epub_paths.last.pathmap("%X.interlaced%x")
+          )
+
+          @interlace_level = prompt.ask(
+            "Please input CSS path of DOM level to interlace:",
+            value: 'body p,h1,h2,h3,h4,h5,h6'
+          )
+
+          FileUtils.copy(epub_paths[0], new_epub_path)
+
+          epub = EPUB::Parser.parse(new_epub_path)
+          epub_other = EPUB::Parser.parse(epub_paths[1])
+
+          epub.each_page_on_spine.select(&:xhtml?).each do |item|
+            next if item.content_document.oga.css(interlace_level).empty?
+
+            item_other = epub_other.manifest[item.id]
+            lang_other = item_other.content_document.oga.lang
+
+            new_dom = item.content_document.oga
+            new_dom.interlace(
+              item_other.content_document.oga,
+              level: interlace_level
+            )
+
+            # Style
+            new_dom.lang = nil
+            style = Oga::XML::Element.new(name: 'style')
+            style.inner_text = "*:lang(#{lang_other}) { color: #999 !IMPORTANT; }"
+            new_dom.at_css('head').node_set.push(style)
+
+            item.content = new_dom.to_xml
+          end
+          epub.save
+
+          puts 'Interlacing complete.'
+        end
+
+        private
+
+        def valid_epub?(path)
+          EPUB::Parser.parse(path)
+          true
+        rescue Errno::ENOENT
+          warn 'Epub not found'
+          false
+        rescue Archive::Zip::UnzipError
+          warn 'Not an Epub'
+          false
+        end
+      end
+    end
+  end
+end

data/lib/epub/translator/prompt/translate.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+require 'rake/ext/string'
+require 'natsukantou/setup/config_load_or_prompt'
+require 'fileutils'
+
+module Epub
+  module Translator
+    module Prompt
+      class Translate
+        attr_reader :prompt
+
+        def execute(epub_path:, config_path: nil, prompt: ::TTY::Prompt.new)
+          begin
+            EPUB::Parser.parse(epub_path)
+          rescue Errno::ENOENT
+            warn 'Epub not found'
+            return
+          rescue Archive::Zip::UnzipError
+            warn 'Not an Epub'
+            return
+          end
+
+          translator = Natsukantou::Setup::ConfigLoadOrPrompt.new.execute(
+            prompt: prompt,
+            config_path: config_path,
+          )
+
+          lang_from = prompt.ask("Language code to translate from?")
+          lang_from = Natsukantou::LanguageCode.new(lang_from)
+          lang_to = prompt.ask("Language code to translate to?")
+          lang_to = Natsukantou::LanguageCode.new(lang_to)
+
+          # Make a copy for modification
+
+          new_epub_path = prompt.ask(
+            'Where do you want to save the result?',
+            value: epub_path.pathmap("%X.#{lang_to.code}%x")
+          )
+          FileUtils.copy(epub_path, new_epub_path)
+
+          book = EPUB::Parser.parse(new_epub_path)
+
+          items = book.each_page_on_spine.select(&:xhtml?)
+          items_untranslated_index = items.map.with_index do |item, index|
+            lang = Natsukantou::LanguageCode.new(item.content_document.oga.lang)
+            lang.is?(lang_to) ? nil : index
+          end.compact
+
+          choices = items.map.with_index do |item, index|
+            translated = !items_untranslated_index.include?(index)
+            [item_label(item, translated), item]
+          end.to_h
+
+          targets = prompt.multi_select(
+            "Select items to translate:",
+            choices,
+            default: items_untranslated_index.map { |index| index + 1 },
+            per_page: 30, echo: false
+          )
+
+          targets.each do |item|
+            output_translation_progress(item)
+
+            env = Natsukantou::Env.new(
+              dom: item.content_document.oga,
+              lang_from: lang_from,
+              lang_to: lang_to
+            )
+            translator.call(env)
+
+            item.content = env[:dom].to_xml
+            item.save
+          end
+
+          if !targets.empty?
+            puts 'Translation complete.'
+          end
+        end
+
+        private
+
+        def output_translation_progress(item)
+          puts item.content_document.title
+        end
+
+        def item_label(item, translated)
+          text = "#{item.content_document.title} (#{item.id})"
+
+          if translated
+            text += " (already in #{item.content_document.oga.lang})"
+          end
+
+          text
+        end
+      end
+    end
+  end
+end

data/lib/epub/translator/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Epub
+  module Translator
+    VERSION = "0.1.0"
+  end
+end

data/lib/epub/translator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'epub/maker'
+require 'natsukantou'
+
+require_relative "translator/version"
+
+module Epub
+  module Translator
+  end
+end

data/sig/epub/translator.rbs

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: epub-translator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lulalala
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: epub-maker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: epub-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !ruby/object:Gem::Dependency
+  name: middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: natsukantou
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- mark@goodlife.tw
+executables:
+- epub-interlace
+- epub-translator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/eg_interlace.png
+- docs/eg_wizard_config.png
+- docs/eg_wizard_translate.png
+- docs/logo.png
+- epub-translator.gemspec
+- exe/epub-interlace
+- exe/epub-translator
+- lib/epub/translator.rb
+- lib/epub/translator/prompt/interlace.rb
+- lib/epub/translator/prompt/translate.rb
+- lib/epub/translator/version.rb
+- sig/epub/translator.rbs
+homepage: http://gitlab.com/lulalala/epub-translator
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://gitlab.com/lulalala/epub-translator
+  source_code_uri: http://gitlab.com/lulalala/epub-translator
+  changelog_uri: http://gitlab.com/lulalala/epub-translator
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Tools to translate EPUB books
+test_files: []