File: patterns.rb

package info (click to toggle)
ruby-prawn 2.5.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,528 kB
  • sloc: ruby: 17,688; sh: 43; makefile: 20
file content (389 lines) | stat: -rw-r--r-- 15,624 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
# frozen_string_literal: true

require 'digest/sha1'

module Prawn
  module Graphics
    # Implements axial & radial gradients.
    module Patterns
      # Gradient color stop.
      # @private
      GradientStop = Struct.new(:position, :color)

      # @private
      Gradient = Struct.new(
        :type, :apply_transformations, :stops, :from, :to, :r1, :r2,
      )

      # @group Stable API

      # Sets the fill gradient.
      #
      # @overload fill_gradient(from, to, color1, color2, apply_margin_options: false)
      #   Set an axial (linear) fill gradient.
      #
      #   @param from [Array(Number, Number)]
      #     Starting point of the gradient.
      #   @param to [Array(Number, Number)] ending point of the gradient.
      #   @param color1 [Color] starting color of the gradient.
      #   @param color2 [Color] ending color of the gradient.
      #   @param apply_transformations [Boolean] (false)
      #     If set `true`, will transform the gradient's co-ordinate space so it
      #     matches the current co-ordinate space of the document. This option
      #     will be the default from Prawn v3, and is default `true` if you use
      #     the all-keyword version of this method. The default for the
      #     positional arguments version (this one), `false`, will mean if you
      #     (for example) scale your document by 2 and put a gradient inside,
      #     you will have to manually multiply your co-ordinates by 2 so the
      #     gradient is correctly positioned.
      #   @return [void]
      #
      # @overload fill_gradient(from, r1, to, r2, color1, color2, apply_margin_options: false)
      #   Set a radial fill gradient.
      #
      #   @param from [Array(Number, Number)]
      #     Starting point of the gradient.
      #   @param r1 [Number]
      #     Radius of the starting circle of a radial gradient.  The circle is
      #     centered at `from`.
      #   @param to [Array(Number, Number)]
      #     Ending point of the gradient.
      #   @param r2 [Number]
      #     Radius of the ending circle of a radial gradient.  The circle is
      #     centered at `to`.
      #   @param color1 [Color]
      #     Starting color.
      #   @param color2 [Color]
      #     Ending color.
      #   @param apply_transformations [Boolean] (false)
      #     If set `true`, will transform the gradient's co-ordinate space so it
      #     matches the current co-ordinate space of the document. This option
      #     will be the default from Prawn v3, and is default `true` if you use
      #     the all-keyword version of this method. The default for the
      #     positional arguments version (this one), `false`, will mean if you
      #     (for example) scale your document by 2 and put a gradient inside,
      #     you will have to manually multiply your co-ordinates by 2 so the
      #     gradient is correctly positioned.
      #   @return [void]
      #
      # @overload fill_gradient(from:, to:, r1: nil, r2: nil, stops:, apply_margin_options: true)
      #   Set the fill gradient.
      #
      #   @example Draw a horizontal axial gradient that starts at red on the left and ends at blue on the right
      #     fill_gradient from: [0, 0], to: [100, 0], stops: ['ff0000', '0000ff']
      #
      #   @example Draw a horizontal radial gradient that starts at red, is green 80% through, and finishes blue
      #     fill_gradient from: [0, 0], r1: 0, to: [100, 0], r2: 180,
      #       stops: { 0 => 'ff0000', 0.8 => '00ff00', 1 => '0000ff' }
      #
      #   @param from [Array(Number, Number)]
      #     Starting point of the gradient.
      #   @param r1 [Number, nil]
      #     Radius of the starting circle of a radial gradient. The circle is
      #     centered at `from`. If omitted a linear gradient will be produced.
      #   @param to [Array(Number, Number)]
      #     Ending point of the gradient.
      #   @param r2 [Number, nil]
      #     Radius of the ending circle of a radial gradient.  The circle is
      #     centered at `to`.
      #   @param stops [Array<Color>, Hash{Number => Color}]
      #     Color stops. Each stop is either just a color, in which case the
      #     stops will be evenly distributed across the gradient, or a hash
      #     where the key is a position between 0 and 1 indicating what distance
      #     through the gradient the color should change, and the value is
      #     a color.
      #   @param apply_transformations [Boolean] (true)
      #     If set `true`, will transform the gradient's co-ordinate space so it
      #     matches the current co-ordinate space of the document. This option
      #     will be the default from Prawn v3, and is default `true` if you use
      #     the all-keyword version of this method (this one). The default for
      #     the old arguments format, `false`, will mean if you (for example)
      #     scale your document by 2 and put a gradient inside, you will have to
      #     manually multiply your co-ordinates by 2 so the gradient is
      #     correctly positioned.
      #   @return [void]
      def fill_gradient(*args, **kwargs)
        set_gradient(:fill, *args, **kwargs)
      end

      # Sets the stroke gradient.
      #
      # @overload fill_gradient(from, to, color1, color2, apply_margin_options: false)
      #   Set an axial (linear) stroke gradient.
      #
      #   @param from [Array(Number, Number)]
      #     Starting point of the gradient.
      #   @param to [Array(Number, Number)] ending point of the gradient.
      #   @param color1 [Color] starting color of the gradient.
      #   @param color2 [Color] ending color of the gradient.
      #   @param apply_transformations [Boolean] (false)
      #     If set `true`, will transform the gradient's co-ordinate space so it
      #     matches the current co-ordinate space of the document. This option
      #     will be the default from Prawn v3, and is default `true` if you use
      #     the all-keyword version of this method. The default for the
      #     positional arguments version (this one), `false`, will mean if you
      #     (for example) scale your document by 2 and put a gradient inside,
      #     you will have to manually multiply your co-ordinates by 2 so the
      #     gradient is correctly positioned.
      #   @return [void]
      #
      # @overload fill_gradient(from, r1, to, r2, color1, color2, apply_margin_options: false)
      #   Set a radial stroke gradient.
      #
      #   @param from [Array(Number, Number)]
      #     Starting point of the gradient.
      #   @param r1 [Number]
      #     Radius of the starting circle of a radial gradient.  The circle is
      #     centered at `from`.
      #   @param to [Array(Number, Number)]
      #     Ending point of the gradient.
      #   @param r2 [Number]
      #     Radius of the ending circle of a radial gradient.  The circle is
      #     centered at `to`.
      #   @param color1 [Color]
      #     Starting color.
      #   @param color2 [Color]
      #     Ending color.
      #   @param apply_transformations [Boolean] (false)
      #     If set `true`, will transform the gradient's co-ordinate space so it
      #     matches the current co-ordinate space of the document. This option
      #     will be the default from Prawn v3, and is default `true` if you use
      #     the all-keyword version of this method. The default for the
      #     positional arguments version (this one), `false`, will mean if you
      #     (for example) scale your document by 2 and put a gradient inside,
      #     you will have to manually multiply your co-ordinates by 2 so the
      #     gradient is correctly positioned.
      #   @return [void]
      #
      # @overload fill_gradient(from:, to:, r1: nil, r2: nil, stops:, apply_margin_options: true)
      #   Set the stroke gradient.
      #
      #   @example Draw a horizontal axial gradient that starts at red on the left and ends at blue on the right
      #     stroke_gradient from: [0, 0], to: [100, 0], stops: ['ff0000', '0000ff']
      #
      #   @example Draw a horizontal radial gradient that starts at red, is green 80% through, and finishes blue
      #     stroke_gradient from: [0, 0], r1: 0, to: [100, 0], r2: 180,
      #       stops: { 0 => 'ff0000', 0.8 => '00ff00', 1 => '0000ff' }
      #
      #   @param from [Array(Number, Number)]
      #     Starting point of the gradient.
      #   @param r1 [Number, nil]
      #     Radius of the starting circle of a radial gradient. The circle is
      #     centered at `from`. If omitted a linear gradient will be produced.
      #   @param to [Array(Number, Number)]
      #     Ending point of the gradient.
      #   @param r2 [Number, nil]
      #     Radius of the ending circle of a radial gradient.  The circle is
      #     centered at `to`.
      #   @param stops [Array<Color>, Hash{Number => Color}]
      #     Color stops. Each stop is either just a color, in which case the
      #     stops will be evenly distributed across the gradient, or a hash
      #     where the key is a position between 0 and 1 indicating what distance
      #     through the gradient the color should change, and the value is
      #     a color.
      #   @param apply_transformations [Boolean] (true)
      #     If set `true`, will transform the gradient's co-ordinate space so it
      #     matches the current co-ordinate space of the document. This option
      #     will be the default from Prawn v3, and is default `true` if you use
      #     the all-keyword version of this method (this one). The default for
      #     the old arguments format, `false`, will mean if you (for example)
      #     scale your document by 2 and put a gradient inside, you will have to
      #     manually multiply your co-ordinates by 2 so the gradient is
      #     correctly positioned.
      #   @return [void]
      def stroke_gradient(*args, **kwargs)
        set_gradient(:stroke, *args, **kwargs)
      end

      private

      def set_gradient(type, *grad, **kwargs)
        gradient = parse_gradient_arguments(*grad, **kwargs)

        patterns = page.resources[:Pattern] ||= {}

        registry_key = gradient_registry_key(gradient)

        unless patterns.key?("SP#{registry_key}")
          shading = gradient_registry[registry_key]
          unless shading
            shading = create_gradient_pattern(gradient)
            gradient_registry[registry_key] = shading
          end

          patterns["SP#{registry_key}"] = shading
        end

        operator =
          case type
          when :fill
            'scn'
          when :stroke
            'SCN'
          else
            raise ArgumentError, "unknown type '#{type}'"
          end

        set_color_space(type, :Pattern)
        renderer.add_content("/SP#{registry_key} #{operator}")
      end

      # rubocop: disable Metrics/ParameterLists
      def parse_gradient_arguments(
        *arguments, from: nil, to: nil, r1: nil, r2: nil, stops: nil,
        apply_transformations: nil
      )

        case arguments.length
        when 0
          apply_transformations = true if apply_transformations.nil?
        when 4
          from, to, *stops = arguments
        when 6
          from, r1, to, r2, *stops = arguments
        else
          raise ArgumentError, "Unknown type of gradient: #{arguments.inspect}"
        end

        if stops.length < 2
          raise ArgumentError, 'At least two stops must be specified'
        end

        stops =
          stops.map.with_index { |stop, index|
            case stop
            when Array, Hash
              position, color = stop
            else
              position = index / (Float(stops.length) - 1)
              color = stop
            end

            unless (0..1).cover?(position)
              raise ArgumentError, 'position must be between 0 and 1'
            end

            GradientStop.new(position, normalize_color(color))
          }

        if stops.first.position != 0
          raise ArgumentError, 'The first stop must have a position of 0'
        end
        if stops.last.position != 1
          raise ArgumentError, 'The last stop must have a position of 1'
        end

        if stops.map { |stop| color_type(stop.color) }.uniq.length > 1
          raise ArgumentError, 'All colors must be of the same color space'
        end

        Gradient.new(
          r1 ? :radial : :axial,
          apply_transformations,
          stops,
          from,
          to,
          r1,
          r2,
        )
      end
      # rubocop: enable Metrics/ParameterLists

      def gradient_registry_key(gradient)
        _x1, _y1, x2, y2, transformation = gradient_coordinates(gradient)

        key = [
          gradient.type.to_s,
          transformation,
          x2, y2,
          gradient.r1 || -1, gradient.r2 || -1,
          gradient.stops.length,
          gradient.stops.map { |s| [s.position, s.color] },
        ].flatten
        Digest::SHA1.hexdigest(key.join(','))
      end

      def gradient_registry
        @gradient_registry ||= {}
      end

      def create_gradient_pattern(gradient)
        if gradient.apply_transformations.nil? &&
            current_transformation_matrix_with_translation(0, 0) !=
                [1, 0, 0, 1, 0, 0]
          warn(
            'Gradients in Prawn 2.x and lower are not correctly positioned ' \
              'when a transformation has been made to the document. ' \
              "Pass 'apply_transformations: true' to correctly transform the " \
              'gradient, or see ' \
              'https://github.com/prawnpdf/prawn/wiki/Gradient-Transformations ' \
              'for more information.',
          )
        end

        shader_stops =
          gradient.stops.each_cons(2).map { |first, second|
            ref!(
              FunctionType: 2,
              Domain: [0.0, 1.0],
              C0: first.color,
              C1: second.color,
              N: 1.0,
            )
          }

        # If there's only two stops, we can use the single shader.
        # Otherwise we stitch the multiple shaders together.
        shader =
          if shader_stops.length == 1
            shader_stops.first
          else
            ref!(
              FunctionType: 3, # stitching function
              Domain: [0.0, 1.0],
              Functions: shader_stops,
              Bounds: gradient.stops[1..-2].map(&:position),
              Encode: [0.0, 1.0] * shader_stops.length,
            )
          end

        x1, y1, x2, y2, transformation = gradient_coordinates(gradient)

        coords =
          if gradient.type == :axial
            [0, 0, x2 - x1, y2 - y1]
          else
            [0, 0, gradient.r1, x2 - x1, y2 - y1, gradient.r2]
          end

        shading = ref!(
          ShadingType: gradient.type == :axial ? 2 : 3,
          ColorSpace: color_space(gradient.stops.first.color),
          Coords: coords,
          Function: shader,
          Extend: [true, true],
        )

        ref!(
          PatternType: 2, # shading pattern
          Shading: shading,
          Matrix: transformation,
        )
      end

      def gradient_coordinates(gradient)
        x1, y1 = map_to_absolute(gradient.from)
        x2, y2 = map_to_absolute(gradient.to)

        transformation =
          if gradient.apply_transformations
            current_transformation_matrix_with_translation(x1, y1)
          else
            [1, 0, 0, 1, x1, y1]
          end

        [x1, y1, x2, y2, transformation]
      end
    end
  end
end