furirubi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8057d4efc4dbd9db38370ab4f60cc65d03b85b1d2c782dfaebf221108e743e98
+  data.tar.gz: f0881590ea5d0cb013c3f6532072cdb1b16e1ce66b2e730f099835763a7a705e
+SHA512:
+  metadata.gz: 6620a8f25ef7945d3e74068ef6b8742f92c18a15f0765c459351680edeae5ef557e877463a15ae271dbbfa81c874594f3c3b972f5a6f1bf20bbe7e338c604fdd
+  data.tar.gz: 53a01214733509b9462fdd3e6507e09650204bfc8ea119e9d5ffc0b86c622a55c231ed487789910baa8dbdf6e828eac358441aa73fa7bd014a8899796d58714c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 2.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lddr99@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in furirubi.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "nokogiri", "~> 1.10"
+gem "uri", "~> 0.10.0"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    furirubi (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.3)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    uri (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  furirubi!
+  nokogiri (~> 1.10)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  uri (~> 0.10.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 DaHung
+
+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,39 @@
+# Furirubi
+Translate kanji to furigana and with the ruby HTML format. Based on https://jisho.org/.
+
+e.g.
+> 世界 経済 フォーラム は => <ruby>世界<rt>せかい</rt></ruby><ruby>経済<rt>けいざい</rt></ruby>フォーラムは
+>
+> Notice: Translation result is inaccurate. It needs to be confirmed again if it's going to be used on business
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'furirubi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install furirubi
+
+## Usage
+```ruby
+Furirubi.parse('世界 経済 フォーラム は')
+
+=> "<ruby>世界<rt>せかい</rt></ruby><ruby>経済<rt>けいざい</rt></ruby>フォーラムは"
+```
+
+# Roadmap
+ - [ ] Testing
+ - [ ] Support other dictionaries
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "furirubi"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/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

data/furirubi.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/furirubi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "furirubi"
+  spec.version       = Furirubi::VERSION
+  spec.authors       = ["DaHung"]
+  spec.email         = ["lddr99@gmail.com"]
+
+  spec.summary       = %q{Translate kanji to furigana and with the ruby HTML format.}
+  spec.homepage      = "https://github.com/lddr99/furirubi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lddr99/furirubi"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/furirubi.rb

@@ -0,0 +1,28 @@
+require 'furirubi/version'
+require 'furirubi/translators/jisho_web_translator'
+require 'furirubi/formators/ruby_html'
+
+module Furirubi
+  def self.translator
+    @translator ||= Furirubi::Translators::JishoWebTranslator.new
+  end
+
+  def self.translator=(trans)
+    @translator = trans
+  end
+
+  def self.formator
+    @formator ||= Formators::RubyHtml.new
+  end
+
+  def self.formator=(format)
+    @formator = format
+  end
+
+  def self.parse(search_term)
+    words = translator.translate(search_term)
+    words[search_term] = '' if words.size.zero?
+
+    formator.format(words)
+  end
+end

data/lib/furirubi/formators/ruby_html.rb

@@ -0,0 +1,11 @@
+module Formators
+  class RubyHtml
+    def format(words)
+      ruby_elements = words.map do |key, value|
+        value.empty? ? key : "<ruby>#{key}<rt>#{value}</rt></ruby>"
+      end
+
+      ruby_elements.join
+    end
+  end
+end

data/lib/furirubi/translators/jisho_web_translator.rb

@@ -0,0 +1,64 @@
+require 'erb'
+require 'open-uri'
+require 'uri'
+require 'nokogiri'
+
+module Furirubi
+  module Translators
+    class JishoWebTranslator
+      URL = 'https://jisho.org/search/'.freeze
+
+      # @tricky: the flag is using to force-change the word to sentence
+      def translate(search_term, flag = 'flag')
+        words = {}
+        uri = URI.join(URL, ERB::Util.url_encode(search_term + flag))
+
+        elements = Nokogiri::HTML.parse(open(uri)).css('.japanese_word')
+        elements.each do |element|
+          result = parse_element(element, flag)
+          words.merge!(result) unless result.nil?
+        end
+
+        words
+      end
+
+      private
+
+      def parse_element(element, flag)
+        # parse furigana
+        if element.search('.japanese_word__furigana').size.positive?
+          furigana_elements = element.search('.japanese_word__furigana')
+          return parse_furigana_elements(furigana_elements)
+        end
+
+        # parse kana or symbol
+        parse_general_text(element, flag)
+      end
+
+      def parse_furigana_elements(elements)
+        words = {}
+
+        elements.each do |el|
+          if el.attr('data-text').empty?
+            words[el.text] = ''
+            next
+          end
+
+          words[el.attr('data-text')] = el.text
+        end
+
+        words
+      end
+
+      def parse_general_text(element, flag)
+        # parse kana
+        text = element.search('.japanese_word__text_wrapper a').text
+
+        # parse symbol
+        text = element.search('.japanese_word__text_wrapper').text if text.empty?
+
+        { text => '' } if text != flag
+      end
+    end
+  end
+end

data/lib/furirubi/version.rb

@@ -0,0 +1,3 @@
+module Furirubi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: furirubi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DaHung
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-23 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- lddr99@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- furirubi.gemspec
+- lib/furirubi.rb
+- lib/furirubi/formators/ruby_html.rb
+- lib/furirubi/translators/jisho_web_translator.rb
+- lib/furirubi/version.rb
+homepage: https://github.com/lddr99/furirubi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lddr99/furirubi
+  source_code_uri: https://github.com/lddr99/furirubi
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Translate kanji to furigana and with the ruby HTML format.
+test_files: []