bug_reports_client 0.1.0

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

@@ -0,0 +1,39 @@
+require "rails/generators"
+
+module BugReportsClient
+  module Generators
+    # Sets a host app up to use the engine:
+    #   bin/rails g bug_reports_client:install
+    #
+    # Creates the initializer, mounts the engine, copies the default form
+    # schema (ready to customise) and an example issue template, then prints
+    # the remaining manual checklist.
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_initializer
+        template "initializer.rb", "config/initializers/bug_reports_client.rb"
+      end
+
+      def mount_engine
+        route 'mount BugReportsClient::Engine => "/bug_reports"'
+      end
+
+      # The copied schema is identical to the engine default - editing it (or
+      # deleting it to fall back to the default) is the customisation point.
+      def copy_form_schema
+        copy_file BugReportsClient::Engine.root.join("config/form_schema.yml"), "config/bug_report_form.yml"
+      end
+
+      # Copied with an .example suffix because the presence of
+      # config/bug_report_issue.md switches issue rendering to template mode.
+      def copy_issue_template_example
+        copy_file "bug_report_issue.md.example", "config/bug_report_issue.md.example"
+      end
+
+      def print_checklist
+        readme "AFTER_INSTALL" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/bug_reports_client/install/templates/AFTER_INSTALL

@@ -0,0 +1,28 @@
+
+===============================================================================
+bug_reports_client installed. Remaining steps:
+
+1. Migrations:
+     bin/rails bug_reports_client:install:migrations && bin/rails db:migrate
+
+2. Link your user model (app/models/user.rb):
+     include BugReportsClient::Reporter
+
+3. Add a menu link and the resolved-report alerts to your layout:
+     <%= link_to "Report a bug", bug_reports_client.new_bug_report_path %>
+     <%= bug_report_alerts %>
+
+4. Tailwind: add the gem's views to your build.
+   - Tailwind v3 (tailwind.config.js content globs): see README "Styling".
+   - Tailwind v4: add to app/assets/tailwind/application.css:
+       @import "../builds/tailwind/bug_reports_client";
+
+5. Environment variables (or set them in the initializer):
+     BUG_REPORT_API_URL      e.g. https://bugs.example.com/api
+     BUG_REPORT_API_KEY      this app's API token
+     BUG_REPORT_WEBHOOK_SECRET  this app's webhook secret
+     APP_HOST                public HTTPS origin of this app
+
+6. Review config/initializers/bug_reports_client.rb (source, admin_check,
+   ask_severity...) and customise config/bug_report_form.yml if you like.
+===============================================================================

data/lib/generators/bug_reports_client/install/templates/bug_report_issue.md.example

@@ -0,0 +1,23 @@
+<!--
+Rename this file to config/bug_report_issue.md to control the GitHub issue
+body yourself. Placeholders in {{double braces}} are replaced with the
+report's answers: every field key from config/bug_report_form.yml works, plus
+{{title}}, {{report_type}}, {{severity}}, {{reporter_name}}, {{app_name}} and
+{{screenshots}}. Without this file, the issue body is generated automatically
+from the schema (a heading per answered field). Delete this comment block if
+you activate the template - it would appear in your GitHub issues.
+-->
+
+**Severity:** {{severity}} | **Reported by:** {{reporter_name}} ({{app_name}})
+
+## What should happen?
+{{expected_behaviour}}
+
+## What actually happens?
+{{actual_behaviour}}
+
+## Steps to reproduce
+{{steps_to_reproduce}}
+
+## Screenshots
+{{screenshots}}

data/lib/generators/bug_reports_client/install/templates/initializer.rb

@@ -0,0 +1,31 @@
+# Configuration for bug_reports_client. Most settings default from
+# environment variables (BUG_REPORT_API_URL, BUG_REPORT_API_KEY,
+# BUG_REPORT_WEBHOOK_SECRET, APP_HOST) - see the gem README for the full
+# reference.
+BugReportsClient.configure do |config|
+  # REQUIRED: must match this app's API key name on the bug-reports API and a
+  # key in its repo mapping.
+  config.source = "<%= Rails.application.class.module_parent_name.underscore %>"
+
+  # The public HTTPS origin of this app, used for the closure callback URL and
+  # screenshot links in GitHub issues. Defaults to ENV["APP_HOST"].
+  # config.app_host = "https://myapp.example.com"
+
+  # Who counts as an admin (can see /bug_reports/all).
+  # config.admin_check = ->(user) { user.admin? }
+
+  # Whether reports come from outside your team (shown on the GitHub issue).
+  # config.reporter_external = ->(user) { true }
+
+  # Consumer-facing apps often hide the severity picker; bugs then submit
+  # config.default_severity ("medium") automatically.
+  # config.ask_severity = false
+
+  # Screenshot uploads need an Active Storage service whose URLs are publicly
+  # reachable (e.g. S3) - otherwise disable them.
+  # config.screenshots_enabled = false
+
+  # Reporter attributes, if your user model differs from the defaults
+  # (User#email and User#name). Symbols or procs are accepted.
+  # config.reporter_name_method = ->(user) { "#{user.first_name} #{user.last_name}" }
+end

data/lib/generators/bug_reports_client/views/views_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+
+module BugReportsClient
+  module Generators
+    # Copies the engine's views into the host app for full customisation:
+    #   bin/rails g bug_reports_client:views
+    #
+    # Copied views shadow the engine's per-file (Rails checks the host first),
+    # so you can copy everything and delete what you don't change. Note that
+    # copied files no longer receive engine updates.
+    class ViewsGenerator < Rails::Generators::Base
+      source_root BugReportsClient::Engine.root.join("app/views").to_s
+
+      def copy_views
+        directory "bug_reports_client", "app/views/bug_reports_client"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: bug_reports_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PSA Squash Tour
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 'Adds a fully-featured, customisable bug and feature reporting flow to
+  any Rails app: a schema-driven form, screenshot uploads, a my-reports list, and
+  signed closure webhooks from the companion bug-reports API which files GitHub issues.'
+email:
+- harry.mattocks@psasquashtour.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- app/assets/tailwind/bug_reports_client/engine.css
+- app/controllers/bug_reports_client/application_controller.rb
+- app/controllers/bug_reports_client/bug_reports_controller.rb
+- app/controllers/bug_reports_client/webhooks_controller.rb
+- app/helpers/bug_reports_client/bug_reports_helper.rb
+- app/javascript/bug_reports_client/controllers/error_summary_controller.js
+- app/javascript/bug_reports_client/controllers/file_limit_controller.js
+- app/javascript/bug_reports_client/controllers/report_type_controller.js
+- app/javascript/bug_reports_client/controllers/screenshot_dropzone_controller.js
+- app/jobs/bug_reports_client/report_error_job.rb
+- app/models/bug_reports_client/application_record.rb
+- app/models/bug_reports_client/bug_report.rb
+- app/models/bug_reports_client/error_event.rb
+- app/models/concerns/bug_reports_client/reporter.rb
+- app/services/bug_reports_client/api_client.rb
+- app/services/bug_reports_client/description_builder.rb
+- app/views/bug_reports_client/bug_reports/_field_checkbox.html.erb
+- app/views/bug_reports_client/bug_reports/_field_select.html.erb
+- app/views/bug_reports_client/bug_reports/_field_text.html.erb
+- app/views/bug_reports_client/bug_reports/_field_textarea.html.erb
+- app/views/bug_reports_client/bug_reports/_filters.html.erb
+- app/views/bug_reports_client/bug_reports/_form.html.erb
+- app/views/bug_reports_client/bug_reports/_pagination.html.erb
+- app/views/bug_reports_client/bug_reports/_rating_badge.html.erb
+- app/views/bug_reports_client/bug_reports/_related_error.html.erb
+- app/views/bug_reports_client/bug_reports/_status_badge.html.erb
+- app/views/bug_reports_client/bug_reports/_type_badge.html.erb
+- app/views/bug_reports_client/bug_reports/all.html.erb
+- app/views/bug_reports_client/bug_reports/edit.html.erb
+- app/views/bug_reports_client/bug_reports/index.html.erb
+- app/views/bug_reports_client/bug_reports/new.html.erb
+- app/views/bug_reports_client/shared/_after_dismiss.turbo_stream.erb
+- app/views/bug_reports_client/shared/_alerts.html.erb
+- config/form_schema.yml
+- config/importmap.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20260721000001_create_bug_reports.rb
+- db/migrate/20260723000002_create_bug_report_error_events.rb
+- db/migrate/20260723000003_add_activity_to_bug_report_error_events.rb
+- lib/bug_reports_client.rb
+- lib/bug_reports_client/configuration.rb
+- lib/bug_reports_client/engine.rb
+- lib/bug_reports_client/error_context.rb
+- lib/bug_reports_client/error_reporter.rb
+- lib/bug_reports_client/form_schema.rb
+- lib/bug_reports_client/main_app_routes.rb
+- lib/bug_reports_client/version.rb
+- lib/generators/bug_reports_client/install/install_generator.rb
+- lib/generators/bug_reports_client/install/templates/AFTER_INSTALL
+- lib/generators/bug_reports_client/install/templates/bug_report_issue.md.example
+- lib/generators/bug_reports_client/install/templates/initializer.rb
+- lib/generators/bug_reports_client/views/views_generator.rb
+homepage: https://github.com/Professional-Squash-Association/bug-reports
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Professional-Squash-Association/bug-reports
+  source_code_uri: https://github.com/Professional-Squash-Association/bug-reports
+  changelog_uri: https://github.com/Professional-Squash-Association/bug-reports/blob/main/client/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Mountable Rails engine for submitting bug reports and feature requests to
+  a central bug-reports API
+test_files: []