prawn-manual_builder 0.3.1 → 0.4.0

data/lib/prawn/manual_builder/syntax_highlight.rb

@@ -1,55 +1,107 @@
-# encoding: utf-8
-
-require "coderay"
+# frozen_string_literal: true
 
 module Prawn
   module ManualBuilder
-    # Registers a to_prawn method on CodeRay. It returns an array of hashes to be
-    # used with formatted_text.
-    #
-    # Usage:
-    #
-    # CodeRay.scan(string, :ruby).to_prawn
-    #
-    class PrawnEncoder < CodeRay::Encoders::Encoder
-      register_for :to_prawn
-
-      COLORS = { :default           => "FFFFFF",
-                 
-                 :comment           => "AEAEAE",
-                 :constant          => "88A5D2",
-                 :instance_variable => "E8ED97",
-                 :integer           => "C8FF0E",
-                 :float             => "C8FF0E",
-                 :inline_delimiter  => "EF804F",  # #{} within a string
-                 :keyword           => "FEE100",
-                 
-                 # BUG: There appear to be some problem with this token. Method
-                 #      definitions are considered as ident tokens
-                 #
-                 :method            => "FF5C00",
-                 :string            => "56D65E",
-                 :symbol            => "C8FF0E" 
-               }
-
-      def setup(options)
-        super
-        @out  = []
-        @open = []
-      end
+    class SyntaxHighlight
+      DEFAULT_STYLE = { color: 'FFFFFF' }.freeze
+      STRING_STYLE = { color: '56D65E' }.freeze
+      COMMENT_STYPE = { color: 'AEAEAE' }.freeze
+      CONSTANT_STYLE = { color: '88A5D2' }.freeze
+      IVAR_STYLE = { color: 'E8ED97' }.freeze
+      NUMBER_STYLE = { color: 'C8FF0E' }.freeze
+      EMBEXPR_STYLE = { color: 'EF804F' }.freeze
+      KEYWORD_STYLE = { color: 'FEE100' }.freeze
+      SYMBOL_STYLE = { color: 'C8FF0E' }.freeze
+      METHOD_STYLE = { color: 'FF5C00' }.freeze
 
-      def text_token(text, kind)
-        color = COLORS[kind] || COLORS[@open.last] || COLORS[:default]
-        
-        @out << {:text => text, :color => color}
+      def initialize(code)
+        @code = code
       end
 
