chili_pdf 0.4.1 → 0.4.3

data/History.txt

@@ -1,3 +1,21 @@
+=== 0.4.3 / 2011-06-20
+
+* Bugfix:
+  * Yanked 0.4.2 release...this release fixes a mistake tests did not
+    catch...no features other than that on top of 0.4.2
+
+=== 0.4.2 / 2011-06-20
+
+* Minor enhancements:
+  * Updates added style for logo image in plugin settings to reflect
+    the size it will render as within a PDF.
+
+* Bugfix:
+  * Fixed the issue with relative links not working. All links will point
+    to URLs for the time-being (vs in-document chapter links), as the
+    anchor-tag-to-chapter-link conversion doesn't seem to be working for
+    some reason.  [closes #16]
+
 === 0.4.1 / 2011-06-19
 
 * New features:

data/app/helpers/chili_pdf_helper.rb

@@ -112,6 +112,35 @@ module ChiliPdfHelper
     end
   end
 
+  # Public: Converts 'href' attributes of any <a> tags to be compatible with
+  #         the `wkhtmltopdf` executable requirements (to absolute URLs).
+  #         Capable of handling URLs to both other domains and relative URLS.
+  #
+  # content    - the String of HTML content to normalize/update
+  #
+  # Returns content un-modified if wants_html is true. Otherwise returns
+  #         the content string with the modified 'href' attribute on all
+  #         <a>-tags in content.
+  def update_a_hrefs(content)
+    update_tag_attribute(:a, :href, content, false, :absolute_url)
+  end
+
+  # Public: Converts 'href' attributes of any <a> tags  and any 'src' attributes
+  #         of <img> tags contained in 'content' to be compatible with
+  #         the `wkhtmltopdf` executable (to absolute & 'file://-based' URLs).
+  #
+  # content    - the String of HTML content to normalize/update
+  # 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.
+  #
+  # Returns content un-modified if wants_html is true. Otherwise returns
+  #         the content string with the modified 'href' attribute on all
+  #         <a>-tags in content.
+  def update_link_and_image_urls(content, wants_html)
+    update_a_hrefs(update_img_src_tags_of(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`
@@ -124,12 +153,12 @@ module ChiliPdfHelper
     # 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)
+    def update_tag_attribute(tag_type, attribute, content, wants_html, url_type = :file)
       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}"])
+        a_tag["#{attribute.to_s}"] = mangle(a_tag["#{attribute.to_s}"], url_type)
       end
       doc.to_s
     end
@@ -148,8 +177,7 @@ module ChiliPdfHelper
     # 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
@@ -164,9 +192,13 @@ module ChiliPdfHelper
 
     # 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).
+    # of ChiliProject as well as standard static assets (nested under RAILS_ROOT/public),
+    # and URLs (relative & absolute).
     #
-    # content - String to convert
+    # content  - String to convert
+    # url_type - symbol of the type of url to convert (default: :file)
+    #            :file         - process as a local-file URL, if valid
+    #            :absolute_url - process as if the content were a web URL
     #
     # Examples
     #
@@ -177,9 +209,14 @@ module ChiliPdfHelper
     #   => "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
+    #   or is an invalid request (eg: an asset located above the 'RAILS_ROOT/public'
+    #   sub-directory).
+    def mangle(content, url_type = :file)
+      case url_type
+      when :file then TagMangler.new(content).to_local_src
+      when :absolute_url then TagMangler.new(content, request).to_absolute_url
+      else
+        raise ArgumentError, "invalid url_type passed to #mangle (received: #{url_type.inspect})"
+      end
     end
 end

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

@@ -8,4 +8,4 @@
 <%= logo_img_tag(@requesting_html_version) %>
 
 <%- html_content = textilizable(@content.text, :attachments => @content.page.attachments) %>
-<%= update_img_src_tags_of(html_content, @requesting_html_version) %>
+<%= update_link_and_image_urls(html_content, @requesting_html_version) %>

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

@@ -9,5 +9,5 @@ have uploaded to this site, or any public URL.
 
 <%- if ChiliPDF::Config.logo_url? %>
   <h4>Current logo</h4>
-  <%= image_tag ChiliPDF::Config.logo_url %>
+  <%= image_tag ChiliPDF::Config.logo_url, :id => 'chili-pdf-logo' %>
 <%- end %>

data/assets/stylesheets/chili_pdf_settings_tweaks.css

@@ -13,3 +13,5 @@ p.chili-pdf-instructions {padding-left: 0;}
 #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;}
+
+#chili-pdf-logo {max-height:50px; border:none;}

data/lib/chili_pdf.rb

@@ -5,5 +5,5 @@ require 'chili_pdf/string_token'
 require 'chili_pdf/tag_mangler'
 
 module ChiliPDF
-  VERSION = '0.4.1'
+  VERSION = '0.4.3'
 end

data/lib/chili_pdf/tag_mangler.rb

@@ -1,13 +1,28 @@
 class TagMangler
-  def initialize(src)
-    @src_attribute = src
+  def initialize(src, request_like_object = nil)
+    @src_attribute = src # /roy
+    @request_like = request_like_object
   end
 
   def to_local_src
     full_file_path.blank? ? @src_attribute : "file://#{full_file_path}"
   end
 
+  def to_absolute_url
+     if relative_url?
+       "#{base_url}#{relative_url}"
+     elsif anchor_tag
+       "#{@request_like.url}#{anchor_tag}"
+     else
+       @src_attribute
+     end
+  end
+
   private
+    def base_url
+      @request_like.url.sub(@request_like.request_uri, '/')
+    end
+
     def full_file_path
       if requesting_valid_static_asset?
         requested_path
@@ -16,6 +31,22 @@ class TagMangler
       end
     end
 
+    def anchor_tag
+      @src_attribute[%r!^(#.*)!]
+    end
+
+    def anchor_tag?
+      !anchor_tag.blank
+    end
+
+    def relative_url
+      @src_attribute.match(%r!^/(.*)!) && $1
+    end
+
+    def relative_url?
+      !relative_url.blank?
+    end
+
     def attachment
       Attachment.find_by_id(attachment_id)
     end

data/test/chili_pdf/tag_mangler_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-def make_mangler_with(asset_path)
-  TagMangler.new(asset_path)
+def make_mangler_with(asset_path, request_like = nil)
+  TagMangler.new(asset_path, request_like)
 end
 
 # Stolen from the Rails.root test_helper...
@@ -112,4 +112,54 @@ class TokenManagerTest < Test::Unit::TestCase
       end
     end
   end
+
+  context "#to_absolute_url" do
+    context "when the content passed in has a link to another domain" do
+      setup do
+        @requested_asset = "http://someotherhost.com/page.html"
+        @mangler = make_mangler_with(@requested_asset)
+      end
+
+      should "not be modified" do
+        assert_equal @requested_asset, @mangler.to_absolute_url
+      end
+    end
+
+    context "when the content passed in has a relative link" do
+      setup do
+        @base_url = "http://example.com"
+        @requested_asset = "/page"
+        @absolute_url = "#{@base_url}#{@requested_asset}"
+
+        mock_request = 'Mocked Request'
+        mock_request.stubs(:url).returns(@absolute_url)
+        mock_request.stubs(:request_uri).returns(@requested_asset)
+
+        @mangler = make_mangler_with(@requested_asset, mock_request)
+      end
+
+      should "should return an absolute URL to the original page" do
+        assert_equal @absolute_url, @mangler.to_absolute_url
+      end
+    end
+
+    context "when the content passed in has an anchor to another location in the current page" do
+      setup do
+        @base_url = "http://example.com"
+        @current_page = "/current_page"
+        @absolute_url = "#{@base_url}#{@current_page}"
+
+        mock_request = 'Mocked Request'
+        mock_request.stubs(:request_uri).returns(@current_page)
+        mock_request.stubs(:url).returns(@absolute_url)
+
+        @requested_asset = "#HeadingOnPage"
+        @mangler = make_mangler_with(@requested_asset, mock_request)
+      end
+
+      should "should return an absolute URL to the original page" do
+        assert_equal "#{@absolute_url}#{@requested_asset}", @mangler.to_absolute_url
+      end
+    end
+  end
 end

data/test/unit/helpers/chili_pdf_helper_test.rb

@@ -3,6 +3,14 @@ require File.dirname(__FILE__) + '/../../test_helper'
 class ChiliPdfHelperTest < HelperTestCase
   include ChiliPdfHelper
 
+  def root_url
+    "http://example.com/"
+  end
+
+  def request
+    @request ||= ActionController::TestRequest.new
+  end
+
   context "#chili_pdf_stylesheets" do
     should "include the pdf.css stylesheet" do
       assert_match %r(<link.*href=['"].*pdf\.css['"].*>), chili_pdf_stylesheets(false)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chili_pdf
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Tom Kersten
@@ -36,7 +36,7 @@ cert_chain:
   NVADJA==
   -----END CERTIFICATE-----
 
-date: 2011-06-19 00:00:00 -05:00
+date: 2011-06-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency