prawnpdf/prawn

View on GitHub
manual/graphics/graphics.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

# Examples for the Graphics package.

require_relative '../example_helper'

filename = File.basename(__FILE__).gsub('.rb', '.pdf')
Prawn::ManualBuilder::Example.generate(filename, page_size: 'FOLIO') do
  package 'graphics' do |p|
    p.section 'Basics' do |s|
      s.example 'helper'
      s.example 'fill_and_stroke'
    end

    p.section 'Shapes' do |s|
      s.example 'lines_and_curves'
      s.example 'common_lines'
      s.example 'rectangle'
      s.example 'polygon'
      s.example 'circle_and_ellipse'
    end

    p.section 'Fill and Stroke settings' do |s|
      s.example 'line_width'
      s.example 'stroke_cap'
      s.example 'stroke_join'
      s.example 'stroke_dash'
      s.example 'color'
      s.example 'gradients'
      s.example 'transparency'
      s.example 'soft_masks'
      s.example 'blend_mode'
      s.example 'fill_rules'
    end

    p.section 'Transformations' do |s|
      s.example 'rotate'
      s.example 'translate'
      s.example 'scale'
    end

    p.intro do
      prose <<-TEXT
        Here we show all the drawing methods provided by Prawn. Use them to draw
        the most beautiful imaginable things.

        Most of the content that you'll add to your pdf document will use the
        graphics package. Even text is rendered on a page just like a rectangle
        so even if you never use any of the shapes described here you should at
        least read the basic examples.

        The examples show:
      TEXT

      list(
        'All the possible ways that you can fill or stroke shapes on a page',
        'How to draw all the shapes that Prawn has to offer from a measly '\
          'line to a mighty polygon or ellipse',
        'The configuration options for stroking lines and filling shapes',
        'How to apply transformations to your drawing space'
      )
    end
  end
end