chili_pdf 0.2.0 → 0.3.0

data/.autotest

@@ -0,0 +1,14 @@
+Autotest.add_hook(:initialize) {|at|
+  %w{.git .svn .hg .swp .DS_Store ._* tmp}.each do |exception|
+    at.add_exception(exception)
+  end
+
+  at.add_mapping(%r%^test/chili_pdf/.*_test.rb$%) { |filename, _|
+    filename
+  }
+  at.add_mapping(/test_helper.rb/) {
+    at.files_matching /^test.*rb$/
+  }
+  #nil
+}
+

data/Gemfile

@@ -3,8 +3,14 @@ source 'http://rubygems.org'
 gem 'wicked_pdf'
 
 group :development do
-  gem 'autotest-rails', '~> 4.1.0'
+  gem 'autotest-rails', '~> 4.1'
   gem 'fakeweb'
-  gem 'hoe', '~> 2.8.0'
+  gem 'hoe', '~> 2.8'
+  gem 'hoe-git'
   gem 'ZenTest'
+  gem 'redmine_plugin_support'
+  gem 'cucumber', '0.10'
+  gem 'rspec', '1.3.1'
+  gem 'rspec-rails', '1.3.2'
+  gem 'i18n', '0.4.2'
 end

data/Gemfile.lock

@@ -4,10 +4,31 @@ GEM
     ZenTest (4.5.0)
     autotest-rails (4.1.0)
       ZenTest
+    builder (3.0.0)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
     fakeweb (1.3.0)
+    gherkin (2.3.3)
+      json (~> 1.4.6)
     hoe (2.8.0)
       rake (>= 0.8.7)
+    hoe-git (1.4.0)
+      hoe (>= 2.2.0)
+    i18n (0.4.2)
+    json (1.4.6)
+    rack (1.0.1)
     rake (0.8.7)
+    redmine_plugin_support (0.0.4)
+    rspec (1.3.1)
+    rspec-rails (1.3.2)
+      rack (>= 1.0.0)
+      rspec (>= 1.3.0)
+    term-ansicolor (1.0.5)
     wicked_pdf (0.7.0)
 
 PLATFORMS
@@ -15,7 +36,13 @@ PLATFORMS
 
 DEPENDENCIES
   ZenTest
-  autotest-rails (~> 4.1.0)
+  autotest-rails (~> 4.1)
+  cucumber (= 0.10)
   fakeweb
-  hoe (~> 2.8.0)
+  hoe (~> 2.8)
+  hoe-git
+  i18n (= 0.4.2)
+  redmine_plugin_support
+  rspec (= 1.3.1)
+  rspec-rails (= 1.3.2)
   wicked_pdf

data/History.txt

