parchment 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d6c2118023a45879f6d70a6a9504da8af5e2942
-  data.tar.gz: a2a64bf4e2d264dd56f003a066fa027df6b0c911
+  metadata.gz: 2b2b933353bca6915788888bf392d8c8515a3145
+  data.tar.gz: 1dc52ba73b73dd83a4fa7f7ada3ce7271b702a5a
 SHA512:
-  metadata.gz: 92165f1b6633f8ae88545b415b5c53dddb532d0a9f9f84860dbc1e64cc381d84c2ac520da87e10a6a09d6e361dbb0b38c052f60ab6f7a3f1b2ae31590ffb79b5
-  data.tar.gz: d8d175ba3eff1d82cb5bf45680bfd498e1d7b362fb021074fae9b166f904bec55d91430e31cbbbdf8b2064ab0d7e27e0537f2e535adee0659cf5c4881735920b
+  metadata.gz: 20503c349ede5f921df455d05e6367ac3ddfb205a9040054c550fce08de193298ed094ecf49fcd412fa17b9c8aedb6f429d4466ecab660d1bbd267b651f8bef3
+  data.tar.gz: e19cff1bbdebce5d854c5bed607ddb610eaf19227a09865b3f3512910d5159c1a9b590446a48f79bcf36620c0907218795e1aab67395835f40302d0a50f7bdf7

data/README.md

@@ -4,6 +4,21 @@ Parchment is a simple, flexible library for interacting with word processing
 document files. Initially intended for outputting .docx and .odt files as
 HTML fragments, it is built to be flexible for future use.
 
+## Why?
+
+You may ask, is there really a need for another document parsing library?
+Apparently so.
+
+I had a seemingly simple task I wanted to do: Take a Microsoft Word or Open
+Office Writer file and display it as an HTML fragment within a larger page,
+with as much formatting as necessary. I couldn't find a decent solution for
+this, especially from within a Rails app. Most other libraries are focused
+on converting whole documents, such as a Word file into a complete
+fully-compliant HTML page.
+
+I wanted the simplicity of what is seen under usage below, without
+patching together several different command-line tools. That's Parchment.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/parchment.rb

@@ -1,6 +1,7 @@
 require 'parchment/document'
 require 'parchment/formats/odt/odt'
 require 'parchment/formats/docx/docx'
+require 'parchment/formats/txt/txt'
 
 module Parchment
 
@@ -14,6 +15,8 @@ module Parchment
       Parchment::ODT.read(path)
     when 'docx'
       Parchment::DOCX.read(path)
+    when 'txt'
+      Parchment::TXT.read(path)
     else
       raise UnsupportedFileFormatError, 'File format is not supported.'
     end

data/lib/parchment/document.rb

@@ -52,7 +52,7 @@ module Parchment
     # Output entire document as a HTML fragment String.
     #
     def to_html
-      paragraphs.map(&:to_html).join('\n')
+      paragraphs.map(&:to_html).join("\n")
     end
 
     private
@@ -74,4 +74,4 @@ module Parchment
         raise MissingFormatterMethodError
       end
   end
-end
+end

data/lib/parchment/formats/txt/document.rb

@@ -0,0 +1,30 @@
+require 'parchment/document'
+require_relative 'paragraph'
+require_relative 'style'
+
+module Parchment
+  module TXT
+    class Document < Parchment::Document
+
+      def initialize(file)
+        @text = file
+        @styles = []
+        set_paragraphs
+      end
+
+      private
+
+        # These methods parse and add the Document's children and defaults.
+        #
+        def set_paragraphs
+          set_default_paragraph_style
+          # double quotes matter here
+          @paragraphs = @text.gsub("\r", '').split("\n").map { |line| Parchment::TXT::Paragraph.new(line, self) }
+        end
+
+        def set_default_paragraph_style
+          @default_paragraph_style = Parchment::TXT::Style.new
+        end
+    end
+  end
+end

data/lib/parchment/formats/txt/paragraph.rb

@@ -0,0 +1,23 @@
+require 'parchment/paragraph'
+require_relative 'style'
+require_relative 'text_run'
+
+module Parchment
+  module TXT
+    class Paragraph < Parchment::Paragraph
+
+      def initialize(line, document)
+        @node = line # superlass is expecting @node, so we give it @node
+        @document = document
+        @style = @document.default_paragraph_style
+        super()
+      end
+
+      private
+
+        def set_text_runs
+          @text_runs = [Parchment::TXT::TextRun.new(@node, self, @document)]
+        end
+    end
+  end
+end

data/lib/parchment/formats/txt/style.rb

@@ -0,0 +1,12 @@
+require 'parchment/style'
+
+module Parchment
+  module TXT
+    class Style < Parchment::Style
+
+      def initialize
+        # Where this thing is at, it doesn't need styles.
+      end
+    end
+  end
+end

data/lib/parchment/formats/txt/text_run.rb

@@ -0,0 +1,11 @@
+module Parchment
+  module TXT
+    class TextRun < Parchment::TextRun
+
+      def initialize(line, paragraph, document)
+        @content = @node = line # superclass expects @node, so we give it @node
+        @style = paragraph.style
+      end
+    end
+  end
+end

data/lib/parchment/formats/txt/txt.rb

@@ -0,0 +1,13 @@
+require 'zip'
+require_relative 'document'
+
+module Parchment
+
+  # = Parchment plain text format parser
+  #
+  module TXT
+    def self.read(path)
+      Parchment::TXT::Document.new(File.read(path))
+    end
+  end
+end

data/lib/parchment/paragraph.rb

@@ -44,7 +44,7 @@ module Parchment
     # Output the unformatted Paragraph's content as a String.
     #
     def to_s
-      @node.content
+      @text_runs.map(&:to_s).join('')
     end
     alias :text :to_s
 
@@ -54,7 +54,8 @@ module Parchment
     def to_html
       html = ''
       text_runs.each { |text_run| html << text_run.to_html }
-      styles = { 'font-size' => "#{font_size}pt" }
+      styles = {}
+      styles['font-size'] = "#{font_size}pt" unless font_size.nil?
       styles['text-align'] = @style.text_align unless @style.aligned_left?
       html_tag(:p, content: html, styles: styles)
     end

data/lib/parchment/version.rb

@@ -1,3 +1,3 @@
 module Parchment
-  VERSION = '0.0.1'
-end
+  VERSION = '0.0.2'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parchment
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Allen Petlock
@@ -95,6 +95,11 @@ files:
 - lib/parchment/formats/docx/document.rb
 - lib/parchment/formats/docx/style.rb
 - lib/parchment/formats/docx/paragraph.rb
+- lib/parchment/formats/txt/text_run.rb
+- lib/parchment/formats/txt/document.rb
+- lib/parchment/formats/txt/style.rb
+- lib/parchment/formats/txt/txt.rb
+- lib/parchment/formats/txt/paragraph.rb
 - lib/parchment/formats/odt/text_run.rb
 - lib/parchment/formats/odt/document.rb
 - lib/parchment/formats/odt/style.rb
@@ -121,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='