origami 2.0.0 → 2.0.1

data/lib/origami/string.rb

@@ -105,16 +105,6 @@ module Origami
             end
         end
 
-        module ClassMethods #:nodoc:all
-            def native_type; Origami::String end
-        end
-
-        def self.included(receiver) #:nodoc:
-            receiver.extend(ClassMethods)
-        end
-
-        def self.native_type; Origami::String end #:nodoc:
-
         include Origami::Object
 
         attr_accessor :encoding
@@ -188,7 +178,7 @@ module Origami
             super(str)
         end
 
-        def self.parse(stream, parser = nil) #:nodoc:
+        def self.parse(stream, _parser = nil) #:nodoc:
             offset = stream.pos
 
             if stream.skip(@@regexp_open).nil?
@@ -252,7 +242,7 @@ module Origami
             super(str)
         end
 
-        def self.parse(stream, parser = nil) #:nodoc:
+        def self.parse(stream, _parser = nil) #:nodoc:
             offset = stream.pos
 
             unless stream.skip(@@regexp_open)
@@ -381,13 +371,6 @@ module Origami
         attr_reader :year, :month, :day, :hour, :min, :sec, :utc_offset
 
         def initialize(year:, month: 1, day: 1, hour: 0, min: 0, sec: 0, utc_offset: 0)
-            raise InvalidDateError, "Invalid year #{year}" unless (0..9999) === year
-            raise InvalidDateError, "Invalid month #{month}" unless (1..12) === month
-            raise InvalidDateError, "Invalid day #{day}" unless (1..31) === day
-            raise InvalidDateError, "Invalid hour #{hour}" unless (0..23) === hour
-            raise InvalidDateError, "Invalid minute #{min}" unless (0..59) === min
-            raise InvalidDateError, "Invalid second #{sec}" unless (0..59) === sec
-
             @year, @month, @day, @hour, @min, @sec = year, month, day, hour, min, sec
             @utc_offset = utc_offset
 

data/lib/origami/trailer.rb

@@ -22,6 +22,29 @@ module Origami
 
     class PDF
 
+        #
+        # Returns the current trailer.
+        # This might be either a Trailer or XRefStream.
+        #
+        def trailer
+            #
+            # First look for a standard trailer dictionary
+            #
+            if @revisions.last.trailer.has_dictionary?
+                trl = @revisions.last.trailer
+
+            #
+            # Otherwise look for a xref stream.
+            #
+            else
+                trl = @revisions.last.xrefstm
+            end
+
+            raise InvalidPDFError, "No trailer found" if trl.nil?
+
+            trl
+        end
+
         private
 
         def trailer_key?(attr) #:nodoc:
@@ -35,7 +58,7 @@ module Origami
                     return rev.trailer[attr].solve
                 elsif rev.has_xrefstm?
                     xrefstm = rev.xrefstm
-                    if xrefstm.is_a?(XRefStream) and xrefstm.has_field?(attr)
+                    if xrefstm.is_a?(XRefStream) and xrefstm.key?(attr)
                         return xrefstm[attr].solve
                     end
                 end
@@ -44,29 +67,9 @@ module Origami
             nil
         end
 
-        def get_trailer_info #:nodoc:
-            #
-            # First look for a standard trailer dictionary
-            #
-            if @revisions.last.trailer.has_dictionary?
-                @revisions.last.trailer
-
-            #
-            # Otherwise look for a xref stream.
-            #
-            else
-                @revisions.last.xrefstm
-            end
-        end
-
         def generate_id
-            info = get_trailer_info
-            if info.nil?
-                raise InvalidPDFError, "Cannot access trailer information"
-            end
-
             id = HexaString.new Random.new.bytes 16
-            info.ID = [ id, id ]
+            self.trailer.ID = [ id, id ]
         end
     end
 

data/lib/origami/version.rb

@@ -19,5 +19,5 @@
 =end
 
 module Origami
-    VERSION   = "2.0.0"
+    VERSION   = "2.0.1"
 end 

data/lib/origami/xfa.rb

@@ -47,21 +47,21 @@ module Origami
 
             def xfa_attribute(name)
                 # Attribute getter.
-                attr_getter = "attr_#{name.to_s}"
+                attr_getter = "attr_#{name}"
                 remove_method(attr_getter) rescue NameError
                 define_method(attr_getter) do
                     self.attributes[name.to_s]
                 end
 
                 # Attribute setter.
-                attr_setter = "attr_#{name.to_s}="
+                attr_setter = "attr_#{name}="
                 remove_method(attr_setter) rescue NameError
                 define_method(attr_setter) do |value|
                     self.attributes[names.to_s] = value
                 end
             end
 
-            def xfa_node(name, type, range = (0..(1.0/0)))
+            def xfa_node(name, type, _range = (0..Float::INFINITY))
 
                 adder = "add_#{name}"
                 remove_method(adder) rescue NameError
@@ -220,7 +220,7 @@ module Origami
                     def initialize(record = "")
                         super('record')
 
-                        self.text = ""
+                        self.text = record
                     end
                 end
 
@@ -1099,6 +1099,8 @@ module Origami
 
                     def initialize(text = "")
                         super('toolTip')
+
+                        self.text = text
                     end
                 end
 

data/lib/origami/xreftable.rb

@@ -25,26 +25,15 @@ module Origami
         # Tries to strip any xrefs information off the document.
         #
         def remove_xrefs
-
-            # Delete a XRefStream and its ancestors.
-            delete_xrefstm = -> (xrefstm) do
-                prev = xrefstm.Prev
-                delete_object(xrefstm.reference)
-
-                if prev.is_a?(Integer) and (prev_stm = get_object_by_offset(prev)).is_a?(XRefStream)
-                    delete_xrefstm.call(prev_stm)
-                end
-            end
-
             @revisions.reverse_each do |rev|
                 if rev.has_xrefstm?
-                    delete_xrefstm.call(rev.xrefstm)
+                    delete_object(rev.xrefstm.reference)
                 end
 
-                if rev.trailer.has_dictionary? and rev.trailer.XRefStm.is_a?(Integer)
+                if rev.trailer.XRefStm.is_a?(Integer)
                     xrefstm = get_object_by_offset(rev.trailer.XRefStm)
 
-                    delete_xrefstm.call(xrefstm) if xrefstm.is_a?(XRefStream)
+                    delete_object(xrefstm.reference) if xrefstm.is_a?(XRefStream)
                 end
 
                 rev.xrefstm = rev.xreftable = nil
@@ -135,6 +124,8 @@ module Origami
         # A subsection contains a continute set of XRef.
         #
         class Subsection
+            include Enumerable
+
             @@regexp = Regexp.new("(?<start>\\d+) (?<size>\\d+)" + WHITESPACES + "(\\r?\\n|\\r\\n?)")
 
             attr_reader :range
@@ -228,6 +219,8 @@ module Origami
         # A section contains a set of XRefSubsection.
         #
         class Section
+            include Enumerable
+
             TOKEN = "xref"
 
             @@regexp_open = Regexp.new(WHITESPACES + TOKEN + WHITESPACES + "(\\r?\\n|\\r\\n?)")
@@ -337,7 +330,7 @@ module Origami
     #
     # An xref poiting to an Object embedded in an ObjectStream.
     #
-    class XRefToCompressedObj
+    class XRefToCompressedObject
         attr_accessor :objstmno, :index
 
         def initialize(objstmno, index)
@@ -356,6 +349,9 @@ module Origami
 
             [ type , objstmno, index ].pack("B#{type_w}B#{field1_w}B#{field2_w}")
         end
+
+        def used?; true end
+        def free?; false end
     end
 
     class InvalidXRefStreamObjectError < InvalidStreamObjectError ; end
@@ -406,7 +402,7 @@ module Origami
         def pre_build #:nodoc:
             load! if @xrefs.nil?
 
-            self.W = [ 1, 2, 2 ] unless has_field?(:W)
+            self.W = [ 1, 2, 2 ] unless self.key?(:W)
             self.Size = @xrefs.length + 1
 
             save!
@@ -496,18 +492,10 @@ module Origami
         end
 
         def load! #:nodoc:
-            if @xrefs.nil? and has_field?(:W)
-                widths = self.W
-
-                if not widths.is_a?(Array) or widths.length != 3 or widths.any?{|width| not width.is_a?(Integer) }
-                    raise InvalidXRefStreamObjectError, "W field must be an array of 3 integers"
-                end
-
+            if @xrefs.nil? and self.key?(:W)
                 decode!
 
-                type_w = self.W[0]
-                field1_w = self.W[1]
-                field2_w = self.W[2]
+                type_w, field1_w, field2_w = field_widths
 
                 entrymask = "B#{type_w << 3}B#{field1_w << 3}B#{field2_w << 3}"
                 size = @data.size / (type_w + field1_w + field2_w)
@@ -515,15 +503,14 @@ module Origami
                 xentries = @data.unpack(entrymask * size).map!{|field| field.to_i(2) }
 
                 @xrefs = []
-                size.times do |i|
-                    type,field1,field2 = xentries[i*3].ord,xentries[i*3+1].ord,xentries[i*3+2].ord
+                xentries.each_slice(3) do |type, field1, field2|
                     case type
                     when XREF_FREE
                         @xrefs << XRef.new(field1, field2, XRef::FREE)
                     when XREF_USED
                         @xrefs << XRef.new(field1, field2, XRef::USED)
                     when XREF_COMPRESSED
-                        @xrefs << XRefToCompressedObj.new(field1, field2)
+                        @xrefs << XRefToCompressedObject.new(field1, field2)
                     end
                 end
             else
@@ -539,6 +526,19 @@ module Origami
 
             encode!
         end
+
+        #
+        # Check and return the internal field widths.
+        #
+        def field_widths
+            widths = self.W
+
+            unless widths.is_a?(Array) and widths.length == 3 and widths.all? {|w| w.is_a?(Integer) and w >= 0 }
+                raise InvalidXRefStreamObjectError, "Invalid W field: #{widths}"
+            end
+
+            widths
+        end
     end
 
 end

data/test/test_annotations.rb

@@ -7,55 +7,33 @@ class TestAnnotations < Minitest::Test
         @page = Page.new
         @action = Action::JavaScript["app.alert(null);"]
         @output = StringIO.new
-    end
-
-    def test_annotations
-        circle = Annotation::Circle.new
-        square = Annotation::Square.new
-        text = Annotation::Text.new
-        link = Annotation::Link.new
-        file = Annotation::FileAttachment.new
-        screen = Annotation::Screen.new
-        sound = Annotation::Sound.new
-        pushbutton = Annotation::Widget::PushButton.new
-        checkbox = Annotation::Widget::CheckBox.new
-        radio = Annotation::Widget::Radio.new
-        edit = Annotation::Widget::Text.new
-        combo = Annotation::Widget::ComboBox.new
-        list = Annotation::Widget::ListBox.new
-        sig = Annotation::Widget::Signature.new
 
