foreman_custom_tab 0.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1ccbccc92505f23d7321d8abe5aabaa51aa8de8b
-  data.tar.gz: 4570d2c5e548fdf8afeeb5c4eb3c4edaa2d07968
+SHA256:
+  metadata.gz: fab57529be3fc7afdc27762df54dce297ee7a05de2dbe7442d6928f2c0f46430
+  data.tar.gz: 89cbbe7c14ac0131f2c94b03f5bfcc46b37f4655e7416804276b3ab4be8a7b0b
 SHA512:
-  metadata.gz: 2ad9b056e8ba6eabb6d112f279de450f0b4274fac85f9009ef0cb25c845725794c92328284eea8040bc70ad87af1cfe6f026b44cd34da639b858ba520ff78ac3
-  data.tar.gz: b4db88c4325ff99d035c197e7758dd36adaa59db1c2d57b203d891ab81716161f53594bedea2815670432ebfc126dfe2806438eeb7f6a4140b4d57b8b4cacb52
+  metadata.gz: ee289ad795f603726360ceec9f617b724dfcac053189206e33b61aa38288083b4402a211d5e64262e114903acbe6dc9cbd4f9d6088bd7ab5ddc80866fb5840b6
+  data.tar.gz: 9c15dc80e341818d98740c7b0b9c3a4b5d4a18a3206b187808359c7e7088d93388fbc6f2fac346361b765bbf5e1384d533a0f7891951d26b523efa51b6e8a8b5

data/README.md

@@ -14,7 +14,7 @@ bundle update foreman_custom_tab
 
 ## Configuration
 
-If there is no configuration file then the tab should not appear on the detailed hosts screen, but if 
+If there is no configuration file then the tab should not appear on the detailed hosts screen, but if
 there is one and it is empty then it will appear without any fields. To setup the configuration file create
 a new file named 'foreman_custom_tab.yaml' at the location /etc/foreman/plugins/
 
@@ -23,16 +23,19 @@ The keys are the display title and the values are the methods that are actually
 Example configuration:
 
 ```
+---
 :custom_tab:
-  :fields:
-    'Host Name': name
-    'MAC Address': mac
-    'IP Address': ip
-    'Architecture': arch
-    'Certificate Name': certname
-    'OS Title': operatingsystem.title
-    'OS Type': operatingsystem.type
   :title: foo
+  :fields:
+    Host Name: name
+    MAC Address: mac
+    IP Address: ip
+    Architecture: arch
+    Certificate Name: certname
+    OS Title: operatingsystem.title
+    OS Type: operatingsystem.type
+    Puppet Version: facts[puppetversion]
+    Ruby Version: facts.fetch(rubyversion)
 ```
 
 ## Verify the Custom Tab is loaded
@@ -49,7 +52,7 @@ Note: foreman running locally (i.e not installed via rpm/debian package) does no
 
 ## Notes
 
-This project is still incomplete and in development. 
+This project is still incomplete and in development.
 
 Copyright (c) 2017 Joe Lyons Stannard III
 
@@ -65,4 +68,3 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
-

data/Rakefile

@@ -20,7 +20,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 Bundler::GemHelper.install_tasks
 
@@ -38,7 +38,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue StandardError => _
+rescue StandardError => _e
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/concerns/foreman_custom_tab/hosts_controller_extensions.rb

@@ -8,8 +8,8 @@ module ForemanCustomTab
       # it'll override the default find_resource filter.
       find_resource
       render :partial => 'foreman_custom_tab/hosts/custom_tab', :locals => { :host => @host }
-    rescue ActionView::Template::Error => exception
-      process_ajax_error exception, 'fetch custom tab information'
+    rescue ActionView::Template::Error => e
+      process_ajax_error e, 'fetch custom tab information'
     end
 
     private

data/app/helpers/concerns/foreman_custom_tab/hosts_helper_extensions.rb

