origami-docspring 2.2.0 → 2.3.0

data/lib/origami/graphics/path.rb

@@ -1,182 +1,179 @@
-=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 Graphics
+    module LineCapStyle
+      BUTT_CAP = 0
+      ROUND_CAP = 1
+      PROJECTING_SQUARE_CAP = 2
+    end
 
-    module Graphics
+    module LineJoinStyle
+      MITER_JOIN = 0
+      ROUND_JOIN = 1
+      BEVEL_JOIN = 2
+    end
 
-        module LineCapStyle
-            BUTT_CAP              = 0
-            ROUND_CAP             = 1
-            PROJECTING_SQUARE_CAP = 2
-        end
+    class DashPattern
+      attr_accessor :array, :phase
 
-        module LineJoinStyle
-            MITER_JOIN = 0
-            ROUND_JOIN = 1
-            BEVEL_JOIN = 2
-        end
+      def initialize(array, phase = 0)
+        @array = array
+        @phase = phase
+      end
 
-        class DashPattern
-            attr_accessor :array, :phase
+      def eql?(other) # :nodoc
+        other.array == @array and other.phase == @phase
+      end
 
-            def initialize(array, phase = 0)
-                @array = array
-                @phase = phase
-            end
+      def hash # :nodoc:
+        [@array, @phase].hash
+      end
+    end
 
-            def eql?(dash) #:nodoc
-                dash.array == @array and dash.phase == @phase
-            end
+    class InvalidPathError < Error # :nodoc:
+    end
 
-            def hash #:nodoc:
-                [ @array, @phase ].hash
-            end
-        end
+    class Path
+      module Segment
+        attr_accessor :from, :to
 
-        class InvalidPathError < Error #:nodoc:
+        def initialize(from, to)
+          @from, @to = from, to
         end
+      end
 
-        class Path
-            module Segment
-                attr_accessor :from, :to
-
-                def initialize(from, to)
-                    @from, @to = from, to
-                end
-            end
-
-            class Line
-                include Segment
-            end
+      class Line
+        include Segment
+      end
 
-            attr_accessor :current_point
-            attr_reader :segments
+      attr_accessor :current_point
+      attr_reader :segments
 
-            def initialize
-                @segments = []
-                @current_point = nil
-                @closed = false
-            end
+      def initialize
+        @segments = []
+        @current_point = nil
+        @closed = false
+      end
 
-            def is_closed?
-                @closed
-            end
+      def is_closed?
+        @closed
+      end
 
-            def close!
-                from = @current_point
-                to = @segments.first.from
+      def close!
+        from = @current_point
+        to = @segments.first.from
 
-                @segments << Line.new(from, to)
-                @segments.freeze
-                @closed = true
-            end
+        @segments << Line.new(from, to)
+        @segments.freeze
+        @closed = true
+      end
 
-            def add_segment(seg)
-                raise GraphicsStateError, "Cannot modify closed subpath" if is_closed?
+      def add_segment(seg)
+        raise GraphicsStateError, "Cannot modify closed subpath" if is_closed?
 
-                @segments << seg
-                @current_point = seg.to
-            end
-        end
+        @segments << seg
+        @current_point = seg.to
+      end
     end
+  end
 
-    class PDF::Instruction
-        insn 'm', Real, Real do |canvas, x,y|
-            canvas.gs.current_path << (subpath = Graphics::Path.new)
-            subpath.current_point = [x,y]
-        end
-
-        insn 'l', Real, Real do |canvas, x,y|
-            if canvas.gs.current_path.empty?
-                raise InvalidPathError, "No current point is defined"
-            end
+  class PDF::Instruction
+    insn 'm', Real, Real do |canvas, x, y|
+      canvas.gs.current_path << (subpath = Graphics::Path.new)
+      subpath.current_point = [x, y]
+    end
 
-            subpath = canvas.gs.current_path.last
+    insn 'l', Real, Real do |canvas, x, y|
+      if canvas.gs.current_path.empty?
+        raise InvalidPathError, "No current point is defined"
+      end
 
-            from = subpath.current_point
-            to = [x,y]
-            subpath.add_segment(Graphics::Path::Line.new(from, to))
-        end
+      subpath = canvas.gs.current_path.last
 
-        insn 'h' do |canvas|
-            unless canvas.gs.current_path.empty?
-                subpath = canvas.gs.current_path.last
-                subpath.close! unless subpath.is_closed?
-            end
-        end
+      from = subpath.current_point
+      to = [x, y]
+      subpath.add_segment(Graphics::Path::Line.new(from, to))
+    end
 
-        insn 're', Real, Real, Real, Real do |canvas, x,y,width,height|
-            tx = x + width
-            ty = y + height
-            canvas.gs.current_path << (subpath = Graphics::Path.new)
-            subpath.segments << Graphics::Path::Line.new([x,y], [tx,y])
-            subpath.segments << Graphics::Path::Line.new([tx,y], [tx, ty])
-            subpath.segments << Graphics::Path::Line.new([tx, ty], [x, ty])
-            subpath.close!
-        end
+    insn 'h' do |canvas|
+      unless canvas.gs.current_path.empty?
+        subpath = canvas.gs.current_path.last
+        subpath.close! unless subpath.is_closed?
+      end
+    end
 
-        insn 'S' do |canvas|
-            canvas.stroke_path
-        end
+    insn 're', Real, Real, Real, Real do |canvas, x, y, width, height|
+      tx = x + width
+      ty = y + height
+      canvas.gs.current_path << (subpath = Graphics::Path.new)
+      subpath.segments << Graphics::Path::Line.new([x, y], [tx, y])
+      subpath.segments << Graphics::Path::Line.new([tx, y], [tx, ty])
+      subpath.segments << Graphics::Path::Line.new([tx, ty], [x, ty])
+      subpath.close!
+    end
 
-        insn 's' do |canvas|
-            canvas.gs.current_path.last.close!
-            canvas.stroke_path
-        end
+    insn 'S' do |canvas|
+      canvas.stroke_path
+    end
 
-        insn 'f' do |canvas|
-            canvas.fill_path
-        end
+    insn 's' do |canvas|
+      canvas.gs.current_path.last.close!
+      canvas.stroke_path
+    end
 
-        insn 'F' do |canvas|
-            canvas.fill_path
-        end
+    insn 'f' do |canvas|
+      canvas.fill_path
+    end
 
-        insn 'f*' do |canvas|
-            canvas.fill_path
-        end
+    insn 'F' do |canvas|
+      canvas.fill_path
+    end
 
-        insn 'B' do |canvas|
-            canvas.fill_path
-            canvas.stroke_path
-        end
+    insn 'f*' do |canvas|
+      canvas.fill_path
+    end
 
-        insn 'B*' do |canvas|
-            canvas.fill_path
-            canvas.stroke_path
-        end
+    insn 'B' do |canvas|
+      canvas.fill_path
+      canvas.stroke_path
+    end
 
-        insn 'b' do |canvas|
-            canvas.gs.current_path.last.close!
-            canvas.fill_path
-            canvas.stroke_path
-        end
+    insn 'B*' do |canvas|
+      canvas.fill_path
+      canvas.stroke_path
+    end
 
-        insn 'b*' do |canvas|
-            canvas.gs.current_path.last.close!
-            canvas.fill_path
-            canvas.stroke_path
-        end
+    insn 'b' do |canvas|
+      canvas.gs.current_path.last.close!
+      canvas.fill_path
+      canvas.stroke_path
+    end
 
-        insn 'n'
+    insn 'b*' do |canvas|
+      canvas.gs.current_path.last.close!
+      canvas.fill_path
+      canvas.stroke_path
     end
 
+    insn 'n'
+  end
 end

data/lib/origami/graphics/patterns.rb

@@ -1,174 +1,170 @@
-=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
+  module Graphics
+    module Pattern
+      module Type
+        TILING = 1
+        SHADING = 2
+      end
+
+      def self.included(receiver)
+        receiver.field :Type, Type: Name, Default: :Pattern
+        receiver.field :PatternType, Type: Integer, Required: true
+      end
+
+      class Tiling < ContentStream
+        include Pattern
+        include ResourcesHolder
+
+        module PaintType
+          COLOURED = 1
+          UNCOLOURED = 2
+        end
+
+        module Type
+          CONSTANT_SPACING = 1
+          NO_DISTORTION = 2
+          CONSTANT_SPACING_AND_FASTER_TILING = 3
+        end
 
-    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.
+        field :PatternType, Type: Integer, Default: Pattern::Type::TILING, Required: true
+        field :PaintType, Type: Integer, Required: true
+        field :TilingType, Type: Integer, Required: true
+        field :BBox, Type: Rectangle, Required: true
+        field :XStep, Type: Number, Required: true
+        field :YStep, Type: Number, Required: true
+        field :Resources, Type: Resources, Required: true
+        field :Matrix, Type: Array.of(Number, length: 6), Default: [1, 0, 0, 1, 0, 0]
+      end
+
+      class Shading < Dictionary
+        include StandardObject
+        include Pattern
+
+        module Type
+          FUNCTION_BASED = 1
+          AXIAL = 2
+          RADIAL = 3
+          FREEFORM_TRIANGLE_MESH = 4
+          LATTICEFORM_TRIANGLE_MESH = 5
+          COONS_PATCH_MESH = 6
+          TENSORPRODUCT_PATCH_MESH = 7
+        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.
+        field :PatternType, Type: Integer, Default: Pattern::Type::SHADING, Required: true
+        field :Shading, Type: [Dictionary, Stream], Required: true
+        field :Matrix, Type: Array.of(Number, length: 6), Default: [1, 0, 0, 1, 0, 0]
+        field :ExtGState, Type: ExtGState
+
+        # Fields common to all shading objects.
+        module ShadingObject
+          def self.included(receiver)
+            receiver.field :ShadingType, Type: Integer, Required: true
+            receiver.field :ColorSpace, Type: [Name, Array], Required: true
+            receiver.field :Background, Type: Array
+            receiver.field :BBox, Type: Rectangle
+            receiver.field :AntiAlias, Type: Boolean, Default: false
+          end
+        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/>.
+        # Fields common to all Mesh shadings.
+        module Mesh
+          def self.included(receiver)
+            receiver.field :BitsPerCoordinate, Type: Integer, Required: true
+            receiver.field :BitsPerComponent, Type: Integer, Required: true
+            receiver.field :Decode, Type: Array.of(Number), Required: true
+            receiver.field :Function, Type: [Dictionary, Stream]
+          end
+        end
 
-=end
+        class FunctionBased < Dictionary
+          include StandardObject
+          include ShadingObject
 
-module Origami
+          field :ShadingType, Type: Integer, Default: Shading::Type::FUNCTION_BASED, Required: true
+          field :Domain, Type: Array.of(Number, length: 4), Default: [0.0, 1.0, 0.0, 1.0]
+          field :Matrix, Type: Array.of(Number, length: 6), Default: [1, 0, 0, 1, 0, 0]
+          field :Function, Type: [Dictionary, Stream], Required: true
+        end
 
-    module Graphics
-
-        module Pattern
-            module Type
-                TILING  = 1
-                SHADING = 2
-            end
-
-            def self.included(receiver)
-                receiver.field  :Type,          :Type => Name, :Default => :Pattern
-                receiver.field  :PatternType,   :Type => Integer, :Required => true
-            end
-
-            class Tiling < ContentStream
-                include Pattern
-                include ResourcesHolder
-
-                module PaintType
-                    COLOURED    = 1
-                    UNCOLOURED  = 2
-                end
-
-                module Type
-                    CONSTANT_SPACING                    = 1
-                    NO_DISTORTION                       = 2
-                    CONSTANT_SPACING_AND_FASTER_TILING  = 3
-                end
-
-                field   :PatternType,           :Type => Integer, :Default => Pattern::Type::TILING, :Required => true
-                field   :PaintType,             :Type => Integer, :Required => true
-                field   :TilingType,            :Type => Integer, :Required => true
-                field   :BBox,                  :Type => Rectangle, :Required => true
-                field   :XStep,                 :Type => Number, :Required => true
-                field   :YStep,                 :Type => Number, :Required => true
-                field   :Resources,             :Type => Resources, :Required => true
-                field   :Matrix,                :Type => Array.of(Number, length: 6), :Default => [ 1, 0, 0, 1, 0, 0 ]
-            end
-
-            class Shading < Dictionary
-                include StandardObject
-                include Pattern
-
-                module Type
-                    FUNCTION_BASED              = 1
-                    AXIAL                       = 2
-                    RADIAL                      = 3
-                    FREEFORM_TRIANGLE_MESH      = 4
-                    LATTICEFORM_TRIANGLE_MESH   = 5
-                    COONS_PATCH_MESH            = 6
-                    TENSORPRODUCT_PATCH_MESH    = 7
-                end
-
-                field   :PatternType,           :Type => Integer, :Default => Pattern::Type::SHADING, :Required => true
-                field   :Shading,               :Type => [ Dictionary, Stream ], :Required => true
-                field   :Matrix,                :Type => Array.of(Number, length: 6), :Default => [ 1, 0, 0, 1, 0, 0 ]
-                field   :ExtGState,             :Type => ExtGState
-
-                # Fields common to all shading objects.
-                module ShadingObject
-                    def self.included(receiver)
-                        receiver.field   :ShadingType,         :Type => Integer, :Required => true
-                        receiver.field   :ColorSpace,          :Type => [ Name, Array ], :Required => true
-                        receiver.field   :Background,          :Type => Array
-                        receiver.field   :BBox,                :Type => Rectangle
-                        receiver.field   :AntiAlias,           :Type => Boolean, :Default => false
-                    end
-                end
-
-                # Fields common to all Mesh shadings.
-                module Mesh
-                    def self.included(receiver)
-                        receiver.field   :BitsPerCoordinate,   :Type => Integer, :Required => true
-                        receiver.field   :BitsPerComponent,    :Type => Integer, :Required => true
-                        receiver.field   :Decode,              :Type => Array.of(Number), :Required => true
-                        receiver.field   :Function,            :Type => [ Dictionary, Stream ]
-                    end
-                end
-
-                class FunctionBased < Dictionary
-                    include StandardObject
-                    include ShadingObject
-
-                    field   :ShadingType,         :Type => Integer, :Default => Shading::Type::FUNCTION_BASED, :Required => true
-                    field   :Domain,              :Type => Array.of(Number, length: 4), :Default => [ 0.0, 1.0, 0.0, 1.0 ]
-                    field   :Matrix,              :Type => Array.of(Number, length: 6), :Default => [ 1, 0, 0, 1, 0, 0 ]
-                    field   :Function,            :Type => [ Dictionary, Stream ], :Required => true
-                end
-
-                class Axial < Dictionary
-                    include StandardObject
-                    include ShadingObject
-
-                    field   :ShadingType,         :Type => Integer, :Default => Shading::Type::AXIAL, :Required => true
-                    field   :Coords,              :Type => Array.of(Number, length: 4), :Required => true
-                    field   :Domain,              :Type => Array.of(Number, length: 2), :Default => [ 0.0, 1.0 ]
-                    field   :Function,            :Type => [ Dictionary, Stream ], :Required => true
-                    field   :Extend,              :Type => Array.of(Boolean, length: 2), :Default => [ false, false ]
-                end
-
-                class Radial < Dictionary
-                    include StandardObject
-                    include ShadingObject
-
-                    field   :ShadingType,         :Type => Integer, :Default => Shading::Type::RADIAL, :Required => true
-                    field   :Coords,              :Type => Array.of(Number, length: 6), :Required => true
-                    field   :Domain,              :Type => Array.of(Number, length: 2), :Default => [ 0.0, 1.0 ]
-                    field   :Function,            :Type => [ Dictionary, Stream ], :Required => true
-                    field   :Extend,              :Type => Array.of(Boolean, length: 2), :Default => [ false, false ]
-                end
-
-                class FreeFormTriangleMesh < Stream
-                    include ShadingObject
-                    include Mesh
-
-                    field   :ShadingType,         :Type => Integer, :Default => Shading::Type::FREEFORM_TRIANGLE_MESH, :Required => true
-                    field   :BitsPerFlag,         :Type => Integer, :Required => true
-                end
-
-                class LatticeFormTriangleMesh < Stream
-                    include ShadingObject
-                    include Mesh
-
-                    field   :ShadingType,         :Type => Integer, :Default => Shading::Type::LATTICEFORM_TRIANGLE_MESH, :Required => true
-                    field   :VerticesPerRow,      :Type => Integer, :Required => true
-                end
-
-                class CoonsPathMesh < Stream
-                    include ShadingObject
-                    include Mesh
-
-                    field   :ShadingType,         :Type => Integer, :Default => Shading::Type::COONS_PATCH_MESH, :Required => true
-                    field   :BitsPerFlag,         :Type => Integer, :Required => true
-                end
-
-                class TensorProductPatchMesh < Stream
-                    include ShadingObject
-
-                    field   :ShadingType,         :Type => Integer, :Default => Shading::Type::TENSORPRODUCT_PATCH_MESH, :Required => true
-                    field   :BitsPerFlag,         :Type => Integer, :Required => true
-                end
-            end
+        class Axial < Dictionary
+          include StandardObject
+          include ShadingObject
 
