prawn_components 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba3fe2c34017a0063369b7780dd3a3188a031eafc0845b3fe59b974bab47c4b1
+  data.tar.gz: c68115920c2bfdd0b171eb5b2f26b3d104eda194433081ecbbb9626811cccc81
+SHA512:
+  metadata.gz: d015bf6cd3808c464e2883cbe53c2f3096fb1d51b444f9b6a233ffd751041f20f78b1f0586cfb85fefd1bba17ef06f87232077ef140a4c889f1d3ace3ab621f3
+  data.tar.gz: 46c507ebd9f66925aa9d6b25a524722faad3762344212df77b86b3a62426130e890a598f58c6ebca8a9d30c6193ea9d4ffa0268c1c40d8139cdc1e1a9038a25e

data/lib/prawn_components/components/code_block.rb

@@ -0,0 +1,34 @@
+module PrawnComponents
+  module Components
+    module CodeBlock
+      def code_block(value, language)
+        formatter = Rouge::Formatters::Prawn.new
+        lexer = get_lexer(language)
+
+        default_leading(5)
+        span(540) do
+          move_down(5)
+          span(520, position: 10) do
+            move_down(10)
+            font 'Consolas' do
+              formatted_text(formatter.format(lexer.new.lex(value)))
+            end
+          end
+
+          move_down(30)
+        end
+
+        default_leading(5)
+      end
+
+      private
+
+      def get_lexer(language)
+        name = "Rouge::Lexers::#{language.capitalize}"
+        Object.const_get(name)
+      rescue NameError
+        Rouge::Lexers::Ruby
+      end
+    end
+  end
+end

data/lib/prawn_components/components/h1.rb

@@ -0,0 +1,20 @@
+module PrawnComponents
+  module Components
+    module H1
+      def h1(value, options = {})
+        callback = options.key?(:callback) ? options[:callback] : lambda { |x| x }
+
+        font('Helvetica') do
+          text(callback.call(value), size: 20, style: :bold, inline_format: true)
+        end
+        stroke do
+          move_down 10
+          stroke_color 'F2F5F8'
+          line_width 1
+          horizontal_line(0, 540)
+        end
+        move_down(20)
+      end
+    end
+  end
+end

data/lib/prawn_components/components/h2.rb

@@ -0,0 +1,14 @@
+module PrawnComponents
+  module Components
+    module H2
+      def h2(value, options = {})
+        callback = options.key?(:callback) ? options[:callback] : lambda { |x| x }
+
+        font('Helvetica') do
+          text(callback.call(value), size: 18, style: :bold, inline_format: true)
+        end
+        move_down(10)
+      end
+    end
+  end
+end

data/lib/prawn_components/components/h3.rb

@@ -0,0 +1,14 @@
+module PrawnComponents
+  module Components
+    module H3
+      def h3(value, options = {})
+        callback = options.key?(:callback) ? options[:callback] : lambda { |x| x }
+
+        font('Helvetica') do
+          text(callback.call(value), size: 16, style: :bold, inline_format: true)
+        end
+        move_down(10)
+      end
+    end
+  end
+end

data/lib/prawn_components/components/h4.rb

@@ -0,0 +1,14 @@
+module PrawnComponents
+  module Components
+    module H4
+      def h4(value, options = {})
+        callback = options.key?(:callback) ? options[:callback] : lambda { |x| x }
+
+        font('Helvetica') do
+          text(callback.call(value), size: 14, style: :bold, inline_format: true)
+        end
+        move_down(10)
+      end
+    end
+  end
+end

data/lib/prawn_components/components/ol.rb

@@ -0,0 +1,19 @@
+module PrawnComponents
+  module Components
+    module Ol
+      def ol(value, options = {})
+        value.each_with_index do |val, i|
+          start_new_page if value.last != val && cursor.to_i < 64
+          indent(31) do
+            parsed_value = options.key?(:callback) ? options[:callback].call(val) : val
+            text("#{i + 1}.\xC2\xA0\ #{parsed_value}", size: 13, inline_format: true, align: :justify)
+          end
+
+          move_down(5)
+        end
+
+        move_down(10)
+      end
+    end
+  end
+end

data/lib/prawn_components/components/paragraph.rb

@@ -0,0 +1,10 @@
+module PrawnComponents
+  module Components
+    module Paragraph
+      def paragraph(value)
+        text(value, size: 13, inline_format: true, align: :justify)
+        move_down(10)
+      end
+    end
+  end
+end

data/lib/prawn_components/components/quote.rb

