help_center 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/.github/FUNDING.yml +12 -12
  3. data/.gitignore +10 -10
  4. data/CHANGELOG.md +1 -1
  5. data/CODE_OF_CONDUCT.md +74 -74
  6. data/Gemfile +6 -6
  7. data/LICENSE.txt +21 -21
  8. data/README.md +164 -155
  9. data/Rakefile +10 -10
  10. data/app/assets/stylesheets/help_center.scss +139 -119
  11. data/app/controllers/help_center/application_controller.rb +37 -37
  12. data/app/controllers/help_center/notifications_controller.rb +19 -19
  13. data/app/controllers/help_center/support_categories_controller.rb +58 -17
  14. data/app/controllers/help_center/support_posts_controller.rb +72 -72
  15. data/app/controllers/help_center/support_threads_controller.rb +16 -6
  16. data/app/helpers/help_center/support_posts_helper.rb +29 -29
  17. data/app/helpers/help_center/support_threads_helper.rb +28 -28
  18. data/app/jobs/help_center/support_post_notification_job.rb +42 -42
  19. data/app/jobs/help_center/support_thread_notification_job.rb +40 -40
  20. data/app/mailers/help_center/user_mailer.rb +28 -28
  21. data/app/models/support_category.rb +13 -13
  22. data/app/models/support_post.rb +15 -15
  23. data/app/models/support_subscription.rb +19 -19
  24. data/app/models/support_thread.rb +85 -85
  25. data/app/views/help_center/support_categories/_form.html.erb +35 -0
  26. data/app/views/help_center/support_categories/_support_thread.html.erb +25 -0
  27. data/app/views/help_center/support_categories/edit.html.erb +7 -0
  28. data/app/views/help_center/support_categories/index.html.erb +19 -0
  29. data/app/views/help_center/support_categories/new.html.erb +5 -0
  30. data/app/views/help_center/support_categories/show.html.erb +20 -0
  31. data/app/views/help_center/support_threads/_form.html.erb +6 -4
  32. data/app/views/help_center/support_threads/edit.html.erb +7 -7
  33. data/app/views/help_center/support_threads/index.html.erb +1 -1
  34. data/app/views/help_center/support_threads/new.html.erb +5 -5
  35. data/app/views/help_center/support_threads/show.html.erb +42 -1
  36. data/app/views/layouts/help_center.html.erb +37 -13
  37. data/app/views/shared/_spacer.html.erb +1 -1
  38. data/bin/console +14 -14
  39. data/bin/setup +8 -8
  40. data/config/locales/en.yml +55 -52
  41. data/config/routes.rb +24 -24
  42. data/db/migrate/20170417012930_create_support_categories.rb +19 -19
  43. data/db/migrate/20170417012931_create_support_threads.rb +18 -18
  44. data/db/migrate/20170417012932_create_support_posts.rb +12 -12
  45. data/db/migrate/20170417012933_create_support_subscriptions.rb +11 -11
  46. data/help_center.gemspec +29 -29
  47. data/lib/generators/help_center/controllers_generator.rb +13 -13
  48. data/lib/generators/help_center/helpers_generator.rb +13 -13
  49. data/lib/generators/help_center/views_generator.rb +13 -13
  50. data/lib/help_center.rb +23 -24
  51. data/lib/help_center/engine.rb +10 -10
  52. data/lib/help_center/slack.rb +22 -22
  53. data/lib/help_center/support_user.rb +10 -10
  54. data/lib/help_center/version.rb +3 -3
  55. metadata +11 -8
  56. data/.travis.yml +0 -5
  57. data/app/views/help_center/support_threads/_article.html.erb +0 -32
  58. data/lib/help_center/will_paginate.rb +0 -53
@@ -1,18 +1,18 @@
1
- class CreateSupportThreads < ActiveRecord::Migration[4.2]
2
- def change
3
- create_table :support_threads do |t|
4
- t.references :support_category, foreign_key: true
5
- t.references :user, foreign_key: true
6
- t.string :title, null: false
7
- t.string :slug, null: false
8
- t.integer :support_posts_count, default: 0
9
- t.integer :like_count, default: 0
10
- t.integer :dislike_count, default: 0
11
- t.boolean :pinned, default: false
12
- t.boolean :solved, default: false
13
- t.integer :position, default: 0
14
-
15
- t.timestamps
16
- end
17
- end
18
- end
1
+ class CreateSupportThreads < ActiveRecord::Migration[4.2]
2
+ def change
3
+ create_table :support_threads do |t|
4
+ t.references :support_category, foreign_key: true
5
+ t.references :user, foreign_key: true
6
+ t.string :title, null: false
7
+ t.string :slug, null: false
8
+ t.integer :support_posts_count, default: 0
9
+ t.integer :like_count, default: 0
10
+ t.integer :dislike_count, default: 0
11
+ t.boolean :pinned, default: false
12
+ t.boolean :solved, default: false
13
+ t.integer :position, default: 0
14
+
15
+ t.timestamps
16
+ end
17
+ end
18
+ end
@@ -1,12 +1,12 @@
1
- class CreateSupportPosts < ActiveRecord::Migration[4.2]
2
- def change
3
- create_table :support_posts do |t|
4
- t.references :support_thread, foreign_key: true
5
- t.references :user, foreign_key: true
6
- t.text :body
7
- t.boolean :solved, default: false
8
-
9
- t.timestamps
10
- end
11
- end
12
- end
1
+ class CreateSupportPosts < ActiveRecord::Migration[4.2]
2
+ def change
3
+ create_table :support_posts do |t|
4
+ t.references :support_thread, foreign_key: true
5
+ t.references :user, foreign_key: true
6
+ t.text :body
7
+ t.boolean :solved, default: false
8
+
9
+ t.timestamps
10
+ end
11
+ end
12
+ end
@@ -1,11 +1,11 @@
1
- class CreateSupportSubscriptions < ActiveRecord::Migration[4.2]
2
- def change
3
- create_table :support_subscriptions do |t|
4
- t.references :support_thread, foreign_key: true
5
- t.references :user, foreign_key: true
6
- t.string :subscription_type
7
-
8
- t.timestamps
9
- end
10
- end
11
- end
1
+ class CreateSupportSubscriptions < ActiveRecord::Migration[4.2]
2
+ def change
3
+ create_table :support_subscriptions do |t|
4
+ t.references :support_thread, foreign_key: true
5
+ t.references :user, foreign_key: true
6
+ t.string :subscription_type
7
+
8
+ t.timestamps
9
+ end
10
+ end
11
+ end
data/help_center.gemspec CHANGED
@@ -1,29 +1,29 @@
1
- # coding: utf-8
2
- lib = File.expand_path("../lib", __FILE__)
3
- $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
- require "help_center/version"
5
-
6
- Gem::Specification.new do |spec|
7
- spec.name = "help_center"
8
- spec.version = HelpCenter::VERSION
9
- spec.authors = ["Ugurcan Kaya"]
10
- spec.email = ["support@pasilobus.com"]
11
-
12
- spec.summary = %q{A wiki gem for creating documentation & help centers in your Rails app}
13
- spec.description = %q{A wiki gem for creating documentation & help centers in your Rails app}
14
- spec.homepage = "https://github.com/uurcank/help_center"
15
- spec.license = "MIT"
16
-
17
- spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
- f.match(%r{^(test|spec|features)/})
19
- end
20
- spec.bindir = "exe"
21
- spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
- spec.require_paths = ["lib"]
23
-
24
- spec.add_dependency 'font-awesome-sass', '~> 5.13.0'
25
- spec.add_dependency 'friendly_id', '>= 5.2.0'
26
- spec.add_dependency 'gravatar_image_tag'
27
- spec.add_dependency 'rails', '>= 6.0.0'
28
- spec.add_dependency 'will_paginate', '>= 3.1.0'
29
- end
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "help_center/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "help_center"
8
+ spec.version = HelpCenter::VERSION
9
+ spec.authors = ["Ugurcan Kaya"]
10
+ spec.email = ["support@pasilobus.com"]
11
+
12
+ spec.summary = %q{A wiki gem for creating documentation & help centers in your Rails app}
13
+ spec.description = %q{A wiki gem for creating documentation & help centers in your Rails app}
14
+ spec.homepage = "https://github.com/uurcank/help_center"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency 'font-awesome-sass', '>= 5.13.0'
25
+ spec.add_dependency 'friendly_id', '>= 5.2.0'
26
+ spec.add_dependency 'gravatar_image_tag'
27
+ spec.add_dependency 'rails', '>= 6.0.0'
28
+ spec.add_dependency 'will_paginate', '>= 3.1.0'
29
+ end
@@ -1,13 +1,13 @@
1
- require 'rails/generators'
2
-
3
- module HelpCenter
4
- module Generators
5
- class ControllersGenerator < Rails::Generators::Base
6
- source_root File.expand_path("../../../..", __FILE__)
7
-
8
- def copy_controllers
9
- directory 'app/controllers/help_center', 'app/controllers/help_center'
10
- end
11
- end
12
- end
13
- end
1
+ require 'rails/generators'
2
+
3
+ module HelpCenter
4
+ module Generators
5
+ class ControllersGenerator < Rails::Generators::Base
6
+ source_root File.expand_path("../../../..", __FILE__)
7
+
8
+ def copy_controllers
9
+ directory 'app/controllers/help_center', 'app/controllers/help_center'
10
+ end
11
+ end
12
+ end
13
+ end
@@ -1,13 +1,13 @@
1
- require 'rails/generators'
2
-
3
- module HelpCenter
4
- module Generators
5
- class HelpersGenerator < Rails::Generators::Base
6
- source_root File.expand_path("../../../..", __FILE__)
7
-
8
- def copy_views
9
- directory 'app/helpers', 'app/helpers'
10
- end
11
- end
12
- end
13
- end
1
+ require 'rails/generators'
2
+
3
+ module HelpCenter
4
+ module Generators
5
+ class HelpersGenerator < Rails::Generators::Base
6
+ source_root File.expand_path("../../../..", __FILE__)
7
+
8
+ def copy_views
9
+ directory 'app/helpers', 'app/helpers'
10
+ end
11
+ end
12
+ end
13
+ end
@@ -1,13 +1,13 @@
1
- require 'rails/generators'
2
-
3
- module HelpCenter
4
- module Generators
5
- class ViewsGenerator < Rails::Generators::Base
6
- source_root File.expand_path("../../../..", __FILE__)
7
-
8
- def copy_views
9
- directory 'app/views', 'app/views'
10
- end
11
- end
12
- end
13
- end
1
+ require 'rails/generators'
2
+
3
+ module HelpCenter
4
+ module Generators
5
+ class ViewsGenerator < Rails::Generators::Base
6
+ source_root File.expand_path("../../../..", __FILE__)
7
+
8
+ def copy_views
9
+ directory 'app/views', 'app/views'
10
+ end
11
+ end
12
+ end
13
+ end
data/lib/help_center.rb CHANGED
@@ -1,24 +1,23 @@
1
- require 'font-awesome-sass'
2
- require 'friendly_id'
3
- require 'gravatar_image_tag'
4
- require 'will_paginate'
5
-
6
- require 'help_center/engine'
7
- require 'help_center/support_user'
8
- require 'help_center/slack'
9
- require 'help_center/version'
10
- require 'help_center/will_paginate'
11
-
12
- module HelpCenter
13
- # Define who owns the subscription
14
- mattr_accessor :enable_comments
15
- mattr_accessor :send_email_notifications
16
- mattr_accessor :send_slack_notifications
17
- @@send_email_notifications = false
18
- @@send_email_notifications = true
19
- @@send_slack_notifications = true
20
-
21
- def self.setup
22
- yield self
23
- end
24
- end
1
+ require 'font-awesome-sass'
2
+ require 'friendly_id'
3
+ require 'gravatar_image_tag'
4
+ require 'pagy'
5
+
6
+ require 'help_center/engine'
7
+ require 'help_center/support_user'
8
+ require 'help_center/slack'
9
+ require 'help_center/version'
10
+
11
+ module HelpCenter
12
+ # Define who owns the subscription
13
+ mattr_accessor :enable_comments
14
+ mattr_accessor :send_email_notifications
15
+ mattr_accessor :send_slack_notifications
16
+ @@send_email_notifications = false
17
+ @@send_email_notifications = true
18
+ @@send_slack_notifications = true
19
+
20
+ def self.setup
21
+ yield self
22
+ end
23
+ end
@@ -1,10 +1,10 @@
1
- module HelpCenter
2
- class Engine < ::Rails::Engine
3
- engine_name 'help_center'
4
-
5
- # Grab the Rails default url options and use them for sending emails & notifications
6
- config.after_initialize do
7
- HelpCenter::Engine.routes.default_url_options = ActionMailer::Base.default_url_options
8
- end
9
- end
10
- end
1
+ module HelpCenter
2
+ class Engine < ::Rails::Engine
3
+ engine_name 'help_center'
4
+
5
+ # Grab the Rails default url options and use them for sending emails & notifications
6
+ config.after_initialize do
7
+ HelpCenter::Engine.routes.default_url_options = ActionMailer::Base.default_url_options
8
+ end
9
+ end
10
+ end
@@ -1,22 +1,22 @@
1
- require 'open-uri'
2
- require 'net/http'
3
-
4
- module HelpCenter
5
- class Slack
6
- attr_reader :url
7
-
8
- def initialize(url)
9
- @url = url
10
- end
11
-
12
- def post(payload)
13
- uri = URI.parse(url)
14
- request = Net::HTTP::Post.new(uri)
15
- req_options = { use_ssl: uri.scheme == "https", }
16
- request.body = "payload=#{payload.to_json}"
17
- response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
18
- http.request(request)
19
- end
20
- end
21
- end
22
- end
1
+ require 'open-uri'
2
+ require 'net/http'
3
+
4
+ module HelpCenter
5
+ class Slack
6
+ attr_reader :url
7
+
8
+ def initialize(url)
9
+ @url = url
10
+ end
11
+
12
+ def post(payload)
13
+ uri = URI.parse(url)
14
+ request = Net::HTTP::Post.new(uri)
15
+ req_options = { use_ssl: uri.scheme == "https", }
16
+ request.body = "payload=#{payload.to_json}"
17
+ response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
18
+ http.request(request)
19
+ end
20
+ end
21
+ end
22
+ end
@@ -1,10 +1,10 @@
1
- module HelpCenter
2
- module SupportUser
3
- extend ActiveSupport::Concern
4
-
5
- included do
6
- has_many :support_threads
7
- has_many :support_posts
8
- end
9
- end
10
- end
1
+ module HelpCenter
2
+ module SupportUser
3
+ extend ActiveSupport::Concern
4
+
5
+ included do
6
+ has_many :support_threads
7
+ has_many :support_posts
8
+ end
9
+ end
10
+ end
@@ -1,3 +1,3 @@
1
- module HelpCenter
2
- VERSION = "0.0.4"
3
- end
1
+ module HelpCenter
2
+ VERSION = "0.0.5"
3
+ end
metadata CHANGED
@@ -1,27 +1,27 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: help_center
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.4
4
+ version: 0.0.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ugurcan Kaya
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-08-05 00:00:00.000000000 Z
11
+ date: 2021-03-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: font-awesome-sass
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
19
  version: 5.13.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: 5.13.0
27
27
  - !ruby/object:Gem::Dependency
@@ -89,7 +89,6 @@ extra_rdoc_files: []
89
89
  files:
90
90
  - ".github/FUNDING.yml"
91
91
  - ".gitignore"
92
- - ".travis.yml"
93
92
  - CHANGELOG.md
94
93
  - CODE_OF_CONDUCT.md
95
94
  - Gemfile
@@ -111,10 +110,15 @@ files:
111
110
  - app/models/support_post.rb
112
111
  - app/models/support_subscription.rb
113
112
  - app/models/support_thread.rb
113
+ - app/views/help_center/support_categories/_form.html.erb
114
+ - app/views/help_center/support_categories/_support_thread.html.erb
115
+ - app/views/help_center/support_categories/edit.html.erb
116
+ - app/views/help_center/support_categories/index.html.erb
117
+ - app/views/help_center/support_categories/new.html.erb
118
+ - app/views/help_center/support_categories/show.html.erb
114
119
  - app/views/help_center/support_posts/_form.html.erb
115
120
  - app/views/help_center/support_posts/_support_post.html.erb
116
121
  - app/views/help_center/support_posts/edit.html.erb
117
- - app/views/help_center/support_threads/_article.html.erb
118
122
  - app/views/help_center/support_threads/_form.html.erb
119
123
  - app/views/help_center/support_threads/_support_thread.html.erb
120
124
  - app/views/help_center/support_threads/edit.html.erb
@@ -143,7 +147,6 @@ files:
143
147
  - lib/help_center/slack.rb
144
148
  - lib/help_center/support_user.rb
145
149
  - lib/help_center/version.rb
146
- - lib/help_center/will_paginate.rb
147
150
  homepage: https://github.com/uurcank/help_center
148
151
  licenses:
149
152
  - MIT
@@ -163,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
163
166
  - !ruby/object:Gem::Version
164
167
  version: '0'
165
168
  requirements: []
166
- rubygems_version: 3.1.2
169
+ rubygems_version: 3.2.3
167
170
  signing_key:
168
171
  specification_version: 4
169
172
  summary: A wiki gem for creating documentation & help centers in your Rails app