chili_pdf 0.4.0 → 0.4.1

data/History.txt

@@ -1,3 +1,14 @@
+=== 0.4.1 / 2011-06-19
+
+* New features:
+  * 'Logo' support. Admins can add the URL of an image on the plugin
+    configuration page. The logo will show up on the top-right corner
+    of the first page of all exported PDFs. [closes #15]
+  * Converted settings page to fully-support localization. [closes #14]
+
+* Minor enhancements:
+  * Style updates for <pre> & <img> tags (thanks, @roykolak!)
+
 === 0.4.0 / 2011-06-18
 
 * New features:

data/Manifest.txt

@@ -13,6 +13,7 @@ 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
+app/views/settings/_chili_pdf_watermark_settings.html.erb
 assets/javascripts/chili_pdf.js
 assets/stylesheets/chili_pdf_settings_tweaks.css
 assets/stylesheets/pdf.css

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:
 
@@ -30,10 +30,13 @@ ChiliProject (/Redmine) plugin which implements/enhances PDF-export functionalit
    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.
+1. Custom logo support. You can specify the URL of an image to place in the
+   top-right corner of the first page of all exported PDFs.
 
 ## SCREENSHOTS:
 
-You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/sets/72157626992576450).
+You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/tags/chilipdf/).
+(Release-specific screenshots are in [sets named 'chili_pdf,...'](http://www.flickr.com/photos/tomkersten/sets/)).
 
 ## PROBLEMS:
 
@@ -51,7 +54,7 @@ You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/se
 1. Cycle your application servers (Mongrel, unicorn, Passenger, etc)
 1. Visit any wiki page and manually add a '.pdf' extension to the URL
    1. **NOTE:** You must be on an individual wiki page. Manually adding
-      the '.pdf' on the 'default wiki page' URL (/projects/:project_id/wiki)
+      the '.pdf' on the 'default wiki page' URL (http://yoursite.com/projects/:project_id/wiki)
       will not work correctly at this time. The manual step will be removed
       in a future release.
 
@@ -110,7 +113,7 @@ config.gem 'chili_pdf'
 
 Cycle your application server (mongrel, unicorn, whatevs)...
 
-Then, uninstall the chili_pdf gem:
+Then, uninstall the gem:
 
 ```
 gem uninstall chili_pdf

data/app/helpers/chili_pdf_helper.rb

@@ -94,6 +94,24 @@ module ChiliPdfHelper
   end
 
 
+  # Public: Generates an image tag with the appropriate mark-up for the ChiliPDF
+  #         'logo'.
+  #
+  # 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 an '<img>' tag for your view template with a properly formatted 'src'
+  #         attribute, depending on whether the user is requesting an HTML or PDF
+  #         format. If no logo is defined in the plugin configuration, nothing is
+  #         rendered in the view tempalate.
+  def logo_img_tag(wants_html)
+    if ChiliPDF::Config.logo_url?
+      img_tag = image_tag(ChiliPDF::Config.logo_url, :id => "chili-pdf-logo")
+      update_img_src_tags_of(img_tag, wants_html)
+    end
+  end
+
   private
     # Updates the value of the specified attribute of any `tag_type` tags
     # contained in `content` to be compatible with the `wkhtmltopdf`

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

@@ -5,5 +5,7 @@
   <%= normalize_custom_js_src_tags_in(ChiliPDF::Config.custom_js, @requesting_html_version) %>
 <% end %>
 
+<%= 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) %>

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

@@ -4,6 +4,7 @@
 
 <%= 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},
+    {:name => 'watermark_settings', :partial => 'settings/chili_pdf_watermark_settings', :label => :watermark_plugin_settings},
+    {:name => 'advanced_settings', :partial => 'settings/chili_pdf_advanced_settings', :label => :advanced_plugin_settings}
 ]) %>
 

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

@@ -1,35 +1,32 @@
 <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).
+  <span class="tip-label"><%= l(:tip_label) %>:</span>
+  <%= l(:tip_view_as_html) %>
 </p>
 
 <p>
-  <label for='settings_<%= ChiliPDF::Config::HEADER_ENABLED_KEYNAME %>'><%= l(:header_enabled_label) %></label>
+  <label for='settings_<%= ChiliPDF::Config::HEADER_ENABLED_KEYNAME %>'><%= l(:label_header_enabled) %></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>
+  <label for='settings_<%= ChiliPDF::Config::FOOTER_ENABLED_KEYNAME %>'><%= l(:label_footer_enabled) %></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>
+<h3><%= l(:section_heading_custom_header_footer_content) %></h3>
 
-<table>
+<table id="header-footer-settings">
   <thead>
     <tr>
       <td></td>
-      <td>Left</td>
-      <td>Center</td>
-      <td>Right</td>
+      <td><%= l(:table_header_footer_labels_left) %></td>
+      <td><%= l(:table_header_footer_labels_center) %></td>
+      <td><%= l(:table_header_footer_labels_right) %></td>
     </tr>
   </thead>
   <tbody>
     <tr>
-      <td>Header</td>
+      <td><%= l(:table_header_footer_labels_header) %></td>
       <td>
         <%= text_field_tag "settings[#{ChiliPDF::Config::HEADER_LEFT_KEYNAME}]", ChiliPDF::Config.header_values[:left] %>
       </td>
@@ -41,7 +38,7 @@
       </td>
     </tr>
     <tr>
-      <td>Footer</td>
+      <td><%= l(:table_header_footer_labels_footer) %></td>
       <td>
         <%= text_field_tag "settings[#{ChiliPDF::Config::FOOTER_LEFT_KEYNAME}]", ChiliPDF::Config.footer_values[:left] %>
       </td>
@@ -56,12 +53,12 @@
 </table>
 
 <div id="pdf-token-help">
-  <h4>Dynamic text legend</h4>
+  <h4><%= l(:section_heading_dynamic_text_legend) %></h4>
   <table>
     <thead>
       <tr>
-        <td>Enter this</td>
-        <td>...to show this</td>
+        <td><%= l(:table_dyanmic_header_enter_this) %></td>
+        <td>...<%= l(:table_dyanmic_header_to_show_this) %></td>
       </tr>
     </thead>
     <tbody>

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

@@ -0,0 +1,13 @@
+<p class="chili-pdf-instructions">
+Enter the URL of an image you would like to appear on the first
+page of all exported PDFs. You can enter a URL of a file you
+have uploaded to this site, or any public URL.
+<p>
+  <label for='settings_<%= ChiliPDF::Config::LOGO_KEYNAME%>'><%= l(:label_logo_url) %></label>
+  <%= text_field_tag "settings[#{ChiliPDF::Config::LOGO_KEYNAME}]", ChiliPDF::Config.logo_url, :class => 'url' %>
+</p>
+
+<%- if ChiliPDF::Config.logo_url? %>
+  <h4>Current logo</h4>
+  <%= image_tag ChiliPDF::Config.logo_url %>
+<%- end %>

data/assets/stylesheets/chili_pdf_settings_tweaks.css

@@ -3,6 +3,11 @@ textarea {width: 600px; height: 200px;}
 
 p.chili-pdf-instructions {padding-left: 0;}
 .tip-label {font-weight: bold; text-decoration: underline;}
+.url {width: 600px;}
+
+#header-footer-settings input {
+  width: 300px;
+}
 
 #pdf-token-help {margin-top: 20px;}
 #pdf-token-help table {width: 100%; border: 1px #AAA solid;}

data/assets/stylesheets/pdf.css

@@ -34,3 +34,23 @@ ol li {list-style-type: decimal;}
 ul li {list-style-type: disc;}
 h1, h2 {font-weight: bold;}
 img {max-width: 100%;}
+img {border:1px solid #888;}
+#chili-pdf-logo {max-height:50px; float:right; border:none;}
+
+pre {
+  // found at http://www.longren.org/wrapping-text-inside-pre-tags/
+  overflow: auto;
+  font-family: ?Consolas?,monospace;
+  font-size: 9pt;
+  text-align:left;
+  background-color: #FCF7EC;
+  overflow-x: auto; /* Use horizontal scroller if needed; for Firefox 2, not
+  white-space: pre-wrap; /* css-3 */
+  white-space: -moz-pre-wrap !important; /* Mozilla, since 1999 */
+  word-wrap: break-word; /* Internet Explorer 5.5+ */
+  margin: 0px 0px 0px 0px;
+  padding:5px 5px 3px 5px;
+  white-space : normal; /* crucial for IE 6, maybe 7? */
+  padding:10px; background:#DDD;
+  margin:5px 0;
+}

data/config/locales/en.yml

@@ -1,9 +1,22 @@
 # English strings go here for Rails i18n
 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
+  typical_plugin_settings: Typical
+  advanced_plugin_settings: Technical
+  watermark_plugin_settings: Logo
+  label_header_enabled: Display page header?
+  label_footer_enabled: Display page footer?
   label_custom_css: Custom CSS
   label_custom_js: Custom JavaScript
+  label_logo_url: Logo URL
+  section_heading_dynamic_text_legend: Dynamic text legend
+  section_heading_custom_header_footer_content: Custom Header/Footer Content
+  table_header_footer_labels_left: Left
+  table_header_footer_labels_center: Center
+  table_header_footer_labels_right: Right
+  table_header_footer_labels_header: Header
+  table_header_footer_labels_footer: Footer
+  table_dyanmic_header_enter_this: Enter this
+  table_dyanmic_header_to_show_this: to show this
+  tip_label: Pro Tip
+  tip_view_as_html: 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).

data/lib/chili_pdf.rb

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

data/lib/chili_pdf/config.rb

@@ -16,6 +16,7 @@ module ChiliPDF
     FOOTER_LEFT_KEYNAME   = :footer_content_left
     FOOTER_CENTER_KEYNAME = :footer_content_center
     FOOTER_RIGHT_KEYNAME  = :footer_content_right
+    LOGO_KEYNAME          = :watermarks_logo
 
     HEADER_LEFT_DEFAULT_VALUE   = '{{page_title}}'
     HEADER_CENTER_DEFAULT_VALUE = ''
@@ -54,7 +55,8 @@ END_OF_JS_DEF
         FOOTER_CENTER_KEYNAME  => FOOTER_CENTER_DEFAULT_VALUE,
         FOOTER_RIGHT_KEYNAME   => FOOTER_RIGHT_DEFAULT_VALUE,
         CUSTOM_CSS_KEYNAME     => CUSTOM_CSS_DEFAULT_VALUE,
-        CUSTOM_JS_KEYNAME      => CUSTOM_JS_DEFAULT_VALUE
+        CUSTOM_JS_KEYNAME      => CUSTOM_JS_DEFAULT_VALUE,
+        LOGO_KEYNAME           => ''
       }
     end
 
@@ -111,6 +113,14 @@ END_OF_JS_DEF
       end
     end
 
+    def logo_url
+      plugin_settings[LOGO_KEYNAME]
+    end
+
+    def logo_url?
+      !logo_url.blank?
+    end
+
     private
       def default_header_values
         {:left => HEADER_LEFT_DEFAULT_VALUE,

data/test/unit/helpers/chili_pdf_helper_test.rb

@@ -98,4 +98,26 @@ class ChiliPdfHelperTest < HelperTestCase
       end
     end
   end
+
+  context "#logo_img_tag" do
+    context "when no logo URL is defined for the plugin" do
+      setup do
+        ChiliPDF::Config.stubs(:logo_url).returns("")
+      end
+
+      should "return nil" do
+        assert_nil logo_img_tag(true)
+      end
+    end
+
+    context "when a logo URL is defined" do
+      setup do
+        ChiliPDF::Config.stubs(:logo_url).returns("/images/cancel.png")
+      end
+
+      should "return an '<img>' tag with an 'id' of 'chili-pdf-logo'" do
+        assert_match /id="chili-pdf-logo"/, logo_img_tag(true)
+      end
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chili_pdf
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Tom Kersten
@@ -36,7 +36,7 @@ cert_chain:
   NVADJA==
   -----END CERTIFICATE-----
 
-date: 2011-06-18 00:00:00 -05:00
+date: 2011-06-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,6 +113,7 @@ files:
 - 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
+- app/views/settings/_chili_pdf_watermark_settings.html.erb
 - assets/javascripts/chili_pdf.js
 - assets/stylesheets/chili_pdf_settings_tweaks.css
 - assets/stylesheets/pdf.css
@@ -140,7 +141,7 @@ files:
 - 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: