dokno 1.0.0

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

@@ -0,0 +1,18 @@
+<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 %>
+      is a problem
+    <% else %>
+      are <%= pluralize(errors.count, "problem") %>
+    <% end %>
+    that must be resolved before saving:
+  </h2>
+
+  <ul class="mt-5 list-disc list-inside bg-gray-100 p-5 rounded">
+    <% errors.full_messages.each do |message| %>
+      <li><%= message %></li>
+    <% end %>
+  </ul>
+</div>

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

@@ -0,0 +1,52 @@
+<% if article&.logs.present? %>
+  <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
+
+        <div class="inline toggle-visibility-indicator-container change-log">
+          <i data-feather="chevron-left" class="inline toggle-visibility-indicator change-log"></i>
+        </div>
+      </div>
+
+      <div id="change-log" class="bg-gray-800 px-10 mt-8 rounded hidden text-gray-500">
+        <ul>
+          <% article.logs.includes(article: :categories).each do |log| %>
+            <li class="my-10">
+              <div>
+                <% if article.blank? %>
+                  <div class="text-white text-xl"><a href="<%= article_path log.article.slug %>" title="View Article"><%= log.article.title %></a></div>
+                  <div class="mb-5"><%= log.article.category_name_list %></div>
+                <% 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">
+                    <%= time_ago_in_words log.created_at %> ago
+                    <% if log.username.present? %>
+                      by <%= log.username %>
+                    <% end %>
+
+                    <% if log.meta.present? %>
+                      <br /><span class="text-gray-300"><%= log.meta %></span>
+                    <% 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>
+                </div>
+
+                <% if log.diff_left != log.diff_right %>
+                  <div id="article-diff-<%= log.id %>" class="flex hidden">
+                    <div class="w-1/2 p-5">Before:<br /><%= log.diff_left.html_safe %></div>
+                    <div class="w-1/2 p-5">After:<br /><%= log.diff_right.html_safe %></div>
+                  </div>
+                <% end %>
+              </div>
+            </li>
+          <% end %>
+        </ul>
+      </div>
+    </div>
+  </div>
+<% end %>

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

@@ -0,0 +1,35 @@
+<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>
+
+  <%= 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" />
+
+    <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>
+
+<span class="text-gray-400">
+  <%= @total_records %>
+  <%= 'uncategorized' if @category.blank? && @search_term.blank? %>
+  <%= 'article'.pluralize(@total_records) %>
+
+  <% if @search_term.present? %>
+    containing <span class="font-serif">&ldquo;</span><%= @search_term %><span class="font-serif">&rdquo;</span>
+  <% end %>
+
+  <% if @category.present? %>
+    in <%= "#{(children_count = @category.branch.count) == 1 ? 'this' : children_count} #{'category'.pluralize(children_count)}" %>
+  <% end %>
+</span>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Dokno::Engine.routes.draw do
+  resources :categories, except: [:show]
+  resources :articles
+
+  get '/(:cat_code)',          to: 'categories#index',     as: :article_index
+  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'
+end

data/db/migrate/20201203190330_baseline.rb

@@ -0,0 +1,62 @@
+class Baseline < ActiveRecord::Migration[6.0]
+  def change
+    create_table "dokno_article_slugs", force: :cascade do |t|
+      t.string "slug", null: false
+      t.bigint "article_id"
+      t.datetime "created_at", precision: 6, null: false
+      t.datetime "updated_at", precision: 6, null: false
+      t.index ["article_id"], name: "index_dokno_article_slugs_on_article_id"
+      t.index ["slug"], name: "index_dokno_article_slugs_on_slug", unique: true
+    end
+
+    create_table "dokno_articles", force: :cascade do |t|
+      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.index ["slug"], name: "index_dokno_articles_on_slug", unique: true
+    end
+
+    create_table "dokno_articles_categories", id: false, force: :cascade do |t|
+      t.bigint "article_id"
+      t.bigint "category_id"
+      t.index ["article_id", "category_id"], name: "index_dokno_articles_categories_on_article_id_and_category_id", unique: true
+      t.index ["article_id"], name: "index_dokno_articles_categories_on_article_id"
+      t.index ["category_id"], name: "index_dokno_articles_categories_on_category_id"
+    end
+
+    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.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
+    end
+
+    create_table "dokno_logs", force: :cascade do |t|
+      t.bigint "article_id"
+      t.string "username"
+      t.text "meta"
+      t.text "diff_left"
+      t.text "diff_right"
+      t.datetime "created_at", precision: 6, null: false
+      t.datetime "updated_at", precision: 6, null: false
+      t.index ["article_id"], name: "index_dokno_logs_on_article_id"
+      t.index ["username"], name: "index_dokno_logs_on_username"
+    end
+
+    add_foreign_key "dokno_article_slugs", "dokno_articles", column: "article_id"
+    add_foreign_key "dokno_articles_categories", "dokno_articles", column: "article_id"
+    add_foreign_key "dokno_articles_categories", "dokno_categories", column: "category_id"
+    add_foreign_key "dokno_categories", "dokno_categories", column: "category_id"
+    add_foreign_key "dokno_logs", "dokno_articles", column: "article_id"
+  end
+end

