phlex-pdf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e265d912e998c60ecf6d2d9cd8d68bbd183769525b13e60c02b3a9c82af99699
-  data.tar.gz: a7688fbcf405741dba49938da25cb91d2c9ac7fc70a34a67379ec2724b75b23f
+  metadata.gz: 3ed0d33ef620bd813370875bbe924058ebaea8cb3788d9945a0f56bb909cd468
+  data.tar.gz: 1fef48340c15401133fbc9a9fb90482996b3edd0382b94dd6be97611a1a533b4
 SHA512:
-  metadata.gz: d5986c26c44ebba40a95a9c254bf3e492d11e41d41b8b8e0dcb01745efe101739fcdc69fc1b62138113ae4479beda3e3dad115745b62f80dd2a0e69e056ed287
-  data.tar.gz: 932a86b037f7a2258e6fd037bf0ebae5834f95d415cd96851838e65ea62ac9c77b255355b26da549a69cb151332c87392b5d49cc6d5a6327e6c4e657d15d9795
+  metadata.gz: c1a8850366e024fad4342f07c4c11c5525cb6b253603767ee79e825e1cb9c58ff6d2d46283b039504bee2f8f68ce36f5659e2b109a87f23749bee76d267b487c
+  data.tar.gz: d3df818ae52444f7799b7f33099f4d570caac8e5132f55401c2df646513377476883f45c41e4c9308eb884b277f48eff9fae7a8b1867d1f9120e0ff8937e331b

data/README.md

@@ -1,8 +1,6 @@
-# Phlex::Pdf
+# Phlex::PDF
 
-TODO: Delete this and the text below, and describe your gem
-
-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/phlex/pdf`. To experiment with that code, run `bin/console` for an interactive prompt.
+Phlex PDF lets you compose PDF files with components in pure Ruby. It's a thin layer that sits on the shoulder of giants, [Prawn](https://github.com/prawnpdf/prawn), that encourages a component-first approach to building PDF documents.
 
 ## Installation
 
@@ -16,6 +14,8 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+`Phlex::PDF` is a thin wrapper around `Prawn::View`, so you'll want to become familiar with [PrawnPDF](http://prawnpdf.org/), particularly the [PrawnPDF Manual](https://prawnpdf.org/manual.pdf).
+
 ```ruby
 require "phlex/pdf"
 
@@ -46,7 +46,11 @@ class NoticeComponent < ApplicationComponent
   end
 end
 
-NoticeComponent.pdf.render_file "poof.pdf"
+# Render it to a file
+NoticeComponent.render_file "hello.pdf"
+
+# Or to a string
+NoticeComponent.render
 ```
 
 ## Development
@@ -57,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/phlex-pdf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/phlex-pdf/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/phlex-ruby/phlex-pdf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/phlex-ruby/phlex-pdf/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -65,4 +69,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Phlex::Pdf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phlex-pdf/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Phlex::PDF project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/phlex-ruby/phlex-pdf/blob/main/CODE_OF_CONDUCT.md).

data/lib/phlex/pdf/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
   module Pdf
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/phlex/pdf.rb

@@ -12,19 +12,58 @@ module Phlex
 
     def call(document, &block)
       @document = document
-      before_template if respond_to?(:before_template)
-      view_template(&block)
-      after_template if respond_to?(:after_template)
+      around_template do
+        view_template(&block)
+      end
     end
 
-    def render(component, &block)
-      component.call(@document, &block)
+    # @abstract Override this method to hook in around a template render. You can do things before and after calling `super` to render the template. You should always call `super` so that callbacks can be added at different layers of the inheritance tree.
+    # @return [nil]
+    def around_template
+      before_template
+      yield
+      after_template
       nil
     end
 
-    def self.document(document = Prawn::Document.new)
-      new.call(document)
-      document
+    # @abstract Override this method to hook in right before a template is rendered. Please remember to call `super` so that callbacks can be added at different layers of the inheritance tree.
+    # @return [nil]
+    def before_template
+      nil
+    end
+
+    # @abstract Override this method to hook in right after a template is rendered. Please remember to call `super` so that callbacks can be added at different layers of the inheritance tree.
+    # @return [nil]
+    def after_template
+      nil
+    end
+
+    def render(renderable, &block)
+      case renderable
+      when String
+        @document.text renderable
+      when Phlex::PDF
+        renderable.call(@document, &block)
+      else
+        raise ArgumentError, "You can't render a #{renderable.inspect}."
+      end
+
+      nil
+    end
+
+    class << self
+      def document(document = Prawn::Document.new)
+        new.call(document)
+        document
+      end
+
+      def render(...)
+        document.render(...)
+      end
+
+      def render_file(...)
+        document.render_file(...)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phlex-pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-24 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn