pixelpress 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72fc075971593953c3a7056f7001d50348f9b8d685ad08fe96b80dcd4151436a
-  data.tar.gz: 72c713f2b2aa16d3437bf0ed335d158cfd32048487aa5626a4236976c3cbe76c
+  metadata.gz: 54fcf4c2f566dca8d2ea089d1432841da7266c9729660740a40b75f06bdfd1aa
+  data.tar.gz: 160335c2409574f6d0a368191b0e2824fca8e731951d2a8147a440dbb326a627
 SHA512:
-  metadata.gz: d89b7c28c2a0a9193281eb5d1b8c3e9da7bc100772a41628c5c85b9ba3216e3ff6f00de6c9566238dfc63e9cf9dde026efe7c6c1c0d5e7aeb926ff634c5ba9eb
-  data.tar.gz: 56c91b7091209f81d7447de720c3b5ffa3e523a89599a23c6363434866d14fa6f671aab7bfb2504c895647878c7b2a78d8fbe47e045df69f025d0764847b36ba
+  metadata.gz: 6c4751c86a67a9f8922b7359afd76f34ea99973da54e73aa62cbc12ff83f2d2c55cf7bb420d5a46a43976c297cf4327968def7313acbe230d91084889d2b9828
+  data.tar.gz: a0c733d14738be7a0d757e673fe6b0be771c0f623b3987078b9e9c48d92dc5a909fae9fe42f23362609ee5f68484a1a623abb48a510cb6bc51599aa15a68efc8

data/README.md

@@ -1,23 +1,22 @@
 # Pixelpress
-[![CircleCI](https://circleci.com/gh/nerdgeschoss/pixelpress/tree/master.svg?style=svg)](https://circleci.com/gh/nerdgeschoss/pixelpress/tree/master)
 
-Modeled after `ActionMailer` this gem allows you to render PDFs from HTML via Rails templating engine. Also you can preview your PDF templates via a supplied engine during development.
+Modeled after `ActionMailer`, this gem allows you to render PDFs from HTML via Rails' templating engine. Additionally, you can preview your PDF templates via a supplied Rails engine during development.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add Pixelpress to your application's Gemfile:
 
 ```ruby
-gem 'pixelpress'
+gem "pixelpress"
 ```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
+```bash
+$ bundle
+```
 
-    $ gem install pixelpress
+You'll also need [WeasyPrint](https://weasyprint.org/). It needs to be installed and added to your `PATH`, so that `which weasyprint` returns the location of the binary. Read their installation instructions here: https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation
 
 ## Usage
 
@@ -26,26 +25,29 @@ Run the printer generator providing the name of your printer with methods to be
 rails generate pixelpress:printer NAME [method_name1 method_name2 ...] [options]
 ```
 
-This creates an `ApplicationPrinter` in `app/printers` and the corresponding subclass and also mounts the engine in your `config/routes.rb` file.
+This creates the new printer in `app/printers`. If you run it the first time, it will also add an `ApplicationPrinter` and mount the Rails engine in your `config/routes.rb` file.
 
 **Example**
+
 ```bash
-$ rails g pixelpress:printer invoice customer_invoice delivery_document 	
+$ rails g pixelpress:printer invoice customer_invoice delivery_document
 ```
-will generate `app/printers/invoice_printer.rb` file which looks like this:
+
+will generate an `app/printers/invoice_printer.rb` file with this content:
+
 ```ruby
 class InvoicePrinter < ApplicationPrinter
- 	def customer_invoice
- 		# put your code here
- 	end
+  def customer_invoice
+    # put your code here
+  end
 
- 	def delivery_document
- 		# put your code here
- 	end
+  def delivery_document
+    # put your code here
+  end
 end
 ```
 
-Also this command will generate the corresponding templates  as `.pdf.erb` files located in `app/views/printers/invoice/`:
+The command will also generate corresponding templates  as `.pdf.erb` files located in `app/views/printers/invoice/`:
 
 - `customer_invoice.pdf.erb`
 - `delivery_document.pdf.erb`
@@ -53,10 +55,10 @@ Also this command will generate the corresponding templates  as `.pdf.erb` files
 You can preview your documents by running `rails s` and go to
 
 ```
-localhost:3000/rails/printers
+http://localhost:3000/rails/printers
 ```
 
-To use your printers in code, you can instantiate them just like mailers:
+To use your printers in code, you can use them similarly to how you'd use mailers:
 
 ```ruby
 InvoicePrinter.customer_invoice.pdf # render a temporary pdf file

data/lib/pixelpress/renderers/weasyprint_renderer.rb

@@ -1,11 +1,13 @@
 class Pixelpress::WeasyPrintRenderer
+  class WeasyPrintInstallationError < StandardError; end
+
   def render(input)
     output = Tempfile.new
 
     system executable_path, "--encoding", "utf-8", input.path, output.path, exception: true
     return output
   end
-  
+
   def version
     `#{executable_path} --version`.chomp.scan(/(\d+\.\d+)/).flatten.first
   end
@@ -13,6 +15,12 @@ class Pixelpress::WeasyPrintRenderer
   private
 
   def executable_path
-    `which weasyprint`.chomp || raise(StandardError, "could not find weasyprint")
+    path = `which weasyprint`.chomp
+
+    if path.blank?
+      raise WeasyPrintInstallationError.new("Unable to locate weasyprint binary. Please make sure it's in your PATH.")
+    end
+
+    path
   end
 end

data/lib/pixelpress/version.rb

@@ -1,3 +1,3 @@
 module Pixelpress
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pixelpress
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Alex
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack