elegant 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36b854e581ccff601af3015dd4b19c25f095202f
-  data.tar.gz: 4b4444ebe31e9ab1359ed1c6432e9ed4a279d083
+  metadata.gz: 49d380d40dfac8ce477d00db75bc1604695432a3
+  data.tar.gz: 75459d4ca3def9cfe6a639196ea3285744282f74
 SHA512:
-  metadata.gz: 969b386e87be5af551ed7e270fbe806731dc705c6de719743940051b9178b3b7b08fb30db2a99f4ce0bff50c66f8a931293804f235eff664fe191aa10392f00f
-  data.tar.gz: 4d6ab0f39dca53487225356245da59e699ad411f99f2880b755ebaa90f4d852d89716c8679a05ec4f11bca31e6afce7d27bf8a1460a3cc9a1d28698ae70afd44
+  metadata.gz: 5591417ffb9d7fe2496f7c381fc35cea285c2339d886eca283d19cacdcf29c3b81b3a37d2c8a6d6b8ca8545e68ef2429a14f5095db9c83cb5aa67a62bf1bb09c
+  data.tar.gz: 5cf7843617579048f2f96f305b2c0e04ad3af0c18e2f7ed851da1838b3efd88336fcd473512bf024c10e4f6d6f40fc492007795aeed1e909cd81082dc0608482

data/.gitignore

