konjac 0.1.1 → 0.1.2

data/README.md

@@ -63,6 +63,14 @@ Use multiple dictionaries:
 
     konjac translate financial_report_en.txt into japanese using finance
 
+Extract text from a DOCX document (creates a plain-text `test.tags` file):
+
+    konjac extract test.docx
+
+Import tags file back into DOCX document:
+
+    konjac import test.docx
+
 Extended Example
 ----------------
 

data/lib/konjac/tag.rb

@@ -0,0 +1,17 @@
+module Konjac
+  class Tag
+    attr_accessor :index, :original, :translated
+
+    def initialize(index, original, translated)
+      @index, @original, @translated = index, original, translated
+    end
+
+    def to_s
+      "[[KJ-#{index}]]\n> #{original}#{"\n" + translated if translated?}"
+    end
+
+    def translated?
+      !!translated
+    end
+  end
+end

data/lib/konjac/tag_manager.rb

@@ -0,0 +1,50 @@
+module Konjac
+  class TagManager
+    attr_accessor :tags
+
+    STARTS_WITH_CLOSE_TAG = /^\>/
+    KONJAC_TAG = /^\[\[KJ\-(\d+)\]\]/
+
+    def initialize(path)
+      @tags = []
+      parse_lines File.readlines(path)
+    end
+
+    def parse_lines(lines)
+      index      = nil
+      orig       = nil
+      trans      = nil
+
+      lines.each do |line|
+        if line =~ KONJAC_TAG
+          # Handle instances where there is no translation
+          unless orig.nil?
+            @tags << Tag.new(index, orig, trans)
+            index = nil
+            orig  = nil
+          end
+
+          index = line.match(KONJAC_TAG)[1].to_i
+        elsif line =~ STARTS_WITH_CLOSE_TAG
+          orig = line[2..-1].chomp
+        else
+          trans = line.chomp
+          unless index.nil?
+            @tags << Tag.new(index, orig, trans)
+            index = nil
+            orig  = nil
+            trans = nil
+          end
+        end
+      end
+    end
+
+    def all
+      @tags
+    end
+
+    def [](index)
+      @tags[index]
+    end
+  end
+end

data/lib/konjac/version.rb

@@ -1,3 +1,3 @@
 module Konjac
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/konjac/word.rb

@@ -1,3 +1,5 @@
+# This really needs cleanup
+
 module Konjac
   module Word
     class << self
@@ -11,20 +13,25 @@ module Konjac
             basename  = File.basename(sub_file, ".*")
             new_path  = "#{dirname}/#{basename}_imported.docx"
             xml_path  = "#{dirname}/#{basename}.xml"
-            tags_path = "#{dirname}/#{basename}.tags"
+            tags_path = "#{dirname}/#{basename}.konjac"
             out_path  = "#{dirname}/word/document.xml"
 
             # Open the original XML file and the updated tags
             writer = Nokogiri::XML(File.read(xml_path))
-            tags   = File.readlines(tags_path)
+            nodes  = writer.xpath("//w:t")
+            tags   = TagManager.new(tags_path)
 
             # Overwrite each <w:t> tag's content with the new tag
-            writer.xpath("//w:t").each do |node|
-              node.content = tags.shift.tr("\n", "")
+            tags.all.each do |tag|
+              if tag.translated?
+                nodes[tag.index].content = tag.translated
+              end
             end
 
             # Create a directory for word/document.xml if necessary
-            FileUtils.mkdir "#{dirname}/word" unless File.directory?("#{dirname}/word")
+            unless File.directory?("#{dirname}/word")
+              FileUtils.mkdir "#{dirname}/word"
+            end
 
             # Write the modified XML to a file
             File.open(out_path, "w") do |file|
@@ -50,7 +57,7 @@ module Konjac
             basename   = File.basename(sub_file, ".*")
             xml_path   = "#{dirname}/#{basename}_orig.xml"
             clean_path = "#{dirname}/#{basename}.xml"
-            tags_path  = "#{dirname}/#{basename}.tags"
+            tags_path  = "#{dirname}/#{basename}.konjac"
 
             # Unzip the DOCX's word/document.xml file and pipe the output into
             # an XML with the same base name as the DOCX
@@ -79,11 +86,16 @@ module Konjac
                 prev = node
               end
 
+              # Write the tags file
+              index = 0
               cleaner.xpath("//w:t").each do |node|
-                tags_file.puts node.content
+                tags_file.puts "[[KJ-%i]]%s" % [index, additional_info(node)]
+                tags_file.puts "> %s" % node.content
+                index += 1
               end
             end
 
