Add journals to Jobs to track changes

Redmine uses journals to track changes to Issues. Whilst theoretically a
polymorphic association, there are a bunch of places where it is assumed
this is an issue, so we have to account for that and start patching
things.

Refs #3320

app/helpers/jobs_helper.rb

@@ -22,7 +22,7 @@ module JobsHelper
         {
           name: "history",
           label: "History",
-          onclick: 'showJobHistory("history", this.href)',
+          onclick: 'showIssueHistory("history", this.href)',
           partial: "jobs/tabs/history",
           locals: {
             job: @job,
@@ -33,7 +33,7 @@ module JobsHelper
         tabs << {
           name: "notes",
           label: "Notes",
-          onclick: 'showJobHistory("notes", this.href)',
+          onclick: 'showIssueHistory("notes", this.href)',
         }
       end
     end
@@ -101,12 +101,9 @@ module JobsHelper
       when 'due_date', 'start_date'
         value = format_date(detail.value.to_date) if detail.value
         old_value = format_date(detail.old_value.to_date) if detail.old_value
-
-      when 'project_id', 'status_id', 'tracker_id', 'assigned_to_id',
-            'priority_id', 'category_id', 'fixed_version_id'
+      when 'project_id', 'category_id'
         value = find_name_by_reflection(field, detail.value)
         old_value = find_name_by_reflection(field, detail.old_value)
-
       when 'description'
         show_diff = true
       end
@@ -195,7 +192,7 @@ module JobsHelper
     return nil if id.blank?
 
     @detail_value_name_by_reflection ||= Hash.new do |hash, key|
-      association = Issue.reflect_on_association(key.first.to_sym)
+      association = Job.reflect_on_association(key.first.to_sym)
       name = nil
       if association
         record = association.klass.find_by_id(key.last)
@@ -207,4 +204,8 @@ module JobsHelper
     end
     @detail_value_name_by_reflection[[field, id]]
   end
+
+  def render_notes(issue, journal, options={})
+    content_tag('div', textilizable(journal, :notes), :id => "journal-#{journal.id}-notes", :class => "wiki")
+  end
 end

app/models/job.rb

@@ -87,6 +87,19 @@ class Job < ActiveRecord::Base
     true
   end
 
+  # tracker and subject are used to make Job quack like an issue so the diff view
+  # built into Redmine will work
+  def tracker
+    OpenStruct.new(
+      name: name,
+      to_s: "Job",
+    )
+  end
+
+  def subject
+    name
+  end
+
   def self.fields_for_order_statement
     "jobs.name"
   end

app/views/jobs/_form.html.erb

@@ -20,7 +20,7 @@
     <p>
     <%= f.label :description %>
     <%= f.text_area :description, required: true, cols: 60, rows: 15, class: "wiki-edit",
-                    data: { auto_complete: true }, id: "job_description" %>
+      data: { auto_complete: true }, id: "job_description" %>
 
     <%= f.hidden_field :project_id, value: @job.project.id %>
 
@@ -35,14 +35,17 @@
         <%= ff.hidden_field :_destroy, value: false %>
       <% end %>
     </fieldset>
-<%= wikitoolbar_for 'job_description' %>
+    <%= wikitoolbar_for 'job_description' %>
 
+
+    <% unless @job.new_record? %>
+      <fieldset id="add_notes">
+        <legend>Notes</legend>
+        <%= f.text_area :notes, cols: 60, rows: 15, class: "wiki-edit",
+          data: { auto_complete: true }, id: "job_notes" %>
+        <%= wikitoolbar_for 'job_notes' %>
+      </fieldset>
+    <% end %>
   </div>
-
-  <% unless @job.new_record? %>
-    <%= f.text_area :notes, cols: 60, rows: 15, class: "wiki-edit",
-                    data: { auto_complete: true }, id: "job_notes" %>
-    <%= wikitoolbar_for 'job_notes' %>
-  <% end %>
   <%= f.submit %>
 <% end %>

app/views/jobs/tabs/_history.html.erb

@@ -5,7 +5,7 @@
 
 <% reply_links = job.notes_addable? %>
 <% journals.each_with_index do |journal, indice| %>
-  <div id="change-<%= journal.id %>" class="journal has-notes">
+  <div id="change-<%= journal.id %>" class="<%= journal.css_classes %>">
     <div id="note-<%= indice %>" class="note">
       <div class="contextual">
         <span class="journal-actions">
@@ -17,7 +17,6 @@
         <%= avatar(journal.user) %>
         <%= authoring journal.created_on, journal.user, label: :label_updated_time_by %>
       </h4>
-      <%= journal.notes %>
 
       <% if journal.details.any? %>
         <ul class="details">
@@ -26,6 +25,8 @@
           <% end %>
         </ul>
       <% end %>
+
+      <%= render_notes(job, journal) unless journal.notes.blank? %>
     </div>
   </div>
 <% end %>

init.rb

@@ -12,10 +12,10 @@ Redmine::Plugin.register :jobs do
   User.safe_attributes 'time_budget_category_id'
 
   Rails.application.config.before_initialize do
-    Rails.logger.info "Patch Jobs"
     TimeEntryQuery.send(:include, TimeEntryQueryPatch)
     TimeEntry.send(:include, TimeEntryPatch)
     Project.send(:include, ProjectPatch)
+    JournalsController.send(:include, JournalsControllerPatch)
     Redmine::Helpers::TimeReport.send(:include, TimeReportHelperPatch)
   end
 

lib/journals_controller_patch.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_dependency 'journals_controller'
+
+module JournalsControllerPatch
+  extend ActiveSupport::Concern
+
+  included do
+    include InstanceMethods
+
+    alias_method :original_diff, :diff
+    alias_method :diff, :new_diff
+    alias_method :original_find_journal, :find_journal
+    alias_method :find_journal, :new_find_journal
+  end
+
+  module InstanceMethods
+    def new_diff
+      @journalized = @journal.journalized
+      if params[:detail_id].present?
+        @detail = @journal.details.find_by_id(params[:detail_id])
+      else
+        @detail = @journal.details.detect {|d| d.property == 'attr' && d.prop_key == 'description'}
+      end
+      unless @journalized && @detail
+        render_404
+        return false
+      end
+      if @detail.property == 'cf'
+        unless @detail.custom_field && @detail.custom_field.visible_by?(@journalized.project, User.current)
+          raise ::Unauthorized
+        end
+      end
+      @diff = Redmine::Helpers::Diff.new(@detail.value, @detail.old_value)
+    end
+
+    # The find_journal method in the controller assumes journalized is an Issue, so we need
+    # to be a bit silly about it.
+    def new_find_journal
+      @journal = Journal.find(params[:id])
+      if @journal.journalized.is_a?(Issue)
+        original_find_journal and return
+      end
+
+      @project = @journal.journalized.project
+      @issue = @journal.journalized
+    rescue ActiveRecord::RecordNotFound
+      render_404
+    end
+  end
+end