From 19c78d6072ba4825c38d2a0095fa40446dadfd30 Mon Sep 17 00:00:00 2001 From: Ridhwana Date: Wed, 7 Oct 2020 17:20:32 +0200 Subject: [PATCH] [deploy] Prepare the database for the configurable navigation items (#10662) * feat: add the order of the navigational items to the database + admin interface * refactor: rename :display_when_signed_in to :display_only_when_signed_in * chore: rename all instances of display_when_signed_in to display_only_when_signed_in * feat: add a data script that will setup the base urls * feat: add a temporary rake file that will allow us to seed prod db's * chore: oops rename file * chore: remove the index for now * chore: remove validation * feat: change the order field to position and add an index o the name and url * feat: update everything that uses order to position * refactor: order by name as a secondary attr --- .../admin/navigation_links_controller.rb | 4 +- app/models/navigation_link.rb | 4 +- .../_add_navigation_link_modal.html.erb | 8 ++- .../_edit_navigation_link_modal.html.erb | 8 ++- .../admin/navigation_links/index.html.erb | 3 +- ...ange_display_when_signed_in_column_name.rb | 5 ++ ...085440_add_position_to_navigation_links.rb | 5 ++ ..._index_to_navigation_links_url_and_name.rb | 6 ++ db/schema.rb | 6 +- .../20201001173841_add_navigation_links.rb | 26 +++++++++ .../temporary/add_dev_navigation_links.rake | 58 +++++++++++++++++++ 11 files changed, 122 insertions(+), 11 deletions(-) create mode 100644 db/migrate/20201005181510_change_display_when_signed_in_column_name.rb create mode 100644 db/migrate/20201007085440_add_position_to_navigation_links.rb create mode 100644 db/migrate/20201007091041_add_unique_index_to_navigation_links_url_and_name.rb create mode 100644 lib/data_update_scripts/20201001173841_add_navigation_links.rb create mode 100644 lib/tasks/temporary/add_dev_navigation_links.rake diff --git a/app/controllers/admin/navigation_links_controller.rb b/app/controllers/admin/navigation_links_controller.rb index d9a09e12c..7fd9a5d71 100644 --- a/app/controllers/admin/navigation_links_controller.rb +++ b/app/controllers/admin/navigation_links_controller.rb @@ -1,12 +1,12 @@ module Admin class NavigationLinksController < Admin::ApplicationController ALLOWED_PARAMS = %i[ - name url icon display_when_signed_in + name url icon display_only_when_signed_in position ].freeze layout "admin" def index - @navigation_links = NavigationLink.order(:name) + @navigation_links = NavigationLink.order(position: :asc, name: :asc) end def create diff --git a/app/models/navigation_link.rb b/app/models/navigation_link.rb index 5536c90f8..6bbd5e26f 100644 --- a/app/models/navigation_link.rb +++ b/app/models/navigation_link.rb @@ -2,7 +2,7 @@ class NavigationLink < ApplicationRecord SVG_REGEXP = //i.freeze validates :name, :url, :icon, presence: true - validates :url, url: { schemes: %w[https http] } + validates :url, url: { schemes: %w[https http] }, uniqueness: { scope: :name } validates :icon, format: SVG_REGEXP - validates :display_when_signed_in, inclusion: { in: [true, false] } + validates :display_only_when_signed_in, inclusion: { in: [true, false] } end diff --git a/app/views/admin/navigation_links/_add_navigation_link_modal.html.erb b/app/views/admin/navigation_links/_add_navigation_link_modal.html.erb index 49acc9c32..68a68b4c0 100644 --- a/app/views/admin/navigation_links/_add_navigation_link_modal.html.erb +++ b/app/views/admin/navigation_links/_add_navigation_link_modal.html.erb @@ -30,8 +30,12 @@ <%= form.text_area :icon, class: "form-control" %>
- <%= form.check_box :display_when_signed_in %> - <%= form.label :display_when_signed_in %> + <%= form.label :position %> + <%= form.number_field :position, class: "form-control" %> +
+
+ <%= form.check_box :display_only_when_signed_in %> + <%= form.label :display_only_when_signed_in %>
<%= form.submit "Add link", class: "crayons-btn" %> <% end %> diff --git a/app/views/admin/navigation_links/_edit_navigation_link_modal.html.erb b/app/views/admin/navigation_links/_edit_navigation_link_modal.html.erb index 77a3193d1..7c4411a3c 100644 --- a/app/views/admin/navigation_links/_edit_navigation_link_modal.html.erb +++ b/app/views/admin/navigation_links/_edit_navigation_link_modal.html.erb @@ -29,8 +29,12 @@ <%= form.text_field :icon, class: "form-control" %>
- <%= form.check_box :display_when_signed_in %> - <%= form.label :display_when_signed_in %> + <%= form.label :position %> + <%= form.number_field :position, class: "form-control" %> +
+
+ <%= form.check_box :display_only_when_signed_in %> + <%= form.label :display_only_when_signed_in %>
<%= form.submit class: "btn btn-primary" %> <% end %> diff --git a/app/views/admin/navigation_links/index.html.erb b/app/views/admin/navigation_links/index.html.erb index 4e8d9203e..6a8cddce0 100644 --- a/app/views/admin/navigation_links/index.html.erb +++ b/app/views/admin/navigation_links/index.html.erb @@ -1,6 +1,7 @@ <%= render "add_navigation_link_modal" %> <% @navigation_links.each do |link| %> -
+
+
<%= link.position %>
diff --git a/db/migrate/20201005181510_change_display_when_signed_in_column_name.rb b/db/migrate/20201005181510_change_display_when_signed_in_column_name.rb new file mode 100644 index 000000000..dc370bca9 --- /dev/null +++ b/db/migrate/20201005181510_change_display_when_signed_in_column_name.rb @@ -0,0 +1,5 @@ +class ChangeDisplayWhenSignedInColumnName < ActiveRecord::Migration[6.0] + def change + safety_assured { rename_column :navigation_links, :display_when_signed_in, :display_only_when_signed_in } + end +end diff --git a/db/migrate/20201007085440_add_position_to_navigation_links.rb b/db/migrate/20201007085440_add_position_to_navigation_links.rb new file mode 100644 index 000000000..be6870dfa --- /dev/null +++ b/db/migrate/20201007085440_add_position_to_navigation_links.rb @@ -0,0 +1,5 @@ +class AddPositionToNavigationLinks < ActiveRecord::Migration[6.0] + def change + add_column :navigation_links, :position, :integer + end +end diff --git a/db/migrate/20201007091041_add_unique_index_to_navigation_links_url_and_name.rb b/db/migrate/20201007091041_add_unique_index_to_navigation_links_url_and_name.rb new file mode 100644 index 000000000..3969231f6 --- /dev/null +++ b/db/migrate/20201007091041_add_unique_index_to_navigation_links_url_and_name.rb @@ -0,0 +1,6 @@ +class AddUniqueIndexToNavigationLinksUrlAndName < ActiveRecord::Migration[6.0] + disable_ddl_transaction! + def change + add_index :navigation_links, [:url, :name], unique: true, algorithm: :concurrently + end +end diff --git a/db/schema.rb b/db/schema.rb index 305687283..05e6694a6 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,7 +10,7 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema.define(version: 2020_10_02_104711) do +ActiveRecord::Schema.define(version: 2020_10_07_091041) do # These are extensions that must be enabled in order to support this database enable_extension "citext" @@ -671,11 +671,13 @@ ActiveRecord::Schema.define(version: 2020_10_02_104711) do create_table "navigation_links", force: :cascade do |t| t.datetime "created_at", precision: 6, null: false - t.boolean "display_when_signed_in", default: false + t.boolean "display_only_when_signed_in", default: false t.string "icon", null: false t.string "name", null: false + t.integer "position" t.datetime "updated_at", precision: 6, null: false t.string "url", null: false + t.index ["url", "name"], name: "index_navigation_links_on_url_and_name", unique: true end create_table "notes", force: :cascade do |t| diff --git a/lib/data_update_scripts/20201001173841_add_navigation_links.rb b/lib/data_update_scripts/20201001173841_add_navigation_links.rb new file mode 100644 index 000000000..feb05e55e --- /dev/null +++ b/lib/data_update_scripts/20201001173841_add_navigation_links.rb @@ -0,0 +1,26 @@ +module DataUpdateScripts + class AddNavigationLinks + PROTOCOL = ApplicationConfig["APP_PROTOCOL"].freeze + DOMAIN = Rails.application&.initialized? ? SiteConfig.app_domain : ApplicationConfig["APP_DOMAIN"] + BASE_URL = "#{PROTOCOL}#{DOMAIN}".freeze + + READING_ICON = File.read(Rails.root.join("app/assets/images/twemoji/drawer.svg")).freeze + THUMB_UP_ICON = File.read(Rails.root.join("app/assets/images/twemoji/thumb-up.svg")).freeze + SMART_ICON = File.read(Rails.root.join("app/assets/images/twemoji/smart.svg")).freeze + LOOK_ICON = File.read(Rails.root.join("app/assets/images/twemoji/look.svg")).freeze + CONTACT_ICON = File.read(Rails.root.join("app/assets/images/twemoji/contact.svg")).freeze + + def run + NavigationLink.where(name: "Reading List", url: "#{BASE_URL}/readinglist", icon: READING_ICON, + display_only_when_signed_in: true, position: 0).first_or_create + NavigationLink.where(name: "Code of Conduct", url: "#{BASE_URL}/code-of-conduct", icon: THUMB_UP_ICON, + display_only_when_signed_in: false, position: 1).first_or_create + NavigationLink.where(name: "Privacy Policy", url: "#{BASE_URL}/privacy", icon: SMART_ICON, + display_only_when_signed_in: false, position: 2).first_or_create + NavigationLink.where(name: "Terms of use", url: "#{BASE_URL}/terms", icon: LOOK_ICON, + display_only_when_signed_in: false, position: 3).first_or_create + NavigationLink.where(name: "Contact", url: "#{BASE_URL}/contact", icon: CONTACT_ICON, + display_only_when_signed_in: false, position: 4).first_or_create + end + end +end diff --git a/lib/tasks/temporary/add_dev_navigation_links.rake b/lib/tasks/temporary/add_dev_navigation_links.rake new file mode 100644 index 000000000..68e44248c --- /dev/null +++ b/lib/tasks/temporary/add_dev_navigation_links.rake @@ -0,0 +1,58 @@ +# rubocop:disable Metrics/BlockLength +namespace :temporary do + namespace :navigation_links do + desc "Update DEV's navigation_links" + task update_links: :environment do + protocol = ApplicationConfig["APP_PROTOCOL"].freeze + domain = Rails.application&.initialized? ? SiteConfig.app_domain : ApplicationConfig["APP_DOMAIN"] + base_url = "#{protocol}#{domain}".freeze + + reading_icon = File.read(Rails.root.join("app/assets/images/twemoji/drawer.svg")).freeze + thumb_up_icon = File.read(Rails.root.join("app/assets/images/twemoji/thumb-up.svg")).freeze + smart_icon = File.read(Rails.root.join("app/assets/images/twemoji/smart.svg")).freeze + look_icon = File.read(Rails.root.join("app/assets/images/twemoji/look.svg")).freeze + contact_icon = File.read(Rails.root.join("app/assets/images/twemoji/contact.svg")).freeze + + # we can probably remove these icons once they in the database + listing_icon = File.read(Rails.root.join("app/assets/images/twemoji/listing.svg")).freeze + mic_icon = File.read(Rails.root.join("app/assets/images/twemoji/mic.svg")).freeze + camera_icon = File.read(Rails.root.join("app/assets/images/twemoji/camera.svg")).freeze + tag_icon = File.read(Rails.root.join("app/assets/images/twemoji/tag.svg")).freeze + bulb_icon = File.read(Rails.root.join("app/assets/images/twemoji/bulb.svg")).freeze + shopping_icon = File.read(Rails.root.join("app/assets/images/twemoji/shopping.svg")).freeze + heart_icon = File.read(Rails.root.join("app/assets/images/twemoji/heart.svg")).freeze + rainbowdev = File.read(Rails.root.join("app/assets/images/rainbowdev.svg")).freeze + + NavigationLink.where(url: "#{base_url}/readinglist").first_or_create(name: "Reading List", icon: reading_icon, + display_only_when_signed_in: true, + position: 0) + NavigationLink.where(url: "#{base_url}/listings").first_or_create(name: "Listings", icon: listing_icon, + display_only_when_signed_in: false, position: 1) + NavigationLink.where(url: "#{base_url}/pod").first_or_create(name: "Podcasts", icon: mic_icon, + display_only_when_signed_in: false, position: 2) + NavigationLink.where(url: "#{base_url}/videos").first_or_create(name: "Videos", icon: camera_icon, + display_only_when_signed_in: false, position: 3) + NavigationLink.where(url: "#{base_url}/tags").first_or_create(name: "Tags", icon: tag_icon, + display_only_when_signed_in: false, position: 4) + NavigationLink.where(url: "#{base_url}/code-of-conduct").first_or_create(name: "Code of Conduct", + icon: thumb_up_icon, + display_only_when_signed_in: false, + position: 5) + NavigationLink.where(url: "#{base_url}/faq").first_or_create(name: "FAQ", icon: bulb_icon, + display_only_when_signed_in: false, position: 6) + NavigationLink.where(url: "https://shop.dev.to/").first_or_create(name: "DEV Shop", icon: shopping_icon, + display_only_when_signed_in: false, position: 7) + NavigationLink.where(url: "#{base_url}/sponsors").first_or_create(name: "Sponsors", icon: heart_icon, + display_only_when_signed_in: false, position: 8) + NavigationLink.where(url: "#{base_url}/about").first_or_create(name: "About", icon: rainbowdev, + display_only_when_signed_in: false, position: 9) + NavigationLink.where(url: "#{base_url}/privacy").first_or_create(name: "Privacy Policy", icon: smart_icon, + display_only_when_signed_in: false, position: 10) + NavigationLink.where(url: "#{base_url}/terms").first_or_create(name: "Terms of use", icon: look_icon, + display_only_when_signed_in: false, position: 11) + NavigationLink.where(url: "#{base_url}/contact").first_or_create(name: "Contact", icon: contact_icon, + display_only_when_signed_in: false, position: 12) + end + end +end +# rubocop:enable Metrics/BlockLength