-      def begin_group(kind)
-        @open << kind
+      def to_prawn
+        tokens.each_with_index.map do |token, index|
+          style =
+            case token.type
+            when :STRING_BEGIN, :STRING_CONTENT, :STRING_END, :HEREDOC_START, :HEREDOC_END
+              STRING_STYLE
+            when :COMMENT
+              COMMENT_STYPE
+            when :CONSTANT
+              CONSTANT_STYLE
+            when :INSTANCE_VARIABLE
+              IVAR_STYLE
+            when :INTEGER, :FLOAT, :INTEGER_RATIONAL, :INTEGER_IMAGINARY
+              NUMBER_STYLE
+            when :EMBEXPR_BEGIN, :EMBEXPR_END
+              EMBEXPR_STYLE
+            when /\AKEYWORD_/
+              KEYWORD_STYLE
+            when :SYMBOL_BEGIN, :LABEL
+              SYMBOL_STYLE
+            when :IDENTIFIER
+              case tokens[index - 1].type
+              when :SYMBOL_BEGIN
+                SYMBOL_STYLE
+              when :DOT
+                METHOD_STYLE
+              else
+                DEFAULT_STYLE
+              end
+            else
+              DEFAULT_STYLE
+            end
+          { text: token.value.gsub(' ', Prawn::Text::NBSP) }.merge(style)
+        end
+        .compact
+        .each_with_object([]) do |fragment, fragments|
+          if fragments.empty?
+            fragments << fragment
+          elsif fragments.last.reject { |k, _| k == :text} == fragment.reject { |k, _| k == :text } || fragment[:text].match?(/\A[#{Prawn::Text::NBSP}\s\t\r\n]*\z/)
+            fragments.last[:text] << fragment[:text]
+          else
+            fragments << fragment
+          end
+        end
       end
 
-      def end_group(kind)
-        @open.pop
+      private
+
+      attr_reader :code
+
+      def tokens
+        @tokens ||=
+          begin
+            result = Prism.lex(code)
+            tokens =
+              result.value
+                .map(&:first) # Only tokens
+
+            # Add a BOF token to be able to not miss the whitespace at the beginning
+            tokens.prepend(Prism::Token.new(:PRAWN_BOF, '', Prism::Location.new(result.source, 0, 0)))
+
+            cursor = 0
+            # Add whitespace tokens
+            tokens
+              # Tokens are not sequential. Specifically, heredoc body is out of order.
+              # We don't want to add "backwards" whitespace tokens in that case.
+              .sort_by { |token| token.location.start_offset }
+              .each_cons(2)
+              .flat_map do |token, next_token|
+                if next_token.location.start_offset != token.location.end_offset
+                  ws_location = Prism::Location.new(
+                    result.source,
+                    token.location.end_offset,
+                    next_token.location.start_offset - token.location.end_offset
+                  )
+                  [
+                    token,
+                    Prism::Token.new(:PRAWN_WHITESPACE, ws_location.slice, ws_location)
+                  ]
+              else
+                  [token]
+                end
+              end
+          end
       end
     end
   end

data/lib/prawn/manual_builder/text_renderer.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Prawn
+  module ManualBuilder
+    class TextRenderer
+      def initialize(doc, &text)
+        @doc = doc
+        @text = text
+      end
+
+      def render
+        return unless text
+
+        instance_eval(&text)
+      end
+
+      private
+
+      attr_reader :doc, :text
+
+      def header(str)
+        doc.font(HEADER_FONT, size: HEADER_FONT_SIZE) do
+          str.split(/\n\n+/).each do |paragraph|
+            doc.text(
+              paragraph.gsub(/\s+/," "),
+              align: :justify,
+              inline_format: true,
+              leading: LEADING,
+              color: DARK_GRAY)
+
+            doc.move_down(RHYTHM)
+          end
+        end
+
+        doc.move_down(RHYTHM)
+      end
+
+      def header_with_bg(header_text = [], header_options = { final_gap: false })
+        if header_text.is_a?(String)
+          header_text = [{ text: header_text }]
+        end
+        header_text = header_text.map { |fragment| { font: HEADER_FONT, size: HEADER_FONT_SIZE }.merge(fragment) }
+        text_height = doc.height_of_formatted(header_text, header_options)
+
+        doc.bounding_box(
+          [-doc.bounds.absolute_left, doc.cursor + PAGE_MARGIN],
+          width: doc.bounds.absolute_left + doc.bounds.absolute_right,
+          height: PAGE_MARGIN * 2 + text_height
+        ) do
+          doc.fill_color(LIGHT_GRAY)
+          doc.fill_rectangle(
+            [doc.bounds.left, doc.bounds.top],
+            doc.bounds.right,
+            doc.bounds.top - doc.bounds.bottom
+          )
+          doc.fill_color(BLACK)
+
+          doc.bounding_box(
+            [PAGE_MARGIN + INNER_MARGIN, doc.bounds.top - PAGE_MARGIN],
+            width: doc.bounds.width - PAGE_MARGIN * 2 - INNER_MARGIN * 2,
+            height: text_height
+          ) do
+            doc.formatted_text(header_text, header_options)
+          end
+        end
+
+        doc.stroke_color(GRAY)
+        doc.stroke_horizontal_line(-doc.bounds.absolute_left, doc.bounds.width + doc.bounds.absolute_right, at: doc.cursor)
+        doc.stroke_color(BLACK)
+
+        doc.move_down(RHYTHM * 3)
+      end
+
+      def prose(str)
+        doc.font(TEXT_FONT, size: TEXT_FONT_SIZE) do
+          extra_markup(str).split(/\n\n+/).each do |paragraph|
+            doc.text(
+              paragraph.gsub(/\s+/," "),
+              align: :justify,
+              inline_format: true,
+              leading: LEADING,
+              color: DARK_GRAY)
+
+            doc.move_down(RHYTHM)
+          end
+        end
+
+        doc.move_down(RHYTHM)
+      end
+
+      def list(*items)
+        doc.move_up(RHYTHM)
+
+        doc.font("DejaVu", size: 11) do
+          items.each do |li|
+            doc.float { doc.text("\u2022", size: doc.font_size * 1.25) }
+            doc.indent(RHYTHM) do
+              doc.text(
+                extra_markup(li).gsub(/\s+/, ' '),
+                inline_format: true,
+                color: DARK_GRAY,
+                leading: LEADING
+              )
+            end
+
+            doc.move_down(RHYTHM / 2)
+          end
+
+          doc.move_down(RHYTHM / 2)
+        end
+      end
+
+      def ordered_list(*items)
+        doc.move_up(RHYTHM)
+
+        doc.font("DejaVu", size: 11) do
+          counter_width = (1..items.size).to_a.map { |i| doc.width_of("#{i}.") }.max
+          space_width = doc.width_of(' ')
+          items.each_with_index do |li, i|
+            doc.float do
+              doc.bounding_box([0, doc.cursor], width: counter_width) do
+                doc.text("#{i + 1}.", color: DARK_GRAY, align: :right)
+              end
+            end
+            doc.indent(counter_width + space_width) do
+              doc.text(
+                extra_markup(li).gsub(/\s+/, ' '),
+                inline_format: true,
+                color: DARK_GRAY,
+                leading: LEADING
+              )
+            end
+
+            doc.move_down(RHYTHM / 2)
+          end
+
+          doc.move_down(RHYTHM / 2)
+        end
+      end
+
+      def extra_markup(str)
+        str
+          .gsub(/<code>([^<]+?)<\/code>/, '<font name="Iosevka"><b>\1</b></font>') # Process the <code> tags
+          .gsub(URI::Parser.new.make_regexp(%w[http https])) do |match|
+            %(<color rgb="#{BLUE}"><link href="#{match}">#{match.gsub('/', "/#{Prawn::Text::ZWSP}")}</link></color>) # Process the links
+          end
+      end
+    end
+  end
+end

data/lib/prawn/manual_builder/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Prawn
+  module ManualBuilder
+    VERSION = '0.4.0'
+  end
+end

data/lib/prawn/manual_builder.rb

@@ -1,31 +1,40 @@
-require "enumerator"
-
 module Prawn
   module ManualBuilder
-    def self.manual_dir=(dir)
-      @manual_dir = dir
-    end
+    DATADIR = File.dirname(__FILE__) + "/../../data"
+    NOT_SET = Object.new.freeze
 
-    def self.manual_dir
-      @manual_dir || Dir.pwd
-    end
+    # Values used for the manual design:
 
-    def self.document_class
-      @document_class || Prawn::Document
-    rescue NameError
-      raise "Prawn::ManualBuilder.document_class was not set. "+
-            "Either assign a custom document class, or make sure to install "+
-            "and require the Prawn gem."
+    # Default margin
+    PAGE_MARGIN = 36
 
-    end
+    # Additional indentation to keep the line measure with a reasonable size
+    INNER_MARGIN = 30
 
-    DATADIR = File.dirname(__FILE__) + "/../../data"
+    # Vertical Rhythm settings
+    RHYTHM = 10
+    LEADING = 2
+
+    # Colors
+    BLACK = "000000"
+    LIGHT_GRAY = "F2F2F2"
+    GRAY = "DDDDDD"
+    DARK_GRAY = "333333"
+    BROWN = "A4441C"
+    ORANGE = "F28157"
+    LIGHT_GOLD = "FBFBBE"
+    DARK_GOLD = "EBE389"
+    BLUE = "0000D0"
+
+    HEADER_FONT = "DejaVu"
+    HEADER_FONT_SIZE = 18
+
+    CODE_FONT = 'Iosevka'
+    CODE_FONT_SIZE = 9
+
+    TEXT_FONT = 'DejaVu'
+    TEXT_FONT_SIZE = 10
   end
 end
 
-require_relative "manual_builder/example"
-require_relative "manual_builder/example_file"
-require_relative "manual_builder/example_section"
-require_relative "manual_builder/example_package"
-require_relative "manual_builder/syntax_highlight"
-require_relative "manual_builder/example"
+require_relative "manual_builder/manual"

metadata

@@ -1,34 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: prawn-manual_builder
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
-- Felipe Doria
-- Gregory Brown
-autorequire: 
+- Alexander Mankuta
+autorequire:
 bindir: bin
-cert_chain: []
-date: 2019-11-17 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIC+jCCAeKgAwIBAgIBAzANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhhbGV4
+  L0RDPXBvaW50bGVzcy9EQz1vbmUwHhcNMjMxMTA5MTA1MzIxWhcNMjQxMTA4MTA1
+  MzIxWjAjMSEwHwYDVQQDDBhhbGV4L0RDPXBvaW50bGVzcy9EQz1vbmUwggEiMA0G
+  CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDPOVLPGEK+eaP6zJfifrpWvPTg4qo3
+  XNJJPom80SwqX2hVCVsRDK4RYgKUQqKRQzHhlx14wZHwWLETBVbNDGX3uqyCnTWU
+  JUKh3ydiZShXpNHoV/NW7hhEYvNsDcBAjYTmbvXOhuYCo0Tz/0N2Oiun/0wIICtP
+  vytY9TY0/lklWjAbsqJjNOu3o8IYkJBAN/rU96E/6WhFwjnxLcTnV9RfFRXdjG5j
+  CughoB2xSwKX8gwbQ8fsnaZRmdyDGYNpz6sGF0zycfiLkTttbLA2nYATCALy98CH
+  nsyZNsTjb4WINCuY2yEDjwesw9f/ROkNC68EgQ5M+aMjp+D0WcYGfzojAgMBAAGj
+  OTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBRPgIwSVbeonua/
+  Ny/8576oxdUbrjANBgkqhkiG9w0BAQsFAAOCAQEAX28QLxNNz5EgaZZuQQUkbOXB
+  4b5luBO22535+Vgj2jw7yjV8KKoGMWKrnB00ijgntqPEPXCzaPNibOcPZV5WfWVS
+  t0Ls8lWE/8kezPwV4SbRe4Y7C+D4J+oirs0L5PtpREV9CJ7kfdW/AN9MtvjjBFlb
+  jHquD/MiOOMyHtuO0FiTL265m10thcAUsbyi0MehKgGbtJ5fGceHvZDqDouvbMjT
+  hoijFk1oTY939JhjdcHuJzMiS2TrqIw8Dr5DkQu2vAjHpw0aOOWhlRjNJ7RHYJNm
+  QugXmCnHQxSKTmc7imKuotyMdRRKFh8UEFCLRsFtBbNxkXyNuB4xBMuUYodhEw==
+  -----END CERTIFICATE-----
+date: 2024-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.7
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 description: A tool for writing manuals for Prawn and Prawn accessories
 email:
-- felipe.doria@gmail.com
-- gregory.t.brown@gmail.com
+- alex@pointless.one
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -38,22 +69,32 @@ files:
 - GPLv3
 - LICENSE
 - README.md
+- data/fonts/DejaVuSans-Bold.ttf
+- data/fonts/DejaVuSans-BoldOblique.ttf
+- data/fonts/DejaVuSans-Oblique.ttf
 - data/fonts/DejaVuSans.ttf
-- data/fonts/Dustismo_Roman.ttf
-- data/fonts/gkai00mp.ttf
+- data/fonts/Jigmo.ttf
+- data/fonts/Jigmo2.ttf
+- data/fonts/Jigmo3.ttf
+- data/fonts/Panic+Sans.dfont
+- data/fonts/iosevka-po-bold.ttf
+- data/fonts/iosevka-po-regular.ttf
 - lib/prawn/manual_builder.rb
-- lib/prawn/manual_builder/example.rb
-- lib/prawn/manual_builder/example_file.rb
-- lib/prawn/manual_builder/example_package.rb
-- lib/prawn/manual_builder/example_section.rb
+- lib/prawn/manual_builder/chapter.rb
+- lib/prawn/manual_builder/manual.rb
+- lib/prawn/manual_builder/part.rb
+- lib/prawn/manual_builder/peritext.rb
+- lib/prawn/manual_builder/section.rb
 - lib/prawn/manual_builder/syntax_highlight.rb
-homepage: 
+- lib/prawn/manual_builder/text_renderer.rb
+- lib/prawn/manual_builder/version.rb
+homepage:
 licenses:
 - PRAWN
 - GPL-2.0
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,15 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A tool for writing manuals for Prawn and Prawn accessories
 test_files: []

metadata.gz.sig

@@ -0,0 +1 @@
+����v��.%Y�a=�'^����M	�
�SJ�|�,U���~ef�Ii-$ĉ�s�7