thousand_island 0.0.1

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/thousand_island.rb

@@ -0,0 +1,21 @@
+require "thousand_island/version"
+
+require "prawn"
+
+require "thousand_island/style_sheet"
+require "thousand_island/template"
+require "thousand_island/builder"
+
+require "thousand_island/components"
+require "thousand_island/components/base"
+require "thousand_island/components/header"
+require "thousand_island/components/footer"
+require "thousand_island/components/body"
+
+require "thousand_island/utilities/utilities"
+require "thousand_island/utilities/style_hash"
+
+module ThousandIsland
+  Error = Class.new(StandardError)
+  TemplateRequiredError = Class.new(Error)
+end

data/lib/thousand_island/builder.rb

@@ -0,0 +1,153 @@
+module ThousandIsland
+  # Your Builder class is where you will put the necessary logic for
+  # rendering the final pdf. It's up to you how you get the data into
+  # the Builder. It will depend on the complexity. You might just pass
+  # an Invoice object (<code>MyBuilder.new(invoice))</code>) or you may have a
+  # bunch of methods that are called by an external object to get the
+  # data where it needs to be.
+  #
+  # You must declare which Template class you will be using. Failing
+  # to do so will raise a <code>TemplateRequiredError</code> when you call the
+  # build method. Declare the template with the following in the main
+  # class body:
+  #
+  #   uses_template MyTemplate
+  #
+  # Your Builder can have a <code>filename</code> method, which will help a Rails
+  # Controller or other class determine the name to use to send the
+  # file to the browser or save to the filesystem (or both). Without
+  # this method it will have a default name, so you may choose to put
+  # the naming logic for your file elsewhere, it's up to you.
+  #
+  # You must have a <code>body_content</code> method that takes no arguments (or
+  # the pdf will be empty!). This is the method that is passed around
+  # internally in order for Prawn to render what is in the method.
+  # You can use raw Prawn syntax, or any of the style magic methods
+  # to render to the pdf. You may also call other methods from your
+  # <code>body_content</code> method, and use Prawn syntax and magic methods in
+  # those too.
+  #
+  #  A Builder example might be:
+  #
+  #   class MyBuilder < ThousandIsland::Builder
+  #     uses_template MyTemplate
+  #
+  #     attr_reader :data
+  #
+  #     def initialize(data={})
+  #       @data = data
+  #       # do something with the data...
+  #     end
+  #
+  #     def filename
+  #       "Document#{data.id_number}"
+  #     end
+  #
+  #     def body_content
+  #       # call custom methods, magic methods or call Prawn methods directly:
+  #       h1 'Main Heading'
+  #       display_info
+  #       body 'Main text in here...'
+  #     end
+  #
+  #     # Custom method called by body_content
+  #     def display_info
+  #       body "Written by: #{data.author}"
+  #       pdf.image data.avatar, height: 20
+  #     end
+  #   end
+  #
+  #
+  # Finally, to get the finished pdf from your Builder, call the <code>build</code> method like so:
+  #
+  #   pdf = my_builder.build
+  #
+  #
+  # Optional:
+  #
+  # Define a <code>header_content</code> method to add content below whatever is defined in the Template. This will be repeated according to the header settings in the Template.
+  #
+  # Define a <code>footer_content</code> method to add content above whatever is defined in the Template. This will be repeated according to the footer settings in the Template.
+  #
+  # Define a <code>settings</code> method that returns a Hash. This will be passed to the Template class and will override any of the Template default settings.
+  class Builder
+
+    attr_reader :pdf
+
+    class << self
+      attr_writer :template_klass
+
+      def template_klass
+        raise TemplateRequiredError.new 'Builders must set a Template class with #uses_template in the Class body' if @template_klass.nil?
+        @template_klass
+      end
+
+      def uses_template(klass)
+        self.template_klass = klass
+      end
+    end
+
+    def initialize(data=nil)
+    end
+
+    def filename
+      'default_filename'
+    end
+
+    # Returns the finished pdf ready to save to the filesystem or send back to the user's browser
+    def build
+      #body first so we know how many pages for repeated components
+      draw_body
+      draw_header
+      draw_footer
+      pdf.render
+    end
+
+    def settings
+      {}
+    end
+
+  private
+
+    def draw_header
+      template.draw_header do
+        header_content if self.respond_to? :header_content
+      end
+    end
+
+    def draw_body
+      template.draw_body do
+        body_content if respond_to? :body_content
+      end
+    end
+
+    def draw_footer
+      template.draw_footer do
+        footer_content if respond_to? :footer_content
+      end
+    end
+
+
+    def template
+      @template ||= begin
+        template = self.class.template_klass.new(settings)
+        @pdf = template.pdf
+        template
+      end
+    end
+
+    #Respond to methods that relate to the style_sheet known styles
+    def method_missing(method_name, *arguments, &block)
+      if template.available_styles.include?(method_name)
+        template.send(method_name, *arguments)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, *)
+      template.available_styles.include?(method_name) || super
+    end
+
+  end
+end

data/lib/thousand_island/components.rb

@@ -0,0 +1,4 @@
+module ThousandIsland
+  module Components
+  end
+end

data/lib/thousand_island/components/base.rb

@@ -0,0 +1,43 @@
+module ThousandIsland
+  module Components
+    class Base
+
+      attr_reader :pdf, :options
+
+      def initialize(pdf, args=nil)
+        @options = args || self.defaults
+        @pdf = pdf
+      end
+
+      def draw(&block)
+        if repeated?
+          render_all &block
+        else
+          render &block
+        end
+      end
+
+      def render_all(&block)
+        pdf.repeat :all do
+          render &block
+        end
+      end
+
+      def render(&block)
+        raise NotImplementedError
+      end
+
+      def repeated?
+        false
+      end
+
+      def self.defaults
+        {}
+      end
+
+      def defaults
+        self.class.defaults
+      end
+    end
+  end
+end

