prawn_cocktail_rails 0.1.0 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac39360c48b9d97535316933f2c27b9a6168ac4fdf2e35e49729f4d3bba1354e
+  data.tar.gz: d47baa4f5ce4a84d01012fd7cdaeab492571b0d64c35fca95bf825197765ea88
+SHA512:
+  metadata.gz: e8147b805f4d60e8c50f01ddfe7775a93bd33e693533baaaa5125bef2449e9dac1fcad88404c2fc4826bbf89bd098d0cb2b870c5918e78b6d02f2b2dd1a9feb8
+  data.tar.gz: 1b6dee0014c83d892682617994f3a1ee8340727369dc57b0e64d13b13a1190ed0cce1758b0c3618104524ef2aa6b53cb8dff969a7c320c6c42737e3fd5211217

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "2.5"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@ae9cb3b565e36682a2c6045e4f664388da4c73aa
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically          
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - "tmp/**/*"
+inherit_gem:
+  barsoom_utils: shared_rubocop.yml

data/Gemfile

@@ -1,4 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in prawn_cocktail.gemspec
 gemspec
+
+group :development do
+  gem "barsoom_utils", github: "barsoom/barsoom_utils"
+  gem "rubocop"
+end

data/README.md

@@ -1,12 +1,8 @@
 # PrawnCocktailRails
 
