plan_my_stuff 0.1.0 → 1.0.0

data/app/views/plan_my_stuff/testing_projects/show.html.erb

@@ -0,0 +1,65 @@
+<h1><%= @project.title %></h1>
+
+<p>
+  <%= link_to('Edit', plan_my_stuff.edit_testing_project_path(@project.number)) %>
+  <% if @support_user && @project.url.present? %>
+    <%= link_to('View on GitHub', @project.url, target: '_blank', rel: 'noopener') %>
+  <% end %>
+</p>
+
+<% if @support_user && @project.metadata.subject_urls.present? %>
+  <p>
+    <strong>Subject URLs:</strong>
+    <% @project.metadata.subject_urls.each do |url| %>
+      <%= link_to(url, url, target: '_blank', rel: 'noopener') %>
+    <% end %>
+  </p>
+<% end %>
+
+<% if @project.metadata.due_date.present? %>
+  <p><strong>Due:</strong> <%= @project.metadata.due_date %></p>
+<% end %>
+
+<% if @statuses.present? %>
+  <table>
+    <thead>
+      <tr>
+        <% @statuses.each do |status| %>
+          <th><%= status %></th>
+        <% end %>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <% @statuses.each do |status| %>
+          <td>
+            <% items = @items_by_status[status] || [] %>
+            <% items.each do |item| %>
+              <%= render({
+                partial: 'plan_my_stuff/testing_projects/partials/item',
+                locals: { item: item, project: @project, statuses: @statuses },
+              }) %>
+            <% end %>
+            <% if items.empty? %>
+              <em>No items</em>
+            <% end %>
+          </td>
+        <% end %>
+      </tr>
+    </tbody>
+  </table>
+<% else %>
+  <p>No statuses configured for this project.</p>
+<% end %>
+
+<h2>Add Item</h2>
+
+<p><%= link_to('Add item with details', plan_my_stuff.new_testing_project_item_path(@project.number)) %></p>
+
+<%= form_with(url: plan_my_stuff.testing_project_items_path(@project.number), method: :post, local: true) do |form| %>
+  <%= form.label(:title, 'Title') %>
+  <%= form.text_field(:title, required: true) %>
+  <%= form.label(:body, 'Body') %>
+  <%= form.text_area(:body) %>
+  <%= form.submit('Add Item') %>
+<% end %>

data/config/routes.rb

@@ -1,24 +1,52 @@
 # frozen_string_literal: true
 
 PlanMyStuff::Engine.routes.draw do
-  resources :issues, except: %i[destroy] do
-    member do
-      patch :close
-      patch :reopen
-      post :add_viewers
-      delete :remove_viewer
+  config = PlanMyStuff.configuration
+  mount_groups = config.mount_groups
+
+  if mount_groups.fetch(:issues, true)
+    resources :issues, except: %i[destroy], controller: config.controller_for(:issues) do
+      resource :closure, only: %i[create destroy], controller: config.controller_for(:'issues/closures')
+      resource :waiting, only: %i[create destroy], controller: config.controller_for(:'issues/waitings')
+      resources :viewers, only: %i[create destroy], controller: config.controller_for(:'issues/viewers')
+      if config.pipeline_enabled
+        resource(
+          :take,
+          only: %i[create destroy],
+          controller: config.controller_for(:'issues/takes'),
+        )
+        resource(
+          :testing,
+          only: %i[create destroy],
+          controller: config.controller_for(:'issues/testings'),
+        )
+      end
+      resources :comments, only: %i[create edit update], controller: config.controller_for(:comments)
+      resources :labels, only: %i[create destroy], controller: config.controller_for(:labels)
+      resources :links, only: %i[create destroy], controller: config.controller_for(:'issues/links')
+      resources :approvals, only: %i[create update destroy], controller: config.controller_for(:'issues/approvals')
+    end
+  end
+
+  if mount_groups.fetch(:webhooks, true) && config.pipeline_enabled
+    namespace :webhooks do
+      resource :github, only: %i[create], controller: config.controller_for(:'webhooks/github')
+      resource :aws, only: %i[create], controller: config.controller_for(:'webhooks/aws')
     end
-    resources :comments, only: %i[create edit update]
-    post 'labels', to: 'labels#add_to_issue', as: :add_label
-    delete 'labels/:name', to: 'labels#remove_from_issue', as: :remove_label
   end
 
