help_center 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d5abd35602e62d22607a377c4f63ecd1781e2260a390112183ec05b6467ae6
-  data.tar.gz: f052cf2fa537f50ca26823b6d3744e78457ab82841ec4fc914e33f24e5b5c711
+  metadata.gz: c229690f4ea2200eaac22205e66d776fdc1590f05ae1aca8fa6498ddf5d5fa53
+  data.tar.gz: 269c19131ea7c54b07c70ebc46f744926b270880a94bc5368a5a8ea3aa4274fe
 SHA512:
-  metadata.gz: a3af90e3300fc85ecdba1ebea049b79c16f18afc31cd601965fce7f6e9d536e20f3f5cb505102351adbb3902bad8ea9b820f9e9796f01fbd44584dde7a28a5ad
-  data.tar.gz: 3145813c4bf4d9fbded2d73405c6b54bc1f7a42c25e956372bc74d1803543685e1a428f0bda7eec0ec15511d463cdb6ef649feee1133dd51c2a894cd4c585ce0
+  metadata.gz: 53a7e667e6010ae88cb43a5bfbdae856f270c5fdbc9a31b57e3092129d353e4c15ff43897eb25bfdf2fc47ebdbea8de8209d2efd875c4bfd5e920a1e46c8a0b9
+  data.tar.gz: 0a5c782fc528a571356f620506a91a750da997ecec8571ad9c7f774df51517f1bfc47add6c367fb9b402128a2253b6a9c38a04b54fefbaf238b945a03a062dcc

data/.github/FUNDING.yml

@@ -1,6 +1,6 @@
 # These are supported funding model platforms
 
-github: [uurcankaya, pasilobus] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github: [uurcank, pasilobus] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username

data/.gitignore

@@ -8,3 +8,6 @@
 /spec/reports/
 /tmp/
 .DS_Store
+
+# Ignore all files with the .gem extension
+*.gem

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 ### Unreleased
 
+* Fixes in form labels
+* Styling improvements
+
+### 0.1.0
+
+* Inherit application layout
+* Remove logo requirement removed (add the layout file to your views to customize)
+* Refactor partials
+
+### 0.0.9
+
+* [BREAKING] No longer inherits application layout
+* [BREAKING] Use CDN to install required libraries, skipping asset pipeline
+* [BREAKING] Layout file requires a logo.svg file in assets, otherwise will break
+* Upgrade to Tailwind v2.0
+* New layout design
+* Togglable sidebar menu
+* Use Highlight.js for syntax highlighting
+
+### 0.0.7
+
+* Improve default styling
+
 ### 0.0.6
 
 * Bug fixes

data/README.md

