konjac 0.1.8.1 → 0.1.8.3

data/README.rdoc

@@ -0,0 +1,142 @@
+= konjac
+
+A Ruby command-line utility for translating files using a YAML wordlist
+
+Homepage::      http://www.brymck.com
+Author::        Bryan McKelvey
+Copyright::     (c) 2012 Bryan McKelvey
+License::       MIT
+
+== Installation
+
+=== Stable
+
+With {Ruby}[http://www.ruby-lang.org/en/downloads/] installed, run the
+following in your terminal:
+
+    gem install konjac
+
+=== Development
+
+With Ruby and {Git}[http://help.github.com/set-up-git-redirect] installed,
+navigate in your command line to a directory of your choice, then run:
+
+    git clone git://github.com/brymck/konjac.git
+    cd konjac
+    rake install
+
+== Usage
+
+Translate all text files in the current directory from Japanese into English:
+
+    konjac translate *.txt --from japanese --to english
+    konjac translate *.txt -f ja -t en
+
+Use multiple dictionaries:
+
+    konjac translate financial_report_en.txt --to japanese --using {finance,fluffery}
+    konjac translate financial_report_en.txt -t ja -u {finance,fluffery}
+
+Extract text from a .docx document (creates a plain-text <tt>test.konjac</tt> file from
+<tt>test.docx</tt>):
+
+    konjac export test
+
+Extract text from a .docx document and process with a dictionary
+
+    konjac export test.docx --from japanese --to english --using pre
+    konjac export test.docx -f ja -t en -u pre
+
+Import tags file back into .docx document (file created is named
+<tt>test_imported.docx</tt>):
+
+    konjac import test
+
+Add a word to your dictionary:
+
+    konjac add --original dog --from english --translation 犬 --to japanese
+    konjac add -o dog -f en -r 犬 -t ja
+
+Translate a word using your dictionary:
+
+    konjac translate dog --from english --to japanese --word
+    konjac translate dog -f en -t ja -w
+
+== Dictionary Format
+
+Store terms in <tt>~/.konjac/dict.yml</tt>.
+
+<em>Simple (two-way equivalent terms)</em> - English "I" is equivalent to Spanish
+"yo":
+
+    -
+      en: I
+      es: yo
+
+<em>Not as simple</em> - Japanese lacks a plural, therefore both "dog" and "dogs"
+translate as 犬:
+
+    -
+      en: dog
+      ja:
+        ja: 犬
+        en: dogs?  # i.e. the regular expression /dogs?/
+
+== Extended Example
+
+~/.konjac/dict.yml:
+
+    -
+      en: I
+      ja: 僕
+    -
+      en: like
+      ja: 好き
+    -
+      en:
+        en: dog
+        ja: 犬
+      ja:
+        ja: 犬
+        en: dogs?
+    - # Periods
+      en:
+        en: ". "
+        ja: 。
+      ja:
+        ja: 。
+        en: !ruby/regexp '/\.(?:\s|$)/'
+    - # Spaces between non-ASCII characters
+      en:
+        en: " "
+        ja: !ruby/regexp /\s{2,}/
+      ja:
+        ja: "\\1\\2"
+        en: !ruby/regexp /([^\w])\s([^\w])/
+    - # Delete extraneous spaces
+      en:
+        en: ""
+        ja: !ruby/regexp /\s(?=[.,:]|$)/
+
+~/.konjac/test_en.txt:
+
+    I like dogs.
+
+Run
+
+    konjac translate ~/.konjac/test_en.txt into japanese
+
+~/.konjac/test_ja.txt (result):
+
+    僕好き犬。
+
+Now, obviously that does require some fiddling to make it more grammatical, but
+it's a start (=> <tt>僕は犬が好きだ。</tt>)
+
+== Name
+
+<em>Hon'yaku</em> means "translation" in Japanese. This utility relies on a
+YAML wordlist. <em>Konnyaku</em> (Japanese for "konjac") rhymes with
+<em>hon'yaku</em> and is a type of yam. Also, Doraemon had something called a
+<em>hon'yaku konnyaku</em> that allowed one to listen to animals. But I
+digress.

data/konjac.gemspec

@@ -13,10 +13,11 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "konjac"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths    = ["lib"]
 
   s.add_runtime_dependency "i18n"
   s.add_runtime_dependency "nokogiri"

data/lib/konjac/config.rb

@@ -1,3 +1,4 @@
+require "i18n"
 require "yaml"
 
 module Konjac

data/lib/konjac/version.rb

@@ -1,3 +1,3 @@
 module Konjac
-  VERSION = "0.1.8.1"
+  VERSION = "0.1.8.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konjac
 version: !ruby/object:Gem::Version
-  version: 0.1.8.1
+  version: 0.1.8.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70338893761940 !ruby/object:Gem::Requirement
+  requirement: &70268052029780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338893761940
+  version_requirements: *70268052029780
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70338893777860 !ruby/object:Gem::Requirement
+  requirement: &70268052029360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338893777860
+  version_requirements: *70268052029360
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &70338893777340 !ruby/object:Gem::Requirement
+  requirement: &70268052028920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338893777340
+  version_requirements: *70268052028920
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70338893776780 !ruby/object:Gem::Requirement
+  requirement: &70268052028480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70338893776780
+  version_requirements: *70268052028480
 - !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &70338893776060 !ruby/object:Gem::Requirement
+  requirement: &70268052028040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338893776060
+  version_requirements: *70268052028040
 - !ruby/object:Gem::Dependency
   name: autotest-fsevent
-  requirement: &70338893775240 !ruby/object:Gem::Requirement
+  requirement: &70268052027580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338893775240
+  version_requirements: *70268052027580
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &70338893774820 !ruby/object:Gem::Requirement
+  requirement: &70268052027160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338893774820
+  version_requirements: *70268052027160
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70338893774360 !ruby/object:Gem::Requirement
+  requirement: &70268052026720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338893774360
+  version_requirements: *70268052026720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70338893773740 !ruby/object:Gem::Requirement
+  requirement: &70268052026300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338893773740
+  version_requirements: *70268052026300
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: &70338893773060 !ruby/object:Gem::Requirement
+  requirement: &70268052025880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,21 +120,22 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70338893773060
+  version_requirements: *70268052025880
 description: A Ruby command-line utility for translating files using a YAML wordlist
 email:
 - bryan.mckelvey@gmail.com
 executables:
 - konjac
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
 - .autotest
 - .gitignore
 - .rspec
 - Gemfile
 - LICENSE
-- README.md
+- README.rdoc
 - Rakefile
 - bin/konjac
 - konjac.gemspec

data/README.md

@@ -1,134 +0,0 @@
-konjac
-======
-
-A Ruby command-line utility for translating files using a YAML wordlist
-
-**Homepage**: http://brymck.herokuapp.com  
-**Author**: Bryan McKelvey  
-**Copyright**: (c) 2012 Bryan McKelvey  
-**License**: MIT
-
-Installation
-------------
-
-### Stable
-
-With [Ruby](http://www.ruby-lang.org/en/downloads/) installed, run the
-following in your terminal:
-
-    gem install konjac
-
-### Development
-
-With Ruby and [Git](http://help.github.com/set-up-git-redirect) installed,
-navigate in your command line to a directory of your choice, then run:
-
-    git clone git://github.com/brymck/konjac.git
-    cd konjac
-    rake install
-
-Dictionary Format
------------------
-
-Store terms in `~/.konjac/dict.yml`.
-
-**Simple (two-way equivalent terms)** - English "I" is equivalent to Spanish
-"yo":
-
-    -
-      en: I
-      es: yo
-
-**Not as simple** - Japanese lacks a plural, therefore both "dog" and "dogs"
-translate as 犬:
-
-    -
-      en: dog
-      ja:
-        ja: 犬
-        en: dogs?  # i.e. the regular expression /dogs?/
-
-Usage
------
-
-Translate all text files in the current directory from Japanese into English:
-
-    konjac translate *.txt --from japanese --to english
-
-Utilize a document's implied language (English) and translate into Japanese:
-
-    konjac translate test_en.txt --to japanese
-
-Use multiple dictionaries:
-
-    konjac translate financial_report_en.txt --to japanese --using finance
-
-Extract text from a DOCX document (creates a plain-text `test.konjac` file from
-`test.docx`):
-
-    konjac export test
-
-Import tags file back into DOCX document (file created is named
-`test_imported.docx`):
-
-    konjac import test
-
-Extended Example
-----------------
-
-~/.konjac/dict.yml:
-
-    -
-      en: I
-      ja: 僕
-    -
-      en: like
-      ja: 好き
-    -
-      en:
-        en: dog
-        ja: 犬
-      ja:
-        ja: 犬
-        en: dogs?
-    - # Periods
-      en:
-        en: ". "
-        ja: 。
-      ja:
-        ja: 。
-        en: !ruby/regexp '/\.(?:\s|$)/'
-    - # Spaces between non-ASCII characters
-      en:
-        en: " "
-        ja: !ruby/regexp /\s{2,}/
-      ja:
-        ja: "\\1\\2"
-        en: !ruby/regexp /([^\w])\s([^\w])/
-    - # Delete extraneous spaces
-      en:
-        en: ""
-        ja: !ruby/regexp /\s(?=[.,:]|$)/
-
-~/.konjac/test_en.txt:
-
-    I like dogs.
-
-Run
-
-    konjac translate ~/.konjac/test_en.txt into japanese
-
-~/.konjac/test_ja.txt (result):
-
-    僕好き犬。
-
-Now, obviously that does require some fiddling to make it more grammatical, but
-it's a start (=> `僕は犬が好きだ。`)
-
-Name
-----
-
-*Hon'yaku* means "translation" in Japanese. This utility relies on a YAML
-wordlist. *Konnyaku* (Japanese for "konjac") rhymes with *hon'yaku* and is a
-type of yam. Also, Doraemon had something called a *hon'yaku konnyaku* that
-allowed one to listen to animals. But I digress.