jmdict 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50e74e443e242733de9d3d9031efeba47e6a7d38
+  data.tar.gz: d683f0678b436503ba017551100ce348c751fc6e
+SHA512:
+  metadata.gz: 22abdee7ee5daee1b77d7b5dee2aa998d64cd3f13f73889598753780cae4273109d15cd28376e5c900867540550aa8900559870bfab6a95e8f89d8c6a71356fd
+  data.tar.gz: 3b1d66c42fc6a1aef0a69124108d5e1a391125c4a2b3e7458f8dc6ebfb451f17ce2c581a61ab6967af66b6a7bbf62273d1eb82a6e9d9c546072f188245588b8d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jmdict.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Ramiro Antonio <ramiro.antonio@outlook.com>
+
+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,74 @@
+# JMDict Gem
+
+This is a simple gem that takes in an XML file containing the [JMDict](http://www.edrdg.org/jmdict/edict_doc.html) Japanese/English dictionary from the Electronic Dictionary Research and Development Group. To avoid dealing with the parsing of this complex file this gem gives the functionality of retrieving each entry in a Ruby Hash more friendly to just focus on the processing step.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jmdict'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jmdict
+
+And use it in your application:
+
+```ruby
+require 'jmdict'
+```
+
+## Dependencies
+
+This gem depends on `nokogiri` for XML parsing.
+
+## Usage
+
+The usage is very simple, just do:
+```ruby
+jmdict = JMDict.new("JMdict.xml")
+jmdict.each_entry do |entry|
+  # Here you can play with the entry
+end
+```
+Example of an entry hash:
+```
+{"ent_seq"=>1000310,
+  "k_ele"=>[{"keb"=>"馬酔木", "ke_inf"=>[], "ke_pri"=>[]}],
+  "r_ele"=>[{"reb"=>"あせび", "re_nokanji"=>"", "re_restr"=>[], "re_inf"=>[], "re_pri"=>[]},
+            {"reb"=>"あしび", "re_nokanji"=>"", "re_restr"=>[], "re_inf"=>[], "re_pri"=>[]},
+            {"reb"=>"あせぼ", "re_nokanji"=>"", "re_restr"=>[], "re_inf"=>[], "re_pri"=>[]},
+            {"reb"=>"あせぶ", "re_nokanji"=>"", "re_restr"=>[], "re_inf"=>[], "re_pri"=>[]},
+            {"reb"=>"アセビ", "re_nokanji"=>"", "re_restr"=>[], "re_inf"=>[], "re_pri"=>[]}],
+  "sense"=>[{"stagk"=>[], "stagr"=>[], "pos"=>["noun (common) (futsuumeishi)"], "xref"=>[], "ant"=>[],
+            "field"=>[], "misc"=>["word usually written using kana alone"], "s_inf"=>[], "l_source"=>[], "dial"=>[], "gloss"=>[{"lang"=>nil, "gloss"=>"Japanese andromeda (Pieris japonica)"},{"lang"=>nil,"gloss"=>"lily-of-the-valley"}]},
+            {"stagk"=>[], "stagr"=>[], "pos"=>[], "xref"=>[], "ant"=>[], "field"=>[], "misc"=>[], "s_inf"=>[], "l_source"=>[], "dial"=>[], "gloss"=>[{"lang"=>"dut", "gloss"=>"{plantk.} Japanse rotsheide"}, {"lang"=>"dut", "gloss"=>"Pieris japonica"}]},
+            {"stagk"=>[], "stagr"=>[], "pos"=>[], "xref"=>[], "ant"=>[], "field"=>[], "misc"=>[], "s_inf"=>[], "l_source"=>[], "dial"=>[], "gloss"=>[{"lang"=>"dut", "gloss"=>"Ashibi {naam van een tanka-tijdschrift, 1903-1908}"}]},
+            {"stagk"=>[], "stagr"=>[], "pos"=>[], "xref"=>[], "ant"=>[], "field"=>[], "misc"=>[], "s_inf"=>[], "l_source"=>[], "dial"=>[], "gloss"=>[{"lang"=>"dut", "gloss"=>"Ashibi {sedert 1928 de naam van het vanaf 1922 gepubliceerde haiku-tijdschrift Hamayumi 破魔弓}"}, {"lang"=>"dut", "gloss"=>"{plantk.} Japanse rotsheide"}, {"lang"=>"dut", "gloss"=>"Pieris japonica"}]},
+            {"stagk"=>[], "stagr"=>[], "pos"=>[], "xref"=>[], "ant"=>[], "field"=>[], "misc"=>[], "s_inf"=>[], "l_source"=>[], "dial"=>[], "gloss"=>[{"lang"=>"ger", "gloss"=>"(f) Lavendelheide"}, {"lang"=>"ger", "gloss"=>"Pieris japonica"}]},
+            {"stagk"=>[], "stagr"=>[], "pos"=>[], "xref"=>[], "ant"=>[], "field"=>[], "misc"=>[], "s_inf"=>[], "l_source"=>[], "dial"=>[], "gloss"=>[{"lang"=>"rus", "gloss"=>"(см.) あせび"}, {"lang"=>"rus", "gloss"=>"(бот.) подбел, Picris japonicum (D. Don.)"}]}]
+}
+```
+Please read the [DTD](view-source:http://www.edrdg.org/jmdict/dtd-jmdict.xml) for more information and to know how to deal with this data. This is only a wrapper.
+
+## Versioning
+
+I decided to put a version number that follows the same pattern as the official DTD revision version for aknowledge the compatibility of this gem with the XML file used.
+
+## Performance
+
+It's important to advice about the memory and time consumption that all this parsing could take. The file itself and the Nokogiri structures takes about ~2 GB of memory with or without this gem. In matter of time we have a notable increase for converting the Node element into a Hash. Using this gem therefore takes more time than dealing with Nokogiri directly but it's aimed for a one shot use for processing the XML file and brings a more unified form of accessing all the fields.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/r-antonio/jmdict.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jmdict"
+
+# 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/jmdict.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jmdict/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jmdict"
+  spec.version       = JMDict::VERSION
+  spec.authors       = ["Ramiro Antonio"]
+  spec.email         = ["ramiro.antonio@outlook.com"]
+
+  spec.summary       = %q{A gem to get parsed entries of the JMDict Japanese dictionary}
+  spec.description   = %q{This gem parses the JMDict XML file to get a more friendly hash interface for its entries}
+  spec.homepage      = "https://github.com/r-antonio/jmdict"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "nokogiri"
+end

data/lib/jmdict.rb

@@ -0,0 +1,100 @@
+require "jmdict/version"
+require 'nokogiri'
+
+class JMDict
+  	@jmdict_file = nil
+
+  	def initialize(filename)
+  		@jmdict_file = File.open(filename) { |f| Nokogiri::XML(f) }
+  	end
+
+  	def each_entry()
+  		@jmdict_file.xpath('JMdict/entry').each do |e|
+  			yield(parse_entry(e))
+  		end
+  	end
+
+  	# Many elements consists of text only subelements
+    def fill_elems(tag, element)
+      aux = []
+      element.css(tag).each do |elem|
+        aux << elem.text
+      end
+      aux
+    end
+
+  	# For the fields info see the DTD Rev 1.09 (http://www.edrdg.org/jmdict/dtd-jmdict.xml)
+  	def parse_entry(entry)
+
+  		this_entry = {}
+
+  		this_entry["ent_seq"] = entry.css("ent_seq").text.to_i
+
+  		this_entry["k_ele"] = []
+
+  		entry.css("k_ele").each do |elem|
+        k_ele = {}
+        k_ele['keb'] = elem.css('keb').text
+        k_ele['ke_inf'] = fill_elems('ke_inf', elem)
+        k_ele['ke_pri'] = fill_elems('ke_pri', elem)
+  			this_entry['k_ele'] << k_ele
+  		end
+
+      this_entry["r_ele"] = []
+
+      entry.css("r_ele").each do |elem|
+        r_ele = {}
+        r_ele['reb'] = elem.css('reb').text
+        r_ele['re_nokanji'] = elem.css('re_nokanji').text
+        r_ele['re_restr'] = fill_elems('re_restr', elem)
+        r_ele['re_inf'] = fill_elems('re_inf', elem)
+        r_ele['re_pri'] = fill_elems('re_pri', elem)
+  			this_entry['r_ele'] << r_ele
+  		end
+
+      this_entry["sense"] = []
+
+      entry.css("sense").each do |s|
+        sense = {}
+        sense['stagk'] = fill_elems('stagk', s)
+        sense['stagr'] = fill_elems('stagr', s)
+        sense['pos'] = fill_elems('pos', s)
+        sense['xref'] = fill_elems('xref', s)
+        sense['ant'] = fill_elems('ant', s)
+        sense['field'] = fill_elems('field', s)
+        sense['misc'] = fill_elems('misc', s)
+        sense['s_inf'] = fill_elems('s_inf', s)
+        sense['l_source'] = []
+        s.css('l_source').each do |ls|
+          l_source = {}
+          l_source['lang'] = ls.lang
+          l_source['ls_type'] = ls.ls_type
+          l_source['ls_wasei'] = ls.ls_wasei
+          l_source['ls_source'] = ls.ls_source.text
+          sense['l_source'] << l_source
+        end
+        sense['dial'] = fill_elems('dial', s)
+        sense['gloss'] = []
+        s.css('gloss').each do |g|
+          gloss = {}
+          gloss['lang'] = g.lang
+
+  				# Give errors if accesed the same way as lang attribute when are not present
+  				gloss['g_gend'] = g['g_gend'] if g.key? 'g_gend'
+  				gloss['g_type'] = g['g_type'] if g.key? 'g_type'
+
+  				# The gloss could have a text PCData or a 'pri' element.
+  				# Currently in rev 1.09 there is no 'pri' with content at all. Just for the sake of DTD.
+  				gloss['pri'] = g.at_css('pri').text unless g.at_css('pri').nil?
+
+          gloss['gloss'] = g.text
+          sense['gloss'] << gloss
+        end
+
+  			this_entry['sense'] << sense
+  		end
+
+      return this_entry
+  	end
+
+  end

data/lib/jmdict/version.rb

@@ -0,0 +1,3 @@
+class JMDict
+  VERSION = "1.9.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: jmdict
+version: !ruby/object:Gem::Version
+  version: 1.9.0
+platform: ruby
+authors:
+- Ramiro Antonio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+description: This gem parses the JMDict XML file to get a more friendly hash interface
+  for its entries
+email:
+- ramiro.antonio@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jmdict.gemspec
+- lib/jmdict.rb
+- lib/jmdict/version.rb
+homepage: https://github.com/r-antonio/jmdict
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to get parsed entries of the JMDict Japanese dictionary
+test_files: []