RubyGems - doctor_ninja - Versions diffs - 0.0.1 - Mend

doctor_ninja 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (33) hide show

checksums.yaml +7 -0
data/.gitignore +14 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +62 -0
data/Rakefile +6 -0
data/bin/ninjadoc +29 -0
data/doctor_ninja.gemspec +29 -0
data/lib/doctor_ninja.rb +9 -0
data/lib/doctor_ninja/document.rb +29 -0
data/lib/doctor_ninja/errors.rb +4 -0
data/lib/doctor_ninja/parser.rb +59 -0
data/lib/doctor_ninja/parsers/base.rb +26 -0
data/lib/doctor_ninja/parsers/blip_fill.rb +43 -0
data/lib/doctor_ninja/parsers/drawing.rb +35 -0
data/lib/doctor_ninja/parsers/math.rb +29 -0
data/lib/doctor_ninja/parsers/math_para.rb +13 -0
data/lib/doctor_ninja/parsers/omml2mml.xsl +2068 -0
data/lib/doctor_ninja/parsers/paragraph.rb +38 -0
data/lib/doctor_ninja/parsers/run.rb +24 -0
data/lib/doctor_ninja/parsers/text.rb +12 -0
data/lib/doctor_ninja/relationships.rb +20 -0
data/lib/doctor_ninja/version.rb +3 -0
data/test/document_test.rb +15 -0
data/test/fixtures/img.docx +0 -0
data/test/fixtures/img_crop.docx +0 -0
data/test/fixtures/img_rot.docx +0 -0
data/test/fixtures/img_rot_crop.docx +0 -0
data/test/fixtures/invalid_file.docx +0 -0
data/test/fixtures/limites.docx +0 -0
data/test/integration_test.rb +33 -0
data/test/minitest_helper.rb +3 -0
metadata +186 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec64e692dfb01d06fbd09bb42162997d2b47bfb8
+  data.tar.gz: 1b80f7d87e7f22966c3733587ade0fdeffceafae
+SHA512:
+  metadata.gz: 9eaf28e4b06b699f63c9062e3f53b67c436817383178da6971479a643f57dfa697ea79d442631f35764712038f546d38a1e847f265f75d3a76602a0259b778b4
+  data.tar.gz: 80c0b08e752ad68265d70db184ff38447ffcbfdcfd5d8850003ede10973a31bc961db8e5a573406b4009c6218bcd54a7e5985cd1b446e7fda9bd6f00629ad12d

data/.gitignore ADDED

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in doctor_ninja.gemspec
+gemspec

data/LICENSE.txt ADDED

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bernardo Amorim
+MIT License
+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 ADDED

@@ -0,0 +1,62 @@
+Here be dragons! This is a WIP.
+# DoctorNinja
+DoctorNinja is a library to convert word documents into html files like a ninja.
+## Why DoctorNinja?
+Well, the name is simple, **Doctor** comes from **Doc** (.docx) and **Ninja** comes from our first MVP (Ninja das Dúvidas).
+## Features
+* Convert images and applies the following transformations
+  * Crop
+* Convert Microsoft's Math to MathML
+* Accepts bold, italic and underline
+* Sets text-align to center when there are only non-text children on paragrpahs ( This is for our own usecase, we should probably give an interface to configure it, maybe passing a lambda )
+## TODO
+* Pass styleMap as an option(to choose what tag in paragraph rendering)
+* Add general configurations:
+  1. style map
+  2. image inline(src=data)/as file
+  3. MathML/ansimath/latex
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'doctor_ninja'
+```
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install doctor_ninja
+## Usage
+To use it, you first load the .docx file and then use the to_html to get the html.
+```ruby
+doc = DoctorNinja::Document.new('path_to_file.docx')
+doc.to_html
+```
+Alternativly, you can use our binary, that wraps inside a html boilerplate and adds MathJax to correcly render the MathML
+    $> doctor_ninja document.docx document.html
+## Contributing
+1. Fork it ( https://github.com/bamorim/doctor_ninja/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile ADDED

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+task :default => :test
+task :test do
+    Dir.glob('./test/*_test.rb').each { |file| require file}
+end

data/bin/ninjadoc ADDED

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+MATHJAX = <<-HTML
+<script type="text/javascript"
+  src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+  </script>
+HTML
+PREFIX = <<-HTML
+<!doctype HTML>
+<html>
+  <head>
+    <meta charset="utf-8"/>
+    #{MATHJAX}
+  </head>
+  <body>
+HTML
+SUFFIX = <<-HTML
+  </body>
+</html>
+HTML
+require 'doctor_ninja'
+doc = DoctorNinja::Document.new(ARGV[0])
+file = ARGV[1] ? File.open(ARGV[1],"w+") : STDOUT
+file.write("#{PREFIX}#{doc.to_html}#{SUFFIX}")
+file.close
+doc.close

data/doctor_ninja.gemspec ADDED

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doctor_ninja/version'
+Gem::Specification.new do |spec|
+  spec.name          = "doctor_ninja"
+  spec.version       = DoctorNinja::VERSION
+  spec.authors       = ["Bernardo Amorim"]
+  spec.email         = ["contato@bamorim.com"]
+  spec.summary       = %q{DoctorNinja is a library to convert word documents into html files like a ninja.}
+  spec.description   = %q{DoctorNinja is built by the Responde Aí Team (www.respondeai.com.br/time) in an attempt to fill our needs to convert docx files into html that also converts Word Forumlas into MathML.}
+  spec.homepage      = "https://github.com/bamorim/doctor_ninja"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_dependency "rubyzip", "~> 1.1"
+  spec.add_dependency "rmagick", "~> 2.13"
+end

data/lib/doctor_ninja.rb ADDED

@@ -0,0 +1,9 @@
+require "doctor_ninja/version"
+require "doctor_ninja/document"
+require "doctor_ninja/parser"
+module DoctorNinja
+  RESOLUTION = 96
+  EMU_PER_INCH = 914400
+  EMU_PER_PIXEL = EMU_PER_INCH/RESOLUTION
+end

data/lib/doctor_ninja/document.rb ADDED

@@ -0,0 +1,29 @@
+require "zip"
+require "doctor_ninja/parser"
+require "doctor_ninja/relationships"
+module DoctorNinja
+  class Document
+    def initialize file
+      @file = Zip::File.new(file)
+    rescue Zip::Error
+      raise InvalidDocumentError.new
+    end
+    def relationships
+      @relationships ||= DoctorNinja::Relationships.new(self)
+    end
+    def read file
+      @file.read(file)
+    end
+    def to_html
+      DoctorNinja::Parser.new(self).parse
+    end
+    def close
+      @file.close
+    end
+  end
+end

data/lib/doctor_ninja/errors.rb ADDED

@@ -0,0 +1,4 @@
+module DoctorNinja
+  class Error < StandardError; end
+  class InvalidDocumentError < Error; end
+end

data/lib/doctor_ninja/parser.rb ADDED

@@ -0,0 +1,59 @@
+require 'nokogiri'
+Dir[File.dirname(__FILE__) + '/parsers/*.rb'].each {|file| require file }
+module DoctorNinja
+  class Parser
+    class Noop < DoctorNinja::Parsers::Base
+      def self.applicable_to?(node)
+        return true
+      end
+    end
+    def initialize(doc)
+      @docx = doc
+      @xmldoc = Nokogiri::XML @docx.read "word/document.xml"
+    end
+    def parse
+      self.parse_node(@xmldoc.root, {})
+    end
+    def parse_node(node,context)
+      parsers = parsers_for(node,context)
+      if debug?(node,parsers)
+        debug(node,binding)
+      end
+      parsers
+        .first
+        .parse
+    end
+    def parsers_for(node,context)
+      parsers
+        .select{|p| p.applicable_to? node}
+        .map{|p| p.new(node, self.public_method(:parse_node), @docx, context)}
+    end
+    def parsers
+      DoctorNinja::Parsers.constants.map{|c| DoctorNinja::Parsers.const_get(c)}+[Noop]
+    end
+    def debug?(node,parsers)
+      ENV["DEBUG"] == "all" ||
+      (ENV["DEBUG"] == "missing" && parsers.length == 1) ||
+      ENV["DEBUG"] == node.name ||
+      (node.namespace && ENV["DEBUG"] == "#{node.namespace.prefix}:#{node.name}")
+    end
+    def debug(node,b)
+      if(ENV["DEBUG_MODE"]=="pry")
+        require "pry"
+        b.pry
+      else
+        puts "---BEGIN---\n#{node.to_xml}\n----END----"
+      end
+    end
+  end
+end

data/lib/doctor_ninja/parsers/base.rb ADDED

@@ -0,0 +1,26 @@
+module DoctorNinja
+  module Parsers
+    class Base
+      def self.applicable_to?(node)
+        false
+      end
+      def initialize(node, yielder, document, context)
+        @node = node
+        @yielder = yielder
+        @document = document
+        @context = context
+      end
+      def parse
+        parse_children
+      end
+      def parse_children(context=@context)
+        @node.children.inject("") do |str,child|
+          str << @yielder.call(child,context).to_s
+        end
+      end
+    end
+  end
+end

data/lib/doctor_ninja/parsers/blip_fill.rb ADDED

@@ -0,0 +1,43 @@
+require_relative "./base"
+class DoctorNinja::Parsers::BlipFill < DoctorNinja::Parsers::Base
+  def self.applicable_to?(node)
+    node.name == "blipFill"
+  end
+  def parse
+    @image = Magick::Image.from_blob(@document.relationships[rel_id]).first
+    transform
+    @context.background_image = @image
+  end
+private
+  def rel_id
+    @node.xpath("./a:blip", "a" => xmlns_a).attribute("embed").value
+  end
+  def transform
+    return unless src_rect
+    h = {
+      "l" => src_rect["l"].to_i*@image.columns/100000,
+      "t" => src_rect["t"].to_i*@image.rows/100000,
+      "r" => src_rect["r"].to_i*@image.columns/100000,
+      "b" => src_rect["b"].to_i*@image.rows/100000
+    }
+    @image = @image.crop(
+      h["l"],
+      h["t"],
+      @image.columns - h["l"]-h["r"] ,
+      @image.rows-h["b"]-h["t"]
+    )
+  end
+  def src_rect
+    @node.xpath("./a:srcRect","a" => xmlns_a)[0]
+  end
+  def xmlns_a
+    @node.namespaces["xmlns:a"]
+  end
+end

data/lib/doctor_ninja/parsers/drawing.rb ADDED

@@ -0,0 +1,35 @@
+require "rvg/rvg"
+require "base64"
+class DoctorNinja::Parsers::Drawing < DoctorNinja::Parsers::Base
+  include Magick
+  def self.applicable_to?(node)
+    node.name == "drawing"
+  end
+  def parse
+    width = extent[:x]/DoctorNinja::EMU_PER_PIXEL
+    height = extent[:y]/DoctorNinja::EMU_PER_PIXEL
+    rvg = RVG.new(width,height).viewbox(0,0,width,height) do |canvas|
+      parse_children(canvas)
+    end
+    format = "png"
+    base64 = Base64.encode64 rvg.draw.to_blob { self.format = format }
+    "<img src=\"data:image/#{format};base64,#{base64}\"/>"
+  end
+  def extent
+    @extent ||= {
+      x: extent_node.attribute("cx").value.to_i,
+      y: extent_node.attribute("cy").value.to_i
+    }
+  end
+  def extent_node
+    @node.xpath(".//wp:extent")
+  end
+end

data/lib/doctor_ninja/parsers/math.rb ADDED

@@ -0,0 +1,29 @@
+require_relative "./base"
+class DoctorNinja::Parsers::Math < DoctorNinja::Parsers::Base
+  @@xsl = File.join(File.dirname(__FILE__),"omml2mml.xsl")
+  def self.applicable_to?(node)
+    node.name == "oMath"
+  end
+  # Uses saxon to convert by now
+  def parse
+    doc = Nokogiri::XML(mml)
+    doc.remove_namespaces!
+    doc.root.set_attribute "xmlns", "http://www.w3.org/1998/Math/MathML"
+    doc.root.set_attribute "display", "block" if @context[:is_math_para]
+    doc.root.to_xml
+  end
+  def mml
+    doc = Nokogiri::XML("<root>#{@node.to_xml(encoding: "utf-8")}</root>")
+    @node.namespaces.each do |k,v|
+      doc.root.add_namespace k.split(":")[1], v
+    end
+    xslt = Nokogiri::XSLT(File.read(@@xsl))
+    xslt.transform(Nokogiri::XML(doc.to_xml)).to_xml
+  end
+end

data/lib/doctor_ninja/parsers/math_para.rb ADDED

@@ -0,0 +1,13 @@
+require_relative "./base"
+class DoctorNinja::Parsers::MathPara < DoctorNinja::Parsers::Base
+  def self.applicable_to?(node)
+    node.name == "oMathPara"
+  end
+  def parse
+    @context = @context.dup
+    @context[:is_math_para] = true
+    parse_children
+  end
+end