plan_my_stuff 0.1.0

data/app/controllers/plan_my_stuff/project_items_controller.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module PlanMyStuff
+  class ProjectItemsController < ApplicationController
+    # POST /projects/:project_id/items
+    def create
+      project_number = params[:project_id].to_i
+
+      if params[:draft] == '1'
+        PMS::ProjectItem.create!(params[:title], draft: true, body: params[:body], project_number: project_number)
+        flash[:success] = 'Draft item created.'
+      else
+        issue = PMS::Issue.find(params[:issue_number].to_i)
+        PMS::ProjectItem.create!(issue, project_number: project_number)
+        flash[:success] = "Issue ##{issue.number} added to project."
+      end
+
+      redirect_to(plan_my_stuff.project_path(project_number))
+    rescue ArgumentError, PMS::Error, Octokit::Error => e
+      flash[:error] = e.message
+      redirect_to(plan_my_stuff.project_path(project_number))
+    end
+
+    # PATCH /projects/:project_id/items/:id/move
+    def move
+      item = find_project_item
+
+      item.move_to!(params[:status])
+
+      flash[:success] = "Item moved to #{params[:status]}."
+      redirect_to(plan_my_stuff.project_path(params[:project_id]))
+    rescue ArgumentError, PMS::Error => e
+      flash[:error] = e.message
+      redirect_to(plan_my_stuff.project_path(params[:project_id]))
+    end
+
+    # PATCH /projects/:project_id/items/:id/assign
+    def assign
+      item = find_project_item
+      assignees = parse_assignees(params[:assignee])
+
+      item.assign!(assignees)
+
+      flash[:success] = "Item assigned to #{assignees.join(', ')}."
+      redirect_to(plan_my_stuff.project_path(params[:project_id]))
+    rescue ArgumentError, PMS::Error => e
+      flash[:error] = e.message
+      redirect_to(plan_my_stuff.project_path(params[:project_id]))
+    end
+
+    # PATCH /projects/:project_id/items/:id/unassign
+    def unassign
+      item = find_project_item
+      current_assignees = item.field_values['Assignees'] || []
+      remaining = current_assignees - [params[:username]]
+
+      item.assign!(remaining)
+
+      flash[:success] = "#{params[:username]} unassigned."
+      redirect_to(plan_my_stuff.project_path(params[:project_id]))
+    rescue ArgumentError, PMS::Error => e
+      flash[:error] = e.message
+      redirect_to(plan_my_stuff.project_path(params[:project_id]))
+    end
+
+    private
+
+      # Finds the project and the item within it.
+      #
+      # @return [PlanMyStuff::ProjectItem]
+      #
+      def find_project_item
+        project = PMS::Project.find(params[:project_id].to_i)
+        item = project.items.find { |i| i.id == params[:id] }
+
+        raise(PMS::APIError, "Item not found: #{params[:id]}") unless item
+
+        item
+      end
+
+      # Splits a comma-separated assignees string into an array.
+      #
+      # @param assignees_string [String, nil]
+      #
+      # @return [Array<String>]
+      #
+      def parse_assignees(assignees_string)
+        return [] if assignees_string.blank?
+
+        assignees_string.split(',').filter_map { |a| a.strip.presence }
+      end
+  end
+end

data/app/controllers/plan_my_stuff/projects_controller.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PlanMyStuff
+  class ProjectsController < ApplicationController
+    # GET /projects
+    def index
+      @projects = PMS::Project.list.reject(&:closed)
+    end
+
+    # GET /projects/:id
+    def show
+      @project = PMS::Project.find(params[:id].to_i)
+      @statuses = @project.statuses.pluck(:name)
+      @items_by_status = @project.items.group_by(&:status)
+    end
+  end
+end

data/app/views/plan_my_stuff/comments/edit.html.erb

@@ -0,0 +1,16 @@
+<h1>Edit Comment</h1>
+
+<% if flash[:error].present? %>
+  <p style="color: red;"><%= flash[:error] %></p>
+<% end %>
+
+<%=
+  render({
+    partial: 'plan_my_stuff/comments/partials/form',
+    locals: {
+      issue: @issue,
+      comment: @comment,
+      support_user: @support_user,
+    },
+  })
+%>