@@ -7,4 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.gem
+elegant.pdf
+example*.pdf
+*.psd

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6
+  - 2.1.0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+For more information about changelogs, check
+[Keep a Changelog](http://keepachangelog.com) and
+[Vandamme](http://tech-angels.github.io/vandamme).
+
+## 1.0.0 - 2015.11.03
+
+* [FEATURE] New `Elegant::Document` class with `title` method.

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 claudiob
+Copyright (c) 2015 Fullscreen, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.md

@@ -1,41 +1,73 @@
-# Elegant
+Elegant
+=======
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/elegant`. To experiment with that code, run `bin/console` for an interactive prompt.
+Elegant provides a nice layout for PDF reports generated in Ruby.
 
-TODO: Delete this and the text above, and describe your gem
+The **source code** is available on [GitHub](https://github.com/Fullscreen/elegant) and the **documentation** on [RubyDoc](http://www.rubydoc.info/github/Fullscreen/elegant/master/Elegant/Interface).
 
-## Installation
+[![Build Status](http://img.shields.io/travis/Fullscreen/elegant/master.svg)](https://travis-ci.org/Fullscreen/elegant)
+[![Coverage Status](http://img.shields.io/coveralls/Fullscreen/elegant/master.svg)](https://coveralls.io/r/Fullscreen/elegant)
+[![Dependency Status](http://img.shields.io/gemnasium/Fullscreen/elegant.svg)](https://gemnasium.com/Fullscreen/elegant)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fullscreen/elegant.svg)](https://codeclimate.com/github/Fullscreen/elegant)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/github/Fullscreen/elegant/master/Elegant)
+[![Gem Version](http://img.shields.io/gem/v/elegant.svg)](http://rubygems.org/gems/elegant)
 
-Add this line to your application's Gemfile:
+Elegant is a library built on top of [Prawn](http://prawnpdf.org) to generate PDF files in Ruby.
 
-```ruby
-gem 'elegant'
-```
+Whereas Prawn creates PDF pages that are completely blank (letting users customize them at will),
+Elegant comes with a nice layout that makes each page look… elegant! :wink:
+
+How to use
+==========
 
-And then execute:
+If you have never used [Prawn](http://prawnpdf.org/) to generate PDF files, you should first read [its manual](http://prawnpdf.org/manual.pdf).
 
-    $ bundle
+Using Elegant is as simple as replacing any instance of `Prawn::Document` with `Elegant::Document`:
 
-Or install it yourself as:
+```ruby
+# with Prawn
+Prawn::Document.new do
+  text 'Hello, World!'
+end
+
+# with Elegant
+Elegant::Document.new do
+  text 'Hello, World!'
+end
+
+# with Elegant and extra options
+header = {text: 'A report', logo: {url: 'http://lorempixel.com/500/500'}}
+footer = {text: 'A link', url: 'http://www.example.com'}
+Elegant::Document.new(header: header, footer: footer) do
+  title 'Welcome'
+  text 'Hello, world!'
+end
+```
 
-    $ gem install elegant
+![Prawn vs. Elegant](https://cloud.githubusercontent.com/assets/7408595/10898333/433a6072-817e-11e5-8c95-999c5629e84c.jpg)
 
-## Usage
+`Elegant::Document` accepts some options [... TODO ...]
 
-TODO: Write usage instructions here
+How to install
+==============
 
-## Development
+Elegant requires **Ruby 2.1 or higher**.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To include in your project, add `gem 'elegant', ~> '1.0'` to the `Gemfile` file of your Ruby project.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+How to generate the manual
+==========================
 
-## Contributing
+`rake manual`
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/elegant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+How to contribute
+=================
 
+If you’ve made it this far in the README… thanks! :v:
+Feel free to try it the gem, explore the code, and send issues or pull requests.
 
-## License
+All pull requests will have to make Travis and Code Climate happy in order to be accepted. :kissing_smiling_eyes:
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+You can also run the tests locally with `bundle exec rspec`.
 
+Happy hacking!

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+
+require "rspec/core/rake_task"
+require "rspec/core/version"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new :spec
+
+task default: [:spec]

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'elegant'
+require "bundler/setup"
+require "elegant"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require 'pry'
-# Pry.elegantt
+# require "pry"
+# Pry.start
 
-require 'irb'
+require "irb"
 IRB.start

data/bin/elegant

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'elegant'
+rescue LoadError
+  require 'rubygems'
+  require 'elegant'
+end
+
+class Section
+  attr_accessor :title, :page, :alignment
+  def initialize(title:, page:, alignment:)
+    @title, @page, @alignment = title, page, alignment
+  end
+
+  attr_accessor :document
+  include Prawn::View
+  def render_to(pdf)
+    @document = pdf
+    render
+  end
+
+  def render
+    header
+
+    bounding_box [0, cursor], width: bounds.width, height: 170 do
+      stroke_bounds
+    end
+
+    footer
+  end
+
+private
+
+  def header
+    if alignment == :top and page > 1
+      start_new_page
+    end
+
+    move_down 10
+    formatted_text_box [{text: title.upcase, font: sans_serif, styles: [:bold], valign: :center, color: '556270', size: 14}], height: 15, at: [0, cursor]
+    move_down 30 # 15 of the float box, and 15 real
+  end
+
+  def footer
+    unless alignment == :bottom
+      document.move_down 25
+      document.stroke_horizontal_rule
+    end
+  end
+
+  def sans_serif
+    'Sans Serif' if document.font_families['Sans Serif']
+  end
+end
+
+sections = [
+  Section.new(title: 'Lifetime Metrics', page: 1, alignment: :top),
+  Section.new(title: 'Monetization', page: 1, alignment: :middle),
+  Section.new(title: 'Month over month view tracking', page: 1, alignment: :bottom),
+  Section.new(title: 'Lifetime Metrics', page: 2, alignment: :top),
+  Section.new(title: 'Month over month view tracking', page: 2, alignment: :middle),
+]
+
+def font_files_for(family)
+  {normal: ttf("#{family}-Regular"), bold: ttf("#{family}-Bold")}
+end
+
+def ttf(basename)
+  asset "fonts/#{basename}.ttf"
+end
+
+def png(basename)
+  asset "images/#{basename}.png"
+end
+
+def asset(path)
+  File.expand_path "../../tmp/#{path}", __FILE__
+end
+
+fonts = {}.tap do |families|
+  families['Helvetica']    = font_files_for 'HelveticaWorld'
+  families['Fallback']     = font_files_for 'ArialUnicode'
+  families['Sans Serif']   = font_files_for 'ProximaNova'
+end
+
+company_logo = png('logo')
+company_name = 'Fullscreen'
+title = 'March 2015'
+thumbnail = png('thumbnail')
+footer = "Report for channelpl.us (2015/02/12 – 2015/10/12)"
+
+filename = 'elegant.pdf'
+
+Elegant::Document.new(fonts: fonts, title: title, company_logo: company_logo, thumbnail: thumbnail, footer: footer, company_name: company_name) do |pdf|
+  sections.each{|section| section.render_to pdf}
+end.render_file filename
+
+`open #{filename}`

data/elegant.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elegant/version'
@@ -9,16 +8,24 @@ Gem::Specification.new do |spec|
   spec.authors       = ['claudiob']
   spec.email         = ['claudiob@gmail.com']
 
-  spec.summary       = %q{:elegant:}
-  spec.description   = %q{:elegant: :elegant: :elegant:}
-  spec.homepage      = 'https://github.com/claudiob/elegant'
+  spec.summary       = %q{An elegant layout for PDF reports generated in Ruby.}
+  spec.description   = %q{Elegant expands Prawn providing a new class to generate new pages with an elegant layout.}
+  spec.homepage      = 'https://github.com/Fullscreen/elegant'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.1' # 2.0 does not have Array#to_h
+
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_dependency             'prawn', '~> 2.0'
+
+  spec.add_development_dependency 'pdf-inspector', '~> 1.2'
+  spec.add_development_dependency 'prawn-manual_builder', '~> 0.2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'coveralls', '~> 0.8.2'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
 end

data/lib/elegant/config.rb

@@ -0,0 +1,42 @@
+require 'elegant/configuration'
+
+module Elegant
+  # Provides methods to read and write global configuration settings.
+  #
+  # @example Set the author of PDF files to 'John Doe':
+  #   Elegant.configure do |config|
+  #     config.author = 'John Doe'
+  #   end
+  #
+  module Config
+    # Yields the global configuration to the given block.
+    #
+    # @example
+    #   Elegant.configure do |config|
+    #     config.author = 'John Doe'
+    #   end
+    #
+    # @yield [Elegant::Configuration] The global configuration.
+    def configure
+      yield configuration if block_given?
+    end
+
+    # Returns the global {Elegant::Models::Configuration} object.
+    #
+    # While this method _can_ be used to read and write configuration settings,
+    # it is easier to use {Elegant::Config#configure} Elegant.configure}.
+    #
+    # @example
+    #     Elegant.configuration.author = 'John Doe'
+    #
+    # @return [Elegant::Configuration] The global configuration.
+    def configuration
+      @configuration ||= Elegant::Configuration.new
+    end
+  end
+
+  # @note Config is the only module auto-loaded in the Elegant module,
+  #       in order to have a syntax as easy as Elegant.configure
+
+  extend Config
+end

data/lib/elegant/configuration.rb

@@ -0,0 +1,49 @@
+module Elegant
+  # Provides an object to store global configuration settings.
+  #
+  # This class is typically not used directly, but by calling
+  # {Elegant::Config#configure Elegant.configure}, which creates and updates a
+  # single instance of {Elegant::Configuration}.
+  #
+  # @example Set the author of PDF files to 'John Doe':
+  #   Elegant.configure do |config|
+  #     config.author = 'John Doe'
+  #   end
+  #
+  # @see Elegant::Config for more examples.
+  class Configuration
+    # @return [String] the Author to store in the PDF metadata
+    attr_accessor :author
+
+    # @return [String] the Creator to store in the PDF metadata
+    attr_accessor :creator
+
+    # @return [String] the Producer to store in the PDF metadata
+    attr_accessor :producer
+
+    # @return [String] the path of an image to display on every page
+    attr_accessor :watermark
+
+    # @return [Array<Hash<Symbol, Hash<Symbol, String>] the fonts to use.
+    attr_accessor :fonts
+
+    def initialize
+      @author = 'Elegant'
+      @creator = 'Elegant'
+      @producer = 'Elegant'
+      @watermark = asset 'images/default_watermark.png'
+      @fonts = {'Sans Serif' => default_font, 'Fallback' => default_font}
+    end
+
+  private
+
+    def default_font
+      type = 'DejaVuSans'
+      {normal: asset("fonts/#{type}.ttf"), bold: asset("fonts/#{type}Bold.ttf")}
+    end
+
+    def asset(file)
+      File.expand_path "../#{file}", __FILE__
+    end
+  end
+end

data/lib/elegant/document.rb

@@ -0,0 +1,81 @@
+require 'elegant/config'
+require 'elegant/footer'
+require 'elegant/header'
+require 'elegant/typography'
+
+module Elegant
+  # A wrapper around Prawn::Document that enforces an elegant layout, setting
+  # nice dimensions and margins so that each page can fit up to three sections
+  # of content properly aligned along the vertical axis.
+  class Document < ::Prawn::Document
+    # Creates a new Elegant Document.
+    # @param [Hash] options. All the options of Prawn::Document are
+    # available, plus the following extra options.
+    # @option options [Hash] :header ({}) The options for the header. Accepted
+    #   values are :text (the title to write in the top-right corner) and :logo
+    #   (a Hash with a :url key with the location of the logo image and
+    #    optional :width and :height, which default to 50x50).
+    # @option options [Hash] :footer ({}) The options for the footer. Accepted
+    #   values are :text (the text in the bottom-center of the page) and :url
+    #   (to make that text a link to a URL).
+    # @see http://www.rubydoc.info/gems/prawn/Prawn/Document
+    def initialize(options = {}, &block)
+      options = options.dup
+      @header = Header.new self, options.delete(:header) {{}}
+      @footer = Footer.new self, options.delete(:footer) {{}}
+
+      super(with_elegant options) do
+        Typography.new(self).set_fonts
+        @header.render
+
+        if block
+          block.arity < 1 ? instance_eval(&block) : block[self]
+        end
+
+        @footer.render
+      end
+    end
+
+    # An additional method provided by Elegant::Document to render a title
+    # with an elegant font and padding above and below.
+    def title(text, options = {})
+      move_down 10
+
+      width = bounds.width - @header.title_padding
+      title = text_options.merge text: text.upcase, color: '556270', size: 14
+      options = {width: width, height: 15, at: [0, cursor]}
+      formatted_text_box [title], options
+
+      move_down 30
+    end
+
+    # Determines the total height occupied by the header
+    def header_height
+      50
+    end
+
+  private
+
+    # Applies some elegant defaults to the options provided by the user. For
+    # instance forces the layout to be letter portrait, and set the metadata
+    # from the configuration if not explicitly provided.
+    def with_elegant(options)
+      options[:page_size] = 'LETTER'
+      options[:page_layout] = :portrait
+      options[:print_scaling] = :none
+      options[:top_margin] = (default_margin = 36) + header_height / 2
+      options[:info] = default_metadata.merge(options.fetch :info, {})
+      options
+    end
+
+    def default_metadata
+      %i(Author Creator Producer).map do |key|
+        [key, Elegant.configuration.public_send(key.to_s.downcase)]
+      end.to_h
+    end
+
+    def text_options
+      {font: 'Sans Serif', styles: [:bold]}
+    end
+  end
+end

data/lib/elegant/fonts/DejaVuLicense.txt

@@ -0,0 +1,97 @@
+Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
+Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
+
+Bitstream Vera Fonts Copyright
+------------------------------
+
+Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
+a trademark of Bitstream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of the fonts accompanying this license ("Fonts") and associated
+documentation files (the "Font Software"), to reproduce and distribute the
+Font Software, including without limitation the rights to use, copy, merge,
+publish, distribute, and/or sell copies of the Font Software, and to permit
+persons to whom the Font Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright and trademark notices and this permission notice shall
+be included in all copies of one or more of the Font Software typefaces.
+
+The Font Software may be modified, altered, or added to, and in particular
+the designs of glyphs or characters in the Fonts may be modified and
+additional glyphs or characters may be added to the Fonts, only if the fonts
+are renamed to names not containing either the words "Bitstream" or the word
+"Vera".
+
+This License becomes null and void to the extent applicable to Fonts or Font
+Software that has been modified and is distributed under the "Bitstream
+Vera" names.
+
+The Font Software may be sold as part of a larger software package but no
+copy of one or more of the Font Software typefaces may be sold by itself.
+
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT,
+TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL BITSTREAM OR THE GNOME
+FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING
+ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE
+FONT SOFTWARE.
+
+Except as contained in this notice, the names of Gnome, the Gnome
+Foundation, and Bitstream Inc., shall not be used in advertising or
+otherwise to promote the sale, use or other dealings in this Font Software
+without prior written authorization from the Gnome Foundation or Bitstream
+Inc., respectively. For further information, contact: fonts at gnome dot
+org. 
+
+Arev Fonts Copyright
+------------------------------
+
+Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the fonts accompanying this license ("Fonts") and
+associated documentation files (the "Font Software"), to reproduce
+and distribute the modifications to the Bitstream Vera Font Software,
+including without limitation the rights to use, copy, merge, publish,
+distribute, and/or sell copies of the Font Software, and to permit
+persons to whom the Font Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright and trademark notices and this permission notice
+shall be included in all copies of one or more of the Font Software
+typefaces.
+
+The Font Software may be modified, altered, or added to, and in
+particular the designs of glyphs or characters in the Fonts may be
+modified and additional glyphs or characters may be added to the
+Fonts, only if the fonts are renamed to names not containing either
+the words "Tavmjong Bah" or the word "Arev".
+
+This License becomes null and void to the extent applicable to Fonts
+or Font Software that has been modified and is distributed under the 
+"Tavmjong Bah Arev" names.
+
+The Font Software may be sold as part of a larger software package but
+no copy of one or more of the Font Software typefaces may be sold by
+itself.
+
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL
+TAVMJONG BAH BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
+
+Except as contained in this notice, the name of Tavmjong Bah shall not
+be used in advertising or otherwise to promote the sale, use or other
+dealings in this Font Software without prior written authorization
+from Tavmjong Bah. For further information, contact: tavmjong @ free
+. fr.

data/lib/elegant/footer.rb

@@ -0,0 +1,46 @@
+require 'open-uri' # for open(http://...)
+module Elegant
+  class Footer
+    include Prawn::View
+
+    def initialize(document, options = {})
+      @document = document
+      @text, @url = options.values_at :text, :url
+    end
+
+    # Draws in the header of each page a horizontal line, the name of the
+    # author, the title and the page number. The author must be provided in
+    # the configuration, and the title when initializing the document.
+    def render
+      repeat(:all) do
+        transparent(0.25) { stroke_horizontal_line 0, bounds.width, at: 0 }
+        render_author
+        render_text if @text
+      end
+      render_page_number
+    end
+
+  private
+
+    def render_author
+      options = {at: [0, -6], width: 50, height: 10, size: 7, valign: :top}
+      text_box Elegant.configuration.author, options
+    end
+
+    def render_text
+      text = @url ? "<link href='#{@url}'>#{@text}</link>" : @text
+      left = 50
+      options = {size: 7, align: :center, valign: :top, inline_format: true}
+      options[:at] = [left, -6]
+      options[:width] = bounds.width - 2 * left
+      options[:height] = 10
+      text_box text, options
+    end
+
+    def render_page_number
+      options = {width: 50, height: 10, size: 7, align: :right, valign: :top}
+      options[:at] = [bounds.width - options[:width], -6]
+      number_pages "Page <page>", options
+    end
+  end
+end

data/lib/elegant/header.rb

@@ -0,0 +1,91 @@
+require 'open-uri' # for open(http://...)
+module Elegant
+  class Header
+    include Prawn::View
+
+    def initialize(document, options = {})
+      @document = document
+      @text, @logo = options.values_at :text, :logo
+      @logo_width = @logo.fetch(:width, 50) if @logo
+      @logo_height = @logo.fetch(:height, 50) if @logo
+    end
+
+    # Draws in the header of each page a watermark logo (provided via the
+    # configuration), a horizontal line, a title and an image for the content.
+    def render
+      repeat(:all) do
+        render_watermark
+        stroke_horizontal_rule
+        render_logo if @logo
+        render_heading
+      end
+    end
+
+    # Sets the right padding for title based on whether the page has a logo
+    # or not.
+    def title_padding
+      @logo_width ? @logo_width + (margin = 7) : 0
+    end
+
+  private
+
+    # Renders a watermark at the top-left corner of each page. The watermark
+    # must be provided via configuration.
+    def render_watermark
+      image = Elegant.configuration.watermark
+      height = (document.header_height * 0.25).ceil
+      y = bounds.top + (document.header_height * 0.375).floor
+      image image, at: [0, y], height: height.ceil
+    end
+
+
+    # Renders an image in the top-right corner of each page. The image must be
+    # provided when initializing the document.
+    def render_logo
+      float do
+        render_logo_frame
+        render_logo_image
+      end if @logo
+    end
+
+    # Renders a frame around the logo in the top-right corner.
+    def render_logo_frame(options = {})
+      width = @logo_width + line_width
+      height = @logo_height + line_width
+      left = bounds.right - width - 0.5 * line_width
+      top = bounds.top + 0.5 * height
+      bounding_box([left, top], width: width, height: height) {stroke_bounds}
+    end
+
+    # Renders the actual image as the logo in the top-right corner.
+    def render_logo_image
+      left = bounds.right - @logo_width - line_width
+      top = bounds.top + @logo_height / 2
+      options = {width: @logo_width, height: @logo_height, at: [left, top]}
+      image open(@logo[:url]), options
+    rescue OpenURI::HTTPError, OpenSSL::SSL::SSLError, SocketError
+    end
+
+    # Writes the heading for the document in the top-right corner of each page,
+    # to the left of the logo. The heading must be provided when initializing
+    # the document.
+    def render_heading
+      transparent(0.25) do
+        font('Sans Serif', style: :bold) {text_box @text, heading_options}
+      end if @text
+    end
+
+    def heading_options(options = {})
+      left = 25
+      width = (@logo_width || 0) + 2 * line_width + (margin = 5)
+      options[:valign] = :center
+      options[:align] = :right
+      options[:size] = 17
+      options[:overflow] = :shrink_to_fit
+      options[:width] = bounds.width - width - left
+      options[:height] = document.header_height / 2.0
+      options[:at] = [left, bounds.top + options[:height]]
+      options
+    end
+  end
+end

data/lib/elegant/typography.rb

@@ -0,0 +1,17 @@
+module Elegant
+  class Typography
+    include Prawn::View
+
+    def initialize(document, options = {})
+      @document = document
+    end
+    
+    # Set the fonts for the document. Fonts are provided via configuration and
+    # a 'Fallback' font must be set to be used for special characters. A
+    # 'Sans Serif' font is also required for titles and headers.
+    def set_fonts
+      font_families.update Elegant.configuration.fonts
+      fallback_fonts ['Fallback']
+    end
+  end
+end

data/lib/elegant/version.rb

@@ -1,3 +1,3 @@
 module Elegant
-  VERSION = '0.0.0'
+  VERSION = '1.0.0'
 end

data/lib/elegant.rb

@@ -1,5 +1,7 @@
-require 'elegant/version'
+require 'prawn'
+require 'elegant/document'
 
+# Provides Elegant::Document, a wrapper around Prawn::Document to initialize
+# PDF pages with an elegant layout.
 module Elegant
-  # Your code goes here...
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: elegant
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: prawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: prawn-manual_builder
+  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: '1.10'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +66,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: ":elegant: :elegant: :elegant:"
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: Elegant expands Prawn providing a new class to generate new pages with
+  an elegant layout.
 email:
 - claudiob@gmail.com
 executables: []
@@ -47,17 +118,28 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - bin/console
-- bin/dhh
+- bin/elegant
 - bin/setup
 - elegant.gemspec
 - lib/elegant.rb
+- lib/elegant/config.rb
+- lib/elegant/configuration.rb
+- lib/elegant/document.rb
+- lib/elegant/fonts/DejaVuLicense.txt
+- lib/elegant/fonts/DejaVuSans.ttf
+- lib/elegant/fonts/DejaVuSansBold.ttf
+- lib/elegant/footer.rb
+- lib/elegant/header.rb
+- lib/elegant/images/default_watermark.png
+- lib/elegant/typography.rb
 - lib/elegant/version.rb
-homepage: https://github.com/claudiob/elegant
+homepage: https://github.com/Fullscreen/elegant
 licenses:
 - MIT
 metadata: {}
@@ -69,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -80,6 +162,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: ":elegant:"
+summary: An elegant layout for PDF reports generated in Ruby.
 test_files: []
-has_rdoc: 

data/bin/dhh

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'elegant'