@@ -6,10 +6,15 @@ module ForemanCustomTab
       fields = []
       config_fields = SETTINGS[:custom_tab][:fields] || []
       config_fields.each do |key, value|
-        host_attr_val = nil
         # chain the method calls for attibutes like operatingsystem.title
-        value.split('.').each_with_index do |method, index|
-          host_attr_val = index.eql?(0) ? host.try(method) : host_attr_val.try(method)
+        host_attr_val = value.split('.').inject(host) do |memo, method|
+          if (m = method.match(/(.*)\((.*)\)/))
+            memo.try(m[1], *m[2].split(/,\s?/))
+          elsif (m = method.match(/(.*)\[(.*)\]/))
+            memo.try(m[1]).try('[]', m[2])
+          else
+            memo.try(method)
+          end
         end
         fields += [[_(key.to_s), host_attr_val]] if host_attr_val.present?
       end

data/app/overrides/{add_tab.rb → custom_tab_add_tab.rb}

@@ -1,7 +1,7 @@
 if SETTINGS[:custom_tab]
   Deface::Override.new(:virtual_path => 'hosts/show',
-                       :name => 'add_tab_link',
-                       :insert_bottom => 'ul#myTab',
+                       :name => 'custom_tab_add_tab',
+                       :insert_bottom => 'ul#host-show-tabs',
                        :text =>
                        "<li><a href='#custom_tab' data-toggle='tab'><%= _(custom_tab_title) %></a></li>")
 end

data/app/overrides/{add_tab_link.rb → custom_tab_add_tab_link.rb}

@@ -1,7 +1,7 @@
 if SETTINGS[:custom_tab]
   Deface::Override.new(:virtual_path => 'hosts/show',
-                       :name => 'create_link',
-                       :insert_bottom => 'div#myTabContent',
+                       :name => 'custom_tab_add_tab_link',
+                       :insert_bottom => 'div#host-show-tabs-content',
                        :text =>
                        "\n  <div id='custom_tab' class='tab-pane'
                        data-ajax-url='<%= custom_tab_host_path(@host)%>' data-on-complete='onContentLoad'>

data/config/routes.rb

@@ -1,5 +1,5 @@
 Rails.application.routes.draw do
-  constraints(:id => %r{[^\/]+}) do
+  constraints(:id => %r{[^/]+}) do
     resources :hosts do
       member do
         get 'custom_tab'

data/lib/foreman_custom_tab/engine.rb

@@ -17,10 +17,10 @@ module ForemanCustomTab
     # http://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Plugin#Adding-permission
     initializer('foreman_custom_tab.register_plugin', :before => :finisher_hook) do
       Foreman::Plugin.register :foreman_custom_tab do
-        requires_foreman '>= 1.7'
+        requires_foreman '>= 2.3'
 
         security_block :foreman_custom_tab do
-          permission :view_hosts,
+          permission :view_custom_tab,
                      { :hosts => [:custom_tab] },
                      :resource_type => 'Host'
         end
@@ -31,17 +31,14 @@ module ForemanCustomTab
     # Include concerns in this config.to_prepare block
     # http://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Plugin#Extending-a-Controller
     config.to_prepare do
-      begin
-        HostsHelper.send(:include, ForemanCustomTab::HostsHelperExtensions)
-        ::HostsController.send(:include,
-                               ForemanCustomTab::HostsControllerExtensions)
-      rescue StandardError => e
-        Rails.logger.warn "ForemanCustomTab: skipping engine hook (#{e})"
-      end
+      HostsHelper.include ForemanCustomTab::HostsHelperExtensions
+      ::HostsController.include ForemanCustomTab::HostsControllerExtensions
+    rescue StandardError => e
+      Rails.logger.warn "ForemanCustomTab: skipping engine hook (#{e})"
     end
 
     initializer 'foreman_custom_tab.register_gettext', after: :load_config_initializers do |_app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
       locale_domain = 'foreman_custom_tab'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end

data/lib/foreman_custom_tab/version.rb

@@ -1,3 +1,3 @@
 module ForemanCustomTab
-  VERSION = '0.1.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/tasks/foreman_custom_tab_tasks.rake

@@ -11,7 +11,7 @@ namespace :test do
 end
 
 namespace :foreman_custom_tab do
-  task :rubocop do
+  task rubocop: :environment do
     begin
       require 'rubocop/rake_task'
       RuboCop::RakeTask.new(:rubocop_foreman_custom_tab) do |task|

data/test/functional/concerns/hosts_controller_extensions_test.rb

@@ -4,24 +4,24 @@ class HostsControllerTest < ActionController::TestCase
   let(:os) { FactoryBot.create(:operatingsystem, name: 'CentOS', major: '7', type: 'Redhat') }
   let(:arch) { FactoryBot.create(:architecture) }
   let(:host_id) { 'foreman.example.com' }
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   let(:host) { FactoryBot.create(:host, id: host_id, mac: '00:00:00:00:00:00', ip: '127.0.0.1', operatingsystem: os, arch: arch) }
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength
   let(:custom_tab_title) { SETTINGS[:custom_tab][:title] }
 
-  # rubocop:disable Metrics/LineLength, Style/StringLiterals, HttpPositionalArguments
+  # rubocop:disable Layout/LineLength, Style/StringLiterals, Rails/HttpPositionalArguments
   test 'GET hosts/:id displays tabs' do
     get :show, { :id => host.id }, set_session_user
     assert_includes response.headers['Content-Type'], 'text/html'
     assert_equal response.status, 200
-    assert_includes response.body, "ul id=\"myTab\""
+    assert_includes response.body, "ul id=\"host-show-tabs\""
   end
 
   test "host overview displays tabs 'Properties', 'Metrics', 'NICs'" do
     get :show, { :id => host.id }, set_session_user
     assert_includes response.headers['Content-Type'], 'text/html'
     assert_equal response.status, 200
-    assert_includes response.body, "<ul id=\"myTab\""
+    assert_includes response.body, "<ul id=\"host-show-tabs\""
     assert_includes response.body, "<li class=\"active\"><a href=\"#properties\" data-toggle=\"tab\">Properties</a></li>"
     assert_includes response.body, "<li><a href=\"#metrics\" data-toggle=\"tab\">Metrics</a></li>"
     assert_includes response.body, "<li><a href=\"#nics\" data-toggle=\"tab\">NICs</a></li>"
@@ -30,7 +30,7 @@ class HostsControllerTest < ActionController::TestCase
   test "host overview displays the Custom Tab" do
     get :show, { :id => host.id }, set_session_user
     assert_includes response.headers['Content-Type'], 'text/html'
-    assert_includes response.body, "<ul id=\"myTab\""
+    assert_includes response.body, "<ul id=\"host-show-tabs\""
     assert_equal response.status, 200
     assert_includes response.body, "<li><a href=\"#custom_tab\" data-toggle=\"tab\">#{custom_tab_title}</a></li>"
   end
@@ -40,7 +40,7 @@ class HostsControllerTest < ActionController::TestCase
 
     assert_equal response.status, 200
     assert_includes response.headers['Content-Type'], 'text/html'
-    assert_includes response.body, "<ul id=\"myTab\""
+    assert_includes response.body, "<ul id=\"host-show-tabs\""
     assert_includes response.body, "<li><a href=\"#custom_tab\" data-toggle=\"tab\">#{custom_tab_title}</a></li>"
     assert_includes response.body, "<div id=\"custom_tab\" class=\"tab-pane\" data-ajax-url=\"/hosts/#{host.name}/custom_tab\" data-on-complete=\"onContentLoad\">"
   end
@@ -70,5 +70,5 @@ class HostsControllerTest < ActionController::TestCase
       end
     end
   end
-  # rubocop:enable Metrics/LineLength, Style/StringLiterals, HttpPositionalArguments
+  # rubocop:enable Layout/LineLength, Style/StringLiterals, Rails/HttpPositionalArguments
 end

data/test/helpers/concerns/foreman_custom_tab/hosts_helper_extensions_test.rb

@@ -5,9 +5,9 @@ class HostsHelperExtensionsTest < ActiveSupport::TestCase
 
   let(:os) { FactoryBot.create(:operatingsystem, name: 'CentOS', major: '7', type: 'Redhat') }
   let(:arch) { FactoryBot.create(:architecture) }
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   let(:host) { FactoryBot.create(:host, id: 'foreman.example.com', mac: '00:00:00:00:00:00', ip: '127.0.0.1', operatingsystem: os, arch: arch) }
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength
   let(:expected_fields) do
     fields = []
     SETTINGS[:custom_tab][:fields].each do |title, host_attr|

data/test/test_plugin_helper.rb

@@ -6,7 +6,8 @@ SETTINGS[:custom_tab] = { fields: { 'Host Name' => 'name',
                                     'Architecture' => 'arch',
                                     'Certificate Name' => 'certname',
                                     'OS Title' => 'operatingsystem.title',
-                                    'OS Type' => 'operatingsystem.type' },
+                                    'OS Type' => 'operatingsystem.type',
+                                    'Puppet Version' => 'facts[puppetversion]' },
                           title: 'foo' }
 
 # This calls the main test_helper in Foreman-core

