Merge pull request #57 from paviliondev/custom_field_management

FEATURE: Custom field management

assets/javascripts/discourse/components/custom-field-input.js.es6

@@ -0,0 +1,45 @@
+import Component from "@ember/component";
+import discourseComputed, { discourseObserve } from "discourse-common/utils/decorators";
+import { or } from "@ember/object/computed";
+
+const generateContent = function(array, type) {
+  return array.map(key => ({
+    id: key,
+    name: I18n.t(`admin.wizard.custom_field.${type}.${key}`)
+  }));
+}
+
+export default Component.extend({
+  tagName: 'tr',
+  topicSerializers: ['topic_view', 'topic_list_item'],
+  postSerializers: ['post'],
+  categorySerializers: ['basic_category', 'topic_view', 'topic_list_item'],
+  klassContent: generateContent(['topic', 'post', 'group', 'category'], 'klass'),
+  typeContent: generateContent(['string', 'boolean', 'json'], 'type'),
+  showInputs: or('field.new', 'field.edit'),
+  
+  @discourseComputed('field.klass')
+  serializerContent(klass) {
+    const serializers = this.get(`${klass}Serializers`);
+        
+    if (serializers) {
+      return generateContent(serializers, 'serializers');
+    } else {
+      return [];
+    }
+  },
+  
+  actions: {
+    edit() {
+      this.set('field.edit', true);
+    },
+    
+    close() {
+      if (this.field.edit) {
+        this.set('field.edit', false);
+      } else {
+        this.removeField(this.field);
+      }
+    }
+  }
+});

assets/javascripts/discourse/components/wizard-mapper-selector.js.es6

