rocketjob_mission_control 5.0.0 → 6.0.1

data/app/helpers/rocket_job_mission_control/application_helper.rb

@@ -56,8 +56,16 @@ module RocketJobMissionControl
       values
     end
 
+    def escape(s)
+      s.dump[1..-2]
+    end
+
+    def unescape(s)
+      "\"#{s}\"".undump
+    end
+
     # Returns the editable field as html for use in editing dynamic fields from a Job class.
-    def editable_field_html(klass, field_name, value, f, include_nil_selectors = false)
+    def editable_field_html(klass, field_name, value, f)
       # When editing a job the values are of the correct type.
       # When editing a dirmon entry values are strings.
       field = klass.fields[field_name.to_s]
@@ -67,44 +75,61 @@ module RocketJobMissionControl
       placeholder = nil if placeholder.is_a?(Proc)
 
       case field.type.name
-      when "Symbol", "String", "Integer"
+      when "Integer"
+        options = extract_inclusion_values(klass, field_name)
+        f.number_field(field_name, in: options, include_blank: false, value: value, class: "form-control", placeholder: placeholder)
+      when "String", "Symbol", "Mongoid::StringifiedSymbol"
         options = extract_inclusion_values(klass, field_name)
-        str     = "[#{field.type.name}]\n".html_safe
         if options
-          str + f.select(field_name, options, {include_blank: options.include?(nil) || include_nil_selectors, selected: value}, {class: "selectize form-control"})
+          f.select(field_name, options, {include_blank: options.include?(nil), selected: value}, {class: "selectize form-control"})
         else
-          if field.type.name == "Integer"
-            str + f.number_field(field_name, value: value, class: "form-control", placeholder: placeholder)
-          else
-            str + f.text_field(field_name, value: value, class: "form-control", placeholder: placeholder)
-          end
+          f.text_area(field_name, value: value ? value : "", class: "form-control", placeholder: placeholder)
         end
+      when "Boolean", "Mongoid::Boolean"
+        options = extract_inclusion_values(klass, field_name) || [nil, "true", "false"]
+        f.select(field_name, options, {include_blank: options.include?(nil), selected: value}, {class: "selectize form-control"})
       when "Hash"
         "[JSON Hash]\n".html_safe +
           f.text_field(field_name, value: value ? value.to_json : "", class: "form-control", placeholder: '{"key1":"value1", "key2":"value2", "key3":"value3"}')
       when "Array"
         options = Array(value)
-        "[Array]\n".html_safe +
-          f.select(field_name, options_for_select(options, options), {include_hidden: false}, {class: "selectize form-control", multiple: true})
-      when "Mongoid::Boolean"
-        name = "#{field_name}_true".to_sym
-        value = value.to_s
-        str = '<div class="radio-buttons">'.html_safe
-        str << f.radio_button(field_name, "true", checked: value == "true")
-        str << " ".html_safe + f.label(name, "true")
-        str << " ".html_safe + f.radio_button(field_name, "false", checked: value == "false")
-        str << " ".html_safe + f.label(name, "false")
-        # Allow this field to be unset (nil).
-        if include_nil_selectors
-          str << " ".html_safe + f.radio_button(field_name, "", checked: value == "")
-          str << " ".html_safe + f.label(name, "nil")
-        end
-
-        str << "</div>".html_safe
+        f.text_field(field_name, {class: "selectize form-control", multiple: true})
       else
         "[#{field.type.name}]".html_safe +
           f.text_field(field_name, value: value, class: "form-control", placeholder: placeholder)
       end
     end
+
+    # This method creates a link with `data-id` `data-fields` attributes. These attributes are used to create new instances of the nested fields through Javascript.
+    def link_to_add_fields(name, f, association, option)
+      # Takes an object (@job) and creates a new instance of its associated model (:properties)
+      new_object = f.object.send(association).klass.new
+
+      # Saves the unique ID of the object into a variable.
+      # This is needed to ensure the key of the associated array is unique. This is makes parsing the content in the `data-fields` attribute easier through Javascript.
+      # We could use another method to achive this.
+      id = new_object.object_id
+
+      # https://api.rubyonrails.org/ fields_for(record_name, record_object = nil, fields_options = {}, &block)
+      # record_name = :addresses
+      # record_object = new_object
+      # fields_options = { child_index: id }
+      # child_index` is used to ensure the key of the associated array is unique, and that it matched the value in the `data-id` attribute.
+      # `person[addresses_attributes][child_index_value][_destroy]`
+      fields = f.fields_for(association, new_object, child_index: id) do |builder|
+        # `association.to_s.singularize + "_fields"` ends up evaluating to `address_fields`
+        # The render function will then look for `views/people/_address_fields.html.erb`
+        # The render function also needs to be passed the value of 'builder', because `views/dirmon_entries/_input_categories.html.erb` needs this to render the form tags.
+        render(association.to_s.singularize + "_fields", f: builder)
+      end
+
+      # This renders a simple link, but passes information into `data` attributes.
+      # This info can be named anything we want, but in this case we chose `data-id:` and `data-fields:`.
+      # The `id:` is from `new_object.object_id`.
+      # The `fields:` are rendered from the `fields` blocks.
+      # We use `gsub("\n", "")` to remove anywhite space from the rendered partial.
+      # The `id:` value needs to match the value used in `child_index: id`.
+      link_to(name, '#', class: "add_fields btn btn-#{option}", data: { id: id, fields: fields.gsub("\n", "") })
+    end
   end
 end

data/app/helpers/rocket_job_mission_control/dirmon_entries_helper.rb

@@ -3,5 +3,17 @@ module RocketJobMissionControl
     def dirmon_counts_by_state(state)
       RocketJob::DirmonEntry.counts_by_state.fetch(state.downcase.to_sym, 0)
     end
+
+
+    def dirmon_entry_find_category(categories, category_name = :main)
+      return unless categories
+
+      categories.each { |category| return category if category_name == (category["name"] || :main).to_sym }
+      nil
+    end
+    
+    def rocket_job_mission_control
+      @@rocket_job_mission_control_engine_url_helpers ||= RocketJobMissionControl::Engine.routes.url_helpers
+    end
   end
 end

data/app/helpers/rocket_job_mission_control/jobs_helper.rb

@@ -1,5 +1,23 @@
 module RocketJobMissionControl
   module JobsHelper
+    # The fields that RJMC already displays, all other will be rendered under the custom section.
+    DISPLAYED_FIELDS = %w[
+      _id _type
+      completed_at created_at cron_schedule
+      description destroy_on_complete download_encryption
+      exception expires_at
+      failed_at_list failure_count
+      input_categories
+      log_level
+      output_categories output_path
+      percent_complete priority
+      record_count retry_limit run_at
+      started_at state statistics sub_state
+      throttle_group throttle_running_workers
+      upload_file_name
+      worker_name
+    ]
+
     def job_icon(job)
       state = job_state(job)
       state_icon(state)
@@ -15,6 +33,47 @@ module RocketJobMissionControl
       end
     end
 
+    def job_state_name(job)
+      job_state(@job).to_s.camelcase
+    end
+
+    def job_time(time)
+      return "" unless time
+      time.in_time_zone(Time.zone)
+    end
+
+    def job_state_time(job)
+      return job_time(job.run_at) if job.scheduled?
+
+      job_time(job.completed_at || job.started_at || job.created_at )
+      # job_time(job.running? ? job.started_at : job.completed_at)
+    end
+
+    def job_estimated_time_left(job)
+      if job.record_count && job.running? && job.record_count.positive?
+        percent = job.percent_complete
+        if percent >= 5
+          secs = job.seconds.to_f
+          RocketJob.seconds_as_duration((((secs / percent) * 100) - secs))
+        end
+      end
+    end
+
+    def job_records_per_hour(job)
+      return unless job.completed?
+
+      secs = job.seconds.to_f
+      ((job.record_count.to_f / secs) * 60 * 60).round if job.record_count&.positive? && (secs > 0.0)
+    end
+
+    def job_custom_fields(job)
+      attrs = job.attributes.dup
+      DISPLAYED_FIELDS.each { |key| attrs.delete(key) }
+      # Convert time zones for any custom time fields
+      attrs.keys { |key| attrs[key] = attrs[key].in_time_zone(Time.zone) if attrs[key].is_a?(Time) }
+      attrs
+    end
+
     def job_states
       @job_states ||= RocketJob::Job.aasm.states.map { |state| state.name.to_s }
     end
