rails_pdf 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44883fce40a90d093e9507abdc4a179c0583607af4b713512936bf9145e2c808
-  data.tar.gz: bd189278cf71f4fb035c2be28d306096094d12dca574ce40f92948acae2c6a63
+  metadata.gz: 678f0f8bea4244c6d485dc5f1b75fab64eb3eabaad6d51951c4ea958af159e56
+  data.tar.gz: 856f2c46206dabb82b979537d7f89dafd29b5f70f164552a07413e558224bdab
 SHA512:
-  metadata.gz: e96e51f13562c97422edb772c004bae168accfcfcd96c8648841281673e2a1b301deb48f37a7aaeb724d9f46b2e908ac3bd4c304e7dccfaac7eb1087b42efd48
-  data.tar.gz: b2e3351bfb6961bc23ce186e36863460b177fb76016b613786c1f049d6f01dbde7d9d6b5d40808263db6611a1e75e0630ea30c4c30190dc4818addc933fa7831
+  metadata.gz: a1fe29e986fa4160d2f3479cd3bcd8ccea5038ab3ce1792960f520ab57b0cf4000328e0e1aab906d9a1338be5abc4bfa06ca4c31d0b16af013e6ef2d72468239
+  data.tar.gz: 24566e771c4710e783a0f5c19428d2ade592ddc47624d20a426549b635cf3c95404927c71559b67d928cc9f46ada34dd6a0c97d9f3d29e41e7ff4280d7ab12b8

data/README.md

@@ -14,6 +14,7 @@ Create PDF documents in Rails your app from HTML, CSS and JS.
 - Separates PDF templates from app views
 - Doesn't insert any middleware into your app
 - Pub format is similar to slim
+- Pass locals to the view
 
 It's uses [ReLaXedJS](https://github.com/RelaxedJS/ReLaXed) tool, which is wrapper arround chromium headless.
 
@@ -28,19 +29,19 @@ _If you want to contribute and add more templates - it' very easy to do. See #Te
     <td width="25%">
       <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_1.png">
         <img src="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_1_thumb.png?raw=true" />
-      </a>      
+      </a>
       Template: <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/lib/generators/rails_pdf/templates/simple_invoice/invoice.pug.erb">simple_invoice</a>
     </td>
     <td width="25%">
       <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_2.png">
         <img src="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_2_thumb.png?raw=true" />
-      </a>      
+      </a>
       Template: <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/lib/generators/rails_pdf/templates/basic_invoice/invoice.pug.erb">basic_invoice</a>
     </td>
     <td width="50%">
       <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_3c.png">
         <img src="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_3c_thumb.png?raw=true" />
-      </a>      
+      </a>
       Template: <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/lib/generators/rails_pdf/templates/chart1/chart.pug.erb">chart1</a>
     </td>
   </tr>
@@ -48,9 +49,9 @@ _If you want to contribute and add more templates - it' very easy to do. See #Te
     <td width="25%">
       <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_4.png">
         <img src="https://github.com/igorkasyanchuk/rails_pdf/blob/master/docs/report_4_thumb.png?raw=true" />
-      </a>      
+      </a>
       Template: <a href="https://github.com/igorkasyanchuk/rails_pdf/blob/master/lib/generators/rails_pdf/templates/products/index.pug.erb">products</a>
-    </td>    
+    </td>
     <td width="25%">
     </td>
     <td width="25%">
@@ -83,14 +84,24 @@ This is how you can generate and send PDF files on the fly:
       send_data(data, type: 'application/pdf', disposition: 'inline', filename: 'report.pdf')
     end
   end
-  
+
   # or return file as attachment
-  
+
   def invoice
     RailsPDF.template("report2/invoice.pug.erb").render do |data|
       send_data(data, type: 'application/pdf', disposition: 'attachment', filename: 'report.pdf')
     end
-  end  
+  end
+
+  # sample with locals
+  # works similar how regular partials works
+
+  def report
+    @invoice = Invoice.find(params[:id])
+    RailsPDF.template("report2/invoice.pug.erb").locals(invoice: @invoice).render do |data|
+      send_data(data, type: 'application/pdf', disposition: 'inline', filename: 'report.pdf')
+    end
+  end
 ```
 
 If you need to create PDF file and save to file on drive:
@@ -137,9 +148,11 @@ Installation of gem is very simple, it's just requires one additional step to in
 
 #### Install RelaxedJS
 
->git clone https://github.com/RelaxedJS/ReLaXed.git .
->npm install
->sudo npm link --unsafe-perm=true
+```bash
+$ git clone https://github.com/RelaxedJS/ReLaXed.git .
+$ npm install
+$ sudo npm link --unsafe-perm=true
+```
 
 Verify it's installed with: `relaxed --version`.
 
@@ -166,7 +179,7 @@ $ bundle
   // A4
   $page-width: 8.27in;
   $page-height: 11.69in;
-```  
+```
 - if you want to add header/footer (sample: lib/generators/rails_pdf/templates/simple_invoice/invoice.pug.erb)
 ```pug
   h1 My document
@@ -184,8 +197,8 @@ $ bundle
 ## Development
 
 - open `test/dummy`
-- rake db:migrate
-- `rails s -b 0.0.0.0`
+- `bundle exec rake db:migrate`
+- `bundle exec rails s -b 0.0.0.0`
 - open `localhost:3000/report.pdf`
 - modify templates in app/pdf
 
@@ -222,6 +235,10 @@ Before deploy app to production please don't forget to install Relaxed.JS on it.
 
 You are welcome to contribute.
 
+## Contributors
+
+* https://github.com/gambala
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rails_pdf/renderer.rb

@@ -12,10 +12,17 @@ module RailsPDF
       self
     end
 
+    def locals(locals)
+      @locals = locals
+      self
+    end
+
     def render(&block)
       controller = ActionController::Base.new
       view = ActionView::Base.new(ActionController::Base.view_paths, {}, controller)
-      content = view.render(file: @file, layout: @layout)
+      params = { file: @file, layout: @layout }
+      params = params.merge(locals: @locals) if @locals.present?
+      content = view.render(params)
 
       logger.debug "RailsPDF ====="
       logger.debug "RailsPDF content:\n#{content}"

data/lib/rails_pdf/version.rb

@@ -1,3 +1,3 @@
 module RailsPDF
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_pdf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Igor Kasyanchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Reliable way to generate PDF files of any complexity.