fourmi-prawn-utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ea58138a0f9fd6da9db87d1bb929f962d85a9ff3a3a5e6a7f46991e179d401d
+  data.tar.gz: 3a3402195f5fa623959b51038f03144a94a612a52ef58aa7183206fa44ee1087
+SHA512:
+  metadata.gz: 48c9de9298d9c4d52dfedf9e187e09c900db0c27120513f475c5cab7c4e624ed1158331f413dae1b3815df9242cf4c353ff25870c274db81193ff85eda0b591b
+  data.tar.gz: 5ae9ada9f8c253fe376e6bf1622443755e946768afb842e9ee2048f16d36a50fc384339d5139ec4fb72a086e81b2fb4cb2d976fac705f42c09982aee4e403016

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fourmi-prawn-utils.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Guillaume Dott
+
+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,33 @@
+# Fourmi::Prawn::Utils
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fourmi/prawn/utils`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add fourmi-prawn-utils
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install fourmi-prawn-utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/[USERNAME]/fourmi-prawn-utils.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+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/lib/fourmi/prawn/utils/callbacks/border_callback.rb

@@ -0,0 +1,14 @@
+module Fourmi::Prawn::Utils
+  module Callbacks
+    class BorderCallback
+      def initialize(document)
+        @document = document
+      end
+
+      def render_in_front(fragment)
+        @document.stroke_polygon(fragment.top_left, fragment.top_right,
+                                 fragment.bottom_right, fragment.bottom_left)
+      end
+    end
+  end
+end

data/lib/fourmi/prawn/utils/callbacks/highlight_callback.rb

@@ -0,0 +1,19 @@
+module Fourmi::Prawn::Utils
+  module Callbacks
+    class HighlightCallback
+      def initialize(color, document, padding_top = 0, padding_left = 0)
+        @color    = color
+        @document = document
+        @padding_top = padding_top
+        @padding_left = padding_left
+      end
+
+      def render_behind(fragment)
+        original_color = @document.fill_color
+        @document.fill_color = @color
+        @document.fill_rectangle([fragment.left - @padding_left, fragment.top + @padding_top], fragment.width + 2 * @padding_left, fragment.height + 2 * @padding_top)
+        @document.fill_color = original_color
+      end
+    end
+  end
+end

data/lib/fourmi/prawn/utils/extensions/box.rb

@@ -0,0 +1,53 @@
+require 'fourmi/prawn/utils/extensions/text_align'
+
+module Fourmi::Prawn::Utils
+  module Extensions
+    module Box
+      def textbox(content = nil, height = 40)
+        bounding_box([0, cursor], height: content.blank? && !block_given? ? height : nil, width: bounds.width) do
+          pad(5) do
+            indent(5) do
+              text content unless content.blank?
+              yield if block_given?
+            end
+          end
+          stroke_bounds
+        end
+      end
+
+      def padded_box(position, padding, **options, &block)
+        rounded = options.delete(:rounded)
+        rounded = true if rounded.nil?
+
+        bounding_box position, options do
+          bounding_box [padding, bounds.top - padding], width: bounds.width - 2 * padding, height: bounds.height > 2 * padding ? bounds.height - 2 * padding : nil do
+            yield block
+            move_down padding
+          end
+          if rounded
+            stroke_rounded_bounds
+          else
+            stroke_bounds
+          end
+        end
+      end
+
+      def filled_box(color, x: 0, y: cursor, width: bounds.width, height: 150, &block)
+        fill_color(color) do
+          fill_rectangle [x, y], width, height
+        end
+        bounding_box([x, y], width: width, height: height, &block)
+      end
+
+      def list(text, options = {})
+        float { indent(5) { text '- ' } }
+        indent 15 do
+          textj text, options
+        end
+      end
+    end
+  end
+end
+
+require 'prawn/document'
+Prawn::Document.extensions << Fourmi::Prawn::Utils::Extensions::Box

data/lib/fourmi/prawn/utils/extensions/stroke_rounded_bounds.rb

@@ -0,0 +1,12 @@
+module Fourmi::Prawn::Utils
+  module Extensions
+    module StrokeRoundedBounds
+      def stroke_rounded_bounds(radius = 2)
+        stroke_rounded_rectangle [0, bounds.top], bounds.width, bounds.height, radius
+      end
+    end
+  end
+end
+
+require 'prawn/document'
+Prawn::Document.extensions << Fourmi::Prawn::Utils::Extensions::StrokeRoundedBounds

data/lib/fourmi/prawn/utils/extensions/strokes_and_colors.rb

@@ -0,0 +1,30 @@
+module Fourmi::Prawn::Utils
+  module Extensions
+    module StrokesAndColors
+      def with_fill_color(color)
+        original_color = fill_color
+        self.fill_color = color
+
+        yield if block_given?
+      ensure
+        self.fill_color = original_color
+      end
+
+      def with_stroke_properties(color: nil, width: nil)
+        original_color = stroke_color
+        original_width = line_width
+
+        self.stroke_color = color unless color.nil?
+        self.line_width = width unless width.nil?
+
+        yield if block_given?
+      ensure
+        self.stroke_color = original_color
+        self.line_width = original_width
+      end
+    end
+  end
+end
+
+require 'prawn/document'
+Prawn::Document.extensions << Fourmi::Prawn::Utils::Extensions::StrokesAndColors

data/lib/fourmi/prawn/utils/extensions/text_align.rb

@@ -0,0 +1,21 @@
+module Fourmi::Prawn::Utils
+  module Extensions
+    module TextAlign
+      def paragraph(string, options = {})
+        textj string, options
+        move_down 4
+      end
+
+      def textc(string, options = {})
+        text string, {align: :center}.merge(options)
+      end
+
+      def textj(string, options = {})
+        text string, {align: :justify}.merge(options)
+      end
+    end
+  end
+end
+
+require 'prawn/document'
+Prawn::Document.extensions << Fourmi::Prawn::Utils::Extensions::TextAlign

data/lib/fourmi/prawn/utils/extensions/visual_form.rb

@@ -0,0 +1,32 @@
+require 'fourmi/prawn/utils/extensions/strokes_and_colors'
+require 'prawn/blank'
+
+module Fourmi::Prawn::Utils
+  module Extensions
+    module VisualForm
+      def visual_checkbox(name, checked = false, size: 8, white: false, form: false)
+        bounding_box([0, cursor], width: bounds.width) do
+          float do
+            bounding_box([0, cursor], width: size, height: size) do
+              if form
+                checkbox name: name, at: [0, bounds.top], checked: checked, width: bounds.width, height: bounds.height
+              else
+                with_fill_color 'FFFFFF' do
+                  fill_rectangle [0, bounds.top], bounds.width, bounds.height if white
+                end
+                fill_rectangle [2, bounds.height - 2], bounds.width - 4, bounds.height - 4 if checked
+              end
+              stroke_bounds
+            end
+          end
+          indent(size + 7) do
+            yield
+          end if block_given?
+        end
+      end
+    end
+  end
+end
+
+require 'prawn/document'
+Prawn::Document.extensions << Fourmi::Prawn::Utils::Extensions::VisualForm

data/lib/fourmi/prawn/utils/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Fourmi
+  module Prawn
+    module Utils
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/fourmi/prawn/utils.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "utils/version"
+
+module Fourmi
+  module Prawn
+    module Utils
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/sig/fourmi/prawn/utils.rbs

@@ -0,0 +1,8 @@
+module Fourmi
+  module Prawn
+    module Utils
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: fourmi-prawn-utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume Dott
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-14 00:00:00.000000000 Z
+dependencies:
+- !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: prawn-blank
+  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'
+description: Some methods to simplify PDF creation with Prawn
+email:
+- guillaume+github@dott.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fourmi/prawn/utils.rb
+- lib/fourmi/prawn/utils/callbacks/border_callback.rb
+- lib/fourmi/prawn/utils/callbacks/highlight_callback.rb
+- lib/fourmi/prawn/utils/extensions/box.rb
+- lib/fourmi/prawn/utils/extensions/stroke_rounded_bounds.rb
+- lib/fourmi/prawn/utils/extensions/strokes_and_colors.rb
+- lib/fourmi/prawn/utils/extensions/text_align.rb
+- lib/fourmi/prawn/utils/extensions/visual_form.rb
+- lib/fourmi/prawn/utils/version.rb
+- sig/fourmi/prawn/utils.rbs
+homepage: https://code.lafourmi-immo.com/lafourmi-immo/prawn-utils
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://code.lafourmi-immo.com/lafourmi-immo/prawn-utils
+  source_code_uri: https://code.lafourmi-immo.com/lafourmi-immo/prawn-utils
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.21
+signing_key:
+specification_version: 4
+summary: Some methods to simplify PDF creation with Prawn
+test_files: []