@@ -25,10 +84,10 @@ module RocketJobMissionControl
 
     def job_counts_by_state(state)
       @job_counts ||= begin
-        counts          = RocketJob::Job.counts_by_state
-        counts[:queued] = counts[:queued_now] || 0
-        counts
-      end
+                        counts          = RocketJob::Job.counts_by_state
+                        counts[:queued] = counts[:queued_now] || 0
+                        counts
+                      end
       @job_counts.fetch(state.downcase.to_sym, 0)
     end
 
@@ -38,8 +97,9 @@ module RocketJobMissionControl
         path,
         method: http_method,
         title:  "#{action} job",
-        class:  "btn btn-default",
-        data:   {confirm: t(:confirm, scope: %i[job action], action: action)}
+        class:  "btn btn-default btn-group",
+        role:   "group",
+        data:   { confirm: t(:confirm, scope: %i[job action], action: action) }
       )
     end
 
@@ -49,8 +109,9 @@ module RocketJobMissionControl
         path,
         method: http_method,
         title:  "#{action} job",
-        class:  "btn btn-primary",
-        data:   {confirm: t(:confirm, scope: %i[job action], action: action)}
+        class:  "btn btn-default btn-group",
+        role:   "group",
+        data:   { confirm: t(:confirm, scope: %i[job action], action: action) }
       )
     end
 
@@ -61,5 +122,12 @@ module RocketJobMissionControl
         ""
       end
     end
+
+    def job_find_category(categories, category_name = :main)
+      return unless categories
+
+      categories.each { |category| return category if category_name == (category["name"] || :main).to_sym }
+      nil
+    end
   end
 end

data/app/helpers/rocket_job_mission_control/servers_helper.rb

@@ -26,5 +26,9 @@ module RocketJobMissionControl
         map[server.state] || "callout-info"
       end
     end
+    
+    def rocket_job_mission_control
+      @@rocket_job_mission_control_engine_url_helpers ||= RocketJobMissionControl::Engine.routes.url_helpers
+    end
   end
 end

data/app/models/rocket_job_mission_control/dirmon_sanitizer.rb

@@ -0,0 +1,68 @@
+module RocketJobMissionControl
+  module DirmonSanitizer
+    DIRMON_FIELDS = %i(archive_directory job_class_name name pattern).freeze
+
+    def self.sanitize(params, job_class, target)
+      permissible_params = {}
+
+      DIRMON_FIELDS.each do |field_name|
+        value = params[field_name]
+        next if value.blank?
+
+        permissible_params[field_name] = value
+      end
+
+      if params.key?(:properties)
+        properties                      = JobSanitizer.sanitize(params[:properties], job_class, target, false)
+        permissible_params[:properties] = properties unless properties.blank?
+      end
+
+      permissible_params
+    end
+
+    # Returns [Hash] the difference between the supplied params and those already set in the job itself
+    def self.diff_properties(sanitized_properties, dirmon_entry)
+      default_job = dirmon_entry.job_class.new
+      updated_job = dirmon_entry.job_class.from_properties(sanitized_properties)
+      properties  = {}
+      sanitized_properties&.each_pair do |name, value|
+        if name == :input_categories
+          categories = []
+          value.each do |category_properties|
+            category_name = category_properties[:name].to_sym
+            props         = diff_category(category_properties, updated_job.input_category(category_name), default_job.input_category(category_name))
+            categories << props unless props.empty?
+          end
+          properties[:input_categories] = categories unless categories.empty?
+        elsif name == :output_categories
+          categories = []
+          value.each do |category_properties|
+            category_name = category_properties[:name].to_sym
+            props         = diff_category(category_properties, updated_job.output_category(category_name), default_job.output_category(category_name))
+            categories << props unless props.empty?
+          end
+          properties[:output_categories] = categories unless categories.empty?
+        elsif default_job.public_send(name) != updated_job.public_send(name)
+          properties[name] = value.is_a?(String) ? value.gsub(/\r\n/, "\n") : value
+        end
+      end
+      properties
+    end
+
+    def self.diff_category(properties, updated_category, default_category)
+      diff = {}
+      name = nil
+      properties&.each_pair do |key, value|
+        if key == :name
+          name = value
+          next
+        end
+        next if updated_category.public_send(key) == default_category.public_send(key)
+
+        diff[key] = value
+      end
+      diff[:name] = name unless diff.empty?
+      diff
+    end
+  end
+end

data/app/models/rocket_job_mission_control/job_sanitizer.rb

@@ -1,5 +1,7 @@
 module RocketJobMissionControl
   module JobSanitizer
+    CATEGORIES_FIELDS = %i[id name format format_options mode skip_unknown slice_size columns].freeze
+
     # Returns [Hash] the permissible params for the specified job class, after sanitizing.
     # Parameters
     #   properties [Hash]
@@ -17,6 +19,7 @@ module RocketJobMissionControl
     #     Default: true
     def self.sanitize(properties, job_class, target, nil_blank = true)
       permissible_params = {}
+
       job_class.user_editable_fields.each do |field_name|
         next unless value = properties[field_name]
 
@@ -24,6 +27,8 @@ module RocketJobMissionControl
         next unless field&.type
 
         case field.type.name
+        when "String"
+          value.gsub(/\r\n/, "\n")
         when "Hash"
           begin
             value = value.blank? ? nil : JSON.parse(value)
@@ -38,7 +43,39 @@ module RocketJobMissionControl
           permissible_params[field_name] = value
         end
       end
+
+      if properties.key?(:input_categories_attributes)
+        categories                            = sanitize_categories(properties[:input_categories_attributes])
+        permissible_params[:input_categories] = categories unless categories == [{}]
+      end
+
+      if properties.key?(:output_categories_attributes)
+        categories                             = sanitize_categories(properties[:output_categories_attributes])
+        permissible_params[:output_categories] = categories unless categories == [{}]
+      end
+
       permissible_params
     end
+
+    def self.sanitize_categories(properties)
+      categories = []
+
+      properties.each_pair do |_, category|
+        hash = {}
+        CATEGORIES_FIELDS.each do |key|
+          next unless category.key?(key)
+
+          value = category[key]
+          next if value.blank?
+          next if (key == :columns) && value == [""]
+
+          value     = JSON.parse(value) if key == :format_options
+          hash[key] = value
+        end
+        categories << hash
+      end
+
+      categories
+    end
   end
 end

data/app/views/layouts/rocket_job_mission_control/application.html.erb

@@ -17,8 +17,8 @@
 
     <%= yield :meta %>
 
-    <%= stylesheet_link_tag 'rocket_job_mission_control/application', media: 'all' %>
-    <%= javascript_include_tag 'rocket_job_mission_control/application' %>
+    <%= stylesheet_link_tag "rocket_job_mission_control/application", media: 'all', "data-turbolinks-track": "reload" %>
+    <%= javascript_include_tag "rocket_job_mission_control/application", "data-turbolinks-track": "reload" %>
 
     <%= csrf_meta_tag %>
   </head>

data/app/views/layouts/rocket_job_mission_control/partials/_flash.html.erb

@@ -1,13 +1,13 @@
 <% if flash.present? %>
-  <div class='flash text-center'>
+  <div class="flash text-center">
     <% flash.each do |key, msg| %>
-      <div class='alert alert-<%=key%> alert-dismissable' role='alert'>
-        <button class='close' data-dismiss='alert'>
+      <div class="alert alert-<%=key%> alert-dismissable" role="alert">
+        <button class="close" data-dismiss="alert">
           <span>&times;</span>
         </button>
 
         <% if msg.kind_of? Array %>
-          <ul class='list-unstyled margin-bottom-0'>
+          <ul class="list-unstyled margin-bottom-0">
             <% msg.each do |m| %>
               <li><%= m.html_safe %></li>
             <% end %>

data/app/views/rocket_job_mission_control/dirmon_entries/_form.html.erb

@@ -1,69 +1,105 @@
 <% action ||= :create %>
 
 <% if @dirmon_entry.errors.present? %>
-  <div class='alert alert-alert'>Invalid Dirmon entry!</div>
+  <div class="alert alert-alert">Invalid Dirmon entry!</div>
+
   <% @dirmon_entry.errors.messages.each_pair do |field, message| %>
-    <div class='message'><%= field %>: <%= message %></div>
+    <div class="message"><%= field %>: <%= message %></div>
   <% end %>
 <% end %>
 
-<%= form_for @dirmon_entry, url: {action: action} do |f| %>
-  <div class='row'>
-    <div class='col-md-6'>
-      <div class='name form-group'>
-        <%= f.label :name %>
-        <%= f.text_field :name, class: 'form-control' %>
-      </div>
-    </div>
+<%= form_for @dirmon_entry, url: { action: action } do |f| %>
+  <div class="row">
+    <div class="col-md-12">
+        <div class="arguments">
+          <div class="panel panel-default">
+            <div class="panel-body">
+              <div class="job_arguments form-group"></div>
 
-    <div class='col-md-6'>
-      <div class='job form-group'>
-        <%= f.label :job_class_name %>
-        <%= f.text_field :job_class_name, class: 'form-control', disabled: action != :create %>
-      </div>
-    </div>
-  </div>
+              <div class="form-group">
+                <%= f.label :name %>
+                <%= f.text_field :name, class: "form-control" %>
+              </div>
 
-  <div class='path form-group'>
-    <%= f.label :pattern %>
-    <%= f.text_field :pattern, class: 'form-control' %>
-  </div>
+              <div class="form-group">
+                <%= f.label "Job Class" %>
+                <%= f.text_field :job_class_name, class: "form-control", disabled: action != :create %>
+              </div>
 
-  <div class='path form-group'>
-    <%= f.label :archive_directory %>
-    <%= f.text_field :archive_directory, class: 'form-control' %>
-  </div>
+              <div class="form-group">
+                <%= f.label :pattern %>
+                <%= f.text_field :pattern, class: "form-control" %>
+              </div>
+
+              <div class="form-group">
+                <%= f.label :archive_directory %>
+                <%= f.text_field :archive_directory, class: "form-control" %>
+              </div>
+            </div>
+          </div>
+
+        <% if @dirmon_entry.job_class %>
+            <% @job = @dirmon_entry.job_class.from_properties(@dirmon_entry.properties) %>
+            <%= f.fields_for :properties do |p| %>
+            <div class="panel panel-default">
+              <div class="panel-heading">
+                <strong>Properties</strong>
+              </div>
+
+              <div class="panel-body">
+                <% @dirmon_entry.job_class.user_editable_fields.sort.each do |property_name| %>
+                  <% next if property_name == :run_at %>
+
+                  <div class="form-group">
+                    <%= p.label property_name.to_s %>
+                    <%= editable_field_html(@dirmon_entry.job_class, property_name, @job.public_send(property_name), p) %>
+                  </div>
+                <% end %>
+              </div>
+            </div>
+
+            <% if @dirmon_entry.job_class.respond_to?(:defined_input_categories) && @dirmon_entry.job_class.respond_to?(:defined_output_categories) %>
+              <div class="row">
+                <div class="col-sm-6">
+                  <div class="panel panel-primary">
+                    <div class="panel-body">
+                      <div class='lead'>Input Categories</div>
 
