sugpoko 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88e84036fab620a72d223e6b63b24e1aaca2f057
+  data.tar.gz: 5112051bf8f3054a66aed7a1545f9d58a46abcb7
+SHA512:
+  metadata.gz: 699cf988d09c49bd0e7e71bf997d2d7786b56721d3d6de22c2d19bffee0c321abb33fb24d199a07ad002b6eeba2c05714829b7f1b137154ed5d0f74b3c21786e
+  data.tar.gz: f46bc4dd1388ec612f9b86fd3bb3894516c7438166fda47a692d0c1aabaa87138e9d4c4e5a785926a9902a2018cbe69f71316ce32bdcfbda759d29f24def890d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,68 @@
+# Sugpoko
+
+Modularize your pdf code with this gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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.
+
+``` ruby
+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`
+
+``` ruby
+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`.
+``` ruby
+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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sugpoko"
+
+# 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.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sugpoko.rb

@@ -0,0 +1,9 @@
+require "sugpoko/version"
+require 'prawn'
+require 'sugpoko/base'
+require 'sugpoko/component'
+require "prawn/measurement_extensions"
+
+module Sugpoko
+  class Error < StandardError; end
+end

data/lib/sugpoko/base.rb

@@ -0,0 +1,32 @@
+module Sugpoko
+  class Base
+    attr_reader :pdf, :data
+
+    include Prawn::View
+
+    def generate
+      raise '#generate not defined'
+    end
+
+    def draw(klass, options = {})
+      klass.new(options.merge(pdf: pdf)).generate
+    end
+
+    def initialize(options = {})
+      @data = options[:data]
+      @pdf = self
+    end
+
+    def document
+      @document ||= Prawn::Document.new(default_options)
+    end
+
+    def default_options
+      @default_options ||= {
+        page_size: [8.5.in, 11.in],
+        page_layout: :portrait
+      }
+    end
+
+  end
+end

data/lib/sugpoko/component.rb

@@ -0,0 +1,16 @@
+class Sugpoko::Component
+  attr_reader :pdf, :cursor_origin
+
+  def generate
+    raise '#generate not defined'
+  end
+
+  def draw(klass, options = {})
+    klass.new(options.merge(pdf: pdf)).generate
+  end
+
+  def initialize(options = {})
+    @pdf = options.fetch(:pdf)
+    @cursor_origin = pdf.cursor
+  end
+end

data/lib/sugpoko/version.rb

@@ -0,0 +1,3 @@
+module Sugpoko
+  VERSION = "0.1.0"
+end

data/sugpoko.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sugpoko/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sugpoko"
+  spec.version       = Sugpoko::VERSION
+  spec.authors       = ["Joseph Nelson Valeros"]
+  spec.email         = ["valerosjoseph@gmail.com"]
+
+  spec.summary       = %q{A prawnpdf wrapper }
+  spec.description   = %q{Modularize your prawnpdf code }
+  spec.homepage      = "https://github.com/neume/sugpoko"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sugpoko
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Nelson Valeros
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Modularize your prawnpdf code '
+email:
+- valerosjoseph@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sugpoko.rb
+- lib/sugpoko/base.rb
+- lib/sugpoko/component.rb
+- lib/sugpoko/version.rb
+- sugpoko.gemspec
+homepage: https://github.com/neume/sugpoko
+licenses: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A prawnpdf wrapper
+test_files: []