dokno 1.1.0 → 1.4.0

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

@@ -0,0 +1,30 @@
+<div class="no-print flex items-center mb-10">
+  <% if Dokno::Category.exists? %>
+    <div class="w-1/2 pr-5">
+      <select aria-label="Category" name="category" id="category" size="1" class="rounded text-xl shadow-inner bg-gray-100 p-2 w-full max-w-full" onchange="applyCategoryCriteria(this.value, elem('#search_term').value, '<%= @order %>');">
+        <option value="">Uncategorized</option>
+
+        <optgroup label="Categories">
+          <% cache Dokno::Category do %>
+            <%= Dokno::Category.select_option_markup.html_safe %>
+          <% end %>
+        </optgroup>
+      </select>
+    </div>
+
+    <script>
+      // Client-side select of cached select list
+      selectOption('category', '<%= j @category&.code %>');
+    </script>
+  <% end %>
+
+  <% if Dokno::Article.exists? %>
+    <div class="relative w-<%= Dokno::Category.exists? ? '1/2 pl-5' : 'full' %>">
+      <i data-feather="search" class="absolute ml-4 mt-3 inline-block text-gray-300" title="Search"></i>
+      <input title="Press / to search" onsearch="applyCategoryCriteria('<%= @category&.code %>', this.value, '<%= @order %>');" onfocus="disableSearchHotkey();" onblur="enableSearchHotkey();" placeholder="Search<%= @category.present? ? ' under this category' : ', hotkey /' %>" type="search" name="search_term" id="search_term" value="<%= @search_term %>" class="pl-12 pr-8 py-2 rounded text-xl shadow-inner bg-gray-100 w-full" />
+      <% if @category.present? %><div title="Press / to search" class="absolute -ml-6 mt-2 inline-block text-gray-300 font-semibold">/</div><% end %>
+    </div>
+  <% end %>
+</div>
+
+<script> enableSearchHotkey(); </script>

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

@@ -1,5 +1,4 @@
 <div id="error_explanation" class="bg-white mb-10">
-  <i data-feather="alert-octagon" class="float-right"></i>
   <h2 class="font-semibold">
     There
     <% if errors.count == 1 %>

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

@@ -2,7 +2,7 @@
   <div class="py-10 px-16 text-gray-200 bg-gray-900">
     <div class="w-full max-w-screen-xl m-auto">
       <div class="text-xl text-gray-600 cursor-pointer" onclick="toggleVisibility('change-log');">
-        Change log for this article
+        Change history for this article
 
         <div class="inline toggle-visibility-indicator-container change-log">
           <i data-feather="chevron-left" class="inline toggle-visibility-indicator change-log"></i>
@@ -20,7 +20,7 @@
                 <% end %>
 
                 <div class="text-gray-500 bg-gray-700 p-5 pr-10 rounded <%= 'cursor-pointer' if log.diff_left != log.diff_right %> flex items-center" onclick="toggleVisibility('article-diff-<%= log.id %>');" title="Show / Hide Diff">
-                  <div class="w-4/5">
+                  <div class="w-<%= log.diff_left != log.diff_right ? '11/12' : 'full' %>">
                     <%= time_ago_in_words log.created_at %> ago
                     <% if log.username.present? %>
                       by <%= log.username %>
@@ -31,9 +31,11 @@
                     <% end %>
                   </div>
 
-                  <div class="w-1/5 text-right toggle-visibility-indicator-container article-diff-<%= log.id %>">
-                    <% if log.diff_left != log.diff_right %><i data-feather="chevron-left" class="inline toggle-visibility-indicator article-diff-<%= log.id %>"></i><% end %>
-                  </div>
+                  <% if log.diff_left != log.diff_right %>
+                    <div class="w-1/12 text-right toggle-visibility-indicator-container article-diff-<%= log.id %>">
+                      <i data-feather="chevron-left" class="inline toggle-visibility-indicator article-diff-<%= log.id %>"></i>
+                    </div>
+                  <% end %>
                 </div>
 
                 <% if log.diff_left != log.diff_right %>

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

@@ -1,29 +1,31 @@
-<span class="mr-5">
-  <% if @page > 1 %>
-    <span class="mr-1 inline-block"><a href="?search_term=<%= CGI.escape @search_term.to_s %>&order=<%= @order %>&page=<%= (@page - 1) %>"><i data-feather="arrow-left" class="h-5 inline-block" title="Previous page"></i></a></span>
-  <% end %>
+<% if @total_pages > 1 %>
+  <span class="mr-5">
+    <% if @page > 1 %>
+      <span class="mr-1 inline-block"><a href="?search_term=<%= CGI.escape @search_term.to_s %>&order=<%= @order %>&page=<%= (@page - 1) %>"><i data-feather="arrow-left" class="h-5 inline-block" title="Previous page"></i></a></span>
+    <% end %>
 
