Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🧹 Clean up forms #2098

Merged
merged 1 commit into from
Dec 21, 2023
+145 −162
Merged

🧹 Clean up forms #2098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
291 changes: 131 additions & 160 deletions app/forms/hyrax/forms/admin/appearance.rb → ...hyrax/forms/admin/appearance_decorator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,91 +1,143 @@
# frozen_string_literal: true

# OVERRIDE Hyrax 3.4.0 to add custom theming
# OVERRIDE Hyrax v5.0.0rc2 to add custom theming

# rubocop:disable Metrics/ClassLength
# rubocop:disable Metrics/ModuleLength
module Hyrax
module Forms
module Admin
# An object to model and persist the form data for the appearance
# customization menu
class Appearance
extend ActiveModel::Naming
delegate :banner_image, :banner_image?, to: :site
delegate :logo_image, :logo_image?, to: :site
delegate :favicon, :favicon?, to: :site
delegate :directory_image, :directory_image?, to: :site
delegate :default_collection_image, :default_collection_image?, to: :site
delegate :default_work_image, :default_work_image?, to: :site

##
# @!group Class Attributes
#
# @!attribute default_fonts
# @return [Hash<String, String>] there should be at least the key "body_font" and
# "headline_font"
class_attribute :default_fonts, default: {
'body_font' => 'Helvetica Neue, Helvetica, Arial, sans-serif;',
'headline_font' => 'Helvetica Neue, Helvetica, Arial, sans-serif;'
}

##
# @!attribute default_colors
# @return [Hash<String, String>]
class_attribute :default_colors, default: {
'header_and_footer_background_color' => '#3c3c3c',
'header_and_footer_text_color' => '#dcdcdc',
'navbar_background_color' => '#000000',
'navbar_link_background_hover_color' => '#ffffff',
'navbar_link_text_color' => '#eeeeee',
'navbar_link_text_hover_color' => '#eeeeee',
'link_color' => '#2e74b2',
'link_hover_color' => '#215480',
'footer_link_color' => '#ffebcd',
'footer_link_hover_color' => '#ffffff',
'primary_button_hover_color' => '#286090',
'default_button_background_color' => '#ffffff',
'default_button_border_color' => '#cccccc',
'default_button_text_color' => '#333333',
# 'active_tabs_background_color' => '#337ab7',
'facet_panel_background_color' => '#f5f5f5',
'facet_panel_text_color' => '#333333'
}
# @!endgroup Class Attributes

# @param [Hash] attributes the list of parameters from the form
def initialize(attributes = {})
@attributes = attributes
end

attr_reader :attributes
private :attributes

# This allows this object to route to the correct path
def self.model_name
ActiveModel::Name.new(self, Hyrax, "Hyrax::Admin::Appearance")
end

# Override this method if your form takes more than just the customization_params
def self.permitted_params
customization_params + image_params
end

def self.image_params
%i[favicon banner_image logo_image directory_image default_collection_image default_work_image]
end
module AppearanceDecorator
extend ActiveSupport::Concern

# rubocop:disable Metrics/BlockLength
prepended do
delegate :banner_image, :banner_image?, to: :site
delegate :logo_image, :logo_image?, to: :site
delegate :favicon, :favicon?, to: :site
delegate :directory_image, :directory_image?, to: :site
delegate :default_collection_image, :default_collection_image?, to: :site
delegate :default_work_image, :default_work_image?, to: :site

##
# @!group Class Attributes
#
# @!attribute default_fonts
# @return [Hash<String, String>] there should be at least the key "body_font" and
# "headline_font"
class_attribute :default_fonts, default: {
'body_font' => 'Helvetica Neue, Helvetica, Arial, sans-serif;',
'headline_font' => 'Helvetica Neue, Helvetica, Arial, sans-serif;'
}

##
# @!attribute default_colors
# @return [Hash<String, String>]
class_attribute :default_colors, default: {
'header_and_footer_background_color' => '#3c3c3c',
'header_and_footer_text_color' => '#dcdcdc',
'navbar_background_color' => '#000000',
'navbar_link_background_hover_color' => '#ffffff',
'navbar_link_text_color' => '#eeeeee',
'navbar_link_text_hover_color' => '#eeeeee',
'link_color' => '#2e74b2',
'link_hover_color' => '#215480',
'footer_link_color' => '#ffebcd',
'footer_link_hover_color' => '#ffffff',
'primary_button_hover_color' => '#286090',
'default_button_background_color' => '#ffffff',
'default_button_border_color' => '#cccccc',
'default_button_text_color' => '#333333',
# 'active_tabs_background_color' => '#337ab7',
'facet_panel_background_color' => '#f5f5f5',
'facet_panel_text_color' => '#333333'
}
# @!endgroup Class Attributes
end

class_methods do
# Override this method if your form takes more than just the customization_params
def permitted_params
customization_params + image_params
end

def site
@site ||= Site.instance
end
def image_params
%i[favicon banner_image logo_image directory_image default_collection_image default_work_image]
end

# @return [Array<Symbol>] a list of fields that are related to the banner
def banner_fields
%i[
banner_image banner_label
]
end

def favicon_fields
[:favicon]
end

# Required to back a form
def to_key
[]
# @return [Array<Symbol>] a list of fields that are related to the logo
def logo_fields
%i[
logo_image logo_label
]
end

