origami-docspring 2.2.0 → 2.3.0

data/lib/origami/font.rb

@@ -1,196 +1,192 @@
-=begin
+# frozen_string_literal: true
+
+#
+#     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/>.
+#
 
-    This file is part of Origami, PDF manipulation framework for Ruby
-    Copyright (C) 2016	Guillaume Delugré.
+module Origami
+  #
+  # Embedded font stream.
+  #
+  class FontStream < Stream
+    field :Subtype, Type: Name
+    field :Length1, Type: Integer
+    field :Length2, Type: Integer
+    field :Length3, Type: Integer
+    field :Metadata, Type: MetadataStream
+  end
+
+  #
+  # Class representing a font details in a document.
+  #
+  class FontDescriptor < Dictionary
+    include StandardObject
+
+    FIXEDPITCH = 1 << 1
+    SERIF = 1 << 2
+    SYMBOLIC = 1 << 3
+    SCRIPT = 1 << 4
+    NONSYMBOLIC = 1 << 6
+    ITALIC = 1 << 7
+    ALLCAP = 1 << 17
+    SMALLCAP = 1 << 18
+    FORCEBOLD = 1 << 19
+
+    field :Type, Type: Name, Default: :FontDescriptor, Required: true
+    field :FontName, Type: Name, Required: true
+    field :FontFamily, Type: String, Version: "1.5"
+    field :FontStretch, Type: Name, Default: :Normal, Version: "1.5"
+    field :FontWeight, Type: Integer, Default: 400, Version: "1.5"
+    field :Flags, Type: Integer, Required: true
+    field :FontBBox, Type: Rectangle
+    field :ItalicAngle, Type: Number, Required: true
+    field :Ascent, Type: Number
+    field :Descent, Type: Number
+    field :Leading, Type: Number, Default: 0
+    field :CapHeight, Type: Number
+    field :XHeight, Type: Number, Default: 0
+    field :StemV, Type: Number
+    field :StemH, Type: Number, Default: 0
+    field :AvgWidth, Type: Number, Default: 0
+    field :MaxWidth, Type: Number, Default: 0
+    field :MissingWidth, Type: Number, Default: 0
+    field :FontFile, Type: FontStream
+    field :FontFile2, Type: FontStream, Version: "1.1"
+    field :FontFile3, Type: FontStream, Version: "1.2"
+    field :CharSet, Type: String, Version: "1.1"
+  end
+
+  #
+  # Class representing a character encoding in a document.
+  #
+  class Encoding < Dictionary
+    include StandardObject
+
+    field :Type, Type: Name, Default: :Encoding
+    field :BaseEncoding, Type: Name
+    field :Differences, Type: Array
+  end
+
+  #
+  # Class representing a rendering font in a document.
+  #
+  class Font < Dictionary
+    include StandardObject
+
+    field :Type, Type: Name, Default: :Font, Required: true
+    field :Subtype, Type: Name, Required: true
+    field :Name, Type: Name
+    field :FirstChar, Type: Integer
+    field :LastChar, Type: Integer
+    field :Widths, Type: Array.of(Number)
+    field :FontDescriptor, Type: FontDescriptor
+    field :Encoding, Type: [Name, Encoding], Default: :MacRomanEncoding
+    field :ToUnicode, Type: Stream, Version: "1.2"
+
+    # TODO: Type0 and CID Fonts
 
-    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.
+    #
+    # Type1 Fonts.
+    #
+    class Type1 < Font
+      field :BaseFont, Type: Name, Required: true
+      field :Subtype, Type: Name, Default: :Type1, Required: true
+
+      #
+      # 14 standard Type1 fonts.
+      #
+      module Standard
+        class TimesRoman < Type1
+          field :BaseFont, Type: Name, Default: :'Times-Roman', Required: true
+        end
 
-    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.
+        class Helvetica < Type1
+          field :BaseFont, Type: Name, Default: :Helvetica, Required: true
+        end
 
-    You should have received a copy of the GNU Lesser General Public License
-    along with Origami.  If not, see <http://www.gnu.org/licenses/>.
+        class Courier < Type1
+          field :BaseFont, Type: Name, Default: :Courier, Required: true
+        end
 
-=end
+        class Symbol < Type1
+          field :BaseFont, Type: Name, Default: :Symbol, Required: true
+        end
 
-module Origami
+        class TimesBold < Type1
+          field :BaseFont, Type: Name, Default: :'Times-Bold', Required: true
+        end
 
-    #
-    # Embedded font stream.
-    #
-    class FontStream < Stream
-        field   :Subtype,                 :Type => Name
-        field   :Length1,                 :Type => Integer
-        field   :Length2,                 :Type => Integer
-        field   :Length3,                 :Type => Integer
-        field   :Metadata,                :Type => MetadataStream
-    end
+        class HelveticaBold < Type1
+          field :BaseFont, Type: Name, Default: :'Helvetica-Bold', Required: true
+        end
 
-    #
-    # Class representing a font details in a document.
-    #
-    class FontDescriptor < Dictionary
-        include StandardObject
-
-        FIXEDPITCH  = 1 << 1
-        SERIF       = 1 << 2
-        SYMBOLIC    = 1 << 3
-        SCRIPT      = 1 << 4
-        NONSYMBOLIC = 1 << 6
-        ITALIC      = 1 << 7
-        ALLCAP      = 1 << 17
-        SMALLCAP    = 1 << 18
-        FORCEBOLD   = 1 << 19
-
-        field   :Type,                    :Type => Name, :Default => :FontDescriptor, :Required => true
-        field   :FontName,                :Type => Name, :Required => true
-        field   :FontFamily,              :Type => String, :Version => "1.5"
-        field   :FontStretch,             :Type => Name, :Default => :Normal, :Version => "1.5"
-        field   :FontWeight,              :Type => Integer, :Default => 400, :Version => "1.5"
-        field   :Flags,                   :Type => Integer, :Required => true
-        field   :FontBBox,                :Type => Rectangle
-        field   :ItalicAngle,             :Type => Number, :Required => true
-        field   :Ascent,                  :Type => Number
-        field   :Descent,                 :Type => Number
-        field   :Leading,                 :Type => Number, :Default => 0
-        field   :CapHeight,               :Type => Number
-        field   :XHeight,                 :Type => Number, :Default => 0
-        field   :StemV,                   :Type => Number
-        field   :StemH,                   :Type => Number, :Default => 0
-        field   :AvgWidth,                :Type => Number, :Default => 0
-        field   :MaxWidth,                :Type => Number, :Default => 0
-        field   :MissingWidth,            :Type => Number, :Default => 0
-        field   :FontFile,                :Type => FontStream
-        field   :FontFile2,               :Type => FontStream, :Version => "1.1"
-        field   :FontFile3,               :Type => FontStream, :Version => "1.2"
-        field   :CharSet,                 :Type => String, :Version => "1.1"
-    end
+        class CourierBold < Type1
+          field :BaseFont, Type: Name, Default: :'Courier-Bold', Required: true
+        end
 
-    #
-    # Class representing a character encoding in a document.
-    #
-    class Encoding < Dictionary
-        include StandardObject
+        class ZapfDingbats < Type1
+          field :BaseFont, Type: Name, Default: :ZapfDingbats, Required: true
+        end
 
-        field   :Type,                    :Type => Name, :Default => :Encoding
-        field   :BaseEncoding,            :Type => Name
-        field   :Differences,             :Type => Array
-    end
+        class TimesItalic < Type1
+          field :BaseFont, Type: Name, Default: :'Times-Italic', Required: true
+        end
 
-    #
-    # Class representing a rendering font in a document.
-    #
-    class Font < Dictionary
-        include StandardObject
-
-        field   :Type,                    :Type => Name, :Default => :Font, :Required => true
-        field   :Subtype,                 :Type => Name, :Required => true
-        field   :Name,                    :Type => Name
-        field   :FirstChar,               :Type => Integer
-        field   :LastChar,                :Type => Integer
-        field   :Widths,                  :Type => Array.of(Number)
-        field   :FontDescriptor,          :Type => FontDescriptor
-        field   :Encoding,                :Type => [ Name, Encoding ], :Default => :MacRomanEncoding
-        field   :ToUnicode,               :Type => Stream, :Version => "1.2"
-
-        # TODO: Type0 and CID Fonts
-
-        #
-        # Type1 Fonts.
-        #
-        class Type1 < Font
-
-            field   :BaseFont,              :Type => Name, :Required => true
-            field   :Subtype,               :Type => Name, :Default => :Type1, :Required => true
-
-            #
-            # 14 standard Type1 fonts.
-            #
-            module Standard
-
-                class TimesRoman < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Times-Roman", :Required => true
-                end
-
-                class Helvetica < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :Helvetica, :Required => true
-                end
-
-                class Courier < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :Courier, :Required => true
-                end
-
-                class Symbol < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :Symbol, :Required => true
-                end
-
-                class TimesBold < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Times-Bold", :Required => true
-                end
-
-                class HelveticaBold < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Bold", :Required => true
-                end
-
-                class CourierBold < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Courier-Bold", :Required => true
-                end
-
-                class ZapfDingbats < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :ZapfDingbats, :Required => true
-                end
-
-                class TimesItalic < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Times-Italic", :Required => true
-                end
-
-                class HelveticaOblique < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Helvetica-Oblique", :Required => true
-                end
-
-                class CourierOblique < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Courier-Oblique", :Required => true
-                end
-
-                class TimesBoldItalic < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Times-BoldItalic", :Required => true
-                end
-
-                class HelveticaBoldOblique < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Helvetica-BoldOblique", :Required => true
-                end
-
-                class CourierBoldOblique < Type1
-                    field   :BaseFont,          :Type => Name, :Default => :"Courier-BoldOblique", :Required => true
-                end
-            end
+        class HelveticaOblique < Type1
+          field :BaseFont, Type: Name, Default: :'Helvetica-Oblique', Required: true
+        end
+
+        class CourierOblique < Type1
+          field :BaseFont, Type: Name, Default: :'Courier-Oblique', Required: true
         end
 
-        #
-        # TrueType Fonts
-        #
-        class TrueType < Font
-            field   :Subtype,               :Type => Name, :Default => :TrueType, :Required => true
-            field   :BaseFont,              :Type => Name, :Required => true
+        class TimesBoldItalic < Type1
+          field :BaseFont, Type: Name, Default: :'Times-BoldItalic', Required: true
         end
 
-        #
-        # Type 3 Fonts
-        #
-        class Type3 < Font
-            include ResourcesHolder
-
-            field   :Subtype,               :Type => Name, :Default => :Type3, :Required => true
-            field   :FontBBox,              :Type => Rectangle, :Required => true
-            field   :FontMatrix,            :Type => Array.of(Number, length: 6), :Required => true
-            field   :CharProcs,             :Type => Dictionary, :Required => true
-            field   :Resources,             :Type => Resources, :Version => "1.2"
+        class HelveticaBoldOblique < Type1
+          field :BaseFont, Type: Name, Default: :'Helvetica-BoldOblique', Required: true
         end
+
+        class CourierBoldOblique < Type1
+          field :BaseFont, Type: Name, Default: :'Courier-BoldOblique', Required: true
+        end
+      end
+    end
+
+    #
+    # TrueType Fonts
+    #
+    class TrueType < Font
+      field :Subtype, Type: Name, Default: :TrueType, Required: true
+      field :BaseFont, Type: Name, Required: true
     end
 
+    #
+    # Type 3 Fonts
+    #
+    class Type3 < Font
+      include ResourcesHolder
+
+      field :Subtype, Type: Name, Default: :Type3, Required: true
+      field :FontBBox, Type: Rectangle, Required: true
+      field :FontMatrix, Type: Array.of(Number, length: 6), Required: true
+      field :CharProcs, Type: Dictionary, Required: true
+      field :Resources, Type: Resources, Version: "1.2"
+    end
+  end
 end

data/lib/origami/functions.rb

@@ -1,79 +1,75 @@
-=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
-
+# frozen_string_literal: true
+
+#
+#     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/>.
+#
 
 module Origami