-  <span class="mr-1 inline-block">Page</span>
+    <span class="mr-1 inline-block">Page</span>
 
-  <%= form_with(url: article_index_path, method: :get, class: 'inline') do %>
-    <input type="hidden" name="id" value="<%= @category&.id %>">
-    <input type="hidden" name="search_term" value="<%= @search_term %>">
-    <input type="hidden" name="order" value="<%= @order %>">
-    <input type="text" name="page" id="page" value="<%= @page %>" onclick="this.select();" class="w-10 text-center bg-gray-200 rounded" />
+    <%= form_with(url: article_index_path(@category&.code), method: :get, class: 'inline') do %>
+      <input type="hidden" name="search_term" value="<%= @search_term %>">
+      <input type="hidden" name="order" value="<%= @order %>">
+      <input aria-label="Page" type="text" name="page" value="<%= @page %>" onclick="this.select();" class="w-10 text-center bg-gray-200 rounded" />
 
-    <span class="mx-1 inline-block">of</span>
-    <span class="text-center inline-block"><%= @total_pages %></span>
-  <% end %>
+      <span class="mx-1 inline-block">of</span>
+      <span class="text-center inline-block"><%= @total_pages %></span>
+    <% end %>
 
-  <% if @page < @total_pages %>
-    <span class="ml-1 inline-block"><a href="?search_term=<%= CGI.escape @search_term.to_s %>&order=<%= @order %>&page=<%= (@page + 1) %>"><i data-feather="arrow-right" class="h-5 inline-block" title="Next page"></i></a></span>
-  <% end %>
-</span>
+    <% if @page < @total_pages %>
+      <span class="ml-1 inline-block"><a href="?search_term=<%= CGI.escape @search_term.to_s %>&order=<%= @order %>&page=<%= (@page + 1) %>"><i data-feather="arrow-right" class="h-5 inline-block" title="Next page"></i></a></span>
+    <% end %>
+  </span>
+<% end %>
 
 <span class="text-gray-400">
   <%= @total_records %>
-  <%= 'uncategorized' if @category.blank? && @search_term.blank? %>
+  <%= 'uncategorized' if !current_page?(up_for_review_path) && @category.blank? && @search_term.blank? %>
   <%= 'article'.pluralize(@total_records) %>
+  <%= 'up for review' if current_page?(up_for_review_path) %>
 
   <% if @search_term.present? %>
     containing <span class="font-serif">&ldquo;</span><%= @search_term %><span class="font-serif">&rdquo;</span>

data/config/routes.rb

@@ -3,8 +3,8 @@ Dokno::Engine.routes.draw do
   resources :articles
 
   get '/(:cat_code)',          to: 'categories#index',     as: :article_index
+  get '/up_for_review',        to: 'categories#index',     as: :up_for_review
   get 'article_panel/(:slug)', to: 'articles#panel',       as: :panel
-  post 'article_log',          to: 'articles#article_log', as: :article_log
   post 'article_preview',      to: 'articles#preview',     as: :preview
   post 'article_status',       to: 'articles#status',      as: :status
   root 'categories#index'

data/db/migrate/20201203190330_baseline.rb

@@ -13,12 +13,12 @@ class Baseline < ActiveRecord::Migration[6.0]
       t.string "slug"
       t.string "title"
       t.text "markdown"
-      t.datetime "created_at", precision: 6, null: false
-      t.datetime "updated_at", precision: 6, null: false
       t.text "summary"
       t.boolean "active", default: true
       t.bigint "views", default: 0
       t.datetime "last_viewed_at"
+      t.datetime "created_at", precision: 6, null: false
+      t.datetime "updated_at", precision: 6, null: false
       t.index ["slug"], name: "index_dokno_articles_on_slug", unique: true
     end
 
@@ -32,10 +32,10 @@ class Baseline < ActiveRecord::Migration[6.0]
 
     create_table "dokno_categories", force: :cascade do |t|
       t.string "name"
-      t.datetime "created_at", precision: 6, null: false
-      t.datetime "updated_at", precision: 6, null: false
       t.bigint "category_id"
       t.string "code", null: false
+      t.datetime "created_at", precision: 6, null: false
+      t.datetime "updated_at", precision: 6, null: false
       t.index ["category_id"], name: "index_dokno_categories_on_category_id"
       t.index ["code"], name: "index_dokno_categories_on_code", unique: true
       t.index ["name"], name: "index_dokno_categories_on_name", unique: true

data/db/migrate/20201211192306_add_review_due_at_to_articles.rb

@@ -0,0 +1,6 @@
+class AddReviewDueAtToArticles < ActiveRecord::Migration[6.0]
+  def change
+    add_column :dokno_articles, :review_due_at, :datetime
+    add_index :dokno_articles, :review_due_at
+  end
+end

data/db/migrate/20201213165700_add_starred_to_article.rb

@@ -0,0 +1,5 @@
+class AddStarredToArticle < ActiveRecord::Migration[6.0]
+  def change
+    add_column :dokno_articles, :starred, :boolean, default: false
+  end
+end

data/lib/dokno/config/config.rb

@@ -1,4 +1,8 @@
 module Dokno
+  module Error
+    class Config < StandardError; end
+  end
+
   def self.configure
     yield config
     config.validate
@@ -8,62 +12,71 @@ module Dokno
     @config ||= Config.new
   end
 
-  def self.config=(val)
-    @config = val
-  end
-
   class Config
-    # (String) Host application name for display within the mounted dashboard
-    attr_accessor :app_name
+    # Dokno configuration options
+    #
+    # app_name (String)
+    #   Host app name for display within the mounted dashboard
+    # tag_whitelist (Enumerable)
+    #   Determines which HTML tags are allowed in Article markdown
+    # attr_whitelist (Enumerable)
+    #   Determines which HTML attributes are allowed in Article markdown
+    # app_user_object (String)
+    #   Host app's user object
+    # app_user_auth_method (Symbol)
+    #   Host app's user object method to be used for edit authorization.
+    #   Should return boolean
+    # app_user_name_method (Symbol)
+    #   Host app's user object method that returns the authenticated user's name or other
+    #   identifier that will be included in change log events.
+    #   Should return a string
+    # article_review_period (ActiveSupport::Duration)
+    #   The amount of time before articles should be reviewed for accuracy/relevance
+    # article_review_prompt_days (Integer)
+    #   The number of days prior to an article being up for review that users should be prompted
 
-    # (Enumerable) Determines which HTML tags are allowed in Article markdown
+    attr_accessor :app_name
     attr_accessor :tag_whitelist
-
-    # (Enumerable) Determines which HTML attributes are allowed in Article markdown
     attr_accessor :attr_whitelist
-
-    # (String) Host application's user object
     attr_accessor :app_user_object
-
-    # (Symbol) Host application's user object method that should be used to authorize users to edit Dokno data
-    #   Should return boolean.
     attr_accessor :app_user_auth_method
-
-    # (Symbol) Host application's user object method that should return the authenticated user's name or other
-    #   identifier that will be included in change log events. Should return a string.
     attr_accessor :app_user_name_method
+    attr_accessor :article_review_period
+    attr_accessor :article_review_prompt_days
 
     # Defaults
-    TAG_WHITELIST        = %w[code img h1 h2 h3 h4 h5 h6 a em u i b strong ol ul li table thead tbody tfoot tr th td blockquote hr br p]
-    ATTR_WHITELIST       = %w[src alt title href target]
-    APP_USER_OBJECT      = 'current_user'
-    APP_USER_AUTH_METHOD = 'admin?'
-    APP_USER_NAME_METHOD = 'name'
+    TAG_WHITELIST              = %w[code img h1 h2 h3 h4 h5 h6 a em u i b strong ol ul li table thead tbody tfoot tr th td blockquote hr br p]
+    ATTR_WHITELIST             = %w[src alt title href target]
+    APP_USER_OBJECT            = 'current_user'
+    APP_USER_AUTH_METHOD       = :admin?
+    APP_USER_NAME_METHOD       = :name
+    ARTICLE_REVIEW_PERIOD      = 1.year
+    ARTICLE_REVIEW_PROMPT_DAYS = 30
 
     def initialize
-      self.app_name             = Rails.application.class.module_parent.name.underscore.humanize.upcase
-      self.tag_whitelist        = TAG_WHITELIST
-      self.attr_whitelist       = ATTR_WHITELIST
-      self.app_user_object      = APP_USER_OBJECT
-      self.app_user_auth_method = APP_USER_AUTH_METHOD
-      self.app_user_name_method = APP_USER_NAME_METHOD
+      self.app_name                   = Rails.application.class.module_parent.name.underscore.humanize.upcase
+      self.tag_whitelist              = TAG_WHITELIST
+      self.attr_whitelist             = ATTR_WHITELIST
+      self.app_user_object            = APP_USER_OBJECT
+      self.app_user_auth_method       = APP_USER_AUTH_METHOD
+      self.app_user_name_method       = APP_USER_NAME_METHOD
+      self.article_review_period      = ARTICLE_REVIEW_PERIOD
+      self.article_review_prompt_days = ARTICLE_REVIEW_PROMPT_DAYS
     end
 
     def validate