@@ -1,3 +1,21 @@
+=== 0.3.0 / 2011-06-13
+
+* New features
+  * Added header/footer support [closes #2]
+  * Implemented 'footer_enabled' and 'header_enabled' settings to
+    control whether footers/headers are included [closes #3]
+  * Added 'dynamic' content which can be used to customize the
+    header/footer sections of exported PDFs (see TokenManager and
+    TokenString for details) [closes #4]
+
+* Minor enhancements:
+
+  * Added testing harness
+  * Updated layout to include any :header_tag content_for blocks
+  * PDF content was previously not being wrapped in PDF layout...fixed
+  * Threw in a fix for ul->li's showing numbers [closes #6]
+  * Added Formatter class which will be used for managing PDF formatting
+
 === 0.2.0 / 2011-05-23
 
 * Fixed layout & stylesheet inclusions

data/Manifest.txt

@@ -1,3 +1,4 @@
+.autotest
 Gemfile
 Gemfile.lock
 History.txt
@@ -9,12 +10,25 @@ 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_settings.html.erb
 assets/stylesheets/pdf.css
 autotest/discover.rb
+config/locales/en.yml
 config/routes.rb
 init.rb
+lang/en.yml
 lib/chili_pdf.rb
+lib/chili_pdf/config.rb
+lib/chili_pdf/formatter.rb
+lib/chili_pdf/string_token.rb
+lib/chili_pdf/token_manager.rb
 lib/tasks/chili_pdf_tasks.rb
+lib/tasks/contributor_tasks.rb
+lib/tasks/test_lib_dir.rake
 lib/user_patch.rb
 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/token_manager_test.rb
 test/test_helper.rb

data/README.md

@@ -30,7 +30,7 @@ ChiliProject (/Redmine) plugin which implements/enhances PDF-export functionalit
 
 ## SCREENSHOTS:
 
-You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/sets/72157626768112790/).
+You can find a few screenshots [here](http://www.flickr.com/photos/tomkersten/sets/72157626827940413/).
 
 ## PROBLEMS:
 

data/Rakefile

@@ -11,7 +11,7 @@ RedminePluginSupport::Base.setup do |plugin|
   plugin.redmine_root = File.expand_path(File.dirname(__FILE__) + '/../../../')
 end
 
-Dir["/lib/tasks/**/*.rake"].sort.each { |ext| load ext }
+Dir["lib/tasks/**/*.rake"].sort.each { |ext| load ext }
 
 task :default => [:test]
 

data/app/controllers/extended_wiki_controller.rb

@@ -7,22 +7,21 @@ class ExtendedWikiController < WikiController
     super
     unless performed? # Prevent double render
       respond_to do |format|
-        format.html {render :template => 'wiki/show'}
-        format.pdf {
-          filename = "#{@project.name.underscore}_#{@page.title}".gsub(/\s/,'')
-          render :pdf => filename,
-                 :template => 'extended_wiki/show.pdf.html.erb',
-                 :page_size => "Letter",
-                 :show_as_html => params[:debug],
-                 :margin => {
-                   :top    => "0.5in",
-                   :bottom => "0.5in",
-                   :left   => "0.5in",
-                   :right  => "0.5in"
-                 },
-                 :layout => 'pdf.pdf.erb'
-        }
+        format.pdf {render formatter.render_options}
       end
     end
   end
+
+  private
+    def formatter
+      ChiliPDF::Formatter.new(filename, page_title)
+    end
+
+    def filename
+      "#{@project.name.underscore}_#{@page.title}".gsub(/\s/,'')
+    end
+
+    def page_title
+      "#{@project.name}, #{@page.title}"
+    end
 end

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

@@ -13,8 +13,6 @@
     <link rel="stylesheet" href="<%= root_url %>stylesheets/pdf.css">
   <%- end %>
 
-  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <%= yield(:header_tags) %>
 </head>
 

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

@@ -0,0 +1,82 @@
+<% content_for :header_tags do %>
+  <%= stylesheet_link_tag '/plugin_assets/chili_pdf/stylesheets/pdf' %>
+<% 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>
+
+<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/assets/stylesheets/pdf.css

@@ -29,5 +29,16 @@ a.wiki-anchor { display:none; }
 
 h1, h2, h3, h4 { margin: 0.5em 0; }
 ul,ol {margin: 0 0 0 3em; padding: 0.1em;}
-li { list-style-type: decimal; padding: 0.1em; }
+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;}

data/autotest/discover.rb

@@ -1,4 +1,2 @@
-Autotest.add_discovery do
-  "rails"
-end
+Autotest.add_discovery {"rails"}
 

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# 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?

data/init.rb

@@ -10,6 +10,9 @@ Redmine::Plugin.register :chili_pdf do
   version ChiliPDF::VERSION
   url 'https://github.com/tomkersten/chili_pdf'
   author_url 'http://tomkersten.com/'
+
+  settings :partial => 'settings/chili_pdf_settings',
+           :default => ChiliPDF::Config.defaults
 end
 
 Dispatcher.to_prepare :chili_pdf do

data/lang/en.yml

@@ -0,0 +1,3 @@
+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?

data/lib/chili_pdf.rb

@@ -1,3 +1,8 @@
+require 'chili_pdf/config'
+require 'chili_pdf/token_manager'
+require 'chili_pdf/formatter'
+require 'chili_pdf/string_token'
+
 module ChiliPDF
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/chili_pdf/config.rb

@@ -0,0 +1,112 @@
+module ChiliPDF
+  module Config
+    extend self
+
+    PLUGIN_KEYNAME = 'plugin_chili_pdf'
+    ENABLED_VALUE = '1'
+    DISABLED_VALUE = '0'
+    FOOTER_ENABLED_KEYNAME = 'footer_enabled'
+    HEADER_ENABLED_KEYNAME = 'header_enabled'
+
+    HEADER_LEFT_KEYNAME   = :header_content_left
+    HEADER_CENTER_KEYNAME = :header_content_center
+    HEADER_RIGHT_KEYNAME  = :header_content_right
+    FOOTER_LEFT_KEYNAME   = :footer_content_left
+    FOOTER_CENTER_KEYNAME = :footer_content_center
+    FOOTER_RIGHT_KEYNAME  = :footer_content_right
+
+    HEADER_LEFT_DEFAULT_VALUE   = '{{page_title}}'
+    HEADER_CENTER_DEFAULT_VALUE = ''
+    HEADER_RIGHT_DEFAULT_VALUE  = ''
+    FOOTER_LEFT_DEFAULT_VALUE   = '{{datestamp}}'
+    FOOTER_CENTER_DEFAULT_VALUE = ''
+    FOOTER_RIGHT_DEFAULT_VALUE  = '{{current_page}}/{{total_pages}}'
+
+    def defaults
+      {
+        FOOTER_ENABLED_KEYNAME => ENABLED_VALUE,
+        HEADER_ENABLED_KEYNAME => ENABLED_VALUE,
+        HEADER_LEFT_KEYNAME    => HEADER_LEFT_DEFAULT_VALUE,
+        HEADER_CENTER_KEYNAME  => HEADER_CENTER_DEFAULT_VALUE,
+        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
+      }
+    end
+
+    # Public: Returns whether the footer will be printed when exporting
+    #         a PDF.
+    #
+    # Returns either true or false.
+    def footer_enabled?
+      footer_enabled == ENABLED_VALUE
+    end
+
+    # Public: Returns whether the header will be printed when exporting
+    #         a PDF.
+    #
+    # Returns either true or false.
+    def header_enabled?
+      header_enabled == ENABLED_VALUE
+    end
+
+    # Public: Accepts anything which responds to '[]' and '.has_key?'
+    #         (ie: Hash-like objects)
+    #
+    # Utilizes following keys (values of):
+    #   - HEADER_ENABLED_KEYNAME
+    #   - FOOTER_ENABLED_KEYNAME
+    #
+    # Returns true. Always.
+    def update(options)
+      Setting[PLUGIN_KEYNAME] = defaults.merge(options)
+      true
+    end
+
+    def header_values
+      default_header_values.merge(stored_header_settings)
+    end
+
+    def footer_values
+      default_footer_values.merge(stored_footer_settings)
+    end
+
+    private
+      def default_header_values
+        {:left => HEADER_LEFT_DEFAULT_VALUE,
+         :center => HEADER_CENTER_DEFAULT_VALUE,
+         :right => HEADER_RIGHT_DEFAULT_VALUE}
+      end
+
+      def stored_header_settings
+        {:left => plugin_settings[HEADER_LEFT_KEYNAME],
+         :center => plugin_settings[HEADER_CENTER_KEYNAME],
+         :right => plugin_settings[HEADER_RIGHT_KEYNAME]}.reject {|k,v| v.nil?}
+      end
+
+      def default_footer_values
+        {:left  => FOOTER_LEFT_DEFAULT_VALUE,
+         :center => FOOTER_CENTER_DEFAULT_VALUE,
+         :right  => FOOTER_RIGHT_DEFAULT_VALUE}
+      end
+
+      def stored_footer_settings
+        {:left => plugin_settings[FOOTER_LEFT_KEYNAME],
+         :center => plugin_settings[FOOTER_CENTER_KEYNAME],
+         :right => plugin_settings[FOOTER_RIGHT_KEYNAME]}.reject {|k,v| v.nil?}
+      end
+
+      def footer_enabled
+        plugin_settings[FOOTER_ENABLED_KEYNAME]
+      end
+
+      def header_enabled
+        plugin_settings[HEADER_ENABLED_KEYNAME]
+      end
+
+      def plugin_settings
+        Setting[PLUGIN_KEYNAME]
+      end
+  end
+end

data/lib/chili_pdf/formatter.rb

@@ -0,0 +1,80 @@
+module ChiliPDF
+  class Formatter
+    HEADER_FOOTER_FONT_SIZE = 8
+    DEFAULT_MARGIN = '0.5in'
+    DEFAULT_PAGE_SIZE = "Letter"
+    DEFAULT_PAGE_TITLE = "Untitled"
+    DEFAULT_LAYOUT = 'pdf.pdf.erb'
+    DEFAULT_VIEW_TEMPLATE  = 'extended_wiki/show.pdf.html.erb'
+
+    attr_reader :page_title
+
+    # TODO: Hack...need to come up with better approach for this...
+    TokenManager.add_token_definition do
+      {:page_title => {:replacement_object => (DEFAULT_PAGE_TITLE),
+                       :description        => "The project & wiki page name (eg: 'My Project, Wiki Page Title')"}}
+    end
+
+    def initialize(filename, title = nil)
+      @page_title = title
+      @filename = filename
+
+      # TODO: Hack...need to come up with better approach for this...
+      TokenManager.add_token_definition do
+        {:page_title => {:replacement_object => (@page_title || DEFAULT_PAGE_TITLE),
+                         :description        => "The project & wiki page name (eg: 'My Project, Wiki Page Title')"}}
+      end
+    end
+
+    def render_options
+      default_options = {
+        :pdf => @filename,
+        :template => view_template,
+        :page_size => DEFAULT_PAGE_SIZE,
+        :margin => {
+          :top    => DEFAULT_MARGIN,
+          :bottom => DEFAULT_MARGIN,
+          :left   => DEFAULT_MARGIN,
+          :right  => DEFAULT_MARGIN
+        },
+        :layout => DEFAULT_LAYOUT
+      }
+
+      default_options.merge!(footer_options) if ChiliPDF::Config.footer_enabled?
+      default_options.merge!(header_options) if ChiliPDF::Config.header_enabled?
+      default_options
+    end
+
+    private
+      def footer_options
+        {:footer => {
+          :font_size => 8,
+          :line => true,
+          :spacing => 2
+        }.merge(substitute_tokens(ChiliPDF::Config.footer_values))}
+      end
+
+      def header_options
+        {:header => {
+          :font_size => HEADER_FOOTER_FONT_SIZE,
+          :line => true,
+          :spacing => 2
+        }.merge(substitute_tokens(ChiliPDF::Config.header_values))}
+      end
+
+      def substitute_tokens(hash)
+        hash.inject({}) do |converted_list, unconverted_item|
+          header_location,header_location_value = unconverted_item
+          converted_list.merge({header_location => replace_tokens_in(header_location_value)})
+        end
+      end
+
+      def replace_tokens_in(string)
+        TokenManager.apply_tokens_to string
+      end
+
+      def view_template
+        DEFAULT_VIEW_TEMPLATE
+      end
+  end
+end

data/lib/chili_pdf/string_token.rb

@@ -0,0 +1,73 @@
+module ChiliPDF
+  # Associates documentation of a "string to replace" (matcher) with it's
+  # "replacement text" (replacement_object) and allows either either static
+  # or dynamic string replacement declarations.
+  class StringToken
+    # Description used if the default description is empty
+    DEFAULT_DESCRIPTION = "[No description provided]"
+
+    # String used to denote the begining of a token
+    STARTING_DELIMITER = "{{"
+
+    # String used to denote the ending of a token
+    ENDING_DELIMITER   = "}}"
+
+    # Public: Get the matcher of the token
+    # Returns the String matcher of token
+    attr_reader :matcher
+
+    # Returns the String replacement_object of token
+    attr_reader :replacement_object
+
+    # Returns the String description of the token
+    attr_reader :description
+
+
+    # Public: Create new instance of StringToken class
+    #
+    # matcher            - the #to_s value to search for
+    # replacement_object - the value to replace 'matcher' with
+    # description        - a friendly description which can be used
+    #                       to explain what purpose the matcher is
+    #                       intended to serve
+    #
+    # 'replacement_object' may be any object, but special behavior
+    # exists if the value is a Proc object. Refer to the #apply_to
+    # documentation for details on said behavior.
+    #
+    # Returns new instance of StringToken
+    def initialize(matcher, replacement_object, description = nil)
+      @matcher = matcher
+      @replacement_object = replacement_object
+      @description = description.blank? ? DEFAULT_DESCRIPTION : description
+    end
+
+    # Public: Substitutes any occurrences of #replacement_object in the specified
+    #         object's response to #to_s. If #replacement_object returns a Proc
+    #         object, #call will be issued to it.
+    #
+    # string - string to search for token occurrences in
+    #
+    # Examples:
+    # Returns copy of string with matcher text occurrences replaced.
+    def apply_to(string)
+      string.gsub(replacement_regexp(string), replacement_value.to_s)
+    end
+
+    def matcher_with_delimiters
+      "#{STARTING_DELIMITER}#{matcher}#{ENDING_DELIMITER}"
+    end
+    private
+      def replacement_regexp(string)
+        Regexp.new(/#{escaped(STARTING_DELIMITER)}#{matcher.to_s}#{escaped(ENDING_DELIMITER)}/)
+      end
+
+      def replacement_value
+        replacement_object.is_a?(Proc) ? replacement_object.call(self) : replacement_object
+      end
+
+      def escaped(string)
+        Regexp.escape string
+      end
+  end
+end

data/lib/chili_pdf/token_manager.rb

@@ -0,0 +1,45 @@
+module ChiliPDF
+  module TokenManager
+    extend self
+
+    MAPPINGS = {:current_page => {
+                   :replacement_object  => "[page]",
+                   :description         => "The current page of the PDF document."},
+                :total_pages => {
+                   :replacement_object  => '[topage]',
+                   :description         => "The total number of pages in the PDF document."},
+                :datestamp => {
+                   :replacement_object  => lambda {Time.now.strftime('%d-%b-%Y')},
+                   :description         => "The current date in the format of DD-MON-YYYY'"},
+                :current_quarter => {
+                   :replacement_object => lambda {calculate_quarter.to_s},
+                   :description        => "The current fiscal quarter (assuming Jan-Mar is thefirst quarter). Example output: '1'."},
+                :current_year => {
+                   :replacement_object => lambda {Time.now.strftime('%Y')},
+                   :description        => "The current year in YYYY-format"}}
+
+    def tokens
+      raw_tokens.map {|matcher, meta|
+        StringToken.new(matcher, meta[:replacement_object], meta[:description])
+      }
+    end
+
+    def add_token_definition
+      raw_tokens.merge!(yield)
+    end
+
+    def apply_tokens_to(string)
+      tokens.inject(string.dup) {|modified, token| modified = token.apply_to modified}
+    end
+
+    private
+      def raw_tokens
+        @raw_tokens ||= MAPPINGS.dup
+      end
+
+      def self.calculate_quarter
+        month = Time.now.strftime('%m').to_i
+        ((month - 1) / 3) + 1
+      end
+  end
+end

data/lib/tasks/chili_pdf_tasks.rb

@@ -22,7 +22,6 @@ class ChiliPDFTasks < Rake::TaskLib
       task :symlink_assets => [:environment] do
         # HACK: Symlinks the files from plugindir/assets to the appropriate place in
         # the rails application
-        remove_symlink(asset_destination_dir)
         puts "Symlinking assets (stylesheets, etc)..."
         add_symlink asset_source_dir, asset_destination_dir
       end

data/lib/tasks/contributor_tasks.rb

@@ -0,0 +1,73 @@
+require 'rake'
+require 'rake/tasklib'
+
+class ContributorTasks < Rake::TaskLib
+  def initialize
+    define
+  end
+
+  def define
+    desc "Update contributors list in README"
+    task :update_contributors do
+      if new_contributors?
+        puts "New contributors!"
+        new_contributors.each {|name| puts "- #{name}"}
+        puts ""
+
+        print "Updating the 'Contributors' section of README..."
+
+        File.open("README.md", "w+") do |file|
+          file.puts readme_without_contributors_section
+          file.puts "## Contributors (sorted alphabetically)"
+          file.puts ""
+          committers.each {|name| file.puts "* #{name}"}
+        end
+        puts "done!"
+      else
+        puts "No new contributors."
+      end
+    end
+
+    task :release do
+      puts "#####################"
+      puts "For the twitters"
+      puts "#####################"
+      puts "[ANN] chili_pdf v#{ChiliPDF::VERSION} released. Changes: http://bit.ly/lEfOaJ, Repo: http://bit.ly/lu5bjP /cc @chiliproject"
+      puts "#####################"
+
+    end
+  end
+
+  private
+    def all_committers
+      all_names = `git shortlog -s |cut -s -f2`
+      all_names.gsub!(/\sand\s/, "\n").split("\n").uniq!.sort!
+    end
+
+    def committers
+      excluded_committers = ["Tom Kersten"]
+      @committers ||= all_committers - excluded_committers
+    end
+
+    def readme_file_contents
+      @readme_contents ||= `cat README.md`
+    end
+
+    def existing_contributors
+      existing_contributors = readme_file_contents[/## Contributors(.|\n)*/].strip.split("\n* ")
+      existing_contributors.shift # remove "Contributors..." line
+      existing_contributors
+    end
+
+    def new_contributors
+      @new_contributors ||= committers - existing_contributors
+    end
+
+    def new_contributors?
+      !new_contributors.empty?
+    end
+
+    def readme_without_contributors_section
+      readme_file_contents.sub(/## Contributors(.|\n)*/, '')
+    end
+end

data/lib/tasks/test_lib_dir.rake

@@ -0,0 +1,12 @@
+namespace :test do
+  desc "Test lib source"
+  Rake::TestTask.new(:lib) do |t|
+    t.libs << "test"
+    t.pattern = 'test/chili_pdf/**/*_test.rb'
+    t.verbose = true
+  end
+end
+
+lib_task = Rake::Task["test:lib"]
+test_task = Rake::Task[:test]
+test_task.enhance { lib_task.invoke }

data/test/chili_pdf/config_test.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ConfigTest < ActiveSupport::TestCase
+  setup do
+    Setting["plugin_chili_pdf"] = HashWithIndifferentAccess.new(ChiliPDF::Config.defaults)
+  end
+
+  context '#header_values' do
+    context 'when no customizations have taken place' do
+      should "return the 'defaults' values for the header fields" do
+        defaults = {
+                     :left   => ChiliPDF::Config.defaults[ChiliPDF::Config::HEADER_LEFT_KEYNAME],
+                     :center => ChiliPDF::Config.defaults[ChiliPDF::Config::HEADER_CENTER_KEYNAME],
+                     :right  => ChiliPDF::Config.defaults[ChiliPDF::Config::HEADER_RIGHT_KEYNAME]
+                   }
+        assert_equal defaults, ChiliPDF::Config.header_values
+      end
+    end
+
+    context 'when the content has been customized' do
+      setup do
+        @left   = 'left_header'
+        @center = 'center header'
+        @right  = 'right header'
+
+        Setting["plugin_chili_pdf"] = {ChiliPDF::Config::HEADER_LEFT_KEYNAME => @left,
+                                       ChiliPDF::Config::HEADER_CENTER_KEYNAME => @center,
+                                       ChiliPDF::Config::HEADER_RIGHT_KEYNAME => @right}
+      end
+
+      should "return the customized values for the header fields" do
+        assert_equal @left, ChiliPDF::Config.header_values[:left]
+        assert_equal @center, ChiliPDF::Config.header_values[:center]
+        assert_equal @right, ChiliPDF::Config.header_values[:right]
+      end
+    end
+  end
+
+  context '#footer_values' do
+    context 'when no customizations have taken place' do
+      should "return the 'defaults' values for the footer fields" do
+        defaults = {
+                     :left   => ChiliPDF::Config.defaults[ChiliPDF::Config::FOOTER_LEFT_KEYNAME],
+                     :center => ChiliPDF::Config.defaults[ChiliPDF::Config::FOOTER_CENTER_KEYNAME],
+                     :right  => ChiliPDF::Config.defaults[ChiliPDF::Config::FOOTER_RIGHT_KEYNAME]
+                   }
+        assert_equal defaults, ChiliPDF::Config.footer_values
+      end
+    end
+
+    context 'when the footer content has been customized' do
+      setup do
+        @left   = 'left footer'
+        @center = 'center footer'
+        @right  = 'right footer'
+
+        Setting["plugin_chili_pdf"] = {ChiliPDF::Config::FOOTER_LEFT_KEYNAME => @left,
+                                       ChiliPDF::Config::FOOTER_CENTER_KEYNAME => @center,
+                                       ChiliPDF::Config::FOOTER_RIGHT_KEYNAME => @right}
+      end
+
+      should "return the customized values for the footer fields" do
+        assert_equal @left, ChiliPDF::Config.footer_values[:left]
+        assert_equal @center, ChiliPDF::Config.footer_values[:center]
+        assert_equal @right, ChiliPDF::Config.footer_values[:right]
+      end
+    end
+  end
+end

data/test/chili_pdf/formatter_test.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+class FormatterTest < Test::Unit::TestCase
+  include HeaderHelpers
+
+  def setup
+    @formatter = Formatter.new('filename.pdf')
+  end
+
+  context "#render_options" do
+    should "render_options returns hash with pdf filename set" do
+      assert_equal 'filename.pdf', Formatter.new('filename.pdf').render_options[:pdf]
+    end
+
+    should "set the return the default layout of 'pdf.pdf.erb'" do
+      assert_equal ChiliPDF::Formatter::DEFAULT_LAYOUT, @formatter.render_options[:layout]
+    end
+
+    should "set 'extended_wiki/show.pdf.html.erb' as the default template" do
+      assert_equal ChiliPDF::Formatter::DEFAULT_VIEW_TEMPLATE, @formatter.render_options[:template]
+    end
+
+    should "set the default page_size to be 'Letter'" do
+      assert_equal ChiliPDF::Formatter::DEFAULT_PAGE_SIZE, @formatter.render_options[:page_size]
+    end
+
+    should "set the default margins" do
+      def_margin = ChiliPDF::Formatter::DEFAULT_MARGIN
+      default_margins = {:top => def_margin, :bottom => def_margin, :left => def_margin, :right => def_margin}
+      assert_equal default_margins, @formatter.render_options[:margin]
+    end
+
+    context 'when footers are enabled' do
+      setup do
+        enable_footers
+      end
+
+      should 'include footer options' do
+        assert ChiliPDF::Config.footer_enabled?
+        assert @formatter.render_options.has_key?(:footer)
+      end
+    end
+
+    context 'when footers are disabled' do
+      setup do
+        disable_footers
+      end
+
+      should "not include a 'footer' key" do
+        assert !@formatter.render_options.has_key?(:footer)
+      end
+    end
+
+    context 'when headers are enabled' do
+      setup do
+        enable_headers
+      end
+
+      should 'include header options' do
+        assert @formatter.render_options.has_key?(:header)
+      end
+    end
+
+    context 'when headers are disabled' do
+      setup do
+        disable_headers
+      end
+
+      should "not include a 'header' key" do
+        assert !@formatter.render_options.has_key?(:header)
+      end
+    end
+
+    context "replacing 'dynamic tokens' with expected content" do
+      should "substitues '{{current_page}}' with '[page]'" do
+        set_header_field_to "{{current_page}}"
+
+        assert ChiliPDF::Config.footer_enabled?
+        assert_equal '[page]', @formatter.render_options[:header][:left]
+      end
+
+      should "substitues '{{total_pages}}' with '[topage]'" do
+        set_header_field_to "{{total_pages}}"
+
+        assert ChiliPDF::Config.footer_enabled?
+        assert_equal '[topage]', @formatter.render_options[:header][:left]
+      end
+
+      should "substitues '{{datestamp}}' with a date formated as 'DD-MON-YYYY'" do
+        todays_date = Time.now.strftime('%d-%b-%Y')
+
+        set_header_field_to "{{datestamp}}"
+        assert_equal todays_date, header_value
+      end
+
+      context "when a page title is supplied" do
+        setup do
+          @custom_title = 'Custom title'
+          @formatter = ChiliPDF::Formatter.new('filename.pdf', @custom_title)
+        end
+
+        should "substitute '{{page_title}}' with a string value passed in as the 'page_title' argument" do
+          set_header_field_to "{{page_title}}"
+
+          assert ChiliPDF::Config.footer_enabled?
+          assert_equal @custom_title, header_value
+        end
+      end
+
+      context "when a page title is not supplied" do
+        should "substitues '{{page_title}}' with the default page title value '#{ChiliPDF::Formatter::DEFAULT_PAGE_TITLE}'" do
+          set_header_field_to "{{page_title}}"
+          assert_equal ChiliPDF::Formatter::DEFAULT_PAGE_TITLE, header_value
+        end
+      end
+
+      # The next couple are slightly hacky (or...maybe super-hacky)
+      should "substitues '{{current_year}}' with the current year (formated as 'YYYY')" do
+        todays_date = Time.now.strftime('%Y')
+
+        set_header_field_to "{{current_year}}"
+        assert_equal todays_date, header_value
+      end
+
+      should "substitues '{{current_quarter}}' with a string value of 1, 2, 3, 4...depending on month of year" do
+        month = Time.now.strftime('%m').to_i
+        expected = (((month - 1) / 3) + 1).to_s
+
+        set_header_field_to '{{current_quarter}}'
+        assert_equal expected, header_value
+      end
+    end
+  end
+end

data/test/chili_pdf/string_token_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class StringTokenTest < Test::Unit::TestCase
+  context ".apply_to" do
+    setup do
+      @sdelim = StringToken::STARTING_DELIMITER
+      @edelim = StringToken::ENDING_DELIMITER
+      @matcher = "matcher_here"
+      @replacement_object = 'text_added'
+      @token = StringToken.new(@matcher, @replacement_object)
+    end
+
+    should "returns does not modify the original string passed in" do
+      original = '{{test}}'
+      string = original.dup
+      assert_not_equal original.object_id, @token.apply_to(string).object_id
+    end
+
+    should "set a default value for a description when not provided" do
+      assert_equal StringToken::DEFAULT_DESCRIPTION, @token.description
+    end
+
+    context "when the token's matcher does not exist in the specified string" do
+      should "return the same string value" do
+        assert_equal 'string', @token.apply_to('string')
+      end
+    end
+
+    context "when the token's matcher does exist in the specified string" do
+      setup do
+        @string = "This does have the matcher twice '#{@sdelim}#{@matcher}#{@edelim}' '#{@sdelim}#{@matcher}#{@edelim}'"
+      end
+
+      should "return a string value with only the matcher text replaced" do
+        expected_string = "This does have the matcher twice '#{@replacement_object}' '#{@replacement_object}'"
+        assert_equal expected_string, @token.apply_to(@string)
+      end
+
+      context "and the replacement object is a Proc object" do
+        setup do
+          @string = "This does have the matcher twice '#{@sdelim}#{@matcher}#{@edelim}' '#{@sdelim}#{@matcher}#{@edelim}'"
+          @result = 'resulting_replaced_text'
+          faker_class = Struct.new("Faker", :name)
+          faker = faker_class.new(@result)
+
+          @replacement_object = lambda {faker.name}
+        end
+
+        should "return a string value with the result of calling the Proc and passing 'self' as an argument" do
+          token = StringToken.new(@matcher, @replacement_object)
+
+          expected_string = "This does have the matcher twice '#{@result}' '#{@result}'"
+          assert_equal expected_string, token.apply_to(@string)
+        end
+      end
+    end
+  end
+end

data/test/chili_pdf/token_manager_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class TokenManagerTest < Test::Unit::TestCase
+  context ".tokens" do
+    should "return list of objects which respond to #apply_to" do
+      assert TokenManager.tokens.first.respond_to?(:apply_to)
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,77 +1,36 @@
+require 'test/unit'
+
 require File.expand_path(File.dirname(__FILE__) + '/../../../../test/test_helper')
 
 # Ensure that we are using the temporary fixture path
 Engines::Testing.set_fixture_path
 
+require 'chili_pdf'
+include ChiliPDF
 
-require 'webrat'
-require 'fakeweb'
-require 'chili_videos'
-
-FakeWeb.allow_net_connect = false
-
-Webrat.configure do |config|
-  config.mode = :rails
-end
-
-module IntegrationTestHelper
-  def login_as(user="existing", password="existing")
-    visit "/login"
-    fill_in 'Login', :with => user
-    fill_in 'Password', :with => password
-    click_button 'login'
-    assert_response :success
-    assert User.current.logged?
-  end
-
-  def visit_project(project)
-    visit '/'
-    assert_response :success
-
-    click_link 'Projects'
-    assert_response :success
-
-    click_link project.name
-    assert_response :success
+module HeaderHelpers
+  def set_header_field_to(value)
+    ChiliPDF::Config.update({ChiliPDF::Config::HEADER_LEFT_KEYNAME => value})
   end
 
-  def assert_forbidden
-    assert_response :forbidden
-    assert_template 'common/403'
+  def header_value
+    @formatter.render_options[:header][:left]
   end
 
-  # Cleanup current_url to remove the host; sometimes it's present, sometimes it's not
-  def current_path
-    return nil if current_url.nil?
-    return current_url.gsub("http://www.example.com","")
+  def disable_footers
+    ChiliPDF::Config.update(ChiliPDF::Config::FOOTER_ENABLED_KEYNAME => ChiliPDF::Config::DISABLED_VALUE)
   end
 
-end
-
-module TransloaditServiceHelper
-  def workflow_results(identifier = :standard)
-    YAML.load(File.open("test/fixtures/#{identifier}_transloadit_response.json"))
+  def enable_footers
+    ChiliPDF::Config.update({ChiliPDF::Config::FOOTER_ENABLED_KEYNAME => ChiliPDF::Config::ENABLED_VALUE})
   end
 
-  def stub_assembly_url(assembly = nil, fixture_base_name = :single_video_processed)
-    response = "test/fixtures/#{fixture_base_name.to_s}_assembly.json"
-    url = assembly.blank? ? assembly_url : assembly.assembly_url
-    FakeWeb.register_uri(:get, url, :response => response)
+  def enable_headers
+    ChiliPDF::Config.update({ChiliPDF::Config::HEADER_ENABLED_KEYNAME => ChiliPDF::Config::ENABLED_VALUE})
   end
 
-  def assembly_url
-    'http://fake.transload.it/assembly_url'
+  def disable_headers
+    ChiliPDF::Config.update({ChiliPDF::Config::HEADER_ENABLED_KEYNAME => ChiliPDF::Config::DISABLED_VALUE})
   end
 end
 
-class ActionController::IntegrationTest
-  include IntegrationTestHelper
-end
-
-class ActiveSupport::TestCase
-  include TransloaditServiceHelper
-end
-
-class ActionController::TestCase
-  include TransloaditServiceHelper
-end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chili_pdf
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Tom Kersten
@@ -36,7 +36,7 @@ cert_chain:
   NVADJA==
   -----END CERTIFICATE-----
 
-date: 2011-05-23 00:00:00 -05:00
+date: 2011-06-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files: 
+- .autotest
 - Gemfile
 - Gemfile.lock
 - History.txt
@@ -95,14 +96,27 @@ 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_settings.html.erb
 - assets/stylesheets/pdf.css
 - autotest/discover.rb
+- config/locales/en.yml
 - config/routes.rb
 - init.rb
+- lang/en.yml
 - lib/chili_pdf.rb
+- lib/chili_pdf/config.rb
+- lib/chili_pdf/formatter.rb
+- lib/chili_pdf/string_token.rb
+- lib/chili_pdf/token_manager.rb
 - lib/tasks/chili_pdf_tasks.rb
+- lib/tasks/contributor_tasks.rb
+- lib/tasks/test_lib_dir.rake
 - lib/user_patch.rb
 - 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/token_manager_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/tomkersten/chili_pdf
@@ -135,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: chili_pdf
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: ChiliProject (/Redmine) plugin which implements/enhances PDF-export functionality using the Webkit rendering engine.