Extract manual building code

Squashed commit of the following: commit 24ee467 Author: Gregory Brown <gregory.t.brown@gmail.com> Date: Wed May 28 12:00:30 2014 -0400 Remove Prawn::Example namespace shim commit 1fbf5a1 Author: Gregory Brown <gregory.t.brown@gmail.com> Date: Wed May 28 11:45:41 2014 -0400 Minor tweaks to manual commit 488c129 Author: Gregory Brown <gregory.t.brown@gmail.com> Date: Tue May 27 12:13:42 2014 -0400 Use extracted prawn-manual_builder code The functionality of the manual should stay the same, we now just depend on an external gem rather than bundling the manual building code directly with Prawn. In theory, this will allow for the manual building code to be used by other extensions. In practice, some extra effort may be needed before that's practical.
prawnpdf · May 28, 2014 · 8b4fbd8 · 8b4fbd8
1 parent 1be9bd4
commit 8b4fbd8
Show file tree

Hide file tree

Showing 114 changed files with 126 additions and 796 deletions.
diff --git a/Rakefile b/Rakefile
@@ -32,7 +32,7 @@ desc "Generate the 'Prawn by Example' manual"
 task :manual do
   puts "Building manual..."
   require File.expand_path(File.join(File.dirname(__FILE__),
-    %w[manual manual manual]))
+    %w[manual contents]))
   puts "The Prawn manual is available at manual.pdf. Happy Prawning!"
 end
 

diff --git a/manual/absolute_position.pdf b/manual/absolute_position.pdf
diff --git a/manual/basic_concepts/adding_pages.rb b/manual/basic_concepts/adding_pages.rb
@@ -17,7 +17,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   text "We are still on the initial page for this example. Now I'll ask " +
        "Prawn to gently start a new page. Please follow me to the next page."
 

diff --git a/manual/basic_concepts/basic_concepts.rb b/manual/basic_concepts/basic_concepts.rb
@@ -2,10 +2,10 @@
 #
 # Examples for Prawn basic concepts.
 #
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
 
-Prawn::Example.generate("basic_concepts.pdf", :page_size => "FOLIO") do
+require_relative "../example_helper"
+
+Prawn::ManualBuilder::Example.generate("basic_concepts.pdf", :page_size => "FOLIO") do
 
   package "basic_concepts" do |p|
 

diff --git a/manual/basic_concepts/cursor.rb b/manual/basic_concepts/cursor.rb
@@ -16,7 +16,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
 
   text "the cursor is here: #{cursor}"

diff --git a/manual/basic_concepts/measurement.rb b/manual/basic_concepts/measurement.rb
@@ -15,7 +15,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   require "prawn/measurement_extensions"
 
   [:mm, :cm, :dm, :m, :in, :yd, :ft].each do |measurement|

diff --git a/manual/basic_concepts/origin.rb b/manual/basic_concepts/origin.rb
@@ -26,7 +26,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_axis
 
   stroke_circle [0, 0], 10

diff --git a/manual/basic_concepts/other_cursor_helpers.rb b/manual/basic_concepts/other_cursor_helpers.rb
@@ -13,7 +13,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   stroke_horizontal_rule
   pad(20) { text "Text padded both before and after." }
 

diff --git a/manual/bounding_box/bounding_box.rb b/manual/bounding_box/bounding_box.rb
@@ -5,7 +5,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
-Prawn::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
+Prawn::ManualBuilder::Example.generate("bounding_box.pdf", :page_size => "FOLIO") do
 
   package "bounding_box" do |p|
 

diff --git a/manual/bounding_box/bounds.rb b/manual/bounding_box/bounds.rb
@@ -21,7 +21,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   def print_coordinates
     text "top: #{bounds.top}"
     text "bottom: #{bounds.bottom}"

diff --git a/manual/bounding_box/canvas.rb b/manual/bounding_box/canvas.rb
@@ -14,7 +14,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   canvas do
     fill_circle [bounds.left, bounds.top],     30
     fill_circle [bounds.right, bounds.top],    30

diff --git a/manual/bounding_box/creation.rb b/manual/bounding_box/creation.rb
@@ -14,7 +14,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   bounding_box([200, cursor - 100], :width => 200, :height => 100) do
     text "Just your regular bounding box"
 

diff --git a/manual/bounding_box/indentation.rb b/manual/bounding_box/indentation.rb
@@ -11,7 +11,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   text "No indentation on the margin box."
   indent(20) do
     text "Some indentation inside an indent block."

diff --git a/manual/bounding_box/nesting.rb b/manual/bounding_box/nesting.rb
@@ -13,7 +13,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   def box_content(string)
     text string
     transparent(0.5) { stroke_bounds }

diff --git a/manual/bounding_box/russian_boxes.rb b/manual/bounding_box/russian_boxes.rb
@@ -8,7 +8,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   def combine(a1, a2)
     output = []
     a1.each do |i1|

diff --git a/manual/bounding_box/stretchy.rb b/manual/bounding_box/stretchy.rb
@@ -8,7 +8,7 @@
                                    %w[.. example_helper]))
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   y_position = cursor
   bounding_box([0, y_position], :width => 200, :height => 100) do
     text "This bounding box has a height of 100. If this text gets too large " +

diff --git a/manual/manual/manual.rb → manual/contents.rb b/manual/manual/manual.rb → manual/contents.rb
@@ -1,19 +1,16 @@
 # encoding: utf-8
 #
 # Generates the Prawn by example manual.
-#
 
-Encoding.default_external = Encoding::UTF_8
+require_relative "example_helper"
 
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+Encoding.default_external = Encoding::UTF_8
 
-Prawn::Example.generate("manual.pdf",
-                        :skip_page_creation => true,
-                        :page_size => "FOLIO") do
+Prawn::ManualBuilder::Example.generate("manual.pdf",
+  :skip_page_creation => true, :page_size => "FOLIO") do
 
-  load_page "cover"
-  load_page "how_to_read_this_manual"
+  load_page "", "cover"
+  load_page "", "how_to_read_this_manual"
 
   # Core chapters
   load_package "basic_concepts"

diff --git a/manual/manual/cover.rb → manual/cover.rb b/manual/manual/cover.rb → manual/cover.rb
@@ -2,11 +2,11 @@
 #
 # Prawn manual how to read this manual page.
 #
-require File.expand_path(File.join(File.dirname(__FILE__),
-                                   %w[.. example_helper]))
+
+require_relative "example_helper"
 
 filename = File.basename(__FILE__).gsub('.rb', '.pdf')
-Prawn::Example.generate(filename) do
+Prawn::ManualBuilder::Example.generate(filename) do
   move_down 200
 
   image "#{Prawn::DATADIR}/images/prawn.png",

diff --git a/manual/document_and_page_options/document_and_page_options.rb b/manual/document_and_page_options/document_and_page_options.rb
@@ -5,7 +5,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__),
                                    %w[.. example_helper]))
 
-Prawn::Example.generate("document_and_page_options.pdf",
+Prawn::ManualBuilder::Example.generate("document_and_page_options.pdf",
                         :page_size => "FOLIO") do
 
   package "document_and_page_options" do |p|

diff --git a/manual/example_file.rb b/manual/example_file.rb