prawn-label_sheet 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f85fe1ff0bc71aa9563acbaa3b21ecac56dd90eb43f6f18f87b448c3587215d7
-  data.tar.gz: 8ee3acde8e20e96186492bc3cabf187c494ce3cba2b78012525fc9a4c981242d
+  metadata.gz: 1d593ea89fd930b39f95de418c4164fbbf9fbf11308d9e6fe24d8d2febebeecf
+  data.tar.gz: 3fd4bf13ada22220777b107b3abb5bd4b8a60291c75f9d9617c1921727419f09
 SHA512:
-  metadata.gz: 06c27d6a1a091b2da11596c3f84f2091576f7c97fb38604354855ab0d886af983915e26d56b3e23d9867af802999dcf50abb0513e8946d3536d5fa887364a646
-  data.tar.gz: 3cb58232101e7dd8e1ecfb75a615228df167910dc9a5006f7e88aa21e1605fce3772fc697e78885fbb18de1f346badd1015cee27faf4903dea6e73e9fa056f93
+  metadata.gz: 9755747c24dd0e22f744dea0e6483d4580712cf2741cf50d5a852b0bee75b52a47394d8644ffba65a9387cfed105b4951bb96c026d2967f4a66c8dea8377b243
+  data.tar.gz: 2189f582469ee7cb745ded23d3eecf865ffc1a2ab16c8ca6efb8b96f2d1db15a06a6d28a449d8abae41a6b1d054024378c0dd1e8ea9ee87adb4929f92daf09e1

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

data/.github/workflows/gem-push.yml

@@ -0,0 +1,43 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.rubocop.yml

@@ -2,11 +2,11 @@ inherit_gem:
   relaxed-rubocop: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
 
-Layout/AlignArguments:
+Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
@@ -16,10 +16,3 @@ Layout/MultilineOperationIndentation:
 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

@@ -1,15 +1,16 @@
 ---
-sudo: false
+os: linux
 language: ruby
 cache: bundler
 rvm:
-  - 2.4
-  - 2.5.3
-  - 2.6
   - 2.7
+  - 3.0
+  - 3.1
   - ruby-head
-matrix:
+jobs:
   allow_failures:
     - rvm: ruby-head
   fast_finish: true
-before_install: gem install bundler -v 2.0.1
+before_install:
+  - gem update --system
+  - gem install bundler

data/.yardopts

@@ -0,0 +1 @@
+-m markdown - LICENSE.txt

data/README.md

@@ -1,8 +1,9 @@
 # Prawn::LabelSheet
 