@@ -0,0 +1,32 @@
+module PrawnComponents
+  module Components
+    module Quote
+      def quote(value, options = {})
+        callback = options.key?(:callback) ? options[:callback] : lambda { |x| x }
+        parsed_value = if value.is_a?(Array)
+          value.map { |e| [callback.call(e)] }
+        else
+          value.split("\n").map { |e| [callback.call(e)] }
+        end
+
+        quote_rows = parsed_value
+        text_color = '6A737D'
+        border_color = 'DFE2E5'
+        padding = [5, 0, 5, 15]
+        border_width = 3
+
+        table(quote_rows,
+          cell_style: { 
+            text_color: text_color, 
+            borders: [:left], 
+            border_color: border_color, 
+            border_width: border_width, 
+            padding: padding,
+            inline_format: true
+          }
+        )
+        move_down(20)
+      end
+    end
+  end
+end

data/lib/prawn_components/components/table_of_contents.rb

@@ -0,0 +1,78 @@
+# pdf.v1_table_of_contents(
+#   [
+#     [
+#       'Preface',
+#       {
+#         page: 1,
+#         headings: {
+#           'Introduction' => '2',
+#           'Chapter 1' => '3',
+#           'Chapter 2' => '4',
+#         }
+#       }
+#     ],
+#     [
+#       'Introduction',
+#       {
+#         page: 2,
+#         headings: {
+#           'Introduction' => '2',
+#           'Chapter 1' => '3',
+#           'Chapter 2' => '4',
+#         }
+#       }
+#     ]
+#   ]
+# )
+module PrawnComponents
+  module Components
+    module TableOfContents
+      def table_of_contents(value)
+        value.each do |(chapter_title, data)|
+          table_data = []
+          start_page = data[:page]
+          table_data << [
+            { content: chapter_title, font_style: :bold }, 
+            { content: start_page.to_s, font_style: :bold, align: :right }
+          ]
+          data[:headings].each do |(title, page)|
+            str = "\xC2\xA0\xC2\xA0\xC2\xA0\xC2\xA0#{title}\xC2\xA0\xC2\xA0"
+            line_size = 140
+            1.upto(line_size - str.size) do |i|
+              if i.odd?
+                str << "."
+              else
+                str << "\xC2\xA0"
+              end
+            end
+            length_indicator = data[:headings].keys.sort_by { |s| s.size }.reverse.first.size
+            diff = length_indicator - title.size
+
+            if diff > 0
+              next_diff = diff
+              next_diff = 2 if diff == 1
+              1.upto(next_diff + 1) do |i|
+                if i.odd?
+                  str << "\xC2\xA0"
+                else
+                  str << "."
+                end
+              end
+            end
+
+            table_data << [
+              { content: title }, 
+              { content: page.to_s, align: :right }
+            ]
+          end
+
+          table(table_data,
+            cell_style: { border_width: 0, padding: [10, 10, 5, 10] },
+            width: 560
+          )
+          move_down(30)
+        end
+      end
+    end
+  end
+end

data/lib/prawn_components/components/ul.rb

@@ -0,0 +1,19 @@
+module PrawnComponents
+  module Components
+    module Ul
+      def ul(value, options = {})
+        value.each_with_index do |val, i|
+          start_new_page if value.last != val && cursor.to_i < 64
+          indent(31) do
+            parsed_value = options.key?(:callback) ? options[:callback].call(val) : val
+            text("• #{parsed_value}", size: 13, inline_format: true, align: :justify)
+          end
+
+          move_down(5)
+        end
+
+        move_down(10)
+      end
+    end
+  end
+end

data/lib/prawn_components/version.rb

@@ -0,0 +1,9 @@
+module PrawnComponents
+  module Version
+    module_function
+
+    def to_s
+      "0.0.1"
+    end
+  end
+end

data/lib/prawn_components.rb

