Skip to content

Commit

Permalink
Reorganize SDG tag list components
Browse files Browse the repository at this point in the history
So now we've got a component receiving records (goals or targets) and a
related model (Debate, Proposal, ...), with optionally a link to see
more tags.

This way we simplify some logic since the `TagList` classes were dealing
with too many cases (a record is passed, a class name is passed, a limit
is passed), ... Now `TagList` only deal with the natural `TagList` case,
which is listing the tags for a record. The case where a class name is
passed is used in the `TagCloud` class.
  • Loading branch information
javierm committed Feb 2, 2021
1 parent e519719 commit 1a60181
Show file tree
Hide file tree
Showing 13 changed files with 92 additions and 114 deletions.
35 changes: 15 additions & 20 deletions app/components/concerns/sdg/tag_list.rb
Original file line number Diff line number Diff line change
@@ -1,36 +1,31 @@
module SDG::TagList
extend ActiveSupport::Concern
attr_reader :record_or_name, :limit
delegate :link_list, to: :helpers
attr_reader :record, :limit

def initialize(record_or_name, limit: nil)
@record_or_name = record_or_name
def initialize(record, limit: nil)
@record = record
@limit = limit
end

def render?
process.enabled?
SDG::ProcessEnabled.new(record).enabled?
end

def see_more_link(association_name)
render Shared::SeeMoreLinkComponent.new(record, association_name, limit: limit)
end
def tag_records
tags = record.send(association_name)

def filter_text(goal_or_target)
t("sdg.#{i18n_namespace}.filter.link",
resources: model.model_name.human(count: :other),
code: goal_or_target.code)
if tags.respond_to?(:limit)
tags.limit(limit).order(:code)
else
tags.sort[0..(limit.to_i - 1)]
end
end

def index_by(advanced_search)
polymorphic_path(model, advanced_search: advanced_search)
end

def process
@process ||= SDG::ProcessEnabled.new(record_or_name)
def see_more_link
render Shared::SeeMoreLinkComponent.new(record, association_name, limit: limit)
end

def model
process.name.constantize
def association_name
raise NotImplementedError, "method must be implemented in the included class"
end
end
1 change: 1 addition & 0 deletions app/components/sdg/filter_links_component.html.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<%= link_list(*links, class: "sdg-#{parameter_name}-tag-list") %>
49 changes: 49 additions & 0 deletions app/components/sdg/filter_links_component.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
class SDG::FilterLinksComponent < ApplicationComponent
attr_reader :records, :related_model, :see_more_link
delegate :link_list, to: :helpers

def initialize(records, related_model, see_more_link: nil)
@records = records
@related_model = related_model
@see_more_link = see_more_link
end

def links
[*sdg_links, see_more_link]
end

private

def sdg_links
records.map do |goal_or_target|
[
render(SDG::TagComponent.new(goal_or_target)),
index_by(parameter_name => goal_or_target.code),
title: filter_text(goal_or_target),
data: { code: goal_or_target.code }
]
end
end

def filter_text(goal_or_target)
t("sdg.#{i18n_namespace}.filter.link",
resources: related_model.model_name.human(count: :other),
code: goal_or_target.code)
end

def index_by(advanced_search)
polymorphic_path(related_model, advanced_search: advanced_search)
end

def i18n_namespace
parameter_name.pluralize
end

def parameter_name
if records.first.is_a?(SDG::Goal)
"goal"
else
"target"
end
end
end
16 changes: 4 additions & 12 deletions app/components/sdg/goals/plain_tag_list_component.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,17 @@ class SDG::Goals::PlainTagListComponent < ApplicationComponent

private

def record
record_or_name
end

def tags
[*goal_tags, see_more_link(:sdg_goals)].select(&:present?)
[*goal_tags, see_more_link].select(&:present?)
end

def goal_tags
goals.order(:code).limit(limit).map do |goal|
tag_records.map do |goal|
render SDG::TagComponent.new(goal)
end
end

def goals
record.sdg_goals
end