data/app/views/plan_my_stuff/comments/partials/_form.html.erb

@@ -0,0 +1,32 @@
+<%
+  persisted = comment.persisted?
+  url =
+    if persisted
+      plan_my_stuff.issue_comment_path(issue.number, comment.id)
+    else
+      plan_my_stuff.issue_comments_path(issue.number)
+    end
+%>
+<%= form_with(url: url, method: persisted ? :patch : :post, scope: :comment) do |form| %>
+  <div>
+    <%= form.label(:body, persisted ? 'Edit comment' : 'Add a comment') %>
+    <%= form.text_area(:body, rows: 4, value: persisted ? comment.body_without_header : nil) %>
+  </div>
+
+  <% if support_user %>
+    <div>
+      <%= form.label(:visibility, 'Visibility') %>
+      <%=
+        form.select(
+          :visibility,
+          [%w[Public public], %w[Internal internal]],
+          selected: comment.visibility&.to_s || 'public',
+        )
+      %>
+    </div>
+  <% end %>
+
+  <div>
+    <%= form.submit(persisted ? 'Update Comment' : 'Post Comment') %>
+  </div>
+<% end %>

data/app/views/plan_my_stuff/issues/edit.html.erb

@@ -0,0 +1,12 @@
+<h1>Edit Issue #<%= @issue.number %></h1>
+
+<% if flash[:error].present? %>
+  <p style="color: red;"><%= flash[:error] %></p>
+<% end %>
+
+<%= render({ partial: 'plan_my_stuff/issues/partials/form', locals: { issue: @issue, support_user: @support_user } }) %>
+
+<% if @support_user %>
+  <hr>
+  <%= render({ partial: 'plan_my_stuff/issues/partials/viewers', locals: { issue: @issue } }) %>
+<% end %>

data/app/views/plan_my_stuff/issues/index.html.erb

@@ -0,0 +1,37 @@
+<h1>Issues</h1>
+
+<% if @issues.any? %>
+  <table>
+    <thead>
+      <tr>
+        <th>#</th>
+        <th>Title</th>
+        <th>State</th>
+        <th>Labels</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @issues.each do |issue| %>
+        <tr>
+          <td><%= issue.number %></td>
+          <td><%= link_to(issue.title, plan_my_stuff.issue_path(issue.number)) %></td>
+          <td><%= issue.state %></td>
+          <td><%= issue.labels.join(', ') %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+  <nav>
+    <% if @page > 1 %>
+      <%= link_to('Previous', plan_my_stuff.issues_path(page: @page - 1, state: @state, labels: @labels)) %>
+    <% end %>
+    <% if @issues.size == @per_page %>
+      <%= link_to('Next', plan_my_stuff.issues_path(page: @page + 1, state: @state, labels: @labels)) %>
+    <% end %>
+  </nav>
+<% else %>
+  <p>No issues found.</p>
+<% end %>
+<br>
+<%= link_to "New Issue", plan_my_stuff.new_issue_path %>

data/app/views/plan_my_stuff/issues/new.html.erb

@@ -0,0 +1,7 @@
+<h1>New Issue</h1>
+
+<% if flash[:error].present? %>
+  <p style="color: red;"><%= flash[:error] %></p>
+<% end %>
+
+<%= render({ partial: 'plan_my_stuff/issues/partials/form', locals: { issue: @issue, support_user: @support_user } }) %>

data/app/views/plan_my_stuff/issues/partials/_form.html.erb

