foreman_theme_satellite 13.1.0

data/lib/foreman_theme_satellite/engine.rb

@@ -0,0 +1,155 @@
+require 'fast_gettext'
+require 'gettext_i18n_rails'
+require 'rubygems'
+require 'deface'
+
+module ForemanThemeSatellite
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_theme_satellite'
+
+    config.eager_load_paths += Dir["#{config.root}/app/overrides"]
+    config.eager_load_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.eager_load_paths += Dir["#{config.root}/app/helpers"]
+    config.eager_load_paths += Dir["#{config.root}/app/models/concerns"]
+    config.eager_load_paths += Dir["#{config.root}/app/services/concerns"]
+    config.eager_load_paths += Dir["#{config.root}/lib/foreman_theme_satellite"]
+
+    initializer 'foreman_theme_satellite.load_default_settings', :before => :load_config_initializers do |app|
+      SettingRegistry.prepend SettingRegistryBranding
+    end
+
+    initializer 'foreman_theme_satellite.register_plugin', :before=> :finisher_hook do |app|
+      Foreman::Plugin.register :foreman_theme_satellite do
+        requires_foreman '>= 3.7.0'
+        register_gettext
+
+        settings do
+          category(:provisioning) do
+            setting('show_unsupported_templates',
+              type: :boolean,
+              default: true,
+              description: N_('Show unsupported provisioning templates. '\
+                              'When enabled, all the avaiable templates will be shown. '\
+                              'When disabled, Red Hat supported templates will be shown only'),
+              full_name: N_('Show unsupported provisioning templates')
+            )
+          end
+        end
+
+         tests_to_skip ({
+                        "ComputeResourceTest" => ["friendly provider name"],
+                        "RealmIntegrationTest" => ["create new page"],
+                        "SmartProxyIntegrationTest" => ["create new page", "index page"],
+                        "TopBarIntegrationTest" => ["top bar links"],
+                        "AboutIntegrationTest" => ["about page"],
+                        "ComputeProfileIntegrationTest" => ["index page", "create new page", "edit page", "show page", "edit compute attribute page", "new compute attribute page"] ,
+
+                        #the following tests are failing due to change in realms types
+                        "Api::V2::RealmsControllerTest" => ["should create valid realm", "should update valid realm"],
+                        "OrganizationTest" => ["should clone organization with all associations"],
+                        "RealmTest" => ["realm can be assigned to locations"],
+                        "LocationTest" => ["should clone location with all associations"]
+                       })
+
+        extend_rabl_template 'api/v2/home/status', 'api/v2/home/status_extensions'
+        extend_template_helpers ForemanThemeSatellite::RendererMethods
+      end
+    end
+
+    initializer 'foreman_theme_satellite.load_app_instance_data' do |app|
+      ForemanThemeSatellite::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_theme_satellite.gettext.branding', :before => :finisher_hook do |app|
+      require File.expand_path('replacer_repository', __dir__)
+      FastGettext.translation_repositories.each do |key, repo|
+        FastGettext.translation_repositories[key] = ::ForemanThemeSatellite::ReplacerRepository.new(repo)
+      end
+    end
+
+    initializer 'foreman_theme_satellite.rails_loading_workaround' do
+      # Without this, in production environment the module gets prepended too
+      # late and the extensions do not get applied
+      # the idea is stolen from https://github.com/theforeman/foreman_remote_execution/commit/2efd0a6eccfc19e282f453d5629cf46e729963eb
+      ProvisioningTemplatesHelper.prepend ProvisioningTemplatesHelperBranding
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      begin
+        # Include your monkey-patches over here
+        ::ForemanGoogle::GCE.send(:prepend, GCE::ClassMethods) if Foreman::Plugin.installed?("foreman_google")
+        require 'rss_checker_branding'
+        UINotifications::RssNotificationsChecker.send :prepend, RssCheckerBranding
+        Foreman::Model::Openstack.send :include, Openstack
+        Foreman::Model::Ovirt.send :include, Ovirt
+        Realm.send :include, RealmTheme
+        ProvisioningTemplate.send :include, Provisioning
+
+        # Skip katello initialization, if katello module is not present (dev environments)
+        if defined?(Katello::VERSION)
+          Katello::Ping.send :include, SatellitePackages
+          Katello::Glue::Provider.send :include, DistributorVersion
+          Katello::LayoutHelper.send :include, ThemeLayoutHelper
+          Katello::LayoutHelper.send :prepend, ThemeCssClassHelper
+        end
+
+        if defined?(ForemanRhCloud)
+          ForemanRhCloud::BranchInfo.send :prepend, BranchInfoBranding
+        end
+
+        UINotifications::StringParser.send :prepend, DeprecationNotification::StringParser
+        Notification.singleton_class.send :prepend, DeprecationNotification::Notification
+        LinksController.prepend DocumentationControllerBranding
+        ProvisioningTemplatesController.include ProvisioningTemplatesControllerBranding
+        ProvisioningTemplatesHelper.prepend ProvisioningTemplatesHelperBranding
+        Setting.singleton_class.send :prepend, SettingBranding::ClassMethods
+        LayoutHelper.send :prepend, ThemeCssClassHelper
+      rescue => e
+        Rails.logger.error "ForemanThemeSatellite: skipping engine hook (#{e})\n#{e.backtrace.join("\n")}"
+      end
+    end
+  end
+
+  METADATA_PATH = '/usr/share/satellite/metadata.yml'.freeze
+
+  def self.metadata_field(key, default)
+    value = ENV["SATELLITE_#{key.upcase}"]
+    return value if value
+
+    metadata_path = Rails.env.production? ? METADATA_PATH : "#{__dir__}/../../config/metadata.yml"
+
+    @metadata_yaml ||= File.exist?(metadata_path) ? YAML.load_file(metadata_path) : {}
+    @metadata_yaml.fetch(key, default)
+  end
+
+  def self.get_satellite_version
+    metadata_field('version', '6.13.0-development')
+  end
+
+  def self.get_satellite_short_version
+    Foreman::Version.new(SATELLITE_VERSION).short
+  end
+
+  def self.documentation_server
+    @documentation_server ||= metadata_field('documentation_server', 'https://access.redhat.com')
+  end
+
+  def self.documentation_version
+    @documentation_version ||= metadata_field('documentation_version', ForemanThemeSatellite::SATELLITE_SHORT_VERSION)
+  end
+
+  def self.documentation_root
+    @documentation_root ||= begin
+      "#{documentation_server}/documentation/en-us/red_hat_satellite/#{documentation_version}/html"
+    end
+  end
+
+  # this file indicates the satellite version that will be represented on the login page.
+  SATELLITE_VERSION = get_satellite_version
+
+  # this file indicates the satellite version that will be used on links to documentation.
+  SATELLITE_SHORT_VERSION = get_satellite_short_version
+end