-  resources :projects, only: %i[index show] do
-    resources :items, only: %i[create], controller: 'project_items' do
-      member do
-        patch :move
-        patch :assign
-        patch :unassign
+  if mount_groups.fetch(:projects, true)
+    resources :projects, except: %i[destroy], controller: config.controller_for(:projects) do
+      resources :items, only: %i[create destroy], controller: config.controller_for(:project_items) do
+        resource :status, only: %i[update], controller: config.controller_for(:'project_items/statuses')
+        resource :assignment, only: %i[update destroy], controller: config.controller_for(:'project_items/assignments')
+      end
+    end
+
+    resources :testing_projects, except: %i[destroy index], controller: config.controller_for(:testing_projects) do
+      resources :items, only: %i[new create], controller: config.controller_for(:testing_project_items) do
+        resource :status, only: %i[update], controller: config.controller_for(:'project_items/statuses')
+        resource :result, only: %i[new create], controller: config.controller_for(:'testing_project_items/results')
       end
     end
   end

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

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-PMS.configure do |config|
+PlanMyStuff.configure do |config|
   # --------------------------------------------------------------------------
   # Authentication (required)
   # --------------------------------------------------------------------------
   # GitHub PAT with `repo` and `project` scopes. All API calls use this token.
   config.access_token = Rails.application.credentials.dig(:plan_my_stuff, :github_token)
 
+  # Classic PAT (requires `repo` scope) for the Issues Import API (golden-comet-preview).
+  # Fine-grained tokens are not supported by that endpoint.
+  # config.import_access_token = Rails.application.credentials.dig(:plan_my_stuff, :github_import_token)
+
   # --------------------------------------------------------------------------
   # Organization (required)
   # --------------------------------------------------------------------------
@@ -20,12 +24,34 @@ PMS.configure do |config|
   # config.repos[:underwriter] = 'YourOrganization/Underwriter'
   # config.default_repo = :element
 
+  # Human-readable prefix used as the `Issue#to_param` so URLs read
+  # `/issues/Element-1234` instead of `/issues/1234`. Missing keys fall back
+  # to `key.to_s.titleize`; only repos whose key doesn't titleize cleanly
+  # need an entry.
+  # config.repo_nicknames = { safety: 'Compliance' }
+
+  # --------------------------------------------------------------------------
+  # Attachments
+  # --------------------------------------------------------------------------
+  # Bare repo name (under `organization`) that stores uploaded attachment
+  # binaries. The repo must already exist; the uploader does not create it.
+  # Attachments commit onto `config.main_branch` under
+  # `<repo_key_or_name>/issue-<number>/<uuid>.<ext>`.
+  # config.attachment_repo = 'pms-attachments'
+
   # --------------------------------------------------------------------------
   # Projects
   # --------------------------------------------------------------------------
   # Default GitHub Projects V2 number for add_to_project calls.
   # config.default_project_number = 14
 
+  # Template project to clone when creating new Testing Projects.
+  # When set, TestingProject.create! copies this project (preserving its
+  # custom fields and board layout) instead of bootstrapping fields from scratch.
+  # The template should be a pre-configured testing project with the correct
+  # fields and board view already set up in the GitHub UI.
+  # config.testing_template_project_number = 42
+
   # --------------------------------------------------------------------------
   # App identity
   # --------------------------------------------------------------------------
@@ -49,6 +75,14 @@ PMS.configure do |config|
   # config.support_method = :support?
   # config.support_method = ->(user) { user.role.in?(%w[support admin]) }
 
+  # Map of app user id (whatever `user_id_method` returns) to GitHub login.
+  # Used by the "Take" UI flow to assign the GitHub user when a support
+  # user claims an issue.
+  # config.github_login_for = {
+  #   1 => 'some_username',
+  #   2 => 'octocat',
+  # }
+
   # --------------------------------------------------------------------------
   # Engine authentication
   # --------------------------------------------------------------------------
@@ -65,31 +99,45 @@ PMS.configure do |config|
   # :commonmarker (default) or :redcarpet -- the chosen gem must be in your Gemfile.
   # config.markdown_renderer = :commonmarker
 
+  # Default options passed to the markdown renderer. Per-call options merge on top.
+  # For :commonmarker -- passed as `options:` to `Commonmarker.to_html`:
+  #   config.markdown_options = { render: { hardbreaks: true } }
+  # For :redcarpet -- :render_options and :renderer are extracted for the HTML
+  #   renderer; remaining keys are extensions passed to `Redcarpet::Markdown.new`:
+  #   config.markdown_options = {
+  #     render_options: { hard_wrap: true, no_styles: true },
+  #     autolink: true,
+  #   }
+
   # --------------------------------------------------------------------------
   # URL prefix
   # --------------------------------------------------------------------------
-  # Prefix for building user-facing ticket URLs in your app.
-  # config.issues_url_prefix = 'https://myapp.example.com/tickets/'
+  # Prefix for building user-facing ticket URLs in your app. The issue
+  # number is appended to form `Issue#user_link`, which the gem also
+  # writes as the visible body of the GitHub issue.
+  # Recommended default:
+  #   url_options = Rails.application.routes.default_url_options
+  #   config.issues_url_prefix =
+  #     "#{url_options[:protocol] || 'http'}://#{url_options[:host]}/issues"
 
   # --------------------------------------------------------------------------
-  # Request gateway
+  # Notification actor
   # --------------------------------------------------------------------------
-  # Proc returning boolean, or nil (always send). When it returns false the
-  # request is deferred to a background job instead of hitting GitHub.
-  # config.should_send_request = -> { !MaintenanceMode.active? }
-
-  # Map of action type to job class name for deferred requests.
-  # config.job_classes = {
-  #   create_ticket:  'PmsCreateTicketJob',
-  #   post_comment:   'PmsPostCommentJob',
-  #   update_status:  'PmsUpdateStatusJob'
-  # }
+  # Fallback actor for notification events (*.plan_my_stuff) when a caller
+  # does not pass an explicit user: kwarg. Proc/lambda called at event time.
+  # config.current_user = -> { Current.user }
 
-  # Custom notifier for deferred requests (proc/class), or nil to use
-  # the built-in DeferredMailer.
-  # config.deferred_notifier = nil
-  # config.deferred_email_from = 'noreply@example.com'
-  # config.deferred_email_to = 'it-support@example.com'
+  # --------------------------------------------------------------------------
+  # Controller rescue hook
+  # --------------------------------------------------------------------------
+  # Invoked from every gem controller rescue block, after the gem logs the
+  # error class/message and stack trace via Rails.logger.error and just
+  # before the user-facing flash + redirect/render. Forwards the rescued
+  # exception so consuming apps can fire monitoring even though the rescue
+  # swallows the error. Receives the rescued exception; return value is
+  # ignored. Defaults to nil (no-op).
+  #
+  # config.controller_rescue = ->(error) { MonitoringService.notice_error(error) }
 
   # --------------------------------------------------------------------------
   # Custom fields
@@ -100,7 +148,241 @@ PMS.configure do |config|
   # Supported types: :string, :integer, :boolean, :array, :hash
   # required: true means the key must be present (value can be nil, [], etc.)
   #
+  # Shared fields (available on both issues and comments):
   config.custom_fields = {
-    notification_recipients: { type: :array, required: true },
+    # notification_recipients: { type: :array, required: true },
   }
+
+  # Issue-only fields (merged on top of shared, context wins on conflicts):
+  # config.issue_custom_fields = {
+  #   ticket_type: { type: :string, required: true },
+  # }
+
+  # Comment-only fields (merged on top of shared, context wins on conflicts):
+  # config.comment_custom_fields = {}
+
+  # Project-only fields (merged on top of shared, context wins on conflicts):
+  # config.project_custom_fields = {}
+
+  # Testing-project-only fields (merged on top of shared, context wins on conflicts):
+  # config.testing_custom_fields = {}
+
+  # --------------------------------------------------------------------------
+  # Issue types (org-side renames)
+  # --------------------------------------------------------------------------
+  # The gem speaks in canonical type names: 'Bug', 'Feature',
+  # 'IT Issue / Hardware', 'Other', 'Performance', 'Question', 'Task'.
+  # Symbol shortcuts (`:bug`, `:feature`, `:it_issue`, `:other`, `:performance`,
+  # `:question`, `:task`) resolve to those canonical names automatically.
+  # If your GitHub org uses different names for any of them, map the
+  # canonical name to your org's name here and PMS will translate on
+  # write. Missing keys pass through unchanged.
+  #
+  # config.issue_types = {
+  #   'Bug' => 'User Bug',
+  #   'Feature' => 'Enhancement',
+  # }
+
+  # --------------------------------------------------------------------------
+  # Issue Fields (public preview)
+  # --------------------------------------------------------------------------
+  # GitHub Issue Fields is a per-org public preview. Default is true (opt-out).
+  # Flip to false if your org has not been admitted to the preview - read paths
+  # return an empty set and write paths raise IssueFieldsNotEnabledError instead
+  # of letting a raw GraphQL error bubble.
+  #
+  # config.issue_fields_enabled = false
+
+  # Rename the native Issue Fields the gem refers to internally to whatever your
+  # org actually calls them. Keys are the gem's canonical names; values are your
+  # org's field names. Applied on reads, writes, and filters; unmapped names pass
+  # through unchanged.
+  # config.issue_field_names = {
+  #   'Issue Status' => 'Status',
+  #   'Priority'     => 'Prio',
+  # }
+
+  # Rename single-select option labels, nested by canonical field name. Keys are
+  # the gem's canonical values; values are your org's option labels. Unmapped
+  # fields / values pass through unchanged.
+  # config.issue_field_values = {
+  #   'Issue Status' => {
+  #     'Submitted'        => 'Triaged',
+  #     'Waiting on Reply' => 'Awaiting Customer',
+  #     'Open'             => 'Open',
+  #     'Reopened'         => 'Reopened',
+  #   },
+  # }
+
+  # --------------------------------------------------------------------------
+  # Boot behavior
+  # --------------------------------------------------------------------------
+  # Eager-load the engine's controllers in after_initialize so that
+  # `defined?(PlanMyStuff::SomeController)` resolves without first referencing
+  # the constant. Opt in if the host app probes engine controllers via
+  # `defined?` in dev mode.
+  #
+  # config.eager_load_controllers_on_boot = true
+
+  # --------------------------------------------------------------------------
+  # Release pipeline
+  # --------------------------------------------------------------------------
+  # config.pipeline_enabled = true
+  # config.pipeline_project_number = 14
+
+  # GitHub webhook HMAC-SHA256 secret (required when webhook routes are mounted).
+  # config.webhook_secret = Rails.application.credentials.dig(:plan_my_stuff, :webhook_secret)
+
+  # Configurable display aliases for pipeline statuses.
+  # config.pipeline_statuses = {
+  #   'Submitted' => 'Triaged',
+  #   'Completed' => 'Done',
+  # }
+
+  # Display name for the Testing single-select field on the pipeline project.
+  # config.pipeline_testing_field_name = 'Testing'
+
+  # Display labels for the canonical Testing field option keys.
+  # config.pipeline_testing_values = {
+  #   active: 'Testing',
+  #   inactive: 'Not testing',
+  # }
+
+  # Whether the pipeline sweep removes aged-out Completed items.
+  # config.pipeline_completion_purge_enabled = true
+
+  # Hours after a project item's last update at which the sweep removes it
+  # from the pipeline if its status is Completed.
+  # config.pipeline_completion_ttl_hours = 24
+
+  # config.main_branch = 'main'
+  # config.production_branch = 'production'
+
+  # --------------------------------------------------------------------------
+  # Follow-up reminders
+  # --------------------------------------------------------------------------
+  # Daily sweep that fires `issue_reminder_due.plan_my_stuff` events on
+  # waiting issues and auto-closes issues that exceed the inactivity
+  # ceiling. Consuming app is responsible for the initial enqueue:
+  #
+  #   # Enqueue one sweep job per configured repo:
+  #   rake plan_my_stuff:reminders:sweep
+  #
+  #   # Or a single repo:
+  #   rake plan_my_stuff:reminders:sweep REPO=element
+  #
+  # Each job self-requeues after perform (default: 6:30am ET next day);
+  # running the rake task once on app boot is enough. Override
+  # `RemindersSweepJob.next_run` on a subclass to change the cadence.
+  #
+  # config.reminders_enabled = true
+  #
+  # Days-since-waiting at which reminders fire. Per-issue override via
+  # `issue.metadata.reminder_days = [...]`.
+  # config.reminder_days = [1, 3, 7, 10, 14, 18]
+  #
+  # Days of continuous waiting before the sweep auto-closes the issue
+  # (emits `issue.closed_inactive` instead of the regular `issue.closed`).
+  # config.inactivity_close_days = 30
+  #
+  # Label names the gem creates and manages on waiting/inactive issues.
+  # config.waiting_on_user_label = 'waiting-on-user'
+  # config.waiting_on_approval_label = 'waiting-on-approval'
+  # config.user_inactive_label = 'user-inactive'
+
+  # --------------------------------------------------------------------------
+  # Auto-archiving of aged-closed issues
+  # --------------------------------------------------------------------------
+  # Piggybacks the RemindersSweepJob. For every issue closed more than
+  # `archive_closed_after_days` ago (based on GitHub's `closed_at`) the
+  # sweep: adds the configured label, locks the conversation, removes
+  # the issue from every Projects V2 board, stamps `metadata.archived_at`,
+  # and emits `issue_archived.plan_my_stuff` with `reason: :aged_closed`.
+  # Issues auto-closed by the inactivity sweep (closed_by_inactivity) are
+  # excluded. Non-PMS issues are excluded.
+  #
+  # config.archiving_enabled = true
+  # config.archive_closed_after_days = 90
+  # config.archived_label = 'archived'
+
+  # --------------------------------------------------------------------------
+  # AWS webhook (ECS deployments via SNS)
+  # --------------------------------------------------------------------------
+  # Expected SNS topic ARN for webhook validation.
+  # config.sns_topic_arn = 'arn:aws:sns:us-east-1:123456:ecs-deploy-topic'
+
+  # ECS service identifier - suffix matched against resource ARNs in events.
+  # config.aws_service_identifier = 'myapp-production-web'
+
+  # Commit hash of the currently deploying build. Prefix-matched against
+  # issue metadata commit_sha on SERVICE_DEPLOYMENT_COMPLETED events.
+  # config.production_commit_sha = Rails.configuration.x.image_tag
+
+  # Toggle for processing AWS webhook events (default: Rails.env.production?).
+  # config.process_aws_webhooks = Rails.env.production?
+
+  # SNS signature verifier (default: Aws::SNS::MessageVerifier). Must respond
+  # to authenticate!(raw_body). Provide aws-sdk-sns in your Gemfile.
+  # config.sns_verifier_class = Aws::SNS::MessageVerifier
+  # config.sns_verifier_error = Aws::SNS::MessageVerifier::VerificationError
+
+  # --------------------------------------------------------------------------
+  # Caching
+  # --------------------------------------------------------------------------
+  # ETag-based HTTP caching of GitHub reads via Rails.cache. Defaults to true.
+  # config.cache_enabled = true
+
+  # Opaque version string baked into every PMS cache key. Bump it to invalidate
+  # all cached entries from the consuming app's side (e.g. after a deploy).
+  # config.cache_version = Rails.configuration.x.image_tag
+
+  # --------------------------------------------------------------------------
+  # Route mounting
+  # --------------------------------------------------------------------------
+  # Per-group toggles for which engine route groups to mount.
+  # config.mount_groups = { webhooks: true, issues: true, projects: true }
+
+  # --------------------------------------------------------------------------
+  # Controller overrides (Devise-style)
+  # --------------------------------------------------------------------------
+  # Swap in your own controller for any mounted route group. Typical use is
+  # to subclass the gem controller and slot the subclass in here:
+  #
+  #   # app/controllers/issues_controller.rb
+  #   class IssuesController < PlanMyStuff::IssuesController
+  #     before_action :require_admin
+  #   end
+  #
+  #   # config/initializers/plan_my_stuff.rb
+  #   config.controllers = { issues: 'issues' }
+  #
+  # Unset keys fall back to the gem default.
+  #
+  # Controllable keys (with gem defaults):
+  #   :issues                           => 'plan_my_stuff/issues'
+  #   :comments                         => 'plan_my_stuff/comments'
+  #   :labels                           => 'plan_my_stuff/labels'
+  #   :projects                         => 'plan_my_stuff/projects'
+  #   :project_items                    => 'plan_my_stuff/project_items'
+  #   :testing_projects                 => 'plan_my_stuff/testing_projects'
+  #   :testing_project_items            => 'plan_my_stuff/testing_project_items'
+  #   :'issues/closures'                => 'plan_my_stuff/issues/closures'
+  #   :'issues/viewers'                 => 'plan_my_stuff/issues/viewers'
+  #   :'issues/takes'                   => 'plan_my_stuff/issues/takes'
+  #   :'issues/testings'                => 'plan_my_stuff/issues/testings'
+  #   :'issues/waitings'                => 'plan_my_stuff/issues/waitings'
+  #   :'issues/links'                   => 'plan_my_stuff/issues/links'
+  #   :'issues/approvals'               => 'plan_my_stuff/issues/approvals'
+  #   :'project_items/statuses'         => 'plan_my_stuff/project_items/statuses'
+  #   :'project_items/assignments'      => 'plan_my_stuff/project_items/assignments'
+  #   :'testing_project_items/results'  => 'plan_my_stuff/testing_project_items/results'
+  #   :'webhooks/github'                => 'plan_my_stuff/webhooks/github'
+  #   :'webhooks/aws'                   => 'plan_my_stuff/webhooks/aws'
+
+  # --------------------------------------------------------------------------
+  # Parent controller
+  # --------------------------------------------------------------------------
+  # Parent class for PlanMyStuff::ApplicationController. Override when the
+  # consuming app does not use the `ApplicationController` name.
+  # config.parent_controller = 'MyOtherApplicationController'
 end