foreman_column_view 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5fc7034b17fb5621127dcabd0b0a011637f4fa7
-  data.tar.gz: d58f35cecb93132e6b95665076dc6d826044ef5a
+  metadata.gz: 942628959842bb592201db30bf188899ccf5c39d
+  data.tar.gz: d0efccf2714f26cc7d36e7e833893fb34d4e7f6e
 SHA512:
-  metadata.gz: 2efaceb1767dcf5b76046820b3b058293069bc9b31cbdef8346091bef441344fba9270df95f7adafd2fc473fad63a4bc8eb1994e561f69615edf01eef492df42
-  data.tar.gz: 9df1a938678999dc378eb6d439642af5128250dcda9ecf050ca0d88ec8e837f51eecf7f80d597f8fc1bdbc31f1e4ea4b67a384db7ebda289a326ff79598f665f
+  metadata.gz: 3d5c334da3404a7e3dbba931463d02d018ddfffa3cc015faf2200ce766dfe3aa241029d0abd6cf64d09c32a4a3717689c3c4129597d4a181856d499978a9f297
+  data.tar.gz: 839d22fe642884e4872ee6d73912897f14434478b5f45a3177fd9781895f003628b712c177603c311b64cbf81ded6f7899ece8cc4a1fced95120cb8d931aed32

data/README.md