-      validate_tag_whitelist
-      validate_attr_whitelist
+      validate_config_option(option: 'tag_whitelist',              expected_class: Enumerable,              example: '%w[a p strong]')
+      validate_config_option(option: 'attr_whitelist',             expected_class: Enumerable,              example: '%w[class href]')
+      validate_config_option(option: 'app_user_object',            expected_class: String,                  example: 'current_user')
+      validate_config_option(option: 'app_user_auth_method',       expected_class: Symbol,                  example: ':admin?')
+      validate_config_option(option: 'app_user_name_method',       expected_class: Symbol,                  example: ':name')
+      validate_config_option(option: 'article_review_period',      expected_class: ActiveSupport::Duration, example: '1.year')
+      validate_config_option(option: 'article_review_prompt_days', expected_class: Integer,                 example: '30')
     end
 
-    def validate_tag_whitelist
-      return unless !tag_whitelist.is_a?(Enumerable)
-
-      raise "#{config_error_prefix} tag_whitelist must be Enumerable"
-    end
-
-    def validate_attr_whitelist
-      return unless !attr_whitelist.is_a?(Enumerable)
-
-      raise "#{config_error_prefix} attr_whitelist must be Enumerable"
+    def validate_config_option(option:, expected_class:, example:)
+      return unless !send(option.to_sym).is_a? expected_class
+      raise Error::Config, "#{config_error_prefix} #{option} must be #{expected_class}, e.g. #{example}"
     end
 
     def config_error_prefix

data/lib/dokno/engine.rb

@@ -4,10 +4,6 @@ module Dokno
   class Engine < ::Rails::Engine
     isolate_namespace Dokno
 
-    initializer 'Dokno precompile', group: :all do |app|
-      app.config.assets.precompile << "dokno_manifest.js"
-    end
-
     config.generators do |g|
       g.test_framework :rspec
     end
@@ -18,8 +14,12 @@ module Dokno
       end
     end
 
+    initializer 'Dokno precompile', group: :all do |app|
+      app.config.assets.precompile << "dokno_manifest.js"
+    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.1.0'
+  VERSION = '1.4.0'
 end

data/lib/generators/dokno/templates/config/initializers/dokno.rb

@@ -1,14 +1,27 @@
 Dokno.configure do |config|
-  config.tag_whitelist          = Dokno::Config::TAG_WHITELIST
-  config.attr_whitelist         = Dokno::Config::ATTR_WHITELIST
+  # To control the permitted HTML tags and attributes within articles,
+  # uncomment and change the defaults.
+  #   (Enumerable) tag_whitelist
+  #   (Enumerable) attr_whitelist
+  # config.tag_whitelist         = %w[code img h1 h2 h3 h4 h5 h6 a em u i b strong ol ul li table thead tbody tfoot tr th td blockquote hr br p]
+  # config.attr_whitelist        = %w[src alt title href target]
 
   # To restrict Dokno data modification and include indentifying information
   # in change log entries, provide the appropriate user values for your app below.
   #   (String) app_user_object
   #   (Symbol) app_user_auth_method
   #   (Symbol) app_user_name_method
+  # config.app_user_object       = 'current_user'
+  # config.app_user_auth_method  = :admin?
+  # config.app_user_name_method  = :name
 
-  # config.app_user_object      = 'current_user'
-  # config.app_user_auth_method = :admin?
-  # config.app_user_name_method = :name
+  # To control the amount of time before a created/updated article is flagged
+  # for accuracy/relevance review, uncomment and change the default.
+  #   (ActiveSupport::Duration) article_review_period
+  # config.article_review_period = 1.year
+
+  # To control the number of days prior to an article being up for review
+  # that users should be prompted to re-review, uncomment and change the default.
+  #   (Integer) article_review_prompt_days
+  # config.article_review_prompt_days = 30
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dokno
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Courtney Payne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bullet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.34'
 - !ruby/object:Gem::Dependency
   name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -127,47 +183,59 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.0.1
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '3.142'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.142.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '3.142'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.142.7
 - !ruby/object:Gem::Dependency
-  name: bullet
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 0.19.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.1
 description: Dokno allows you to easily mount a self-contained knowledgebase / wiki
   / help system to your Rails app.
 email:
@@ -210,11 +278,14 @@ files:
 - app/views/dokno/categories/index.html.erb
 - app/views/dokno/categories/new.html.erb
 - app/views/layouts/dokno/application.html.erb
+- app/views/partials/_category_header.html.erb
 - app/views/partials/_form_errors.html.erb
 - app/views/partials/_logs.html.erb
 - app/views/partials/_pagination.html.erb
 - config/routes.rb
 - db/migrate/20201203190330_baseline.rb
+- db/migrate/20201211192306_add_review_due_at_to_articles.rb
+- db/migrate/20201213165700_add_starred_to_article.rb
 - lib/dokno.rb
 - lib/dokno/config/config.rb
 - lib/dokno/engine.rb