pdfcraft 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f54e8e2001f880ef78adeed73787e729b2d5da32
+  data.tar.gz: 176111e09a1886d79753aec70bc45b7eab60dd78
+SHA512:
+  metadata.gz: 4c29e48960dd9669fccf480a97a29417de39b4a601bb36c68b27c5bc75c438a80de700c39a0acd5d9746f2f44d0a1db5fd5b2838a259c07abd36948e1ff4c667
+  data.tar.gz: ae432a87e38c4aeccb1d5c24eb69e823101a42395b78f62c364ddadffa094af9b2f7eb05ddaa98929d571621d9b4a5bc387df5fd622cb431cd84305f3df780c6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Ryan L. Bell
+
+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,65 @@
+= Pdfcraft {<img src="https://travis-ci.org/kofno/pdfcraft.png?branch=master" />}[https://travis-ci.org/kofno/pdfcraft]
+
+A little Rails plugin for rendering PDFs from templates.
+
+== Install
+
+Add Pdfcraft to your Gemfile
+    gem "pdfcraft"
+
+And bundle
+    % bundle
+
+
+== Usage
+
+=== Controllers
+
+From your controllers:
+
+    def index
+      respond_to do |format|
+        format.pdf { render pdf: 'contents' }
+      end
+    end
+
+=== Views
+
+Create view templates just like you would for any other view format. Use file
+extension .pdfcraft for the pdfcraft template handler.
+
+Pdfcraft initializes an ivar named @pdf the holds the PDF document you are
+building.
+
+    @pdf.text "This will be rendered in a PDF"
+
+Since Pdfcraft is built on Rails' templating and rendering, this means that
+partials, layouts, and helpers are all at yout disposal.
+
+    @pdf.text "This is a template"
+
+    render partial: 'aggregates'
+
+Pdfcraft uses Prawn as the rendering engine. For the time being, the @pdf
+object delgates directly to a Prawn::Document object, so refer to Prawn's API
+documentation for how to construct a PDF.
+
+One method on the Pdfcraft::Document that is not part of the Prawn::Document is
+the #page_config method. This method takes all of the options that
+Prawn::Document#new does, and can only be called once before any other method
+on Pdfcraft::Document. This is how you can configure the PDF layout options.
+
+    @pdf.page_config page_layout: :landscape
+
+One you've started constructing the document, calls to #page_config will be
+ignored. There is also a version of #page_config named #page_config! (notice
+the bang). Using #page_config! will raise an exception if PDF document
+construction has already begun.
+
+=== A Note About render_to_string
+
+The contract for render_to_string requires that this method returns a string.
+In the case of PDF representations, string content doesn't really make sense,
+since it's really a binary format. When render_to_string is called for PDF
+format, Pdfcraft simply returns the binary data for the generated PDF.
+

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pdfcraft'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/pdfcraft.rb

@@ -0,0 +1,5 @@
+require 'pdfcraft/pdf_renderer'
+require 'pdfcraft/pdf_template_handler'
+
+module Pdfcraft
+end

data/lib/pdfcraft/document.rb

@@ -0,0 +1,42 @@
+require 'prawn'
+require 'delegate'
+
+module Pdfcraft
+
+  class Document < Delegator
+
+    def initialize
+      # override the super instance with a new signature
+    end
+
+    def page_config! options
+      raise EngineAlreadyInitialized, "pdf document has already started rendering" if @pdf_engine.present?
+      __setobj__ pdf_engine(options)
+    end
+
+    def page_config options
+      page_config! options
+      true
+    rescue EngineAlreadyInitialized
+      false
+    end
+
+    def __getobj__
+      @pdf_engine ||= pdf_engine
+    end
+
+    def __setobj__(obj)
+      @pdf_engine = obj
+    end
+
+    private
+
+    def pdf_engine options={}
+      Prawn::Document.new(options)
+    end
+
+    class EngineAlreadyInitialized < StandardError; end
+  end
+
+end
+

data/lib/pdfcraft/pdf_renderer.rb

@@ -0,0 +1,6 @@
+require 'prawn'
+
+ActionController::Renderers.add :pdf do |filename, options|
+  pdf = render_to_string(options)
+  send_data pdf, filename: "#{filename}.pdf", disposition: "inline"
+end

data/lib/pdfcraft/pdf_template_handler.rb

@@ -0,0 +1,17 @@
+require 'action_view/template'
+require 'pdfcraft/document'
+
+module Pdfcraft
+
+  class PdfHandler
+
+    def call(template)
+      "@pdf ||= ::Pdfcraft::Document.new;" +
+        template.source + ";" +
+        "@pdf.render;"
+    end
+  end
+
+end
+
+ActionView::Template.register_template_handler :pdfcraft, Pdfcraft::PdfHandler.new

data/lib/pdfcraft/version.rb

@@ -0,0 +1,3 @@
+module Pdfcraft
+  VERSION = "0.0.1"
+end

data/lib/tasks/pdfcraft_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pdfcraft do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,25 @@
+class HomeController < ApplicationController
+
+  def index
+    respond_to do |format|
+      format.html
+      format.pdf { render pdf: "contents" }
+    end
+  end
+
+  def another
+    render pdf: "contents", template: "home/index"
+  end
+
+  def partials
+    render pdf: "contents"
+  end
+
+  def helpers
+    render pdf: "contents"
+  end
+
+  def pdf_layout
+    render pdf: "contents"
+  end
+end

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

@@ -0,0 +1,7 @@
+module ApplicationHelper
+
+  def example_helper
+    "This string came from a helper"
+  end
+
+end

data/test/dummy/app/views/home/_the_partial.pdf.pdfcraft

@@ -0,0 +1,3 @@
+@pdf.move_down 20
+
+@pdf.text "I was rendered in a partial"

data/test/dummy/app/views/home/helpers.pdf.pdfcraft

@@ -0,0 +1 @@
+@pdf.text example_helper

data/test/dummy/app/views/home/index.pdf.pdfcraft

@@ -0,0 +1 @@
+@pdf.text "This template is rendered as a PDF."

data/test/dummy/app/views/home/partials.pdf.pdfcraft

@@ -0,0 +1,4 @@
+@pdf.text "This was rendered in the base template"
+
+render partial: 'the_partial'
+

data/test/dummy/app/views/home/pdf_layout.pdf.pdfcraft

@@ -0,0 +1,3 @@
+@pdf.page_config page_layout: :landscape
+
+@pdf.text "This page should be formatted as landscape"

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "pdfcraft"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000