merges custom comment support

Author: dkastl

app/controllers/gtt_print_jobs_controller.rb

@@ -10,15 +10,14 @@ class GttPrintJobsController < ApplicationController
   menu_item :issues
 
   def create
-    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
+    job = GttPrintJob.new gtt_print_job_params
+    job.issue = @issue
+    job.issues = @issues
+    if job.valid?
+      @result = RedmineGttPrint.mapfish.print job
       render status: (@result&.success? ? :created : 422)
     else
-      render_404
+      render status: 422
     end
   end
 
@@ -45,6 +44,10 @@ def show
 
   private
 
+  def gtt_print_job_params
+    params[:gtt_print_job].permit(:layout, :custom_text)
+  end
+
   def authorize_create
     if @project
       authorize

app/models/gtt_print_job.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class GttPrintJob
+  include ActiveModel::Model
+
+  attr_accessor :layout, :custom_text, :issue, :issues
+
+  validates :layout, presence: true
+  validates :issue, presence: true,  if: ->{ issues.nil? }
+  validates :issues, presence: true, if: ->{ issue.nil? }
+
+  def list?
+    issue.nil? && issues.present?
+  end
+
+  def json
+    if list?
+      RedmineGttPrint::IssuesToJson.(issues, layout, custom_text: custom_text)
+    else
+      RedmineGttPrint::IssueToJson.(issue, layout, custom_text: custom_text)
+    end
+  end
+
+  def print_config
+    if list?
+      RedmineGttPrint.list_config
+    else
+      RedmineGttPrint.tracker_config(issue.tracker)
+    end
+  end
+
+  def format
+    "pdf"
+  end
+end

app/views/hooks/_print_issue_form.html.erb

@@ -1,9 +1,9 @@
 <% if @issue and User.current.allowed_to?(:view_gtt_print, @issue.project) and (layouts = RedmineGttPrint.layouts_for_tracker(@issue.tracker)).present? %>
   <h3><%= l :label_gtt_print_title %></h3>
-  <%= form_tag gtt_print_jobs_path, remote: true do |f| %>
+  <%= form_for :gtt_print_job, url: gtt_print_jobs_path, remote: true do |f| %>
     <%= hidden_field_tag :issue_id, @issue.id %>
-    <%= text_area_tag :gtt_print_custom_text %><br>
-    <%= select_tag :gtt_print_layout, options_from_collection_for_select(layouts, :to_s, :to_s) %>
+    <%= f.text_area :custom_text %><br>
+    <%= f.select :layout, options_from_collection_for_select(layouts, :to_s, :to_s) %>
     <button type="submit"><%= l :button_gtt_print_submit %></button>
   <% end %>
 <% end %>
@@ -15,10 +15,10 @@
 %>
 
   <h3><%= l :label_gtt_print_title %></h3>
-  <%= form_tag gtt_print_jobs_path, remote: true do |f| %>
+  <%= form_for :gtt_print_job, url: gtt_print_jobs_path, remote: true do |f| %>
     <%= hidden_field_tag :issue_ids, @issues.map(&:id).join(',') %>
-    <%= text_area_tag :gtt_print_custom_text %><br>
-    <%= select_tag :gtt_print_layout, options_from_collection_for_select(layouts, :to_s, :to_s) %>
+    <%= f.text_area :custom_text %><br>
+    <%= f.select :layout, options_from_collection_for_select(layouts, :to_s, :to_s) %>
     <button type="submit"><%= l :button_gtt_print_submit %></button>
   <% end %>
 

lib/redmine_gtt_print/issue_to_json.rb

@@ -4,19 +4,20 @@ module RedmineGttPrint
   # server.
   #
   class IssueToJson
-    def initialize(issue, layout)
+    def initialize(issue, layout, other_attributes = {})
       @issue = issue
       @layout = layout
+      @other_attributes = other_attributes
     end
 
-    def self.call(issue, layout)
-      new(issue, layout).call
+    def self.call(*_)
+      new(*_).call
     end
 
     def call
       json = {
         layout: @layout,
-        attributes: self.class.attributes_hash(@issue)
+        attributes: self.class.attributes_hash(@issue, @other_attributes)
       }
 
       if data = @issue.geodata_for_print
@@ -28,7 +29,7 @@ def call
 
     # the following static helpers are used by IssuesToJson as well
 
-    def self.attributes_hash(issue)
+    def self.attributes_hash(issue, other_attributes)
       {
         id: issue.id,
         subject: issue.subject,
@@ -55,6 +56,9 @@ def self.attributes_hash(issue)
         created_on: issue.created_on,
         updated_on: issue.updated_on,
 
+        # Custom text
+        # custom_text: other_attributes[:custom_text]
+
         # Experimental
         # issue: issue,
         # project: (Project.find issue.project_id),

lib/redmine_gtt_print/issues_to_json.rb

@@ -4,20 +4,23 @@ module RedmineGttPrint
   # mapfish print server
   #
   class IssuesToJson
-    def initialize(issues, layout)
+    def initialize(issues, layout, other_attributes = {})
       @issues = issues
       @layout = layout
+      @other_attributes = other_attributes
     end
 
-    def self.call(issues, layout)
-      new(issues, layout).call
+    def self.call(*_)
+      new(*_).call
     end
 
     def call
       hsh = {
         layout: @layout,
         attributes: {
-          issues: @issues.map{|i| IssueToJson.attributes_hash(i)}
+          issues: @issues.map{|i|
+            IssueToJson.attributes_hash(i, @other_attributes)
+          }
         }
       }
 

lib/redmine_gtt_print/mapfish.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RedmineGttPrint
   class Mapfish
 
@@ -27,6 +29,14 @@ def get_capabilities(print_config)
       end
     end
 
+    def print(job)
+      if ref = request_print(job.json, job.print_config, job.format)
+        CreateJobResult.new success: true, ref: ref
+      else
+        CreateJobResult.new
+      end
+    end
+
     # {"done"=>true, "status"=>"finished", "elapsedTime"=>6588, "waitingTime"=>0, "downloadURL"=>"/mapfish/print/report/a790a8e0-d2b9-4f27-8a83-d58a70b66568@36419944-3e1d-4b17-9aab-f56aec338242"}
     def get_status(ref)
       r = HTTParty.get "#{@host}/print/status/#{ref}.json"
@@ -49,25 +59,6 @@ def get_print(ref)
       end
     end
 
-    def print_issue(issue, layout, format: 'pdf')
-      json = IssueToJson.(issue, layout)
-      print_config = RedmineGttPrint.tracker_config(issue.tracker)
-      if ref = request_print(json, print_config, format)
-        CreateJobResult.new success: true, ref: ref
-      else
-        CreateJobResult.new
-      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)

test/integration/issue_print_test.rb

@@ -33,22 +33,22 @@ def setup
   def test_should_create_print_job
     get "/issues/#{@issue.id}"
     assert_response :success
-    assert_select '#gtt_print_layout option', text: "A4 portrait", count: 0
+    assert_select '#gtt_print_job_layout option', text: "A4 portrait", count: 0
 
     log_user 'jsmith', 'jsmith'
     get '/projects/ecookbook/issues/new'
     assert_response :success
 
     get "/issues/#{@issue.id}"
     assert_response :success
-    assert_select '#gtt_print_layout option', text: "A4 portrait"
+    assert_select '#gtt_print_job_layout option', text: "A4 portrait"
 
     xhr :post, "/gtt_print_jobs", { issue_id: @issue.id,
-                                    gtt_print_layout: "A4 portrait" }
+                                    gtt_print_job: { layout: "A4 portrait" } }
     assert_response :created
 
     assert_equal @issue, @mapfish.issue
-    assert_equal 'A4 portrait', @mapfish.template
+    assert_equal 'A4 portrait', @mapfish.layout
   end
 
   def test_should_check_job_status

test/integration/mapfish_test.rb

@@ -36,8 +36,9 @@ class MapfishTest < ActionDispatch::IntegrationTest
   test "should issue print job" do
     i = @issue
     i.update_attribute :geojson, test_geojson
+    job = GttPrintJob.new issue: i, layout: 'A4 portrait'
 
-    assert r = @mapfish.print_issue(i, 'A4 portrait')
+    assert r = @mapfish.print(job)
     assert r.success?
     assert ref = r.ref
     sleep 3

test/test_helper.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../redmine_gtt/test/test_helper')
 
 class TestMapfish
-  attr_reader :issue, :template
+  attr_reader :issue, :layout
   def print_configs
     ['test-template']
   end
@@ -25,9 +25,9 @@ def printjob_ready(name)
     @ready_jobs << name
   end
 
-  def print_issue(issue, template)
-    @issue = issue
-    @template = template
+  def print(job)
+    @issue = job.issue
+    @layout = job.layout
 
     Result.new(success: true, ref: 'some-job')
   end

test/unit/issue_to_json_test.rb

@@ -24,7 +24,7 @@ class IssueToJsonTest < ActiveSupport::TestCase
     assert j = RedmineGttPrint::IssueToJson.(@issue, 'das layout')
     assert h = JSON.parse(j)
     assert_equal 'das layout', h['layout']
-    assert_equal @issue.subject, h['attributes']['title']
+    assert_equal @issue.subject, h['attributes']['subject']
     assert map = h['attributes']['map']
     assert_equal 2, map['center'].size
     assert geo = map['layers'][0]['geoJson']
@@ -40,7 +40,7 @@ class IssueToJsonTest < ActiveSupport::TestCase
     i = Issue.find(2)
     assert j = RedmineGttPrint::IssueToJson.(i, 'layout')
     assert h = JSON.parse(j)
-    assert_equal i.subject, h['attributes']['title']
+    assert_equal i.subject, h['attributes']['subject']
     assert_nil h['attributes']['map']
   end