@@ -1,21 +1,21 @@
 # foreman\_column\_view
 
 A small plugin to showcase the awesome [Deface](https://github.com/spree/deface)
-library. It simply adds a column to the Hosts list. It also serves as a simple example
-of including a new Helper in the plugin.
+library. It simply adds a column to the Hosts list or properties table. It also
+serves as a simple example of including a new Helper in the plugin.
 
 # Installation
 
-Require the gem in Foreman, and also Deface, in `bundler.d/Gemfile.local.rb`:
+Require the gem in Foreman (you may need extra dependencies such as libxml or libxslt
+to build the nokogiri dependency)
 
 ```yaml
-gem 'deface', '0.7.2'
-gem 'foreman_column_view', :git => "https://github.com/GregSutcliffe/foreman_column_view.git"
+gem 'foreman_column_view'
 ```
 
 Update Foreman with the new gems:
 
-    bundle update
+    bundle update foreman_column_view
 
 # Configuration
 
@@ -50,6 +50,41 @@ as well:
     :content: facts_hash['uptime']
 ```
 
+Additional rows can also be added to the Properties table on the host page by setting
+`:view: hosts_properties`.  The position is also controlled by `:after` using either a
+numeric index to represent the row or the name of the previous row (however this will
+not work well when the Foreman language is switched).  An example configuration:
+
+```yaml
+  :uptime:
+    :title: Uptime
+    :after: 6
+    :content: facts_hash['uptime']
+    :view: :hosts_properties
+```
+
+If you need to add information not readily available in a host, you can add information that
+will be evaluated on runtime by adding `:eval_content: true` to your additional row.
+Also, some times you do not want to show the additional row if a certain condition is not met,
+in order to show that row conditionally, add `:conditional: :condition_symbol` to your configuration,
+and that conditional will be executed on your host.
+
+As an example, the following yaml shows a link to a custom URL if the method host.bmc_available? is true.
+
+```yaml
+  :console:
+    :title: Console
+    :after: 0
+    :content: link_to(_("Console"), "https://#{host.interfaces.first.name}.domainname", { :class => "btn btn-info" } )
+    :conditional: :bmc_available?
+    :eval_content: true
+    :view: :hosts_properties
+```
+
+If your conditional method needs arguments to work, the arguments should go after the method name separated by
+spaces, as in `:custom_method arg1 arg2`
+
+
 You will need to restart Foreman for changes to take effect, as the `settings.yaml` is
 only read at startup.
 

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.license = "GPL-3"
   gem.summary = %Q{Column View Plugin for Foreman }
   gem.description = %Q{Displays an additional column in the Foreman Hosts view}
-  gem.email = "greg.sutclif@gmail.com"
+  gem.email = "greg.sutcliffe@gmail.com"
   gem.authors = ["Greg Sutcliffe"]
   # dependencies defined in Gemfile
 end

data/app/helpers/foreman_column_view/hosts_helper_extension.rb

@@ -0,0 +1,40 @@
+module ForemanColumnView
+  module HostsHelperExtension
+    def self.included(base)
+      base.send :alias_method_chain, :overview_fields, :fcv
+    end
+
+    # Extend core HostsHelper to add rows to Properties on hosts/show
+    def overview_fields_with_fcv host
+      fields = overview_fields_without_fcv(host)
+      valid_views = [:hosts_properties]
+
+      SETTINGS[:column_view].reject { |k,v| !valid_views.include?(v[:view]) }.keys.sort.map do |k|
+        after       = SETTINGS[:column_view][k.to_sym][:after]
+        conditional = SETTINGS[:column_view][k.to_sym][:conditional]
+        if conditional.present?
+          method = conditional[0].to_sym
+          args   = conditional.drop(1)
+        end
+
+        begin
+          next unless (conditional.present? && host.respond_to?(method) && host.send(method, *args)) ||
+                      (conditional.nil?)
+        rescue ArgumentError
+          Rails.logger.warn("Foreman_column_view: Your are supplying the wrong kind/number of arguments to your conditional method. Host #{host} , method - #{method} - arguments - #{args.join(', ')} ")
+          next
+        end
+
+        # This won't work well with i18n, use row numbers instead
+        after = fields.find_index { |r| r[0].include? after } unless after.is_a? Fixnum
+        eval_content = SETTINGS[:column_view][k.to_sym][:eval_content]
+        content = eval_content ? eval(SETTINGS[:column_view][k.to_sym][:content]) :
+                                 fcv_content(host, k)
+
+        fields.insert(after || -1, [fcv_title(k), content])
+      end
+
+      fields
+    end
+  end
+end

data/app/overrides/add_column_content.rb

@@ -1,5 +1,5 @@
 if SETTINGS[:column_view]
-  SETTINGS[:column_view].keys.sort.map do |k|
+  SETTINGS[:column_view].reject { |k,v| v[:view] && v[:view] != 'hosts_list' }.keys.sort.map do |k|
     after = SETTINGS[:column_view][k.to_sym][:after]
     Deface::Override.new(
       :virtual_path => "hosts/_list",

data/app/overrides/add_column_title.rb

@@ -1,5 +1,5 @@
 if SETTINGS[:column_view]
-  SETTINGS[:column_view].keys.sort.map do |k|
+  SETTINGS[:column_view].reject { |k,v| v[:view] && v[:view] != 'hosts_list' }.keys.sort.map do |k|
     after = SETTINGS[:column_view][k.to_sym][:after]
     Deface::Override.new(
       :virtual_path => "hosts/_list",

data/lib/foreman_column_view.rb

@@ -1,5 +1,4 @@
+require 'foreman_column_view/engine'
+
 module ForemanColumnView
-  if defined?(Rails) && Rails::VERSION::MAJOR == 3
-    require 'foreman_column_view/engine'
-  end
 end

data/lib/foreman_column_view/engine.rb

@@ -1,4 +1,6 @@
+require 'deface'
 require 'foreman_column_view'
+require 'deface'
 
 module ForemanColumnView
   #Inherit from the Rails module of the parent app (Foreman), not the plugin.
@@ -7,6 +9,9 @@ module ForemanColumnView
 
     initializer 'foreman_column_view.helper' do |app|
       ActionView::Base.send :include, ForemanColumnView::HostsHelper
+
+      # Extend core HostHelper to add rows to Properties on hosts/show
+      ::HostsHelper.send :include, ForemanColumnView::HostsHelperExtension
     end
 
   end

data/lib/foreman_column_view/version.rb

@@ -1,3 +1,3 @@
 module ForemanColumnView
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_column_view
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Greg Sutcliffe
@@ -34,6 +34,7 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- app/helpers/foreman_column_view/hosts_helper_extension.rb
 - app/helpers/foreman_column_view/hosts_helper.rb
 - app/overrides/add_column_title.rb
 - app/overrides/add_column_content.rb