@@ -21,9 +21,11 @@ export default Component.extend({
   showGroup: computed('activeType', function() { return this.showInput('group') }),
   showUser: computed('activeType', function() { return this.showInput('user') }),
   showList: computed('activeType', function() { return this.showInput('list') }),
+  showCustomField: computed('activeType', function() { return this.showInput('customField') }),
   textEnabled: computed('options.textSelection', 'inputType', function() { return this.optionEnabled('textSelection') }),
   wizardFieldEnabled: computed('options.wizardFieldSelection', 'inputType', function() { return this.optionEnabled('wizardFieldSelection') }),
   wizardActionEnabled: computed('options.wizardActionSelection', 'inputType', function() { return this.optionEnabled('wizardActionSelection') }),
+  customFieldEnabled: computed('options.customFieldSelection', 'inputType', function() { return this.optionEnabled('customFieldSelection') }),
   userFieldEnabled: computed('options.userFieldSelection', 'inputType', function() { return this.optionEnabled('userFieldSelection') }),
   userFieldOptionsEnabled: computed('options.userFieldOptionsSelection', 'inputType', function() { return this.optionEnabled('userFieldOptionsSelection') }),
   categoryEnabled: computed('options.categorySelection', 'inputType', function() { return this.optionEnabled('categorySelection') }),
@@ -34,7 +36,7 @@ export default Component.extend({
   
   groups: alias('site.groups'),
   categories: alias('site.categories'),
-  showComboBox: or('showWizardField', 'showWizardAction', 'showUserField', 'showUserFieldOptions'),
+  showComboBox: or('showWizardField', 'showWizardAction', 'showUserField', 'showUserFieldOptions', 'showCustomField'),
   showMultiSelect: or('showCategory', 'showGroup'),
   hasTypes: gt('selectorTypes.length', 1),
   showTypes: false,
@@ -88,7 +90,8 @@ export default Component.extend({
     'showController.wizard.actions.[]',
     'showController.userFields.[]',
     'showController.currentField.id',
-    'showController.currentAction.id'
+    'showController.currentAction.id',
+    'showController.customFields'
   )
   comboBoxContent(
     activeType,
@@ -96,7 +99,8 @@ export default Component.extend({
     wizardActions,
     userFields,
     currentFieldId,
-    currentActionId
+    currentActionId,
+    customFields
   ) {
     let content;
     
@@ -139,6 +143,10 @@ export default Component.extend({
       content = userFields;
     }
     
+    if (activeType === 'customField') {
+      content = customFields;
+    }
+    
     return content;
   },
   

assets/javascripts/discourse/controllers/admin-wizards-custom-fields.js.es6

@@ -0,0 +1,42 @@
+import Controller from "@ember/controller";
+import EmberObject from '@ember/object';
+import { ajax } from 'discourse/lib/ajax';
+import { popupAjaxError } from 'discourse/lib/ajax-error';
+
+export default Controller.extend({
+  fieldKeys: ['klass', 'type', 'serializers', 'name'],
+  
+  actions: {
+    addField() {
+      this.get('customFields').pushObject(
+        EmberObject.create({
+          new: true
+        })
+      );
+    },
+    
+    removeField(field) {
+      this.get('customFields').removeObject(field);
+    },
+    
+    saveFields() {
+      this.set('saving', true);
+      ajax(`/admin/wizards/custom-fields`, {
+        type: 'PUT',
+        dataType: 'json',
+        contentType: 'application/json',
+        data: JSON.stringify({
+          custom_fields: this.customFields
+        })
+      }).then(result => {
+        if (result.success) {
+          this.set('saveIcon', 'check');
+        } else {
+          this.set('saveIcon', 'times');
+        }
+        setTimeout(() => this.set('saveIcon', ''), 5000);
+      }).finally(() => this.set('saving', false))
+        .catch(popupAjaxError);
+    }
+  }
+});

assets/javascripts/discourse/custom-wizard-admin-route-map.js.es6

@@ -7,6 +7,8 @@ export default {
         this.route('adminWizardsWizardShow', { path: '/:wizardId/', resetNamespace: true });
       });
       
+      this.route('adminWizardsCustomFields', { path: '/custom-fields', resetNamespace: true });
+      
       this.route('adminWizardsSubmissions', { path: '/submissions', resetNamespace: true }, function() {
         this.route('adminWizardsSubmissionsShow', { path: '/:wizardId/', resetNamespace: true });
       })

assets/javascripts/discourse/lib/wizard-mapper.js.es6

@@ -86,7 +86,8 @@ const selectionTypes = [
   'group',
   'category',
   'tag',
-  'user'
+  'user',
+  'customField'
 ]
 
 function defaultSelectionType(inputType, options = {}) {

assets/javascripts/discourse/routes/admin-wizards-custom-fields.js.es6

@@ -0,0 +1,13 @@
+import DiscourseRoute from "discourse/routes/discourse";
+import { ajax } from 'discourse/lib/ajax';
+import { A } from "@ember/array";
+
+export default DiscourseRoute.extend({
+  model() {
+    return ajax('/admin/wizards/custom-fields');
+  },
+  
+  setupController(controller, model) {
+    controller.set('customFields', A(model || []));
+  }
+});

assets/javascripts/discourse/routes/admin-wizards-wizard-show.js.es6

@@ -2,6 +2,7 @@ import CustomWizard from '../models/custom-wizard';
 import { ajax } from 'discourse/lib/ajax';
 import DiscourseRoute from "discourse/routes/discourse";
 import I18n from "I18n";
+import { selectKitContent } from '../lib/wizard';
 
 export default DiscourseRoute.extend({
   model(params) {
@@ -32,6 +33,7 @@ export default DiscourseRoute.extend({
       wizardList: parentModel.wizard_list,
       fieldTypes,
       userFields: parentModel.userFields,
+      customFields: selectKitContent(parentModel.custom_fields.map(f => f.name)),
       apis: parentModel.apis,
       themes: parentModel.themes,
       wizard,

assets/javascripts/discourse/routes/admin-wizards-wizard.js.es6

@@ -1,6 +1,7 @@
 import DiscourseRoute from "discourse/routes/discourse";
 import { buildFieldTypes } from '../lib/wizard-schema';
-import { set } from "@ember/object";
+import EmberObject, { set } from "@ember/object";
+import { A } from "@ember/array";
 import { all } from "rsvp";
 import { ajax } from 'discourse/lib/ajax';
 
@@ -62,7 +63,8 @@ export default DiscourseRoute.extend({
   setupController(controller, model) {
     controller.setProperties({
       wizardList: model.wizard_list,
-      wizardId: this.currentWizard()
+      wizardId: this.currentWizard(),
+      custom_fields: A(model.custom_fields.map(f => EmberObject.create(f)))
     });
   },
   

assets/javascripts/discourse/templates/admin-wizards-custom-fields.hbs

@@ -0,0 +1,38 @@
+<div class="admin-wizard-controls">
+  <h3>{{i18n 'admin.wizard.custom_field.nav_label'}}</h3>
+  
+  <div class="buttons">
+    {{#if saving}}
+      {{loading-spinner size="small"}}
+    {{else}}
+      {{#if saveIcon}}
+        {{d-icon saveIcon}}
+      {{/if}}
+    {{/if}}
+    {{d-button
+      label="admin.wizard.custom_field.save"
+      action="saveFields"}}
+    {{d-button
+      label="admin.wizard.custom_field.add"
+      icon="plus"
+      action="addField"}}
+  </div>
+</div>
+
+<div class="admin-wizard-container">
+  {{#if customFields}}
+    <table>
+      <tr>
+        {{#each fieldKeys as |key|}}
+          <th>{{i18n (concat "admin.wizard.custom_field." key ".label")}}</th>
+        {{/each}}
+        <th></th>
+      </tr>
+      {{#each customFields as |field|}}
+        {{custom-field-input
+          field=field
+          removeField=(action 'removeField')}}
+      {{/each}}
+    </table>
+  {{/if}}
+</div>

assets/javascripts/discourse/templates/admin-wizards.hbs

@@ -1,5 +1,6 @@
 {{#admin-nav}}
   {{nav-item route='adminWizardsWizard' label='admin.wizard.nav_label'}}
+  {{nav-item route='adminWizardsCustomFields' label='admin.wizard.custom_field.nav_label'}}
   {{nav-item route='adminWizardsSubmissions' label='admin.wizard.submissions.nav_label'}}
   {{#if siteSettings.wizard_apis_enabled}}
     {{nav-item route='adminWizardsApi' label='admin.wizard.api.nav_label'}}

assets/javascripts/discourse/templates/components/custom-field-input.hbs

@@ -0,0 +1,44 @@
+{{#if showInputs}}
+  <td>
+    {{combo-box
+      value=field.klass
+      content=klassContent
+      none="admin.wizard.custom_field.klass.select"
+      onChange=(action (mut field.klass))}}
+  </td>
+  <td>
+    {{combo-box
+      value=field.type
+      content=typeContent
+      none="admin.wizard.custom_field.type.select"
+      onChange=(action (mut field.type))}}
+  </td>
+  <td>
+    {{multi-select
+      value=field.serializers
+      content=serializerContent
+      none="admin.wizard.custom_field.serializers.select"
+      onChange=(action (mut field.serializers))}}
+  </td>
+  <td>
+    {{input
+      value=field.name
+      placeholder=(i18n "admin.wizard.custom_field.klass.select")}}
+  </td>
+  <td>
+    {{d-button action="close" icon="times"}}
+  </td>
+{{else}}
+  <td><label>{{field.klass}}</label></td>
+  <td><label>{{field.type}}</label></td>
+  <td>
+    {{#each field.serializers as |serializer|}}
+      <label>{{serializer}}</label>
+    {{/each}}
+  </td>
+  <td><label>{{field.name}}</label></td>
+  <td>
+    {{d-button action="edit" icon="pencil-alt"}}
+    {{d-button action="close" icon="times"}}
+  </td>
+{{/if}}

assets/javascripts/discourse/templates/components/wizard-custom-action.hbs

@@ -730,7 +730,9 @@
               onUpdate=(action 'mappedFieldUpdated')
               options=(hash
                 inputTypes='association'
+                customFieldSelection='key'
                 wizardFieldSelection='value'
+                wizardActionSelection='value'
                 userFieldSelection='value'
                 keyPlaceholder='admin.wizard.action.custom_fields.key'
                 context='action'

assets/stylesheets/common/wizard-admin.scss

@@ -535,3 +535,21 @@
   background-color: $secondary;
   border: 1px solid $primary-medium;
 }
+
+.admin-wizards-custom-fields {
+  .select-kit {
+    width: 200px;
+  }
+  
+  .select-kit.multi-select {
+    width: 250px;
+  }
+  
+  input[type="text"] {
+    margin: 0;
+  }
+  
+  td:last-of-type {
+    text-align: right;
+  }
+}

config/locales/client.en.yml

@@ -102,6 +102,7 @@ en:
             tag: "tag"
             group: "group"
             list: "list"
+            custom_field: "custom field"
 
           placeholder:
             text: "Enter text"
@@ -115,6 +116,7 @@ en:
             tag: "Select tag"
             group: "Select group"
             list: "Enter item"
+            custom_field: "Select field"
             
         error:
           failed: "failed to save wizard"
@@ -277,6 +279,31 @@ en:
             visibility_level: Visibility Level
             members_visibility_level: Members Visibility Level
         
+        custom_field:
+          nav_label: "Custom Fields"
+          add: "Add Custom Field"
+          save: "Save Custom Fields"
+          name:
+            label: "Name"
+            select: "Enter a name"
+          type:
+            label: "Type"
+            select: "Select a type"
+            string: "String"
+            boolean: "Boolean"
+            json: "JSON"
+          klass:
+            label: "Class"
+            select: "Select a class"
+            topic: "Topic"
+            group: "Group"
+            user: "User"
+          serializers:
+            label: "Serializers"
+            select: "Select serializers"
+            topic_view: "Topic View"
+            topic_list_item: "Topic List Item"
+            
         submissions:
           nav_label: "Submissions"
           title: "{{name}} Submissions"

config/routes.rb

@@ -19,6 +19,9 @@ Discourse::Application.routes.append do
     put 'admin/wizards/wizard/:wizard_id' => 'admin_wizard#save'
     delete 'admin/wizards/wizard/:wizard_id' => 'admin_wizard#remove'
     
+    get 'admin/wizards/custom-fields' => 'admin_custom_fields#index'
+    put 'admin/wizards/custom-fields' => 'admin_custom_fields#update'
+    
     get 'admin/wizards/submissions' => 'admin_submissions#index'
     get 'admin/wizards/submissions/:wizard_id' => 'admin_submissions#show'
     get 'admin/wizards/submissions/:wizard_id/download' => 'admin_submissions#download'

controllers/custom_wizard/admin/admin.rb

@@ -10,4 +10,8 @@ class CustomWizard::AdminController < ::Admin::AdminController
     params.require(:wizard_id)
     @wizard = CustomWizard::Wizard.create(params[:wizard_id].underscore)
   end
+  
+  def custom_field_list
+    serialize_data(CustomWizard::CustomField.list, CustomWizard::CustomFieldSerializer)
+  end
 end

controllers/custom_wizard/admin/custom_fields.rb

@@ -0,0 +1,47 @@
+class CustomWizard::AdminCustomFieldsController < CustomWizard::AdminController
+  def index
+    render_json_dump(custom_field_list)
+  end
+  
+  def update        
+    custom_fields = custom_field_params[:custom_fields].map do |data|
+      CustomWizard::CustomField.new(data.to_h)
+    end
+    
+    custom_fields.each do |custom_field|
+      custom_field.validate
+      
+      unless custom_field.valid?
+        raise Discourse::InvalidParameters,
+          custom_field.errors.full_messages.join("\n\n")
+      end
+    end
+    
+    all_fields_saved = true
+    
+    custom_fields.each do |field|
+      unless field.save
+        all_fields_saved = false
+      end
+    end
+    
+    if all_fields_saved
+      render json: success_json
+    else
+      render json: error_json
+    end
+  end
+  
+  private
+  
+  def custom_field_params
+    params.permit(
+      custom_fields: [
+        :klass,
+        :name,
+        :type,
+        serializers: []
+      ]
+    )
+  end
+end

controllers/custom_wizard/admin/wizard.rb

@@ -7,7 +7,8 @@ class CustomWizard::AdminWizardController < CustomWizard::AdminController
         CustomWizard::Wizard.list,
         each_serializer: CustomWizard::BasicWizardSerializer
       ),
-      field_types: CustomWizard::Field.types
+      field_types: CustomWizard::Field.types,
+      custom_fields: custom_field_list
     )
   end
   

lib/custom_wizard/action.rb

@@ -60,12 +60,18 @@ class CustomWizard::Action
   end
   
   def send_message
-    if action['required'].present? && data[action['required']].blank?
-      log_error(
-        "required not present",
-        "required: #{action['required']}; data: #{data[action['required']]}"
-      )
-      return
+
+    if action['required'].present?
+      required = CustomWizard::Mapper.new(
+        inputs: action['required'],
+        data: data,
+        user: user
+      ).perform
+            
+      if required.blank?
+        log_error("required input not present")
+        return
+      end
     end
     
     params = basic_topic_params
@@ -410,17 +416,32 @@ class CustomWizard::Action
         user: user
       ).perform
       
+      registered_fields = CustomWizard::CustomField.list
+      
       field_map.each do |field|
         keyArr = field[:key].split('.')
         value = field[:value]
         
-        if keyArr.first === 'topic'
+        if keyArr.length > 1
+          klass = keyArr.first
+          name = keyArr.last
+        else
+          name = keyArr.first
+        end
+         
+        
+        registered = registered_fields.select { |f| f.name == name }
+        if registered.first.present?
+          klass = registered.first.klass
+        end
+                
+        if klass === 'topic'
           params[:topic_opts] ||= {}
           params[:topic_opts][:custom_fields] ||= {}
-          params[:topic_opts][:custom_fields][keyArr.last] = value
+          params[:topic_opts][:custom_fields][name] = value
         else
           params[:custom_fields] ||= {}
-          params[:custom_fields][keyArr.last.to_sym] = value
+          params[:custom_fields][name] = value
         end
       end
     end

lib/custom_wizard/custom_field.rb

@@ -0,0 +1,82 @@
+class ::CustomWizard::CustomField
+  include HasErrors
+  include ActiveModel::Serialization
+  
+  CLASSES ||= ["topic", "group", "category", "post"]
+  SERIALIZERS ||= ["topic_view", "topic_list_item", "post", "basic_category"]
+  TYPES ||= ["string", "boolean", "json"]
+  ATTRS ||= ["name", "klass", "type", "serializers"]
+  KEY ||= "custom_wizard_custom_fields"
+  
+  def initialize(data)
+    data = data.with_indifferent_access
+    
+    ATTRS.each do |attr|
+      self.class.class_eval { attr_accessor attr }     
+      send("#{attr}=", data[attr]) if data[attr].present? 
+    end
+  end
+
+  def save
+    validate
+
+    if valid?
+      data = {}
+      name = nil
+      
+      ATTRS.each do |attr|
+        value = send(attr)
+        
+        if attr == 'name'
+          name = value.parameterize(separator: '_')
+        else
+          data[attr] = value
+        end
+      end
+      
+      PluginStore.set(KEY, name, data)
+    else
+      false
+    end
+  end
+  
+  def validate
+    ATTRS.each do |attr|
+      value = send(attr)
+      
+      if value.blank?
+        add_error("Attribute required: #{attr}")
+        next
+      end
+      
+      if attr == 'klass' && CLASSES.exclude?(value)
+        add_error("Unsupported class: #{value}")
+      end
+      
+      if attr == 'serializers' && (SERIALIZERS & value).empty?
+        add_error("Unsupported serializer: #{value}")
+      end
+      
+      if attr == 'type' && TYPES.exclude?(value)
+        add_error("Unsupported type: #{value}")
+      end
+      
+      if attr == 'name' && value.length < 3
+        add_error("Field name is too short")
+      end
+    end
+  end
+  
+  def valid?
+    errors.blank?
+  end
+  
+  def self.list
+    PluginStoreRow.where(plugin_name: KEY)
+      .map do |record|
+        data = JSON.parse(record.value)
+        data[:name] = record.key
+        self.new(data)
+      end
+  end
+end

plugin.rb

@@ -42,6 +42,7 @@ after_initialize do
     ../controllers/custom_wizard/admin/submissions.rb
     ../controllers/custom_wizard/admin/api.rb
     ../controllers/custom_wizard/admin/logs.rb
+    ../controllers/custom_wizard/admin/custom_fields.rb
     ../controllers/custom_wizard/wizard.rb
     ../controllers/custom_wizard/steps.rb
     ../controllers/custom_wizard/transfer.rb
@@ -51,6 +52,7 @@ after_initialize do
     ../lib/custom_wizard/action_result.rb
     ../lib/custom_wizard/action.rb
     ../lib/custom_wizard/builder.rb
+    ../lib/custom_wizard/custom_field.rb
     ../lib/custom_wizard/field.rb
     ../lib/custom_wizard/mapper.rb
     ../lib/custom_wizard/log.rb
@@ -68,6 +70,7 @@ after_initialize do
     ../serializers/custom_wizard/api_serializer.rb
     ../serializers/custom_wizard/basic_api_serializer.rb
     ../serializers/custom_wizard/basic_wizard_serializer.rb
+    ../serializers/custom_wizard/custom_field_serializer.rb
     ../serializers/custom_wizard/wizard_field_serializer.rb
     ../serializers/custom_wizard/wizard_step_serializer.rb
     ../serializers/custom_wizard/wizard_serializer.rb
@@ -160,5 +163,26 @@ after_initialize do
   
   CustomWizard::Wizard.register_styles
   
+  CustomWizard::CustomField.list.each do |field|
+    self.send("register_#{field.klass}_custom_field_type", field.name, field.type.to_sym)
+    
+    add_to_class(field.klass.to_sym, field.name.to_sym) do
+      custom_fields[field.name]
+    end
+    
+    if field.serializers.any?
+      field.serializers.each do |klass|
+        klass = klass.to_sym
+        add_to_serializer(klass, field.name.to_sym) do
+          if klass == :topic_view
+            object.topic.send(field.name)
+          else
+            object.send(field.name)
+          end
+        end
+      end
+    end
+  end
+  
   DiscourseEvent.trigger(:custom_wizard_ready)
 end

serializers/custom_wizard/custom_field_serializer.rb

@@ -0,0 +1,3 @@
+class CustomWizard::CustomFieldSerializer < ApplicationSerializer
+  attributes :klass, :name, :type, :serializers
+end