+[![Gem Version](https://img.shields.io/gem/v/prawn-label_sheet.svg)](https://rubygems.org/gems/prawn-label_sheet)
 [![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)
-
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/tcrouch/prawn-label_sheet)
 
 Generate sets of labels or stickers using Prawn PDF.
 

data/lib/prawn/label_sheet/configuration.rb

@@ -6,6 +6,8 @@ module Prawn
   class LabelSheet
     # config options
     class Configuration
+      # Default layout key
+      # @return [String] the default key
       attr_accessor :default_layout
       attr_writer :layouts
 
@@ -13,31 +15,30 @@ module Prawn
         @default_layout = 'Avery7160'
       end
 
-      # @return [Hash]
+      # Layout definitions
+      #
+      # @return [{String => 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
+    class << self
+      attr_writer :config
 
-    # Define configuration
-    #
-    # @param configuration [Prawn::LabelSheet::Configuration]
-    def self.config=(configuration)
-      @config = configuration
-    end
+      # Current configuration
+      #
+      # @return [Prawn::LabelSheet::Configuration]
+      def config
+        @config ||= Configuration.new
+      end
 
-    # Modify configuration
-    #
-    # @yieldparam config [Prawn::LabelSheet::Configuration]
-    def self.configure
-      yield config
+      # Modify configuration
+      #
+      # @yieldparam config [Prawn::LabelSheet::Configuration]
+      def configure
+        yield config
+      end
     end
   end
 end

data/lib/prawn/label_sheet/version.rb

@@ -2,6 +2,7 @@
 
 module Prawn
   class LabelSheet
-    VERSION = '0.1.0'
+    # Gem version
+    VERSION = '0.2.0'
   end
 end

data/lib/prawn/label_sheet.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'prawn'
-require 'polyfill'
 require 'prawn/label_sheet/version'
 require 'prawn/label_sheet/configuration'
 
@@ -15,37 +14,34 @@ module Prawn
     class Error < StandardError; end
 
     # Override Prawn::View#document
-
-    attr_reader :document, :layout
-
-    using Polyfill(Hash: %w[#transform_keys])
+    attr_reader :document
+    attr_reader :layout
 
     # Render and persist a set of label sheets
     #
-    # @param labels [Enumerable, CSV]
+    # @param filename [String] Name of output file
+    # @param labels (see #initialize)
     # @param options (see #initialize)
+    # @yieldparam (see #initialize)
     def self.generate(filename, labels, **options, &block)
-      pdf = new(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 [Proc, Integer, String] :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 }
+    # @yieldparam doc (see #make_label)
+    # @yieldparam item (see #make_label)
+    def initialize(labels, **options, &block)
+      @layout = setup_layout(options[:layout]).merge(info: options[:info])
+      @document = setup_document(options[:document], @layout)
 
       @count = 0
       @break_on = options[:break_on]
 
-      labels.each do |label|
-        make_label(label, options) { |pdf, item| yield pdf, item }
-      end
+      labels.each { |label| make_label(label, options, &block) }
     end
 
     # Generate individual label
@@ -57,9 +53,7 @@ module Prawn
     def make_label(item, _options)
       break_page if break_page?(item)
 
-      @document.grid(*gridref).bounding_box do
-        yield @document, item
-      end
+      @document.grid(*gridref).bounding_box { yield @document, item }
       @count += 1
     end
 
@@ -70,7 +64,7 @@ module Prawn
     # @param item [Proc, #[]]
     # @return [Boolean]
     def break_page?(item)
-      return unless @break_on
+      return false unless @break_on
 
       val = @break_on.is_a?(Proc) ? @break_on.call(item) : item[@break_on]
       return false if @last_val == val
@@ -99,21 +93,20 @@ module Prawn
       r.divmod(@document.grid.columns)
     end
 
+    # Extract definition & provide defaults for required keys
+    #
     # @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 })
+      ).transform_keys(&:to_sym)
+
+      { page_size: 'A4', top_margin: 40, left_margin: 20 }.merge!(defs)
     end
-    # rubocop:enable Style/RescueModifier
 
     # Lookup layout definition
     #
@@ -127,11 +120,13 @@ module Prawn
     end
 
     # @param doc [Prawn::Document, nil]
+    # @param layout [Hash]
     # @return [Prawn::Document]
-    def resolve_document(doc)
-      return doc.start_new_page(@layout) if doc
-
-      Document.new @layout
+    def setup_document(doc, layout)
+      doc&.start_new_page(layout)
+      doc ||= Document.new layout
+      doc.define_grid layout
+      doc
     end
 
     # @return [Prawn::LabelSheet::Configuration]

data/prawn-label_sheet.gemspec

@@ -27,14 +27,14 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = ">= 2.7.0"
 
-  spec.add_dependency 'polyfill', '~> 1.1.0'
+  spec.add_dependency 'matrix'
   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 'rake', '~> 13.0'
+  spec.add_development_dependency 'relaxed-rubocop', '~> 2.5'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.74'
+  spec.add_development_dependency 'rubocop', '~> 1.8'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: prawn-label_sheet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Crouch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: polyfill
+  name: matrix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: relaxed-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '1.8'
 description: 'Generate sets of labels or stickers programmatically using Prawn PDF.
 
   '
@@ -117,10 +117,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -144,15 +147,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Generate PDF sets of labels & stickers.