prawnto_2 0.2.0.beta → 0.2.0.beta2

data/README.rdoc

@@ -4,13 +4,17 @@ A rails plugin providing templating abilities for generating pdf files leveragin
 
 This is my attempt to merge the various forks of the prawnto gem, and <b>update it for Rails 3.1+</b>. I want to thank the many developers who's code I collected together for the gem. Main credit goes to the developer of the initial Prawnto plugin - smecsia.
 
+
+<b>I could use some help with the wiki.</b> If you find this helpful, and aren't up for contributing to the code, I would appreciate some help getting the docs in order.
+
+
 <b>Note:</b> It has not been tested with earlier versions of Rails.
 
-== Installation in Rails 3.1
+== Installation in Rails 3.1+
 
 In your <code>Gemfile</code>:
 
-  gem "prawnto_2", "0.2.0.beta", :require => "prawnto"
+  gem "prawnto_2", "0.2.0.beta2", :require => "prawnto"
 
 Then run:
   
@@ -18,16 +22,59 @@ Then run:
 
 Now make a view:
 
-  <action name>.pdf.prawnto
+  <action name>.pdf.prawn
   
 == Usage
 
-Please check out the {wiki}[http://github.com/forrest/prawnto/wiki] for usage details.
+More Details will be coming to {wiki}[http://github.com/forrest/prawnto/wiki].
+
+=== As View in Controller
+
+Simply create additional views that end with <code>.pdf.prawn</code> and rails will use the Prawnto template handler to render it properly. The beta has combined the regular <code>.prawn</code> and <code>.prawn_dsl</code> extensions. Now you won't get tired of typing <code>pdf.method</code>, but instance variables get used. There are a number of options available which are detailed in the wiki (or will be soon).
+  
+=== As Attachment to Email
+
+You can render PDF's as an attachment to an email very simply with Prawnto.
+  
+  class PdfEmailer < ActionMailer::Base
+    default from: "from@example.com"
+
+    def email_with_attachment
+      @var1 = 1
+      attachments["hello_world.pdf"] = render("test/default_render", :format => :pdf)
+      mail :subject => "Hello", :to => "test@test.com" do |format|
+        format.text
+      end
+    end
+  end
 
-In the meantime you can read the original (slightly out of date) documentation/demos at: http://cracklabs.com/prawnto
+If you need something more complicated, you may want to consider using the <code>Prawnto::Render.to_string</code> method listed next to create your attachment content.
+
+<b>Gotcha:</b> Something odd happens to the default format handling. You have to include the format block at the bottom, and specify the text, html, etc formats you want included on the body.
+
+=== From Model (or anywhere else)
+
+Experimental!!!
+
+Sometimes you need to be able to render a PDF from anywhere (Background process saving to the File, combining PDFs, etc), but you still want access to your helpers. This feature instantiates the most basic controller, and renders the template to a string for you to use. (more info coming to wiki soon)
+
+  class SuperModel
+    ...
+    def to_pdf
+      @x = 1
+      Prawnto::Render.to_string "template_path", self
+    end
+  end
+
+
+== Tips
+
+While layouts and partials aren't yet supported, helper methods can be called from within the PDF views. To help keep PDF's DRY, I would recommend creating a <code>PdfHelper</code> class for complex functionality. Don't forget to add this helper to your emailer if you generate PDF's as attachments.
 
 == Contributing & Reporting Issues
 
+Obviously, all code contributions are greatly appreciated. We also need help with testing and the wiki.
+
 While I can't promise the most speedy response, I do plan to continue to maintain this gem. Please feel free to report any issues, provide feedback, or make suggestions on the {Issue Tracker}[http://github.com/forrest/prawnto/issues]
 
 ---

data/lib/prawnto.rb

@@ -12,7 +12,13 @@ module Prawnto
   end
 
   module TemplateHandlers
+    autoload :Renderer, 'prawnto/template_handlers/renderer'
+    
     autoload :Base, 'prawnto/template_handlers/base'
     autoload :Dsl, 'prawnto/template_handlers/dsl'
   end
+  
+  autoload :Render, 'prawnto/pretend_render'
+  
+  
 end

data/lib/prawnto/action_controller_mixin.rb

@@ -19,7 +19,7 @@ module Prawnto
         self.prawnto_hash = DEFAULT_PRAWNTO_OPTIONS.dup.merge(prawnto_options)
       end
   
-      private
+    private
 
       # splits the :prawn key out into a seperate hash
       def breakdown_prawnto_options(options)

data/lib/prawnto/action_view_mixins/compile_support.rb

@@ -14,13 +14,13 @@ module Prawnto
       end
 
       def set_headers
-        # unless defined?(ActionMailer) && defined?(ActionMailer::Base) && self.is_a?(ActionMailer::Base)
+        unless defined?(ActionMailer) && defined?(ActionMailer::Base) && @controller.is_a?(ActionMailer::Base)
           set_pragma
           set_cache_control
           set_content_type
           set_disposition
           set_other_headers_for_ie_ssl
-        # end
+        end
       end
 
       def ie_request?

data/lib/prawnto/pretend_render.rb

@@ -0,0 +1,18 @@
+module Prawnto
+  module Render
+    # template : invoices/show.pdf
+    # instance_variables : {"@account" => account} - variables set in before filters
+    def self.to_string(template, calling_object = nil)
+      instance = ApplicationController.new
+  
+      instance.request = ActionDispatch::Request.new({})
+      instance.response = ActionDispatch::Response.new()
+  
+      instance_variables.each{|key, value|
+        instance.instance_variable_set(key, value)
+      }
+  
+      return instance.render_to_string(template, :template => false).html_safe
+    end
+  end
+end

data/lib/prawnto/railtie.rb

@@ -6,13 +6,14 @@ module Prawnto
     initializer "prawnto.register_handlers" do
       Mime::Type.register("application/pdf", :pdf) unless Mime::Type.lookup_by_extension(:pdf)
       ActionView::Template.register_template_handler 'prawn', Prawnto::TemplateHandlers::Base
-      ActionView::Template.register_template_handler 'prawn_dsl', Prawnto::TemplateHandlers::Dsl
+      ActionView::Template.register_template_handler 'prawn_dsl', Prawnto::TemplateHandlers::Base # for legacy systems
     end
     
     # This will run it once in production and before each load in development.
     # Include the mixins for ActionController and ActionView.
     config.to_prepare do
       ActionController::Base.send :include, Prawnto::ActionControllerMixin
+      ActionMailer::Base.send :include, Prawnto::ActionControllerMixin
       ActionView::Base.send :include, Prawnto::ActionViewMixins::ActionViewMixin
     end
     

data/lib/prawnto/template_handlers/base.rb

@@ -3,12 +3,10 @@ require "prawn"
 module Prawnto
   module TemplateHandlers
     class Base
-      
       def self.call(template)
         "_prawnto_compile_setup;" +
-        "pdf = Prawn::Document.new(@prawnto_options[:prawn]);" + 
-        "#{template.source}\n" +
-        "raw pdf.render;"
+        "renderer = Prawnto::TemplateHandlers::Renderer.new(self);"+
+        "renderer.to_pdf do; #{template.source}\nend;"
       end
     end
   end

data/lib/prawnto/template_handlers/renderer.rb

@@ -0,0 +1,45 @@
+module Prawnto
+  module TemplateHandlers
+    class Renderer
+      def initialize(calling_object = nil)
+        @calling_object = calling_object
+        copy_instance_variables_from(@calling_object) if @calling_object
+        @pdf = Prawn::Document.new(@prawnto_options[:prawn]);
+        self
+      end
+      
+      def to_pdf(&block)
+        instance_eval(&block)
+        @pdf.render.html_safe
+      end
+    
+    private
+    
+      def pdf
+        @pdf
+      end
+    
+      # This was removed in Rails 3.1
+      def copy_instance_variables_from(object, exclude = [])
+        vars = object.instance_variables.map(&:to_s) - exclude.map(&:to_s)
+        vars.each { |name| instance_variable_set(name, object.instance_variable_get(name)) }
+      end
+   
+      def method_missing(m, *args)
+        begin
+          super
+        rescue
+          if pdf.respond_to?(m.to_s)
+            pdf.send(m, *args)
+          elsif @calling_object.respond_to?(m.to_s)
+            @calling_object.send(m, *args)
+          else
+            raise
+          end
+        end
+      end
+  
+    end
+  end
+end
+  

data/prawnto.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |s|
   s.name = "prawnto_2"
-  s.version = '0.2.0.beta'
+  s.version = '0.2.0.beta2'
   s.author = ["Forrest"]
   s.email = ["development@forrestzeisler.com"]
   s.date = Time.now.utc.strftime("%Y-%m-%d")

data/spec/assets/{hello_world.pdf → default_render.pdf}

@@ -17,7 +17,7 @@ endobj
 >>
 endobj
 4 0 obj
-<< /Length 83
+<< /Length 343
 >>
 stream
 q
@@ -28,6 +28,20 @@ BT
 [<48656c6c6f2057> 30 <6f72> -15 <6c6421>] TJ
 ET
 
+
+BT
+36 733.512 Td
+/F1.0 12 Tf
+[<696e7374616e63652076> 25 <6172> -15 <696162> 20 <6c65204078203d2031>] TJ
+ET
+
+
+BT
+36 719.6399999999999 Td
+/F1.0 12 Tf
+[<68656c706572206d6574686f64732077> 10 <6f72> -15 <6b203a20746869732069732066726f6d20612068656c706572>] TJ
+ET
+
 Q
 
 endstream
@@ -57,13 +71,13 @@ xref
 0000000109 00000 n 
 0000000158 00000 n 
 0000000215 00000 n 
-0000000348 00000 n 
-0000000526 00000 n 
+0000000609 00000 n 
+0000000787 00000 n 
 trailer
 << /Size 7
 /Root 2 0 R
 /Info 1 0 R
 >>
 startxref
-623
+884
 %%EOF

data/spec/assets/dsl_render.pdf

@@ -0,0 +1,83 @@
+%PDF-1.3
+%����
+1 0 obj
+<< /Creator <feff0050007200610077006e>
+/Producer <feff0050007200610077006e>
+>>
+endobj
+2 0 obj
+<< /Type /Catalog
+/Pages 3 0 R
+>>
+endobj
+3 0 obj
+<< /Type /Pages
+/Count 1
+/Kids [5 0 R]
+>>
+endobj
+4 0 obj
+<< /Length 355
+>>
+stream
+q
+
+BT
+36 747.384 Td
+/F1.0 12 Tf
+[<48656c6c6f2057> 30 <6f72> -15 <6c6421202d2044534c>] TJ
+ET
+
+
+BT
+36 733.512 Td
+/F1.0 12 Tf
+[<696e7374616e63652076> 25 <6172> -15 <696162> 20 <6c65204078203d2031>] TJ
+ET
+
+
+BT
+36 719.6399999999999 Td
+/F1.0 12 Tf
+[<68656c706572206d6574686f64732077> 10 <6f72> -15 <6b203a20746869732069732066726f6d20612068656c706572>] TJ
+ET
+
+Q
+
+endstream
+endobj
+5 0 obj
+<< /Type /Page
+/Parent 3 0 R
+/MediaBox [0 0 612.0 792.0]
+/Contents 4 0 R
+/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI]
+/Font << /F1.0 6 0 R
+>>
+>>
+>>
+endobj
+6 0 obj
+<< /Type /Font
+/Subtype /Type1
+/BaseFont /Helvetica
+/Encoding /WinAnsiEncoding
+>>
+endobj
+xref
+0 7
+0000000000 65535 f 
+0000000015 00000 n 
+0000000109 00000 n 
+0000000158 00000 n 
+0000000215 00000 n 
+0000000621 00000 n 
+0000000799 00000 n 
+trailer
+<< /Size 7
+/Root 2 0 R
+/Info 1 0 R
+>>
+startxref
+896
+%%EOF

data/spec/dummy/app/controllers/test_controller.rb

@@ -1,7 +1,13 @@
 class TestController < ApplicationController
 
   def default_render
+    @x = 1
     render :action => "default_render"
   end
+  
+  def dsl_render
+    @x = 1
+    render :action => "dsl_render"
+  end
     
 end

data/spec/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,5 @@
 module ApplicationHelper
+  def some_helper
+    "this is from a helper"
+  end
 end

data/spec/dummy/app/mailers/pdf_emailer.rb

@@ -0,0 +1,14 @@
+class PdfEmailer < ActionMailer::Base
+  helper :application
+  default from: "from@example.com"
+  
+  def email_with_attachment
+    @x = 1
+    
+    attachments["hello_world.pdf"] = render("test/default_render", :format => :pdf)
+    mail :subject => "Hello", :to => "test@test.com" do |format|
+      format.text
+    end
+  end
+  
+end

data/spec/dummy/app/models/super_model.rb

@@ -0,0 +1,8 @@
+class SuperModel
+  
+  def to_pdf
+    @x = 1
+    Prawnto::Render.to_string "test/default_render", self
+  end
+  
+end

data/spec/dummy/app/views/pdf_emailer/email_with_attachment.text.erb

@@ -0,0 +1 @@
+Please see attached PDF

data/spec/dummy/app/views/test/default_render.pdf.prawn

@@ -1 +1,3 @@
-pdf.text "Hello World!"
+pdf.text "Hello World!"
+pdf.text "instance variable @x = #{@x}"
+pdf.text "helper methods work : #{some_helper}"

data/spec/dummy/app/views/test/dsl_render.pdf.prawn

@@ -0,0 +1,3 @@
+text "Hello World! - DSL"
+text "instance variable @x = #{@x}"
+text "helper methods work : #{some_helper}"

data/spec/dummy/config/routes.rb

@@ -1,4 +1,6 @@
 Rails.application.routes.draw do
   get "/default_render" => "test#default_render"
+  get "/dsl_render" => "test#dsl_render"
+  
   root :to => "test#default_render"
 end

data/spec/integrations/pdf_emailer_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path("../spec_helper.rb", File.dirname(__FILE__))
+
+describe PdfEmailer do
+  describe "email_with_attachment" do
+    before(:all) do
+      @email = PdfEmailer.email_with_attachment.deliver 
+    end
+    
+    it "should have the plain text on the body" do
+      @email.encoded.should include "text\/plain"
+      @email.encoded.should include "Please see attached PDF"
+    end
+    
+    it "should have the PDF attached" do
+      @email.encoded.should include "application\/pdf"
+      @email.encoded.should include "Content-Disposition: attachment;"
+      @email.encoded.should include "filename=hello_world.pdf"
+    end
+    
+  end
+end

data/spec/integrations/super_model_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path("../spec_helper.rb", File.dirname(__FILE__))
+
+describe SuperModel do
+  
+  describe "#to_pdf" do
+    before do
+      @model = SuperModel.new
+    end
+    
+    it do
+      asset_binary = File.open(TEST_ASSETS + "/default_render.pdf").read.bytes.to_a
+      @model.to_pdf.bytes.to_a.should == asset_binary
+    end
+  end
+  
+end

data/spec/integrations/test_controller_spec.rb

@@ -3,15 +3,26 @@ require File.expand_path("../spec_helper.rb", File.dirname(__FILE__))
 describe TestController do
   
   describe "GET default_render" do
-    it "returns hello_world.pdf" do
+    it "returns correct PDF" do
       get "/default_render.pdf"
       response.should be_success
       
-      asset_binary = File.open(TEST_ASSETS + "/hello_world.pdf").read.bytes.to_a
+      asset_binary = File.open(TEST_ASSETS + "/default_render.pdf").read.bytes.to_a
       body_binary = response.body.bytes.to_a
       body_binary.should == asset_binary
     end
   end
   
   
+  describe "GET dsl_render" do
+    it "returns correct PDF" do
+      get "/dsl_render.pdf"
+      response.should be_success
+      
+      asset_binary = File.open(TEST_ASSETS + "/dsl_render.pdf").read.bytes.to_a
+      body_binary = response.body.bytes.to_a
+      body_binary.should == asset_binary
+    end
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawnto_2
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta
+  version: 0.2.0.beta2
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70288695969600 !ruby/object:Gem::Requirement
+  requirement: &70318788769400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70288695969600
+  version_requirements: *70318788769400
 - !ruby/object:Gem::Dependency
   name: prawn
-  requirement: &70288695948040 !ruby/object:Gem::Requirement
+  requirement: &70318788768940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 0.12.0
   type: :runtime
   prerelease: false
-  version_requirements: *70288695948040
+  version_requirements: *70318788768940
 description: Simple PDF generation using the prawn library.
 email:
 - development@forrestzeisler.com
@@ -50,13 +50,15 @@ files:
 - lib/prawnto/action_controller_mixin.rb
 - lib/prawnto/action_view_mixins/action_view_mixin.rb
 - lib/prawnto/action_view_mixins/compile_support.rb
+- lib/prawnto/pretend_render.rb
 - lib/prawnto/railtie.rb
 - lib/prawnto/template_handlers/base.rb
-- lib/prawnto/template_handlers/dsl.rb
+- lib/prawnto/template_handlers/renderer.rb
 - prawnto.gemspec
 - rails/init.rb
 - script/rails
-- spec/assets/hello_world.pdf
+- spec/assets/default_render.pdf
+- spec/assets/dsl_render.pdf
 - spec/dummy/.rspec
 - spec/dummy/.sass-cache/387f7b3fde13680ae5a79212c089f81d2d418f1e/application.css.scssc
 - spec/dummy/.sass-cache/6a18c557e07dbc07a14d0809be02d4f21f1dbe91/_shared.css.scssc
@@ -72,9 +74,13 @@ files:
 - spec/dummy/app/controllers/test_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/mailers/pdf_emailer.rb
 - spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/super_model.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/pdf_emailer/email_with_attachment.text.erb
 - spec/dummy/app/views/test/default_render.pdf.prawn
+- spec/dummy/app/views/test/dsl_render.pdf.prawn
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -98,9 +104,10 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/delayed_job
 - spec/dummy/script/rails
+- spec/integrations/pdf_emailer_spec.rb
+- spec/integrations/super_model_spec.rb
 - spec/integrations/test_controller_spec.rb
 - spec/spec_helper.rb
-- spec/support/template_handler_test_mocks.rb
 - spec/units/action_controller_spec.rb
 - spec/units/compile_support_spec.rb
 homepage: 
@@ -129,7 +136,8 @@ specification_version: 3
 summary: This gem allows you to use the PDF mime-type and the simple prawn syntax
   to generate impressive looking PDFs.
 test_files:
-- spec/assets/hello_world.pdf
+- spec/assets/default_render.pdf
+- spec/assets/dsl_render.pdf
 - spec/dummy/.rspec
 - spec/dummy/.sass-cache/387f7b3fde13680ae5a79212c089f81d2d418f1e/application.css.scssc
 - spec/dummy/.sass-cache/6a18c557e07dbc07a14d0809be02d4f21f1dbe91/_shared.css.scssc
@@ -145,9 +153,13 @@ test_files:
 - spec/dummy/app/controllers/test_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/mailers/pdf_emailer.rb
 - spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/super_model.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/pdf_emailer/email_with_attachment.text.erb
 - spec/dummy/app/views/test/default_render.pdf.prawn
+- spec/dummy/app/views/test/dsl_render.pdf.prawn
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -171,8 +183,9 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/delayed_job
 - spec/dummy/script/rails
+- spec/integrations/pdf_emailer_spec.rb
+- spec/integrations/super_model_spec.rb
 - spec/integrations/test_controller_spec.rb
 - spec/spec_helper.rb
-- spec/support/template_handler_test_mocks.rb
 - spec/units/action_controller_spec.rb
 - spec/units/compile_support_spec.rb

data/lib/prawnto/template_handlers/dsl.rb

@@ -1,16 +0,0 @@
-module Prawnto
-  module TemplateHandlers
-    class Dsl < Base
-      
-      def self.call(template)
-        "_prawnto_compile_setup;" +
-        "pdf = Prawn::Document.new(@prawnto_options[:prawn]);" + 
-        "pdf.instance_eval do; #{template.source}\nend;" +
-        "raw pdf.render;"
-      end
-
-    end
-  end
-end
-
-

data/spec/support/template_handler_test_mocks.rb

@@ -1,72 +0,0 @@
-module TemplateHandlerTestMocks
-    # 
-    # class Template
-    #   attr_reader :source, :locals, :filename
-    # 
-    #   def initialize(source, locals={})
-    #     @source = source
-    #     @locals = locals
-    #     @filename = "blah.pdf"
-    #   end
-    # end
-    # 
-  
-  
-  class Request
-    def env
-      {}
-    end
-    
-    def ssl?
-      false
-    end
-  end
-  
-  class ActionController
-    include Prawnto::ActionControllerMixin
-  
-    def response
-      @response ||= ActionDispatch::TestResponse.new
-    end
-  
-    def request
-      @request ||= Request.new
-    end
-  
-    def headers
-      response.headers
-    end
-  end
-    
-  class ActionView
-    include Prawnto::ActionViewMixin
-
-    def controller
-      @controller ||= ActionController.new
-    end
-    
-    def response
-      controller.response
-    end
-    
-    def request
-      controller.request
-    end
-    
-    def headers
-      controller.headers
-    end
-    
-    def prawnto_options
-      controller.get_instance_variable(:@prawnto_options)
-    end
-    
-    def public_prawnto_compile_setup
-      _prawnto_compile_setup
-    end
-    
-  end
-
-
-end
-