data/lib/foreman_theme_satellite/pry_rack.rb

@@ -0,0 +1,12 @@
+module ForemanThemeSatellite
+  class PryRack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+       binding.pry
+       @app.call(env)
+     end
+   end
+end

data/lib/foreman_theme_satellite/replacer_repository.rb

@@ -0,0 +1,57 @@
+require 'fast_gettext'
+require_relative 'branded_words'
+
+module ForemanThemeSatellite
+  # This repository is a wrapper above other repository,
+  # it replaces branded words with their downstream counterparts.
+  class ReplacerRepository < ::FastGettext::TranslationRepository::Base
+    def initialize(old_repo)
+      @repo = old_repo
+    end
+
+    def pluralisation_rule
+      @repo.pluralisation_rule
+    end
+
+    def available_locales
+      @repo.available_locales
+    end
+
+    def [](key)
+      original = @repo[key]
+      val = original || key
+      return original unless val.is_a? String
+
+      val = val.dup if val
+
+      replaced = replace_string(val)
+
+      replaced == val ? original : replaced
+    end
+
+    def plural(*keys)
+      @repo.plural(*keys)
+    end
+
+    def reload
+      @repo.reload
+    end
+
+    private
+
+    # 'babcb'.split(/b/, -1) => ['', 'a', 'c', ''].join('z') => 'zazcz'
+    def replace_string(val)
+      return '' if val.empty?
+
+      ForemanThemeSatellite::FOREMAN_BRAND.each do |foreman_word, value|
+        parts = val.split(foreman_word, -1)
+        next if parts.size == 1 # no match, try the next word
+
+        parts = parts.map { |part| replace_string(part) }
+        return parts.join(value)
+      end
+
+      val # no match found at all
+    end
+  end
+end

data/lib/foreman_theme_satellite/rss_checker_branding.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanThemeSatellite
+  module RssCheckerBranding
+    extend ActiveSupport::Concern
+
+    def rss_user_agent
+      "Satellite/#{ForemanThemeSatellite::SATELLITE_VERSION} (RSS notifications)"
+    end
+  end
+end

data/lib/foreman_theme_satellite/version.rb

@@ -0,0 +1,3 @@
+module ForemanThemeSatellite
+  VERSION = '13.1.0'.freeze
+end

data/lib/foreman_theme_satellite.rb

@@ -0,0 +1,4 @@
+require 'foreman_theme_satellite/engine'
+
+module ForemanThemeSatellite
+end