-Ruby on Rails integration for [PrawnCocktail](http://github.com/barsoom/prawn_cocktail).
-
-NOTE: Work in progress; well used but untested.
-
-## TODO
+[![Ruby CI](https://github.com/barsoom/prawn_cocktail_rails/actions/workflows/ci.yml/badge.svg)](https://github.com/barsoom/prawn_cocktail_rails/actions/workflows/ci.yml)
 
-* Tests
+Ruby on Rails integration for [PrawnCocktail](http://github.com/barsoom/prawn_cocktail).
 
 ## Usage
 
@@ -24,8 +20,11 @@ class InvoicesController < ApplicationController
 end
 ```
 
+The default [disposition](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) is `"attachment"`, meaning it should be downloaded rather than opened inline in the browser.
+
+You can change disposition to `"inline"` with `send_pdf(document, disposition: "inline")`.
 
-It configures PrawnCocktail to look for its views in `app/views/documents`.
+PrawnCocktailRails configures PrawnCocktail to look for its views in `app/views/documents`.
 
 It also adds `app/documents/helpers` to the Rails autoload path so you can put your PrawnCocktail helpers there.
 
@@ -45,6 +44,14 @@ And then execute:
 
 As this library depends on `prawn_cocktail`, you only need to list this one to get both.
 
+### Mime types
+
+You may need to register the pdf mimetype in `config/initializers/mime_types.rb`, for older versions of rails.
+
+```ruby
+Mime::Type.register "application/pdf", :pdf
+```
+
 ## License
 
 Copyright (c) 2013 [Barsoom AB](http://barsoom.se)

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task default: :test

data/lib/prawn_cocktail_rails/controller.rb

@@ -2,12 +2,12 @@ module PrawnCocktailRails
   module Controller
     private
 
-    def send_pdf(document)
+    def send_pdf(document, disposition: "attachment")
       send_data(
         document.render,
-        type: "application/pdf",
-        disposition: "attachment",
-        filename: document.filename
+        type: :pdf,
+        disposition: disposition,
+        filename: document.filename,
       )
     end
   end

data/lib/prawn_cocktail_rails/railtie.rb

@@ -5,5 +5,9 @@ module PrawnCocktailRails
     initializer "prawn_cocktail.autoload", before: :set_autoload_paths do |app|
       app.config.autoload_paths << "#{app.config.root}/app/documents/helpers"
     end
+
+    initializer "prawn_cocktail.set_template_root" do |app|
+      PrawnCocktail.template_root = app.config.root.join("app/views/documents")
+    end
   end
 end

data/lib/prawn_cocktail_rails/version.rb

@@ -1,3 +1,3 @@
 module PrawnCocktailRails
-  VERSION = "0.1.0"
+  VERSION = "0.3.2"
 end

data/lib/prawn_cocktail_rails.rb

@@ -6,5 +6,3 @@ require "prawn_cocktail"
 class ActionController::Base
   include PrawnCocktailRails::Controller
 end
-
-PrawnCocktail.template_root = "app/views/documents"

data/prawn_cocktail_rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "prawn_cocktail_rails/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "prawn_cocktail_rails"
+  gem.version       = PrawnCocktailRails::VERSION
+  gem.authors       = [ "Henrik Nyh" ]
+  gem.email         = [ "henrik@barsoom.se" ]
+  gem.summary       = "Simple documents, templates and helpers on top of Prawn. In Ruby on Rails."
+  gem.homepage      = ""
+  gem.metadata      = { "rubygems_mfa_required" => "true" }
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = [ "lib" ]
+
+  gem.add_dependency "prawn_cocktail", ">=0.4.0"
+  gem.add_dependency "rails"
+
+  gem.add_development_dependency "rake"  # For Travis CI.
+  gem.add_development_dependency "pdf-inspector"
+end

data/spec/dummy/.gitignore

@@ -0,0 +1 @@
+log/*

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+# 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/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/dummy_controller.rb

@@ -0,0 +1,6 @@
+class DummyController < ApplicationController
+  def show
+    document = TestDocument.new("test")
+    send_pdf document
+  end
+end

data/spec/dummy/app/documents/helpers/test_document_helper.rb

@@ -0,0 +1,5 @@
+module TestDocumentHelper
+  def helper_works
+    text "Helper works."
+  end
+end

data/spec/dummy/app/documents/test_document.rb

@@ -0,0 +1,17 @@
+class TestDocument < PrawnCocktail::Document
+  helper TestDocumentHelper
+
+  def initialize(message)
+    @message = message
+  end
+
+  def filename
+    "test.pdf"
+  end
+
+  private
+
+  def data
+    { message: @message }
+  end
+end

data/spec/dummy/app/views/documents/test_document.pdf.rb

@@ -0,0 +1,6 @@
+meta page_size: "A4"
+
+content do |data|
+  helper_works
+  text "Message: #{data.message}."
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,16 @@
+require File.expand_path("../boot", __FILE__)
+
+# Pick the frameworks you want:
+require "action_controller/railtie"
+#require "action_mailer/railtie"
+#require "active_resource/railtie"
+#require "sprockets/railtie"
+#require "rails/test_unit/railtie"
+
+Bundler.require
+require "prawn_cocktail_rails"
+
+module Dummy
+  class Application < Rails::Application
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+gemfile = File.expand_path("../../../../Gemfile", __FILE__)
+
+if File.exist?(gemfile)
+  ENV["BUNDLE_GEMFILE"] = gemfile
+  require "bundler"
+  Bundler.setup
+end
+
+$:.unshift File.expand_path("../../../../lib", __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path("../application", __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  #config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  #config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = "ecc1e4d2f3688465864a194ce713e2a958d94741c8a39741775b5fd5c001fcf279c2f32540d95139f3cb814718a25d36b23de65d8c7d8d5643e5da61ba86e5a9"

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: "_dummy_session"

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Dummy::Application.routes.draw do
+  get "document" => "dummy#show"
+end

data/spec/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 Dummy::Application

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path("../../config/application",  __FILE__)
+require File.expand_path("../../config/boot",  __FILE__)
+require "rails/commands"

data/spec/integration_spec.rb

@@ -0,0 +1,33 @@
+# Load dummy Rails app.
+ENV["RAILS_ENV"] ||= "test"
+require_relative "dummy/config/environment.rb"
+require "rails/test_help"
+
+require "pdf/inspector"
+require "minitest/pride"
+
+class IntegrationTest < ActionController::TestCase
+  tests DummyController
+
+  def test_integration
+    get :show
+    assert_header "Content-Type", "application/pdf"
+    assert_match %r{attachment; filename="test\.pdf"}, response.headers["Content-Disposition"]
+    assert_pdf_strings [
+      "Helper works.",
+      "Message: test.",
+    ]
+  end
+end
+
+def assert_header(name, value)
+  assert_equal value, response.headers[name]
+end
+
+def assert_pdf_strings(strings)
+  assert_equal strings, parse_strings(response.body)
+end
+
+def parse_strings(pdf_data)
+  PDF::Inspector::Text.analyze(pdf_data).strings
+end

metadata

@@ -1,38 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: prawn_cocktail_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn_cocktail
-  requirement: &70330186124280 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70330186124280
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70330186123660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70330186123660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - henrik@barsoom.se
@@ -40,7 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -48,30 +83,66 @@ files:
 - lib/prawn_cocktail_rails/controller.rb
 - lib/prawn_cocktail_rails/railtie.rb
 - lib/prawn_cocktail_rails/version.rb
-- prawn_cocktail.gemspec
+- prawn_cocktail_rails.gemspec
+- spec/dummy/.gitignore
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/dummy_controller.rb
+- spec/dummy/app/documents/helpers/test_document_helper.rb
+- spec/dummy/app/documents/test_document.rb
+- spec/dummy/app/views/documents/test_document.pdf.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/lib/assets/.gitkeep
+- spec/dummy/script/rails
+- spec/integration_spec.rb
 homepage: ''
 licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
 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: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 3.2.31
 signing_key: 
-specification_version: 3
-summary: PrawnCocktail on Rails.
-test_files: []
-has_rdoc: 
+specification_version: 4
+summary: Simple documents, templates and helpers on top of Prawn. In Ruby on Rails.
+test_files:
+- spec/dummy/.gitignore
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/dummy_controller.rb
+- spec/dummy/app/documents/helpers/test_document_helper.rb
+- spec/dummy/app/documents/test_document.rb
+- spec/dummy/app/views/documents/test_document.pdf.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/lib/assets/.gitkeep
+- spec/dummy/script/rails
+- spec/integration_spec.rb

data/prawn_cocktail.gemspec

@@ -1,21 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'prawn_cocktail_rails/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "prawn_cocktail_rails"
-  gem.version       = PrawnCocktailRails::VERSION
-  gem.authors       = ["Henrik Nyh"]
-  gem.email         = ["henrik@barsoom.se"]
-  gem.summary       = "PrawnCocktail on Rails."
-  gem.homepage      = ""
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency "prawn_cocktail", ">=0.4.0"
-  gem.add_dependency "rails"
-end