+          field :ShadingType, Type: Integer, Default: Shading::Type::AXIAL, Required: true
+          field :Coords, Type: Array.of(Number, length: 4), Required: true
+          field :Domain, Type: Array.of(Number, length: 2), Default: [0.0, 1.0]
+          field :Function, Type: [Dictionary, Stream], Required: true
+          field :Extend, Type: Array.of(Boolean, length: 2), Default: [false, false]
         end
-    end
 
-    class PDF::Instruction
-        insn 'sh',  Name do |canvas, shading|
-            canvas.paint_shading(shading)
+        class Radial < Dictionary
+          include StandardObject
+          include ShadingObject
+
+          field :ShadingType, Type: Integer, Default: Shading::Type::RADIAL, Required: true
+          field :Coords, Type: Array.of(Number, length: 6), Required: true
+          field :Domain, Type: Array.of(Number, length: 2), Default: [0.0, 1.0]
+          field :Function, Type: [Dictionary, Stream], Required: true
+          field :Extend, Type: Array.of(Boolean, length: 2), Default: [false, false]
+        end
+
+        class FreeFormTriangleMesh < Stream
+          include ShadingObject
+          include Mesh
+
+          field :ShadingType, Type: Integer, Default: Shading::Type::FREEFORM_TRIANGLE_MESH, Required: true
+          field :BitsPerFlag, Type: Integer, Required: true
+        end
+
+        class LatticeFormTriangleMesh < Stream
+          include ShadingObject
+          include Mesh
+
+          field :ShadingType, Type: Integer, Default: Shading::Type::LATTICEFORM_TRIANGLE_MESH, Required: true
+          field :VerticesPerRow, Type: Integer, Required: true
+        end
+
+        class CoonsPathMesh < Stream
+          include ShadingObject
+          include Mesh
+
+          field :ShadingType, Type: Integer, Default: Shading::Type::COONS_PATCH_MESH, Required: true
+          field :BitsPerFlag, Type: Integer, Required: true
+        end
+
+        class TensorProductPatchMesh < Stream
+          include ShadingObject
+
+          field :ShadingType, Type: Integer, Default: Shading::Type::TENSORPRODUCT_PATCH_MESH, Required: true
+          field :BitsPerFlag, Type: Integer, Required: true
         end
+      end
     end
+  end
 
+  class PDF::Instruction
+    insn 'sh', Name do |canvas, shading|
+      canvas.paint_shading(shading)
+    end
+  end
 end