data/test/views/foreman_custom_tab/hosts/_custom_tab_test.rb

@@ -3,20 +3,20 @@ require 'test_plugin_helper'
 class CustomTabTest < ActionView::TestCase
   let(:os) { FactoryBot.create(:operatingsystem, name: 'CentOS', major: '7', type: 'Redhat') }
   let(:arch) { FactoryBot.create(:architecture) }
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   let(:host) { FactoryBot.create(:host, id: 'foreman.example.com', mac: '00:00:00:00:00:00', ip: '127.0.0.1', operatingsystem: os, arch: arch) }
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength
   let(:custom_tab_title) { SETTINGS[:custom_tab][:title] }
 
-  class FakeHostsController < ActionController::Base
+  class FakeHostsController < ApplicationController
     include ForemanCustomTab::HostsHelperExtensions
     include LayoutHelper
 
     def index
       os = FactoryBot.create(:operatingsystem, name: 'CentOS', major: '7', type: 'Redhat')
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
       @host = FactoryBot.create(:host, id: 'foreman.example.com', mac: '00:00:00:00:00:00', ip: '127.0.0.1', operatingsystem: os, arch: FactoryBot.create(:architecture))
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
       render :partial => 'foreman_custom_tab/hosts/custom_tab', :locals => { :host => @host }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_custom_tab
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Joe Stannard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Foreman Plugin that makes a new tab with different fields depending on
   the settings file
 email:
@@ -51,8 +65,8 @@ files:
 - Rakefile
 - app/controllers/concerns/foreman_custom_tab/hosts_controller_extensions.rb
 - app/helpers/concerns/foreman_custom_tab/hosts_helper_extensions.rb
-- app/overrides/add_tab.rb
-- app/overrides/add_tab_link.rb
+- app/overrides/custom_tab_add_tab.rb
+- app/overrides/custom_tab_add_tab_link.rb
 - app/views/foreman_custom_tab/hosts/_custom_tab.html.erb
 - config/foreman_custom_tab.yaml.example
 - config/routes.rb
@@ -81,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -89,13 +103,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Creates custom tab for hosts in Foreman
 test_files:
-- test/test_plugin_helper.rb
 - test/functional/concerns/hosts_controller_extensions_test.rb
+- test/helpers/concerns/foreman_custom_tab/hosts_helper_extensions_test.rb
+- test/test_plugin_helper.rb
 - test/unit/foreman_custom_tab_test.rb
 - test/views/foreman_custom_tab/hosts/_custom_tab_test.rb
-- test/helpers/concerns/foreman_custom_tab/hosts_helper_extensions_test.rb