prawn_plus 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+= v1.0.0
+
+* Initial version.

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2012 {Red Alchemist}[http://www.redalchemist.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,116 @@
+= Overview
+
+{<img src="https://secure.travis-ci.org/bkuhlmann/prawn_plus.png" />}[http://travis-ci.org/bkuhlmann/prawn_plus]
+
+= Features
+
+* Loads the Prawn[https://github.com/prawnpdf/prawn] gem by default (no Gemfile entry necessary).
+* Registers PDF as a MIME type.
+* Registers a template handler for rendering ".prawn" template view files.
+
+= Requirements
+
+1. {Ruby on Rails}[http://rubyonrails.org].
+2. Prawn[https://github.com/prawnpdf/prawn].
+
+= Setup
+
+Type the following from the command line to install:
+
+  gem install prawn_plus
+
+Add the following to your Gemfile:
+
+  gem "prawn_plus"
+
+= Usage
+
+== Views
+
+Within your views you can craft Prawn templates using Ruby code. For example, assuming there are document resources, then
+the following structure might exist:
+
+  /views/documents/show.html.erb
+  /views/documents/show.pdf.prawn
+
+The show.html.erb could have a link to the PDF download. Example:
+
+  <%= link_to "PDF Download", action: "show", id: @document.id, format: "pdf" %>
+
+The show.pdf.prawn file would contain the Prawn syntax for crafting the PDF. A simple example
+might look like this:
+
+  pdf.text "Hello, I'm a PDF!"
+
+...which would render the following output:
+
+{<img src="https://github.com/bkuhlmann/prawn_plus/raw/master/doc/examples/basic.png" />}[https://github.com/bkuhlmann/prawn_plus]
+
+You could also render a more complex PDF with tabular information, for example:
+
+  pdf.text "Metals"
+  pdf.move_down 10
+  pdf.font_size = 10
+  
+  data = [
+    ["Name", "Atomic Number", "Price"],
+    ["Mercury", "80", number_to_currency(10)],
+    ["Platinum", "78", number_to_currency(25)],
+    ["Titanium", "22", number_to_currency(50)]
+  ]
+  
+  pdf.table data, header: true, column_widths: [100, 50, 50], row_colors: ["FFFFFF", "E5ECF9"] do
+    columns(0).align = :left
+    columns(1..2).align = :right
+    row(0).text_color = "FFFFFF"
+    row(0).background_color = "000000"
+    row(0).columns(0..2).font_style = :bold
+    row(0).columns(0..2).align = :center
+  end
+
+...which would render the following output:
+
+{<img src="https://github.com/bkuhlmann/prawn_plus/raw/master/doc/examples/complex.png" />}[https://github.com/bkuhlmann/prawn_plus]
+
+NOTE: The _pdf_ object must always be referenced when making using of the Prawn syntax - it is initialized for you
+as a Prawn::Document instance.
+
+== Controllers
+
+Within your controller, only the respond_to method is required. Using the same example above, only the following
+would be necessary:
+
+  class DocumentsController < ApplicationController
+    respond_to :pdf
+
+    def show
+    end
+  end
+
+That's it!
+
+= Tests
+
+To test, do the following:
+
+1. cd to the gem root.
+2. bundle install
+3. bundle exec rspec spec
+
+= Contributions
+
+Please log all feedback/issues via GitHub Issues. Thanks.
+
+= Credits
+
+Developed by {Brooke Kuhlmann}[http://www.redalchemist.com] at {Red Alchemist}[http://www.redalchemist.com]
+
+= License
+
+Copyright (c) 2012 {Red Alchemist}[http://www.redalchemist.com].
+Read the LICENSE for details.
+
+= History
+
+Read the CHANGELOG for details.
+Built with Gemsmith[https://github.com/bkuhlmann/gemsmith].

data/lib/prawn_plus/railtie.rb

@@ -0,0 +1,8 @@
+module PrawnPlus
+  class Railtie < Rails::Railtie
+    initializer "prawn_plus.initialize" do
+      Mime::Type.register("application/pdf", :pdf) unless Mime::Type.lookup_by_extension :pdf
+      ActionView::Template.register_template_handler :prawn, PrawnPlus::TemplateHandlers::Prawn.new
+    end
+  end
+end

data/lib/prawn_plus/template_handlers/prawn.rb

@@ -0,0 +1,13 @@
+module PrawnPlus
+  module TemplateHandlers
+    class Prawn
+      # Renders a Prawn template. It is assumed that the template will reference a
+      # _pdf_ (a.k.a. Prawn:Document) instance.
+      # * +template+ - Required. The template to render to a PDF.
+      # * +options+ - Optional. The template options. Default: {}.
+      def call template, options = {}
+        "pdf = ::Prawn::Document.new;" + template.source + ";pdf.render;"
+      end
+    end
+  end
+end

data/lib/prawn_plus/version.rb

@@ -0,0 +1,3 @@
+module PrawnPlus
+  VERSION = "1.0.0"
+end

data/lib/prawn_plus.rb

@@ -0,0 +1,4 @@
+require "prawn"
+require File.join File.dirname(__FILE__), "prawn_plus", "version.rb"
+require File.join File.dirname(__FILE__), "prawn_plus", "template_handlers", "prawn.rb"
+require File.join File.dirname(__FILE__), "prawn_plus", "railtie.rb"

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: prawn_plus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enhances default Prawn PDF functionality (which includes PDF template
+  handling/rendering).
+email: brooke@redalchemist.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+files:
+- lib/prawn_plus/railtie.rb
+- lib/prawn_plus/template_handlers/prawn.rb
+- lib/prawn_plus/version.rb
+- lib/prawn_plus.rb
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+homepage: http://www.redalchemist.com
+licenses:
+- MIT
+post_install_message: ! '(W): www.redalchemist.com. (T): @ralchemist.'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Enhances default Prawn PDF functionality.
+test_files: []