bootstrap_feedbacker 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fcf1b3b1b691f4919e562650859e0409029a94668c6e987ee9471c3369c6a4a
-  data.tar.gz: 50500796c58e2858b18f418cda4ec9e9ef14cdadf450ae361ff9a3743a91449e
+  metadata.gz: 030fbf4be8402a47970dcc5222361857019f2314757df81ae10068b163f0ddcc
+  data.tar.gz: 442e62e32fe40bdf7551506e79354128b36a1d47ccb33f582d33a8a3a45e5a45
 SHA512:
-  metadata.gz: 9ab358d81eda954c83a746848e6e591a34459f0988b26ed17617d537b718bbfc1159ff0e47e947348aedd5087300c8ad7ac3378272ef2463e75fd55524c24d77
-  data.tar.gz: f9c6b739bca165bb1cf3397499b92cd57f19e2b953580f855625d1743bee529fe55eca554a4f204f1ece00f1cdfcf0bb8c7e84504940e59dfb0154b726f1b86b
+  metadata.gz: d3b049102364ba8a80c662de058f75170a5826362f461849f656a45761ac341d866e0e2ca1fdc2f7f2acc32b528f65e77383fdab5840d4c88980b5d1b9e4c504
+  data.tar.gz: 37baa68a20025d9e6390c33b77fdc077d0ac4ffa6e0015ceaae00cb059a98c299c6235b19ef5315ceff931691e943a08aa9cb894761fc11bc852272cbaf2b783

data/README.md