def i18n_namespace
"goals"
def association_name
:sdg_goals
end
end
2 changes: 1 addition & 1 deletion app/components/sdg/goals/tag_cloud_component.html.erb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div class="sdg-goal-tag-cloud">
<div class="sidebar-divider"></div>
<h2 class="sidebar-title"><%= heading %></h2>
<%= render SDG::Goals::TagListComponent.new(class_name) %>
<%= render SDG::FilterLinksComponent.new(goals, class_name.constantize) %>
</div>
4 changes: 4 additions & 0 deletions app/components/sdg/goals/tag_cloud_component.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,8 @@ def render?
def heading
t("sdg.goals.filter.heading")
end

def goals
SDG::Goal.order(:code)
end
end
2 changes: 1 addition & 1 deletion app/components/sdg/goals/tag_list_component.html.erb
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<%= link_list(*links, class: "sdg-goal-tag-list") %>
<%= render SDG::FilterLinksComponent.new(tag_records, related_model, see_more_link: see_more_link) %>
30 changes: 4 additions & 26 deletions app/components/sdg/goals/tag_list_component.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,11 @@ class SDG::Goals::TagListComponent < ApplicationComponent

private

def record
record_or_name if record_or_name.respond_to?(:sdg_goals)
def association_name
:sdg_goals
end

def links
[*goal_links, see_more_link(:sdg_goals)]
end

def goal_links
goals.order(:code).limit(limit).map do |goal|
[
render(SDG::TagComponent.new(goal)),
index_by_goal(goal),
title: filter_text(goal)
]
end
end

def goals
record&.sdg_goals || SDG::Goal.all
end

def index_by_goal(goal)
index_by(goal: goal.code)
end

def i18n_namespace
"goals"
def related_model
record.class
end
end
16 changes: 4 additions & 12 deletions app/components/sdg/targets/plain_tag_list_component.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,17 @@ class SDG::Targets::PlainTagListComponent < ApplicationComponent

private

def record
record_or_name
end

def tags
[*target_tags, see_more_link(:sdg_targets)].select(&:present?)
[*target_tags, see_more_link].select(&:present?)
end

def target_tags
targets.sort[0..(limit.to_i - 1)].map do |target|
tag_records.map do |target|
tag.span(render(SDG::TagComponent.new(target)), data: { code: target.code })
end
end

def targets
record.sdg_targets
end

def i18n_namespace
"targets"
def association_name
:sdg_targets
end
end
2 changes: 1 addition & 1 deletion app/components/sdg/targets/tag_list_component.html.erb
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<%= link_list(*links, class: "sdg-target-tag-list") %>
<%= render SDG::FilterLinksComponent.new(tag_records, related_model, see_more_link: see_more_link) %>
31 changes: 4 additions & 27 deletions app/components/sdg/targets/tag_list_component.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,11 @@ class SDG::Targets::TagListComponent < ApplicationComponent

private

def record
record_or_name
def association_name
:sdg_targets
end

def links
[*target_links, see_more_link(:sdg_targets)]
end

def target_links
targets.sort[0..(limit.to_i - 1)].map do |target|
[
render(SDG::TagComponent.new(target)),
index_by_target(target),
title: filter_text(target),
data: { code: target.code }
]
end
end

def targets
record.sdg_targets
end

def index_by_target(target)
index_by(target: target.code)
end

def i18n_namespace
"targets"
def related_model
record.class
end
end
6 changes: 4 additions & 2 deletions spec/components/sdg/goals/tag_cloud_component_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@
expect(page).to have_content "Filters by SDG"
end

it "renders all goals" do
it "renders all goals ordered by code" do
component = SDG::Goals::TagCloudComponent.new("Proposal")

render_inline component

expect(page).to have_css ".sdg-goal-icon", count: 17
expect(page).to have_selector ".sdg-goal-icon", count: 17
expect(page.first("a")[:title]).to end_with "goal 1"
expect(page.all("a").last[:title]).to end_with "goal 17"
end
end
12 changes: 0 additions & 12 deletions spec/components/sdg/goals/tag_list_component_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,4 @@
title: "One more goal",
href: "/debates/#{debate.to_param}"
end

context "given a class name" do
let(:component) { SDG::Goals::TagListComponent.new("Debate") }

it "renders all goals ordered by code" do
render_inline component

expect(page).to have_selector "li", count: 17
expect(page.first("a")[:title]).to end_with "goal 1"
expect(page.all("a").last[:title]).to end_with "goal 17"
end
end
end

0 comments on commit 1a60181

Please sign in to comment.