prawn-manual_builder 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e049e1cd01093d886d6fdff3d0a20aec5f585574
-  data.tar.gz: 7c29632aca25f3ca567681a5ff847eb170a0bf2e
+SHA256:
+  metadata.gz: 3d4873e82c2906833aa5480dcd264453e839b62a67254e8bd6c43c361430be8b
+  data.tar.gz: 4958041c344dcb46dae8142b07872995d3e649bd9e5bc94befc7f476a5bd45b3
 SHA512:
-  metadata.gz: 63ca7f9ed808b3b17a4f9f5c6f69c1b5f27b02773af4b32fed7cb387632e2e4077f1d2519afb39bb883f5eb6f870f5e1ef80aa629ad4be528884c66db4b8d705
-  data.tar.gz: 532ede4bdd2deb210c246e7ffdc3ed9456b88a65d53df4a4667689096fa52b452e145d8c91a84c0adad104a84ced0768c034af7018f4030e336579d4e9badc0f
+  metadata.gz: c29745b0d6d5e43c81907857eb695017cce649d30b9905e0baffe52cf8385fa4073bdaad5021c936f57b87196cf9288659351ef4f9e63268b2f35c0d364f8e86
+  data.tar.gz: d1a4eff4362d6e9a4fbe5a644cbf385c8aaf66d56baf2eb0a1e3cc3d1330f1ec791125906cb2f62dcecf616394861b066cf0838e76f3e95ac66d9318cd6724c9

data/GPLv2

@@ -1,8 +1,8 @@
-		    GNU GENERAL PUBLIC LICENSE
-		       Version 2, June 1991
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
 
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 

data/lib/prawn/manual_builder/example.rb

@@ -73,7 +73,7 @@ module Prawn
       def load_file(package, file)
         start_new_page
         example = ExampleFile.new(package, "#{file}.rb")
-        eval example.generate_block_source
+        eval example.generate_block_source, nil, File.join(Prawn::ManualBuilder.manual_dir, example.parent_folder_name, example.filename), example.generated_block_line
       end
 
 
@@ -129,7 +129,7 @@ module Prawn
         code(example.source)
 
         if example.eval?
-          eval_code(example.source)
+          eval_code(example)
         else
           source_link(example)
         end
@@ -212,7 +212,8 @@ module Prawn
 
       # Renders a dashed line and evaluates the code inline
       #
-      def eval_code(source)
+      def eval_code(example)
+        source = example.source
         move_down(RHYTHM)
 
         dash(3)
@@ -223,18 +224,12 @@ module Prawn
 
         move_down(RHYTHM*3)
         begin
-          eval(source)
+          eval source, nil, File.join(Prawn::ManualBuilder.manual_dir, example.parent_folder_name, example.filename), example.generated_block_line
         rescue => e
           puts "Error evaluating example: #{e.message}"
           puts
           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
+          puts source
         end
       end
 

data/lib/prawn/manual_builder/example_file.rb

@@ -44,7 +44,15 @@ module Prawn
         
         block.gsub(/^( ){2}/, "")
       end
-      
+
+      def generated_block_line
+        pre_block = @data.slice(/.*\w+\.generate.*? do\n/m)
+
+        return 1 unless pre_block
+
+        pre_block.lines.length + 1
+      end
+
       # Return either the full_source or the generate_block_source according
       # to the options
       #
@@ -65,14 +73,19 @@ module Prawn
       # Then removes the '#' signs, reflows the line breaks and return the result
       #
       def introduction_text
-        intro_lines
-          .map do |line|
-            line
-              .gsub(/\A\s*# (?=\S)/m, ' ')
-              .gsub(/\A\s*#/, '')
-              .strip
-          end
-          .join("\n")
+        intro = @data.lines.grep(/^#/)
+
+        intro.shift if intro.first =~ /^#!/
+        intro.shift if intro.first =~ /coding:/
+        intro.shift if intro.first =~ /frozen_string_literal:/
+
+        intro = intro.join
+
+        intro.gsub!(/\n# (?=\S)/m, ' ')
+        intro.gsub!(/^#/, '')
+        intro.gsub!("\n", "\n\n")
+        intro.rstrip!
+        intro
       end
       
       # Returns a human friendly version of the example file name
@@ -109,18 +122,7 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn-manual_builder
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Felipe Doria
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-27 00:00:00.000000000 Z
+date: 2019-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -46,9 +46,7 @@ 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:
 - PRAWN
@@ -63,15 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A tool for writing manuals for Prawn and Prawn accessories

data/lib/prawn/manual_builder/manual.rb

@@ -1,14 +0,0 @@
-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

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