prawn-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d6fbefb65824997d33b8548ae130748091503ae
-  data.tar.gz: 5a06022952a399839b9d5e791a16ec2285f28e5c
+  metadata.gz: 8087ba0ba0e0bfcbc51bfbc5e05c9847dcf65869
+  data.tar.gz: 067355f7b11a01986b8ce5f5948598bc3e4536ae
 SHA512:
-  metadata.gz: b8dc1640268c8aaad75b44e0dfb5a4ea041decc3ca4e799b9306040645e158a9fea97053a78ed996dd9d23b25610a990eae49df26205da5e934e19094e876d4f
-  data.tar.gz: b3ffd4b8dd3154d878e80bda3cfcb226722b3b5bcbab332cbc6d7bcd38cca7df8556796d0c26c553f72d6653d13087e0a708f6fa82bdf1c339894d0ed70c4dc6
+  metadata.gz: d62d8ecf3aed1aa63c100b2d6047a18c913d9fa323dbb8c63eb57c56f180c5673ce0bbdac141f8188fd491897dfe31ba8be5f2c6ac542764131477bb1b86e4b5
+  data.tar.gz: 2a0ca3e83f4ab55dfa41487b3fd263c15a77c66679b649ac5b97bb062ba0031f3522f6796cd582082ee782df995dbd03c3a802e799415b942ea9206cd75272ba

data/README.markdown

@@ -1,25 +1,35 @@
-# Prawn-Rails
+# Prawn-Rails [![Gem Version](https://badge.fury.io/rb/prawn-rails.svg)](http://badge.fury.io/rb/prawn-rails)
 
 ## Dependencies
  
 * prawn > 0.0.12
+* prawn-table
 * Rails 3.0x
 * Ruby > 1.8.7
 
 ## Install
 1.Add to the Rails Gemfile
 
-	gem 'prawn'
-	gem 'prawn-table'
 	gem 'prawn-rails'
 		
-to the Rails Gemfile
-
+to the Rails Gemfile  
+`prawn` and `prawn-table` is a dependency so no need to mention it in the projects Gemfile  
+but can mention a specific version if your Gemfile, if you want   
 
 ## Usage
 Create a view with `pdf` as format and `prawn` as handler 