@@ -1,168 +1,162 @@
-# HelpCenter
-
-### 📖 Knowledge Base for your Ruby on Rails App 
-
-HelpCenter is a Rails wiki gem with Trix editor support for creating a knowledge base for your project. It includes support categories, support articles, simple moderation, the ability to leave comments to support articles and more.
-
-Out of the box, HelpCenter comes with styling for TailwindCSS 2.0 but you're free to customize the UI as much as you like by installing the views and tweaking the HTML.
-
-## Requirements
-
-```
-Rails >= 6.0.0
-tailwindcss >= 2.0.0
-```
-
-## Installation
-
-Before you get started, HelpCenter requires a `User` model in your application (for now).
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'help_center'
-```
-
-And then execute:
-
-```bash
-bundle
-```
-
-Install the migrations and migrate:
-
-```bash
-rails help_center:install:migrations
-rails db:migrate
-```
-
-Add HelpCenter to your `User` model. The model **must** have `name` method which will be used to display the user's name on comments & discussions (if enabled). Currently only a model named `User` will work.
-
-```ruby
-class User < ActiveRecord::Base
-  include HelpCenter::SupportUser
-
-  def name
-    "#{first_name} #{last_name}"
-  end
-end
-```
-
-Next add a `moderator` or `admin` flag to the `User` model.
-
-```bash
-rails g migration AddModeratorToUsers moderator:boolean
-rails db:migrate
-```
-Only moderators or admins can add support articles.
-
-```
-if current_user.admin? || current_user.moderator?
-```
-
-Add the following line to your `config/routes.rb` file:
-
-```ruby
-mount HelpCenter::Engine => "/docs"
-```
-
-Add routes for active storage with your custom prefix
-
-```ruby
-get "/support/rails/active_storage/blobs/:signed_id/*filename" =>
-     "active_storage/blobs#show"
-get "/support/rails/active_storage/representations/:signed_blob_id/:variation_key/*filename" =>
-     "active_storage/representations#show"
-```
-
-Lastly, add the CSS to your `application.css` to load some default styles.
-
-```scss
-*= require help_center
-```
-
-## Usage
-
-To get all the basic functionality, the only thing you need to do is add a link to HelpCenter in your navbar.
-
-```erb
-<%= link_to "Docs", help_center_path %>
-```
-
-This will take the user to the views inside the Rails engine and that's all you have to do!
-
-### Customizing
-
-If you'd like to customize the views that HelpCenter uses, you can install the views to your Rails app:
-
-```bash
-rails g help_center:views
-```
-
-You can also install a copy of the HelpCenter controllers for advanced customization:
-
-```bash
-rails g help_center:controllers
-```
-
-Helpers are available for override as well. They are used for rendering the user avatars, text formatting, and more.
-
-```bash
-rails g help_center:helpers
-```
-
-**NOTE:** Keep in mind that the more customization you do, the tougher gem upgrades will be in the future.
-
-### User comments & Notifications
-
-You can enable user comments and questions for support articles. HelpCenter will attempt to send email and slack notifications for users who leave comments when a new reply posted.
-
-To turn these off you can do the following in `config/initializers/help_center.rb`
-
-```ruby
-HelpCenter.setup do |config|
-  config.article_dicussions = false # Default: false
-  config.send_email_notifications = false # Default: true
-  config.send_slack_notifications = false # Default: true
-end
-```
-
-Slack notifications require you to set `help_center_slack_url` in your `config/secrets.yml`. If you don't have this value set, it will not attempt Slack notifications even if they are enabled.
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Roadmap / Upcoming features
-Your support is appreciated for this project. Consider backing the project via GitHub Sponsors.
-
-We plan to release following features:
-
-- Contact form
-- Built-in search
-- Versioning Support
-- Themes
-- Dark Mode Support
-
-## Acknowledgment
-
-[simple_discussion](https://github.com/excid3/simple_discussion) by [Chris Oliver](https://github.com/excid3)
-
-[Trix editor](https://github.com/basecamp/trix) by [Basecamp](https://github.com/basecamp)
-
-[TailwindCSS](https://github.com/basecamp/trix) by [Tailwind Labs](https://github.com/tailwindlabs/tailwindcss)
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/uurcank/help_center This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the HelpCenter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pasilobus/help_center/blob/master/CODE_OF_CONDUCT.md).
+# HelpCenter
+
+### 📖 Knowledge Base for your Ruby on Rails App 
+
+HelpCenter is a Rails wiki gem with Trix editor support for creating a knowledge base for your project. It includes categories, articles, simple moderation, the ability to leave comments to docs and more.
+
+Out of the box, HelpCenter comes with styling for TailwindCSS 2.0 but you're free to customize the UI as much as you like by installing the views and tweaking the HTML.
+
+## Requirements
+
+```
+Rails >= 6.1.4
+
+```
+
+## Installation
+
+Before you get started, HelpCenter requires a `User` model in your application (for now).
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'help_center'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Install the migrations and migrate:
+
+```bash
+rails help_center:install:migrations
+rails db:migrate
+```
+
+Add HelpCenter to your `User` model. The model **must** have `name` method which will be used to display the user's name on comments & discussions (if enabled). Currently only a model named `User` will work.
+
+```ruby
+class User < ActiveRecord::Base
+  include HelpCenter::SupportUser
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+```
+
+Next add a `moderator` and `admin` flag to the `User` model.
+
+```bash
+rails g migration AddModeratorToUsers admin:boolean moderator:boolean
+rails db:migrate
+```
+Only moderators or admins can manage articles.
+
+```
+if current_user.admin? || current_user.moderator?
+```
+
+Add the following line to your `config/routes.rb` file:
+
+```ruby
+mount HelpCenter::Engine => "/docs"
+```
+
+Add routes for active storage with your custom prefix
+
+```ruby
+get "/docs/rails/active_storage/blobs/:signed_id/*filename" =>
+     "active_storage/blobs#show"
+get "/docs/rails/active_storage/representations/:signed_blob_id/:variation_key/*filename" =>
+     "active_storage/representations#show"
+```
+
+## Usage
+
+To get all the basic functionality, the only thing you need to do is add a link to HelpCenter in your navbar.
+
+```erb
+<%= link_to "Docs", help_center_path %>
+```
+
+This will take the user to the views inside the Rails engine and that's all you have to do!
+
+### Customizing
+
+If you'd like to customize the views that HelpCenter uses, you can install the views to your Rails app:
+
+```bash
+rails g help_center:views
+```
+
+You can also install a copy of the HelpCenter controllers for advanced customization:
+
+```bash
+rails g help_center:controllers
+```
+
+Helpers are available for override as well. They are used for rendering the user avatars, text formatting, and more.
+
+```bash
+rails g help_center:helpers
+```
+
+**NOTE:** Keep in mind that the more customization you do, the tougher gem upgrades will be in the future.
+
+### User comments & Notifications
+
+You can enable user comments and questions for support articles. HelpCenter will attempt to send email and slack notifications for users who leave comments when a new reply posted.
+
+To turn these off you can do the following in `config/initializers/help_center.rb`
+
+```ruby
+HelpCenter.setup do |config|
+  config.article_dicussions = false # Default: false
+  config.send_email_notifications = false # Default: true
+  config.send_slack_notifications = false # Default: true
+end
+```
+
+Slack notifications require you to set `help_center_slack_url` in your `config/secrets.yml`. If you don't have this value set, it will not attempt Slack notifications even if they are enabled.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Roadmap / Upcoming features
+Your support is appreciated for this project. Consider backing the project via GitHub Sponsors.
+
+We plan to release following features:
+
+- Contact form
+- Built-in search
+- Versioning Support
+- Themes
+- Dark Mode Support
+
+## Acknowledgment
+
+[simple_discussion](https://github.com/excid3/simple_discussion) by [Chris Oliver](https://github.com/excid3)
+
+[Trix editor](https://github.com/basecamp/trix) by [Basecamp](https://github.com/basecamp)
+
+[TailwindCSS](https://github.com/basecamp/trix) by [Tailwind Labs](https://github.com/tailwindlabs/tailwindcss)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uurcank/help_center This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HelpCenter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pasilobus/help_center/blob/master/CODE_OF_CONDUCT.md).

data/app/controllers/help_center/support_categories_controller.rb

@@ -1,14 +1,10 @@
 class HelpCenter::SupportCategoriesController < HelpCenter::ApplicationController
   before_action :authenticate_user!, only: [:edit, :update, :destroy]
-  before_action :set_category, only: [:index, :show, :edit, :update, :destroy]
+  before_action :set_category, only: [:show, :edit, :update, :destroy]
   before_action :require_mod_or_author_for_thread!, only: [:edit, :update, :destroy]
 
 
   def index
-    @support_threads = SupportThread.where(support_category: @category) if @category.present?
-    @support_threads = @support_threads.pinned_first.sorted.includes(:user, :support_category)
-    @pagy, @records = pagy(@support_threads)
-    render "help_center/support_threads/index"
   end
 
   def new
@@ -49,7 +45,7 @@ class HelpCenter::SupportCategoriesController < HelpCenter::ApplicationControlle
     def set_category
       @category = SupportCategory.friendly.find(params[:id])
     rescue ActiveRecord::RecordNotFound
-      redirect_to help_center.support_threads_path
+      redirect_to help_center.support_categories_path, notice: I18n.t('page_not_found')
     end
 
     def support_category_params

data/app/controllers/help_center/support_posts_controller.rb

@@ -52,10 +52,12 @@ class HelpCenter::SupportPostsController < HelpCenter::ApplicationController
     redirect_to help_center.support_thread_path(@support_thread, anchor: ActionView::RecordIdentifier.dom_id(@support_post))
   end
 
-  private
-
+  private 
+ 
     def set_support_thread
       @support_thread = SupportThread.friendly.find(params[:support_thread_id])
+    rescue ActiveRecord::RecordNotFound
+      redirect_to help_center.root_path, notice: I18n.t('page_not_found')
     end
 
     def set_support_post

data/app/controllers/help_center/support_threads_controller.rb

@@ -4,8 +4,7 @@ class HelpCenter::SupportThreadsController < HelpCenter::ApplicationController
   before_action :require_mod_or_author_for_thread!, only: [:edit, :update]
 
   def index
-    @support_threads = SupportThread.pinned_first.sorted.includes(:user, :support_category)
-    @pagy, @records = pagy(@support_threads)
+    redirect_to help_center.support_categories_path
   end
 
   def answered
@@ -74,6 +73,9 @@ class HelpCenter::SupportThreadsController < HelpCenter::ApplicationController
 
     def set_support_thread
       @support_thread = SupportThread.friendly.find(params[:id])
+      @category = @support_thread.support_category
+    rescue ActiveRecord::RecordNotFound
+      redirect_to help_center.support_categories_path, notice: I18n.t('page_not_found')
     end
 
     def support_thread_params

data/app/models/support_category.rb

@@ -2,7 +2,7 @@ class SupportCategory < ApplicationRecord
   extend FriendlyId
   friendly_id :name, use: :slugged
   
-  has_many :support_threads
+  has_many :support_threads, dependent: :destroy
   has_rich_text :description
 
   scope :sorted, ->{ order(position: :asc) }

data/app/views/help_center/support_categories/_form.html.erb

@@ -12,28 +12,28 @@
     </div>
   <% end %>
   <div class="mb-4">
-    <%= f.label t('title') %>
-    <%= f.text_field :name, placeholder: t('how_do_i'), class: "form-control form-input" %>
+    <%= f.label t('title'), class: "block text-sm font-medium text-gray-700 sm:mt-px sm:pt-2 mb-2" %>
+    <%= f.text_field :name, placeholder: t('how_do_i'), class: "shadow-sm block w-full focus:ring-blue-500 focus:border-blue-500 sm:text-sm border border-gray-300 rounded-md p-2" %>
   </div>
   <div class="mb-4">
-    <%= f.label t('position') %>
-    <%= f.text_field :position, type: "number", step: "1", min: "0", class: "form-control form-input" %>
+    <%= f.label t('position'), class: "block text-sm font-medium text-gray-700 sm:mt-px sm:pt-2 mb-4" %>
+    <%= f.text_field :position, type: "number", step: "1", min: "0", class: "shadow-sm block w-full focus:ring-blue-500 focus:border-blue-500 sm:text-sm border border-gray-300 rounded-md p-2" %>
   </div>
   <div class="mb-4">
-    <%= f.label t('color') %>
-    <%= f.color_field :color, class: "form-control form-input" %>
+    <%= f.label t('color'), class: "block text-sm font-medium text-gray-700 sm:mt-px sm:pt-2 mb-4" %>
+    <%= f.color_field :color, class: "max-w-xs shadow-sm block w-full focus:ring-blue-500 focus:border-blue-500 sm:text-sm border border-gray-300 rounded-md" %>
   </div>
   <div class="mb-4">
-    <%= f.label t('title') %>
-    <%= f.rich_text_area :description, placeholder: t('how_do_i'), class: "form-control form-input" %>
+    <%= f.label t('title'), class: "block text-sm font-medium text-gray-700 sm:mt-px sm:pt-2 mb-4" %>
+    <%= f.rich_text_area :description, placeholder: t('how_do_i'), class: "shadow-sm block w-full focus:ring-blue-500 focus:border-blue-500 sm:text-sm border border-gray-300 rounded-md p-2" %>
   </div>
   <div class="flex justify-between mb-4 text-right">
     <% if f.object.new_record? %>
-      <%= f.button t('add'), class: "btn btn-primary", data: {disable_with: "<i class='fa fa-spinner fa-spin'></i> #{t('saving')}"} %>
+      <%= f.button t('add'), class: "inline-flex items-center px-4 py-2 border border-transparent text-sm font-medium rounded-md shadow-sm text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500", data: {disable_with: "<i class='fa fa-spinner fa-spin'></i> #{t('saving')}"} %>
     <% else %>
-      <%= f.button t('update'), class: "btn btn-primary", data: {disable_with: "<i class='fa fa-spinner fa-spin'></i> #{t('saving')}"} %>
+      <%= f.button t('update'), class: "inline-flex items-center px-4 py-2 border border-transparent text-sm font-medium rounded-md shadow-sm text-white bg-blue-600 hover:bg-blue-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-blue-500", data: {disable_with: "<i class='fa fa-spinner fa-spin'></i> #{t('saving')}"} %>
     <% end %>
 
-    <%= link_to "Cancel", :back, class: "btn btn-link" %>
+    <%= link_to "Cancel", :back, class: "inline-flex items-center px-4 py-2 border border-transparent text-sm font-medium rounded-md shadow-sm text-white bg-red-600 hover:bg-red-700 focus:outline-none focus:ring-2 focus:ring-offset-2 focus:ring-red-500" %>
   </div>
 <% end %>

data/app/views/help_center/support_categories/edit.html.erb

@@ -1,7 +1,11 @@
 <%= content_for :title, "Edit Category" %>
+ 
+<div class="px-4 py-10 mb-6 text-white bg-gray-100	text-4xl text-4xl md:px-20 lg:px-40 xl:px-56 font-bold">
+    <h1 class="text-gray-900"><%= t('edit_category') %></h1>
+</div>
 
-<h1 class="mb-4 font-bold"><%= t('edit_category') %></h1>
-
-<div class="support_category">
+<div class="px-4 pt-4 md:px-20 lg:px-40 xl:px-56">
+    <div class="max-w-5xl text-gray-700">
   <%= render 'form', posts: false %>
+  </div>
 </div>

data/app/views/help_center/support_categories/index.html.erb

@@ -1,19 +1,44 @@
-<% if @support_threads.none? %>
-    <div><%= t('search_not_found') %>. <%= t('check_out') %> <%= link_to t('latest_questions'), help_center.support_threads_path %> <%= t('instead') %> </div>
-<% else %>
-<div class="container mx-auto">
-    <% if request.url.include?('category') %>
-      <%# If category, list all articles %>
-      <div class="w-1/62 text-left p-0">
-        <h3> <%= @support_threads.first.support_category.name %></h3>
-      </div>
-      <hr>
-      <%= render partial: "help_center/support_threads/support_thread", collection: @support_threads, spacer_template: "shared/spacer" %>
-      <div class="support-threads-nav text-center">
-      <%== pagy_nav(@pagy) %>
-     </div>
-    <% else %>
-     <%# Set default index here %>
-  <% end %>
-</div>
-<% end %>
+<% if SupportCategory.none? %>
+    <div><%= t('search_not_found') %>. <%= link_to t('browse_categories'), help_center.support_categories_path %> <%= t('instead') %> </div>
+<% else %>
+<div class="px-4 py-10 mb-6 text-white bg-gray-100	text-4xl text-4xl md:px-20 lg:px-40 xl:px-56 font-bold">
+    <h1 class="text-gray-900">Documentation</h1>
+    <p class="text-2xl text-gray-500 font-normal mt-4">Explore our guides and examples</p>
+</div>
+<div class="px-4 pt-4 md:px-20 lg:px-40 xl:px-56">
+  <div class="bg-white shadow overflow-hidden sm:rounded-md">
+    <ul role="list" class="divide-y divide-gray-200">
+      <% SupportCategory.sorted.each do |category| %>
+        <li>
+          <%= link_to help_center.support_category_path(category), class: "block hover:bg-gray-50" do %>
+            <div class="flex items-center px-4 py-4 sm:px-6">
+              <div class="min-w-0 flex-1 flex items-center">
+                <div class="flex-shrink-0">
+                  </div>
+                <div class="min-w-0 flex-1 px-4 md:grid md:grid-cols-2 md:gap-4">
+                  <div>
+                    <p class="text-base font-medium text-gray-600 truncate"><%= category.name %></p>
+                    <p class="mt-2 flex items-center text-sm text-gray-400">
+                      <span class="truncate"><%= category.description %></span>
+                    </p>
+                  </div>
+                
+                </div>
+              </div>
+              <div>
+                <!-- Heroicon name: solid/chevron-right -->
+                <svg class="h-5 w-5 text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
+                  <path fill-rule="evenodd" d="M7.293 14.707a1 1 0 010-1.414L10.586 10 7.293 6.707a1 1 0 011.414-1.414l4 4a1 1 0 010 1.414l-4 4a1 1 0 01-1.414 0z" clip-rule="evenodd" />
+                </svg>
+              </div>
+            </div>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+</div>
+<% end %>
+
+
+ 

data/app/views/help_center/support_categories/new.html.erb

@@ -1,5 +1,9 @@
-<h1 class="mb-4 font-bold"><%= t('add_category') %></h1>
+<div class="px-4 py-10 mb-6 text-white bg-gray-100	text-4xl text-4xl md:px-20 lg:px-40 xl:px-56 font-bold">
+    <h1 class="text-gray-900"><%= t('add_category') %></h1>
+</div>
 
-<div class="support_post">
-  <%= render 'form' %>
+<div class="px-4 pt-4 md:px-20 lg:px-40 xl:px-56">
+    <div class="max-w-5xl text-gray-700">
+    <%= render 'form' %>
+  </div>
 </div>