aptible-prawn-helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fcf4c0f2c0766f4bac83d94c32776be5f4cf5d4
+  data.tar.gz: 97a1d03444899f1085d6eb70285aa24d01b4db9b
+SHA512:
+  metadata.gz: 4f72cfd5cda59c3a65a7194ec6689b20dfb618617d3a0b4bbc282870f55efb2d4ffed6a4e565ed0068fb68f057b0a32b8240123ddaf6430fc5b2139e3839154a
+  data.tar.gz: a058a66dd2c7f06aa19f348235328a030a95ea30ae0394a8754725e9de0f7d68b2731aedf559083a5f33bb48e38baa825ec1ea207dbb6bd28dd708b7503855bf

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.0.0
+  - jruby

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aptible-auth.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aptible, Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,25 @@
+# ![](https://raw.github.com/aptible/straptible/master/lib/straptible/rails/templates/public.api/icon-60px.png) Aptible::DocumentHelpers
+
+Include `Aptible::DocumentHelpers` in your `Prawn::Document` for easy Aptible-styled PDF generation.
+
+# Installation
+
+Add `aptible-prawn-helpers` to your Gemfile
+
+```
+gem 'aptible-prawn-helpers'
+  
+```
+and install the gem with `bundle install`.
+
+# Usage
+
+To load the helpers, just include the module in your `Prawn::Document` definition:
+
+```
+class AptibleDocument < Prawn::Document
+  include Aptible::DocumentHelpers
+end
+```
+
+[<img src="https://s.gravatar.com/avatar/9b58236204e844e3181e43e05ddb0809?s=60" style="border-radius: 50%;" alt="@sandersonet" />](https://github.com/sandersonet)

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require 'aptible/tasks'
+Aptible::Tasks.load_tasks

data/aptible-prawn-helpers.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'English'
+require 'aptible/document_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aptible-prawn-helpers'
+  spec.version       = Aptible::DocumentHelpers::VERSION
+  spec.authors       = ['Skylar Anderson', 'Chas Ballew']
+  spec.email         = ['skylar@aptible.com', 'chas@aptible.com']
+  spec.description   = 'Prawn Document Helpers'
+  spec.summary       = 'Prawn Document Helpers'
+  spec.homepage      = 'https://github.com/aptible/aptible-prawn-helpers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'aptible-tasks', '>= 0.2.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/aptible/document_helpers/change_layout_format.rb

@@ -0,0 +1,18 @@
+module Aptible
+  module DocumentHelpers
+    module ChangeLayoutFormat
+      def change_layout_format(format)
+        case format
+        when :portrait
+          start_new_page(layout: :portrait)
+          on_page_create
+        when :landscape
+          start_new_page(layout: :landscape)
+          # push the current page
+          @landscape_pages.push(page_number)
+          # push additional pages in the watermark hook
+        end
+      end
+    end
+  end
+end

data/lib/aptible/document_helpers/font_loader.rb

@@ -0,0 +1,29 @@
+module Aptible
+  module DocumentHelpers
+    module FontLoader
+      # rubocop:disable MethodLength
+      def load_fonts
+        font_families.update(
+          'Georgia' => {
+            normal: 'data/fonts/Georgia.ttf',
+            italic: 'data/fonts/Georgia Italic.ttf',
+            bold: 'data/fonts/Georgia Bold.ttf',
+            bold_italic: 'data/fonts/Georgia Bold Italic.ttf'
+          }
+        )
+        font_families.update(
+          'Proxima Nova' => {
+            normal: 'data/fonts/proxima_nova.ttf',
+            italic: 'data/fonts/proxima_nova_italic.ttf',
+            light: 'data/fonts/proxima_nova_light.ttf',
+            light_italic: 'data/fonts/proxima_nova_light_italic.ttf',
+            bold: 'data/fonts/proxima_nova_bold.ttf',
+            bold_italic: 'data/fonts/proxima_nova_bold_italic.ttf'
+          }
+        )
+        font 'Georgia'
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers/footer.rb

@@ -0,0 +1,23 @@
+module Aptible
+  module DocumentHelpers
+    module Footer
+      # rubocop:disable MethodLength
+      def footer
+        options = {
+          at: [0, -10],
+          color: '999999',
+          size: 10,
+          page_filter: ->(page) { page != 1 }
+        }
+        font 'Proxima Nova'
+        number_pages "#{@document.organization_name}", options
+        number_pages 'NIST SP 800-30 Rev 1 Risk Analysis',
+                     options.merge(at: [0, -22])
+        number_pages 'Prepared with assistance from Aptible',
+                     options.merge(at: [0, -34])
+        font 'Georgia'
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers/header.rb

@@ -0,0 +1,48 @@
+module Aptible
+  module DocumentHelpers
+    module Header
+      # rubocop:disable MethodLength
+      def header(title, options = {})
+        header_box do
+          formatted_text [{
+            text: title,
+            color: '003366',
+            size: 30,
+            styles: [:bold],
+            font: 'Proxima Nova'
+          }],
+                         valign: :center
+          add_dest title, dest_fit
+        end
+
+        closed = options[:closed] || false
+        outline.define do
+          section(title, destination: page_number, closed: closed) do
+          end
+        end
+      end
+
+      def header_box(&block)
+        box_margin = 36
+        background_color = 'eef6fe'
+        reset_default_font_color = '333333'
+
+        bounding_box([-bounds.absolute_left, cursor + 50],
+                     width: bounds.absolute_left + bounds.absolute_right,
+                     height: box_margin * 2) do
+          fill_color background_color
+          fill_rectangle(
+            [bounds.left, bounds.top],
+            bounds.right,
+            bounds.top - bounds.bottom
+          )
+          fill_color reset_default_font_color
+          # pass the block and render the text
+          indent(50, &block)
+        end
+        # move_down(20)
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers/page_numbers.rb

@@ -0,0 +1,43 @@
+module Aptible
+  module DocumentHelpers
+    module PageNumbers
+      # rubocop:disable MethodLength
+      def page_numbers
+        # Number portrait pages pages
+        font 'Proxima Nova'
+        string = 'Page <page>'
+        options = {
+          at: [bounds.right - 150, -22],
+          width: 150,
+          align: :right,
+          start_count_at: 1,
+          size: 10,
+          color: '999999',
+          page_filter: lambda do |page|
+                         (!page.in?(1..2)) &&
+                         (!page.in?(@landscape_pages))
+                       end
+        }
+        number_pages string, options
+
+        return unless @landscape_pages.any?
+
+        # Number landscape pages
+        options = {
+          at: [bounds.right + 25, -22],
+          width: 150,
+          align: :right,
+          start_count_at: @landscape_pages[0] - 2,
+          size: 10,
+          color: '999999',
+          page_filter: lambda do |page|
+                         page.in?(@landscape_pages)
+                       end
+        }
+        number_pages string, options
+        font 'Georgia'
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers/pretty_table.rb

@@ -0,0 +1,34 @@
+module Aptible
+  module DocumentHelpers
+    module PrettyTable
+      # rubocop:disable MethodLength
+      def pretty_table(data, col_widths, options = {})
+        font_size 11
+
+        # Widths should add to 510 for portrait, 690 for landscape
+
+        table_options = {
+          header: true,
+          column_widths: col_widths,
+          cell_style: { inline_format: true }
+        }
+
+        table(data, table_options) do
+          cells.padding = 8
+          cells.border_color = '999999'
+          row(0).background_color = 'ffcc99'
+          row(0).font_style = :bold
+          row(0).valign = :center
+
+          centering_option = options[:col_center] || ''
+          column(centering_option).align = :center unless centering_option == ''
+
+          bolding_option = options[:col_bold] || ''
+          column(bolding_option).font_style = :bold unless bolding_option == ''
+        end
+        font_size 12
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers/subsection_headings.rb

@@ -0,0 +1,28 @@
+module Aptible
+  module DocumentHelpers
+    module SubsectionHeadings
+      # rubocop:disable MethodLength
+      def subsection_heading(heading_title, section_title)
+        move_down 20
+        formatted_text [
+          text: heading_title,
+          anchor: heading_title,
+          font: 'Proxima Nova',
+          size: 20,
+          styles: [:bold],
+          color: '003366'
+        ]
+
+        move_down 10
+
+        outline.add_subsection_to(section_title) do
+          # Add references for PDF navigation
+          outline.section(title: heading_title, destination: page_number)
+          # Add page titles and numbers for Table of Contents
+          outline.page(title: heading_title, destination: page_number)
+        end
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers/table_of_contents.rb

@@ -0,0 +1,53 @@
+module Aptible
+  module DocumentHelpers
+    module TableOfContents
+      # rubocop:disable MethodLength
+      def table_of_contents
+        go_to_page 2
+        fill_color '333333'
+        font('Proxima Nova')
+        header_box do
+          font('Proxima Nova', size: 30, style: :bold) do
+            text('Table of Contents', valign: :center, color: '003366')
+          end
+        end
+        # text 'Table of Contents', size: 27.812, style: :bold, align: :center
+        move_down(15)
+
+        font('Proxima Nova', size: 13) do
+          column_box([0, cursor], columns: 2, width: bounds.width) do
+            last_title ||= ''
+            # don't bump the first heading
+            bump_heading = false
+            outline.items.keys.each do |key|
+              # Section headings are strings
+              if key.class == String
+                if key != last_title
+                  move_down(3) if bump_heading
+                  text key,
+                       style: :bold,
+                       leading: 3
+                  move_down(2)
+                end
+                # bump each one after the first
+                bump_heading = true
+              else
+                # Page references are hashes
+                last_title = key.fetch(:title)
+                indent(40) do
+                  text "#{key.fetch(:title)}" \
+                       "#{@nbsp}–#{@nbsp}" \
+                       "p.#{@nbsp}#{key.fetch(:destination) - 2 }",
+                       style: :italic,
+                       size: 11,
+                       indent_paragraphs: -20
+                end
+              end
+            end
+          end
+        end
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers/version.rb

@@ -0,0 +1,5 @@
+module Aptible
+  module DocumentHelpers
+    VERSION = '0.0.1'
+  end
+end

data/lib/aptible/document_helpers/watermark.rb

@@ -0,0 +1,56 @@
+module Aptible
+  module DocumentHelpers
+    module Watermark
+      # rubocop:disable MethodLength
+      def watermarked(stamp_type = 'CONFIDENTIAL', format = :portrait, &block)
+        # Tying the definition to the current format helps ensure
+        # the watermark is created with the right margin boxes
+        define_watermarks(format)
+
+        stamp_name = "#{stamp_type} - #{format}"
+
+        # Watermark the current page
+        stamp stamp_name
+
+        # Watermark additional pages
+        on_page_create do
+          stamp stamp_name
+          @landscape_pages.push(page_number) if format == :landscape
+        end
+        yield if block_given?
+        # clears the callback
+        on_page_create
+      end
+
+      def define_watermarks(format = :portrait)
+        @defined_formats ||= []
+        # Catch strings
+        format = format.to_sym
+        return if @defined_formats.include?(format)
+
+        case format
+        when :portrait
+          create_confidential_stamp(48, 0, -60, format)
+        when :landscape
+          create_confidential_stamp(15, 130, 70, format)
+        end
+        @defined_formats << format
+      end
+
+      def create_confidential_stamp(rotation, main_y_pos, sub_y_pos, format)
+        create_stamp("CONFIDENTIAL - #{format}") do
+          rotate(rotation, origin: [0, 0]) do
+            fill_color 'f3f3f3'
+            font('Proxima Nova', style: :bold, size: 100) do
+              draw_text 'CONFIDENTIAL', at: [40, main_y_pos]
+            end
+            font('Proxima Nova', style: :normal, size: 70) do
+              draw_text 'Do Not Distribute', at: [130, sub_y_pos]
+            end
+          end
+        end
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/document_helpers.rb

@@ -0,0 +1,23 @@
+require 'aptible/document_helpers/change_layout_format'
+require 'aptible/document_helpers/font_loader'
+require 'aptible/document_helpers/footer'
+require 'aptible/document_helpers/header'
+require 'aptible/document_helpers/page_numbers'
+require 'aptible/document_helpers/pretty_table'
+require 'aptible/document_helpers/subsection_headings'
+require 'aptible/document_helpers/table_of_contents'
+require 'aptible/document_helpers/watermark'
+
+module Aptible
+  module DocumentHelpers
+    include Aptible::DocumentHelpers::FontLoader
+    include Aptible::DocumentHelpers::Header
+    include Aptible::DocumentHelpers::Footer
+    include Aptible::DocumentHelpers::PageNumbers
+    include Aptible::DocumentHelpers::SubsectionHeadings
+    include Aptible::DocumentHelpers::PrettyTable
+    include Aptible::DocumentHelpers::Watermark
+    include Aptible::DocumentHelpers::ChangeLayoutFormat
+    include Aptible::DocumentHelpers::TableOfContents
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: aptible-prawn-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skylar Anderson
+- Chas Ballew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aptible-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Prawn Document Helpers
+email:
+- skylar@aptible.com
+- chas@aptible.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- aptible-prawn-helpers.gemspec
+- data/fonts/Georgia Bold Italic.ttf
+- data/fonts/Georgia Bold.ttf
+- data/fonts/Georgia Italic.ttf
+- data/fonts/Georgia.ttf
+- data/fonts/proxima_nova.ttf
+- data/fonts/proxima_nova_bold.ttf
+- data/fonts/proxima_nova_bold_italic.ttf
+- data/fonts/proxima_nova_italic.ttf
+- data/fonts/proxima_nova_light.ttf
+- data/fonts/proxima_nova_light_italic.ttf
+- lib/aptible/document_helpers.rb
+- lib/aptible/document_helpers/change_layout_format.rb
+- lib/aptible/document_helpers/font_loader.rb
+- lib/aptible/document_helpers/footer.rb
+- lib/aptible/document_helpers/header.rb
+- lib/aptible/document_helpers/page_numbers.rb
+- lib/aptible/document_helpers/pretty_table.rb
+- lib/aptible/document_helpers/subsection_headings.rb
+- lib/aptible/document_helpers/table_of_contents.rb
+- lib/aptible/document_helpers/version.rb
+- lib/aptible/document_helpers/watermark.rb
+- spec/.keep
+homepage: https://github.com/aptible/aptible-prawn-helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Prawn Document Helpers
+test_files:
+- spec/.keep