# @return [Array<Symbol>] a list of fields that are related to the directory
def directory_fields
%i[
directory_image directory_image_label
]
end

# @return [Array<Symbol>] a list of fields that are related to default works & collections
def default_image_fields
%i[
default_collection_image
default_work_image
default_collection_label
default_work_label
]
end

# A list of parameters that are related to customizations
# rubocop:disable Metrics/MethodLength
def customization_params
%i[
body_font
headline_font
header_and_footer_background_color
header_and_footer_text_color
link_color
link_hover_color
footer_link_color
footer_link_hover_color
primary_button_hover_color
default_button_background_color
default_button_border_color
default_button_text_color
active_tabs_background_color
facet_panel_background_color
facet_panel_text_color
navbar_background_color
navbar_link_background_hover_color
navbar_link_text_color
navbar_link_text_hover_color
custom_css_block
logo_image_text
banner_image_text
directory_image_text
default_collection_image_text
default_work_image_text
]
end
# rubocop:enable Metrics/MethodLength
end
# rubocop:enable Metrics/BlockLength

# Required to back a form (for route determination)
def persisted?
true
def site
@site ||= Site.instance
end

# The alt text for the logo image
Expand Down Expand Up @@ -198,31 +250,16 @@ def primary_button_hover_background_color
darken_color(primary_button_hover_color, 0.1)
end

# The mouse over color for the border of "primary" buttons
def primary_button_hover_border_color
darken_color(primary_button_border_color, 0.12)
end

# The color for the background of active "primary" buttons
def primary_button_active_background_color
darken_color(primary_button_hover_color, 0.1)
end

# The color for the border of active "primary" buttons
def primary_button_active_border_color
darken_color(primary_button_border_color, 0.12)
end

# The color for the background of focused "primary" buttons
def primary_button_focus_background_color
darken_color(primary_button_hover_color, 0.1)
end

# The color for the border of focused "primary" buttons
def primary_button_focus_border_color
darken_color(primary_button_border_color, 0.25)
end

# The custom css module
def custom_css_block
# we want to be able to read the css
Expand Down Expand Up @@ -325,41 +362,6 @@ def default_image_attributes
attributes.slice(*self.class.default_image_fields)
end

# @return [Array<Symbol>] a list of fields that are related to the banner
def self.banner_fields
%i[
banner_image banner_label
]
end

def self.favicon_fields
[:favicon]
end

# @return [Array<Symbol>] a list of fields that are related to the logo
def self.logo_fields
%i[
logo_image logo_label
]
end

# @return [Array<Symbol>] a list of fields that are related to the directory
def self.directory_fields
%i[
directory_image directory_image_label
]
end

# @return [Array<Symbol>] a list of fields that are related to default works & collections
def self.default_image_fields
%i[
default_collection_image
default_work_image
default_collection_label
default_work_label
]
end

# Persist the form values
def update!
self.class.customization_params.each do |field|
Expand All @@ -372,39 +374,6 @@ def update!
.merge(default_image_attributes))
end

# A list of parameters that are related to customizations
# rubocop:disable Metrics/MethodLength
def self.customization_params
%i[
body_font
headline_font
header_and_footer_background_color
header_and_footer_text_color
link_color
link_hover_color
footer_link_color
footer_link_hover_color
primary_button_hover_color
default_button_background_color
default_button_border_color
default_button_text_color
active_tabs_background_color
facet_panel_background_color
facet_panel_text_color
navbar_background_color
navbar_link_background_hover_color
navbar_link_text_color
navbar_link_text_hover_color
custom_css_block
logo_image_text
banner_image_text
directory_image_text
default_collection_image_text
default_work_image_text
]
end
# rubocop:enable Metrics/MethodLength

def font_import_body_url
body = body_font.split('|').first.to_s.tr(" ", "+")
# we need to be able to read the url to import fonts
Expand Down Expand Up @@ -469,4 +438,6 @@ def format_font_names(font_style)
end
end
end
# rubocop:enable Metrics/ClassLength
# rubocop:enable Metrics/ModuleLength

Hyrax::Forms::Admin::Appearance.prepend(Hyrax::Forms::Admin::AppearanceDecorator)
2 changes: 1 addition & 1 deletion app/forms/hyrax/forms/permission_template_form_decorator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

# OVERRIDE Hyrax 3.4.1 to fix Hyrax::Groups args
# OVERRIDE Hyrax v5.0.0rc2 to fix Hyrax::Groups args
module Hyrax
module Forms
module PermissionTemplateFormDecorator
Expand Down
14 changes: 13 additions & 1 deletion ...orms/hyrax/forms/admin/appearance_spec.rb → .../forms/admin/appearance_decorator_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

require 'spec_helper'

RSpec.describe Hyrax::Forms::Admin::Appearance do
RSpec.describe Hyrax::Forms::Admin::Appearance, type: :decorator do
describe '.default_fonts' do
subject { described_class.default_fonts }

Expand All @@ -18,4 +18,16 @@

it { is_expected.to be_a(Hash) }
end

describe '.image_params' do
subject { described_class.image_params }

it { is_expected.to be_an(Array) }
end

describe '#banner_image' do
subject { described_class.new.banner_image }

it { is_expected.to be_a(Hyrax::AvatarUploader) }
end
end
Loading