-should look like `example.pdf.prawn`
-  
+so filename should look like `example.pdf.prawn`
+
+we provide a helper called `prawn_document` 
+it builds a PrawnRails::Document with default options. Can override with `page_size` and `page_layout` 
+example contents of `example.pdf.prawn` 
+
+    prawn_document(:page_layout => :landscape) do |pdf|
+      pdf.text "Hello World"
+    end
+
+No need to call `pdf.render`, it is called by `prawn_document` 
+
 Your available to use all prawn document methods like `pdf.text` `pdf.font_size` and also
 block like `pdf.font(FONT_NAME,opts) do
 pdf.XXXX
@@ -36,9 +46,17 @@ Removes the html tags from a string
 Add a `prawn-rails.rb` config to your Rails app under `config/initializers` like this
 
     PrawnRails.config do |config|
-      config.page_layout = :landscape
+      config.page_layout = :portrait
+      config.page_size   = "A4"
+      config.skip_page_creation = false
     end
 
+by default `page_layout` is portrait and `page_size` is "A4" 
+also `skip_page_creation` is set to false by default, if it is set to true 
+then have to create the first page yourself for eg. 
+
+    pdf.start_new_page size: "A4", page_layout: :landscape
+
 ## Examples
  
 1. **Hello World**

data/lib/prawn-rails/config.rb

@@ -3,7 +3,9 @@ require 'ostruct'
 module PrawnRails
 extend self
 
-  @config = OpenStruct.new
+  @config = OpenStruct.new(:page_layout => :portrait,
+                           :page_size => "A4",
+                           :skip_page_creation => false)
 
   def config
     begin

data/lib/prawn-rails/document.rb

@@ -1,10 +1,16 @@
 require 'prawn'
 require 'prawn/table'
+require "prawn-rails/extension"
 
 module PrawnRails
   # This derives from Prawn::Document in order to override defaults. Note
   # that the Prawn::Document behaviour itself shouldn't be changed.
   class Document < Prawn::Document
+    def initialize(opts = {})
+      default = PrawnRails.config.to_h.merge(opts)
+      super(default)
+    end
+
     # Typicall text expects a string. But rails views have this interesting
     # concept that they implicitly call `to_s` on all the variables before
     # rendering. So, passing an integer to text fails:
@@ -18,4 +24,6 @@ module PrawnRails
       super(value.to_s, options)
     end
   end
+
+  Document.extensions << Extension
 end

data/lib/prawn-rails/engine.rb

@@ -1,8 +1,10 @@
 require "prawn"
+require "prawn-rails/rails_helper"
 require "prawn-rails/renderer"
 
 module PrawnRails
   class Engine < Rails::Engine
+    ActionView::Base.send(:include, PrawnRails::RailsHelper)
     ActionView::Template.register_template_handler(:prawn, PrawnRails::Renderer)
 
     if !Mime::Type.lookup_by_extension(:pdf)

data/lib/prawn-rails/extension.rb

@@ -0,0 +1,43 @@
+module PrawnRails
+  module Extension
+    ##
+    # Removes all html tags from the string
+    # @param html[String] string to remove the tags
+    # @return [String] the string with out the tags
+    ##
+    def html_strip html
+      return html if html.nil?
+      html
+      text = html.
+        gsub(/( |\n|\s)+/im, ' ').squeeze(' ').strip.
+        gsub(/<([^\s]+)[^>]*(src|href)=\s*(.?)([^>\s]*)\3[^>]*>\4<\/\1>/i,
+             '\4')
+
+      links = []
+      linkregex = /<[^>]*(src|href)=\s*(.?)([^>\s]*)\2[^>]*>\s*/i
+      while linkregex.match(text)
+        links << $~[3]
+        text.sub!(linkregex, "[#{links.size}]")
+      end
+
+      text = CGI.unescapeHTML(
+                              text.
+                              gsub(/<(script|style)[^>]*>.*<\/\1>/im, '').
+                              gsub(/<!--.*-->/m, '').
+                              gsub(/<hr(| [^>]*)>/i, "___\n").
+                              gsub(/<li(| [^>]*)>/i, "\n* ").
+                              gsub(/<blockquote(| [^>]*)>/i, '> ').
+                              gsub(/<(br)(| [^>]*)>/i, "\n").
+                              gsub(/<(\/h[\d]+|p)(| [^>]*)>/i, "\n\n").
+                              gsub(/<[^>]*>/, '')
+                              ).lstrip.gsub(/\n[ ]+/, "\n") + "\n"
+
+      for i in (0...links.size).to_a
+        text = text + "\n  [#{i+1}] <#{CGI.unescapeHTML(links[i])}>" unless
+          links[i].nil?
+      end
+      links = nil
+      text
+    end
+  end
+end

data/lib/prawn-rails/rails_helper.rb

@@ -0,0 +1,18 @@
+require 'prawn-rails/document'
+
+module PrawnRails
+  module RailsHelper
+    def prawn_document(options={})
+      options.reverse_merge!(:page_layout => PrawnRails.config.page_layout,
+                             :page_size => PrawnRails.config.page_size)
+
+      options.reverse_merge!(:skip_page_creation => true) if PrawnRails.config.skip_page_creation
+
+      pdf = PrawnRails::Document.new(options)
+
+      yield pdf if block_given?
+
+      pdf.render
+    end
+  end
+end

data/lib/prawn-rails/renderer.rb

@@ -1,17 +1,9 @@
 require "prawn-rails/document"
-require "prawn-rails/prawn_rails_helper"
 
 module PrawnRails
   class Renderer
     def self.call(template)
-      ::Prawn::Document.extensions << PrawnRailsHelper
-      new.call(template)
-    end
-
-    def call(template)
-      "pdf = PrawnRails::Document.new;" +
-      template.source +
-      ";self.output_buffer=pdf.render;"
+      template.source.strip
     end
   end
 end

data/lib/prawn-rails/version.rb

@@ -1,3 +1,3 @@
 module PrawnRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/dummy/app/views/pdf/render_pdf.pdf.prawn

@@ -1,34 +1,36 @@
-pdf.text "Hello There :D"
-pdf.text "now it is here: #{pdf.cursor}"
-pdf.text "ITems are #{@items.inspect}"
-pdf.font("Courier") do
-  pdf.text "Written in Courier because we are inside the block." 
-end
+prawn_document do |pdf|
+  pdf.text "Hello There :D"
+  pdf.text "now it is here: #{pdf.cursor}"
+  pdf.text "ITems are #{@items.inspect}"
+  pdf.font("Courier") do
+    pdf.text "Written in Courier because we are inside the block."
+  end
 
-pdf.text "with html<bold></bold>"
-pdf.text pdf.html_strip("without html <bold>LD</bold>")
-pdf.text "Let's see which is the current font_size: #{pdf.font_size.inspect}"
-pdf.move_down 10 
-pdf.font_size 16 
-pdf.text "Yeah, something bigger!"
-pdf.move_down 10 
-pdf.font_size(25) { pdf.text "Even bigger!" }
-pdf.move_down 10 
-pdf.text "Back to 16 again."
-pdf.move_down 10 
-pdf.text "Single line on 20 using the :size option.", :size => 20
-pdf.move_down 10 
-pdf.text "Back to 16 once more."
-pdf.move_down 10 
-pdf.font("Courier", :size => 10) do
-  pdf.text "Yeah, using Courier 10 courtesy of the font method."
-end
-pdf.font("Helvetica", :size => 12) # back to normal
+  pdf.text "with html<bold></bold>"
+  pdf.text pdf.html_strip("without html <bold>LD</bold>")
+  pdf.text "Let's see which is the current font_size: #{pdf.font_size.inspect}"
+  pdf.move_down 10
+  pdf.font_size 16
+  pdf.text "Yeah, something bigger!"
+  pdf.move_down 10
+  pdf.font_size(25) { pdf.text "Even bigger!" }
+  pdf.move_down 10
+  pdf.text "Back to 16 again."
+  pdf.move_down 10
+  pdf.text "Single line on 20 using the :size option.", :size => 20
+  pdf.move_down 10
+  pdf.text "Back to 16 once more."
+  pdf.move_down 10
+  pdf.font("Courier", :size => 10) do
+    pdf.text "Yeah, using Courier 10 courtesy of the font method."
+  end
+  pdf.font("Helvetica", :size => 12) # back to normal
 
-pdf.text "Default color is black" 
-pdf.move_down 25
-pdf.text "Changed to red", :color => "FF0000" 
-pdf.move_down 25
-pdf.text "CMYK color", :color => [22, 55, 79, 30] 
-pdf.move_down 25
-pdf.text "Also works with <color rgb='ff0000'>inline</color> formatting", :color => "0000FF", :inline_format => true
+  pdf.text "Default color is black"
+  pdf.move_down 25
+  pdf.text "Changed to red", :color => "FF0000"
+  pdf.move_down 25
+  pdf.text "CMYK color", :color => [22, 55, 79, 30]
+  pdf.move_down 25
+  pdf.text "Also works with <color rgb='ff0000'>inline</color> formatting", :color => "0000FF", :inline_format => true
+end

data/test/dummy/test/functional/pdf_controller_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'pdf/reader'
 
 class PdfControllerTest < ActionController::TestCase
   test "should get a pdf" do

data/test/prawn-rails_test.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
-require "prawn-rails/prawn_rails_helper"
+require "prawn-rails/extension"
 
 class PrawnRailsTest < ActiveSupport::TestCase
-  include  PrawnRailsHelper
+  include PrawnRails::Extension
   test "html_strip" do
     
     assert_nil(html_strip(nil)) 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Carlos Ortiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  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'
 description: Prawn Handler for RoR 3.x/4.x projects handles and registers pdf formats
 email:
 - chrono.dark@gmail.com
@@ -80,7 +94,8 @@ files:
 - lib/prawn-rails/config.rb
 - lib/prawn-rails/document.rb
 - lib/prawn-rails/engine.rb
-- lib/prawn-rails/prawn_rails_helper.rb
+- lib/prawn-rails/extension.rb
+- lib/prawn-rails/rails_helper.rb
 - lib/prawn-rails/renderer.rb
 - lib/prawn-rails/version.rb
 - lib/tasks/prawn-rails_tasks.rake
@@ -148,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Prawn Handler for RoR 3.x/4.x projects

data/lib/prawn-rails/prawn_rails_helper.rb

@@ -1,41 +0,0 @@
-module PrawnRailsHelper
-  ##
-  # Removes all html tags from the string
-  # @param html[String] string to remove the tags
-  # @return [String] the string with out the tags
-  ##
-  def html_strip html
-    return html if html.nil?
-    html
-      text = html.
-        gsub(/( |\n|\s)+/im, ' ').squeeze(' ').strip.
-        gsub(/<([^\s]+)[^>]*(src|href)=\s*(.?)([^>\s]*)\3[^>]*>\4<\/\1>/i,
-    '\4')
-
-      links = []
-      linkregex = /<[^>]*(src|href)=\s*(.?)([^>\s]*)\2[^>]*>\s*/i
-      while linkregex.match(text)
-        links << $~[3]
-        text.sub!(linkregex, "[#{links.size}]")
-      end
-
-      text = CGI.unescapeHTML(
-        text.
-          gsub(/<(script|style)[^>]*>.*<\/\1>/im, '').
-          gsub(/<!--.*-->/m, '').
-          gsub(/<hr(| [^>]*)>/i, "___\n").
-          gsub(/<li(| [^>]*)>/i, "\n* ").
-          gsub(/<blockquote(| [^>]*)>/i, '> ').
-          gsub(/<(br)(| [^>]*)>/i, "\n").
-          gsub(/<(\/h[\d]+|p)(| [^>]*)>/i, "\n\n").
-          gsub(/<[^>]*>/, '')
-      ).lstrip.gsub(/\n[ ]+/, "\n") + "\n"
-
-      for i in (0...links.size).to_a
-        text = text + "\n  [#{i+1}] <#{CGI.unescapeHTML(links[i])}>" unless
-    links[i].nil?
-      end
-      links = nil
-      text
-  end
-end