-  <div class='row'>
-    <div class='col-md-12'>
-      <% if @dirmon_entry.job_class %>
-        <div class='lead'>Job Properties</div>
+                      <% @job.input_categories.each do |input_categories| %>
+                        <%= p.fields_for "input_categories_attributes[]", input_categories  do |i| %>
+                          <%= render "input_category_fields.html", f: i %>
+                        <% end %>
+                      <% end %>
+                    </div>
+                  </div>
+                </div>
 
-        <div class='arguments'>
-          <div class='job_arguments form-group'></div>
+                <div class="col-sm-6">
+                  <div class="panel panel-success">
+                    <div class="panel-body">
+                      <div class='lead'>Output Categories</div>
 
-          <%= f.fields_for :properties do |properties| %>
-            <% @dirmon_entry.job_class.user_editable_fields.each do |property_name| %>
-              <div class='form-group'>
-                <%= properties.label property_name.to_s %>
-                <%= editable_field_html(@dirmon_entry.job_class, property_name, @dirmon_entry.properties[property_name], properties, true) %>
+                      <% @job.output_categories.each do |output_categories| %>
+                        <%= p.fields_for "output_categories_attributes[]", output_categories  do |o| %>
+                          <%= render "output_category_fields.html", f: o %>
+                        <% end %>
+                      <% end %>
+                    </div>
+                  </div>
+                </div>
               </div>
             <% end %>
           <% end %>
         </div>
       <% end %>
 
-      <div class='buttons pull-right'>
+      <div class='buttons'>
         <%= f.submit action, class: 'btn btn-primary' %>
         <%= link_to 'cancel', :back, class: 'btn btn-default' %>
       </div>
 
       <% if action == :create %>
-        <%= button_tag 'properties',
-            type:  'button',
-            class: 'btn btn-default',
-            id:    'properties',
-            data:  { url: rocket_job_mission_control.new_dirmon_entry_path } %>
+        <%= button_tag 'properties', type: 'button', class: 'btn btn-default', id: 'properties', data: {url: rocket_job_mission_control.new_dirmon_entry_path} %>
       <% end %>
     </div>
   </div>

data/app/views/rocket_job_mission_control/dirmon_entries/_input_categories.html.erb

@@ -0,0 +1,59 @@
+<div class='lead'>Input Categories:</div>
+<% @job.input_categories.each do |category| %>
+  <div class='row'>
+    <div class='col-md-12'>
+      <div class='status-message'><label><%= category.name.to_s.camelcase %>:</label></div>
+      <div class='row'>
+        <div class='col-md-12'>
+          <table>
+            <% if category.name == :main %>
+              <tr>
+                <td><label>Slice Size:</label></td>
+                <td><%= category.slice_size %></td>
+              </tr>
+            <% end %>
+            </tr>
+            <tr>
+              <td><label>Format:</label></td>
+              <td><%= category.format %></td>
+            </tr>
+            <tr>
+              <td><label>Skip Unknown Columns:</label></td>
+              <td><%= category.skip_unknown %></td>
+            </tr>
+            <tr>
+              <td><label>Mode:</label></td>
+              <td><%= category.mode %></td>
+            </tr>
+            <% if category.format_options %>
+            <tr>
+              <td><label>Format Options:</label></td>
+              <td>
+                <pre><code><%= category.format_options.ai(plain: true, ruby19_syntax: true, sort_keys: true) %></code></pre>
+              </td>
+            </tr>
+            <% end %>
+            <% if category.columns %>
+              <% first = true %>
+              <% category.columns.each do |item| %>
+                <% if first %>
+                  <tr>
+                    <td><label>Columns:</label></td>
+                    <td><%= item %></td>
+                  </tr>
+                  <% first = false %>
+                <% else %>
+                  <tr>
+                    <td></td>
+                    <td><%= item %></td>
+                  </tr>
+                <% end %>
+              <% end %>
+            <% end %>
+          </table>
+        </div>
+      </div>
+    </div>
+  </div>
+  <br/>
+<% end %>