prawn-manual_builder 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b92c79c06eb6b0de91b5b541d5f948d45594e142
-  data.tar.gz: 728bbb45d003b2c8c6a98a5e0ebb0c0dc83ba928
+  metadata.gz: e049e1cd01093d886d6fdff3d0a20aec5f585574
+  data.tar.gz: 7c29632aca25f3ca567681a5ff847eb170a0bf2e
 SHA512:
-  metadata.gz: 80bf1683a3c617881d099cccc8b7e551400a43c959b091171a18561815d6d766f15b70af7e73e7cbc12a07c129a8c154fb43b755b99346f58f662c6869773cfa
-  data.tar.gz: 521f4848da775d933160a2b1d8b460e7c17a598310c99a91469366147a42ae29288009bb259991130fb5cbd20c0c1611fc4d35e99b1bb2d36f475aaf13a93da8
+  metadata.gz: 63ca7f9ed808b3b17a4f9f5c6f69c1b5f27b02773af4b32fed7cb387632e2e4077f1d2519afb39bb883f5eb6f870f5e1ef80aa629ad4be528884c66db4b8d705
+  data.tar.gz: 532ede4bdd2deb210c246e7ffdc3ed9456b88a65d53df4a4667689096fa52b452e145d8c91a84c0adad104a84ced0768c034af7018f4030e336579d4e9badc0f

data/README.md

@@ -1,5 +1,7 @@
 # Prawn::ManualBuilder
 
+![Maintained: yes](https://img.shields.io/badge/maintained-yes-brightgreen.png)
+
 This library is used by Prawn to generate its self-documenting manual,
 and could be used by third-party Prawn extensions to create manuals
 for their functionality as well.

data/lib/prawn/manual_builder/example.rb

@@ -228,7 +228,13 @@ module Prawn
           puts "Error evaluating example: #{e.message}"
           puts
           puts "---- Source: ----"
-          puts source
+          puts
+          source.lines.each_with_index do |l, i|
+            puts format('% 4d: %s', i + 1, l)
+          end
+          puts
+          puts "---- Backtrace: ----"
+          puts e.backtrace
         end
       end
 

data/lib/prawn/manual_builder/example_file.rb

@@ -65,18 +65,14 @@ module Prawn
       # Then removes the '#' signs, reflows the line breaks and return the result
       #
       def introduction_text
-        intro = @data.lines.grep(/^#/)
-
-        intro.shift if intro.first =~ /^#!/
-        intro.shift if intro.first =~ /coding:/
-
-        intro = intro.join
-
-        intro.gsub!(/\n# (?=\S)/m, ' ')
-        intro.gsub!(/^#/, '')
-        intro.gsub!("\n", "\n\n")
-        intro.rstrip!
-        intro
+        intro_lines
+          .map do |line|
+            line
+              .gsub(/\A\s*# (?=\S)/m, ' ')
+              .gsub(/\A\s*#/, '')
+              .strip
+          end
+          .join("\n")
       end
       
       # Returns a human friendly version of the example file name
@@ -113,7 +109,18 @@ module Prawn
 
         data.encode(::Encoding::UTF_8)
       end
-      
+
+      def intro_lines
+        @data
+          .lines
+          .grep(/^#/)
+          .reject do |line|
+            line.start_with?('#!') ||
+              /coding:/.match(line) ||
+              /\A\s*#\s*frozen_string_literal:/.match(line) ||
+              /\A\s*#\s*rubocop:/.match(line)
+          end
+      end
     end
   end
 end

data/lib/prawn/manual_builder/example_package.rb

@@ -1,20 +1,20 @@
 # encoding: utf-8
 
 module Prawn
-  module ManualBuilder  
-    # The Prawn::ManualBuilder::ExamplePackage class is a utility class to 
-    # handle the packaging of individual examples within a hierarchy 
+  module ManualBuilder
+    # The Prawn::ManualBuilder::ExamplePackage class is a utility class to
+    # handle the packaging of individual examples within a hierarchy
     # when building the manual.
     class ExamplePackage
       attr_reader :intro_block, :folder_name
 
       attr_writer :name
-      
+
       def initialize(folder_name)
         @folder_name = folder_name
         @hierarchy = []
       end
-      
+
       # Stores a new ExampleSection in the hierarchy and yields it to a block
       #
       def section(name)
@@ -22,31 +22,31 @@ module Prawn
         yield s
         @hierarchy << s
       end
-      
+
       # Stores a new ExampleFile in the hierarchy
       #
       def example(filename, options={})
         @hierarchy << ExampleFile.new(self, "#{filename}.rb", options)
       end
-      
+
       # Stores a block with code to be evaluated when rendering the package cover
       #
       def intro(&block)
         @intro_block = block
       end
-      
+
       # Returns a human friendly version of the package name
       #
       def name
         @name ||= @folder_name.gsub("_", " ").capitalize
       end
-      
+
       # Renders a cover page for the package to a pdf and iterates the examples
       # hierarchy delegating the examples and sections to be rendered as well
       #
       def render(pdf)
         pdf.render_package_cover(self)
-        
+
         @hierarchy.each do |node|
           node.render(pdf)
         end

data/lib/prawn/manual_builder/manual.rb

@@ -0,0 +1,14 @@
+module Prawn
+  module ManualBuilder
+    class Manual
+      # Creates a new ExamplePackage object and yields it to a block in order
+      # for it to be populated with examples, sections and some introduction
+      # text.  Used on the package files.
+      def package(package, &block)
+        ep = ExamplePackage.new(package)
+        ep.instance_eval(&block)
+        ep.render(self)
+      end
+    end
+  end
+end

data/lib/prawn/manual_builder/version.rb

@@ -0,0 +1,5 @@
+module Prawn
+  module ManualBuilder
+    VERSION = '0.3.0'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn-manual_builder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Felipe Doria
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -46,9 +46,14 @@ files:
 - 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/manual.rb
 - lib/prawn/manual_builder/syntax_highlight.rb
+- lib/prawn/manual_builder/version.rb
 homepage: 
-licenses: []
+licenses:
+- PRAWN
+- GPL-2.0
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -58,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -66,9 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A tool for writing manuals for Prawn and Prawn accessories
 test_files: []
-has_rdoc: