Giter VIP home page Giter VIP logo

sugpoko's Introduction

Sugpoko

Modularize your pdf code with this gem

Installation

Add this line to your application's Gemfile:

gem 'prawn'
gem 'sugpoko'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sugpoko

Usage

Create a class that inherits Sugpoko::Base. This class is the main pdf component where the pdf generation is triggered. It includes Prawn::View module.

class PdfDocument < Sugpoko::Base
  def generate
    pdf.text 'Hello World'
  end
end

PdfDocument.new.generate
# Hello world

A component can also be created using Sugpoko::Component

class Header < Sugpoko::Component
  def generate
    pdf.text 'This is a header'
  end
end

To add Header on our previous base document, use draw method. It accepts a class that inherits from either Sugpoko::Base or Sugpoko::Component.

class PdfDocument < Sugpoko::Base
  def generate
    draw Header
    pdf.text 'Hello World'
    draw ...
  end
end

PdfDocument.new.generate
# This is a Header
# Hello World

Sugpoko::Component can also use draw method

Bug reports and pull requests are welcome on GitHub at https://github.com/neume/sugpoko.

sugpoko's People

Contributors

neume avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.