prawnto_2 0.0.7

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+**/*.swp
+*.gem
+rdoc/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in my_project.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 cracklabs.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,28 @@
+= Prawnto (prawnto_2)
+
+A rails plugin providing templating abilities for generating pdf files leveraging the new kick-ass prawn library (http://prawn.majesticseacreature.com/)
+
+Full (slightly out of date) documentation/demos at: http://cracklabs.com/prawnto
+
+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>Note:</b> It has not been tested with earlier versions of Rails.
+
+== Installation in Rails 3.1
+
+In your <code>Gemfile</code>:
+
+  gem 'prawnto_2'
+  
+== Usage
+
+On it's way...
+
+
+
+---
+
+
+Copyright on Updates - Copyright (c) 2011 getjobber.com, released under the MIT license
+
+Original Copyright - Copyright (c) 2008 cracklabs.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'  
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Generate documentation for the prawnto plugin.'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Prawnto'
+
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end
+
+desc 'Test the prawnto gem'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  # t.verbose = true
+end

data/lib/prawnto.rb

@@ -0,0 +1,39 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'prawnto/railtie' if defined?(Rails)
+
+module Prawnto
+  VERSION='0.0.7'
+  autoload :ActionControllerMixin, 'prawnto/action_controller_mixin'
+  autoload :ActionViewMixin, 'prawnto/action_view_mixin'
+  module TemplateHandlers
+    autoload :Base, 'prawnto/template_handlers/base'
+    autoload :Dsl, 'prawnto/template_handlers/dsl'
+  end
+
+  module TemplateHandler
+    autoload :CompileSupport, 'prawnto/template_handler/compile_support'
+  end
+
+  class << self
+    
+    def run_includes
+      ActionController::Base.send :include, Prawnto::ActionControllerMixin
+      ActionView::Base.send :include, Prawnto::ActionViewMixin
+    end
+    
+    def register_handlers
+      Mime::Type.register "application/pdf", :pdf unless defined?(Mime::PDF)
+      ActionView::Template.register_template_handler 'prawn', Prawnto::TemplateHandlers::Base
+      ActionView::Template.register_template_handler 'prawn_dsl', Prawnto::TemplateHandlers::Dsl
+    end
+    
+    def init_both
+      run_includes
+      register_handlers
+    end
+    
+  end
+
+end

data/lib/prawnto/action_controller_mixin.rb

@@ -0,0 +1,54 @@
+module Prawnto
+  module ActionControllerMixin
+
+    DEFAULT_PRAWNTO_OPTIONS = {:inline=>true}
+      
+    def self.included(base)
+      base.class_attribute :prawn_hash, :prawnto_hash
+      base.prawn_hash = {}
+      base.prawnto_hash = {}
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      
+      # Sets options in the class attributes. Can be pulled into the instance variable with :compute_prawnto_options
+      def prawnto(options)
+        prawn_options, prawnto_options = breakdown_prawnto_options options
+        self.prawn_hash = prawn_options
+        self.prawnto_hash = DEFAULT_PRAWNTO_OPTIONS.dup.merge(prawnto_options)
+      end
+    
+    private
+
+      # splits the :prawn key out into a seperate hash
+      def breakdown_prawnto_options(options)
+        prawnto_options = options.dup
+        prawn_options = (prawnto_options.delete(:prawn) || {}).dup
+        [prawn_options, prawnto_options]
+      end
+    end
+
+
+    # Sets options directly on the instance
+    def prawnto(options)
+      @prawnto_options ||= {}
+      @prawnto_options.merge! options
+    end
+
+
+  private
+
+    # Used to set the @prawnto_options variable before rendering. Called from compile_support just before rendering.
+    def compute_prawnto_options
+      @prawnto_options ||= DEFAULT_PRAWNTO_OPTIONS.dup
+      @prawnto_options[:prawn] ||= {}
+      @prawnto_options[:prawn].merge!(self.class.prawn_hash || {}) {|k,o,n| o}
+      @prawnto_options.merge!(self.class.prawnto_hash || {}) {|k,o,n| o}
+      @prawnto_options
+    end
+
+  end
+end
+
+

data/lib/prawnto/action_view_mixin.rb

@@ -0,0 +1,12 @@
+module Prawnto
+  module ActionViewMixin
+
+  private
+    def _prawnto_compile_setup
+      compile_support = Prawnto::TemplateHandler::CompileSupport.new(controller)
+      @prawnto_options = compile_support.options
+    end
+
+  end
+end
+

data/lib/prawnto/railtie.rb

@@ -0,0 +1,16 @@
+module Prawnto
+  class Railtie < Rails::Railtie
+
+    config.to_prepare do
+      puts "running railtie initializer"
+      Prawnto.register_handlers
+    end
+    
+    #switching from an initializer to a :to_prepare will run it once in production and before each load in development
+    config.to_prepare do
+      puts "running railtie includes"
+      Prawnto.run_includes
+    end
+    
+  end
+end

data/lib/prawnto/template_handler/compile_support.rb

@@ -0,0 +1,82 @@
+module Prawnto
+  module TemplateHandler
+
+    class CompileSupport
+      extend ActiveSupport::Memoizable
+
+      attr_reader :options
+
+      def initialize(controller)
+        @controller = controller
+        @options = pull_options
+        set_headers
+      end
+
+      # This sets the @options hash which is used for rendering.
+      def pull_options
+        @controller.send :compute_prawnto_options || {}
+      end
+
+      def set_headers
+        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
+
+      # TODO: kept around from railspdf-- maybe not needed anymore? should check.
+      def ie_request?
+        @controller.request.env['HTTP_USER_AGENT'] =~ /msie/i
+      end
+      memoize :ie_request?
+
+      # added to make ie happy with ssl pdf's (per naisayer)
+      def ssl_request?
+				@controller.request.ssl?
+      end
+      memoize :ssl_request?
+      
+      def set_other_headers_for_ie_ssl
+        return unless ssl_request? && ie_request?
+        @controller.headers['Content-Description'] = 'File Transfer'
+        @controller.headers['Content-Transfer-Encoding'] = 'binary'
+        @controller.headers['Expires'] = '0'        
+      end
+
+      # TODO: kept around from railspdf-- maybe not needed anymore? should check.
+      def set_pragma
+        if ssl_request? && ie_request?
+          @controller.headers['Pragma'] = 'public' # added to make ie ssl pdfs work (per naisayer)
+        else
+          @controller.headers['Pragma'] ||= ie_request? ? 'no-cache' : ''
+        end
+      end
+
+      # TODO: kept around from railspdf-- maybe not needed anymore? should check.
+      def set_cache_control
+        if ssl_request? && ie_request?
+          @controller.headers['Cache-Control'] = 'maxage=1' # added to make ie ssl pdfs work (per naisayer)
+        else
+          @controller.headers['Cache-Control'] ||= ie_request? ? 'no-cache, must-revalidate' : ''
+        end
+      end
+
+      def set_content_type
+        @controller.response.content_type ||= Mime::PDF
+      end
+
+      def set_disposition
+        inline = options[:inline] ? 'inline' : 'attachment'
+        filename = options[:filename] ? "filename=\"#{options[:filename]}\"" : nil
+        @controller.headers["Content-Disposition"] = [inline,filename].compact.join(';')
+      end
+
+    end
+
+  end
+end
+
+

data/lib/prawnto/template_handlers/base.rb

@@ -0,0 +1,15 @@
+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;"
+      end
+    end
+  end
+end
+
+

data/lib/prawnto/template_handlers/dsl.rb

@@ -0,0 +1,16 @@
+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/prawnto.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path("../lib/prawnto.rb", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "prawnto_2"
+  s.version = Prawnto::VERSION
+  s.author = ["Forrest"]
+  s.email = ["development@forrestzeisler.com"]
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
+  
+  
+  s.description = 'Simple PDF generation using the prawn library.'
+  s.summary = "This gem allows you to use the PDF mime-type and the simple prawn syntax to generate impressive looking PDFs."
+  
+  s.homepage = "http://cracklabs.com/prawnto"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.platform = Gem::Platform::RUBY
+  s.add_dependency('rails', '>=3.1')
+  s.add_dependency('prawn', '>= 0.12.0')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path  = "lib"
+  
+  
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc"]
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '/../lib/prawnto.rb')

data/test/action_controller_test.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__)+"/test_helper.rb")
+
+class PrawntoControllerTest < ActionController::TestCase
+  
+  class PrawntoControllerWithInlineTrue < PrawntoController
+    prawnto :inline=>true, :prawn=>{:page_orientation=>:landscape}
+  end
+  
+  class PrawntoControllerWithInlineFalse < PrawntoController
+    prawnto :inline=>false
+  end
+  
+
+  def test_inheritable_options
+    assert_equal({:page_orientation=>:landscape}, PrawntoControllerWithInlineTrue.prawn_hash)
+    assert_equal({:inline=>true}, PrawntoControllerWithInlineTrue.prawnto_hash)
+    
+    #send a change and make sure it doesn't effect the others
+    @controller.send(:prawnto, {:inline=>false})
+    assert_equal({:inline=>false, :prawn => {}}, @controller.send(:compute_prawnto_options))
+    assert_equal({:inline=>true, :prawn=>{:page_orientation=>:landscape}}, PrawntoControllerWithInlineTrue.new.send(:compute_prawnto_options))
+  end
+
+  def test_computed_options
+    # controller = PrawntoController.new
+    @controller.send(:prawnto, {:inline=>false, :prawn=>{:page_orientation=>:landscape, :page_size=>'A4'}})
+    assert_equal({:inline=>false, :prawn=>{:page_orientation=>:landscape, :page_size=>'A4'}}, @controller.send(:compute_prawnto_options))
+  end
+
+
+  def test_default_settings
+    # controller = PrawntoController.new
+    assert_equal({:inline=>true, :prawn => {}}, @controller.send(:compute_prawnto_options))
+  end
+  
+end
+

data/test/base_template_handler_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__)+"/test_helper.rb")
+require 'template_handler_test_mocks'
+
+class PrawntoControllerTest < ActionController::TestCase
+  include TemplateHandlerTestMocks
+  
+  def setup
+    @view = ActionView.new
+    @handler = Prawnto::TemplateHandlers::Base.new(@view)
+    @controller = @view.controller
+  end
+
+  def test_headers_disposition_inline_and_filename
+    @controller.prawnto :filename=>'xxx.pdf', :inline=>true
+    @view.public_prawnto_compile_setup
+    
+    assert_equal 'inline;filename="xxx.pdf"', @view.headers['Content-Disposition']
+  end
+
+  def test_headers_disposition_attachment_and_filename
+    @controller.prawnto :filename=>'xxx.pdf', :inline=>false
+    @view.public_prawnto_compile_setup
+    
+    assert_equal 'attachment;filename="xxx.pdf"', @view.headers['Content-Disposition']
+  end
+  
+  def test_headers_disposition_default
+    @view.public_prawnto_compile_setup
+    
+    assert_equal 'inline', @view.headers['Content-Disposition']
+  end
+
+end
+

data/test/dsl_template_handler_test.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__)+"/test_helper.rb")
+require 'template_handler_test_mocks'
+
+class PrawntoControllerTest < ActionController::TestCase
+  include TemplateHandlerTestMocks
+  
+  def setup
+    @view = ActionView.new
+    @handler = Prawnto::TemplateHandlers::Base.new(@view)
+    @controller = @view.controller
+  end
+  
+  # I'm not sure what these are suppose to test, and they aren't currently working. - Forrest
+  
+  # def test_prawnto_options_dsl_hash
+  #   @y = 3231; @x = 5322
+  #   @controller.prawnto :dsl=> {'x'=>:@x, :y=>'@y'}
+  #   @view.public_prawnto_compile_setup
+  #   
+  #   source = @handler.build_source_to_establish_locals(Template.new(""))
+  # 
+  #   assert_equal @x, eval(source + "\nx")
+  #   assert_equal @y, eval(source + "\ny")
+  # end
+# 
+#   def test_prawnto_options_dsl_array
+#     @y = 3231; @x = 5322
+#     @controller.prawnto :dsl=> ['x', :@y]
+#     @handler.pull_prawnto_options
+#     source = @handler.build_source_to_establish_locals(Template.new(""))
+# 
+#     assert_equal @x, eval(source + "\nx")
+#     assert_equal @y, eval(source + "\ny")
+#   end
+
+end
+

data/test/template_handler_test_mocks.rb

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

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'tempfile'
+
+require 'active_support'
+require 'action_controller'
+require 'action_view'
+
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), '/../lib/prawnto.rb')
+Prawnto.init_both
+
+class PrawntoController < ActionController::Base
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: prawnto_2
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Forrest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2162199040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2162199040
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: &2162198580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2162198580
+description: Simple PDF generation using the prawn library.
+email:
+- development@forrestzeisler.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/prawnto.rb
+- lib/prawnto/action_controller_mixin.rb
+- lib/prawnto/action_view_mixin.rb
+- lib/prawnto/railtie.rb
+- lib/prawnto/template_handler/compile_support.rb
+- lib/prawnto/template_handlers/base.rb
+- lib/prawnto/template_handlers/dsl.rb
+- prawnto.gemspec
+- rails/init.rb
+- test/action_controller_test.rb
+- test/base_template_handler_test.rb
+- test/dsl_template_handler_test.rb
+- test/template_handler_test_mocks.rb
+- test/test_helper.rb
+homepage: http://cracklabs.com/prawnto
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+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:
+- test/action_controller_test.rb
+- test/base_template_handler_test.rb
+- test/dsl_template_handler_test.rb
+- test/template_handler_test_mocks.rb
+- test/test_helper.rb