OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
Initial implementation of OpPrimer::ListComponent
Alexander Brandon Colesb8e5ede4a33e
diff --git a/app/components/op_primer/list_component.html.erb b/app/components/op_primer/list_component.html.erbnew file mode 100644index 00000000000..6268749a9ef--- /dev/null+++ b/app/components/op_primer/list_component.html.erb@@ -0,0 +1,37 @@+<%#-- copyright+OpenProject is an open source project management software.+Copyright (C) the OpenProject GmbH++This program is free software; you can redistribute it and/or+modify it under the terms of the GNU General Public License version 3.++OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+Copyright (C) 2006-2013 Jean-Philippe Lang+Copyright (C) 2010-2013 the ChiliProject Team++This program is free software; you can redistribute it and/or+modify it under the terms of the GNU General Public License+as published by the Free Software Foundation; either version 2+of the License, or (at your option) any later version.++This program is distributed in the hope that it will be useful,+but WITHOUT ANY WARRANTY; without even the implied warranty of+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+GNU General Public License for more details.++You should have received a copy of the GNU General Public License+along with this program; if not, write to the Free Software+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.++See COPYRIGHT and LICENSE files for more details.++++#%>++<%= render(Primer::BaseComponent.new(**@system_arguments)) do %>+ <% items.each do |item| %>+ <%= item %>+ <% end %>+ <% if content.present? %>+ <%= content %>+ <% end %>+<% end %>diff --git a/app/components/op_primer/list_component.rb b/app/components/op_primer/list_component.rbnew file mode 100644index 00000000000..fedbed17acf--- /dev/null+++ b/app/components/op_primer/list_component.rb@@ -0,0 +1,109 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++module OpPrimer+ # A low-level component for building semantic lists with unopinionated styling.+ #+ # This component is not designed to be used directly, but rather a primitive for+ # authors of other components.+ class ListComponent < Primer::Component # rubocop:disable OpenProject/AddPreviewForViewComponent+ TAG_DEFAULT = :ul+ TAG_OPTIONS = [TAG_DEFAULT, :ol].freeze++ # @!parse+ # # Adds an item to the list.+ # #+ # # @param system_arguments [Hash] These arguments are forwarded to <%= link_to_component(OpPrimer::ListComponent::Item) %>+ # def with_item(**system_arguments, &block)+ # end++ # @!parse+ # # Adds a divider to the list. Dividers visually separate items.+ # #+ # # @param system_arguments [Hash] The arguments accepted by <%= link_to_component(OpPrimer:::ListComponent::Divider) %>.+ # def with_divider(**system_arguments, &block)+ # end+ renders_many :items, types: {+ item: {+ renders: ->(**item_arguments) { Item.new(**item_arguments) },+ as: :item+ },+ divider: {+ renders: -> { Divider.new },+ as: :divider+ }+ }++ # @param tag [Symbol] <%= one_of(OpPrimer::ListComponent::TAG_OPTIONS) %>+ # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>+ def initialize(tag: TAG_DEFAULT, **system_arguments)+ super()++ @system_arguments = system_arguments+ @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, TAG_DEFAULT)+ @system_arguments[:classes] = class_names(+ @system_arguments[:classes],+ "list-style-none"+ )+ end++ def render?+ items.any? || content?+ end++ class Item < Primer::Component # rubocop:disable OpenProject/AddPreviewForViewComponent+ def initialize(**system_arguments)+ super()++ @system_arguments = deny_tag_argument(**system_arguments)+ @system_arguments[:tag] = :li+ end++ def call+ render(Primer::BaseComponent.new(**@system_arguments)) { content }+ end+ end++ class Divider < Primer::Component # rubocop:disable OpenProject/AddPreviewForViewComponent+ def initialize(**system_arguments)+ super()++ @system_arguments = deny_tag_argument(**system_arguments)+ @system_arguments[:tag] = :li+ @system_arguments[:role] = :presentation+ @system_arguments[:"aria-hidden"] = true+ end++ def call+ render(Primer::BaseComponent.new(**@system_arguments))+ end+ end+ end+enddiff --git a/spec/components/op_primer/list_component_spec.rb b/spec/components/op_primer/list_component_spec.rbnew file mode 100644index 00000000000..e0f299c0630--- /dev/null+++ b/spec/components/op_primer/list_component_spec.rb@@ -0,0 +1,121 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#+++require "rails_helper"++RSpec.describe OpPrimer::ListComponent, type: :component do+ include ActionView::Helpers::TagHelper++ def render_component(**, &)+ render_inline(described_class.new(**), &)+ end++ context "with string content" do+ let(:args) { {} }++ subject(:rendered_component) do+ render_component(**args) do+ "<li>List item</lI>".html_safe+ end+ end++ context "with default :tag (unordered list)" do+ it "renders list" do+ expect(rendered_component).to have_element :ul, class: "list-style-none"+ end++ it "renders list item" do+ expect(rendered_component).to have_element :li, text: "List item"+ end+ end++ context "with tag: :ol (ordered list)" do+ let(:args) { { tag: :ol } }++ it "renders list" do+ expect(rendered_component).to have_element :ol, class: "list-style-none"+ end++ it "renders list item" do+ expect(rendered_component).to have_element :li, text: "List item"+ end+ end++ context "with invalid tag:" do+ let(:args) { { tag: "not-a-list-tag" } }++ it "raises an InvalidValueError" do+ expect { rendered_component }.to raise_error Primer::FetchOrFallbackHelper::InvalidValueError+ end+ end+ end++ context "with helper tags" do+ subject(:rendered_component) do+ render_component do+ content_tag(:li, "List item")+ end+ end++ it "renders list" do+ expect(rendered_component).to have_element :ul, class: "list-style-none"+ end++ it "renders list item" do+ expect(rendered_component).to have_element :li, text: "List item"+ end+ end++ context "with slots" do+ subject(:rendered_component) do+ render_component do |list|+ list.with_item do+ "List item 1"+ end++ list.with_divider++ list.with_item do+ "List item 2"+ end+ end+ end++ it "renders list" do+ expect(rendered_component).to have_element :ul, class: "list-style-none"+ end++ it "renders list items" do+ expect(rendered_component).to have_list_item count: 3+ expect(rendered_component).to have_list_item position: 1, text: "List item 1"+ expect(rendered_component).to have_list_item position: 2, role: "presentation"+ expect(rendered_component).to have_list_item position: 3, text: "List item 2"+ end+ end+end