foreman_custom_banner 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/pkg
+/Gemfile.lock
+*.gem
+*.sw*

data/CHANGES.md

@@ -0,0 +1,7 @@
+# Version 0.0.1a
+
+* Fixed a broken SCL macro in the RPM spec file.
+
+# Version 0.0.1
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,19 @@
+# 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.
+
+This looks something like:
+
+![foreman_custom_banner_preview](foreman_custom_banner.png)
+
+Customize the banner by altering the plugin settings within Foreman and refreshing your browser.
+
+## Installation
+
+* 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/decorators/controllers/application_controller_decorator.rb

@@ -0,0 +1,15 @@
+ApplicationController.class_eval do
+  helper_method :custom_banner_text, :custom_banner_enabled, :custom_banner_style
+
+  def custom_banner_text
+    Setting.custom_banner_text
+  end
+
+  def custom_banner_enabled
+    !!Setting.custom_banner_enabled
+  end
+
+  def custom_banner_style
+    Setting.custom_banner_style
+  end
+end

data/app/models/settings/custom_banner.rb

@@ -0,0 +1,18 @@
+class Setting::CustomBanner < ::Setting
+  def self.load_defaults
+    return unless ActiveRecord::Base.connection.table_exists?('settings')
+    return unless super
+
+    Setting.transaction do
+      [
+        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_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;'),
+      ].compact.each { |s| self.create! s.update(:category => "Setting::CustomBanner") }
+    end
+
+    true
+  end
+end

data/app/overrides/add_banner.rb

@@ -0,0 +1,4 @@
+Deface::Override.new(:virtual_path => 'home/_topbar',
+                     :name => 'add_custom_banner',
+                     :insert_before => 'div.navbar.navbar-default.navbar-outer',
+                     :template => 'home/_foreman_custom_header')

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

@@ -0,0 +1,5 @@
+<% if custom_banner_enabled -%>
+<div style="<%= h(custom_banner_style) %>">
+  <%= h(custom_banner_text) %>
+</div>
+<% end -%>

data/foreman_custom_banner.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/foreman_custom_banner/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jon McKenzie"]
+  gem.email         = ["jcmcken@gmail.com"]
+  gem.description   = %q{Plugin for Foreman that adds a custom banner}
+  gem.summary       = %q{Plugin for Foreman that adds a custom banner}
+  gem.homepage      = "https://github.com/jcmcken/foreman_custom_banner"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "foreman_custom_banner"
+  gem.require_paths = ["lib"]
+  gem.version       = ForemanCustomBanner::VERSION
+
+  gem.add_runtime_dependency "deface"
+end

data/foreman_custom_banner.spec

@@ -0,0 +1,85 @@
+%global gem_name foreman_custom_banner
+%global rubyabi 1.9.1
+
+%{?scl:%scl_package rubygem-%{gem_name}}
+%{?scl:%global pkg_name %{name}}
+
+Summary: Plugin for Foreman that adds a custom banner
+Name: %{?scl_prefix}rubygem-%{gem_name}
+Version: 0.0.1
+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) 
+%{?scl:BuildRequires: scl-utils-build}
+BuildRequires: %{?scl_prefix}ruby(abi) = %{rubyabi}
+BuildRequires: %{?scl_prefix}ruby(rubygems) 
+BuildRequires: %{?scl_prefix}rubygems-devel 
+BuildArch: noarch
+Provides: %{?scl_prefix}rubygem(%{gem_name}) = %{version}
+
+%description
+Plugin for Foreman that adds a custom banner.
+
+%package doc
+Summary: Documentation for %{name}
+Group: Documentation
+Requires: %{name} = %{version}-%{release}
+BuildArch: noarch
+
+%description doc
+Documentation for %{name}
+
+
+%prep
+%setup -q -c -T
+mkdir -p .%{gem_dir}
+
+%{?scl:scl enable %{scl} "}
+gem install --local --install-dir .%{gem_dir} \
+            --force %{SOURCE0}
+%{?scl:"}
+
+%build
+
+%install
+mkdir -p %{buildroot}%{gem_dir}
+cp -pa .%{gem_dir}/* \
+        %{buildroot}%{gem_dir}/
+
+find %{buildroot}%{gem_instdir} -type f | xargs chmod ugo+r
+
+%if %{?scl:1}%{!?scl:0}
+mkdir -p %{buildroot}%{_root_datadir}/foreman/bundler.d
+ln -s %{gem_instdir}/install/foreman_custom_banner.rb \
+    %{buildroot}%{_root_datadir}/foreman/bundler.d
+%endif
+
+rm %{buildroot}/%{gem_instdir}/.gitignore
+
+%files
+%dir %{gem_instdir}
+%{gem_instdir}/lib
+%{gem_instdir}/install
+%{gem_instdir}/app
+%{gem_instdir}/Gemfile
+%{gem_instdir}/foreman_custom_banner.png
+%exclude %{gem_dir}/cache/%{gem_name}-%{version}.gem
+%exclude %{gem_instdir}/%{gem_name}.gemspec
+%{gem_dir}/specifications/%{gem_name}-%{version}.gemspec
+%{_root_datadir}/foreman/bundler.d
+%doc %{gem_instdir}/README.md
+%doc %{gem_instdir}/CHANGES.md
+%doc %{gem_instdir}/LICENSE
+
+%files doc
+%doc %{gem_dir}/doc/%{gem_name}-%{version}
+
+
+%changelog
+* Sat Oct 11 2014 Jon McKenzie - 0.0.1-1
+- Initial release.

data/install/foreman_custom_banner.rb

@@ -0,0 +1,2 @@
+# To enable the plugin, copy this file into /usr/share/foreman/bundler.d
+gem 'foreman_custom_banner'

data/lib/foreman_custom_banner/engine.rb

@@ -0,0 +1,22 @@
+module ForemanCustomBanner
+  class Engine < ::Rails::Engine
+    isolate_namespace ForemanCustomBanner
+
+    config.to_prepare do
+      Dir.glob(Rails.root + 'app/decorators/**/*_decorator*.rb').each do |c|
+        require_dependency(c)
+      end
+    end
+
+    initializer 'foreman_custom_banner.load_default_settings', :before => :load_config_initializers do |app|
+      require_dependency File.expand_path('../../../app/models/settings/custom_banner.rb', __FILE__) if \
+        (Setting.table_exists? rescue(false))
+    end
+
+    initializer 'foreman_custom_banner.register_plugin', :after => :finisher_hook do |app|
+      Foreman::Plugin.register :foreman_custom_banner do
+        requires_foreman '>= 1.5'
+      end
+    end
+  end
+end

data/lib/foreman_custom_banner/version.rb

@@ -0,0 +1,3 @@
+module ForemanCustomBanner
+  VERSION = "0.0.1"
+end

data/lib/foreman_custom_banner.rb

@@ -0,0 +1,6 @@
+require "deface"
+require "foreman_custom_banner/version"
+require "foreman_custom_banner/engine"
+
+module ForemanCustomBanner
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: foreman_custom_banner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon McKenzie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plugin for Foreman that adds a custom banner
+email:
+- jcmcken@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGES.md
+- Gemfile
+- LICENSE
+- README.md
+- app/decorators/controllers/application_controller_decorator.rb
+- app/models/settings/custom_banner.rb
+- app/overrides/add_banner.rb
+- app/views/home/_foreman_custom_header.html.erb
+- foreman_custom_banner.gemspec
+- foreman_custom_banner.png
+- foreman_custom_banner.spec
+- install/foreman_custom_banner.rb
+- lib/foreman_custom_banner.rb
+- lib/foreman_custom_banner/engine.rb
+- lib/foreman_custom_banner/version.rb
+homepage: https://github.com/jcmcken/foreman_custom_banner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Plugin for Foreman that adds a custom banner
+test_files: []