doc2text 0.3.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e795071f6df878e0427e2728848d170ecb1277d0
-  data.tar.gz: 4c02f808c1d6c47bf7edf8f1d81fc534bdf2ab93
+SHA256:
+  metadata.gz: e803f834de30ec59e70080fa881b47e4647e467f1d443cca097aaa726d80d48a
+  data.tar.gz: 5ff4569486e0a8f59a089918abd5f3025e46bf3970b7e7c5d50e6d2bd38e9718
 SHA512:
-  metadata.gz: d7a9314e425c425dc228e4f742874f3393ec77ab604e22ead973cb1430e5a01bd7395a5e8f6b6f2c71114aaad2736b5d43abcad30bb797a17a0ce842f6474ecd
-  data.tar.gz: c82f62f3fabd0ccdf42ec6fb23d06cb3f6884676184e6a44e670e4a9f803b7fa2bc71ebd107ff067315e1ac52214c79c0477d9fd0a0388a0010f5c70fd915678
+  metadata.gz: 29766bf3c446cd231277da1d8f41f6d3e2c8c8b46e01f58acefe9b62f123646de7757680cd94687637ef06a439bb69a8066a623fc25235a97e70970d311886dd
+  data.tar.gz: 585d4d505d4ffa9c9885e813debe512edefda10943fdf1693388838c858830e0a4802f12716fbc956ac8b8de4c0899892d9b35a9a8fe32e1e3707ff3c8fd7e00

data/bin/doc2text

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'doc2text'
+require 'optparse'
+
+options = {}
+opt_parse = OptionParser.new do |opts|
+  opts.banner = "Usage: doc2text document.odt output.md
+  or:  doc2text [OPTION]... -s input[.odt] -o output[.md]\n\n"
+
+  opts.on('-s FILE', '--source FILE', 'Odt FILE document to be processed') do |file|
+    options[:source] = file
+  end
+
+  opts.on('-o FILE', '--output FILE', 'Output to markdown document FILE') do |file|
+    options[:output] = file
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  opt_parse.parse!
+  if options.empty?
+    if ARGV.size == 2
+      options[:source], options[:output] = *ARGV
+    else
+      puts opt_parse
+      exit
+    end
+  end
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts $!.to_s
+  puts opt_parse
+  exit
+end
+
+
+Doc2Text::Resolution.parse_and_save options[:source], options[:output]

data/lib/doc2text.rb

@@ -2,10 +2,21 @@ require 'nokogiri'
 #require 'nokogiri/xml'
 require 'fileutils'
 
-require 'doc2text/odt'
-require 'doc2text/odt_xml_node'
-require 'doc2text/odt_xml_namespaces'
-require 'doc2text/markdown_odt_parser'
+require 'doc2text/xml_based_document_file'
+require 'doc2text/generic_xml_nodes'
+require 'doc2text/resolution'
 require 'doc2text/errors'
 
-require 'doc2text/content'
+require 'doc2text/odt/odt'
+require 'doc2text/odt/odt_xml_namespaces'
+require 'doc2text/odt/markdown_odt_parser'
+
+require 'doc2text/docx/docx'
+require 'doc2text/docx/markdown_docx_parser'
+require 'doc2text/docx/docx_xml_namespaces'
+
+require 'doc2text/pptx/pptx'
+require 'doc2text/pptx/markdown_pptx_parser'
+require 'doc2text/pptx/pptx_xml_namespaces'
+
+require 'doc2text/styles_parser'

data/lib/doc2text/docx/docx.rb

@@ -0,0 +1,31 @@
+module Doc2Text
+  module Docx
+    class Document < XmlBasedDocument::DocumentFile
+
+      def self.parse_and_save(input, output_filename)
+        docx = new input
+        begin
+          docx.unpack
+          styles_xml_root = docx.parse_styles
+          output = File.open output_filename, 'w'
+          markdown = Markdown::DocxParser.new output, styles_xml_root
+          begin
+            docx.parse markdown
+          ensure
+            markdown.close
+          end
+        ensure
+          docx.clean
+        end
+      end
+
+      def contains_extracted_files?
+        File.exist? File.join(extract_path, '[Content_Types].xml')
+      end
+
+      def extract_extension
+        'unpacked_docx'
+      end
+    end
+  end
+end

data/lib/doc2text/docx/docx_xml_namespaces.rb

