print list of issues

Author: jkraemer

app/controllers/gtt_print_jobs_controller.rb

@@ -2,17 +2,21 @@ class GttPrintJobsController < ApplicationController
   layout 'base'
 
   before_action :find_optional_project
-  before_action :find_issue, only: :create
+  before_action :find_issues, only: :create
 
-  before_action :authorize, only: :create
+  before_action :authorize_create, only: :create
   before_action :authorize_global, except: :create
 
   menu_item :issues
 
   def create
-    if @issue and (layout = params[:gtt_print_layout]).present?
-      @result = RedmineGttPrint.mapfish.print_issue @issue, layout
-      render status: (@result.success? ? :created : 422)
+    if (layout = params[:gtt_print_layout]).present?
+      if @issue
+        @result = RedmineGttPrint.mapfish.print_issue @issue, layout
+      elsif @issues
+        @result = RedmineGttPrint.mapfish.print_issues @issues, layout
+      end
+      render status: (@result&.success? ? :created : 422)
     else
       render_404
     end
@@ -41,9 +45,19 @@ def show
 
   private
 
-  def find_issue
+  def authorize_create
+    if @project
+      authorize
+    else
+      authorize_global
+    end
+  end
+
+  def find_issues
     if params[:issue_id]
       @issue = (@project ? @project.issues : Issue).visible.find params[:issue_id]
+    elsif params[:issue_ids]
+      @issues = Issue.visible.where(id: params[:issue_ids].split(','))
     end
     @project ||= @issue.project if @issue
   end

app/views/gtt_print/_settings.html.erb

@@ -19,3 +19,13 @@
                                          RedmineGttPrint.tracker_config(t)) %>
   </p>
 <% end %>
+
+<p>
+    <%= content_tag :label, l(:label_gtt_list_config) %>
+    <%= select_tag "settings[issue_list_config]",
+      content_tag(:option, l(:label_gtt_no_printing), value: '') +
+      options_from_collection_for_select(RedmineGttPrint.mapfish.print_configs,
+                                         :to_s,
+                                         :to_s,
+                                         RedmineGttPrint.list_config) %>
+</p>

app/views/hooks/_print_issue_form.html.erb

@@ -7,3 +7,17 @@
   <% end %>
 <% end %>
 
+<% if @issues and
+    ( @project && User.current.allowed_to?(:view_gtt_print, @project) or
+      User.current.allowed_to?(:view_gtt_print, nil, global: true) ) and
+    (layouts = RedmineGttPrint.list_layouts).present?
+%>
+
+  <h3><%= l :label_gtt_print_title %></h3>
+  <%= form_tag gtt_print_jobs_path, remote: true do |f| %>
+    <%= hidden_field_tag :issue_ids, @issues.map(&:id).join(',') %>
+    <%= select_tag :gtt_print_layout, options_from_collection_for_select(layouts, :to_s, :to_s) %>
+    <button type="submit"><%= l :button_gtt_print_submit %></button>
+  <% end %>
+
+<% end %>

config/locales/en.yml

@@ -1,6 +1,7 @@
 en:
   field_gtt_print_server: Default print server URL
   gtt_print_configurations: Print configurations
+  label_gtt_list_config: Issue lists
   label_gtt_no_printing: No printing
   label_gtt_print_title: Template Print
   label_gtt_print_failed: Printing failed

init.rb

@@ -16,7 +16,8 @@
   settings(
     default: {
       'default_print_server' => "http://localhost:8080/mfp",
-      "tracker_config" => {}
+      "tracker_config" => {},
+      "issue_list_config" => nil
     },
     partial: 'gtt_print/settings'
   )

lib/redmine_gtt_print.rb

@@ -8,6 +8,16 @@ def self.settings
     Setting.plugin_redmine_gtt_print
   end
 
+  def self.list_config
+    settings['issue_list_config']
+  end
+
+  def self.list_layouts
+    if cfg = list_config
+      mapfish.layouts cfg
+    end
+  end
+
   def self.tracker_config(tracker)
     (settings['tracker_config'] || {})[tracker.id.to_s]
   end

lib/redmine_gtt_print/issue_to_json.rb

@@ -3,10 +3,6 @@ module RedmineGttPrint
   # Transforms the given issue into JSON ready to be sent to the mapfish print
   # server.
   #
-  # TODO: fetch template capabilities
-  # (https://print.***REMOVED***/print/DEMO_gtt/capabilities.json?pretty=true)
-  # and determine issue attributes that have to be included from that.
-  #
   class IssueToJson
     def initialize(issue, layout)
       @issue = issue
@@ -20,31 +16,33 @@ def self.call(issue, layout)
     def call
       json = {
         layout: @layout,
-        attributes: {
-          title: @issue.subject,
-        }
+        attributes: self.class.attributes_hash(@issue)
       }
 
       if data = @issue.geodata_for_print
-        json[:attributes][:map] = map_data(data)
+        json[:attributes][:map] = self.class.map_data(data[:center], [data[:geojson]])
       end
 
       json.to_json
     end
 
-    private
+    # the following static helpers are used by IssuesToJson as well
+
+    def self.attributes_hash(issue)
+      {
+        title: issue.subject,
+      }
+    end
 
-    def map_data(data)
+    def self.map_data(center, features)
       {
-        center: data[:center],
+        center: center,
         rotation: 0,
         longitudeFirst: true,
         layers: [
           {
             geoJson: {
-              features: [
-                data[:geojson]
-              ],
+              features: features,
               type: "FeatureCollection",
             },
             style: {

lib/redmine_gtt_print/issues_to_json.rb

@@ -0,0 +1,38 @@
+module RedmineGttPrint
+
+  # Transforms the given array of issues into JSON ready to be sent to the
+  # mapfish print server
+  #
+  class IssuesToJson
+    def initialize(issues, layout)
+      @issues = issues
+      @layout = layout
+    end
+
+    def self.call(issues, layout)
+      new(issues, layout).call
+    end
+
+    def call
+      hsh = {
+        layout: @layout,
+        attributes: {
+          issues: @issues.map{|i| IssueToJson.attributes_hash(i)}
+        }
+      }
+
+      if (features = @issues.map(&:geodata_for_print).compact).any?
+        # TODO determine a proper center for the whole set of features
+        center = features.first[:center]
+        hsh[:attributes][:map] = IssueToJson.map_data(
+          center,
+          features.map{|f| f[:geojson] }
+        )
+      end
+
+      hsh.to_json
+    end
+
+  end
+end
+

lib/redmine_gtt_print/mapfish.rb

@@ -59,11 +59,22 @@ def print_issue(issue, layout, format: 'pdf')
       end
     end
 
+    def print_issues(issues, layout, format: 'pdf')
+      json = IssuesToJson.(issues, layout)
+      if ref = request_print(json, RedmineGttPrint.list_config, format)
+        CreateJobResult.new success: true, ref: ref
+      else
+        CreateJobResult.new
+      end
+    end
+
     private
 
     def request_print(json, print_config, format)
       url = "#{@host}/print/#{print_config}/report.#{format}"
-      #(File.open("/tmp/mapfish.json", "wb") << json).close
+      if Rails.env.development?
+        (File.open(Rails.root.join("tmp/mapfish.json"), "wb") << json).close
+      end
       r = HTTParty.post url, body: json, headers: { 'Content-Type' => 'application/json' }
       if r.success?
         json = JSON.parse r.body

test/unit/issues_to_json_test.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class IssuesToJsonTest < ActiveSupport::TestCase
+  include GttTestData
+
+  fixtures :projects,
+           :trackers,
+           :projects_trackers,
+           :enabled_modules,
+           :issue_statuses,
+           :issues,
+           :enumerations,
+           :custom_fields,
+           :custom_values,
+           :custom_fields_trackers,
+           :attachments
+
+  setup do
+    @issues = Issue.find(1, 2)
+    @issues.first.update_attribute :geojson, test_geojson
+  end
+
+  test 'should build mapfish json' do
+    assert j = RedmineGttPrint::IssuesToJson.(@issues, 'das layout')
+    assert h = JSON.parse(j)
+    assert_equal 'das layout', h['layout']
+    assert_equal @issues[0].subject, h['attributes']['issues'][0]['title']
+    assert_equal @issues[1].subject, h['attributes']['issues'][1]['title']
+
+    assert map = h['attributes']['map']
+    assert_equal 2, map['center'].size
+    assert geo = map['layers'][0]['geoJson']
+    assert_equal 'FeatureCollection', geo['type']
+    assert feature = geo['features'][0]
+    assert_equal 'Feature', feature['type']
+    assert geom = feature['geometry']
+    assert_equal 'Polygon', geom['type']
+    assert_equal 15052703.2783315, geom['coordinates'].flatten.first
+  end
+
+end
+
+