foreman_templates 7.0.4 → 7.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af1ba67f8fecbac048a7e1a4cc49f7b080ab03d4
-  data.tar.gz: bc498b963b11bacdb250a58b02e29b69ef672f4b
+  metadata.gz: 773f26f24c7e56569b70ae180164487a804c89a6
+  data.tar.gz: 13138a1fd87a675c222333e57e7c2ea78a1489c0
 SHA512:
-  metadata.gz: '09b4a9585c049f5d3ad634fff4297445bccfeb5391d05e9c1f61c967b58016da51977a8a2c642b39563389f0a6339f053b08c2b955403ad120d4bee83d6be31e'
-  data.tar.gz: f067aac3c5da05df39fc7159400b77be6c2f4a64cda445892a8eebdb3a03af233189d3d1a7de4e76348cb87766d54e094228ffac5e2c823f68e4097d84dec514
+  metadata.gz: eecbb9e4993ab19b071dfa052290e45b9ee14d50e62b99984de31ea8f28a3a9c48b19bbc06ce17ccab1fdccd325e8016dbc2e1ea7d1a5c13c9520fbd096498d0
+  data.tar.gz: c2091508b18ecb0396564782b809e0e9e69c1489389a0cee5397c7c9a39dab1c2e46954486efd75de2f41b41a01090d8b0db03984b60dc392edf923c9d41b9fc

data/app/controllers/concerns/foreman/controller/parameters/template_params.rb

@@ -7,7 +7,7 @@ module Foreman
 
         class_methods do
           def filter_params_list
-            %i(verbose repo branch dirname filter negate metadata_export_mode dirname)
+            %i(verbose repo branch dirname filter negate metadata_export_mode)
           end
 
           def extra_import_params

data/app/models/concerns/foreman_templates/template_extensions.rb

@@ -0,0 +1,11 @@
+require 'shellwords'
+
+module ForemanTemplates
+  module TemplateExtensions
+    extend ActiveSupport::Concern
+
+    def template_file
+      Shellwords.escape(name.downcase.tr(' /', '_') + '.erb')
+    end
+  end
+end

data/app/models/setting/template_sync.rb

@@ -3,11 +3,11 @@ class Setting
     self.include_root_in_json = false
 
     def self.common_stripped_names
-      %w(verbose repo branch dir filter negate)
+      %w(verbose repo branch dirname filter negate)
     end
 
     def self.import_stripped_names
-      %w(prefix associate force)
+      %w(prefix associate force lock)
     end
 
     def self.export_stripped_names