@@ -0,0 +1,55 @@
+module Doc2Text
+  module Docx
+    module XmlNodes
+      class Node < XmlBasedDocument::XmlNodes::Node
+        def self.create_node(prefix, name, parent = nil, attrs = [], markdown_odt_parser = nil)
+          begin
+            clazz = XmlNodes.const_get "#{prefix.capitalize}::W#{name}"
+          rescue NameError => e
+            # markdown_odt_parser.logger.warn "No such <#{prefix}:#{name}> found"
+            Generic.new(parent, attrs, prefix, name, markdown_odt_parser)
+          else
+            clazz.new(parent, attrs, prefix, name, markdown_odt_parser)
+          end
+        end
+
+        def body?
+          false
+        end
+      end
+
+      class PlainText < XmlBasedDocument::XmlNodes::PlainText
+        def body?
+          false
+        end
+      end
+
+      class Generic < Node
+      end
+
+      module W
+        class Wbody < Node
+          def body?
+            true
+          end
+        end
+
+        class Wbr < Node
+          def open
+            '<br/>'
+          end
+        end
+
+        class Wp < Node
+          def open
+            "\n"
+          end
+
+          def close
+            "\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/doc2text/docx/markdown_docx_parser.rb

@@ -0,0 +1,81 @@
+require 'logger'
+
+module Doc2Text
+  module Markdown
+    class DocxParser < Nokogiri::XML::SAX::Document
+      def initialize(output, styles_xml_root = nil)
+        @styles_xml_root = styles_xml_root
+        @output = output
+        @automatic_styles = {}
+      end
+
+      def start_element_namespace(name ,attrs = [], prefix = nil, uri = nil, ns = [])
+        unless @xml_root
+          @xml_root = @current_node = Docx::XmlNodes::Node.create_node prefix, name, nil, attrs, self
+        else
+          new_node = Docx::XmlNodes::Node.create_node prefix, name, @current_node, attrs, self
+          @current_node.children << new_node
+          @current_node = new_node
+        end
+      end
+
+      def end_element_namespace(name, prefix = nil, uri = nil)
+        if @current_node.parent and @current_node.parent.body?
+          @output << @current_node.expand
+          @current_node.delete
+        end
+        @current_node = @current_node.parent
+      end
+
+      def characters(string)
+        unless string.strip.empty?
+          plain_text = Docx::XmlNodes::PlainText.new(string)
+          @current_node.children << plain_text
+        end
+      end
+
+      def close
+        @output.close
+      end
+
+      def print_tree(node)
+        puts node
+        node.children.each do |child|
+          print_tree child
+        end
+      end
+
+      # Select nodes xpath style
+      # - supports selecting from the root node
+      def xpath(string)
+        patterns = string.split '|'
+        raise Doc2Text::XmlError, 'it does not support this xpath syntax' if patterns.length == 0
+        result = []
+        patterns.each do |pattern|
+          if /^(\/[\w:\-]+)+$/ =~ pattern
+            path = pattern.scan /[\w:\-]+/
+            result += xpath_search_nodes(path, @xml_root)
+            result += xpath_search_nodes(path, @styles_xml_root) if @styles_xml_root
+          else
+            raise Doc2Text::XmlError, 'it does not support this xpath syntax'
+          end
+        end
+        result
+      end
+
+      def xpath_search_nodes(path, xml_root)
+        seek_nodes = [xml_root]
+        path.each_with_index do |xml_name, index|
+          seek_nodes.select! { |node| node.xml_name == xml_name }
+          seek_nodes = seek_nodes.map(&:children).flatten unless index == path.length - 1
+          break if seek_nodes.empty?
+        end
+        seek_nodes
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/doc2text/generic_xml_nodes.rb

@@ -0,0 +1,78 @@
+module Doc2Text
+  module XmlBasedDocument
+    module XmlNodes
+      class Node
+        attr_reader :parent, :children, :attrs, :prefix, :name
+        attr_accessor :text
+
+        def self.inherited(subclass)
+          def subclass.titleize(tag)
+            tag.split('-').map(&:capitalize).join
+          end
+        end
+
+        def initialize(parent = nil, attrs = [], prefix = nil, name = nil, markdown_odt_parser = nil)
+          @parent, @attrs, @prefix, @name, @xml_parser = parent, attrs, prefix, name, markdown_odt_parser
+          @children = []
+          @has_text = false
+        end
+
+        def root?
+          !@parent
+        end
+
+        def has_text?
+          @has_text
+        end
+
+        def open
+          ''
+        end
+
+        def close
+          ''
+        end
+
+        def delete
+          return true unless @children
+          @children.each { |child| child.delete }
+          @children = []
+        end
+
+        def eql?(object)
+          return false unless object.is_a? Node
+          object.xml_name == xml_name
+        end
+
+        def generic?
+          instance_of? Node
+        end
+
+        def xml_name
+          "#{@prefix}:#{@name}"
+        end
+
+        def to_s
+          "#{xml_name} : #{attrs}"
+        end
+
+        def expand
+          expanded = "#{open}#{@children.map(&:expand).join}#{close}"
+          delete
+          expanded.clone
+        end
+      end
+
+      class PlainText < Node
+
+        attr_accessor :text
+
+        alias_method :expand, :text
+
+        def initialize(text)
+          @text = text
+        end
+      end
+    end
+  end
+end