@@ -1,59 +1,81 @@
-[![Gem Version](https://badge.fury.io/rb/bootstrap_feedbacker.png)](http://badge.fury.io/rb/bootstrap_feedbacker)
-[![Code Climate](https://codeclimate.com/github/wwidea/bootstrap_feedbacker.png)](https://codeclimate.com/github/wwidea/bootstrap_feedbacker)
-
 # BootstrapFeedbacker
-BootstrapFeedbacker provides a modal form to collect user feedback and sends it in an email including the current page URL to the configured email address.
+
+BootstrapFeedbacker displays a modal form for collecting feedback and emails it to a configured
+address, along with the referring page URL (when available) and the current user's details.
 
 ## Requirements
 
-* Rails 6.0 or higher with Import Maps, Turbo Frames, and Stimulus
-* Bootstrap version 4
-* **User** model with an **email** attribute
-* **current_user** method defined in **ApplicationController**
+- Ruby 3.3 or later and Rails 7.1 or later
+- Import Maps, Turbo, and Stimulus
+- Bootstrap 5 CSS and JavaScript, with `window.bootstrap.Modal` available
+- A user model with an `email` attribute and a name method (default: `name`)
+- A `current_user` method available to the application's controllers
+- Action Mailer configured to deliver email
 
 ## Installation
 
-1. Add the `bootstrap_feedbacker` gem to your Gemfile:
-```ruby
-gem "bootstrap_feedbacker"
-```
+1. Add the gem to your Gemfile and run `bundle install`:
 
-2. Run `bundle install`.
+   ```ruby
+   gem "bootstrap_feedbacker"
+   ```
 
-3. Run `rails bootstrap_feedbacker:install:migrations`.
+2. Install and run the migrations:
 
-4. Run `rails db:migrate` to add the **bootstrap_feedbacker_remarks** table to your schema.
+   ```sh
+   bin/rails bootstrap_feedbacker:install:migrations
+   bin/rails db:migrate
+   ```
 
-5. Mount the engine in your **routes.rb** file:
-```ruby
-mount BootstrapFeedbacker::Engine, at: '/bootstrap_feedbacker'
-```
+3. Mount the engine in `config/routes.rb`:
 
-6. Add the bootstrap feedbacker link and modal container to a view file:
-```erb
-<%= bootstrap_feedbacker_link %>
-<%= bootstrap_feedbacker_modal %>
-```
+   ```ruby
+   mount BootstrapFeedbacker::Engine, at: "/bootstrap_feedbacker"
+   ```
+
+4. Include Bootstrap 5 CSS and JavaScript in your application. For example, with the Bootstrap
+   gem's JavaScript assets and Import Maps, pin the non-ES module build in `config/importmap.rb`:
+
+   ```ruby
+   pin "bootstrap", to: "bootstrap.min.js"
+   ```
+
+   Import it in `app/javascript/application.js`:
+
+   ```javascript
+   import "bootstrap"
+   ```
+
+   The gem's Stimulus controller uses `window.bootstrap.Modal` to open the form. Ensure your
+   application also loads its Stimulus controllers, for example with `lazyLoadControllersFrom`.
+
+5. Add the feedback link and modal container to a view:
+
+   ```erb
+   <%= bootstrap_feedbacker_link %>
+   <%= bootstrap_feedbacker_modal %>
+   ```
 
-## Configure
+## Configuration
 
-Create `config/initializersbootstrap_feedbacker.rb` and set your email address:
+Set the recipient address in `config/initializers/bootstrap_feedbacker.rb`:
 
 ```ruby
-BootstrapFeedbacker::SETTINGS.email_to = 'support@yourdomain.com'
+BootstrapFeedbacker::SETTINGS.email_to = "support@example.com"
 ```
 
-Or set your email address and override any of these default settings:
+The same address is used as the sender; replies go to the current user's email address.
+You can also configure these settings:
 
 ```ruby
-  BootstrapFeedbacker::SETTINGS.update do |settings|
-    settings.email_to           = 'support@yourdomain.com'
-    settings.email_prefix       = '[FEEDBACKER]'                              # default
-    settings.modal_content_id   = 'bootstrap_feedbacker_remark_modal_content' # default
-    settings.modal_id           = 'bootstrap_feedbacker_remark_modal'         # default
-    settings.user_class         = 'User'                                      # default
-    settings.user_name_method   = :name                                       # default
-  end
+BootstrapFeedbacker::SETTINGS.update do |settings|
+  settings.email_to           = "support@example.com"
+  settings.email_prefix       = "[FEEDBACKER]" # default
+  settings.modal_content_id   = "bootstrap_feedbacker_remark_modal_content" # default
+  settings.modal_id           = "bootstrap_feedbacker_remark_modal" # default
+  settings.user_class         = "User" # default
+  settings.user_name_method   = :name # default
+end
 ```
 
 ## License

data/Rakefile

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
-load "rails/tasks/statistics.rake"
-
 require "bundler/gem_tasks"

data/app/assets/javascripts/controllers/bootstrap_feedbacker/remarks_controller.js

@@ -5,6 +5,6 @@ export default class extends Controller {
   static targets  = [ "modal" ]
 
   modalTargetConnected(element) {
-    $(element).modal('show')
+    window.bootstrap.Modal.getOrCreateInstance(element).show()
   }
 }

data/app/controllers/bootstrap_feedbacker/remarks_controller.rb

@@ -4,16 +4,16 @@ module BootstrapFeedbacker
   class RemarksController < ApplicationController
     def new
       @remark = BootstrapFeedbacker::Remark.new
-      render_update(SETTINGS.modal_id, partial: 'new')
+      render_update(SETTINGS.modal_id, partial: "new")
     end
 
     def create
       @remark = Remark.new(remark_params)
       if @remark.save
         FeedbackMailer.feedback(@remark).deliver_now
-        render_update(SETTINGS.modal_content_id, partial: 'thank_you')
+        render_update(SETTINGS.modal_content_id, partial: "thank_you")
       else
-        render_update(SETTINGS.modal_content_id, partial: 'error', status: :unprocessable_entity)
+        render_update(SETTINGS.modal_content_id, partial: "error", status: :unprocessable_content)
       end
     end
 
@@ -22,12 +22,12 @@ module BootstrapFeedbacker
     def remark_params
       params.require(:remark).permit(:content).merge(
         user_id:    current_user.id,
-        source_url: request.env['HTTP_REFERER'] || 'no referrer'
+        source_url: request.env["HTTP_REFERER"] || "no referrer"
       )
     end
 
     def render_update(dom_id, partial:, status: :ok)
-      render(turbo_stream: turbo_stream.update(dom_id, partial: partial), status:)
+      render(turbo_stream: turbo_stream.update(dom_id, partial:), status:)
     end
   end
 end

data/app/helpers/bootstrap_feedbacker/modals_helper.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BootstrapFeedbacker
   module ModalsHelper
-    def bootstrap_feedbacker_link(name: 'Feedback', **html_options)
-      link_to(name, bootstrap_feedbacker.new_remark_path, 'data-turbo-stream': true, **html_options)
+    def bootstrap_feedbacker_link(name: "Feedback", **html_options)
+      link_to(name, bootstrap_feedbacker.new_remark_path, "data-turbo-stream": true, **html_options)
     end
 
     def bootstrap_feedbacker_modal

data/app/mailers/bootstrap_feedbacker/application_mailer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BootstrapFeedbacker
+  class ApplicationMailer < ActionMailer::Base
+    layout "bootstrap_feedbacker/mailer"
+  end
+end

data/app/mailers/bootstrap_feedbacker/feedback_mailer.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module BootstrapFeedbacker
-  class FeedbackMailer < ActionMailer::Base
+  class FeedbackMailer < ApplicationMailer
     def feedback(remark)
       @remark = remark
       mail(
-        to:         BootstrapFeedbacker::SETTINGS.email_to,
-        from:       BootstrapFeedbacker::SETTINGS.email_to,
-        reply_to:   remark.user.email,
-        subject:    "#{BootstrapFeedbacker::SETTINGS.email_prefix} Feedback Notification"
+        to:       BootstrapFeedbacker::SETTINGS.email_to,
+        from:     BootstrapFeedbacker::SETTINGS.email_to,
+        reply_to: remark.user.email,
+        subject:  "#{BootstrapFeedbacker::SETTINGS.email_prefix} Feedback Notification"
       )
     end
   end

data/app/models/bootstrap_feedbacker/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BootstrapFeedbacker
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/bootstrap_feedbacker/remark.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module BootstrapFeedbacker
-  class Remark < ActiveRecord::Base
-    belongs_to :user, class_name: BootstrapFeedbacker::SETTINGS.user_class
+  class Remark < BootstrapFeedbacker::ApplicationRecord
+    belongs_to :user, class_name: BootstrapFeedbacker::SETTINGS.user_class.to_s
 
     def user_name
-      return user.send(BootstrapFeedbacker::SETTINGS.user_name_method)
+      user.send(BootstrapFeedbacker::SETTINGS.user_name_method)
     end
   end
 end

data/app/views/bootstrap_feedbacker/feedback_mailer/feedback.text.erb

@@ -0,0 +1,7 @@
+Feedback Received
+
+From: <%= @remark.user_name %> [<%= @remark.user.email %>]
+Page: <%= @remark.source_url %>
+
+Comments:
+<%= @remark.content %>

data/app/views/bootstrap_feedbacker/remarks/_close_button.html.erb

@@ -1 +1 @@
-<button type="button" class="btn btn-info" data-dismiss="modal">Close</button>
+<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>

data/app/views/bootstrap_feedbacker/remarks/{_error.erb → _error.html.erb}

@@ -1,6 +1,6 @@
 <div class="modal-body text-danger">
-  <%= t('.message') %>
+  <%= t(".message") %>
 </div>
 <div class="modal-footer">
-  <%= render('close_button') %>
+  <%= render("close_button") %>
 </div>

data/app/views/bootstrap_feedbacker/remarks/_form.html.erb

@@ -1,12 +1,12 @@
 <%= form_for(@remark) do |f| %>
   <div class="modal-body">
     <div class="mb-2">
-      <%= t('.greeting') %>
+      <%= t(".greeting") %>
     </div>
-    <%= f.text_area :content, class: "form-control" %>
+    <%= f.text_area(:content, class: "form-control") %>
   </div>
   <div class="modal-footer">
-    <%= f.submit('Submit Feedback', class: "btn btn-success") %>
-    <%= render('close_button') %>
+    <%= render("close_button") %>
+    <%= f.submit("Submit Feedback", class: "btn btn-success") %>
   </div>
 <% end %>

data/app/views/bootstrap_feedbacker/remarks/_new.html.erb

@@ -1,15 +1,19 @@
 <div data-controller="bootstrap-feedbacker--remarks">
-  <div class="modal fade" tabindex="-1" role="dialog" aria-labelledby="modalFeedbackLabel" data-bootstrap-feedbacker--remarks-target="modal">
-    <div class="modal-dialog" role="document">
+  <div
+    class="modal fade"
+    tabindex="-1"
+    aria-labelledby="modalFeedbackLabel"
+    aria-hidden="true"
+    data-bootstrap-feedbacker--remarks-target="modal"
+  >
+    <div class="modal-dialog">
       <div class="modal-content">
         <div class="modal-header">
-          <h4 class="modal-title" id="modalFeedbackLabel"><%= t('.title') %></h4>
-          <button type="button" class="close" data-dismiss="modal" aria-label="Close">
-            <span aria-hidden="true">&times;</span>
-          </button>
+          <h1 class="modal-title fs-5" id="modalFeedbackLabel"><%= t(".title") %></h1>
+          <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
         </div>
-        <%= tag.div id: BootstrapFeedbacker::SETTINGS.modal_content_id do %>
-          <%= render('form') %>
+        <%= tag.div(id: BootstrapFeedbacker::SETTINGS.modal_content_id) do %>
+          <%= render("form") %>
         <% end %>
       </div>
     </div>

data/app/views/bootstrap_feedbacker/remarks/_thank_you.html.erb

@@ -1,6 +1,6 @@
 <div class="modal-body text-success">
-  <%= t('.message') %>
+  <%= t(".message") %>
 </div>
 <div class="modal-footer">
-  <%= render('close_button') %>
+  <%= render("close_button") %>
 </div>

data/app/views/layouts/bootstrap_feedbacker/mailer.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/bootstrap_feedbacker/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/config/importmap.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 pin_all_from File.expand_path("../app/assets/javascripts/controllers", __dir__), under: "controllers"

data/config/locales/bootstrap_feedbacker.en.yml

@@ -3,7 +3,7 @@ en:
   bootstrap_feedbacker:
     remarks:
       error:
-        message: An error occured saving your feedback. Please try again.
+        message: We couldn't save your feedback due to an error.
       form:
         greeting: What's on your mind?
       new:

data/config/routes.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 BootstrapFeedbacker::Engine.routes.draw do
-  resources :remarks, only: %i(new create)
+  resources :remarks, only: %i[new create]
 end

data/db/migrate/20170306210545_convert_source_url_to_text.rb

@@ -2,6 +2,7 @@ class ConvertSourceUrlToText < ActiveRecord::Migration[5.1]
   def up
     change_column :bootstrap_feedbacker_remarks, :source_url, :text
   end
+
   def down
     change_column :bootstrap_feedbacker_remarks, :source_url, :string
   end

data/lib/bootstrap_feedbacker/engine.rb

@@ -9,15 +9,11 @@ module BootstrapFeedbacker
     end
 
     initializer "bootstrap_feedbacker.assets" do
-      if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += %w( controllers/bootstrap_feedbacker/remarks_controller.js )
-      end
+      Rails.application.config.assets.precompile += %w[controllers/bootstrap_feedbacker/remarks_controller.js] if Rails.application.config.respond_to?(:assets)
     end
 
     initializer "bootstrap_feedbacker.importmap", before: "importmap" do |app|
-      if Rails.application.respond_to?(:importmap)
-        app.config.importmap.paths << Engine.root.join("config/importmap.rb")
-      end
+      app.config.importmap.paths << Engine.root.join("config/importmap.rb") if Rails.application.respond_to?(:importmap)
     end
   end
 end

data/lib/bootstrap_feedbacker/settings.rb

@@ -5,11 +5,11 @@ module BootstrapFeedbacker
     attr_accessor :email_to, :email_prefix, :modal_content_id, :modal_id, :user_name_method, :user_class
 
     def initialize
-      self.email_to           = ''
-      self.email_prefix       = '[FEEDBACKER]'
-      self.modal_content_id   = 'bootstrap_feedbacker_remark_modal_content'
-      self.modal_id           = 'bootstrap_feedbacker_remark_modal'
-      self.user_class         = 'User'
+      self.email_to           = ""
+      self.email_prefix       = "[FEEDBACKER]"
+      self.modal_content_id   = "bootstrap_feedbacker_remark_modal_content"
+      self.modal_id           = "bootstrap_feedbacker_remark_modal"
+      self.user_class         = "User"
       self.user_name_method   = :name
     end
 

data/lib/bootstrap_feedbacker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BootstrapFeedbacker
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,30 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_feedbacker
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Aaron Baldwin
 - Brightways Learning
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Bootstrap Feedbacker opens a modal window for users to send application
   feedback over email that includes the referring url.
 email:
@@ -40,14 +81,19 @@ files:
 - app/controllers/bootstrap_feedbacker/application_controller.rb
 - app/controllers/bootstrap_feedbacker/remarks_controller.rb
 - app/helpers/bootstrap_feedbacker/modals_helper.rb
+- app/mailers/bootstrap_feedbacker/application_mailer.rb
 - app/mailers/bootstrap_feedbacker/feedback_mailer.rb
+- app/models/bootstrap_feedbacker/application_record.rb
 - app/models/bootstrap_feedbacker/remark.rb
 - app/views/bootstrap_feedbacker/feedback_mailer/feedback.html.erb
+- app/views/bootstrap_feedbacker/feedback_mailer/feedback.text.erb
 - app/views/bootstrap_feedbacker/remarks/_close_button.html.erb
-- app/views/bootstrap_feedbacker/remarks/_error.erb
+- app/views/bootstrap_feedbacker/remarks/_error.html.erb
 - app/views/bootstrap_feedbacker/remarks/_form.html.erb
 - app/views/bootstrap_feedbacker/remarks/_new.html.erb
 - app/views/bootstrap_feedbacker/remarks/_thank_you.html.erb
+- app/views/layouts/bootstrap_feedbacker/mailer.html.erb
+- app/views/layouts/bootstrap_feedbacker/mailer.text.erb
 - config/importmap.rb
 - config/locales/bootstrap_feedbacker.en.yml
 - config/routes.rb
@@ -62,8 +108,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/wwidea/bootstrap_feedbacker
-  source_code_uri: https://github.com/wwidea/bootstrap_feedbacker
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -71,15 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.10
-signing_key:
+rubygems_version: 4.0.23
 specification_version: 4
 summary: User feedback form in a Bootstrap modal.
 test_files: []