foreman_custom_banner 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02f911ea973e0dcb2e12e767925392652d284401
-  data.tar.gz: 02052eb52bd980e348a9888ca12520ae840549b4
+  metadata.gz: e174b459460db8214f2872c215c5eb0bdd0067c9
+  data.tar.gz: 3009a6be4af917f4ccce22855bb568bd54a10264
 SHA512:
-  metadata.gz: 8e6dc5abe7d6e649dae13d5714159dde65a036344cce27e741a3b2821968d79d337a3d8f45516c03e11d5f31661853be0da30ebc68f9595cf53f9796b8d62161
-  data.tar.gz: a3567f99de905c80dbbb39b63c1e582a3597774986711c3cbed7961997fbdfd392c2d6a3bbc9cdfe7e69d790dd3460176cd416b2fa8276ba1a8825952eee4a59
+  metadata.gz: a50302e6c005055e282522652bb5de41783c7f6c93dc2a4d003acb93fefc1ada65896c9ef720414be571464b70a8d56f14d8e063aca213c1f1e02509e0062051
+  data.tar.gz: 4a2db9cfd377f19a288a286ccaa88447ebff0ed5785f553cce318abbbdd28c767963221ba2795d129e23ca4e4244860b2b2abdaf6efa4d93b5d19212b7634a58

data/CHANGES.md

@@ -1,3 +1,13 @@
+# Version 0.0.3
+
+* Included functionality to set a hyperlink in the custom banner to an external
+  page
+* Fixed deprecated plugin initialization behavior
+* Updated minimum Foreman version requirement to 1.9
+* By default, the banner now appears on both the login page and in the Foreman
+  application. This can be disabled with a new option, ``custom_banner_on_login_page``,
+  in the ``Settings`` page.
+
 # Version 0.0.2
 
 * Simplify plug-in by removing decorator implementation and just calling settings

data/CONTRIBUTORS

@@ -1,2 +1,3 @@
 github/jcmcken
 github/stbenjam
+github/discreet

data/README.md

@@ -1,19 +1,40 @@
-# foreman_custom_banner
+# foreman\_custom\_banner
 
 A Foreman plugin which provides a configurable, custom banner for the Foreman UI.
 
 The purpose of this plugin is to provide a simple way to distinguish multiple
-installations of Foreman, e.g. a production vs. a development installation.
+installations of Foreman, e.g. a production vs. a development installation. As
+well as the possibility of a link to a "help" or "quick start" page.
 
-This looks something like:
+# Installation
 
-![foreman_custom_banner_preview](foreman_custom_banner.png)
+* Build and install the rubygem
+* Add ``install/foreman_custom_banner.rb`` into Foreman's ``bundler.d``
+  directory.
+  E.g. in the packaged Foreman installation, ``/usr/share/foreman/bundler.d``
+* Restart the webserver hosting the Foreman application
 
-Customize the banner by altering the plugin settings within Foreman and refreshing your browser.
+# Configuration
 
-## Installation
+You configure the custom banner from the `Settings` page on the `Custom Banner`
+tab:
+
+![custom\_banner\_settings\_preview](doc/foreman_custom_banner_config.png)
+
+With a default installation the custom banner would look like this:
+
+![default\_custom\_banner\_preview](doc/foreman_custom_banner_default_preview.png)
+
+If you only wanted to have a banner text simply remove the `custom_banner_url`
+and `custom_banner_url_text` values:
+
+![text\_custom\banner\_preview](doc/foreman_custom_banner_text_preview.png)
+
+If you only wanted to have a banner url simply remove the `custom_banner_text`
+value:
+
+![url\_custom\_banner\_preview](doc/foreman_custom_banner_url_preview.png)
+
+You can alter the style of the custom banner by changing the values for the
+`custom_banner_style` field. This field will accept any CSS style configuration
 
-* Build and install the rubygem.
-* Add ``install/foreman_custom_banner.rb`` into Foreman's ``bundler.d`` directory.
-  E.g. in the packaged Foreman installation, ``/usr/share/foreman/bundler.d``.
-* Restart the webserver hosting the Foreman application.

data/app/models/settings/custom_banner.rb

