dokno 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edd6bc7f282e312599b5d844e48382a5eff63604c13b05d41859c1beb587e878
-  data.tar.gz: b692a98a50654ae4d7d7a77b123289da686ab37131a0bbdf0f4ffc9151b5a1ab
+  metadata.gz: f136bc4f785f0f392e5e76d19b55d74ae59f59f96f144049cb9e288aaaaeced5
+  data.tar.gz: 117835447f5ef02db4c18de8453f7053a977cec6349528a6b3d15250da42ae0a
 SHA512:
-  metadata.gz: ce6b652432db90585a4b72fe2327a5201409d9872c3408b74d7e5a52253d960b2ce1286fad4c762e09f2d4b72134d49174c4bbe3d4fc02203de1b3d95cc8077c
-  data.tar.gz: ae70e70feb6f78cc30daf751085ef58f50a26b45c9faa1276b5723fdb685c08ada77ff02ba5dee1a781a90c3852d0822702e7a410a2e952baef1545ded3408b2
+  metadata.gz: a49495dd1c51f2eac0508d8df2a7bc34f97a8f7cfa2699f36a3cebfbcc3b5012c7ccf80f1bcc730815a644b08ac4021e02fa0f5fd2b39bac1c86d8c0cbbed13b
+  data.tar.gz: ebe01549788e0f4ab21eb36b1b11a0b7d21518dc4626cba64543e6c3ca66a6de8ea7bc311df6490489df22f51f239b0cb544af79bb2ce7af146a6938be829b8b

data/app/assets/javascripts/dokno.js

@@ -46,7 +46,7 @@ function applyCategoryCriteria(category_code, term, order) {
 
 function goToPage(url) {
   var param_join = url.indexOf('?') >= 0 ? '&' : '?';
-  location.href=url + param_join + '_=' + Math.round(new Date().getTime());
+  location.href = url + param_join + '_=' + Math.round(new Date().getTime());
 }
 
 function reloadPage() {
@@ -74,14 +74,9 @@ function sendRequest(url, data, callback, method) {
   request.send(JSON.stringify(data));
 }
 
-function deactivateArticle(slug) {
+function setArticleStatus(slug, active) {
   const callback = function(_data) { reloadPage(); }
-  sendRequest(dokno__base_path + 'article_status', { slug: slug, active: false }, callback, 'POST');
-}
-
-function activateArticle(slug) {
-  const callback = function(_data) { reloadPage(); }
-  sendRequest(dokno__base_path + 'article_status', { slug: slug, active: true }, callback, 'POST');
+  sendRequest(dokno__base_path + 'article_status', { slug: slug, active: active }, callback, 'POST');
 }
 
 function deleteArticle(id) {

data/app/controllers/dokno/articles_controller.rb

@@ -60,10 +60,10 @@ module Dokno
         @article.categories = Category.where(code: params[:category_code])
         redirect_to article_path @article.slug
       else
-        flash.now[:red]    = 'Article could not be updated'
-        @category_codes    = params[:category_code]
-        @reset_review_date = params[:reset_review_date]
-        @review_notes      = params[:review_notes]
+        flash.now[:red]     = 'Article could not be updated'
+        @category_codes     = params[:category_code]
+        @reset_review_date  = params[:reset_review_date]
+        @review_notes       = params[:review_notes]
         render :edit
       end
     end

data/app/controllers/dokno/categories_controller.rb

@@ -6,9 +6,10 @@ module Dokno
     before_action :fetch_category, only: [:index, :edit, :update]
 
     def index
-      @search_term = params[:search_term]
-      @order       = params[:order]&.strip
-      @order       = 'updated' unless %w(updated newest views alpha).include?(@order)
+      @search_term        = params[:search_term]
+      @order              = params[:order]&.strip
+      @order              = 'updated' unless %w(updated newest views alpha).include?(@order)
+      @show_up_for_review = can_edit? && !request.path.include?(up_for_review_path)
 
       articles = if request.path.include? up_for_review_path
                    Article.up_for_review(order: @order&.to_sym)

data/app/controllers/dokno/pagination_concern.rb

@@ -3,11 +3,11 @@ module Dokno
     extend ActiveSupport::Concern
 
     def paginate(records, max_per_page: 10)
-      @page           = params[:page].to_i
-      @total_records  = records.size
-      @total_pages    = (@total_records.to_f / max_per_page).ceil
-      @total_pages    = 1 unless @total_pages.positive?
-      @page           = 1 unless @page.positive? && @page <= @total_pages
+      @page          = params[:page].to_i
+      @total_records = records.size
+      @total_pages   = (@total_records.to_f / max_per_page).ceil
+      @total_pages   = 1 unless @total_pages.positive?
+      @page          = 1 unless @page.positive? && @page <= @total_pages
 
       records.offset((@page - 1) * max_per_page).limit(max_per_page)
     end

data/app/controllers/dokno/user_concern.rb

@@ -28,7 +28,7 @@ module Dokno
     def can_edit?
       # Allow editing by default if host app user object is not configured
       return true  unless sanitized_user_obj_string.present?
-      return false unless user.respond_to? Dokno.config.app_user_auth_method.to_sym
+      return false unless user&.respond_to? Dokno.config.app_user_auth_method.to_sym
 
       user.send(Dokno.config.app_user_auth_method.to_sym)
     end

data/app/helpers/dokno/application_helper.rb

@@ -9,7 +9,7 @@ module Dokno
 
       return "Dokno article slug '#{slug}' not found" if article.blank?
 
-      %Q(<a href="javascript:;" onclick="doknoOpenPanel('#{j article.slug}');">#{link_text.presence || article.title}</a>).html_safe
+      %Q(<a class="dokno-link" href="javascript:;" onclick="doknoOpenPanel('#{j article.slug}');">#{link_text.presence || article.title}</a>).html_safe
     end
   end
 end

data/app/models/dokno/application_record.rb

@@ -1,5 +1,8 @@
 module Dokno
   class ApplicationRecord < ActiveRecord::Base
     self.abstract_class = true
+
+    include Engine.routes.url_helpers
+    include ActionView::Helpers::DateHelper
   end
 end

data/app/models/dokno/article.rb

@@ -3,9 +3,6 @@ require 'redcarpet'
 
 module Dokno
   class Article < ApplicationRecord
-    include Engine.routes.url_helpers
-    include ActionView::Helpers::DateHelper
-
     has_and_belongs_to_many :categories
     has_many :logs, dependent: :destroy
     has_many :article_slugs, dependent: :destroy
@@ -76,7 +73,10 @@ module Dokno
         .where(dokno_articles_categories: { article_id: id })
         .all
         .map do |category|
-          "<a class='underline' href='#{article_index_path(category.code)}?search_term=#{CGI.escape(search_term.to_s)}&order=#{CGI.escape(order.to_s)}'>#{category.name}</a>" if context_category_id != category.id
+          next if context_category_id == category.id
+
+          "<a class='underline' href='#{article_index_path(category.code)}?search_term="\
+          "#{CGI.escape(search_term.to_s)}&order=#{CGI.escape(order.to_s)}'>#{category.name}</a>"
         end.compact
 
       return '' if names.blank?

data/app/models/dokno/category.rb

@@ -1,41 +1,33 @@
 module Dokno
   class Category < ApplicationRecord
-    belongs_to :parent,
-      class_name: 'Dokno::Category',
-      primary_key: 'id',
-      foreign_key: 'category_id',
-      optional: true,
-      inverse_of: :children
-    has_many :children,
-      class_name: 'Dokno::Category',
-      primary_key: 'id',
-      foreign_key: 'category_id',
-      dependent: :nullify,
-      inverse_of: :parent
+    belongs_to :parent, class_name: 'Dokno::Category', primary_key: 'id', foreign_key: 'category_id', inverse_of: :children, optional: true
+    has_many :children, class_name: 'Dokno::Category', primary_key: 'id', foreign_key: 'category_id', inverse_of: :parent, dependent: :nullify
 
     has_and_belongs_to_many :articles
 
+    before_validation :set_code
     validates :name, :code, presence: true, uniqueness: true
     validate :circular_parent_check
 
-    before_validation :set_code
-
     scope :alpha_order, -> { order(:name) }
 
-    # The display breadcrumb for the Category
-    def breadcrumb
-      crumbs = [name]
+    def breadcrumb(**args)
+      crumbs = [(category_link(self, args) unless args[:hide_self])]
       parent_category_id = category_id
 
       loop do
         break if parent_category_id.blank?
 
-        parent_category = self.class.find(parent_category_id)
-        crumbs.prepend parent_category.name
+        parent_category = Category.find(parent_category_id)
+        crumbs.prepend category_link(parent_category, args)
         parent_category_id = parent_category.category_id
       end
 
-      crumbs.join(' > ')
+      crumbs.compact.join("&nbsp;&nbsp;>&nbsp;&nbsp;").html_safe
+    end
+
+    def category_link(category, args={})
+      %(<a href="#{article_index_path(category.code)}?search_term=#{CGI.escape(args[:search_term].to_s)}&order=#{CGI.escape(args[:order].to_s)}">#{category.name}</a>)
     end
 
     # All Articles in the Category, including all child Categories
@@ -73,26 +65,14 @@ module Dokno
       categories.flatten
     end
 
-    def self.select_option_markup(selected_category_codes: nil, exclude_category_id: nil, context_category: nil, level: 0)
+    def self.select_option_markup(selected_category_codes: nil, context_category: nil, level: 0)
       return '' if level.positive? && context_category.blank?
 
       options = []
       level_categories = where(category_id: context_category&.id).alpha_order
-
       level_categories.each do |category|
-        options << option_markup(
-          category:                category,
-          selected_category_codes: selected_category_codes,
-          exclude_category_id:     exclude_category_id,
-          level:                   level
-        )
-
-        options << select_option_markup(
-          selected_category_codes: selected_category_codes,
-          exclude_category_id:     exclude_category_id,
-          context_category:        category,
-          level:                   (level + 1)
-        )
+        options << option_markup(category: category, selected_category_codes: selected_category_codes, level: level)
+        options << select_option_markup(selected_category_codes: selected_category_codes, context_category: category, level: (level + 1))
       end
 
       options.join
@@ -100,9 +80,7 @@ module Dokno
 
     private
 
-    def self.option_markup(category:, selected_category_codes:, exclude_category_id:, level: 0)
-      return '' if category.id == exclude_category_id
-
+    def self.option_markup(category:, selected_category_codes:, level: 0)
       selected = selected_category_codes&.include?(category.code)
       article_count = category.articles_in_branch.size
       %(<option value="#{category.code}" #{'selected="selected"' if selected}>#{('&nbsp;&nbsp;' * level)}#{category.name}#{' (' + article_count.to_s + ')' if article_count.positive?}</option>)

data/app/views/dokno/articles/_article_form.html.erb

@@ -36,9 +36,9 @@
   </div>
 
   <% if Dokno::Category.exists? %>
-    <div class="mb-5">
-      <div class="text-lg font-semibold"><label for="category_id"><%= 'Category'.pluralize article.categories.count %></label></div>
-      <select name="category_code[]" id="category_code" multiple="multiple" size="<%= (cat_count = Dokno::Category.count) <= 4 ? (cat_count + 1).to_s : '5' %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 w-full mt-2 w-full max-w-full">
+    <div class="mb-5 w-2/3">
+      <div class="text-lg font-semibold"><label for="category_code"><%= 'Category'.pluralize article.categories.count %></label></div>
+      <select name="category_code[]" id="category_code" multiple="multiple" size="<%= (cat_count = Dokno::Category.count) <= 9 ? (cat_count + 1).to_s : '10' %>" class="rounded text-xl shadow-inner bg-gray-100 p-2 w-full mt-2 w-full max-w-full">
         <option></option>
         <%= Dokno::Category.select_option_markup(selected_category_codes: @category_codes).html_safe %>
       </select>

data/app/views/dokno/articles/show.html.erb

@@ -2,7 +2,12 @@
 
 <% if @category.present? %>
   <div class="no-print text-gray-500 mb-5">
-    <div>Category: <a href="<%= article_index_path(@category.code) %>?search_term=<%= CGI.escape(@search_term.to_s) %>&order=<%= @order %>"><%= @category.breadcrumb %></a></div>
+    <div>
+      <% if request.referrer&.include? article_index_path %>
+        <a class="fixed left-0 ml-6" title="Back" href="javascript:history.back();"><i data-feather="chevrons-left" class="text-gray-300 h-5 align-text-bottom inline"></i></a>
+      <% end %>
+      <span class="text-gray-500 mr-1">Under</span> <%= @category.breadcrumb(search_term: @search_term, order: @order) %>
+    </div>
   </div>
 <% end %>
 
@@ -126,9 +131,9 @@
       <button title="Edit article" class="bg-blue-900 text-gray-300 hover:text-white rounded mr-5 py-2 px-3 font-bold text-sm" onclick="location.href='<%= edit_article_path(@article.slug) %>';"><i data-feather="edit-2" class="inline h-5"></i> EDIT</button>
 
       <% if @article.active %>
-        <button title="Deactivate article" id="article-deactivate-button" class="bg-yellow-700 text-gray-300 hover:text-white rounded mr-5 py-2 px-3 font-bold text-base" onclick="deactivateArticle('<%= @article.slug %>');"><i data-feather="file-minus" class="inline h-5"></i> DEACTIVATE</button>
+        <button title="Deactivate article" id="article-deactivate-button" class="bg-yellow-700 text-gray-300 hover:text-white rounded mr-5 py-2 px-3 font-bold text-base" onclick="setArticleStatus('<%= @article.slug %>', false);"><i data-feather="file-minus" class="inline h-5"></i> DEACTIVATE</button>
       <% else %>
-        <button title="Re-activate article" id="article-activate-button" class="bg-green-700 text-gray-300 hover:text-white rounded mr-5 py-2 px-3 font-bold text-base" onclick="activateArticle('<%= @article.slug %>');"><i data-feather="file-plus" class="inline h-5"></i> RE-ACTIVATE</button>
+        <button title="Re-activate article" id="article-activate-button" class="bg-green-700 text-gray-300 hover:text-white rounded mr-5 py-2 px-3 font-bold text-base" onclick="setArticleStatus('<%= @article.slug %>', true);"><i data-feather="file-plus" class="inline h-5"></i> RE-ACTIVATE</button>
       <% end %>
       <button title="Permanently delete article" class="bg-red-700 text-gray-300 hover:text-white rounded py-2 px-3 font-bold text-base" onclick="deleteArticle('<%= @article.id %>');"><i data-feather="slash" class="inline h-5"></i> DELETE</button>
     </div>

data/app/views/dokno/categories/_category_form.html.erb

@@ -10,13 +10,20 @@
   </div>
 
   <% if Dokno::Category.exists? %>
-    <div class="mb-5">
+    <div class="mb-5 w-1/2">
       <div class="text-lg font-semibold"><label for="parent_category_code">Parent Category</label></div>
-      <select name="parent_category_code" id="parent_category_code" class="rounded text-xl shadow-inner bg-gray-100 p-2 mt-2 w-1/2 max-w-full">
-        <option></option>
-        <%= Dokno::Category.select_option_markup(selected_category_codes: [@parent_category_code], exclude_category_id: category.id).html_safe %>
+
+      <select name="parent_category_code" id="parent_category_code" size="1" class="rounded text-xl shadow-inner bg-gray-100 p-2 w-full max-w-full">
+        <option value="">No Parent Category</option>
+
+        <optgroup label="Categories">
+          <% cache Dokno::Category do %>
+            <%= Dokno::Category.select_option_markup.html_safe %>
+          <% end %>
+        </optgroup>
       </select>
-      <div class="text-gray-500 mt-2 w-1/2">
+
+      <div class="text-gray-500 mt-2">
         The existing category to which this category belongs.
         <% if (article_count = category.articles.count).positive? %>
           There <%= article_count > 1 ? "are #{article_count} articles" : 'is an article' %> currently in this category.
@@ -35,4 +42,8 @@
   </div>
 </section>
 
-<script> elem('input#name').focus(); </script>
+<script>
+  // Client-side select of cached select list
+  selectOption('parent_category_code', '<%= j @parent_category_code %>');
+  elem('input#name').focus();
+</script>

data/app/views/dokno/categories/index.html.erb

@@ -1,6 +1,27 @@
+<% if !current_page?(up_for_review_path) && (@category.blank? || @search_term.present?) %>
+  <div class="text-center m-auto mb-10 w-full max-w-screen-xl">
+    <% if @search_term.present? %>
+      <div class="text-gray-600 text-2xl uppercase">
+        <%= @total_records.positive? ? "#{@total_records} #{'article'.pluralize(@total_records)}" : 'No articles' %>
+        found containing the search term
+        <div class="text-4xl leading-tight"><span class="font-serif">&ldquo;</span> <%= @search_term %> <span class="font-serif">&rdquo;</span> </div>
+      </div>
+    <% else %>
+      <div class="text-gray-600 text-2xl">
+        Browse or search
+        <% if (article_count = Dokno::Article.count) > 1 %>
+          <%= number_with_delimiter(article_count, delimiter: ',') %> articles in
+        <% end %>
+        the
+      </div>
+      <div class="text-gray-800 text-4xl leading-tight uppercase"><%= Dokno.config.app_name %> knowledgebase</div>
+    <% end %>
+  </div>
+<% end %>
+
 <% if @category&.parent.present? %>
   <div class="text-gray-500 mb-5">
-    <div><%= @category.breadcrumb %></div>
+    <div><span class="text-gray-500 mr-1">Under</span> <%= @category.breadcrumb(search_term: @search_term, order: @order, hide_self: true) %></div>
   </div>
 <% end %>
 
@@ -51,12 +72,6 @@
           </div>
         </div>
         <div class="dokno-article-summary w-2/3 <% unless article.active %>text-gray-500 italic<% end %>">
-          <% unless article.active %>
-            <div class="bg-yellow-700 p-4 mb-5 rounded text-lg border-t-4 border-yellow-900 text-white font-base not-italic">
-              <i data-feather="info" class="inline-block"></i> This article is no longer active
-            </div>
-          <% end %>
-
           <div class="dokno-article-content-highlight mb-2"><%= article.summary.presence || 'No summary provided' %></div>
 
           <div class="text-base text-gray-500">
@@ -75,6 +90,12 @@
             </div>
           <% end %>
 
+          <% if !article.active %>
+            <div class="bg-yellow-700 p-4 mt-5 rounded text-lg border-t-4 border-yellow-900 text-white font-base not-italic">
+              <i data-feather="info" class="inline-block mr-1"></i> This article is no longer active
+            </div>
+          <% end %>
+
           <% if article.up_for_review? %>
             <div class="bg-<%= article.review_due_days.negative? ? 'red' : 'gray' %>-800 p-4 mt-5 rounded text-lg border-t-4 border-<%= article.review_due_days.negative? ? 'red' : 'gray' %>-900 text-white font-base not-italic">
               <i data-feather="bell" class="inline-block mr-1"></i> <%= article.review_due_days_string %>

data/app/views/layouts/dokno/application.html.erb

@@ -16,6 +16,7 @@
 </head>
 <body class="bg-white font-sans font-light subpixel-antialiased text-lg">
 
+
   <nav id="dokno-nav-container" class="bg-blue-900 text-white py-10 px-16 text-lg">
     <div class="flex items-center m-auto w-full max-w-screen-xl">
       <div class="w-1/3">
@@ -42,6 +43,7 @@
     </div>
   </nav>
 
+
   <% flash.each do |type, msg| %>
     <div class="bg-<%= type %>-800 text-lg text-white font-base py-10 px-16 text-center">
       <i data-feather="<%= (type == 'green' ? 'smile' : (type == 'yellow' ? 'info' : (type == 'gray' ? 'bell' : 'frown'))) %>" class="inline mr-1"></i>
@@ -49,33 +51,14 @@
     </div>
   <% end %>
 
-  <main class="py-10 px-16">
-    <% if !current_page?(up_for_review_path) && @article.blank? && (@category.blank? || @search_term.present?) %>
-      <div class="text-center m-auto mb-10 w-full max-w-screen-xl">
-        <% if @search_term.present? %>
-          <div class="text-gray-600 text-2xl uppercase">
-            <%= @total_records.positive? ? "#{@total_records} #{'article'.pluralize(@total_records)}" : 'No articles' %>
-            found containing the search term
-            <div class="text-4xl leading-tight"><span class="font-serif">&ldquo;</span> <%= @search_term %> <span class="font-serif">&rdquo;</span> </div>
-          </div>
-        <% else %>
-          <div class="text-gray-600 text-2xl">
-            Browse or search
-            <% if (article_count = Dokno::Article.count) > 1 %>
-              <%= number_with_delimiter(article_count, delimiter: ',') %> articles in
-            <% end %>
-            the
-          </div>
-          <div class="text-gray-800 text-4xl leading-tight uppercase"><%= Dokno.config.app_name %> knowledgebase</div>
-        <% end %>
-      </div>
-    <% end %>
 
+  <main class="py-10 px-16">
     <div id="dokno-content-container" class="w-full max-w-screen-xl m-auto print-this">
       <%= yield %>
     </div>
   </main>
 
+
   <footer id="dokno-footer-container">
     <% if @article.present? && action_name == 'show' %>
       <div id="dokno-article-log-container" data-category-id="<%= @category&.id %>" data-article-id="<%= @article.id %>">
@@ -83,7 +66,7 @@
       </div>
     <% end %>
 
-    <% if can_edit? && !current_page?(up_for_review_path) && action_name == 'index' && (up_for_review_count = Dokno::Article.up_for_review.count).positive? %>
+    <% if @show_up_for_review && (up_for_review_count = Dokno::Article.up_for_review.count).positive? %>
       <div id="dokno-articles-up-for-review-container">
         <div class="py-10 px-16 bg-gray-900">
           <div class="w-full max-w-screen-xl m-auto">
@@ -119,7 +102,7 @@
   <%= javascript_include_tag 'init' %>
 
   <% if @search_term.present? %>
-    <script>highlightTerm(['<%= j @search_term.strip %>'], 'dokno-article-content-highlight');</script>
+    <script> highlightTerm(['<%= j @search_term.strip %>'], 'dokno-article-content-highlight'); </script>
   <% end %>
 </body>
 </html>

data/app/views/partials/_category_header.html.erb

@@ -11,6 +11,11 @@
         </optgroup>
       </select>
     </div>
+
+    <script>
+      // Client-side select of cached select list
+      selectOption('category', '<%= j @category&.code %>');
+    </script>
   <% end %>
 
   <% if Dokno::Article.exists? %>
@@ -22,8 +27,4 @@
   <% end %>
 </div>
 
-<script>
-  // Client-side select of cached select list
-  selectOption('category', '<%= j @category&.code %>');
-  enableSearchHotkey();
-</script>
+<script> enableSearchHotkey(); </script>

data/lib/dokno/engine.rb

@@ -19,7 +19,7 @@ module Dokno
     end
 
     initializer 'local_helper.action_controller' do
-      ActiveSupport.on_load :action_controller do
+      ActiveSupport.on_load :action_controller_base do
         helper Dokno::ApplicationHelper
       end
     end

data/lib/dokno/version.rb

@@ -1,3 +1,3 @@
 module Dokno
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dokno
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Courtney Payne
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-13 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -300,7 +300,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/cpayne624/dokno/issues
   changelog_uri: https://github.com/cpayne624/dokno/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -315,8 +315,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Dokno (dough-no) is a lightweight mountable Rails Engine for storing and
   managing your app's domain knowledge.