data/lib/thousand_island/components/body.rb

@@ -0,0 +1,18 @@
+module ThousandIsland
+  module Components
+    class Body < Base
+      
+      def render
+        start_coords = [0, options[:top]]
+        pdf.bounding_box(start_coords, height: options[:height], width: pdf.bounds.width) do
+          yield if block_given?
+        end
+      end
+
+      def self.defaults
+        {
+        }
+      end
+    end
+  end
+end

data/lib/thousand_island/components/footer.rb

@@ -0,0 +1,85 @@
+module ThousandIsland
+  module Components
+    class Footer < Base
+
+      def numbering_string
+        options[:numbering_string]
+      end
+
+      def number_pages?
+        options[:number_pages]
+      end
+
+      def render(&block)
+        pdf.bounding_box([0, box_height], width: pdf.bounds.width, height: box_height) do
+          col1
+          col2(&block)
+          col3
+        end
+      end
+
+      def col1_width
+        pdf.bounds.width * 0.15
+      end
+
+      def col2_width
+        pdf.bounds.width * 0.7
+      end
+
+      def col3_width
+        pdf.bounds.width * 0.15
+      end
+
+      def col1
+      end
+
+      def col2
+        start = col1_width
+        pdf.bounding_box([start, box_height], width: col2_width, height: box_height) do
+          options[:style].each do |k,v|
+            pdf.send(k, v) if pdf.respond_to?(k)
+          end if options[:style]
+          yield if block_given?
+        end
+      end
+
+      def col3
+        start = col1_width + col2_width
+        pdf.bounding_box([start, box_height], width: col3_width, height: box_height) do
+          pdf.number_pages numbering_string, numbering_options if number_pages?
+        end
+      end
+
+      def box_height
+        options[:height]
+      end
+
+      def numbering_options
+        options[:style].merge(options[:numbering_options])
+      end
+
+      def repeated?
+        options[:repeated]
+      end
+
+      def self.defaults
+        {
+          height: 33,
+          top_padding: 20,
+          repeated: true,
+          numbering_options: default_numbering_options,
+          number_pages: true,
+          numbering_string: '<page>',
+          style: {},
+        }
+      end
+
+      def self.default_numbering_options
+        {
+          align: :right,
+          start_count_at: 1,
+        }
+      end
+    end
+  end
+end

data/lib/thousand_island/components/header.rb

@@ -0,0 +1,24 @@
+module ThousandIsland
+  module Components
+    class Header < Base
+      
+      def render
+        pdf.bounding_box([0, pdf.bounds.height], width: pdf.bounds.width, height: options[:height]) do
+          yield if block_given?
+        end
+      end
+
+      def repeated?
+        options[:repeated]
+      end
+
+      def self.defaults
+        {
+          height: 33,
+          bottom_padding: 20,
+          repeated: true
+        }
+      end
+    end
+  end
+end

data/lib/thousand_island/style_sheet.rb

@@ -0,0 +1,112 @@
+module ThousandIsland
+  # The StyleSheet is designed to be a mixin to the Template class. It may also
+  # be included into other modules to define custom StyleSheets.
+  #
+  # Methods should return a StyleHash object rather than a vanilla Hash, as it
+  # has some customisation to help it work with Prawn. The default_style is
+  # used as the starting point for all other styles. For instance, the
+  # <code>default_style[:size]</code> value is multiplied in the heading styles,
+  # so changing the default style size value will have a cascading effect. Check
+  # the source for the default values and override as preferred.
+  #
+  # An example of a custom StyleSheet:
+  #
+  #   module MyStyleSheet
+  #     include ThousandIsland::StyleSheet
+  #
+  #     def default_style
+  #       super.merge({
+  #         size: 12,
+  #         color: '222222'
+  #       })
+  #     end
+  #
+  #     def h1_style
+  #       super.merge({ align: :center })
+  #     end
+  #
+  #   end
+  #
+  module StyleSheet
+
+    def default_style
+      StyleHash.new({
+          size: 10,
+          style: :normal,
+          align: :left,
+          leading: 1,
+          inline_format: true,
+          color: '000000',
+      })
+    end
+
+    def body_style
+      default_style
+    end
+
+    def h1_style
+      default_style.merge({
+          size: default_style[:size] * 1.8,
+          style: :bold,
+          leading: 8,
+      })
+    end
+
+    def h2_style
+      default_style.merge({
+          size: default_style[:size] * 1.5,
+          style: :bold,
+          leading: 4,
+      })
+    end
+
+    def h3_style
+      default_style.merge({
+          size: default_style[:size] * 1.4,
+          style: :bold,
+          leading: 4,
+      })
+    end
+
+    def h4_style
+      default_style.merge({
+          size: default_style[:size] * 1.1,
+          style: :bold_italic,
+          leading: 4,
+      })
+    end
+
+    def h5_style
+      default_style.merge({
+          size: default_style[:size] * 1,
+          leading: 4,
+      })
+    end
+
+    def h6_style
+      default_style.merge({
+          size: default_style[:size] * 0.85,
+          style: :italic,
+          leading: 4,
+      })
+    end
+
+    def footer_style
+      default_style.merge({
+         size: default_style[:size] * 0.8,
+         color: '666666',
+         align: :center,
+      })
+    end
+
+    available_styles = []
+    instance_methods.grep(/_style$/).each do |method_name|
+      style = method_name.to_s.sub('_style', '')
+      available_styles << style.to_sym unless style == 'default'
+    end
+    define_method(:available_styles) do
+      available_styles
+    end
+
+  end
+end