canned_tuna 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae4cf59776aa39002650fa4497ab9af9207a545b83c1f601b9c4f46fb61477e8
+  data.tar.gz: d0953722529d21d5381b242745bdf5080f619ed894f2ecc0e1d64ab2364c485d
+SHA512:
+  metadata.gz: 6b9273d8db95cd502a7542c1972edaff57b7aca1c13f2582f48359eb8f256e36cf20abc9e792d75a8f04c84a192868cff91c6faaf3b6ef1e677bae8d81e9faed
+  data.tar.gz: 8a231d9d12802a515ba49627c78dd237fc4fb28473cee240cd4574cb796d4ccd63d3b6e3b2c12210fcd7baccd6ffc3dae9d88f4f05820482dc2a0f48ab4ba93e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.4

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    canned_tuna (0.0.6)
+      prawn (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    Ascii85 (1.0.3)
+    afm (0.2.2)
+    ast (2.4.0)
+    hashery (2.1.2)
+    jaro_winkler (1.5.3)
+    minitest (5.11.3)
+    minitest-focus (1.2.0)
+      minitest (>= 4, < 6)
+    parallel (1.17.0)
+    parser (2.6.4.1)
+      ast (~> 2.4.0)
+    pdf-core (0.7.0)
+    pdf-inspector (1.3.0)
+      pdf-reader (>= 1.0, < 3.0.a)
+    pdf-reader (2.2.1)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.1)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
+    prawn (2.2.2)
+      pdf-core (~> 0.7.0)
+      ttfunk (~> 1.5)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    ruby-rc4 (0.1.5)
+    standard (0.1.4)
+      rubocop (~> 0.72.0)
+      rubocop-performance (~> 1.4.0)
+    ttfunk (1.5.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  canned_tuna!
+  minitest (~> 5.0)
+  minitest-focus (~> 1.2)
+  pdf-inspector (~> 1.3)
+  rake (~> 13.0)
+  standard (~> 0.1.4)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kasper Meyer
+
+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,132 @@
+# Canned Tuna
+
+> 🚧 Under construction. Expect unstable API on versions less than 0.1.0  🚧
+
+Organizing content in Prawn gets notoriously difficult as the size and complexity of the document increases. This often leads to a junk drawer of helper methods and mixins that is hard to maintain.
+
+Components are an antidote to this approach. They encapsulate a self-contained piece of content which can be drawn in any document. This makes them easy to test and reuse.
+
+## Example
+```ruby
+class Box < CannedTuna::Component
+  template do
+    bounding_box([0, cursor - 100], width: width, height: height) do
+      outlet
+      draw_border
+    end
+  end
+
+  attr_reader :width, :height
+
+  def initialize(width: 100, height: 100)
+    @width, @height = width, height
+  end
+
+  def draw_border
+    transparent(0.5) { stroke_bounds }
+  end
+end
+
+Prawn::Document.generate("box.pdf") do
+  draw Box, width: 200, height: 100 do
+    text "Inside the box"
+  end
+end
+```
+
+## Outlets
+
+### Default outlet
+Components can define a single content outlet using the short-hand syntax.
+
+```ruby
+class Box < CannedTuna::Component
+  template do
+    outlet
+  end
+end
+
+Prawn::Document.generate("box.pdf") do
+  draw Box do
+    text "Inside the box"
+  end
+end
+```
+
+### Named outlets
+Components can define multiple content outlets by yielding a content object that provides hooks for naming and defining multiple outlets.
+
+```ruby
+class Box < CannedTuna::Component
+  template do
+    outlet(:header)
+    outlet(:body)
+    outlet(:footer)
+  end
+end
+
+Prawn::Document.generate("outlets.pdf") do
+  draw Box do |content|
+    content.outlet(:header) do
+      text "I am the header"
+    end
+    content.outlet(:body) do
+      text "I am the body"
+    end
+    content.outlet(:footer) do
+      text "I am the footer"
+    end
+  end
+end
+```
+
+### Default content
+Components can define default content for their outlets
+
+```ruby
+class Box < CannedTuna::Component
+  template do
+    outlet(:header) { text "I am the header" }
+    outlet(:body)
+    outlet(:footer) { text "I am the footer" }
+  end
+end
+
+Prawn::Document.generate("outlets.pdf") do
+  draw Box do |content|
+    content.outlet(:body) do
+      text "I am the body"
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canned_tuna'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install canned_tuna
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaspermeyer/canned_tuna.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "canned_tuna"
+
+# 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/canned_tuna.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "canned_tuna/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "canned_tuna"
+  spec.version = CannedTuna::VERSION
+  spec.authors = ["Kasper Meyer"]
+  spec.email = ["hi@kaspermeyer.com"]
+
+  spec.summary = "Components for Prawn"
+  spec.description = "Modular components to encapsulate data and markup in Prawn"
+  spec.homepage = "https://github.com/kaspermeyer/canned_tuna"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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_dependency "prawn", "~> 2.2"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-focus", "~> 1.2"
+  spec.add_development_dependency "pdf-inspector", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "standard", "~> 0.1.4"
+end

data/example/outlets.rb

@@ -0,0 +1,36 @@
+require_relative "../lib/canned_tuna"
+
+class Box < CannedTuna::Component
+  template do
+    bounding_box([0, cursor - 100], width: width, height: height) do
+      outlet(:header)
+      outlet(:body)
+      outlet(:footer)
+      draw_border
+    end
+  end
+
+  attr_reader :width, :height
+
+  def initialize(width: 100, height: 100)
+    @width, @height = width, height
+  end
+
+  def draw_border
+    transparent(0.5) { stroke_bounds }
+  end
+end
+
+Prawn::Document.generate("outlets.pdf") do
+  draw Box, width: 200, height: 100 do |content|
+    content.outlet(:header) do
+      text "I am the header"
+    end
+    content.outlet(:body) do
+      text "I am the body"
+    end
+    content.outlet(:footer) do
+      text "I am the footer"
+    end
+  end
+end

data/example/simple.rb

@@ -0,0 +1,26 @@
+require_relative "../lib/canned_tuna"
+
+class Box < CannedTuna::Component
+  template do
+    bounding_box([0, cursor - 100], width: width, height: height) do
+      outlet
+      draw_border
+    end
+  end
+
+  attr_reader :width, :height
+
+  def initialize(width: 100, height: 100)
+    @width, @height = width, height
+  end
+
+  def draw_border
+    transparent(0.5) { stroke_bounds }
+  end
+end
+
+Prawn::Document.generate("simple.pdf") do
+  draw Box, width: 200, height: 100 do
+    text "Inside the box"
+  end
+end

data/lib/canned_tuna.rb

@@ -0,0 +1,8 @@
+require "prawn"
+require_relative "canned_tuna/version"
+require_relative "canned_tuna/interface"
+require_relative "canned_tuna/component"
+require_relative "canned_tuna/content_proxy"
+
+module CannedTuna
+end

data/lib/canned_tuna/component.rb

@@ -0,0 +1,49 @@
+module CannedTuna
+  class Component
+    include Prawn::View
+
+    def self.template &block
+      if block_given?
+        @template = block
+      else
+        @template || proc {}
+      end
+    end
+
+    def draw_in pdf, &block
+      register_outlets(&block)
+
+      with_temporary_document(pdf) do
+        instance_exec(&self.class.template)
+      end
+    end
+
+    private
+
+    def content
+      @content ||= ContentProxy.new
+    end
+
+    def outlet name = :default, &default_content
+      content.outlet_for(name, &default_content).call
+    end
+
+    def with_temporary_document pdf
+      @document = pdf
+      yield
+      @document = nil
+    end
+
+    def register_outlets &block
+      return unless block_given?
+
+      # Multiple content outlets
+      if block.arity > 0
+        instance_exec(content, &block)
+      # Default content outlet (short-hand syntax)
+      else
+        content.outlet(:default, &block)
+      end
+    end
+  end
+end

data/lib/canned_tuna/content_proxy.rb

@@ -0,0 +1,15 @@
+module CannedTuna
+  class ContentProxy
+    def initialize
+      @outlets = {}
+    end
+
+    def outlet_for name, &default_content
+      @outlets[name] || default_content || proc {}
+    end
+
+    def outlet name = :default, &block
+      @outlets[name] = block
+    end
+  end
+end

data/lib/canned_tuna/interface.rb

@@ -0,0 +1,9 @@
+module CannedTuna
+  module Interface
+    def draw component, *args, &block
+      component.new(*args).draw_in(self, &block)
+    end
+  end
+end
+
+Prawn::Document.extensions << CannedTuna::Interface

data/lib/canned_tuna/version.rb

@@ -0,0 +1,3 @@
+module CannedTuna
+  VERSION = "0.0.6"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: canned_tuna
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Kasper Meyer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  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: pdf-inspector
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+description: Modular components to encapsulate data and markup in Prawn
+email:
+- hi@kaspermeyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- canned_tuna.gemspec
+- example/outlets.rb
+- example/simple.rb
+- lib/canned_tuna.rb
+- lib/canned_tuna/component.rb
+- lib/canned_tuna/content_proxy.rb
+- lib/canned_tuna/interface.rb
+- lib/canned_tuna/version.rb
+homepage: https://github.com/kaspermeyer/canned_tuna
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspermeyer/canned_tuna
+  source_code_uri: https://github.com/kaspermeyer/canned_tuna
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Components for Prawn
+test_files: []