chili_pdf 0.3.0 → 0.4.0

data/Gemfile

@@ -1,6 +1,7 @@
 source 'http://rubygems.org'
 
-gem 'wicked_pdf'
+gem 'wicked_pdf', '~> 0.7'
+gem 'nokogiri', '~> 1.4'
 
 group :development do
   gem 'autotest-rails', '~> 4.1'

data/Gemfile.lock

@@ -21,6 +21,7 @@ GEM
       hoe (>= 2.2.0)
     i18n (0.4.2)
     json (1.4.6)
+    nokogiri (1.4.4)
     rack (1.0.1)
     rake (0.8.7)
     redmine_plugin_support (0.0.4)
@@ -42,7 +43,8 @@ DEPENDENCIES
   hoe (~> 2.8)
   hoe-git
   i18n (= 0.4.2)
+  nokogiri (~> 1.4)
   redmine_plugin_support
   rspec (= 1.3.1)
   rspec-rails (= 1.3.2)
-  wicked_pdf
+  wicked_pdf (~> 0.7)

data/History.txt

@@ -1,3 +1,20 @@
+=== 0.4.0 / 2011-06-18
+
+* New features:
+  * Simplified customizating styles of of exported PDFs. Added ability to
+    insert custom CSS and JavaScript into the DOM before the PDF is
+    rendered [closes #12]
+  * Added support for images in wiki pages to be exported in PDFs [closes #10]
+    (Thanks to @roykolak for the code review!)
+  * Added support for rending the HTML used to create the PDF by passing
+    "as_html=true" in as a URL param (eg: /Page.pdf?as_html=true) [closes #9]
+  * Added nokogiri as a dependency to get around requests for protected
+    assets (images, etc) (see issue #10 for details)
+
+* Minor enhancements:
+  * Fixed image-sizing issue when resolution of image is wider than
+    the exported PDF [closes #11]
+
 === 0.3.0 / 2011-06-13
 
 * New features

data/Manifest.txt

@@ -10,7 +10,11 @@ app/controllers/extended_wiki_controller.rb
 app/helpers/chili_pdf_helper.rb
 app/views/extended_wiki/show.pdf.html.erb
 app/views/layouts/pdf.pdf.erb
+app/views/settings/_chili_pdf_advanced_settings.html.erb
 app/views/settings/_chili_pdf_settings.html.erb
+app/views/settings/_chili_pdf_typical_settings.html.erb
+assets/javascripts/chili_pdf.js
+assets/stylesheets/chili_pdf_settings_tweaks.css
 assets/stylesheets/pdf.css
 autotest/discover.rb
 config/locales/en.yml
@@ -21,6 +25,7 @@ lib/chili_pdf.rb
 lib/chili_pdf/config.rb
 lib/chili_pdf/formatter.rb
 lib/chili_pdf/string_token.rb
+lib/chili_pdf/tag_mangler.rb
 lib/chili_pdf/token_manager.rb
 lib/tasks/chili_pdf_tasks.rb
 lib/tasks/contributor_tasks.rb
@@ -30,5 +35,7 @@ rails/init.rb
 test/chili_pdf/config_test.rb
 test/chili_pdf/formatter_test.rb
 test/chili_pdf/string_token_test.rb
+test/chili_pdf/tag_mangler_test.rb
 test/chili_pdf/token_manager_test.rb
 test/test_helper.rb
+test/unit/helpers/chili_pdf_helper_test.rb

data/README.md

@@ -1,6 +1,6 @@
 # ChiliPDF Plugin - Flexible PDF exporting for ChiliProject/Redmine
 
-* http://github.com/tomkersten/chili_pdf
+* http://github.com/tomkersten/chili\_pdf
 
 ## DESCRIPTION:
 
@@ -24,13 +24,16 @@ ChiliProject (/Redmine) plugin which implements/enhances PDF-export functionalit
 
 ## FEATURES:
 
-1. Provides PDF export of any project wiki page to PDF with a baseline
-  stylesheet. The styling can be customized by modifying the "pdf.css'
-  asset file that ships with the library.
+1. Provides PDF export of any project wiki page to PDF with a decent
+   baseline style out of the box.
+1. Support for dynamic content in headers and footers administered via the
+   plugin configuration page.
+1. Flexible/easy PDF styling. The styling can be customized by adding your
+   own CSS and/or JavaScript on the plugin configuration page.
 
 ## SCREENSHOTS:
 
-You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/sets/72157626827940413/).
+You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/sets/72157626992576450).
 
 ## PROBLEMS:
 
@@ -55,6 +58,7 @@ You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/se
 ## REQUIREMENTS:
 
 * wicked\_pdf
+* nokogiri
 
 ## INSTALL:
 
@@ -136,3 +140,7 @@ You can also drop me a message on Twitter [@tomkersten](http://twitter.com/tomke
 ## LICENSE:
 
 Refer to the [LICENSE](https://github.com/tomkersten/chili_pdf/blob/master/LICENSE) file
+
+## Contributors (sorted alphabetically)
+
+* Roy Kolak

data/Rakefile

@@ -24,7 +24,7 @@ begin
     self.version          = ChiliPDF::VERSION
     self.extra_rdoc_files = FileList['README.md', 'LICENSE', 'History.txt']
     self.summary = "ChiliProject (/Redmine) plugin which implements/enhances PDF-export functionality using the Webkit rendering engine."
-    self.extra_deps       = [['wicked_pdf', '0.7.0']]
+    self.extra_deps       = [['wicked_pdf', '~> 0.7'], ['nokogiri', '~> 1.4']]
     self.extra_dev_deps   = []
     developer('Tom Kersten', 'tom@whitespur.com')
   end

data/app/controllers/extended_wiki_controller.rb

@@ -14,7 +14,7 @@ class ExtendedWikiController < WikiController
 
   private
     def formatter
-      ChiliPDF::Formatter.new(filename, page_title)
+      ChiliPDF::Formatter.new(filename, page_title, wants_html_version?)
     end
 
     def filename
@@ -24,4 +24,8 @@ class ExtendedWikiController < WikiController
     def page_title
       "#{@project.name}, #{@page.title}"
     end
+
+    def wants_html_version?
+      @requesting_html_version = params[:as_html] == 'true' || request.format.html?
+    end
 end

data/app/helpers/chili_pdf_helper.rb

@@ -1,10 +1,167 @@
 module ChiliPdfHelper
-  # Taken almost verbatim from wicked_pdf gem
-  def chili_pdf_stylesheets
-    css_dir = Rails.root.join('public','plugin_assets', 'chili_pdf', 'stylesheets')
-    css_file_list = Dir.glob("#{css_dir}/*css")
-    css_file_list.collect { |css_file|
-      "<style type='text/css'>#{File.read(css_file)}</style>"
+  # Public directory of ChiliPDF plugin JavaScript files
+  PLUGIN_JS_DIR = Rails.root.join('public','plugin_assets', 'chili_pdf', 'javascripts')
+
+  # Public directory of ChiliPDF plugin stylesheets
+  PLUGIN_CSS_DIR = Rails.root.join('public','plugin_assets', 'chili_pdf', 'stylesheets')
+
+  # Standard <script>-tag for Prototype JavaScript file
+  PROTOTYPE_SCRIPT_TAG = "#{Rails.root}/public/javascripts/prototype.js"
+
+
+  # Public: Generates <link> tags for all CSS files in the
+  #         plugin_assets/chili_pdf/stylesheets directory, formatting
+  #         the 'href' attribute value appropriately for HTML or PDF
+  #         request types.
+  #
+  # wants_html - specifies whether the 'src' attribute should be formatted
+  #              for HTML or PDF requests (local vs. relative paths). Added to
+  #              keep excessive boolean logic out of views.
+  #
+  # Returns: String of link tags separated by a newline character.
+  def chili_pdf_stylesheets(wants_html)
+    file_type_list(:css, PLUGIN_CSS_DIR, wants_html) {|asset_path|
+      "<link href='#{asset_path}' rel='stylesheet' type='text/css' />\n"
     }.join("\n")
   end
+
+
+  # Public: Generate JS <script> tags for all JavaScript files in the
+  #         plugin_assets/chili_pdf/stylesheets directory, formatting
+  #         the 'src' attribute value appropriately for HTML or PDF request
+  #         types
+  #
+  # wants_html - specifies whether the 'src' attribute should be formatted
+  #              for HTML or PDF requests (local vs. relative paths). Added to
+  #              keep excessive boolean logic out of views.
+  #
+  # Returns: string of <script> tags separated by a newline character
+  def chili_pdf_javascripts(wants_html)
+    file_type_list(:js, PLUGIN_JS_DIR, wants_html) {|asset_path|
+      "<script src='#{asset_path}' type='text/javascript'></script>"
+    }.join("\n")
+  end
+
+
+  # Public: Converts 'href' attributes of any <link> tags
+  #         tags to be compatible with the `wkhtmltopdf` executable
+  #         requirements, using "file://"-format for all local assets.
+  #
+  # content    - the String of HTML content to normalize/update
+  # wants_html - specifies whether the 'src' attribute should be formatted
+  #              for HTML or PDF requests (local vs. relative paths). Added to
+  #              keep excessive boolean logic out of views.
+  #
+  # Returns content un-modified if wants_html is true. Otherwise returns
+  #         the content string with the modified 'href' attribute on all
+  #         locally-hosted <link>-tags in content.
+  def normalize_custom_link_href_tags_in(content, wants_html = false)
+    update_tag_attribute(:link, :href, content, wants_html)
+  end
+
+
+  # Public: Converts 'src' attributes of any <script> tags (with a 'src'
+  #         attribute) to be compatible with the `wkhtmltopdf` executable
+  #         requirements, using "file://"-format for all local assets.
+  #
+  # content    - the String of HTML content to normalize/update
+  # wants_html - specifies whether the 'src' attribute should be formatted
+  #              for HTML or PDF requests (local vs. relative paths). Added to
+  #              keep excessive boolean logic out of views.
+  #
+  # Returns content un-modified if wants_html is true. Otherwise returns
+  #         the content string with the modified 'src' attribute on all
+  #         locally-hosted <script>-tags in content.
+  def normalize_custom_js_src_tags_in(content, wants_html = false)
+    update_tag_attribute(:script, :src, content, wants_html)
+  end
+
+
+  # Public: Converts 'src' attributes of any <img> tags to be compatible with
+  #         the `wkhtmltopdf` executable requirements, using "file://"-format
+  #         for all local assets.
+  #
+  # content    - the String of HTML content to normalize/update
+  # wants_html - specifies whether the 'src' attribute should be formatted
+  #              for HTML or PDF requests (local vs. relative paths). Added to
+  #              keep excessive boolean logic out of views.
+  #
+  # Returns content un-modified if wants_html is true. Otherwise returns
+  #         the content string with the modified 'src' attribute on all
+  #         locally-hosted <img>-tags in content.
+  def update_img_src_tags_of(content, wants_html = false)
+    update_tag_attribute(:img, :src, content, wants_html)
+  end
+
+
+  private
+    # Updates the value of the specified attribute of any `tag_type` tags
+    # contained in `content` to be compatible with the `wkhtmltopdf`
+    # executable. If `wants_html` is falsey, no modifications are made
+    # to content.
+    #
+    # tag_type   - String-link object which returns the tag to look for in
+    #              'content' when #to_s is called on it.
+    # content    - String of the HTML content to search for `tag_type' in
+    # wants_html - specifies whether the attribute should be formatted
+    #              for HTML or PDF requests (local vs. relative paths). Added to
+    #              keep excessive boolean logic out of views.
+    def update_tag_attribute(tag_type, attribute, content, wants_html)
+      return content if wants_html
+
+      doc = ::Nokogiri::HTML(content)
+      doc.xpath("//#{tag_type.to_s}[@#{attribute.to_s}]").each do |a_tag|
+        a_tag["#{attribute.to_s}"] = mangle(a_tag["#{attribute.to_s}"])
+      end
+      doc.to_s
+    end
+
+
+    # Generate list of content based on files with the specified file extension
+    # in the specified source directory. The object passed into the block will
+    # be the path to an individual file path in either HTML- or PDF-request
+    # compatible form (file://-based or relative-url based). Useful for
+    # generating a series of tags for all files matching a particular file type
+    # in a specified directory.
+    #
+    # file_ext   - the file extension to search for in the src_dir
+    # src_dir    - the directory to search for file with the specified
+    #              file extension (file_ext)
+    # wants_html - specifies whether the 'src' attribute should be formatted
+    #              for HTML or PDF requests (local vs. relative paths). Added to
+    #              keep excessive boolean logic out of views.
+    # &block     - code to execute on each matching filename (filename is
+    #              passed in as a parameter to &block)
+    # Returns an Array of the results of the &block executions.
+    def file_type_list(file_ext, src_dir, wants_html, &block)
+      # We want/need to prepend the Prototype script-tag before all other script-tags
+      file_list = file_ext.to_s == "js" ? [PROTOTYPE_SCRIPT_TAG] : []
+
+      file_list.push(*Dir.glob("#{src_dir}/*#{file_ext.to_s}")).collect do |file_path|
+        asset_path = file_path.to_s.sub(/^#{Rails.root}\/public/, '')
+        asset_path = mangle(asset_path) unless wants_html
+        yield asset_path
+      end
+    end
+
+    # Converts the specified String to PDF-format-friendly version of itself.
+    # Supports the '/attachments/:id/:filename' and '/attachments/download/:id' routes
+    # of ChiliProject as well as standard static assets (nested under RAILS_ROOT/public).
+    #
+    # content - String to convert
+    #
+    # Examples
+    #
+    #   mangle('/stylesheets/application.css')
+    #   => "file:///path/to/rails_root/public/stylesheets/application.css"
+    #
+    #   mangle('/attachments/1/image.png')
+    #   => "file:///path/to/rails_root/files/38278327_image.png"
+    #
+    # Returns modified String, unless requested asset either doesn't exist
+    #   or is an invalid request (to, say, an asset located above
+    #   the 'RAILS_ROOT/public' sub-directory.
+    def mangle(content)
+      TagMangler.new(content).to_local_src
+    end
 end

data/app/views/extended_wiki/show.pdf.html.erb

@@ -1,5 +1,9 @@
 <% content_for :header_tags do %>
-  <%= chili_pdf_stylesheets %>
+  <%= chili_pdf_stylesheets(@requesting_html_version) %>
+  <%= chili_pdf_javascripts(@requesting_html_version) %>
+  <%= normalize_custom_link_href_tags_in(ChiliPDF::Config.custom_css, @requesting_html_version) %>
+  <%= normalize_custom_js_src_tags_in(ChiliPDF::Config.custom_js, @requesting_html_version) %>
 <% end %>
 
-<%= render(:partial => "wiki/content", :locals => {:content => @content}) %>
+<%- html_content = textilizable(@content.text, :attachments => @content.page.attachments) %>
+<%= update_img_src_tags_of(html_content, @requesting_html_version) %>

data/app/views/layouts/pdf.pdf.erb

@@ -16,7 +16,7 @@
   <%= yield(:header_tags) %>
 </head>
 
-<body>
+<body id="custom-pdf-styles">
   <%= yield(:layout) %>
 </body>
 </html>

data/app/views/settings/_chili_pdf_advanced_settings.html.erb

@@ -0,0 +1,13 @@
+<p class="chili-pdf-instructions">
+  You can add custom CSS & JavaScript which will be applied to your PDF before saving.
+</p>
+
+<p>
+  <label><%= l(:label_custom_css) %></label>
+  <%= text_area_tag "settings[#{ChiliPDF::Config::CUSTOM_CSS_KEYNAME}]", ChiliPDF::Config.custom_css %>
+</p>
+
+<p>
+  <label><%= l(:label_custom_js) %></label>
+  <%= text_area_tag "settings[#{ChiliPDF::Config::CUSTOM_JS_KEYNAME}]", ChiliPDF::Config.custom_js %>
+</p>

data/app/views/settings/_chili_pdf_settings.html.erb

@@ -1,82 +1,9 @@
 <% content_for :header_tags do %>
-  <%= stylesheet_link_tag '/plugin_assets/chili_pdf/stylesheets/pdf' %>
+  <%= stylesheet_link_tag '/plugin_assets/chili_pdf/stylesheets/chili_pdf_settings_tweaks' %>
 <% end %>
 
-<p>
-  <label for='settings_<%= ChiliPDF::Config::HEADER_ENABLED_KEYNAME %>'><%= l(:header_enabled_label) %></label>
-  <%= check_box_tag "settings[#{ChiliPDF::Config::HEADER_ENABLED_KEYNAME}]", ChiliPDF::Config::ENABLED_VALUE, ChiliPDF::Config.header_enabled? %>
-</p>
+<%= render_tabs([
+    {:name => 'typical_settings', :partial => 'settings/chili_pdf_typical_settings', :label => :typical_plugin_settings},
+    {:name => 'advanced_settings', :partial => 'settings/chili_pdf_advanced_settings', :label => :advanced_plugin_settings},
+]) %>
 
-<p>
-  <label for='settings_<%= ChiliPDF::Config::FOOTER_ENABLED_KEYNAME %>'><%= l(:footer_enabled_label) %></label>
-  <%= check_box_tag "settings[#{ChiliPDF::Config::FOOTER_ENABLED_KEYNAME}]", ChiliPDF::Config::ENABLED_VALUE, ChiliPDF::Config.footer_enabled? %>
-</p>
-
-<h3>Custom Header/Footer Content</h3>
-
-<h4>Rules</h4>
-<ol>
-  <li>Any "plain text" will render, as is...</li>
-  <li>
-    There are a few 'variables' you can use to dynamically replace content. For example,
-    you can add the current date to any page.
-  </li>
-  <li>All input will be escaped HTML, so injecting dynamic content via JavaScript will not work.</li>
-</ol>
-
-<table>
-  <thead>
-    <tr>
-      <td></td>
-      <td>Left</td>
-      <td>Center</td>
-      <td>Right</td>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>Header</td>
-      <td>
-        <%= text_field_tag "settings[#{ChiliPDF::Config::HEADER_LEFT_KEYNAME}]", ChiliPDF::Config.header_values[:left] %>
-      </td>
-      <td>
-        <%= text_field_tag "settings[#{ChiliPDF::Config::HEADER_CENTER_KEYNAME}]", ChiliPDF::Config.header_values[:center] %>
-      </td>
-      <td>
-        <%= text_field_tag "settings[#{ChiliPDF::Config::HEADER_RIGHT_KEYNAME}]", ChiliPDF::Config.header_values[:right] %>
-      </td>
-    </tr>
-    <tr>
-      <td>Footer</td>
-      <td>
-        <%= text_field_tag "settings[#{ChiliPDF::Config::FOOTER_LEFT_KEYNAME}]", ChiliPDF::Config.footer_values[:left] %>
-      </td>
-      <td>
-        <%= text_field_tag "settings[#{ChiliPDF::Config::FOOTER_CENTER_KEYNAME}]", ChiliPDF::Config.footer_values[:center] %>
-      </td>
-      <td>
-        <%= text_field_tag "settings[#{ChiliPDF::Config::FOOTER_RIGHT_KEYNAME}]", ChiliPDF::Config.footer_values[:right] %>
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-<div id="pdf-token-help">
-  <h4>Dynamic text legend</h4>
-  <table>
-    <thead>
-      <tr>
-        <td>Enter this</td>
-        <td>...to show this</td>
-      </tr>
-    </thead>
-    <tbody>
-      <%- ChiliPDF::TokenManager.tokens.each do |token| %>
-        <tr>
-          <td class="token"><%= token.matcher_with_delimiters %></td>
-          <td class="description"><%= token.description %></td>
-        </tr>
-      <%- end %>
-    </tbody>
-  </table>
-</div>

data/app/views/settings/_chili_pdf_typical_settings.html.erb

@@ -0,0 +1,76 @@
+<p class="chili-pdf-instructions">
+  <span class="tip-label">Pro Tip:</span>
+  You can see what impact your settings have on exported items by appending a
+  "<em>.pdf?as_html=true</em>" to the URL of any wiki page. This will give you an
+  idea of what your style/behavior changes will look like (without headers, margins,
+  et cetera).
+</p>
+
+<p>
+  <label for='settings_<%= ChiliPDF::Config::HEADER_ENABLED_KEYNAME %>'><%= l(:header_enabled_label) %></label>
+  <%= check_box_tag "settings[#{ChiliPDF::Config::HEADER_ENABLED_KEYNAME}]", ChiliPDF::Config::ENABLED_VALUE, ChiliPDF::Config.header_enabled? %>
+</p>
+
+<p>
+  <label for='settings_<%= ChiliPDF::Config::FOOTER_ENABLED_KEYNAME %>'><%= l(:footer_enabled_label) %></label>
+  <%= check_box_tag "settings[#{ChiliPDF::Config::FOOTER_ENABLED_KEYNAME}]", ChiliPDF::Config::ENABLED_VALUE, ChiliPDF::Config.footer_enabled? %>
+</p>
+
+<h3>Custom Header/Footer Content</h3>
+
+<table>
+  <thead>
+    <tr>
+      <td></td>
+      <td>Left</td>
+      <td>Center</td>
+      <td>Right</td>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>Header</td>
+      <td>
+        <%= text_field_tag "settings[#{ChiliPDF::Config::HEADER_LEFT_KEYNAME}]", ChiliPDF::Config.header_values[:left] %>
+      </td>
+      <td>
+        <%= text_field_tag "settings[#{ChiliPDF::Config::HEADER_CENTER_KEYNAME}]", ChiliPDF::Config.header_values[:center] %>
+      </td>
+      <td>
+        <%= text_field_tag "settings[#{ChiliPDF::Config::HEADER_RIGHT_KEYNAME}]", ChiliPDF::Config.header_values[:right] %>
+      </td>
+    </tr>
+    <tr>
+      <td>Footer</td>
+      <td>
+        <%= text_field_tag "settings[#{ChiliPDF::Config::FOOTER_LEFT_KEYNAME}]", ChiliPDF::Config.footer_values[:left] %>
+      </td>
+      <td>
+        <%= text_field_tag "settings[#{ChiliPDF::Config::FOOTER_CENTER_KEYNAME}]", ChiliPDF::Config.footer_values[:center] %>
+      </td>
+      <td>
+        <%= text_field_tag "settings[#{ChiliPDF::Config::FOOTER_RIGHT_KEYNAME}]", ChiliPDF::Config.footer_values[:right] %>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+<div id="pdf-token-help">
+  <h4>Dynamic text legend</h4>
+  <table>
+    <thead>
+      <tr>
+        <td>Enter this</td>
+        <td>...to show this</td>
+      </tr>
+    </thead>
+    <tbody>
+      <%- ChiliPDF::TokenManager.tokens.each do |token| %>
+        <tr>
+          <td class="token"><%= token.matcher_with_delimiters %></td>
+          <td class="description"><%= token.description %></td>
+        </tr>
+      <%- end %>
+    </tbody>
+  </table>
+</div>

data/assets/stylesheets/chili_pdf_settings_tweaks.css

@@ -0,0 +1,10 @@
+em {font-style: italic;}
+textarea {width: 600px; height: 200px;}
+
+p.chili-pdf-instructions {padding-left: 0;}
+.tip-label {font-weight: bold; text-decoration: underline;}
+
+#pdf-token-help {margin-top: 20px;}
+#pdf-token-help table {width: 100%; border: 1px #AAA solid;}
+#pdf-token-help td {border-bottom: 1px dotted #CCC;}
+#pdf-token-help thead td {font-weight: bold; border-bottom: 2px solid #CCC;}

data/assets/stylesheets/pdf.css

@@ -33,12 +33,4 @@ li { padding: 0.1em; }
 ol li {list-style-type: decimal;}
 ul li {list-style-type: disc;}
 h1, h2 {font-weight: bold;}
-
-#pdf-token-help {
-  margin-top: 20px;
-}
-
-#pdf-token-help table {width: 100%; border: 1px #AAA solid;}
-#pdf-token-help td {border-bottom: 1px dotted #CCC;}
-
-#pdf-token-help thead td {font-weight: bold; border-bottom: 2px solid #CCC;}
+img {max-width: 100%;}

data/config/locales/en.yml

@@ -3,3 +3,7 @@ en:
   chili_pdf_instructions: 'You can customize the behavior of the ChiliPDf plugin with the settings below'
   header_enabled_label: Display page header?
   footer_enabled_label: Display page footer?
+  typical_plugin_settings: Typical Settings
+  advanced_plugin_settings: Technical Settings
+  label_custom_css: Custom CSS
+  label_custom_js: Custom JavaScript

data/config/routes.rb

@@ -1,3 +1,4 @@
 ActionController::Routing::Routes.draw do |map|
+  map.connect 'projects/:project_id/wiki.pdf', :controller => 'extended_wiki', :action => 'show', :format => 'pdf'
   map.connect 'projects/:project_id/wiki/:id.pdf', :controller => 'extended_wiki', :action => 'show', :format => 'pdf'
 end

data/init.rb

@@ -1,6 +1,7 @@
 require 'redmine'
 require 'chili_pdf'
-require 'wicked_pdf'
+require 'wicked_pdf' unless defined?(WickedPdf)
+require 'nokogiri' unless defined?(Nokogiri)
 require 'dispatcher'
 
 Redmine::Plugin.register :chili_pdf do

data/lib/chili_pdf.rb

@@ -2,7 +2,8 @@ require 'chili_pdf/config'
 require 'chili_pdf/token_manager'
 require 'chili_pdf/formatter'
 require 'chili_pdf/string_token'
+require 'chili_pdf/tag_mangler'
 
 module ChiliPDF
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/chili_pdf/config.rb

@@ -7,6 +7,8 @@ module ChiliPDF
     DISABLED_VALUE = '0'
     FOOTER_ENABLED_KEYNAME = 'footer_enabled'
     HEADER_ENABLED_KEYNAME = 'header_enabled'
+    CUSTOM_CSS_KEYNAME      = 'custom_css'
+    CUSTOM_JS_KEYNAME       = 'custom_javascript'
 
     HEADER_LEFT_KEYNAME   = :header_content_left
     HEADER_CENTER_KEYNAME = :header_content_center
@@ -21,6 +23,25 @@ module ChiliPDF
     FOOTER_LEFT_DEFAULT_VALUE   = '{{datestamp}}'
     FOOTER_CENTER_DEFAULT_VALUE = ''
     FOOTER_RIGHT_DEFAULT_VALUE  = '{{current_page}}/{{total_pages}}'
+    CUSTOM_CSS_DEFAULT_VALUE    = <<END_OF_CSS_DEF
+<!-- stylesheet link example, uncomment & modify if you like -->
+<!-- <link href='/stylesheets/your_custom.css' rel='stylesheet' type='text/css' />
+
+<!-- inline example -->
+<style type="text/css">
+  //#custom-pdf-styles h2 {color: red;}
+</style>
+END_OF_CSS_DEF
+
+    CUSTOM_JS_DEFAULT_VALUE     = <<END_OF_JS_DEF
+<!-- Script tag link example. Uncomment & modify if you like.  -->
+<!-- <script src='/javascripts/your_custom.js' type='text/javascript' />
+
+<!-- Inline JavaScript example -->
+<script type="text/javascript">
+  // Your custom-inline JS here
+</script>
+END_OF_JS_DEF
 
     def defaults
       {
@@ -31,7 +52,9 @@ module ChiliPDF
         HEADER_RIGHT_KEYNAME   => HEADER_RIGHT_DEFAULT_VALUE,
         FOOTER_LEFT_KEYNAME    => FOOTER_LEFT_DEFAULT_VALUE,
         FOOTER_CENTER_KEYNAME  => FOOTER_CENTER_DEFAULT_VALUE,
-        FOOTER_RIGHT_KEYNAME   => FOOTER_RIGHT_DEFAULT_VALUE
+        FOOTER_RIGHT_KEYNAME   => FOOTER_RIGHT_DEFAULT_VALUE,
+        CUSTOM_CSS_KEYNAME     => CUSTOM_CSS_DEFAULT_VALUE,
+        CUSTOM_JS_KEYNAME      => CUSTOM_JS_DEFAULT_VALUE
       }
     end
 
@@ -72,6 +95,22 @@ module ChiliPDF
       default_footer_values.merge(stored_footer_settings)
     end
 
+    def custom_css
+      if plugin_settings[CUSTOM_CSS_KEYNAME].blank?
+        CUSTOM_CSS_DEFAULT_VALUE
+      else
+        plugin_settings[CUSTOM_CSS_KEYNAME]
+      end
+    end
+
+    def custom_js
+      if plugin_settings[CUSTOM_JS_KEYNAME].blank?
+        CUSTOM_JS_DEFAULT_VALUE
+      else
+        plugin_settings[CUSTOM_JS_KEYNAME]
+      end
+    end
+
     private
       def default_header_values
         {:left => HEADER_LEFT_DEFAULT_VALUE,

data/lib/chili_pdf/formatter.rb

@@ -15,9 +15,10 @@ module ChiliPDF
                        :description        => "The project & wiki page name (eg: 'My Project, Wiki Page Title')"}}
     end
 
-    def initialize(filename, title = nil)
+    def initialize(filename, title = nil, render_html_version = nil)
       @page_title = title
       @filename = filename
+      @allow_debugging = render_html_version
 
       # TODO: Hack...need to come up with better approach for this...
       TokenManager.add_token_definition do
@@ -31,6 +32,7 @@ module ChiliPDF
         :pdf => @filename,
         :template => view_template,
         :page_size => DEFAULT_PAGE_SIZE,
+        :show_as_html => render_as_html?,
         :margin => {
           :top    => DEFAULT_MARGIN,
           :bottom => DEFAULT_MARGIN,
@@ -76,5 +78,9 @@ module ChiliPDF
       def view_template
         DEFAULT_VIEW_TEMPLATE
       end
+
+      def render_as_html?
+        !@allow_debugging.blank?
+      end
   end
 end

data/lib/chili_pdf/tag_mangler.rb

@@ -0,0 +1,65 @@
+class TagMangler
+  def initialize(src)
+    @src_attribute = src
+  end
+
+  def to_local_src
+    full_file_path.blank? ? @src_attribute : "file://#{full_file_path}"
+  end
+
+  private
+    def full_file_path
+      if requesting_valid_static_asset?
+        requested_path
+      elsif requesting_attachment? && !attachment.blank?
+        attachment.diskfile
+      end
+    end
+
+    def attachment
+      Attachment.find_by_id(attachment_id)
+    end
+
+    def requesting_attachment?
+      !attachment_id.blank?
+    end
+
+    def requesting_valid_static_asset?
+      requested_asset_under_public_dir? && static_asset_exists?
+    end
+
+    def static_asset_exists?
+      File.exists?(requested_path)
+    end
+
+    def requested_path
+      File.expand_path(File.join(public_path, @src_attribute))
+    end
+
+    def public_path
+      File.expand_path(File.join(Rails.root, 'public'))
+    end
+
+    def requested_asset_under_public_dir?
+      requested_path.match(/^#{public_path}/)
+    end
+
+    # Pull the specified attachment ID out of the @src_attribute
+    # if it is in one of the 'standad' URL formats
+    # (ie: the :id field from the examples below)
+    #
+    # Example URLs:
+    #   /attachments/:id/:filename
+    #   /attachments/download/:id
+    #
+    # Returns the specified id as a string if a valid one is present
+    # Returns nil otherwise
+    def attachment_id
+      regexp = Regexp.new(/\/?attachments(?:\/download)?\/(\d+)\/?.*/)
+      @src_attribute.match(regexp) && $1
+    end
+
+
+end
+
+

data/test/chili_pdf/formatter_test.rb

@@ -30,6 +30,23 @@ class FormatterTest < Test::Unit::TestCase
       assert_equal default_margins, @formatter.render_options[:margin]
     end
 
+    context "enabling/disabling viewing the underlying HTML of the PDF" do
+      should "set :show_as_html key to true when true is specified" do
+        formatter = Formatter.new('filename.pdf', 'title', true)
+        assert formatter.render_options[:show_as_html]
+      end
+
+      should "set :show_as_html key to false when false is specified" do
+        formatter = Formatter.new('filename.pdf', 'title', false)
+        assert !formatter.render_options[:show_as_html]
+      end
+
+      should "set :show_as_html key to false as the default" do
+        formatter = Formatter.new('filename.pdf', 'title')
+        assert !formatter.render_options[:show_as_html]
+      end
+    end
+
     context 'when footers are enabled' do
       setup do
         enable_footers

data/test/chili_pdf/tag_mangler_test.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+def make_mangler_with(asset_path)
+  TagMangler.new(asset_path)
+end
+
+# Stolen from the Rails.root test_helper...
+# not sure why they are not being included in here yet
+def mock_file
+  file = 'a_file.png'
+  file.stubs(:size).returns(32)
+  file.stubs(:original_filename).returns('a_file.png')
+  file.stubs(:content_type).returns('image/png')
+  file.stubs(:read).returns(false)
+  file
+end
+
+class TokenManagerTest < Test::Unit::TestCase
+  context "#to_local_src" do
+    context "when requesting a static asset" do
+      setup do
+        @requested_asset = "../Rakefile"
+        @mangler = make_mangler_with(@requested_asset)
+      end
+
+      context "which is not nested under the 'public' directory of the application" do
+        should "return the original value without any modifications" do
+          assert_equal @requested_asset, @mangler.to_local_src
+        end
+      end
+
+      context "which does not exist on the filesystem" do
+        setup do
+          @requested_asset = 'stylesheets/faux_css_file_fildjakfldsa.css'
+          @mangler = make_mangler_with(@requested_asset)
+        end
+
+        should "return the original value without any modifications" do
+          assert_equal @requested_asset, @mangler.to_local_src
+        end
+      end
+
+      context "which does exist on the filesystem" do
+        setup do
+          # slightly brittle, but assuming application.css
+          # will always ship w/ app...
+          @requested_asset = 'stylesheets/application.css'
+          @mangler = make_mangler_with(@requested_asset)
+        end
+
+        should "return the full (local) path to the file prepended with 'file://'" do
+          css_path = File.join(Rails.root, 'public', 'stylesheets', 'application.css')
+          assert_equal "file://#{css_path}", @mangler.to_local_src
+        end
+      end
+    end
+
+    context "when requesting an Attachment" do
+      context "using a URI in the form of 'attachments/download/200'"do
+        setup do
+          @requested_asset = '/attachments/download/200'
+          @mangler = make_mangler_with(@requested_asset)
+        end
+
+        should "search for an attachment with an id of '200'" do
+          Attachment.expects(:find).with(:first, {:conditions => {:id => '200'}})
+          @mangler.to_local_src
+        end
+      end
+
+      context "using a URI in the form of 'attachments/2/after.png'"do
+        setup do
+          @requested_asset = 'attachments/2/after.png'
+          @mangler = make_mangler_with(@requested_asset)
+        end
+
+        should "search for an attachment with an id of '2'" do
+          Attachment.expects(:find).with(:first, :conditions => {:id => '2'})
+          @mangler.to_local_src
+        end
+      end
+
+      context "which does not exist" do
+        setup do
+          @requested_asset = '/attachments/download/1'
+          @mangler = make_mangler_with(@requested_asset)
+          Attachment.expects(:find).returns(nil)
+        end
+
+        should "return the original value without any modifications" do
+          assert_equal @requested_asset, @mangler.to_local_src
+        end
+      end
+
+      context "which exists" do
+        setup do
+          # Set up faux local file location & Attachment instance
+          @local_path = '/a/local/path/to/file.png'
+          @req_attachment = mock_file
+          @req_attachment.stubs(:diskfile).returns(@local_path)
+
+          # Stub finding the instance
+          Attachment.stubs(:find).returns(@req_attachment)
+
+          @requested_asset = '/attachments/download/200'
+          @mangler = make_mangler_with(@requested_asset)
+        end
+
+        should "render the full (local) path to the file" do
+          assert_equal "file://#{@local_path}", @mangler.to_local_src
+        end
+      end
+    end
+  end
+end

data/test/unit/helpers/chili_pdf_helper_test.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class ChiliPdfHelperTest < HelperTestCase
+  include ChiliPdfHelper
+
+  context "#chili_pdf_stylesheets" do
+    should "include the pdf.css stylesheet" do
+      assert_match %r(<link.*href=['"].*pdf\.css['"].*>), chili_pdf_stylesheets(false)
+    end
+
+    context "when making an HTML request" do
+      should "set the vale of the 'href' attribute to a relative URL" do
+        assert_match %r(<link.*href=['"]/.*\.css['"].*>), chili_pdf_stylesheets(true)
+      end
+    end
+
+    context "when making a PDF request" do
+      should "set the vale of the 'href' attribute to a file://-based location" do
+        assert_match %r(<link.*href=['"]file://.*\.css['"].*>), chili_pdf_stylesheets(false)
+      end
+    end
+  end
+
+  context "#chili_pdf_javascripts" do
+    should "include the prototype JavaScript library" do
+      assert_match %r(<script.*src=['"].*prototype\.js['"].*></script>), chili_pdf_javascripts(false)
+    end
+
+    context "when making an HTML request" do
+      should "set the vale of the 'src' attribute to a relative URL" do
+        assert_match %r(<script.*src=['"]/.*\.js['"].*></script>), chili_pdf_javascripts(true)
+      end
+    end
+
+    context "when making a PDF request" do
+      should "set the vale of the 'src' attribute to a file://-based location" do
+        assert_match %r(<script.*src=['"]file://.*\.js['"].*></script>), chili_pdf_javascripts(false)
+      end
+    end
+  end
+
+  context "#normalize_custom_link_href_tags_in" do
+    setup do
+      @html = "<link href='/stylesheets/application.css' />"
+    end
+
+    context "when making an HTML request" do
+      should "set the vale of the 'href' attribute to a relative URL" do
+        results = normalize_custom_link_href_tags_in(@html, true)
+        assert_match %r(<link.*href=['"]/stylesheets/application\.css['"].*>), results
+      end
+    end
+
+    context "when making a PDF request" do
+      should "set the vale of the 'href' attribute to a file://-based location" do
+        results = normalize_custom_link_href_tags_in(@html, false)
+        assert_match %r(<link.*href=['"]file://.*/stylesheets/application\.css['"].*>), results
+      end
+    end
+  end
+
+  context "#normalize_custom_js_src_tags_in" do
+    setup do
+      @html = "<script src='/plugin_assets/chili_pdf/javascripts/chili_pdf.js'></script>"
+    end
+
+    context "when making an HTML request" do
+      should "set the vale of the 'src' attribute to a relative URL" do
+        results = normalize_custom_js_src_tags_in(@html, true)
+        assert_match %r(<script.*src=['"]/plugin_assets/chili_pdf/javascripts/chili_pdf\.js['"].*></script>), results
+      end
+    end
+
+    context "when making a PDF request" do
+      should "set the vale of the 'src' attribute to a file://-based location" do
+        results = normalize_custom_js_src_tags_in(@html, false)
+        assert_match %r(<script.*src=['"]file://.*/plugin_assets/chili_pdf/javascripts/chili_pdf\.js['"].*></script>), results
+      end
+    end
+  end
+
+  context "#update_img_src_tags_of" do
+    setup do
+      @html = "<img src='/images/cancel.png'>"
+    end
+
+    context "when making an HTML request" do
+      should "set the vale of the 'src' attribute to a relative URL" do
+        results = update_img_src_tags_of(@html, true)
+        assert_match %r(<img.*src=['"]/images/cancel\.png['"].*>), results
+      end
+    end
+
+    context "when making a PDF request" do
+      should "set the vale of the 'src' attribute to a file://-based location" do
+        results = update_img_src_tags_of(@html, false)
+        assert_match %r(<img.*src=['"]file://.*/images/cancel\.png['"].*>), results
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chili_pdf
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Tom Kersten
@@ -36,7 +36,7 @@ cert_chain:
   NVADJA==
   -----END CERTIFICATE-----
 
-date: 2011-06-13 00:00:00 -05:00
+date: 2011-06-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,20 +45,34 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 5
         segments: 
         - 0
         - 7
-        - 0
-        version: 0.7.0
+        version: "0.7"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: nokogiri
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -70,7 +84,7 @@ dependencies:
         - 0
         version: 2.8.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: ChiliProject (/Redmine) plugin which implements/enhances PDF-export functionality using the Webkit rendering engine (via the 'wkhtmltopdf' executable).
 email: 
 - tom@whitespur.com
@@ -96,7 +110,11 @@ files:
 - app/helpers/chili_pdf_helper.rb
 - app/views/extended_wiki/show.pdf.html.erb
 - app/views/layouts/pdf.pdf.erb
+- app/views/settings/_chili_pdf_advanced_settings.html.erb
 - app/views/settings/_chili_pdf_settings.html.erb
+- app/views/settings/_chili_pdf_typical_settings.html.erb
+- assets/javascripts/chili_pdf.js
+- assets/stylesheets/chili_pdf_settings_tweaks.css
 - assets/stylesheets/pdf.css
 - autotest/discover.rb
 - config/locales/en.yml
@@ -107,6 +125,7 @@ files:
 - lib/chili_pdf/config.rb
 - lib/chili_pdf/formatter.rb
 - lib/chili_pdf/string_token.rb
+- lib/chili_pdf/tag_mangler.rb
 - lib/chili_pdf/token_manager.rb
 - lib/tasks/chili_pdf_tasks.rb
 - lib/tasks/contributor_tasks.rb
@@ -116,10 +135,12 @@ files:
 - test/chili_pdf/config_test.rb
 - test/chili_pdf/formatter_test.rb
 - test/chili_pdf/string_token_test.rb
+- test/chili_pdf/tag_mangler_test.rb
 - test/chili_pdf/token_manager_test.rb
 - test/test_helper.rb
+- test/unit/helpers/chili_pdf_helper_test.rb
 has_rdoc: true
-homepage: http://github.com/tomkersten/chili_pdf
+homepage: http://github.com/tomkersten/chili\_pdf
 licenses: []
 
 post_install_message: