decidim-navbar_links 0.18.0

data/README.md

@@ -0,0 +1,39 @@
+# Decidim::NavbarLinks
+
+[![CircleCI](https://circleci.com/gh/OpenSourcePolitics/decidim-module-navbar_links.svg?style=svg)](https://circleci.com/gh/OpenSourcePolitics/decidim-module-navbar_links)
+[![Maintainability](https://api.codeclimate.com/v1/badges/179ba669f18869b0040a/maintainability)](https://codeclimate.com/github/OpenSourcePolitics/decidim-module-navbar_links/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/179ba669f18869b0040a/test_coverage)](https://codeclimate.com/github/OpenSourcePolitics/decidim-module-navbar_links/test_coverage)
+
+## Usage
+
+NavbarLinks adds a custom link to your decidim menu.
+
+Admin view:
+![Admin view](https://github.com/OpenSourcePolitics/decidim-module-navbar_links/blob/media/admin.png)
+
+Homepage view:
+![Home view](https://github.com/OpenSourcePolitics/decidim-module-navbar_links/blob/media/home.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-navbar_links', git: "https://github.com/OpenSourcePolitics/decidim-module-navbar_links"
+```
+
+And then execute:
+
+```bash
+$ bundle
+$ bundle exec rake decidim_navbar_links:install:migrations
+$ bundle exec rake db:migrate
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+def install_module(path)
+  Dir.chdir(path) do
+    system("bundle exec rake decidim_navbar_links:install:migrations")
+    system("bundle exec rake db:migrate")
+  end
+end
+
+def seed_db(path)
+  Dir.chdir(path) do
+    system("bundle exec rake db:seed")
+  end
+end
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app" do
+  ENV["RAILS_ENV"] = "test"
+  install_module("spec/decidim_dummy_app")
+end
+
+desc "Generates a development app"
+task development_app: "decidim:generate_external_development_app" do
+  install_module("development_app")
+end

data/app/assets/images/decidim/navbar_links/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zm9.5 13.7H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zm0 3.68H8a1 1 0 0 1 0-1.94h19a1 1 0 0 1 0 1.94zM22.26 23H8a1 1 0 0 1 0-1.94h14.26a1 1 0 0 1 0 1.94z"/></svg>

data/app/commands/decidim/navbar_links/admin/create_navbar_link.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    module Admin
+      # A command with all the business logic when creating a static NavbarLink.
+      class CreateNavbarLink < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_navbar_link
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form
+
+        def create_navbar_link
+          Decidim::NavbarLinks::NavbarLink.create!(
+            title: form.title,
+            link: form.link,
+            weight: form.weight,
+            target: form.target,
+            organization: form.organization
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/navbar_links/admin/update_navbar_link.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    module Admin
+      # A command with all the business logic when updating a navbar link.
+      class UpdateNavbarLink < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form, navbar_link)
+          @form = form
+          @navbar_link = navbar_link
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          update_navbar_link
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form
+
+        def update_navbar_link
+          @navbar_link.update!(attributes)
+        end
+
+        def attributes
+          {
+            title: form.title,
+            link: form.link,
+            weight: form.weight,
+            target: form.target,
+            organization: form.organization
+          }
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/navbar_links/admin/application_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `decidim::admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::ApplicationController
+        def permission_class_chain
+          [Decidim::NavbarLinks::Admin::Permissions] + super
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/navbar_links/admin/navbar_links_controller.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    module Admin
+      class NavbarLinksController < NavbarLinks::Admin::ApplicationController
+        layout "decidim/admin/settings"
+        helper_method :navbar_link
+
+        def index
+          enforce_permission_to :index, :navbar_link
+          @navbar_links = NavbarLink.organization(current_organization)
+        end
+
+        def new
+          enforce_permission_to :new, :navbar_link
+          @form = form(Decidim::NavbarLinks::Admin::NavbarLinkForm).instance
+        end
+
+        def create
+          enforce_permission_to :new, :navbar_link
+          @form = form(Decidim::NavbarLinks::Admin::NavbarLinkForm).from_params(params)
+
+          Decidim::NavbarLinks::Admin::CreateNavbarLink.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("navbar_links.create.success", scope: "decidim.admin")
+              redirect_to navbar_links_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("navbar_links.create.error", scope: "decidim.admin")
+              render :new
+            end
+          end
+        end
+
+        def edit
+          enforce_permission_to :update, :navbar_link, navbar_link: navbar_link
+          @form = form(Decidim::NavbarLinks::Admin::NavbarLinkForm).from_model(navbar_link)
+        end
+
+        def update
+          enforce_permission_to :update, :navbar_link, navbar_link: navbar_link
+          @form = form(Decidim::NavbarLinks::Admin::NavbarLinkForm).from_params(params)
+
+          Decidim::NavbarLinks::Admin::UpdateNavbarLink.call(@form, navbar_link) do
+            on(:ok) do
+              flash[:notice] = I18n.t("navbar_links.update.success", scope: "decidim.admin")
+              redirect_to navbar_links_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("navbar_links.update.error", scope: "decidim.admin")
+              render :edit
+            end
+          end
+        end
+
+        def destroy
+          enforce_permission_to :destroy, :navbar_link
+          navbar_link.destroy!
+
+          flash[:notice] = I18n.t("navbar_links.destroy.success", scope: "decidim.admin")
+
+          redirect_to navbar_links_path
+        end
+
+        private
+
+        def navbar_link
+          @navbar_link = Decidim::NavbarLinks::NavbarLink.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/navbar_links/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/forms/decidim/navbar_links/admin/navbar_link_form.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    module Admin
+      # A form object to create or update scopes.
+      class NavbarLinkForm < Form
+        include TranslatableAttributes
+
+        translatable_attribute :title, String
+        attribute :link, String
+        attribute :weight, Integer
+        attribute :target, String
+
+        validates :link, format: { with: URI.regexp(%w(http https)) }, presence: true
+        validates :title, translatable_presence: true
+        validates :weight, presence: true
+
+        alias organization current_organization
+      end
+    end
+  end
+end

data/app/forms/decidim/navbar_links/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/helpers/decidim/navbar_links/application_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    # Custom helpers, scoped to the navbar_links engine.
+    #
+    module ApplicationHelper
+    end
+  end
+end

data/app/models/decidim/navbar_links/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/navbar_links/navbar_link.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    class NavbarLink < ApplicationRecord
+      belongs_to :organization, foreign_key: "decidim_organization_id", class_name: "Decidim::Organization"
+      scope :organization, ->(organization) { where(organization: organization) }
+      before_save :validate_link_regex
+
+      def validate_link_regex
+        link = URI.parse(self.link)
+        link&.host
+      rescue URI::InvalidURIError
+        errors.add(:link)
+      end
+    end
+  end
+end

data/app/permissions/decidim/navbar_links/admin/permissions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          if permission_action.subject == :navbar_link
+            if permission_action.scope == :admin && user&.admin?
+              allow!
+            else
+              disallow!
+            end
+          end
+
+          permission_action
+        end
+      end
+    end
+  end
+end

data/app/views/decidim/navbar_links/admin/navbar_links/_form.html.erb

@@ -0,0 +1,16 @@
+<div class="row column">
+  <%= form.translated :text_field, :title, label: t(".title") %>
+</div>
+
+<div class="row">
+  <div class="columns xlarge-6">
+    <%= form.text_field :link, placeholder: "http://", label: t(".link") %>
+  </div>
+  <div class="columns xlarge-6">
+    <%= form.number_field :weight, label: t(".weight") %>
+  </div>
+  <div class="columns xlarge-6">
+    <%= form.radio_button :target, "blank", label: t(".new_tab") %>
+    <%= form.radio_button :target, "", label: t(".same_tab") %>
+  </div>
+</div>

data/app/views/decidim/navbar_links/admin/navbar_links/edit.html.erb

@@ -0,0 +1,13 @@
+<%= decidim_form_for(@form) do |f| %>
+  <div class="card">
+    <div class="card-divider">
+      <h2 class="card-title"><%= t ".title" %></h2>
+    </div>
+    <div class="card-section">
+      <%= render partial: "form", object: f %>
+    </div>
+  </div>
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

data/app/views/decidim/navbar_links/admin/navbar_links/index.html.erb

@@ -0,0 +1,48 @@
+<div class="card" id="navbar_links">
+  <div class="card-divider">
+    <h2 class="card-title">
+        <%= t "decidim.admin.titles.navbar_links" %> <%= link_to t("actions.add", scope: "decidim.admin"), new_navbar_link_path, class: "button tiny button--title" %>
+    </h2>
+  </div>
+  <div class="card-section">
+    <% if @navbar_links.any? %>
+      <div class="table-scroll">
+        <table class="table-list">
+        <thead>
+          <tr>
+            <th><%= t("models.navbar_link.fields.title", scope: "decidim.admin") %></th>
+            <th><%= t("models.navbar_link.fields.weight", scope: "decidim.admin") %></th>
+            <th><%= t("models.navbar_link.fields.link", scope: "decidim.admin") %></th>
+            <th></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @navbar_links.each do |navbar_link| %>
+            <tr id="<%= "navbar_link_#{navbar_link.id}" %>">
+              <td>
+                <%= translated_attribute(navbar_link.title) %>
+              </td>
+              <td>
+                <%= navbar_link.weight %>
+              </td>
+              <td>
+                <%= link_to navbar_link.link, navbar_link.link, target: :blank %>
+              </td>
+              <td class="table-list__actions">
+                <% if allowed_to? :update, :navbar_link %>
+                  <%= icon_link_to "pencil", ["edit", navbar_link], t("actions.edit", scope: "decidim.admin"), class: "action-icon--edit", method: :get, data: {} %>
+                <% end %>
+                <% if allowed_to? :destroy, :navbar_link %>
+                  <%= icon_link_to "circle-x", navbar_link, t("actions.destroy", scope: "decidim.admin"), class: "action-icon--remove", method: :delete, data: { confirm: t("actions.confirm_destroy", scope: "decidim.admin") } %>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+        </table>
+      </div>
+    <% else %>
+      <p><%= t("decidim.admin.navbar_links.no_links") %></p>
+    <% end %>
+  </div>
+</div>

data/app/views/decidim/navbar_links/admin/navbar_links/new.html.erb

@@ -0,0 +1,13 @@
+<%= decidim_form_for(@form, url: navbar_links_path) do |f| %>
+  <div class="card">
+    <div class="card-divider">
+      <h2 class="card-title"><%= t ".title" %></h2>
+    </div>
+    <div class="card-section">
+      <%= render partial: "form", object: f %>
+    </div>
+  </div>
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".create") %>
+  </div>
+<% end %>

data/app/views/layouts/decidim/admin/settings.html.erb

@@ -0,0 +1,40 @@
+<% content_for :secondary_nav do %>
+  <div class="secondary-nav">
+    <div class="secondary-nav__title">
+      <%= t ".title" %>
+    </div>
+    <ul>
+      <li <% if is_active_link?(decidim_admin.edit_organization_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.configuration", scope: "decidim.admin"), decidim_admin.edit_organization_path %>
+      </li>
+      <li <% if is_active_link?(decidim_admin.edit_organization_appearance_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.appearance", scope: "decidim.admin"), decidim_admin.edit_organization_appearance_path %>
+      </li>
+      <li <% if is_active_link?(decidim_admin.edit_organization_homepage_path, /^\/admin\/organization\/homepage/) %> class="is-active" <% end %>>
+        <%= link_to t("menu.homepage", scope: "decidim.admin"), decidim_admin.edit_organization_homepage_path %>
+      </li>
+      <li <% if is_active_link?(decidim_admin_navbar_links.navbar_links_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.navbar_links", scope: "decidim_navbar_links.admin"), decidim_admin_navbar_links.navbar_links_path %>
+      </li>
+      <li <% if is_active_link?(decidim_admin.scopes_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.scopes", scope: "decidim.admin"), decidim_admin.scopes_path %>
+      </li>
+      <li <% if is_active_link?(decidim_admin.scope_types_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.scope_types", scope: "decidim.admin"), decidim_admin.scope_types_path %>
+      </li>
+      <li <% if is_active_link?(decidim_admin.areas_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.areas", scope: "decidim.admin"), decidim_admin.areas_path %>
+      </li>
+      <li <% if is_active_link?(decidim_admin.area_types_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.area_types", scope: "decidim.admin"), decidim_admin.area_types_path %>
+      </li>
+      <li <% if allowed_to?(:update, :help_sections) && is_active_link?(decidim_admin.help_sections_path) %> class="is-active" <% end %>>
+        <%= link_to t("menu.help_sections", scope: "decidim.admin"), decidim_admin.help_sections_path %>
+      </li>
+    </ul>
+  </div>
+<% end %>
+
+<%= render "layouts/decidim/admin/application" do %>
+  <%= yield %>
+<% end %>

data/config/i18n-tasks.yml

@@ -0,0 +1,10 @@
+---
+
+base_locale: en
+locales: [en]
+
+ignore_unused:
+  - "decidim.components.navbar_links.name"
+
+ignore_missing:
+  - decidim.participatory_processes.scopes.global

data/config/locales/en.yml

@@ -0,0 +1,64 @@
+---
+en:
+  decidim:
+    admin:
+      actions:
+        add: Add
+        confirm_destroy: Confirm destroy
+        destroy: Destroy
+        edit: Edit
+      menu:
+        appearance: Appearance
+        area_types: Area types
+        areas: Areas
+        configuration: Configuration
+        help_sections: Help sections
+        homepage: Homepage
+        navbar_links: Navbar links
+        scope_types: Scope types
+        scopes: Scopes
+      models:
+        navbar_link:
+          fields:
+            link: Link
+            title: Title
+            weight: Weight
+      navbar_links:
+        create:
+          error: Error
+          success: Success
+        destroy:
+          success: Success
+        no_links: No links
+        update:
+          error: Error
+          success: Success
+      titles:
+        navbar_links: Navbar Links
+    components:
+      navbar_links:
+        name: NavbarLinks
+    navbar_links:
+      admin:
+        navbar_links:
+          edit:
+            title: Title
+            update: Update
+          form:
+            link: Link
+            new_tab: New tab
+            same_tab: Same tab
+            title: Title
+            weight: Weight
+          new:
+            create: Create
+            title: Title
+  decidim_navbar_links:
+    admin:
+      menu:
+        navbar_links: Navbar links
+  layouts:
+    decidim:
+      admin:
+        settings:
+          title: Title

data/lib/decidim/navbar_links/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    # This module contains all the domain logic associated to decidim's NavbarLinks
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/navbar_links/admin_engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavbarLinks
+    # This is the engine that runs on the public interface of `NavbarLinks`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::NavbarLinks::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resources :navbar_links
+        root to: "navbar_links#index"
+      end
+
+      initializer "decidim_navbar_links.admin_mount_routes" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::NavbarLinks::AdminEngine, at: "/admin", as: "decidim_admin_navbar_links"
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/navbar_links/engine.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+
+module Decidim
+  module NavbarLinks
+    # This is the engine that runs on the public interface of navbar_links.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::NavbarLinks
+
+      initializer "decidim.menu" do
+        Decidim.menu :menu do |menu|
+          NavbarLink.organization(current_organization).each do |navbar_link|
+            menu.item translated_attribute(navbar_link.title),
+                      navbar_link.link,
+                      position: 5,
+                      active: :exact,
+                      target: navbar_link.target
+          end
+        end
+      end
+    end
+  end
+end