-        all_annots = [
-            circle, square, text, link,
-            file, screen, sound, pushbutton,
-            checkbox, radio, edit, combo,
-            list, sig
+        @types = [ 
+            Annotation::Circle, Annotation::Square,
+            Annotation::Text, Annotation::Link,
+            Annotation::FileAttachment, Annotation::Screen,
+            Annotation::Sound, Annotation::Widget::CheckBox,
+            Annotation::Widget::Radio, Annotation::Widget::Text,
+            Annotation::Widget::ComboBox, Annotation::Widget::ListBox,
+            Annotation::Widget::Signature
         ]
+    end
 
+    def test_annotations
         @target.append_page @page
 
-        @page.add_annotation circle
-        @page.add_annotation square
-        @page.add_annotation text
-        @page.add_annotation link
-        @page.add_annotation file
-        @page.add_annotation screen
-        @page.add_annotation sound
-        @page.add_annotation pushbutton
-        @page.add_annotation checkbox
-        @page.add_annotation radio
-        @page.add_annotation edit
-        @page.add_annotation combo
-        @page.add_annotation list
-        @page.add_annotation sig
+        annotations = @types.map(&:new)
+        annotations.each do |annotation|
+            @page.add_annotation(annotation)
+        end
 
         @page.each_annotation do |annotation|
             assert_kind_of Annotation, annotation
 
-            assert all_annots.include?(annotation)
+            assert annotations.include?(annotation)
         end
 
-        assert_equal @page.annotations.size, all_annots.size
+        assert_equal @page.annotations.size, annotations.size
 
         @target.save(@output)
     end

data/test/test_pdf_attachment.rb

@@ -17,7 +17,7 @@ class TestAttachment < Minitest::Test
         pdf = PDF.read(@output, ignore_errors: false, verbosity: Parser::VERBOSE_QUIET)
 
         assert_equal pdf.each_named_embedded_file.count, 1
-        assert_equal pdf.get_embedded_file_by_name("foo.baz"), nil
+        assert_nil pdf.get_embedded_file_by_name("foo.baz")
 
         file = pdf.get_embedded_file_by_name('foo.bar')
         refute_equal file, nil

data/test/test_pdf_parse.rb

@@ -62,7 +62,7 @@ class TestPDFParser < Minitest::Test
         assert_instance_of Boolean, b_false
 
         assert b_false.false?
-        assert (not b_true.false?)
+        refute b_true.false?
     end
 
     def test_parse_real

data/test/test_xrefs.rb

@@ -47,13 +47,13 @@ class TestXrefs < MiniTest::Test
         xrefstm = pdf.revisions.last.xrefstm
 
         assert_instance_of XRefStream, xrefstm
-        assert xrefstm.entries.all?{ |xref| xref.is_a?(XRef) or xref.is_a?(XRefToCompressedObj) }
+        assert xrefstm.entries.all?{ |xref| xref.is_a?(XRef) or xref.is_a?(XRefToCompressedObject) }
 
         pdf.each_object(compressed: true) do |object|
             xref = xrefstm.find(object.no)
 
             if object.parent.is_a?(ObjectStream)
-                assert_instance_of XRefToCompressedObj, xref
+                assert_instance_of XRefToCompressedObject, xref
                 assert_equal xref.objstmno, object.parent.no
                 assert_equal xref.index, object.parent.index(object.no)
             else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origami
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Guillaume Delugré
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -116,13 +116,13 @@ files:
 - lib/origami/destinations.rb
 - lib/origami/dictionary.rb
 - lib/origami/encryption.rb
-- lib/origami/export.rb
 - lib/origami/extensions/fdf.rb
 - lib/origami/extensions/ppklite.rb
 - lib/origami/filespec.rb
 - lib/origami/filters.rb
 - lib/origami/filters/ascii.rb
 - lib/origami/filters/ccitt.rb
+- lib/origami/filters/ccitt/tables.rb
 - lib/origami/filters/crypt.rb
 - lib/origami/filters/dct.rb
 - lib/origami/filters/flate.rb
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - gtk2 to run the graphical interface
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby framework to manipulate PDF documents

data/lib/origami/export.rb

@@ -1,247 +0,0 @@
-=begin
-
-    This file is part of Origami, PDF manipulation framework for Ruby
-    Copyright (C) 2016	Guillaume Delugré.
-
-    Origami is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Lesser General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    Origami is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU Lesser General Public License for more details.
-
-    You should have received a copy of the GNU Lesser General Public License
-    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
-
-=end
-
-module Origami
-
-    class PDF
-
-        #
-        # Exports the document to a dot Graphiz file.
-        # _filename_:: The path where to save the file.
-        #
-        def export_to_graph(path)
-
-            appearance = -> (object) do
-                label = object.type.to_s
-                case object
-                when Catalog
-                    fontcolor = "red"
-                    color = "mistyrose"
-                    shape = "ellipse"
-                when Name, Number
-                    label = object.value
-                    fontcolor = "brown"
-                    color = "lightgoldenrodyellow"
-                    shape = "polygon"
-                when String
-                    label = object.value if (object.ascii_only? and object.length <= 50)
-                    fontcolor = "red"
-                    color = "white"
-                    shape = "polygon"
-                when Array
-                    fontcolor = "darkgreen"
-                    color = "lightcyan"
-                    shape = "ellipse"
-                else
-                  fontcolor = "blue"
-                  color = "aliceblue"
-                  shape = "ellipse"
-                end
-
-                { label: label, fontcolor: fontcolor, color: color, shape: shape }
-            end
-
-            add_edges = -> (fd, object) do
-                if object.is_a?(Array) or object.is_a?(ObjectStream)
-                    object.each do |subobj|
-                        fd << "\t#{object.object_id} -> #{subobj.solve.object_id}\n"
-                    end
-
-                elsif object.is_a?(Dictionary)
-                    object.each_pair do |name, subobj|
-                        fd << "\t#{object.object_id} -> #{subobj.solve.object_id} "
-                        fd << "[label=\"#{name.value}\",fontsize=9];\n"
-                    end
-                end
-
-                if object.is_a?(Stream)
-                    object.dictionary.each_pair do |key, value|
-                        fd << "\t#{object.object_id} -> #{value.solve.object_id} "
-                        fd << "[label=\"#{key.value}\",fontsize=9];\n"
-                    end
-                end
-            end
-
-            graph_name = "PDF" if graph_name.nil? or graph_name.empty?
-            fd = File.open(path, "w")
-
-            begin
-                fd << "digraph #{graph_name} {\n\n"
-
-                objects = self.objects(include_keys: false).find_all{ |obj| not obj.is_a?(Reference) }
-
-                objects.each do |object|
-                    attr = appearance[object]
-
-                    fd << "\t#{object.object_id} "
-                    fd << "[label=\"#{attr[:label]}\",shape=#{attr[:shape]},color=#{attr[:color]},style=filled,fontcolor=#{attr[:fontcolor]},fontsize=16];\n"
-
-                    if object.is_a?(Stream)
-                        object.dictionary.each do |value|
-                            unless value.is_a?(Reference)
-                                attr = appearance[value]
-                                fd << "\t#{value.object_id} "
-                                fd << "[label=\"#{attr[:label]}\",shape=#{attr[:shape]},color=#{attr[:color]},style=filled,fontcolor=#{attr[:fontcolor]},fontsize=16];\n"
-                            end
-                        end
-                    end
-
-                    add_edges.call(fd, object)
-                end
-
-                fd << "\n}"
-            ensure
-                fd.close
-            end
-        end
-
-        #
-        # Exports the document to a GraphML file.
-        # _filename_:: The path where to save the file.
-        #
-        def export_to_graphml(path)
-            require 'rexml/document'
-
-            declare_node = -> (id, attr) do
-                <<-XML
-                <node id="#{id}">
-                    <data key="d0">
-                        <y:ShapeNode>
-                            <y:NodeLabel>#{attr[:label]}</y:NodeLabel>
-                        </y:ShapeNode>
-                    </data>
-                </node>
-                XML
-            end
-
-            declare_edge = -> (id, src, dest, label = nil) do
-                <<-XML
-                <edge id="#{id}" source="#{src}" target="#{dest}">
-                    <data key="d1">
-                        <y:PolyLineEdge>
-                            <y:LineStyle type="line" width="1.0" color="#000000"/>
-                            <y:Arrows source="none" target="standard"/>
-                            <y:EdgeLabel>#{label.to_s}</y:EdgeLabel>
-                        </y:PolyLineEdge>
-                    </data>
-                </edge>
-                XML
-            end
-
-            appearance = -> (object) do
-                label = object.type.to_s
-                case object
-                when Catalog
-                    fontcolor = "red"
-                    color = "mistyrose"
-                    shape = "doublecircle"
-                when Name, Number
-                    label = object.value
-                    fontcolor = "orange"
-                    color = "lightgoldenrodyellow"
-                    shape = "polygon"
-                when String
-                    label = object.value if (object.ascii_only? and object.length <= 50)
-                    fontcolor = "red"
-                    color = "white"
-                    shape = "polygon"
-                when Array
-                    fontcolor = "green"
-                    color = "lightcyan"
-                    shape = "ellipse"
-                else
-                  fontcolor = "blue"
-                  color = "aliceblue"
-                  shape = "ellipse"
-                end
-
-                { label: label, fontcolor: fontcolor, color: color, shape: shape }
-            end
-
-            add_edges = -> (xml, object, id) do
-                if object.is_a?(Array) or object.is_a?(ObjectStream)
-                    object.each do |subobj|
-                        xml << declare_edge["e#{id}", "n#{object.object_id}", "n#{subobj.solve.object_id}"]
-                        id = id + 1
-                    end
-
-                elsif object.is_a?(Dictionary)
-                    object.each_pair do |name, subobj|
-                        xml << declare_edge["e#{id}", "n#{object.object_id}", "n#{subobj.solve.object_id}",
-                                           name.value]
-                        id = id + 1
-                    end
-                end
-
-                if object.is_a?(Stream)
-                    object.dictionary.each_pair do |key, value|
-                        xml << declare_edge["e#{id}", "n#{object.object_id}", "n#{value.object_id}", key.value]
-                        id = id + 1
-                    end
-                end
-
-                id
-            end
-
-            graph_name = "PDF" if graph_name.nil? or graph_name.empty?
-
-            edge_nb = 1
-            xml = <<-XML
-                <?xml version="1.0" encoding="UTF-8"?>
-                <graphml xmlns="http://graphml.graphdrawing.org/xmlns/graphml"
-                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                         xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns/graphml
-                                             http://www.yworks.com/xml/schema/graphml/1.0/ygraphml.xsd"
-                         xmlns:y="http://www.yworks.com/xml/graphml">
-                    <key id="d0" for="node" yfiles.type="nodegraphics"/>
-                    <key id="d1" for="edge" yfiles.type="edgegraphics"/>
-                    <graph id="#{graph_name}" edgedefault="directed">
-            XML
-
-            objects = self.objects(include_keys: false).find_all{ |obj| not obj.is_a?(Reference) }
-
-            objects.each do |object|
-                xml << declare_node["n#{object.object_id}", appearance[object]]
-
-                if object.is_a?(Stream)
-                    object.dictionary.each do |value|
-                        unless value.is_a?(Reference)
-                            xml << declare_node[value.object_id, appearance[value]]
-                        end
-                    end
-                end
-
-                edge_nb = add_edges[xml, object, edge_nb]
-            end
-
-            xml << '</graph>' << "\n"
-            xml << '</graphml>'
-
-            doc = REXML::Document.new(xml)
-            formatter = REXML::Formatters::Pretty.new(4)
-            formatter.compact = true
-
-            File.open(path, "w") do |fd|
-                formatter.write(doc, fd)
-            end
-        end
-    end
-
-end