data/lib/generators/foreman_theme_satellite/color_diff_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators'
+require_relative 'lib/css_compare'
+require_relative 'lib/color_changer'
+
+module ForemanThemeSatellite
+  class ColorDiffGenerator < Rails::Generators::Base
+    class_option :destination_file, required: true
+    class_option :source_css, required: true
+
+    def create_color_diff
+      replaced = File.read(source_css)
+
+      replaced.gsub!(ForemanThemeSatellite::COLOR_REGEX) do |color|
+        ForemanThemeSatellite::COLOR_REPLACEMENT[color] || color
+      end
+
+      compare = CssCompare.new(left_filename: source_css, right_css: replaced)
+      diff_css = compare.to_css(compare.diff)
+      create_file(destination_file, diff_css)
+    end
+
+    private
+
+    def source_css
+      options['source_css']
+    end
+
+    def destination_file
+      options['destination_file']
+    end
+  end
+end

data/lib/generators/foreman_theme_satellite/lib/color_changer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ForemanThemeSatellite
+  COLOR_REGEX = /#([0-9A-Fa-f]){3}((?=[^[:alnum:]])|([0-9A-Fa-f]){3,5})/i
+
+  # This color translation is copied from previous colors.scss file.
+  # When the same source color was translated to multiple destinations,
+  # one of the conflicting pairs was commented out and left for future
+  # reference.
+  # Each line is commented by the corresponding parameter name.
+  COLOR_REPLACEMENT = {
+    '#005c7e' => '#393F44', # $primary_color
+    '#0187b6' => '#5F666C',   # $border_color
+    # '#005c7e' => '#CC0000',   # $brand_color
+    '#0072a0' => '#474C51',   # $primary_gradient_start
+    # '#0072a0' => '#393F44', # $primary_gradient_end
+    '#005b7e' => '#72757A',   # $selected_gradient_start
+    # '#005b7e' => '#5c6165', # $hover_gradient_start
+    '#006289' => '#64686C',   # $selected_gradient_end
+    # '#006289' => '#4b5053'  # $hover_gradient_end
+    '#024d6c' => '#393F44',   # $nav-pf-vertical-bg-color
+    '#026991' => '#474C51',   # $nav-pf-vertical-active-bg-color
+    '#01749d' => '#202020'    # $topbar-default-color
+  }.freeze
+end

data/lib/generators/foreman_theme_satellite/lib/css_compare.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require 'sass'
+
+module ForemanThemeSatellite
+
+  # Semantically compares two css files.
+  # returns hash: rule => prop => value
+  class CssCompare
+    attr_reader :left, :right
+
+    def initialize(left_filename: nil, left_css: nil, right_filename: nil, right_css: nil)
+      @left = left_filename ? Sass::Engine.for_file(left_filename, syntax: :scss) : Sass::Engine.new(left_css, syntax: :scss)
+      @right = right_filename ? Sass::Engine.for_file(right_filename, syntax: :scss) : Sass::Engine.new(right_css, syntax: :scss)
+    end
+
+    def diff
+      result_hash = {}
+
+      right_hash = rules_hash(right)
+
+      rules_hash(left).each do |rule, props|
+        right_props = right_hash[rule]
+        unless props
+          result_hash[rule] = props
+          next
+        end
+
+        diffed_props = props_diff(props_hash(props), props_hash(right_props))
+
+        result_hash[rule] = diffed_props unless diffed_props.empty?
+      end
+
+      result_hash
+    end
+
+    def to_css(diff)
+      diff.map do |rule, props|
+        [
+          "#{rule} {",
+          to_properties_css(props, '  '),
+          '}'
+        ]
+      end.flatten.join("\n")
+    end
+
+    private
+
+    def rules_hash(engine)
+      root = engine.to_tree
+
+      Hash[
+        root.children.select { |c| c.is_a? Sass::Tree::RuleNode }.map do |c|
+          raise "Rule has too many names: #{c.to_sass}" if c.rule.length > 1
+          [c.rule[0], c.children]
+        end
+      ]
+    end
+
+    def props_hash(props)
+      Hash[
+        props.reject { |c| c.is_a? Sass::Tree::CommentNode }.map do |prop|
+          raise "property has too many names: #{prop.to_sass}" if prop.name.length > 1
+          [
+            prop.name[0],
+            (prop.value[0].is_a? String)? prop.value[0] : prop.value[0].to_sass
+          ]
+        end
+      ]
+    end
+
+    def props_diff(left, right)
+      right.reject { |k, v| left[k] == v }
+    end
+
+    def to_properties_css(props, indent)
+      props.map do |prop, val|
+        "#{indent}#{to_property_css(prop, val)}"
+      end.join("\n")
+    end
+
+    def to_property_css(property, value)
+      "#{property}: #{value};"
+    end
+  end
+end