@@ -67,11 +67,11 @@ class Setting
         [
           self.set('template_sync_verbose', N_('Choose verbosity for Rake task importing templates'), false, N_('Verbosity')),
           self.set('template_sync_associate', N_('Associate templates to OS, organization and location'), 'new', N_('Associate'), nil, { :collection => Proc.new { self.associate_types } }),
-          self.set('template_sync_prefix', N_('The string all imported templates should begin with'), "", N_('Prefix')),
+          self.set('template_sync_prefix', N_('The string that will be added as prefix to imported templates'), "", N_('Prefix')),
           self.set('template_sync_dirname', N_('The directory within the Git repo containing the templates'), '/', N_('Dirname')),
-          self.set('template_sync_filter', N_('Import or export names matching this regex (case-insensitive; snippets are not filtered)'), '', N_('Filter')),
-          self.set('template_sync_repo', N_('Target path to import and export. Different protocols can be used, e.g. /tmp/dir, git://example.com, https://example.com, ssh://example.com'), 'https://github.com/theforeman/community-templates.git', N_('Repo')),
-          self.set('template_sync_negate', N_('Negate the prefix (for purging) / filter (for importing/exporting)'), false, N_('Negate')),
+          self.set('template_sync_filter', N_('Import/export names matching this regex (case-insensitive; snippets are not filtered)'), '', N_('Filter')),
+          self.set('template_sync_repo', N_('Target path to import/export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.'), 'https://github.com/theforeman/community-templates.git', N_('Repo')),
+          self.set('template_sync_negate', N_('Negate the filter for import/export'), false, N_('Negate')),
           self.set('template_sync_branch', N_('Default branch in Git repo'), '', N_('Branch')),
           self.set('template_sync_metadata_export_mode', N_('Default metadata export mode, refresh re-renders metadata, keep will keep existing metadata, remove exports template without metadata'), 'refresh', N_('Metadata export mode'), nil, { :collection => Proc.new { self.metadata_export_mode_types } }),
           self.set('template_sync_force', N_('Should importing overwrite locked templates?'), false, N_('Force import')),

data/app/services/foreman_templates/action.rb

@@ -46,7 +46,7 @@ module ForemanTemplates
 
     def verify_path!(path)
       msg = _("Using file-based synchronization, but couldn't access %s. ") % path
-      msg += _("Please check the access permissions/SELinux and make sure it is readable/writable for the web application user account, typically 'foreman'.")
+      msg += _("Please check the access permissions/SELinux and make sure it is readable/writable for the web application user account, typically '%s'.") % 'foreman'
       raise PathAccessException, msg unless Dir.exist?(path)
     end
 

data/app/services/foreman_templates/template_exporter.rb

@@ -1,5 +1,3 @@
-require 'shellwords'
-
 module ForemanTemplates
   class TemplateExporter < Action
     def self.setting_overrides
@@ -72,7 +70,7 @@ module ForemanTemplates
         templates.map do |template|
           current_dir = get_dump_dir(template)
           FileUtils.mkdir_p current_dir
-          filename = File.join(current_dir, get_template_filename(template))
+          filename = File.join(current_dir, template.template_file)
           File.open(filename, 'w+') do |file|
             logger.debug "Writing to file #{filename}"
             bytes = file.write template.public_send(export_method)
@@ -85,10 +83,6 @@ module ForemanTemplates
       @export_result.add_exported_templates templates
     end
 
-    def get_template_filename(template)
-      Shellwords.escape(template.name.downcase.tr(' /', '_') + '.erb')
-    end
-
     def get_dump_dir(template)
       kind = template.respond_to?(:template_kind) ? template.template_kind.try(:name) || 'snippet' : nil
       template_class_dir = template.model_name.plural

data/app/views/ui_template_syncs/template_export_result.rabl

@@ -1,6 +1,6 @@
 object @template
 
-attributes :name
+attributes :name, :template_file
 
 node(false) do |template|
   partial "ui_template_syncs/template_attrs", :object => template

data/lib/foreman_templates/engine.rb

@@ -50,5 +50,9 @@ module ForemanTemplates
              :turbolinks => false
       end
     end
+
+    config.to_prepare do
+      Template.include ForemanTemplates::TemplateExtensions
+    end
   end
 end

data/lib/foreman_templates/version.rb

@@ -1,3 +1,3 @@
 module ForemanTemplates
-  VERSION = '7.0.4'.freeze
+  VERSION = '7.0.5'.freeze
 end

data/webpack/components/NewTemplateSync/__fixtures__/templateSyncSettings.fixtures.js

@@ -5,6 +5,7 @@ export const associateSetting = Immutable({
   value: 'new',
   settingsType: 'string',
   name: 'associate',
+  description: 'Associate templates to OS, organization and location',
   selection: [
     { value: 'new', label: 'New' },
     { value: 'never', label: 'Never' },
@@ -17,6 +18,7 @@ export const forceSetting = Immutable({
   value: false,
   settingsType: 'bool',
   name: 'force',
+  description: 'Should importing overwrite locked templates?',
 });
 
 export const importSettings = [associateSetting, forceSetting];
@@ -26,6 +28,8 @@ export const filterSetting = Immutable({
   value: '',
   settingsType: 'string',
   name: 'filter',
+  description:
+    'Import or export names matching this regex (case-insensitive; snippets are not filtered)',
 });
 
 export const negateSetting = Immutable({
@@ -33,6 +37,7 @@ export const negateSetting = Immutable({
   value: false,
   settingsType: 'bool',
   name: 'negate',
+  description: 'Negate the filter for import/export',
 });
 
 export const repoSetting = Immutable({
@@ -40,6 +45,8 @@ export const repoSetting = Immutable({
   value: 'https://github.com/theforeman/community-templates.git',
   settingsType: 'string',
   name: 'repo',
+  description:
+    'Target path to import and export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.',
 });
 
 export const exportSettings = [filterSetting, negateSetting, repoSetting];

data/webpack/components/NewTemplateSync/__tests__/__snapshots__/NewTemplateSyncReducer.test.js.snap

@@ -23,18 +23,21 @@ Object {
   "error": "",
   "exportSettings": Array [
     Object {
+      "description": "Import or export names matching this regex (case-insensitive; snippets are not filtered)",
       "id": 47,
       "name": "filter",
       "settingsType": "string",
       "value": "",
     },
     Object {
+      "description": "Negate the filter for import/export",
       "id": 48,
       "name": "negate",
       "settingsType": "bool",
       "value": false,
     },
     Object {
+      "description": "Target path to import and export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.",
       "id": 49,
       "name": "repo",
       "settingsType": "string",
@@ -43,6 +46,7 @@ Object {
   ],
   "importSettings": Array [
     Object {
+      "description": "Associate templates to OS, organization and location",
       "id": 45,
       "name": "associate",
       "selection": Array [
@@ -63,6 +67,7 @@ Object {
       "value": "new",
     },
     Object {
+      "description": "Should importing overwrite locked templates?",
       "id": 46,
       "name": "force",
       "settingsType": "bool",

data/webpack/components/NewTemplateSync/__tests__/__snapshots__/NewTemplateSyncSelectors.test.js.snap

@@ -3,18 +3,21 @@
 exports[`NewTemplateSyncSelectors should return export settings 1`] = `
 Array [
   Object {
+    "description": "Import or export names matching this regex (case-insensitive; snippets are not filtered)",
     "id": 47,
     "name": "filter",
     "settingsType": "string",
     "value": "",
   },
   Object {
+    "description": "Negate the filter for import/export",
     "id": 48,
     "name": "negate",
     "settingsType": "bool",
     "value": false,
   },
   Object {
+    "description": "Target path to import and export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.",
     "id": 49,
     "name": "repo",
     "settingsType": "string",
@@ -26,6 +29,7 @@ Array [
 exports[`NewTemplateSyncSelectors should return import settings 1`] = `
 Array [
   Object {
+    "description": "Associate templates to OS, organization and location",
     "id": 45,
     "name": "associate",
     "selection": Array [
@@ -46,6 +50,7 @@ Array [
     "value": "new",
   },
   Object {
+    "description": "Should importing overwrite locked templates?",
     "id": 46,
     "name": "force",
     "settingsType": "bool",

data/webpack/components/NewTemplateSync/components/NewTemplateSyncForm/__tests__/__snapshots__/NewTemplateSyncForm.test.js.snap

@@ -28,18 +28,21 @@ exports[`NewTemplateSyncForm should render for export settings 1`] = `
     exportSettings={
       Array [
         Object {
+          "description": "Import or export names matching this regex (case-insensitive; snippets are not filtered)",
           "id": 47,
           "name": "filter",
           "settingsType": "string",
           "value": "",
         },
         Object {
+          "description": "Negate the filter for import/export",
           "id": 48,
           "name": "negate",
           "settingsType": "bool",
           "value": false,
         },
         Object {
+          "description": "Target path to import and export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.",
           "id": 49,
           "name": "repo",
           "settingsType": "string",
@@ -50,6 +53,7 @@ exports[`NewTemplateSyncForm should render for export settings 1`] = `
     importSettings={
       Array [
         Object {
+          "description": "Associate templates to OS, organization and location",
           "id": 45,
           "name": "associate",
           "selection": Array [
@@ -70,6 +74,7 @@ exports[`NewTemplateSyncForm should render for export settings 1`] = `
           "value": "new",
         },
         Object {
+          "description": "Should importing overwrite locked templates?",
           "id": 46,
           "name": "force",
           "settingsType": "bool",
@@ -119,18 +124,21 @@ exports[`NewTemplateSyncForm should render when for import settings 1`] = `
     exportSettings={
       Array [
         Object {
+          "description": "Import or export names matching this regex (case-insensitive; snippets are not filtered)",
           "id": 47,
           "name": "filter",
           "settingsType": "string",
           "value": "",
         },
         Object {
+          "description": "Negate the filter for import/export",
           "id": 48,
           "name": "negate",
           "settingsType": "bool",
           "value": false,
         },
         Object {
+          "description": "Target path to import and export. Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com. When exporting to /tmp, note that production deployments may be configured to use private tmp.",
           "id": 49,
           "name": "repo",
           "settingsType": "string",
@@ -141,6 +149,7 @@ exports[`NewTemplateSyncForm should render when for import settings 1`] = `
     importSettings={
       Array [
         Object {
+          "description": "Associate templates to OS, organization and location",
           "id": 45,
           "name": "associate",
           "selection": Array [
@@ -161,6 +170,7 @@ exports[`NewTemplateSyncForm should render when for import settings 1`] = `
           "value": "new",
         },
         Object {
+          "description": "Should importing overwrite locked templates?",
           "id": 46,
           "name": "force",
           "settingsType": "bool",

data/webpack/components/NewTemplateSync/components/NewTemplateSyncForm/__tests__/__snapshots__/NewTemplateSyncFormSelectors.test.js.snap

@@ -13,6 +13,7 @@ Object {
 exports[`NewTemplateSyncFormSelectors should return registered fields 1`] = `
 Object {
   "associate": Object {
+    "description": "Associate templates to OS, organization and location",
     "id": 45,
     "name": "associate",
     "selection": Array [
@@ -33,6 +34,7 @@ Object {
     "value": "new",
   },
   "force": Object {
+    "description": "Should importing overwrite locked templates?",
     "id": 46,
     "name": "force",
     "settingsType": "bool",

data/webpack/components/NewTemplateSync/components/NewTemplateSyncForm/index.js

@@ -38,7 +38,4 @@ const mapStateToProps = (state, ownProps) => {
 const form = reduxForm({ form: NEW_TEMPLATE_SYNC_FORM_NAME })(
   NewTemplateSyncForm
 );
-export default connect(
-  mapStateToProps,
-  FormActions
-)(form);
+export default connect(mapStateToProps, FormActions)(form);

data/webpack/components/NewTemplateSync/components/SyncSettingField.js

@@ -24,6 +24,14 @@ const SyncSettingField = ({ setting, resetField, disabled }) => {
     resetField(settingName, settingValue);
   };
 
+  const tooltipContent = (
+    <div
+      dangerouslySetInnerHTML={{
+        __html: setting.description,
+      }}
+    />
+  );
+
   return (
     <TextButtonField
       name={setting.name}
@@ -38,7 +46,7 @@ const SyncSettingField = ({ setting, resetField, disabled }) => {
       disabled={disabled}
       fieldRequired={setting.required}
       validate={setting.validate}
-      tooltipHelp={<FieldLevelHelp content={setting.description} />}
+      tooltipHelp={<FieldLevelHelp content={tooltipContent} />}
     >
       {setting.value}
     </TextButtonField>

data/webpack/components/NewTemplateSync/components/SyncSettingFields.js

@@ -1,5 +1,5 @@
 import React from 'react';
-import { memoize } from 'lodash';
+import { memoize, upperFirst } from 'lodash';
 import PropTypes from 'prop-types';
 
 import SyncSettingField from './SyncSettingField';
@@ -34,12 +34,33 @@ const SyncSettingsFields = ({
         })
       : setting;
 
+  const modifyDescription = (setting, type) => {
+    if (setting.description) {
+      let split = setting.description.split('. ');
+      if (setting.name === 'repo' && type !== 'export') {
+        split = split.slice(0, split.length - 1);
+      }
+
+      split = split.join('.<br>');
+      return setting.set('description', split);
+    }
+    return setting;
+  };
+
+  const specializeDescription = (setting, type) =>
+    setting.set(
+      'description',
+      upperFirst(setting.description.replace(/import\/export/i, type))
+    );
+
   const settingsAry = syncType === 'import' ? importSettings : exportSettings;
 
   return (
     <React.Fragment>
       {settingsAry
         .map(setting => addValidationToSetting(setting, validationData))
+        .map(setting => modifyDescription(setting, syncType))
+        .map(setting => specializeDescription(setting, syncType))
         .map(setting => (
           <SyncSettingField
             setting={setting}

data/webpack/components/NewTemplateSync/components/__tests__/__snapshots__/SyncSettingField.test.js.snap

@@ -18,6 +18,7 @@ exports[`SyncSettingField should render boolean setting as checkbox 1`] = `
   inputClassName="col-md-6"
   item={
     Object {
+      "description": "Should importing overwrite locked templates?",
       "id": 46,
       "name": "force",
       "settingsType": "bool",
@@ -29,7 +30,15 @@ exports[`SyncSettingField should render boolean setting as checkbox 1`] = `
   tooltipHelp={
     <FieldLevelHelp
       buttonClass=""
-      content={null}
+      content={
+        <div
+          dangerouslySetInnerHTML={
+            Object {
+              "__html": "Should importing overwrite locked templates?",
+            }
+          }
+        />
+      }
       placement="top"
       rootClose={true}
     />
@@ -56,6 +65,7 @@ exports[`SyncSettingField should render setting with input field 1`] = `
   inputClassName="col-md-6"
   item={
     Object {
+      "description": "Import or export names matching this regex (case-insensitive; snippets are not filtered)",
       "id": 47,
       "name": "filter",
       "settingsType": "string",
@@ -67,7 +77,15 @@ exports[`SyncSettingField should render setting with input field 1`] = `
   tooltipHelp={
     <FieldLevelHelp
       buttonClass=""
-      content={null}
+      content={
+        <div
+          dangerouslySetInnerHTML={
+            Object {
+              "__html": "Import or export names matching this regex (case-insensitive; snippets are not filtered)",
+            }
+          }
+        />
+      }
       placement="top"
       rootClose={true}
     />
@@ -94,6 +112,7 @@ exports[`SyncSettingField should render setting with select choices 1`] = `
   inputClassName="col-md-6"
   item={
     Object {
+      "description": "Associate templates to OS, organization and location",
       "id": 45,
       "name": "associate",
       "selection": Array [
@@ -119,7 +138,15 @@ exports[`SyncSettingField should render setting with select choices 1`] = `
   tooltipHelp={
     <FieldLevelHelp
       buttonClass=""
-      content={null}
+      content={
+        <div
+          dangerouslySetInnerHTML={
+            Object {
+              "__html": "Associate templates to OS, organization and location",
+            }
+          }
+        />
+      }
       placement="top"
       rootClose={true}
     />

data/webpack/components/NewTemplateSync/components/__tests__/__snapshots__/SyncSettingFields.test.js.snap

@@ -8,6 +8,7 @@ exports[`SyncSettingFields should show export settings 1`] = `
     resetField={[Function]}
     setting={
       Object {
+        "description": "Import or export names matching this regex (case-insensitive; snippets are not filtered)",
         "id": 47,
         "name": "filter",
         "settingsType": "string",
@@ -21,6 +22,7 @@ exports[`SyncSettingFields should show export settings 1`] = `
     resetField={[Function]}
     setting={
       Object {
+        "description": "Negate the filter for export",
         "id": 48,
         "name": "negate",
         "settingsType": "bool",
@@ -34,6 +36,7 @@ exports[`SyncSettingFields should show export settings 1`] = `
     resetField={[Function]}
     setting={
       Object {
+        "description": "Target path to import and export.<br>Different protocols can be used, for example /tmp/dir, git://example.com, https://example.com, ssh://example.com.<br>When exporting to /tmp, note that production deployments may be configured to use private tmp.",
         "id": 49,
         "name": "repo",
         "required": true,
@@ -56,6 +59,7 @@ exports[`SyncSettingFields should show import settings 1`] = `
     resetField={[Function]}
     setting={
       Object {
+        "description": "Associate templates to OS, organization and location",
         "id": 45,
         "name": "associate",
         "selection": Array [
@@ -83,6 +87,7 @@ exports[`SyncSettingFields should show import settings 1`] = `
     resetField={[Function]}
     setting={
       Object {
+        "description": "Should importing overwrite locked templates?",
         "id": 46,
         "name": "force",
         "settingsType": "bool",

data/webpack/components/NewTemplateSync/index.js

@@ -20,10 +20,7 @@ const permissionList = (
 );
 
 export default withProtectedView(
-  connect(
-    mapStateToProps,
-    TemplateSyncActions
-  )(NewTemplateSync),
+  connect(mapStateToProps, TemplateSyncActions)(NewTemplateSync),
   PermissionDenied,
   props =>
     props.userPermissions &&

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_templates
 version: !ruby/object:Gem::Version
-  version: 7.0.4
+  version: 7.0.5
 platform: ruby
 authors:
 - Greg Sutcliffe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -68,6 +68,7 @@ files:
 - app/controllers/template_syncs_controller.rb
 - app/controllers/ui_template_syncs_controller.rb
 - app/helpers/foreman_templates_helper.rb
+- app/models/concerns/foreman_templates/template_extensions.rb
 - app/models/setting/template_sync.rb
 - app/services/foreman_templates/action.rb
 - app/services/foreman_templates/cleaner.rb