data/lib/dokno.rb

@@ -0,0 +1,4 @@
+require "dokno/engine"
+
+module Dokno
+end

data/lib/dokno/config/config.rb

@@ -0,0 +1,73 @@
+module Dokno
+  def self.configure
+    yield config
+    config.validate
+  end
+
+  def self.config
+    @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
+
+    # (Enumerable) Determines which HTML tags are allowed in Article markdown
+    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
+
+    # 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'
+
+    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
+    end
+
+    def validate
+      validate_tag_whitelist
+      validate_attr_whitelist
+    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"
+    end
+
+    def config_error_prefix
+      "Dokno configuration error (check config/initializers/dokno.rb):"
+    end
+  end
+end

data/lib/dokno/engine.rb

@@ -0,0 +1,27 @@
+require_relative 'config/config'
+
+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
+
+    initializer :append_migrations do |app|
+      config.paths["db/migrate"].expanded.each do |expanded_path|
+        app.config.paths["db/migrate"] << expanded_path
+      end
+    end
+
+    initializer 'local_helper.action_controller' do
+      ActiveSupport.on_load :action_controller do
+        helper Dokno::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/dokno/version.rb

@@ -0,0 +1,3 @@
+module Dokno
+  VERSION = '1.0.0'
+end

data/lib/generators/dokno/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Dokno
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Copies the Dokno configuration templates to the host app'
+      def copy_initializer
+        template 'config/initializers/dokno.rb', 'config/initializers/dokno.rb'
+        template 'config/dokno_template.md', 'config/dokno_template.md'
+      end
+    end
+  end
+end

data/lib/generators/dokno/templates/config/dokno_template.md

@@ -0,0 +1,5 @@
+This is your article template. It's helpful for adding consistency to your app's knowledgebase articles.
+
+Articles support <strong>basic HTML</strong> and **markdown**.
+
+You can modify this template in `/config/dokno_template.md`

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

@@ -0,0 +1,14 @@
+Dokno.configure do |config|
+  config.tag_whitelist          = Dokno::Config::TAG_WHITELIST
+  config.attr_whitelist         = Dokno::Config::ATTR_WHITELIST
+
+  # 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
+end

data/lib/tasks/dokno_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dokno do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification
+name: dokno
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Courtney Payne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !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: 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'
+description: Dokno allows you to easily mount a self-contained knowledgebase / wiki
+  / help system to your Rails app where you and your users can author articles relevant
+  to your app.
+email:
+- cpayne624@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/dokno_manifest.js
+- app/assets/javascripts/dokno.js
+- app/assets/javascripts/dokno/application.js
+- app/assets/javascripts/feather.min.js
+- app/assets/javascripts/init.js
+- app/assets/stylesheets/dokno/application.css
+- app/assets/stylesheets/dokno/tailwind.min.css
+- app/controllers/dokno/application_controller.rb
+- app/controllers/dokno/articles_controller.rb
+- app/controllers/dokno/categories_controller.rb
+- app/controllers/dokno/pagination_concern.rb
+- app/controllers/dokno/user_concern.rb
+- app/helpers/dokno/application_helper.rb
+- app/models/dokno/application_record.rb
+- app/models/dokno/article.rb
+- app/models/dokno/article_slug.rb
+- app/models/dokno/category.rb
+- app/models/dokno/log.rb
+- app/views/dokno/_article_formatting.html.erb
+- app/views/dokno/_article_panel.html.erb
+- app/views/dokno/_panel_formatting.html.erb
+- app/views/dokno/_reset_formatting.html.erb
+- app/views/dokno/articles/_article_form.html.erb
+- app/views/dokno/articles/edit.html.erb
+- app/views/dokno/articles/new.html.erb
+- app/views/dokno/articles/show.html.erb
+- app/views/dokno/categories/_category_form.html.erb
+- app/views/dokno/categories/edit.html.erb
+- app/views/dokno/categories/index.html.erb
+- app/views/dokno/categories/new.html.erb
+- app/views/layouts/dokno/application.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
+- lib/dokno.rb
+- lib/dokno/config/config.rb
+- lib/dokno/engine.rb
+- lib/dokno/version.rb
+- lib/generators/dokno/install/install_generator.rb
+- lib/generators/dokno/templates/config/dokno_template.md
+- lib/generators/dokno/templates/config/initializers/dokno.rb
+- lib/tasks/dokno_tasks.rake
+homepage: https://github.com/cpayne624/dokno
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cpayne624/dokno/issues
+  changelog_uri: https://github.com/cpayne624/dokno/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []