help_center 0.0.5 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 544e4b74c59725cb067edbda4ef444d32219c13b2433ac277917e0bb5a6d5435
-  data.tar.gz: b72851a4402159c203c7c91f682f7e9cefac1d4488997a82b72932ebb5f38502
+  metadata.gz: a00a78bdd79c176569db629519e3e35d23077ae1997b45220b4ea1a7299a0773
+  data.tar.gz: 3d26e2002c404e7584e53a9e2abff88e0ea6d7e586553fbc1d71432dcad3ea52
 SHA512:
-  metadata.gz: 925ef4bccb5794eb48fa9b8c0decfe66c42b6467ab489b1d926a241b14dd6444623335c6e6faa1db3d489bc2a993940836648a272bbe04d9e0c1a065a78382e1
-  data.tar.gz: 84c61d2bd086a3c489fd020895746139c1bace305768375b29ec010d1d8f9938881a3b001001776ca5bed23ae3418c3b2af76fa42c235132ffa233f607a4b3da
+  metadata.gz: 1f566db782b1e4aca5955226a1e05ae24fb6834a427251659b5011d9ee67675a7554cb6828c658a943f002797cc49c124cdcf8c7653765fe30e306397cecad25
+  data.tar.gz: 30604d9022de9695cf01e4878cf58142887fc959c66e13d8e9ef045630f47bca22a5c58247191d8be990af42fbe76e2523d22acaeed2cc709644dccec0718127

data/.gitignore

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

data/CHANGELOG.md

@@ -1 +1,35 @@
+### Unreleased
 
+### 0.0.7
+
+* Improve default styling
+
+### 0.0.6
+
+* Bug fixes
+* Fix gemspec error
+* Remove duplicate gem file 
+* Add changelog
+* Add index page for categories
+* Add descriptions to categories
+* Change home page layout
+
+### 0.0.5
+
+* [BREAKING] Remove Bootstrap in favor of TailwindCSS
+
+### 0.0.4
+
+* Default CSS changes
+
+### 0.0.3
+
+* Change article layout
+
+### 0.0.2
+
+* Fix mailer errors
+
+### 0.0.1
+
+* Initial release

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Ugurcan Kaya
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2021 Ugurcan Kaya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,164 +1,168 @@
-# HelpCenter
-
-HelpCenter is a Rails wiki gem with Trix editor support for organizing app documentation and tutorials. 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 Boostrap v4 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 >= 1.6.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 => "/support"
-```
-
-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
-- Ticket submission
-- Live chat
-- Help Center Layout templates
-- Built-in search
-
-## Acknowledgment
-
-HelpCenter generated from the awesome [simple_discussion](https://github.com/excid3/simple_discussion) gem by [Chris Oliver](https://github.com/excid3)
-
-HelpCenter uses [Trix editor](https://github.com/basecamp/trix) by [Basecamp](https://github.com/basecamp)
-
-## 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 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).

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task :default => :test
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/app/controllers/help_center/application_controller.rb

@@ -1,37 +1,37 @@
-class HelpCenter::ApplicationController < ::ApplicationController
-  layout "help_center"
-
-  def page_number
-    page = params.fetch(:page, '').gsub(/[^0-9]/, '').to_i
-    page = "1" if page.zero?
-    page
-  end
-
-  def is_moderator_or_owner?(object)
-    is_moderator?
-  end
-  helper_method :is_moderator_or_owner?
-
-  def is_moderator?
-    current_user.respond_to?(:moderator) && current_user.moderator? || current_user.respond_to?(:admin) && current_user.admin?
-  end
-  helper_method :is_moderator?
-
-  def require_mod_or_author_for_post!
-    unless is_moderator_or_owner?(@support_post)
-      redirect_to_root
-    end
-  end
-
-  def require_mod_or_author_for_thread!
-    unless is_moderator_or_owner?(@support_thread)
-      redirect_to_root
-    end
-  end
-
-  private
-
-  def redirect_to_root
-    redirect_to help_center.root_path
-  end
-end
+class HelpCenter::ApplicationController < ::ApplicationController
+  layout "help_center"
+
+  def page_number
+    page = params.fetch(:page, '').gsub(/[^0-9]/, '').to_i
+    page = "1" if page.zero?
+    page
+  end
+
+  def is_moderator_or_owner?(object)
+    is_moderator?
+  end
+  helper_method :is_moderator_or_owner?
+
+  def is_moderator?
+    current_user.respond_to?(:moderator) && current_user.moderator? || current_user.respond_to?(:admin) && current_user.admin?
+  end
+  helper_method :is_moderator?
+
+  def require_mod_or_author_for_post!
+    unless is_moderator_or_owner?(@support_post)
+      redirect_to_root
+    end
+  end
+
+  def require_mod_or_author_for_thread!
+    unless is_moderator_or_owner?(@support_thread)
+      redirect_to_root
+    end
+  end
+
+  private
+
+  def redirect_to_root
+    redirect_to help_center.root_path
+  end
+end

data/app/controllers/help_center/notifications_controller.rb

@@ -1,19 +1,19 @@
-class HelpCenter::NotificationsController < HelpCenter::ApplicationController
-  before_action :authenticate_user!
-  before_action :set_support_thread
-
-  def create
-    @support_thread.toggle_subscription(current_user)
-    redirect_to help_center.support_thread_path(@support_thread)
-  end
-
-  def show
-    redirect_to help_center.support_thread_path(@support_thread)
-  end
-
-  private
-
-    def set_support_thread
-      @support_thread = SupportThread.friendly.find(params[:support_thread_id])
-    end
-end
+class HelpCenter::NotificationsController < HelpCenter::ApplicationController
+  before_action :authenticate_user!
+  before_action :set_support_thread
+
+  def create
+    @support_thread.toggle_subscription(current_user)
+    redirect_to help_center.support_thread_path(@support_thread)
+  end
+
+  def show
+    redirect_to help_center.support_thread_path(@support_thread)
+  end
+
+  private
+
+    def set_support_thread
+      @support_thread = SupportThread.friendly.find(params[:support_thread_id])
+    end
+end