prawn-label_sheet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f85fe1ff0bc71aa9563acbaa3b21ecac56dd90eb43f6f18f87b448c3587215d7
+  data.tar.gz: 8ee3acde8e20e96186492bc3cabf187c494ce3cba2b78012525fc9a4c981242d
+SHA512:
+  metadata.gz: 06c27d6a1a091b2da11596c3f84f2091576f7c97fb38604354855ab0d886af983915e26d56b3e23d9867af802999dcf50abb0513e8946d3536d5fa887364a646
+  data.tar.gz: 3cb58232101e7dd8e1ecfb75a615228df167910dc9a5006f7e88aa21e1605fce3772fc697e78885fbb18de1f346badd1015cee27faf4903dea6e73e9fa056f93

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/Gemfile.lock
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# rubocop remote cache
+.rubocop-*

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_gem:
+  relaxed-rubocop: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Layout/AlignArguments:
+  EnforcedStyle: with_fixed_indentation
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - example/**/*.rb
+
+Style/TrivialAccessors:
+  Exclude:
+    - lib/prawn/label_sheet/configuration.rb
+Style/Documentation:
+  Exclude:
+    - lib/prawn/label_sheet/configuration.rb

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4
+  - 2.5.3
+  - 2.6
+  - 2.7
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prawn-label_sheet.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tom Crouch
+
+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,121 @@
+# Prawn::LabelSheet
+
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/28933c41f8ed4d39a1c96a5895de2343)](https://app.codacy.com/manual/t.crouch/prawn-label_sheet?utm_source=github.com&utm_medium=referral&utm_content=tcrouch/prawn-label_sheet&utm_campaign=Badge_Grade_Dashboard)
+[![Inline docs](http://inch-ci.org/github/tcrouch/prawn-label_sheet.svg?branch=master)](http://inch-ci.org/github/tcrouch/prawn-label_sheet)
+
+
+Generate sets of labels or stickers using Prawn PDF.
+
+For simple bulk generation, can break page between groups of data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prawn-label_sheet'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install prawn-label_sheet
+```
+
+## Usage
+
+```ruby
+items = %w[red orange yellow green blue indigo violet]
+
+Prawn::LabelSheet.generate("out.pdf", items) do |pdf, item|
+  pdf.text_box item
+end
+```
+
+Each item is passed to the block, together with a bounding box for the label.
+
+For larger sets, page breaks can be inserted on change of value:
+
+```ruby
+# Change in value returned from item[3]
+generate("out.pdf", items, break_on: 3)
+
+# Change in value returned from proc
+generate("out.pdf", items, break_on: ->(item) { item.downcase })
+```
+
+### Example
+
+In a school you might want a single document with labels for all students,
+where a new sheets is started for each class.
+
+Given your class data, pre-sorted by [class, last, first]:
+
+```csv
+Arthur,Aardvark,1234,Class A
+Sam,Smith,1235,Class A
+Bob,Bobbington,1236,Class B
+Leah,Lemon,1237,Class B
+```
+
+```ruby
+csv = CSV.read("students.csv")
+
+Prawn::LabelSheet.generate("out.pdf", csv, break_on: 3) do |pdf, data|
+  last_name, first_name, class_name, student_id = data
+
+  b = pdf.bounds
+  full_width = b.width - 12
+  half_width = (full_width / 2).floor - 1
+
+  pdf.font 'Helvetica'
+
+  pdf.move_down 12
+  pdf.indent(6) do
+    pdf.text_box "#{last_name} #{first_name}",
+      at: [b.left, pdf.cursor],
+      width: full_width, height: 12,
+      overflow: :truncate
+  end
+  pdf.move_down 12
+  pdf.stroke_horizontal_rule
+  pdf.move_down 6
+  pdf.font_size 7 do
+    pdf.text_box "ID",
+      at: [b.left, pdf.cursor],
+      width: half_width, height: 8
+    pdf.text_box "Class",
+      at: [b.right - half_width, pdf.cursor],
+      width: half_width, height: 8
+  end
+  pdf.move_down 9
+  pdf.text_box student_id,
+    at: [b.left, pdf.cursor],
+    width: half_width, height: 10,
+    overflow: :shrink_to_fit
+  pdf.text_box class_name,
+    at: [b.right - half_width, pdf.cursor],
+    width: half_width, height: 10,
+    overflow: :shrink_to_fit
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/tcrouch/prawn-label_sheet.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'prawn/label_sheet'
+
+# 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,10 @@
+#!/usr/bin/env bash
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prawn/label_sheet.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'prawn'
+require 'polyfill'
+require 'prawn/label_sheet/version'
+require 'prawn/label_sheet/configuration'
+
+# @see http://prawnpdf.org
+module Prawn
+  # Document supporting bulk label/sticker generation
+  class LabelSheet
+    include Prawn::View
+
+    # Error class
+    class Error < StandardError; end
+
+    # Override Prawn::View#document
+
+    attr_reader :document, :layout
+
+    using Polyfill(Hash: %w[#transform_keys])
+
+    # Render and persist a set of label sheets
+    #
+    # @param labels [Enumerable, CSV]
+    # @param options (see #initialize)
+    def self.generate(filename, labels, **options, &block)
+      pdf = new(labels, options, &block)
+      pdf.document.render_file(filename)
+    end
+
+    # @param labels [Enumerable] collection of labels
+    # @option options [String] :layout
+    # @option options [Proc, Integer] :break_on
+    # @option options [Prawn::Document] :document
+    def initialize(labels, **options)
+      @layout = setup_layout(options[:layout])
+
+      @document = resolve_document(options[:document])
+      @document.define_grid @layout
+      # @document.on_page_create { self.instance_variable_set :@count, 0 }
+
+      @count = 0
+      @break_on = options[:break_on]
+
+      labels.each do |label|
+        make_label(label, options) { |pdf, item| yield pdf, item }
+      end
+    end
+
+    # Generate individual label
+    #
+    # @param item [#[], Object]
+    # @yieldparam doc [Prawn::Document] document
+    # @yieldparam item [Object] label item
+    # @return [Integer] tally of labels on current page
+    def make_label(item, _options)
+      break_page if break_page?(item)
+
+      @document.grid(*gridref).bounding_box do
+        yield @document, item
+      end
+      @count += 1
+    end
+
+    protected
+
+    # Determine whether to begin a new page
+    #
+    # @param item [Proc, #[]]
+    # @return [Boolean]
+    def break_page?(item)
+      return unless @break_on
+
+      val = @break_on.is_a?(Proc) ? @break_on.call(item) : item[@break_on]
+      return false if @last_val == val
+
+      @last_val = val
+      @count.positive?
+    end
+
+    # Begin a new page
+    def break_page
+      @document.start_new_page
+      @count = 0
+    end
+
+    # Current grid coordinates
+    #
+    # @return [Array(Integer, Integer)]
+    def gridref
+      q, r = @count.divmod(@document.grid.rows * @document.grid.columns)
+
+      if q.positive? && r.zero?
+        @document.start_new_page
+        return [0, 0]
+      end
+
+      r.divmod(@document.grid.columns)
+    end
+
+    # @param layout_def [String, #to_h] layout definition or identifier
+    # @return [Hash]
+    # rubocop:disable Style/RescueModifier
+    def setup_layout(layout_def)
+      defs = resolve_layout(layout_def).slice(
+        'page_size', 'columns', 'rows',
+        'top_margin', 'bottom_margin',
+        'left_margin', 'right_margin',
+        'column_gutter', 'row_gutter'
+      )
+      {
+        page_size: 'A4', top_margin: 40, left_margin: 20
+      }.merge!(defs.transform_keys { |key| key.to_sym rescue key })
+    end
+    # rubocop:enable Style/RescueModifier
+
+    # Lookup layout definition
+    #
+    # @param layout_def [String, #to_h] layout definition or identifier
+    # @return [Hash]
+    def resolve_layout(layout_def)
+      dfn = layout_def || config.default_layout
+      return dfn.to_h if dfn.respond_to?(:to_h)
+
+      config.layouts[dfn] || raise(Error, 'Unknown layout')
+    end
+
+    # @param doc [Prawn::Document, nil]
+    # @return [Prawn::Document]
+    def resolve_document(doc)
+      return doc.start_new_page(@layout) if doc
+
+      Document.new @layout
+    end
+
+    # @return [Prawn::LabelSheet::Configuration]
+    def config
+      self.class.config
+    end
+  end
+end

data/lib/prawn/label_sheet/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Prawn
+  class LabelSheet
+    # config options
+    class Configuration
+      attr_accessor :default_layout
+      attr_writer :layouts
+
+      def initialize
+        @default_layout = 'Avery7160'
+      end
+
+      # @return [Hash]
+      def layouts
+        @layouts ||= YAML.load_file(File.expand_path('layouts.yml', __dir__))
+      end
+    end
+
+    # Current configuration
+    #
+    # @return [Prawn::LabelSheet::Configuration]
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    # Define configuration
+    #
+    # @param configuration [Prawn::LabelSheet::Configuration]
+    def self.config=(configuration)
+      @config = configuration
+    end
+
+    # Modify configuration
+    #
+    # @yieldparam config [Prawn::LabelSheet::Configuration]
+    def self.configure
+      yield config
+    end
+  end
+end

data/lib/prawn/label_sheet/layouts.yml

@@ -0,0 +1,17 @@
+# Combined config for Prawn document and grid
+# 
+# defaults:
+#   page_size: A4
+#   top_margin: 40
+#   left_margin: 20
+#
+Avery7160:
+  bottom_margin: 43.9
+  column_gutter: 7.08662
+  columns: 3
+  left_margin: 19.843
+  page_size: A4
+  right_margin: 19.843
+  row_gutter: 0
+  rows: 7
+  top_margin: 43.9

data/lib/prawn/label_sheet/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Prawn
+  class LabelSheet
+    VERSION = '0.1.0'
+  end
+end

data/prawn-label_sheet.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prawn/label_sheet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prawn-label_sheet'
+  spec.version       = Prawn::LabelSheet::VERSION
+  spec.authors       = ['Tom Crouch']
+  spec.email         = ['tom.crouch@gmail.com']
+
+  spec.summary       = 'Generate PDF sets of labels & stickers.'
+  spec.description   = <<~DESCRIPTION
+    Generate sets of labels or stickers programmatically using Prawn PDF.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/tcrouch/prawn-label_sheet'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features|example)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.add_dependency 'polyfill', '~> 1.1.0'
+  spec.add_dependency 'prawn'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'relaxed-rubocop', '~> 2.4'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: prawn-label_sheet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Crouch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: polyfill
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: relaxed-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+description: 'Generate sets of labels or stickers programmatically using Prawn PDF.
+
+  '
+email:
+- tom.crouch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prawn/label_sheet.rb
+- lib/prawn/label_sheet/configuration.rb
+- lib/prawn/label_sheet/layouts.yml
+- lib/prawn/label_sheet/version.rb
+- prawn-label_sheet.gemspec
+homepage: https://github.com/tcrouch/prawn-label_sheet
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Generate PDF sets of labels & stickers.
+test_files: []