@@ -5,11 +5,17 @@ class Setting::CustomBanner < ::Setting
 
     Setting.transaction do
       [
-        self.set('custom_banner_text', N_('Text to set on the custom banner'), 
+        self.set('custom_banner_text', N_('Text to set on the custom banner'),
           'Configure the custom banner in your Foreman settings!'),
+        self.set('custom_banner_url_text', N_('Text to set URL on custom banner'),
+          'Source code for this plugin'),
+        self.set('custom_banner_url', N_('URL for custom banner text'),
+          'https://github.com/jcmcken/foreman_custom_banner'),
         self.set('custom_banner_enabled', N_('Whether to enable the custom banner'), true),
         self.set('custom_banner_style', N_('CSS styling for the custom banner'),
           'text-align:center;background-color:green;color:white;font-weight:bold;'),
+        self.set('custom_banner_on_login_page',
+          N_('Whether to enable the custom banner on the login page'), true),
       ].compact.each { |s| self.create! s.update(:category => "Setting::CustomBanner") }
     end
 

data/app/overrides/add_banner.rb

@@ -2,3 +2,12 @@ Deface::Override.new(:virtual_path => 'home/_topbar',
                      :name => 'add_custom_banner',
                      :insert_before => 'div.navbar.navbar-default.navbar-outer',
                      :template => 'home/_foreman_custom_header')
+
+if Setting[:custom_banner_on_login_page]
+  Deface::Override.new(
+    :virtual_path => 'layouts/login',
+    :name => 'add_custom_banner',
+    :insert_before => 'div.login-page',
+    :template => 'home/_foreman_custom_header'
+  )
+end

data/app/views/home/_foreman_custom_header.html.erb

@@ -1,5 +1,17 @@
 <% if Setting[:custom_banner_enabled] -%>
+<% if Setting[:custom_banner_url].empty? or Setting[:custom_banner_url_text].empty? -%>
 <div style="<%= h(Setting[:custom_banner_style]) %>">
   <%= h(Setting[:custom_banner_text]) %>
 </div>
+<% elsif Setting[:custom_banner_text].empty? %>
+<div style="<%= h(Setting[:custom_banner_style]) %>">
+  <a href="<%= h(Setting[:custom_banner_url]) %>" target="_blank"><%= h(Setting[:custom_banner_url_text]) %></a>
+</div>
+<% else %>
+<div style="<%= h(Setting[:custom_banner_style]) %>">
+  <%= h(Setting[:custom_banner_text]) %>
+  <br>
+  <a href="<%= h(Setting[:custom_banner_url]) %>" target="_blank"><%= h(Setting[:custom_banner_url_text]) %></a>
+</div>
+<% end -%>
 <% end -%>

data/foreman_custom_banner.spec

@@ -6,19 +6,19 @@
 
 Summary: Plugin for Foreman that adds a custom banner
 Name: %{?scl_prefix}rubygem-%{gem_name}
-Version: 0.0.2
+Version: 0.0.3
 Release: 1%{?dist}
 Group: Development/Languages
 License: Apache License 2.0
 URL: https://github.com/jcmcken/foreman_custom_banner
 Source0: %{gem_name}-%{version}.gem
 Requires: %{?scl_prefix}ruby(abi) = %{rubyabi}
-Requires: %{?scl_prefix}ruby(rubygems) 
-Requires: %{?scl_prefix}rubygem(deface) 
+Requires: %{?scl_prefix}ruby(rubygems)
+Requires: %{?scl_prefix}rubygem(deface)
 %{?scl:BuildRequires: scl-utils-build}
 BuildRequires: %{?scl_prefix}ruby(abi) = %{rubyabi}
-BuildRequires: %{?scl_prefix}ruby(rubygems) 
-BuildRequires: %{?scl_prefix}rubygems-devel 
+BuildRequires: %{?scl_prefix}ruby(rubygems)
+BuildRequires: %{?scl_prefix}rubygems-devel
 BuildArch: noarch
 Provides: %{?scl_prefix}rubygem(%{gem_name}) = %{version}
 
@@ -83,6 +83,8 @@ rm %{buildroot}/%{gem_instdir}/*.spec
 
 
 %changelog
+* Thu Apr 14 2016 Jon McKenzie - 0.0.3-1
+- Bump to 0.0.3.
 * Mon Feb 16 2015 Jon McKenzie - 0.0.2-1
 - Initial release.
 * Sat Oct 11 2014 Jon McKenzie - 0.0.1-1

data/lib/foreman_custom_banner/engine.rb

@@ -7,9 +7,9 @@ module ForemanCustomBanner
         (Setting.table_exists? rescue(false))
     end
 
-    initializer 'foreman_custom_banner.register_plugin', :after => :finisher_hook do |app|
+    initializer 'foreman_custom_banner.register_plugin', :before => :finisher_hook do |app|
       Foreman::Plugin.register :foreman_custom_banner do
-        requires_foreman '>= 1.5'
+        requires_foreman '>= 1.9'
       end
     end
   end

data/lib/foreman_custom_banner/version.rb

@@ -1,3 +1,3 @@
 module ForemanCustomBanner
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_custom_banner
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jon McKenzie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -40,8 +40,12 @@ files:
 - app/models/settings/custom_banner.rb
 - app/overrides/add_banner.rb
 - app/views/home/_foreman_custom_header.html.erb
+- doc/foreman_custom_banner.png
+- doc/foreman_custom_banner_config.png
+- doc/foreman_custom_banner_default_preview.png
+- doc/foreman_custom_banner_text_preview.png
+- doc/foreman_custom_banner_url_preview.png
 - foreman_custom_banner.gemspec
-- foreman_custom_banner.png
 - foreman_custom_banner.spec
 - install/foreman_custom_banner.rb
 - lib/foreman_custom_banner.rb