phlex-pdf 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e265d912e998c60ecf6d2d9cd8d68bbd183769525b13e60c02b3a9c82af99699
-  data.tar.gz: a7688fbcf405741dba49938da25cb91d2c9ac7fc70a34a67379ec2724b75b23f
+  metadata.gz: 670aa939ab2505d3783c38b9070adbce93e1ddf67c041c726efd7b4efed5296f
+  data.tar.gz: c1e31b9053d69c43c0fac102637fd2d63be0ef9e7f2002e33da8e2419462b90e
 SHA512:
-  metadata.gz: d5986c26c44ebba40a95a9c254bf3e492d11e41d41b8b8e0dcb01745efe101739fcdc69fc1b62138113ae4479beda3e3dad115745b62f80dd2a0e69e056ed287
-  data.tar.gz: 932a86b037f7a2258e6fd037bf0ebae5834f95d415cd96851838e65ea62ac9c77b255355b26da549a69cb151332c87392b5d49cc6d5a6327e6c4e657d15d9795
+  metadata.gz: e815d9f10d1f527d51c250021060354dedbe7ba09153aa7ecd043b02a6e7bb9eba93932f30b2519c3649f4d689961fd6987fe93665b69617d69408e2f2c67cb6
+  data.tar.gz: 3f2283f3b9a6965a34cf08ff7b169b425e493de5f40591e2ed45e09602004953dc00a8a0e639b413f241dd503a693847582a8e41ced0454bdcf52ee149cff22b

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.2"
   end
 end

data/lib/phlex/pdf.rb

@@ -12,19 +12,82 @@ 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
+        if block_given?
+          view_template do
+            yield_content(&block)
+          end
+        else
+          view_template
+        end
+      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 yield_content(&block)
+      return unless block_given?
+
+      if block.arity.zero?
+        # This handles lambdas and ->
+        yield
+      else
+        # This handles Proc and proc
+        yield self
+      end
+    end
+
+    def render(renderable, &block)
+      case renderable
+      when Phlex::PDF
+        renderable.call(@document, &block)
+      when String
+        @document.text renderable
+      when Class
+        render(renderable.new, &block) if renderable < Phlex::PDF
+      when Proc, Method
+        yield_content(&renderable)
+      when Enumerable
+        renderable.each { |r| render(r, &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.2
 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