@@ -0,0 +1,41 @@
+<% persisted = issue.persisted? %>
+<%= form_with(
+  url: persisted ? plan_my_stuff.issue_path(issue.number) : plan_my_stuff.issues_path,
+  method: persisted ? :patch : :post,
+  scope: :issue,
+) do |form| %>
+  <div>
+    <%= form.label(:title, 'Title') %>
+    <%= form.text_field(:title, value: issue.title) %>
+  </div>
+
+  <div>
+    <%= form.label(:body, 'Description') %>
+    <%= form.text_area(:body, rows: 8, value: issue.body) %>
+  </div>
+
+  <div>
+    <%= form.label(:labels, 'Labels (comma-separated)') %>
+    <%= form.text_field(:labels, value: Array.wrap(issue.labels).join(', ')) %>
+  </div>
+
+  <%# Advanced fields - uncomment to enable in your consuming app. %>
+    <%# <div> %>
+      <%#= form.label(:repo, 'Repository') %>
+      <%#= form.select(:repo, PlanMyStuff.configuration.repos.keys.map { |k| [k.to_s.titleize, k] }) %>
+    <%# </div> %>
+
+    <%# <div> %>
+      <%#= form.check_box(:add_to_project) %>
+      <%#= form.label(:add_to_project, 'Add to project') %>
+    <%# </div> %>
+
+    <%# <div> %>
+      <%#= form.label(:visibility_allowlist, 'Visibility allowlist (comma-separated user IDs)') %>
+      <%#= form.text_field(:visibility_allowlist) %>
+    <%# </div> %>
+
+  <div>
+    <%= form.submit(persisted ? 'Update Issue' : 'Create Issue') %>
+  </div>
+<% end %>

data/app/views/plan_my_stuff/issues/partials/_labels.html.erb

@@ -0,0 +1,23 @@
+<% if issue.labels.any? %>
+  <% issue.labels.each do |label| %>
+    <span>
+      <%= label %>
+      <%=
+        button_to(
+          'x',
+          plan_my_stuff.issue_remove_label_path(issue.number, label),
+          method: :delete,
+          form: { style: 'display:inline' }
+        )
+      %>
+      </span>
+  <% end %>
+<% else %>
+  <em>No labels</em>
+<% end %>
+
+<%= form_with(url: plan_my_stuff.issue_add_label_path(issue.number), method: :post, local: true) do |form| %>
+  <%= form.label(:label_name, 'Add label') %>
+  <%= form.text_field(:label_name) %>
+  <%= form.submit('Add') %>
+<% end %>

data/app/views/plan_my_stuff/issues/partials/_viewers.html.erb

@@ -0,0 +1,32 @@
+<h2>Manage Viewers</h2>
+
+<% viewers = issue.metadata.visibility_allowlist %>
+<% if viewers.any? %>
+  <ul>
+    <% viewers.each do |viewer_id| %>
+      <li>
+        User #<%= viewer_id %>
+        <%=
+          button_to(
+            'Remove',
+            plan_my_stuff.remove_viewer_issue_path(issue.number, viewer_id: viewer_id),
+            method: :delete
+          )
+        %>
+      </li>
+    <% end %>
+  </ul>
+<% else %>
+  <p>No viewers added.</p>
+<% end %>
+
+<%= form_with(url: plan_my_stuff.add_viewers_issue_path(issue.number), method: :post) do |form| %>
+  <div>
+    <%= form.label(:viewer_ids, 'Add viewer IDs (comma-separated)') %>
+    <%= form.text_field(:viewer_ids) %>
+  </div>
+
+  <div>
+    <%= form.submit('Add Viewers') %>
+  </div>
+<% end %>

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

@@ -0,0 +1,58 @@
+<h1><%= @issue.title %> <small>#<%= @issue.number %></small></h1>
+
+<p>
+  <%= link_to('Edit', plan_my_stuff.edit_issue_path(@issue.number)) %>
+  <% if @issue.state == 'open' %>
+    <%= button_to('Close Issue', plan_my_stuff.close_issue_path(@issue.number), method: :patch) %>
+  <% else %>
+    <%= button_to('Reopen Issue', plan_my_stuff.reopen_issue_path(@issue.number), method: :patch) %>
+  <% end %>
+</p>
+
+<p><strong>State:</strong> <%= @issue.state %></p>
+
+<div>
+  <strong>Labels:</strong>
+  <%=
+    render({
+      partial: 'plan_my_stuff/issues/partials/labels',
+      locals: { issue: @issue },
+    })
+  %>
+</div>
+
+<div>
+  <%= PlanMyStuff::Markdown.render(@issue.body || '').html_safe %>
+</div>
+
+<hr>
+
+<h2>Comments (<%= @comments.size %>)</h2>
+
+<% if @comments.any? %>
+  <% @comments.each do |comment| %>
+    <div>
+      <%= PlanMyStuff::Markdown.render(comment.body || '').html_safe %>
+      <% if comment.pms_comment? && (@support_user || comment.metadata.created_by == @current_user_id) %>
+        <p>
+          <%= link_to('Edit', plan_my_stuff.edit_issue_comment_path(@issue.number, comment.id)) %>
+        </p>
+      <% end %>
+    </div>
+  <% end %>
+<% else %>
+  <p>No comments yet.</p>
+<% end %>
+
+<hr>
+
+<%=
+  render({
+    partial: 'plan_my_stuff/comments/partials/form',
+    locals: {
+      issue: @issue,
+      comment: PlanMyStuff::Comment.new,
+      support_user: @support_user,
+    },
+  })
+%>

data/app/views/plan_my_stuff/projects/index.html.erb

@@ -0,0 +1,13 @@
+<h1>Projects</h1>
+
+<% if @projects.any? %>
+  <ul>
+    <% @projects.each do |project| %>
+      <li>
+        <%= link_to(project.title, plan_my_stuff.project_path(project.number)) %>
+      </li>
+    <% end %>
+  </ul>
+<% else %>
+  <p>No projects found.</p>
+<% end %>

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

@@ -0,0 +1,101 @@
+<h1><%= @project.title %></h1>
+
+<% if @statuses.any? %>
+  <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| %>
+              <div style="border: 1px solid black; margin: 1em">
+                <% if item.number.present? %>
+                  <strong><%= link_to(item.title, plan_my_stuff.issue_path(item.number)) %></strong>
+                <% else %>
+                  <strong><%= item.title %></strong>
+                <% end %>
+                <% if item.number.present? %>
+                  <small>#<%= item.number %></small>
+                <% end %>
+
+                <%=
+                  form_with(
+                    url: plan_my_stuff.move_project_item_path(@project.number, item.id),
+                    method: :patch,
+                    local: true,
+                  ) do |form|
+                %>
+                  <%= form.select(:status, @statuses, { selected: status }, { onchange: 'this.form.requestSubmit();' }) %>
+                <% end %>
+
+                <% assignees = item.field_values['Assignees'] || [] %>
+                <% if assignees.any? %>
+                  <div>
+                    <% assignees.each do |username| %>
+                      <span>
+                        <%= username %>
+                        <%=
+                          form_with(
+                            url: plan_my_stuff.unassign_project_item_path(@project.number, item.id),
+                            method: :patch,
+                            local: true,
+                            style: 'display: inline',
+                          ) do |form|
+                        %>
+                          <%= form.hidden_field(:username, value: username) %>
+                          <%= form.submit('×', title: "Unassign #{username}") %>
+                        <% end %>
+                      </span>
+                    <% end %>
+                  </div>
+                <% end %>
+
+                <%=
+                  form_with(
+                    url: plan_my_stuff.assign_project_item_path(@project.number, item.id),
+                    method: :patch,
+                    local: true,
+                  ) do |form|
+                %>
+                  <%= form.text_field(:assignee, placeholder: 'GitHub username') %>
+                  <%= form.submit('Assign') %>
+                <% end %>
+              </div>
+            <% 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>
+
+<h3>Add Existing Issue</h3>
+<%= form_with(url: plan_my_stuff.project_items_path(@project.number), method: :post, local: true) do |form| %>
+  <%= form.label(:issue_number, 'Issue number') %>
+  <%= form.number_field(:issue_number, min: 1, required: true) %>
+  <%= form.submit('Add Issue') %>
+<% end %>
+
+<h3>Create Draft Item</h3>
+<%= form_with(url: plan_my_stuff.project_items_path(@project.number), method: :post, local: true) do |form| %>
+  <%= form.hidden_field(:draft, value: '1') %>
+  <%= form.label(:title, 'Title') %>
+  <%= form.text_field(:title, required: true) %>
+  <%= form.label(:body, 'Body') %>
+  <%= form.text_area(:body) %>
+  <%= form.submit('Create Draft') %>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,25 @@
+# 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
+    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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module PlanMyStuff
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      # @return [void]
+      def copy_initializer
+        template('initializer.rb', 'config/initializers/plan_my_stuff.rb')
+      end
+
+      # @return [void]
+      def add_route
+        mount_line = "  mount PlanMyStuff::Engine, at: '/tickets'\n"
+        route_file = 'config/routes.rb'
+
+        if File.exist?(route_file) && File.read(route_file).include?('PlanMyStuff::Engine')
+          say('Route already mounted, skipping.', :yellow)
+          return
+        end
+
+        inject_into_file(route_file, mount_line, after: "Rails.application.routes.draw do\n")
+      end
+
+      # @return [void]
+      def show_next_steps
+        say('')
+        say('PlanMyStuff installed.', :green)
+        say('')
+        say('Next steps:', :yellow)
+        say('  1. Add your GitHub PAT to credentials: rails credentials:edit')
+        say('  2. Run `rails g plan_my_stuff:views` to copy view templates (optional)')
+        say('')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+PMS.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)
+
+  # --------------------------------------------------------------------------
+  # Organization (required)
+  # --------------------------------------------------------------------------
+  config.organization = 'YourOrganization'
+
+  # --------------------------------------------------------------------------
+  # Repositories
+  # --------------------------------------------------------------------------
+  # Register named repos for shorthand access throughout the gem.
+  # config.repos[:element] = 'YourOrganization/Element'
+  # config.repos[:underwriter] = 'YourOrganization/Underwriter'
+  # config.default_repo = :element
+
+  # --------------------------------------------------------------------------
+  # Projects
+  # --------------------------------------------------------------------------
+  # Default GitHub Projects V2 number for add_to_project calls.
+  # config.default_project_number = 14
+
+  # --------------------------------------------------------------------------
+  # App identity
+  # --------------------------------------------------------------------------
+  # Name of this application, stored in issue/comment metadata.
+  # config.app_name = 'MyApp'
+
+  # --------------------------------------------------------------------------
+  # User integration
+  # --------------------------------------------------------------------------
+  # Your app's user model class name (constantized for lookups).
+  # config.user_class = 'User'
+
+  # Method called on user object to get display name for comment headers.
+  # config.display_name_method = :full_name
+
+  # Method called on user object to extract the app-side user ID.
+  # config.user_id_method = :id
+
+  # Determines if a user is support staff. Symbol (method name called on user)
+  # or Proc that receives the user object and returns a boolean.
+  # config.support_method = :support?
+  # config.support_method = ->(user) { user.role.in?(%w[support admin]) }
+
+  # --------------------------------------------------------------------------
+  # Engine authentication
+  # --------------------------------------------------------------------------
+  # Block executed as a before_action on all PlanMyStuff engine controllers.
+  # Use this to require authentication before accessing the mounted engine.
+  #
+  # config.authenticate_with do
+  #   redirect_to main_app.login_path unless current_user
+  # end
+
+  # --------------------------------------------------------------------------
+  # Markdown rendering
+  # --------------------------------------------------------------------------
+  # :commonmarker (default) or :redcarpet -- the chosen gem must be in your Gemfile.
+  # config.markdown_renderer = :commonmarker
+
+  # --------------------------------------------------------------------------
+  # URL prefix
+  # --------------------------------------------------------------------------
+  # Prefix for building user-facing ticket URLs in your app.
+  # config.issues_url_prefix = 'https://myapp.example.com/tickets/'
+
+  # --------------------------------------------------------------------------
+  # Request gateway
+  # --------------------------------------------------------------------------
+  # 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'
+  # }
+
+  # 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'
+
+  # --------------------------------------------------------------------------
+  # Custom fields
+  # --------------------------------------------------------------------------
+  # App-defined fields stored in issue/comment metadata. Keys are field names,
+  # values are hashes with :type and :required.
+  #
+  # Supported types: :string, :integer, :boolean, :array, :hash
+  # required: true means the key must be present (value can be nil, [], etc.)
+  #
+  config.custom_fields = {
+    notification_recipients: { type: :array, required: true },
+  }
+end