prawn_rails 0.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Walton Hoops
+
+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,81 @@
+= Prawn Rails
+
+Prawn Rails provides a simple way of creating PDF views in Rails 3 using the prawn library.
+
+To use Prawn Rails simply add the line
+
+    gem 'prawn_rails'
+
+to your Gemfile and then run
+
+    bundle install
+
+That's it!  You can now create views named
+
+    [action].pdf.prawn
+
+which will be used whenever the user requests a page with a 'pdf' extension
+
+== Usage
+
+prawn_rails is designed to provide only a very thin wrapper around Prawn itself.  A prawn_rails view should consist of only a call to the function prawn_document and a block.  This will create an instance of Prawn::Document and yield it to the block.
+For a simple pdf view try:
+
+views/.../simple.pdf.prawn
+
+  prawn_document() do |pdf|
+    pdf.text "Hello World"
+  end
+
+This will create a simple PDF with only the text Hello World.
+
+Like normal Rails views, instance variables assigned in the controller are made available in the view.  For example:
+
+home_controller.rb
+
+  class HomeController < ApplicationController
+    def index
+      @people=['Jane','John','Jack']
+    end
+  end
+
+views/.../index.pdf.prawn
+
+  prawn_document(:page_layout => :landscape) do |pdf|
+    @people.each {|person| pdf.text person}
+  end
+
+This will produce a pdf with Jane, John, and Jack all written on seperate lines.
+
+Notice we passed a hash into prawn_document.  Any parameters placed in this hash will be passed to the constructor of Prawn::Document, with one exception.  The renderer option will be removed before creating the document and can be used to override the class to be used for rendering with a subclass of Prawn::Document like so:
+
+views/.../override.pdf.prawn
+
+  prawn_document({:renderer => ApplicationHelper::Foo})
+
+So for the view above you could have an application helper file that looks like:
+
+application_helper.rb
+
+  module ApplicationHelper
+    class Foo < Prawn::Document
+      def initialize
+        super
+        text "Foo"
+        text "Bar"
+      end
+    end
+  end
+
+This would generate a canned report with just the lines Foo and Bar.
+
+== Gotchas
+
+The one major gotcha at this point is that layouts do not work.  Do not attempt to make an app/views/layouts/application.pdf.prawn.  All your pdf views will quit.  This is something I hope to fix in a later release.  In the meantime I recommend using custom classes like the one above to achieve a similair effect.
+
+== Examples
+
+For examples see: http://github.com/Volundr/prawn_rails_demo
+
+
+Copyright (c) 2010 Walton Hoops, released under the MIT license

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rubygems'
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',  
+  'lib/**/*',
+  'rails/**/*',  
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "prawn_rails"
+  s.version = "0.0.3"
+  s.author = "Walton Hoops"
+  s.email = "me@waltonhoops.com"
+  s.homepage = "http://github.com/Volundr/prawn-rails"
+  s.add_dependency('rails', '>=3.0.0')
+  s.add_dependency('prawn', '>=0.8.4')
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Integrates Prawn into Rails in a natural way"
+  s.description=<<-EOF
+  The prawn_rails gem provides a Prawn based view engine for creating PDFs with rails.
+  EOF
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+end
+
+desc 'Default: create gem'
+task :default => :gem
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc 'Test the prawn_rails plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the prawn_rails plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PrawnRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'prawn_rails'

data/lib/prawn_rails.rb

@@ -0,0 +1,33 @@
+require 'prawn'
+require 'prawn/layout'
+require 'prawn/security'
+
+module Prawn
+  module Rails
+    
+    module PrawnHelper
+      
+      def prawn_document(opts={})
+        pdf = (opts.delete(:renderer) || Prawn::Document).new(opts)
+        yield pdf if block_given?
+        
+        pdf
+      end
+      
+    end
+    
+    class TemplateHandler < ActionView::Template::Handler
+      self.default_format = :pdf
+      
+      def self.call(template)
+        "#{template.source.strip}.render"        
+      end
+      
+    end
+    
+  end
+end
+
+Mime::Type.register_alias "application/pdf", :pdf
+ActionView::Template.register_template_handler(:prawn, Prawn::Rails::TemplateHandler)
+ActionView::Base.send(:include, Prawn::Rails::PrawnHelper)

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'prawn_rails'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: prawn_rails
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Walton Hoops
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-23 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 8
+        - 4
+        version: 0.8.4
+  type: :runtime
+  version_requirements: *id002
+description: "  The prawn_rails gem provides a Prawn based view engine for creating PDFs with rails.\n"
+email: me@waltonhoops.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- init.rb
+- Rakefile
+- MIT-LICENSE
+- lib/prawn_rails.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/Volundr/prawn-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Integrates Prawn into Rails in a natural way
+test_files: []
+