prawn-rails 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (70) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.markdown +61 -0
  3. data/Rakefile +39 -0
  4. data/lib/prawn-rails.rb +3 -0
  5. data/lib/prawn-rails/engine.rb +7 -0
  6. data/lib/prawn-rails/prawn_handler.rb +17 -0
  7. data/lib/prawn-rails/prawn_rails_helper.rb +41 -0
  8. data/lib/prawn-rails/version.rb +3 -0
  9. data/lib/tasks/prawn-rails_tasks.rake +4 -0
  10. data/test/dummy/Rakefile +7 -0
  11. data/test/dummy/app/assets/javascripts/application.js +9 -0
  12. data/test/dummy/app/assets/javascripts/pdf.js +2 -0
  13. data/test/dummy/app/assets/javascripts/products.js +2 -0
  14. data/test/dummy/app/assets/stylesheets/application.css +7 -0
  15. data/test/dummy/app/assets/stylesheets/pdf.css +4 -0
  16. data/test/dummy/app/assets/stylesheets/products.css +4 -0
  17. data/test/dummy/app/assets/stylesheets/scaffold.css +56 -0
  18. data/test/dummy/app/controllers/application_controller.rb +3 -0
  19. data/test/dummy/app/controllers/pdf_controller.rb +10 -0
  20. data/test/dummy/app/helpers/application_helper.rb +2 -0
  21. data/test/dummy/app/helpers/pdf_helper.rb +2 -0
  22. data/test/dummy/app/helpers/products_helper.rb +2 -0
  23. data/test/dummy/app/models/product.rb +2 -0
  24. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  25. data/test/dummy/app/views/pdf/render_pdf.html.erb +2 -0
  26. data/test/dummy/app/views/pdf/render_pdf.pdf.prawn +34 -0
  27. data/test/dummy/config.ru +4 -0
  28. data/test/dummy/config/application.rb +45 -0
  29. data/test/dummy/config/boot.rb +10 -0
  30. data/test/dummy/config/database.yml +25 -0
  31. data/test/dummy/config/environment.rb +5 -0
  32. data/test/dummy/config/environments/development.rb +30 -0
  33. data/test/dummy/config/environments/production.rb +60 -0
  34. data/test/dummy/config/environments/test.rb +39 -0
  35. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  36. data/test/dummy/config/initializers/inflections.rb +10 -0
  37. data/test/dummy/config/initializers/mime_types.rb +5 -0
  38. data/test/dummy/config/initializers/secret_token.rb +7 -0
  39. data/test/dummy/config/initializers/session_store.rb +8 -0
  40. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  41. data/test/dummy/config/locales/en.yml +5 -0
  42. data/test/dummy/config/routes.rb +62 -0
  43. data/test/dummy/db/development.sqlite3 +0 -0
  44. data/test/dummy/db/schema.rb +22 -0
  45. data/test/dummy/db/test.sqlite3 +0 -0
  46. data/test/dummy/log/development.log +2369 -0
  47. data/test/dummy/log/test.log +1290 -0
  48. data/test/dummy/public/404.html +26 -0
  49. data/test/dummy/public/422.html +26 -0
  50. data/test/dummy/public/500.html +26 -0
  51. data/test/dummy/public/favicon.ico +0 -0
  52. data/test/dummy/script/rails +6 -0
  53. data/test/dummy/test/functional/pdf_controller_test.rb +20 -0
  54. data/test/dummy/test/unit/helpers/pdf_helper_test.rb +4 -0
  55. data/test/dummy/tmp/cache/assets/C1C/440/sprockets%2F327750d15e74b4631b7219847f00528a +374 -0
  56. data/test/dummy/tmp/cache/assets/CAE/130/sprockets%2F5673d456292004d3af77fbb34191a3d9 +377 -0
  57. data/test/dummy/tmp/cache/assets/CFF/990/sprockets%2F7cc4697a647f5ef443f0855f8831f7a9 +0 -0
  58. data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  59. data/test/dummy/tmp/cache/assets/D43/620/sprockets%2Ff65e4a70390755ca5c1aeb1d7c596e47 +9271 -0
  60. data/test/dummy/tmp/cache/assets/D54/ED0/sprockets%2F71c9fa01091d432b131da3bb73faf3d4 +0 -0
  61. data/test/dummy/tmp/cache/assets/D6F/7F0/sprockets%2Fb93a9d8d60404a4c8a5f64e1c8ae4d44 +0 -0
  62. data/test/dummy/tmp/cache/assets/D84/210/sprockets%2Fabd0103ccec2b428ac62c94e4c40b384 +9651 -0
  63. data/test/dummy/tmp/cache/assets/DA1/220/sprockets%2F79ecb141dd3f168f83c4d3f1cf075b4d +0 -0
  64. data/test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  65. data/test/dummy/tmp/cache/assets/E2F/1D0/sprockets%2Fa19e16cee5f9ddbfbb85e2b9dc2420b7 +9268 -0
  66. data/test/dummy/tmp/cache/assets/E3A/290/sprockets%2F8657bc1d0b7bacf9b7ce74a379fbdee6 +0 -0
  67. data/test/integration/navigation_test.rb +10 -0
  68. data/test/prawn-rails_test.rb +7 -0
  69. data/test/test_helper.rb +10 -0
  70. metadata +238 -0
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2012 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.markdown ADDED
@@ -0,0 +1,61 @@
1
+ # Prawn-Rails
2
+
3
+ ## Dependencies
4
+
5
+ * prawn > 0.0.12
6
+ * Rails 3.0x
7
+ * Ruby > 1.8.7
8
+
9
+ ## Install
10
+ 1.Add to the Rails Gemfile
11
+
12
+ gem 'prawn'
13
+
14
+ gem 'prawn-rails'
15
+
16
+ to the Rails Gemfile
17
+
18
+
19
+ ## Usage
20
+ Create a view with `pdf` as format and `prawn` as handler
21
+ should look like `example.pdf.prawn`
22
+
23
+ Your available to use all prawn document methods like `pdf.text` `pdf.font_size` and also
24
+ block like `pdf.font(FONT_NAME,opts) do
25
+ pdf.XXXX
26
+ end`
27
+
28
+ For more documentation go to [the manual](http://prawn.majesticseacreature.com/manual.pdf)
29
+
30
+ ### Build in helpers
31
+ * *html_strip(html)*
32
+ Removes the html tags from a string
33
+
34
+ ## Examples
35
+
36
+ 1. **Hello World**
37
+
38
+ **hello.pdf.prawn**
39
+
40
+ pdf.text hello world
41
+
42
+ 2. ** Using Active Record **
43
+
44
+ **myproducts.pdf.prawn**
45
+
46
+ pdf.text "Current Products are"
47
+ pdf.move_down 20
48
+ pdf.table(@products.collect{ |p| [p.name,p.price]})
49
+
50
+
51
+ ## ToDos
52
+
53
+ 1. Add Default Configuration
54
+ 2. Add per-render Configuration
55
+ 3. Simple Html to PDF ?
56
+ 4. Any Other requested
57
+
58
+
59
+ ## Dev Notes
60
+ Gem works with any rails 3.0 version and ruby but for development It should be atlest Rails 3.1 (for the testing env)
61
+ I'll try to fix that
data/Rakefile ADDED
@@ -0,0 +1,39 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+ begin
8
+ require 'rdoc/task'
9
+ rescue LoadError
10
+ require 'rdoc/rdoc'
11
+ require 'rake/rdoctask'
12
+ RDoc::Task = Rake::RDocTask
13
+ end
14
+
15
+ RDoc::Task.new(:rdoc) do |rdoc|
16
+ rdoc.rdoc_dir = 'rdoc'
17
+ rdoc.title = 'PrawnRails'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.rdoc')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
24
+ load 'rails/tasks/engine.rake'
25
+
26
+
27
+ Bundler::GemHelper.install_tasks
28
+
29
+ require 'rake/testtask'
30
+
31
+ Rake::TestTask.new(:test) do |t|
32
+ t.libs << 'lib'
33
+ t.libs << 'test'
34
+ t.pattern = 'test/**/*_test.rb'
35
+ t.verbose = false
36
+ end
37
+
38
+
39
+ task :default => :test
@@ -0,0 +1,3 @@
1
+ require "prawn-rails/engine"
2
+ module PrawnRails
3
+ end
@@ -0,0 +1,7 @@
1
+ require "prawn-rails/prawn_handler"
2
+ module PrawnRails
3
+ class Engine < Rails::Engine
4
+ ActionView::Template.register_template_handler(:prawn,PrawnRails::PrawnHandler)
5
+ Mime::Type.register "application/pdf", :pdf
6
+ end
7
+ end
@@ -0,0 +1,17 @@
1
+ module PrawnRails
2
+ class PrawnHandler
3
+
4
+ def self.call(template)
5
+ require 'prawn-rails/prawn_rails_helper'
6
+ ::Prawn::Document.extensions<<PrawnRailsHelper
7
+ self.new.call(template)
8
+ end
9
+
10
+ def call(template)
11
+ "pdf = ::Prawn::Document.new();" +
12
+ template.source +
13
+ ";self.output_buffer=pdf.render;"
14
+ end
15
+
16
+ end
17
+ end
@@ -0,0 +1,41 @@
1
+ module PrawnRailsHelper
2
+
3
+ ##
4
+ # Removes all html tags from the string
5
+ # @param html[String] string to remove the tags
6
+ # @return [String] the string with out the tags
7
+ ##
8
+ def html_strip html
9
+ html
10
+ text = html.
11
+ gsub(/(&nbsp;|\n|\s)+/im, ' ').squeeze(' ').strip.
12
+ gsub(/<([^\s]+)[^>]*(src|href)=\s*(.?)([^>\s]*)\3[^>]*>\4<\/\1>/i,
13
+ '\4')
14
+
15
+ links = []
16
+ linkregex = /<[^>]*(src|href)=\s*(.?)([^>\s]*)\2[^>]*>\s*/i
17
+ while linkregex.match(text)
18
+ links << $~[3]
19
+ text.sub!(linkregex, "[#{links.size}]")
20
+ end
21
+
22
+ text = CGI.unescapeHTML(
23
+ text.
24
+ gsub(/<(script|style)[^>]*>.*<\/\1>/im, '').
25
+ gsub(/<!--.*-->/m, '').
26
+ gsub(/<hr(| [^>]*)>/i, "___\n").
27
+ gsub(/<li(| [^>]*)>/i, "\n* ").
28
+ gsub(/<blockquote(| [^>]*)>/i, '> ').
29
+ gsub(/<(br)(| [^>]*)>/i, "\n").
30
+ gsub(/<(\/h[\d]+|p)(| [^>]*)>/i, "\n\n").
31
+ gsub(/<[^>]*>/, '')
32
+ ).lstrip.gsub(/\n[ ]+/, "\n") + "\n"
33
+
34
+ for i in (0...links.size).to_a
35
+ text = text + "\n [#{i+1}] <#{CGI.unescapeHTML(links[i])}>" unless
36
+ links[i].nil?
37
+ end
38
+ links = nil
39
+ text
40
+ end
41
+ end
@@ -0,0 +1,3 @@
1
+ module PrawnRails
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :prawn-rails do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env rake
2
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
3
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
4
+
5
+ require File.expand_path('../config/application', __FILE__)
6
+
7
+ Dummy::Application.load_tasks
@@ -0,0 +1,9 @@
1
+ // This is a manifest file that'll be compiled into including all the files listed below.
2
+ // Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
3
+ // be included in the compiled file accessible from http://example.com/assets/application.js
4
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
5
+ // the compiled file.
6
+ //
7
+ //= require jquery
8
+ //= require jquery_ujs
9
+ //= require_tree .
@@ -0,0 +1,2 @@
1
+ // Place all the behaviors and hooks related to the matching controller here.
2
+ // All this logic will automatically be available in application.js.
@@ -0,0 +1,2 @@
1
+ // Place all the behaviors and hooks related to the matching controller here.
2
+ // All this logic will automatically be available in application.js.
@@ -0,0 +1,7 @@
1
+ /*
2
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
3
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
4
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
5
+ *= require_self
6
+ *= require_tree .
7
+ */
@@ -0,0 +1,4 @@
1
+ /*
2
+ Place all the styles related to the matching controller here.
3
+ They will automatically be included in application.css.
4
+ */
@@ -0,0 +1,4 @@
1
+ /*
2
+ Place all the styles related to the matching controller here.
3
+ They will automatically be included in application.css.
4
+ */
@@ -0,0 +1,56 @@
1
+ body { background-color: #fff; color: #333; }
2
+
3
+ body, p, ol, ul, td {
4
+ font-family: verdana, arial, helvetica, sans-serif;
5
+ font-size: 13px;
6
+ line-height: 18px;
7
+ }
8
+
9
+ pre {
10
+ background-color: #eee;
11
+ padding: 10px;
12
+ font-size: 11px;
13
+ }
14
+
15
+ a { color: #000; }
16
+ a:visited { color: #666; }
17
+ a:hover { color: #fff; background-color:#000; }
18
+
19
+ div.field, div.actions {
20
+ margin-bottom: 10px;
21
+ }
22
+
23
+ #notice {
24
+ color: green;
25
+ }
26
+
27
+ .field_with_errors {
28
+ padding: 2px;
29
+ background-color: red;
30
+ display: table;
31
+ }
32
+
33
+ #error_explanation {
34
+ width: 450px;
35
+ border: 2px solid red;
36
+ padding: 7px;
37
+ padding-bottom: 0;
38
+ margin-bottom: 20px;
39
+ background-color: #f0f0f0;
40
+ }
41
+
42
+ #error_explanation h2 {
43
+ text-align: left;
44
+ font-weight: bold;
45
+ padding: 5px 5px 5px 15px;
46
+ font-size: 12px;
47
+ margin: -7px;
48
+ margin-bottom: 0px;
49
+ background-color: #c00;
50
+ color: #fff;
51
+ }
52
+
53
+ #error_explanation ul li {
54
+ font-size: 12px;
55
+ list-style: square;
56
+ }
@@ -0,0 +1,3 @@
1
+ class ApplicationController < ActionController::Base
2
+ protect_from_forgery
3
+ end
@@ -0,0 +1,10 @@
1
+ class PdfController < ApplicationController
2
+
3
+ def render_pdf
4
+ @items=[{:name=> "Hello"},{:name=> "World"}]
5
+ render "render_pdf.pdf.prawn"
6
+ end
7
+
8
+
9
+
10
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,2 @@
1
+ module PdfHelper
2
+ end
@@ -0,0 +1,2 @@
1
+ module ProductsHelper
2
+ end
@@ -0,0 +1,2 @@
1
+ class Product < ActiveRecord::Base
2
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag "application" %>
6
+ <%= javascript_include_tag "application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,2 @@
1
+ <h1>Pdf#render_pdf</h1>
2
+ <p>Find me in app/views/pdf/render_pdf.html.erb</p>
@@ -0,0 +1,34 @@
1
+ pdf.text "Hello There :D"
2
+ pdf.text "now it is here: #{pdf.cursor}"
3
+ pdf.text "ITems are #{@items.inspect}"
4
+ pdf.font("Courier") do
5
+ pdf.text "Written in Courier because we are inside the block."
6
+ end
7
+
8
+ pdf.text "with html<bold></bold>"
9
+ pdf.text pdf.html_strip("without html <bold>LD</bold>")
10
+ pdf.text "Let's see which is the current font_size: #{pdf.font_size.inspect}"
11
+ pdf.move_down 10
12
+ pdf.font_size 16
13
+ pdf.text "Yeah, something bigger!"
14
+ pdf.move_down 10
15
+ pdf.font_size(25) { pdf.text "Even bigger!" }
16
+ pdf.move_down 10
17
+ pdf.text "Back to 16 again."
18
+ pdf.move_down 10
19
+ pdf.text "Single line on 20 using the :size option.", :size => 20
20
+ pdf.move_down 10
21
+ pdf.text "Back to 16 once more."
22
+ pdf.move_down 10
23
+ pdf.font("Courier", :size => 10) do
24
+ pdf.text "Yeah, using Courier 10 courtesy of the font method."
25
+ end
26
+ pdf.font("Helvetica", :size => 12) # back to normal
27
+
28
+ pdf.text "Default color is black"
29
+ pdf.move_down 25
30
+ pdf.text "Changed to red", :color => "FF0000"
31
+ pdf.move_down 25
32
+ pdf.text "CMYK color", :color => [22, 55, 79, 30]
33
+ pdf.move_down 25
34
+ pdf.text "Also works with <color rgb='ff0000'>inline</color> formatting", :color => "0000FF", :inline_format => true
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Dummy::Application
@@ -0,0 +1,45 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require 'rails/all'
4
+
5
+ Bundler.require
6
+ require "prawn-rails"
7
+
8
+ module Dummy
9
+ class Application < Rails::Application
10
+ # Settings in config/environments/* take precedence over those specified here.
11
+ # Application configuration should go into files in config/initializers
12
+ # -- all .rb files in that directory are automatically loaded.
13
+
14
+ # Custom directories with classes and modules you want to be autoloadable.
15
+ # config.autoload_paths += %W(#{config.root}/extras)
16
+
17
+ # Only load the plugins named here, in the order given (default is alphabetical).
18
+ # :all can be used as a placeholder for all plugins not explicitly named.
19
+ # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
20
+
21
+ # Activate observers that should always be running.
22
+ # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
23
+
24
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
25
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
26
+ # config.time_zone = 'Central Time (US & Canada)'
27
+
28
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
29
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
30
+ # config.i18n.default_locale = :de
31
+
32
+ # Configure the default encoding used in templates for Ruby 1.9.
33
+ config.encoding = "utf-8"
34
+
35
+ # Configure sensitive parameters which will be filtered from the log file.
36
+ config.filter_parameters += [:password]
37
+
38
+ # Enable the asset pipeline
39
+ config.assets.enabled = true
40
+
41
+ # Version of your assets, change this if you want to expire all your assets
42
+ config.assets.version = '1.0'
43
+ end
44
+ end
45
+