+  module Function
+    module Type
+      SAMPLED = 0
+      EXPONENTIAL = 2
+      STITCHING = 3
+      POSTSCRIPT = 4
+    end
 
-    module Function
-
-        module Type
-            SAMPLED     = 0
-            EXPONENTIAL = 2
-            STITCHING   = 3
-            POSTSCRIPT  = 4
-        end
-
-        def self.included(receiver)
-            receiver.field  :FunctionType,  :Type => Integer, :Required => true
-            receiver.field  :Domain,        :Type => Array.of(Number), :Required => true
-            receiver.field  :Range,         :Type => Array.of(Number)
-        end
+    def self.included(receiver)
+      receiver.field :FunctionType, Type: Integer, Required: true
+      receiver.field :Domain, Type: Array.of(Number), Required: true
+      receiver.field :Range, Type: Array.of(Number)
+    end
 
-        class Sampled < Stream
-            include Function
+    class Sampled < Stream
+      include Function
 
-            field   :FunctionType,  :Type => Integer, :Default => Type::SAMPLED, :Version => "1.3", :Required => true
-            field   :Range,         :Type => Array.of(Number), :Required => true
-            field   :Size,          :Type => Array.of(Integer), :Required => true
-            field   :BitsPerSample, :Type => Integer, :Required => true
-            field   :Order,         :Type => Integer, :Default => 1
-            field   :Encode,        :Type => Array.of(Number)
-            field   :Decode,        :Type => Array.of(Number)
-        end
+      field :FunctionType, Type: Integer, Default: Type::SAMPLED, Version: "1.3", Required: true
+      field :Range, Type: Array.of(Number), Required: true
+      field :Size, Type: Array.of(Integer), Required: true
+      field :BitsPerSample, Type: Integer, Required: true
+      field :Order, Type: Integer, Default: 1
+      field :Encode, Type: Array.of(Number)
+      field :Decode, Type: Array.of(Number)
+    end
 
-        class Exponential < Dictionary
-            include StandardObject
-            include Function
+    class Exponential < Dictionary
+      include StandardObject
+      include Function
 
-            field   :FunctionType,  :Type => Integer, :Default => Type::EXPONENTIAL, :Version => "1.3", :Required => true
-            field   :C0,            :Type => Array.of(Number), :Default => [ 0.0 ]
-            field   :C1,            :Type => Array.of(Number), :Default => [ 1.0 ]
-            field   :N,             :Type => Number, :Required => true
-        end
+      field :FunctionType, Type: Integer, Default: Type::EXPONENTIAL, Version: "1.3", Required: true
+      field :C0, Type: Array.of(Number), Default: [0.0]
+      field :C1, Type: Array.of(Number), Default: [1.0]
+      field :N, Type: Number, Required: true
+    end
 
-        class Stitching < Dictionary
-            include StandardObject
-            include Function
+    class Stitching < Dictionary
+      include StandardObject
+      include Function
 
-            field   :FunctionType,  :Type => Integer, :Default => Type::STITCHING, :Version => "1.3", :Required => true
-            field   :Functions,     :Type => Array, :Required => true
-            field   :Bounds,        :Type => Array.of(Number), :Required => true
-            field   :Encode,        :Type => Array.of(Number), :Required => true
-        end
+      field :FunctionType, Type: Integer, Default: Type::STITCHING, Version: "1.3", Required: true
+      field :Functions, Type: Array, Required: true
+      field :Bounds, Type: Array.of(Number), Required: true
+      field :Encode, Type: Array.of(Number), Required: true
+    end
 
-        class PostScript < Stream
-            include Function
+    class PostScript < Stream
+      include Function
 
-            field   :FunctionType,  :Type => Integer, :Default => Type::POSTSCRIPT, :Version => "1.3", :Required => true
-            field   :Range,         :Type => Array.of(Number), :Required => true
-        end
+      field :FunctionType, Type: Integer, Default: Type::POSTSCRIPT, Version: "1.3", Required: true
+      field :Range, Type: Array.of(Number), Required: true
     end
-
+  end
 end