Feature/documents

README.md

@@ -6,6 +6,7 @@ The backoffice for laws and pathways
 
 - Ruby v2.5.5
 - Rails v5.2.3
+- Node v10
 
 ## Local installation
 
@@ -15,6 +16,10 @@ These are the steps to run the project locally:
 
 On the project's root run `bundle install`.
 
+### Installing npm dependencies
+
+`yarn`
+
 ### Database
 
 #### Create database schema
@@ -23,7 +28,11 @@ On the project's root run `bundle install`.
 
 ### Run the server
 
-`bundle exec rails s'` and access the project on `http://localhost:3000`
+`yarn start'` and access the project on `http://localhost:3000`
+
+### Run the tests
+
+`yarn test`
 
 ## Docker
 

app/admin/documents.rb

@@ -0,0 +1,36 @@
+ActiveAdmin.register Document do
+  menu priority: 3
+
+  decorate_with DocumentDecorator
+
+  filter :name_contains
+  filter :documentable_type, label: 'Attached to'
+
+  config.batch_actions = false
+
+  actions :all, except: [:new, :edit, :create, :update]
+
+  show do
+    attributes_table do
+      row :id
+      row :name
+      row :link, &:open_link
+      row :last_verified_on
+      row :created_at
+      row :updated_at
+    end
+  end
+
+  index do
+    column 'name', &:name_link
+    column 'Attached To', :documentable
+    column :last_verified_on
+    actions
+  end
+
+  controller do
+    def scoped_collection
+      super.includes(:documentable)
+    end
+  end
+end

app/admin/litigations.rb

@@ -3,7 +3,10 @@
 
   decorate_with LitigationDecorator
 
-  permit_params :title, :location_id, :document_type, :summary, :core_objective
+  permit_params :title, :location_id, :document_type, :summary, :core_objective,
+                documents_attributes: [
+                  :id, :_destroy, :name, :external_url, :type, :file
+                ]
 
   filter :title_contains
   filter :summary_contains
@@ -36,6 +39,7 @@
           row :core_objective
           row :created_at
           row :updated_at
+          list_row 'Documents', :document_list
         end
       end
 
@@ -51,21 +55,13 @@
     end
   end
 
-  form do |f|
-    f.semantic_errors(*f.object.errors.keys)
+  form partial: 'form'
 
-    f.inputs do
-      f.input :title
-      f.input :location
-      f.input :document_type, as: :select, collection: array_to_select_collection(Litigation::DOCUMENT_TYPES)
-      f.input :summary, as: :trix
-      f.input :core_objective, as: :trix
+  controller do
+    def scoped_collection
+      super.includes(:location)
     end
 
-    f.actions
-  end
-
-  controller do
     def find_resource
       scoped_collection.friendly.find(params[:id])
     end

app/assets/stylesheets/active_admin.scss

@@ -1,11 +1,7 @@
-$am-theme-primary: #00689f;
-$am-theme-accent: #7dd2f7;
-$am-theme-accent-fallback: #ff7547;
-
-$padding: 20px;
-
+@import 'admin/settings';
 @import 'trix/dist/trix';
 @import 'activeadmin_addons/all';
+
 // SASS variable overrides must be declared before loading up Active Admin's styles.
 //
 // To view the variables that Active Admin provides, take a look at
@@ -23,6 +19,22 @@ $padding: 20px;
   display: none;
 }
 
+.button {
+  margin: 0;
+
+  &--raised {
+    @include am-btn-raised;
+  }
+
+  &--red {
+    background-color: $admin-red;
+
+    &:hover {
+      background-color: lighten($admin-red, 20%);
+    }
+  }
+}
+
 .table_tools {
   .scope {
     margin: 0;
@@ -128,3 +140,25 @@ form {
     }
   }
 }
+
+// Documents
+
+.document-list {
+  &__actions {
+    padding: 16px;
+  }
+}
+
+.inline-fields {
+  display: flex;
+  justify-content: space-around;
+  align-items: flex-end;
+
+  li {
+    margin: 0;
+  }
+
+  .flex-grow-1 {
+    flex-grow: 1;
+  }
+}

app/assets/stylesheets/admin/settings.scss

@@ -0,0 +1,9 @@
+$padding: 20px;
+
+//Colors
+$admin-red: red;
+
+// Active Material Theme Colors Change
+$am-theme-primary: #00689f;
+$am-theme-accent: #7dd2f7;
+$am-theme-accent-fallback: $admin-red;

app/decorators/document_decorator.rb

@@ -0,0 +1,17 @@
+class DocumentDecorator < Draper::Decorator
+  delegate_all
+
+  def name_link
+    h.link_to model.name, h.admin_document_path(model)
+  end
+
+  def open_link
+    h.link_to model.name, model.url, target: '_blank'
+  end
+
+  def last_verified_on
+    return 'N/A' if model.uploaded?
+
+    model.last_verified_on
+  end
+end

app/decorators/litigation_decorator.rb

@@ -16,4 +16,12 @@ def summary
   def core_objective
     model.core_objective.html_safe
   end
+
+  def document_list
+    return [] if model.documents.empty?
+
+    model.documents.map do |document|
+      h.link_to document.name, document.url, target: '_blank'
+    end
+  end
 end

app/javascript/controllers/dependent_input_controller.js