+            # Write the cleaned-up XML to a file for inspection
             File.open(clean_path, "w") do |xml|
               xml.puts cleaner.to_xml
             end
@@ -148,6 +160,18 @@ module Konjac
         hash.delete :t
         hash[:rPr][:rFonts][:attributes].delete :hint
       end
+
+      # Get additional information on the node for context in tags file
+      def additional_info(node)
+        info = []
+        info << "hyperlink" if node.parent.parent.name == "hyperlink"
+
+        if info.empty?
+          ""
+        else
+          "  #=> #{info.join(", ")}"
+        end
+      end
     end
   end
 end

data/lib/konjac.rb

@@ -8,6 +8,8 @@ module Konjac
   autoload :CLI,        "konjac/cli"
   autoload :Dictionary, "konjac/dictionary"
   autoload :Language,   "konjac/language"
+  autoload :Tag,        "konjac/tag"
+  autoload :TagManager, "konjac/tag_manager"
   autoload :Translator, "konjac/translator"
   autoload :Utils,      "konjac/utils"
   autoload :Word,       "konjac/word"

data/spec/tag_spec.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+require File.dirname(__FILE__) + "/spec_helper"
+require "tempfile"
+
+describe Tag do
+  before :each do
+    @tags_file = Tempfile.new(["tags", ".tags"])
+    @tags_file.write <<-eos.gsub(/^\s+/, "")
+                       [[KJ-1]]
+                       > 犬
+                       dog
+                       [[KJ-2]]
+                       > 何ですか。
+                       What is it?
+                       [[KJ-3]]
+                       > 空白
+                       [[KJ-6]]
+                       > 以上
+                       -- end --
+                     eos
+    @tags_file.rewind
+    @manager = TagManager.new(@tags_file.path)
+  end
+
+  it "should accurately read a tag file" do
+    @manager.all.should_not == nil
+    @manager[0].index.should == 1
+    @manager[0].original.should == "犬"
+    @manager[0].translated.should == "dog"
+  end
+
+  it "should succeed reading multiple lines" do
+    @manager[1].index.should == 2
+    @manager[1].original.should == "何ですか。"
+    @manager[1].translated.should == "What is it?"
+  end
+
+  it "should ignore blank translations" do
+    @manager[2].index.should == 3
+    @manager[2].original.should == "空白"
+    @manager[2].translated.should == nil
+  end
+
+  it "should skip over blank indexes" do
+    @manager[3].index.should == 6
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konjac
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-12 00:00:00.000000000 Z
+date: 2012-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70314541350300 !ruby/object:Gem::Requirement
+  requirement: &70334829927100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314541350300
+  version_requirements: *70334829927100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70314541347900 !ruby/object:Gem::Requirement
+  requirement: &70334829926260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314541347900
+  version_requirements: *70334829926260
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70314541345520 !ruby/object:Gem::Requirement
+  requirement: &70334829925520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314541345520
+  version_requirements: *70334829925520
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: &70314541340780 !ruby/object:Gem::Requirement
+  requirement: &70334829925000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314541340780
+  version_requirements: *70334829925000
 - !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &70314541332480 !ruby/object:Gem::Requirement
+  requirement: &70334829924120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314541332480
+  version_requirements: *70334829924120
 - !ruby/object:Gem::Dependency
   name: autotest-fsevent
-  requirement: &70314541323420 !ruby/object:Gem::Requirement
+  requirement: &70334829908620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314541323420
+  version_requirements: *70334829908620
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &70314541318360 !ruby/object:Gem::Requirement
+  requirement: &70334829907660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314541318360
+  version_requirements: *70334829907660
 description: A Ruby command-line utility for translating files using a YAML wordlist
 email:
 - bryan.mckelvey@gmail.com
@@ -110,6 +110,8 @@ files:
 - lib/konjac/dictionary.rb
 - lib/konjac/exception.rb
 - lib/konjac/language.rb
+- lib/konjac/tag.rb
+- lib/konjac/tag_manager.rb
 - lib/konjac/translator.rb
 - lib/konjac/utils.rb
 - lib/konjac/version.rb
@@ -118,6 +120,7 @@ files:
 - spec/dictionary_spec.rb
 - spec/language_spec.rb
 - spec/spec_helper.rb
+- spec/tag_spec.rb
 - spec/utils_spec.rb
 homepage: http://brymck.herokuapp.com/
 licenses: []
@@ -148,4 +151,5 @@ test_files:
 - spec/dictionary_spec.rb
 - spec/language_spec.rb
 - spec/spec_helper.rb
+- spec/tag_spec.rb
 - spec/utils_spec.rb