@@ -0,0 +1,77 @@
+require 'prawn/table'
+require 'prawn'
+require 'rouge'
+
+require_relative 'prawn_rouge_formatter/fragment'
+require_relative 'prawn_rouge_formatter/fragment_inline_block_styles'
+require_relative 'prawn_rouge_formatter/fragment_styles'
+require_relative 'prawn_rouge_formatter/rouge_theme_finder'
+require_relative 'prawn_rouge_formatter/normalize_color'
+require_relative 'prawn_rouge_formatter/rouge_theme_finder'
+require_relative 'prawn_rouge_formatter/parser_configuration'
+require_relative 'rouge/formatters/prawn'
+
+require_relative 'prawn_components/components/h1'
+require_relative 'prawn_components/components/h2'
+require_relative 'prawn_components/components/h3'
+require_relative 'prawn_components/components/h4'
+require_relative 'prawn_components/components/paragraph'
+require_relative 'prawn_components/components/code_block'
+require_relative 'prawn_components/components/quote'
+require_relative 'prawn_components/components/ul'
+require_relative 'prawn_components/components/ol'
+require_relative 'prawn_components/components/table_of_contents'
+
+Prawn::Document.class_eval do
+  include PrawnComponents::Components::H1
+  include PrawnComponents::Components::H2
+  include PrawnComponents::Components::H3
+  include PrawnComponents::Components::H4
+  include PrawnComponents::Components::Paragraph
+  include PrawnComponents::Components::CodeBlock
+  include PrawnComponents::Components::Quote
+  include PrawnComponents::Components::Ul
+  include PrawnComponents::Components::Ol
+  include PrawnComponents::Components::TableOfContents
+end
+
+module PrawnComponents
+  class << self
+    def initialize_fonts(pdf:)
+      dir = Gem::Specification.find_by_name('prawn_components').gem_dir
+      fonts_dir = "#{dir}/fonts/"
+
+      pdf.font_families.update(
+        "Helvetica" => {
+          bold: "#{fonts_dir}Helvetica-Bold.ttf",
+          italic: "#{fonts_dir}Helvetica-Oblique.ttf",
+          normal: "#{fonts_dir}Helvetica.ttf"
+        }
+      )
+
+      pdf.font_families.update(
+        "Consolas" => { 
+          bold: "#{fonts_dir}consolab.ttf",
+          italic: "#{fonts_dir}consolai.ttf",
+          normal: "#{fonts_dir}consola.ttf"
+        }
+      )
+
+      pdf.font_families.update(
+        "Georgia" => { 
+          bold: "#{fonts_dir}georgia-bold.ttf",
+          italic: "#{fonts_dir}georgia-italic.ttf",
+          normal: "#{fonts_dir}georgia.ttf"
+        }
+      )
+
+      pdf.font_families.update(
+        "Inter" => { 
+          bold: "#{fonts_dir}Inter-Bold.ttf",
+          normal: "#{fonts_dir}Inter-Regular.ttf",
+          italic: "#{fonts_dir}Inter-Italic.otf"
+        }
+      )
+    end
+  end
+end

data/lib/prawn_rouge_formatter/fragment.rb

@@ -0,0 +1,48 @@
+module PrawnRougeFormatter
+  class Fragment
+    def initialize(token, theme, value)
+      @token = token
+      @theme = theme
+      @value = value
+    end
+
+    def self.call(token:, theme:, value: nil)
+      new(token, theme, value).call
+    end
+
+    def call
+      return default_fragment unless style_rules
+
+      fragment = default_fragment
+
+      # if (bg = PrawnRougeFormatter::NormalizeColor.fetch(style_rules.bg)) && bg != @background_color
+        
+      #   fragment[:background_color] = bg
+
+      #   fragment = ::PrawnRougeFormatter::FragmentInlineBlockStyles.call(
+      #     options: fragment, token: @token, rules: style_rules
+      #   )
+      # end
+
+      if (fg = PrawnRougeFormatter::NormalizeColor.fetch(style_rules.fg))
+        fragment[:color] = fg
+      end
+
+      if styles = PrawnRougeFormatter::FragmentStyles.call(rules: style_rules)
+        fragment[:styles] = styles
+      end
+
+      fragment
+    end
+
+    private
+
+    def default_fragment
+      @value ? { text: @value, size: 13 } : {}
+    end
+
+    def style_rules
+      @style_rules ||= @theme.style_for(@token)
+    end
+  end
+end

data/lib/prawn_rouge_formatter/fragment_inline_block_styles.rb

@@ -0,0 +1,22 @@
+module PrawnRougeFormatter
+  class FragmentInlineBlockStyles
+    LineOrientedTokens = [
+      ::Rouge::Token::Tokens::Generic::Inserted,
+      ::Rouge::Token::Tokens::Generic::Deleted,
+      ::Rouge::Token::Tokens::Generic::Heading,
+      ::Rouge::Token::Tokens::Generic::Subheading
+    ]
+
+    def self.call(options:, token:, rules:)
+      if LineOrientedTokens.include? token
+        options[:inline_block] = true unless rules[:inline_block] == false
+        options[:extend] = true unless rules[:extend] == false
+      else
+        options[:inline_block] = true if rules[:inline_block]
+        options[:extend] = true if rules[:extend]
+      end
+
+      options
+    end
+  end
+end

data/lib/prawn_rouge_formatter/fragment_styles.rb

@@ -0,0 +1,10 @@
+module PrawnRougeFormatter
+  class FragmentStyles
+    def self.call(rules:)
+      styles = %i[italic underline].select { |s| rules[s] }
+      return if styles.size.zero?
+
+      styles.to_set
+    end
+  end
+end

data/lib/prawn_rouge_formatter/normalize_color.rb

@@ -0,0 +1,11 @@
+module PrawnRougeFormatter
+  class NormalizeColor
+    def self.fetch(code)
+      return unless code
+
+      normalized = (code.start_with? '#') ? code[1..-1] : code
+      normalized = normalized.each_char.map {|c| c * 2 }.join if normalized.length == 3
+      normalized
+    end
+  end
+end

data/lib/prawn_rouge_formatter/parser_configuration.rb

@@ -0,0 +1,13 @@
+Tokens = ::Rouge::Token::Tokens
+LineOrientedTokens = [
+  ::Rouge::Token::Tokens::Generic::Inserted,
+  ::Rouge::Token::Tokens::Generic::Deleted,
+  ::Rouge::Token::Tokens::Generic::Heading,
+  ::Rouge::Token::Tokens::Generic::Subheading
+]
+
+LF = %(\n)
+NoBreakSpace = %(\u00a0)
+InnerIndent = %(\n )
+GuardedIndent = %(\u00a0)
+GuardedInnerIndent = %(\n\u00a0)

data/lib/prawn_rouge_formatter/rouge_theme_finder.rb

@@ -0,0 +1,28 @@
+module PrawnRougeFormatter
+  class RougeThemeFinder
+    # Use Github theme by default
+    def initialize(options)
+      @options = options
+    end
+
+    def self.call(options = {})
+      new(options).call
+    end
+
+    def call(options = {})
+      (theme || default_theme).new
+    end
+
+    private
+
+    def default_theme
+      ::Rouge::Themes::Github
+    end
+
+    def theme
+      return unless @options[:theme]
+
+      ::Rouge::Theme.find(@options[:theme])
+    end
+  end
+end

data/lib/rouge/formatters/prawn.rb

@@ -0,0 +1,52 @@
+module Rouge
+  module Formatters
+    class Prawn < Formatter
+      tag 'prawn'
+
+      def initialize opts = {}
+        @theme = ::PrawnRougeFormatter::RougeThemeFinder.call(opts)
+        @linenum_fragment_base = create_fragment(
+          Tokens::Generic::Lineno
+        ).merge(linenum: true)
+      end
+
+      # Override format method so fragments don't get flatted to a string
+      # and to add an options Hash.
+      def format tokens, opts = {}
+        stream tokens, opts
+      end
+
+      def stream tokens, opts = {}
+        start_of_line = true
+        tokens.map do |tok, val|
+          # match one or more consecutive endlines
+          if val == LF || (val == (LF * val.length))
+            start_of_line = true
+            { text: val }
+          else
+            val[0] = GuardedIndent if start_of_line && (val.start_with? ' ')
+            val.gsub! InnerIndent, GuardedInnerIndent if val.include? InnerIndent
+            # QUESTION do we need the call to create_fragment if val contains only spaces? consider bg
+            #fragment = create_fragment tok, val
+            fragment = val.rstrip.empty? ? { text: val } : create_fragment(tok, val)
+            # NOTE we assume if the fragment ends in a line feed, the intention was to match a line-oriented form
+            fragment[:line_oriented] = true if (start_of_line = val.end_with? LF)
+            fragment
+          end
+        end
+      end
+
+      def create_linenum_fragment linenum
+        @linenum_fragment_base.merge text: %(#{linenum} )
+      end
+
+      private
+
+      def create_fragment(token, value = nil)
+        PrawnRougeFormatter::Fragment.call(
+          token: token, theme: @theme, value: value
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: prawn_components
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paweł Dąbrowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.30.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.30.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: Craft beautiful PDFs with Prawn and components
+email: contact@paweldabrowski.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- fonts/Helvetica-Bold.ttf
+- fonts/Helvetica-Oblique.ttf
+- fonts/Helvetica.ttf
+- fonts/Inter-Bold.ttf
+- fonts/Inter-Italic.otf
+- fonts/Inter-Regular.ttf
+- fonts/consola.ttf
+- fonts/consolab.ttf
+- fonts/consolai.ttf
+- fonts/georgia-bold.ttf
+- fonts/georgia-italic.ttf
+- fonts/georgia.ttf
+- lib/prawn_components.rb
+- lib/prawn_components/components/code_block.rb
+- lib/prawn_components/components/h1.rb
+- lib/prawn_components/components/h2.rb
+- lib/prawn_components/components/h3.rb
+- lib/prawn_components/components/h4.rb
+- lib/prawn_components/components/ol.rb
+- lib/prawn_components/components/paragraph.rb
+- lib/prawn_components/components/quote.rb
+- lib/prawn_components/components/table_of_contents.rb
+- lib/prawn_components/components/ul.rb
+- lib/prawn_components/version.rb
+- lib/prawn_rouge_formatter/fragment.rb
+- lib/prawn_rouge_formatter/fragment_inline_block_styles.rb
+- lib/prawn_rouge_formatter/fragment_styles.rb
+- lib/prawn_rouge_formatter/normalize_color.rb
+- lib/prawn_rouge_formatter/parser_configuration.rb
+- lib/prawn_rouge_formatter/rouge_theme_finder.rb
+- lib/rouge/formatters/prawn.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Craft beautiful PDFs with Prawn and components
+test_files: []