zpdf 0.0.2 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fee29fbf4f292dfd6cb941b4e43828f3d3b51c2b
-  data.tar.gz: 808775939cf8169b55e3f6bdb07e142013cf2d07
+SHA256:
+  metadata.gz: 593e223677d36ea8a7d13d98dd5e00289700d23570d148cacc9942b66849c2ee
+  data.tar.gz: '028e05c0fbdfe4e26155b52f41249bf5a144c15b72ec588c2a32f8b16510183d'
 SHA512:
-  metadata.gz: db3a7d94cb6aaab4245e79ae722fad5f3dcfb0cfad67549ee77755fbe828934a99acff277770ec4794539b63c096f9664d1df8b56c6311b0a2e991475b49b925
-  data.tar.gz: d94ee994533ad5c914ca920d6f0bf5c56fed947fbb6358d9fe78f570baac9f45677905c39bba648b2348dbdc5185adefd33aadb5974475dca63e33aa4b217d12
+  metadata.gz: 8ff22e7971a6cff786f3a51eee8b180796e36db3770a431e9e81fcde17d7885081f41a249a8c59f815c47ac58fa43e77610b00f2634b811157f21d3db47b042c
+  data.tar.gz: f1392921b5118a3c4abd5f4eaf1cf230ff7df999857c2284e5386be58883f3add4e858459450606b146e2a6dce4c319a1b6f033a0fadef8a8ac99464a825b9e8

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+
+# 4.1.7 (June 20, 2017)
+
+* Removed a trace `puts` causing unnecessary logging
+
+# 4.1.6 (June 20, 2017)
+
+* Updated to work with Rails 5.0 and 5.1
+* Normalized autoload'ing to use 'zpdf/' path instead of 'z_pdf'
+* Updated documentation
+
+# 4.1.5 (September 15, 2016)
+
+* Updated to work with Rails 4.0, 4.1 and 4.2
+
+# 0.0.3 (March 31, 2015)
+
+* Initial release. Compatible with Rails 3 and Ruby 1.9.2
+

data/lib/zpdf.rb

@@ -1,25 +1,17 @@
 zpdf_path = File.expand_path(File.dirname(__FILE__))
 $:.unshift(zpdf_path) if File.directory?(zpdf_path) && !$:.include?(zpdf_path)
 
-require 'rails'
+require 'active_support/rails'
 require 'active_support/core_ext/module/attr_internal'
 require 'active_support/lazy_load_hooks'
 require 'abstract_controller'
 require 'action_view'
-require 'z_pdf/version'
-require 'z_pdf/railtie'
+require 'zpdf/version'
+require 'zpdf/railtie'
 
 module ZPdf
   extend ::ActiveSupport::Autoload
 
-#  autoload :AdvAttrAccessor
-#  autoload :Collector
-  autoload :Base
-#  autoload :DeliveryMethods
-#  autoload :DeprecatedApi
-#  autoload :MailHelper
-#  autoload :OldApi
-#  autoload :TestCase
-#  autoload :TestHelper
+  autoload :Base, 'zpdf/base'
 end
 

data/lib/{z_pdf → zpdf}/base.rb

@@ -1,5 +1,5 @@
-require 'z_pdf/html_pdf_object'
-require 'z_pdf/z_pdf_helper'
+require 'zpdf/html_pdf_object'
+require 'zpdf/zpdf_helper'
 
 module ZPdf #:nodoc:
   #
@@ -27,12 +27,13 @@ module ZPdf #:nodoc:
     abstract!
 
     include AbstractController::Rendering
-    include AbstractController::Layouts
     include AbstractController::Helpers
     include AbstractController::Translation
     include AbstractController::AssetPaths
     include AbstractController::Logger
 
+    include ActionView::Layouts
+
     helper ZPdf::PdfHelper
 
     private_class_method :new #:nodoc:
@@ -90,7 +91,7 @@ module ZPdf #:nodoc:
     end
 
     def process(*args) #:nodoc:
-      lookup_context.skip_default_locale!
+      lookup_context.skip_default_locale! if lookup_context.respond_to?(:skip_default_locale!)
       super
     end
 
@@ -111,7 +112,7 @@ module ZPdf #:nodoc:
       parts = {}
 
       # TODO : support inline content
-      templates_path = params.delete(:template_path) || self.class.generator_name
+      templates_path = params.delete(:templates_path) || self.class.generator_name
       template_names = { :content => params.delete(:template_name) || action_name,
                          :header  => params.delete(:header_template),
                          :footer  => params.delete(:footer_template) }

data/lib/{z_pdf → zpdf}/generators/controller_module/controller_module.rb

@@ -1,12 +1,12 @@
 require 'rails/generators/base'
 
-module ZPdf
+module Zpdf
   module Generators
     class ControllerModuleGenerator < Rails::Generators::Base
       source_root File.join(File.dirname(__FILE__),'templates')
 
       def create_controller_module
-        template "controller_module_template.rb", 'lib/pdf_controller_methods.rb'
+        template "controller_module_template.rb", 'app/controllers/concerns/pdf_controller_methods.rb'
       end
     end
   end

data/lib/zpdf/generators/controller_module/templates/controller_module_template.rb

@@ -0,0 +1,46 @@
+
+# USAGE:
+#  This module provides basic methods to send PDF content. Simply include this module
+#  in your controller(s):
+#
+#  class InvoiceController < ApplicationController
+#     include PdfControllerMethods
+#     ....
+
+#      def show
+#         ...
+#         respond_to do |format|
+#           ....
+#           format.pdf {
+#             send_pdf_content(InvoiceGenerator.invoice(@invoice).pdf_content,
+#                             :file_name => 'invoice.pdf', :force_download => true)
+#           }
+#           ....
+#         end
+#      end
+#  end
+#
+
+
+module PdfControllerMethods
+
+  protected
+
+  # convert a file name to ISO-8859-1, that most browsers parse correctly.
+  def sanitize_file_name(name)
+    # NOTE: We could use ActiveSupport::Inflector#transliterate also, but that would remove diacritics also...
+    name.gsub! /^.*(\\|\/)/, ''
+    name.gsub! /[\:\*\?\"\<\>\|]/, '_'
+    name.gsub! "—", "-"
+    return name.encode('ISO-8859-1', :invalid => :replace, :undef => :replace, :replace => '_')
+  end
+
+  def send_pdf_content(pdf_content,options = {})
+    force_download = options[:force_download] || false
+    file_name = options[:file_name] || self.class.name.underscore
+    headers["Content-Type"] ||= 'application/pdf; charset=iso-8859-1'
+    headers["Content-Disposition"] = "#{force_download ? 'attachment' : 'inline'}; filename=\"#{sanitize_file_name(file_name)}\""
+    render :text => pdf_content, :layout => false
+  end
+
+end

data/lib/{z_pdf → zpdf}/generators/producers/producer.rb

@@ -1,12 +1,12 @@
 require 'rails/generators/base'
 require 'rails/generators/erb'
 
-module ZPdf
+module Zpdf
   module Generators
     class ProducerGenerator < Erb::Generators::Base
       source_root File.join(File.dirname(__FILE__),'templates')
 
-      argument :actions, :type => :array, :default => [], :banner => "method method"
+      argument :actions, :type => :array, :default => ['my_document'], :banner => "method method"
 
       def create_renderer_file
         template "producer_template.rb", File.join('app/pdf_producers', class_path, "#{file_name}.rb")
@@ -16,7 +16,7 @@ module ZPdf
         rails_root = Rails.root.to_s + "/"
         config = Rails.application.config
         paths  = Rails.application.paths
-        pdf_views_path = ( (config.zpdf ? config.zpdf.pdf_views_path : nil) || paths.app.views.to_a.first).gsub(rails_root,'')
+        pdf_views_path = ( (config.zpdf ? config.zpdf.pdf_views_path : nil) || paths['app/views'].first).gsub(rails_root,'')
 
         base_path = File.join(pdf_views_path,class_path,file_name)
         empty_directory base_path

data/lib/{z_pdf → zpdf}/generators/producers/templates/view_template_footer.html.erb

@@ -1,3 +1,4 @@
+<!doctype html>
 <html>
 <body>
   <p>Footer for <%= class_name %>#<%= @action %> (Find me in <%= @path %>)</p>

data/lib/{z_pdf → zpdf}/generators/producers/templates/view_template_header.html.erb

@@ -1,3 +1,4 @@
+<!doctype html>
 <html>
 <body>
   <p>Header for <%= class_name %>#<%= @action %> (Find me in <%= @path %>)</p>

data/lib/{z_pdf → zpdf}/html_pdf_object.rb

@@ -1,5 +1,4 @@
 require 'thread'
-require 'iconv'
 
 module ZPdf
 
@@ -45,7 +44,7 @@ module ZPdf
         outfile_path = html_files[:content].path + '.pdf' # append correct extension to temp file name
         wk_params['header-html'] = html_files[:header].nil? ? nil : "file:///#{html_files[:header].path}"
         wk_params['footer-html'] = html_files[:footer].nil? ? nil : "file:///#{html_files[:footer].path}"
-        wk_params['quiet']       = true
+        wk_params['quiet']       = true unless wk_params['quiet'] == false
 
         cmd = "#{self.class.wkhtmltopdf_path}"
         wk_params.each_pair do |k,v|
@@ -55,8 +54,9 @@ module ZPdf
 
         cmd << " file:///#{html_files[:content].path} #{outfile_path}"
         puts "\n\nexecuting #{cmd}\n\n" if @verbose
-        # avoid errors on systems where command processor is not UTF-8
-       `#{Iconv.new('ISO-8859-1//TRANSLIT','UTF-8').iconv(cmd)}`
+        # TODO: check if errors can occur with systems where command processor is not UTF-8
+        # if so, we could force encoding to something else
+       `#{cmd}`
         if File.exists?(outfile_path)
           output = File.open(outfile_path,'rb') { |f| f.read }
           File.unlink(outfile_path)
@@ -103,7 +103,7 @@ module ZPdf
     end
 
     def self.find_wkhtmltopdf_executable
-      rbCfg = defined?(RbConfig) ?  RbConfig : Config
+      rbCfg = RbConfig
       if rbCfg::CONFIG['host_os'] =~ /mswin|mingw/ # windows?
         ENV['PATH'].split(';').each do |p|
           exec_path = File.join(p,'wkhtmltopdf.exe')

data/lib/{z_pdf → zpdf}/railtie.rb

@@ -4,29 +4,27 @@ require "rails"
 module ZPdf
   class Railtie < Rails::Railtie
     config.zpdf = ActiveSupport::OrderedOptions.new
-    
+    config.eager_load_namespaces << ZPdf
+
     initializer "zpdf.set_configs" do |app|
       paths   = app.config.paths
       options = app.config.zpdf
-      
-      options.assets_dir      ||= paths.public.to_a.first
-      options.javascripts_dir ||= paths.public.javascripts.to_a.first
-      options.stylesheets_dir ||= paths.public.stylesheets.to_a.first
 
       # by default, the views path for ZPdf::Base is the same as other views
-      pdf_views_path = options.pdf_views_path || paths.app.views.to_a.first
+      pdf_views_path = options.pdf_views_path || paths['app/views'].first
 
       ActiveSupport.on_load(:zpdf) do
         include app.routes.url_helpers
-        prepend_view_path pdf_views_path
+        append_view_path pdf_views_path
+        # Send options to corresponding ZPdf::Base methods
         options.each { |k,v| send("#{k}=", v) }
       end
     end
-    
+
     generators do
       load File.expand_path('./generators/producers/producer.rb',File.dirname(__FILE__))
       load File.expand_path('./generators/controller_module/controller_module.rb',File.dirname(__FILE__))
     end
-    
+
   end
 end

data/lib/{z_pdf → zpdf}/version.rb

@@ -2,7 +2,7 @@ module ZPdf
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 2
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,80 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: zpdf
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 6.0.0
 platform: ruby
 authors:
 - Charles Bedard
+- Stephane Volet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: expectations
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-description: 
-email: charles@cbedard.net
+        version: '6.0'
+description: ZPdf allows to produce PDF content based on ERB templates. It easily
+  integrates into a Rails application and operates on a paradigm very similar to Rails
+  ActionMailer.
+email:
+- zzeligg@gmail.com
+- steph@zboing.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/z_pdf/base.rb
-- lib/z_pdf/generators/controller_module/controller_module.rb
-- lib/z_pdf/generators/controller_module/templates/controller_module_template.rb
-- lib/z_pdf/generators/controller_module/USAGE
-- lib/z_pdf/generators/producers/producer.rb
-- lib/z_pdf/generators/producers/templates/producer_template.rb
-- lib/z_pdf/generators/producers/templates/view_template.html.erb
-- lib/z_pdf/generators/producers/templates/view_template_footer.html.erb
-- lib/z_pdf/generators/producers/templates/view_template_header.html.erb
-- lib/z_pdf/generators/producers/USAGE
-- lib/z_pdf/html_pdf_object.rb
-- lib/z_pdf/railtie.rb
-- lib/z_pdf/version.rb
-- lib/z_pdf/z_pdf_helper.rb
+- CHANGELOG.md
 - lib/zpdf.rb
-homepage: http://github.com/schmlblk/zpdf
-licenses: []
+- lib/zpdf/base.rb
+- lib/zpdf/generators/controller_module/USAGE
+- lib/zpdf/generators/controller_module/controller_module.rb
+- lib/zpdf/generators/controller_module/templates/controller_module_template.rb
+- lib/zpdf/generators/producers/USAGE
+- lib/zpdf/generators/producers/producer.rb
+- lib/zpdf/generators/producers/templates/producer_template.rb
+- lib/zpdf/generators/producers/templates/view_template.html.erb
+- lib/zpdf/generators/producers/templates/view_template_footer.html.erb
+- lib/zpdf/generators/producers/templates/view_template_header.html.erb
+- lib/zpdf/html_pdf_object.rb
+- lib/zpdf/railtie.rb
+- lib/zpdf/version.rb
+- lib/zpdf/zpdf_helper.rb
+homepage: https://github.com/schmlblk/zpdf
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -82,17 +89,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: HTML-based PDF rendering engine (using wkhtmltopdf)

data/lib/z_pdf/generators/controller_module/templates/controller_module_template.rb

@@ -1,57 +0,0 @@
-require 'iconv'
-
-# USAGE:
-#  This module provides basic methods to send PDF content. Simply include this module
-#  in your controller(s):
-#
-#  class InvoiceController < ApplicationController
-#     include PdfControllerMethods
-#     ....
-
-#      def show
-#         ...
-#         respond_to do |format|
-#           ....
-#           format.pdf {
-#             send_pdf_content(InvoiceGenerator.invoice(@invoice).pdf_content,
-#                             :file_name => 'invoice.pdf', :force_download => true)
-#           }
-#           ....
-#         end
-#      end
-#  end
-#
-
-module PdfControllerMethods
-
-#  uncomment and implement if you want to add custom functionality when this module is
-#  included.
-#  def self.included(base)
-#    base.class_eval <<-EOV
-#      def do_something_when_pdf_controller_methods_are_included
-#      end
-#    EOV
-#  end
-
-  protected
-  # convert a file name to ISO-8859-1, so that all browsers correctly parse it.
-  def sanitize_file_name(name)
-     c = Iconv.new('ISO-8859-15','UTF-8')
-     s = c.iconv(name.gsub(/[—–]/,'-'))
-     s.gsub!(/^.*(\\|\/)/, '')
-     s.gsub(/[\:\*\?\"\<\>\|]/, '_')
-  end
-
-  def send_pdf_content(pdf_content,options = {})
-     force_download = options[:force_download] || false
-     file_name = options[:file_name] || self.class.name.underscore
-     # content type is 'iso-8859-1' because we want the header values (namely the filename) to
-     # be interpreted as such.
-     headers["Content-Type"] ||= 'application/pdf; charset=iso-8859-1'
-     if force_download
-       headers["Content-Disposition"] = "attachment; filename=\"#{sanitize_file_name(file_name)}\""
-     end
-     render :text => pdf_content, :layout => false
-  end
-
-end