data/lib/tasks/foreman_theme_satellite_tasks.rake

@@ -0,0 +1,48 @@
+require 'rake/testtask'
+
+# Tasks
+namespace :foreman_theme_satellite do
+  namespace :example do
+    desc 'Example Task'
+    task task: :environment do
+      # Task goes here
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanThemeSatellite'
+  Rake::TestTask.new(:foreman_theme_satellite) do |t|
+    test_dir = File.expand_path('../../test', __dir__)
+    t.libs << 'test'
+    t.libs << test_dir
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_theme_satellite do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_theme_satellite) do |task|
+        task.patterns = ["#{ForemanThemeSatellite::Engine.root}/app/**/*.rb",
+                         "#{ForemanThemeSatellite::Engine.root}/lib/**/*.rb",
+                         "#{ForemanThemeSatellite::Engine.root}/test/**/*.rb"]
+      end
+    rescue
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_theme_satellite'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_theme_satellite']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_theme_satellite', 'foreman_theme_satellite:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,65 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).name')
+VERSION = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '$(DOMAIN).po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+JSFILES = $(shell find ../app/assets/javascripts/*/locale -name '$(DOMAIN).js')
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+%.edit.po:
+	touch $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	cd .. && tx pull -f
+	for f in $(EDITFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation
+	@echo then run rake plugin:po_to_json[$(DOMAIN)] from the Foreman installation
+	@echo then run make -C locale mo-files to finish
+	@echo
+
+build-mo-files: $(MOFILES)
+
+mo-files: build-mo-files
+	git add $(POFILES) $(POTFILE) $(JSFILES) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_theme_satellite.edit.po

@@ -0,0 +1,152 @@
+# foreman_theme_satellite
+#
+# This file is distributed under the same license as foreman_theme_satellite.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: ../app/helpers/provisioning_templates_helper_branding.rb:9
+msgid "Supported by Red Hat"
+msgstr ""
+
+#: ../app/helpers/rhev_helper.rb:3
+msgid "RHEV integration is deprecated."
+msgstr ""
+
+#: ../app/helpers/rhev_helper.rb:4
+msgid "On August 31, 2022, Red Hat Virtualization entered the Maintenance Support Phase. The Maintenance Support Phase runs until August 31, 2024, followed by the Extended Life Phase, which runs until August 31, 2026."
+msgstr ""
+
+#: ../app/helpers/rhev_helper.rb:5
+msgid "More information"
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:7
+msgid "When editing a Template, you must assign a list of Operating Systems with which this Template can be used. Optionally, you can restrict a template to a list of Hostgroups or Environments."
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:8
+msgid "When a Host requests a template (e.g. during provisioning), Foreman selects the optimal match from the available templates of that type, in the following order:"
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:10
+msgid "Host group and Environment"
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:11
+msgid "Host group only"
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:12
+msgid "Environment only"
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:13
+msgid "Operating system default"
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:15
+msgid "The final entry, Operating System default, can be set by editing the %s page."
+msgstr ""
+
+#: ../app/helpers/theme_application_helper.rb:15
+msgid "Operating System"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:2
+msgid "Version %{version}"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:3
+msgid "Support"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:4
+msgid "Customer portal"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:5
+msgid "Documentation"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:6
+msgid "Administering Red Hat Satellite"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:7
+msgid "Transitioning from Red Hat Satellite 5 to Red Hat Satellite 6"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:8
+msgid "API Guide"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:9
+msgid "Blog"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:10
+msgid "Red Hat Satellite Blog"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:11
+msgid "IRC"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:12
+msgid "You can find us on %{liberachat} (irc.libera.chat) in #redhat-satellite."
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:13
+msgid "Version %{version} © %{year} Red Hat Inc."
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:14
+msgid "Includes %{system} © 2009-%{year} Paul Kelly and Ohad Levy"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:15
+msgid "If you feel this is an error with Satellite 6 itself, please open a new issue with"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:16
+msgid "Satellite ticketing system"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:17
+msgid "You would probably need to attach the"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:18
+msgid "Full trace"
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:19
+msgid "and relevant log entries."
+msgstr ""
+
+#: ../app/overrides/satellite_name_override.rb:20
+msgid "(build: %{version})"
+msgstr ""
+
+#: ../lib/foreman_theme_satellite/engine.rb:45
+msgid "Show unsupported provisioning templates. When enabled, all the avaiable templates will be shown. When disabled, Red Hat supported templates will be shown only"
+msgstr ""
+
+#: ../lib/foreman_theme_satellite/engine.rb:48
+msgid "Show unsupported provisioning templates"
+msgstr ""
+
+#: gemspec.rb:2
+msgid "Theme changes for Satellite 6."
+msgstr ""