@@ -1,4 +1,4 @@
-import { Controller } from "stimulus";
+import { Controller } from 'stimulus';
 
 export default class extends Controller {
   connect() {

app/javascript/controllers/document_list_controller.js

@@ -0,0 +1,36 @@
+import { Controller } from 'stimulus';
+
+export default class extends Controller {
+  static targets = [ 'links', 'templateExternal', 'templateUploaded']
+
+  connect() {
+    this.wrapperClass = this.data.get('wrapperClass') || 'nested-fields';
+  }
+
+  addRecord(event) {
+    event.preventDefault();
+
+    const templateName = event.target.dataset['template'];
+    const content = this[`template${templateName}Target`]
+          .innerHTML
+          .replace(/NEW_RECORD/g, new Date().getTime());
+
+    this.linksTarget.insertAdjacentHTML('beforebegin', content);
+  }
+
+  removeRecord(event) {
+    event.preventDefault();
+
+    const wrapper = event.target.closest('.' + this.wrapperClass);
+
+    // New records are simply removed from the page
+    if (wrapper.dataset.newRecord == 'true') {
+      wrapper.remove();
+
+      // Existing records are hidden and flagged for deletion
+    } else {
+      wrapper.querySelector('input[name*="_destroy"]').value = 1;
+      wrapper.style.display = 'none';
+    }
+  }
+}

app/models/document.rb

@@ -0,0 +1,51 @@
+# == Schema Information
+#
+# Table name: documents
+#
+#  id                :bigint           not null, primary key
+#  name              :string           not null
+#  type              :string           not null
+#  external_url      :text
+#  language          :string
+#  last_verified_on  :date
+#  documentable_type :string
+#  documentable_id   :bigint
+#  created_at        :datetime         not null
+#  updated_at        :datetime         not null
+#
+
+class Document < ApplicationRecord
+  self.inheritance_column = nil
+
+  TYPES = %w[uploaded external].freeze
+  enum type: array_to_enum_hash(TYPES)
+
+  belongs_to :documentable, polymorphic: true
+
+  has_one_attached :file
+
+  before_create :set_last_verified_on
+
+  validates :external_url, url: true, presence: true, if: :external?
+  validates :file, attached: true, if: :uploaded?
+
+  validates_presence_of :name, :type
+
+  def url
+    return file_url if uploaded?
+
+    external_url
+  end
+
+  private
+
+  def file_url
+    return unless file.attached?
+
+    Rails.application.routes.url_helpers.polymorphic_url(file, only_path: true)
+  end
+
+  def set_last_verified_on
+    self.last_verified_on = Time.zone.now.to_date
+  end
+end

app/models/litigation.rb

@@ -26,6 +26,9 @@ class Litigation < ApplicationRecord
 
   belongs_to :location
   has_many :litigation_sides
+  has_many :documents, as: :documentable, dependent: :destroy
+
+  accepts_nested_attributes_for :documents, allow_destroy: true
 
   validates_presence_of :title, :slug, :document_type
 end

app/validators/attached_validator.rb

@@ -0,0 +1,5 @@
+class AttachedValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, :attached, options) unless value.attached?
+  end
+end

app/validators/url_validator.rb

@@ -0,0 +1,16 @@
+class UrlValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return unless value.present?
+
+    record.errors[attribute] << (options[:message] || 'must be a valid URL') unless url_valid?(value)
+  end
+
+  def url_valid?(url)
+    url = begin
+            URI.parse(url)
+          rescue StandardError
+            false
+          end
+    url.is_a?(URI::HTTP) || url.is_a?(URI::HTTPS)
+  end
+end

app/views/admin/documents/_fields.html.erb

@@ -0,0 +1,17 @@
+<% is_new_record = form.object.new_record? %>
+
+<%= content_tag :div, class: "nested-fields inline-fields", data: { new_record: is_new_record } do %>
+  <%= form.input :type, as: :hidden, input_html: { value: form.object.type } %>
+  <div style="width: 33%;">
+    <% if form.object.external? %>
+      <%= form.input :external_url, as: :string, label: 'Provide external url' %>
+    <% else %>
+      <%= form.input :file, as: :file %>
+    <% end %>
+  </div>
+  <%= form.input :name, wrapper_html: { class: 'flex-grow-1' } %>
+  <li class="input">
+    <%= button_tag "Remove", type: 'button', class: 'button button--raised button--red', data: { action: "click->document-list#removeRecord" } %>
+  </li>
+  <%= form.hidden_field :_destroy %>
+<% end %>

app/views/admin/documents/_list.html.erb

@@ -0,0 +1,22 @@
+<div class="document-list" data-controller="document-list">
+  <template data-target="document-list.templateExternal">
+    <%= form.semantic_fields_for :documents, Document.new(type: 'external'), child_index: 'NEW_RECORD' do |document| %>
+      <%= render "admin/documents/fields", form: document %>
+    <% end %>
+  </template>
+
+  <template data-target="document-list.templateUploaded">
+    <%= form.semantic_fields_for :documents, Document.new(type: 'uploaded'), child_index: 'NEW_RECORD' do |document| %>
+      <%= render "admin/documents/fields", form: document %>
+    <% end %>
+  </template>
+
+  <%= form.semantic_fields_for :documents do |document| %>
+    <%= render "admin/documents/fields", form: document %>
+  <% end %>
+
+  <div class="document-list__actions" data-target="document-list.links">
+    <%= button_tag "Add External URL", type: 'button', class: 'button button--raised', data: { action: "click->document-list#addRecord", template: 'External' } %>
+    <%= button_tag "Upload a new file", type: 'button', class: 'button button--raised', data: { action: "click->document-list#addRecord", template: 'Uploaded' } %>
+  </div>
+</div>