data/lib/doc2text/odt/markdown_odt_parser.rb

@@ -0,0 +1,81 @@
+require 'logger'
+
+module Doc2Text
+  module Markdown
+    class OdtParser < Nokogiri::XML::SAX::Document
+      def initialize(output, styles_xml_root = nil)
+        @styles_xml_root = styles_xml_root
+        @output = output
+        @automatic_styles = {}
+      end
+
+      def start_element_namespace(name ,attrs = [], prefix = nil, uri = nil, ns = [])
+        unless @xml_root
+          @xml_root = @current_node = Odt::XmlNodes::Node.create_node prefix, name, nil, attrs, self
+        else
+          new_node = Odt::XmlNodes::Node.create_node prefix, name, @current_node, attrs, self
+          @current_node.children << new_node
+          @current_node = new_node
+        end
+      end
+
+      def end_element_namespace(name, prefix = nil, uri = nil)
+        if @current_node.parent and @current_node.parent.office_text?
+          @output.write @current_node.expand
+          @current_node.delete
+        end
+        @current_node = @current_node.parent
+      end
+
+      def characters(string)
+        unless string.strip.empty?
+          plain_text = Odt::XmlNodes::PlainText.new(string)
+          @current_node.children << plain_text
+        end
+      end
+
+      def close
+        @output.close
+      end
+
+      def print_tree(node)
+        puts node
+        node.children.each do |child|
+          print_tree child
+        end
+      end
+
+      # Select nodes xpath style
+      # - supports selecting from the root node
+      def xpath(string)
+        patterns = string.split '|'
+        raise Doc2Text::XmlError, 'it does not support this xpath syntax' if patterns.length == 0
+        result = []
+        patterns.each do |pattern|
+          if /^(\/[\w:\-]+)+$/ =~ pattern
+            path = pattern.scan /[\w:\-]+/
+            result += xpath_search_nodes(path, @xml_root)
+            result += xpath_search_nodes(path, @styles_xml_root) if @styles_xml_root
+          else
+            raise Doc2Text::XmlError, 'it does not support this xpath syntax'
+          end
+        end
+        result
+      end
+
+      def xpath_search_nodes(path, xml_root)
+        seek_nodes = [xml_root]
+        path.each_with_index do |xml_name, index|
+          seek_nodes.select! { |node| node.xml_name == xml_name }
+          seek_nodes = seek_nodes.map(&:children).flatten unless index == path.length - 1
+          break if seek_nodes.empty?
+        end
+        seek_nodes
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/doc2text/odt/odt.rb

@@ -0,0 +1,43 @@
+module Doc2Text
+  module Odt
+    class Document < XmlBasedDocument::DocumentFile
+
+      def extract_extension
+        'unpacked_odt'
+      end
+
+      def self.parse_and_save(input, output_filename)
+        odt = new input
+        begin
+          odt.unpack
+          styles_xml_root = odt.parse_styles
+          output = File.open output_filename, 'w'
+          markdown = Markdown::OdtParser.new output, styles_xml_root
+          begin
+            odt.parse markdown
+          ensure
+            markdown.close
+          end
+        ensure
+          odt.clean
+        end
+      end
+
+      def parse_styles
+        styles_parser = Doc2Text::Odt::StylesParser.new
+        xml = Nokogiri::XML::SAX::Parser.new(styles_parser)
+        xml.parse open 'styles.xml'
+        styles_parser.xml_root
+      end
+
+      def parse(markdown)
+        parser = Nokogiri::XML::SAX::Parser.new(markdown) # { |config| config.strict}
+        parser.parse open 'content.xml'
+      end
+
+      def contains_extracted_files?
+        [File.join(extract_path, 'content.xml'), File.join(extract_path, 'mimetype')].all? { |file| File.exist?(file) }
+      end
+    end
+  end
+end