plan_my_stuff 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b39dc4e08c17c126407b4b96f698d4718b77f9485f251af2f7a1c642e58a1b8
-  data.tar.gz: 335dbb910692194950e6ac9bcc904d302b67ddf34d4cf0e21611dd3bf36d675d
+  metadata.gz: 0fdaa17653ccaf192c32d3ba21c5eb0ea4954b2a983d1d0d8f3665a9a792d065
+  data.tar.gz: d61fb2fba100a20b0e2f40744e2e6c4c936ff4d55c2cbbdf428f8f6d30ed4ea8
 SHA512:
-  metadata.gz: 0f9b3a98fd6085704eafe6bf19a90bca60010f7004c28913b6356d96cef8ac08145f82e12a389fde0adb40c2ffa4eb7aca1aa3ea9f2065ed3549a28f6eacffdd
-  data.tar.gz: 303c6bec1248313856b9dad67234a77344ac1e9ea66e2c90361e498524c9f46f9da142a5c278f2866806be1437fc701097699c67c86890e02757c31632a657cc
+  metadata.gz: cf7a2e48f07ef85f21725524db9a11bad2d4da8ecf403c1e60a3817a86087d0a06ee98d88d12a2a830584c950c5705ca0693c1c5b8f7fd5229b3ffbc0851174a
+  data.tar.gz: 89bc0e780f36649e7abacefe7b0fa65f56d6302f66cc23c49cfb343d4ec8f1190b58cd8f4e59c2ba52a5ab8d199bf459a9060ea69321d0793d3da34f7a4e5294

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.2.0
+
+### Added
+
+- Validate `config.custom_fields` on `create!`/`update!` actions
+
+### Changes
+
+- CodeRabbit improvements
+
+## 0.1.2
+
+### Fixed
+
+- Issues' links were looking for the issue in the default repo with the same number
+
+## 0.1.1
+
+### Fixed
+
+- Wrong changelog included in publish
+
+## 0.1.0
+
+- Initial Setup

data/app/controllers/plan_my_stuff/application_controller.rb

@@ -70,7 +70,10 @@ module PlanMyStuff
       def parse_viewer_ids(ids_string)
         return [] if ids_string.blank?
 
-        ids_string.split(',').filter_map { |id| id.strip.presence&.to_i }
+        ids_string.split(',').filter_map do |id|
+          token = id.strip
+          token.to_i if token.match?(/\A\d+\z/)
+        end
       end
   end
 end

data/app/controllers/plan_my_stuff/comments_controller.rb

@@ -4,7 +4,7 @@ module PlanMyStuff
   class CommentsController < ApplicationController
     # POST /issues/:issue_id/comments
     def create
-      @issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo]&.to_sym)
+      @issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo])
 
       PMS::Comment.create!(
         issue: @issue,
@@ -14,25 +14,33 @@ module PlanMyStuff
       )
 
       flash[:success] = 'Comment was successfully created.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number))
+      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
     end
 
     # GET /issues/:issue_id/comments/:id/edit
     def edit
       load_comment
       return unless @comment
+      return redirect_to_issue if issue_body_comment?
 
       @support_user = support_user?
-      return redirect_to_unauthorized(plan_my_stuff.issue_path(@issue.number)) unless can_edit?(@comment)
+      return if can_edit?(@comment)
+
+      redirect_to_unauthorized(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
     end
 
     # PATCH/PUT /issues/:issue_id/comments/:id
     def update
       load_comment
       return unless @comment
+      return redirect_to_issue if issue_body_comment?
 
       @support_user = support_user?
-      return redirect_to_unauthorized(plan_my_stuff.issue_path(@issue.number)) unless can_edit?(@comment)
+      unless can_edit?(@comment)
+        redirect_to_unauthorized(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+
+        return
+      end
 
       update_attrs = { body: comment_params[:body] }
       update_attrs[:visibility] = comment_params[:visibility].to_sym if @support_user && comment_params[:visibility]
@@ -40,7 +48,7 @@ module PlanMyStuff
       @comment.update!(**update_attrs)
 
       flash[:success] = 'Comment was successfully updated.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number))
+      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
     rescue PMS::StaleObjectError
       flash.now[:error] = 'Comment was modified by someone else. Please review the latest changes and try again.'
       render(:edit, status: PMS.unprocessable_status)
@@ -58,7 +66,7 @@ module PlanMyStuff
       # @return [void]
       #
       def load_comment
-        @issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo]&.to_sym)
+        @issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo])
         @comment = PMS::Comment.find(params[:id].to_i, issue: @issue)
       end
 
@@ -78,5 +86,15 @@ module PlanMyStuff
 
         comment.metadata.created_by == PMS::UserResolver.user_id(user)
       end
+
+      # @return [Boolean]
+      def issue_body_comment?
+        @comment.metadata.issue_body?
+      end
+
+      # @return [void]
+      def redirect_to_issue
+        redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+      end
   end
 end

data/app/controllers/plan_my_stuff/issues_controller.rb

@@ -8,7 +8,7 @@ module PlanMyStuff
       @per_page = (params[:per_page] || 25).to_i
       @state = (params[:state] || 'open').to_sym
       @labels = params[:labels].present? ? Array.wrap(params[:labels]) : []
-      @repo = params[:repo]&.to_sym
+      @repo = params[:repo]
 
       @issues = PMS::Issue.list(
         repo: @repo,
@@ -35,7 +35,7 @@ module PlanMyStuff
       )
 
       flash[:success] = 'Issue was successfully created.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number))
+      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
     rescue PMS::ValidationError => e
       @issue = PMS::Issue.new(title: issue_params[:title], body: issue_params[:body])
       @support_user = support_user?
@@ -45,7 +45,7 @@ module PlanMyStuff
 
     # GET /issues/:id
     def show
-      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo]&.to_sym)
+      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo])
       @comments = filter_visible_comments(@issue.comments)
       @support_user = support_user?
       @current_user_id = pms_current_user.present? ? PMS::UserResolver.user_id(pms_current_user) : nil
@@ -53,13 +53,13 @@ module PlanMyStuff
 
     # GET /issues/:id/edit
     def edit
-      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo]&.to_sym)
+      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo])
       @support_user = support_user?
     end
 
     # PATCH/PUT /issues/:id
     def update
-      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo]&.to_sym)
+      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo])
 
       @issue.update!(
         title: issue_params[:title],
@@ -68,7 +68,7 @@ module PlanMyStuff
       )
 
       flash[:success] = 'Issue was successfully updated.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number))
+      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
     rescue PMS::StaleObjectError
       @support_user = support_user?
       flash.now[:error] = 'Issue was modified by someone else. Please review the latest changes and try again.'
@@ -77,48 +77,54 @@ module PlanMyStuff
 
     # PATCH /issues/:id/close
     def close
-      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo]&.to_sym)
+      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo])
       @issue.update!(state: :closed)
 
       flash[:success] = 'Issue was successfully closed.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number))
+      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
     end
 
     # PATCH /issues/:id/reopen
     def reopen
-      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo]&.to_sym)
+      @issue = PMS::Issue.find(params[:id].to_i, repo: params[:repo])
       @issue.update!(state: :open)
 
       flash[:success] = 'Issue was successfully reopened.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number))
+      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
     end
 
     # POST /issues/:id/add_viewers
     def add_viewers
-      return redirect_to_unauthorized(plan_my_stuff.issue_path(params[:id])) unless support_user?
+      unless support_user?
+        redirect_to_unauthorized(plan_my_stuff.issue_path(params[:id], repo: params[:repo]))
+        return
+      end
 
       viewer_ids = parse_viewer_ids(params[:viewer_ids])
       if viewer_ids.blank?
         flash[:error] = 'No valid viewer IDs provided.'
-        redirect_to(plan_my_stuff.edit_issue_path(params[:id]))
+        redirect_to(plan_my_stuff.edit_issue_path(params[:id], repo: params[:repo]))
         return
       end
 
-      PMS::Issue.add_viewers(number: params[:id].to_i, user_ids: viewer_ids, repo: params[:repo]&.to_sym)
+      PMS::Issue.add_viewers(number: params[:id].to_i, user_ids: viewer_ids, repo: params[:repo])
 
       flash[:success] = 'Viewers were successfully added.'
-      redirect_to(plan_my_stuff.edit_issue_path(params[:id]))
+      redirect_to(plan_my_stuff.edit_issue_path(params[:id], repo: params[:repo]))
     end
 
     # DELETE /issues/:id/remove_viewer
     def remove_viewer
-      return redirect_to_unauthorized(plan_my_stuff.issue_path(params[:id])) unless support_user?
+      unless support_user?
+        redirect_to_unauthorized(plan_my_stuff.issue_path(params[:id], repo: params[:repo]))
+        return
+      end
 
       viewer_id = params[:viewer_id].to_i
-      PMS::Issue.remove_viewers(number: params[:id].to_i, user_ids: [viewer_id], repo: params[:repo]&.to_sym)
+      PMS::Issue.remove_viewers(number: params[:id].to_i, user_ids: [viewer_id], repo: params[:repo])
 
       flash[:success] = 'Viewer was successfully removed.'
-      redirect_to(plan_my_stuff.edit_issue_path(params[:id]))
+      redirect_to(plan_my_stuff.edit_issue_path(params[:id], repo: params[:repo]))
     end
 
     private

data/app/controllers/plan_my_stuff/labels_controller.rb

@@ -7,24 +7,24 @@ module PlanMyStuff
       labels = parse_labels(params[:label_name])
       if labels.blank?
         flash[:error] = 'Label name is required.'
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
         return
       end
 
-      issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo]&.to_sym)
+      issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo])
       PMS::Label.add(issue: issue, labels: labels)
 
       flash[:success] = 'Label was successfully added.'
-      redirect_to(plan_my_stuff.issue_path(issue.number))
+      redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
     end
 
     # DELETE /issues/:issue_id/labels/:name
     def remove_from_issue
-      issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo]&.to_sym)
+      issue = PMS::Issue.find(params[:issue_id].to_i, repo: params[:repo])
       PMS::Label.remove(issue: issue, labels: [params[:name]])
 
       flash[:success] = 'Label was successfully removed.'
-      redirect_to(plan_my_stuff.issue_path(issue.number))
+      redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
     end
   end
 end

data/app/controllers/plan_my_stuff/project_items_controller.rb

@@ -50,6 +50,12 @@ module PlanMyStuff
 
     # PATCH /projects/:project_id/items/:id/unassign
     def unassign
+      if params[:username].blank?
+        flash[:error] = 'Username is required to unassign.'
+        redirect_to(plan_my_stuff.project_path(params[:project_id]))
+        return
+      end
+
       item = find_project_item
       current_assignees = item.field_values['Assignees'] || []
       remaining = current_assignees - [params[:username]]

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

@@ -14,7 +14,7 @@
       <% @issues.each do |issue| %>
         <tr>
           <td><%= issue.number %></td>
-          <td><%= link_to(issue.title, plan_my_stuff.issue_path(issue.number)) %></td>
+          <td><%= link_to(issue.title, plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name)) %></td>
           <td><%= issue.state %></td>
           <td><%= issue.labels.join(', ') %></td>
         </tr>
@@ -24,14 +24,14 @@
 
   <nav>
     <% if @page > 1 %>
-      <%= link_to('Previous', plan_my_stuff.issues_path(page: @page - 1, state: @state, labels: @labels)) %>
+      <%= link_to('Previous', plan_my_stuff.issues_path(page: @page - 1, state: @state, labels: @labels, repo: @repo)) %>
     <% end %>
     <% if @issues.size == @per_page %>
-      <%= link_to('Next', plan_my_stuff.issues_path(page: @page + 1, state: @state, labels: @labels)) %>
+      <%= link_to('Next', plan_my_stuff.issues_path(page: @page + 1, state: @state, labels: @labels, repo: @repo)) %>
     <% end %>
   </nav>
 <% else %>
   <p>No issues found.</p>
 <% end %>
 <br>
-<%= link_to "New Issue", plan_my_stuff.new_issue_path %>
+<%= link_to "New Issue", plan_my_stuff.new_issue_path(repo: @repo) %>

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

@@ -1,9 +1,13 @@
-<% 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| %>
+<%
+  persisted = issue.persisted?
+  url =
+    if persisted
+      plan_my_stuff.issue_path(issue.number, repo: issue.repo&.full_name)
+    else
+      plan_my_stuff.issues_path(repo: issue.repo&.full_name)
+    end
+%>
+<%= form_with(url: url, method: persisted ? :patch : :post, scope: :issue) do |form| %>
   <div>
     <%= form.label(:title, 'Title') %>
     <%= form.text_field(:title, value: issue.title) %>

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

@@ -9,7 +9,7 @@
         <%=
           button_to(
             'Remove',
-            plan_my_stuff.remove_viewer_issue_path(issue.number, viewer_id: viewer_id),
+            plan_my_stuff.remove_viewer_issue_path(issue.number, viewer_id: viewer_id, repo: issue.repo.full_name),
             method: :delete
           )
         %>
@@ -20,7 +20,7 @@
   <p>No viewers added.</p>
 <% end %>
 
-<%= form_with(url: plan_my_stuff.add_viewers_issue_path(issue.number), method: :post) do |form| %>
+<%= form_with(url: plan_my_stuff.add_viewers_issue_path(issue.number, repo: issue.repo.full_name), method: :post) do |form| %>
   <div>
     <%= form.label(:viewer_ids, 'Add viewer IDs (comma-separated)') %>
     <%= form.text_field(:viewer_ids) %>

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

@@ -1,11 +1,11 @@
 <h1><%= @issue.title %> <small>#<%= @issue.number %></small></h1>
 
 <p>
-  <%= link_to('Edit', plan_my_stuff.edit_issue_path(@issue.number)) %>
+  <%= link_to('Edit', plan_my_stuff.edit_issue_path(@issue.number, repo: @issue.repo.full_name)) %>
   <% if @issue.state == 'open' %>
-    <%= button_to('Close Issue', plan_my_stuff.close_issue_path(@issue.number), method: :patch) %>
+    <%= button_to('Close Issue', plan_my_stuff.close_issue_path(@issue.number, repo: @issue.repo.full_name), method: :patch) %>
   <% else %>
-    <%= button_to('Reopen Issue', plan_my_stuff.reopen_issue_path(@issue.number), method: :patch) %>
+    <%= button_to('Reopen Issue', plan_my_stuff.reopen_issue_path(@issue.number, repo: @issue.repo.full_name), method: :patch) %>
   <% end %>
 </p>
 
@@ -35,7 +35,7 @@
       <%= 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)) %>
+          <%= link_to('Edit', plan_my_stuff.edit_issue_comment_path(@issue.number, comment.id, repo: @issue.repo.full_name)) %>
         </p>
       <% end %>
     </div>

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

@@ -16,12 +16,12 @@
             <% 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>
+                <% unless item.draft? %>
+                  <strong><%= link_to(item.title, plan_my_stuff.issue_path(item.number, repo: item.repo.full_name)) %></strong>
                 <% else %>
                   <strong><%= item.title %></strong>
                 <% end %>
-                <% if item.number.present? %>
+                <% unless item.draft? %>
                   <small>#<%= item.number %></small>
                 <% end %>
 
@@ -46,7 +46,7 @@
                             url: plan_my_stuff.unassign_project_item_path(@project.number, item.id),
                             method: :patch,
                             local: true,
-                            style: 'display: inline',
+                            html: { style: 'display: inline' },
                           ) do |form|
                         %>
                           <%= form.hidden_field(:username, value: username) %>

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

@@ -100,7 +100,16 @@ 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 = {}
 end

data/lib/plan_my_stuff/application_record.rb

@@ -8,6 +8,19 @@ module PlanMyStuff
   class ApplicationRecord
     include ActiveModel::Model
 
+    class << self
+      # Reads a field from an object that may respond to method calls or hash access.
+      #
+      # @param obj [Object]
+      # @param field [Symbol]
+      #
+      # @return [Object]
+      #
+      def read_field(obj, field)
+        obj.respond_to?(field) ? obj.public_send(field) : obj[field]
+      end
+    end
+
     def initialize(**)
       super
       @persisted = false
@@ -33,7 +46,7 @@ module PlanMyStuff
       # @return [Object]
       #
       def read_field(obj, field)
-        obj.respond_to?(field) ? obj.public_send(field) : obj[field]
+        self.class.read_field(obj, field)
       end
   end
 end

data/lib/plan_my_stuff/base_metadata.rb

@@ -33,10 +33,11 @@ module PlanMyStuff
         #
         # @param metadata [BaseMetadata]
         # @param hash [Hash]
+        # @param custom_fields_schema [Hash{Symbol => Hash}] merged schema for this context
         #
         # @return [void]
         #
-        def apply_common_from_hash(metadata, hash)
+        def apply_common_from_hash(metadata, hash, custom_fields_schema)
           metadata.schema_version = hash[:schema_version]
           metadata.gem_version = hash[:gem_version]
           metadata.rails_env = hash[:rails_env]
@@ -46,7 +47,7 @@ module PlanMyStuff
           metadata.created_by = hash[:created_by]
           metadata.visibility = hash.fetch(:visibility, 'internal')
           metadata.custom_fields = CustomFields.new(
-            PlanMyStuff.configuration.custom_fields,
+            custom_fields_schema,
             hash[:custom_fields] || {},
           )
         end
@@ -57,10 +58,17 @@ module PlanMyStuff
         # @param user [Object, Integer] user object or user_id
         # @param visibility [String] "public" or "internal"
         # @param custom_fields_data [Hash]
+        # @param custom_fields_schema [Hash{Symbol => Hash}] merged schema for this context
         #
         # @return [void]
         #
-        def apply_common_build(metadata, user:, visibility: 'internal', custom_fields_data: {})
+        def apply_common_build(
+          metadata,
+          user:,
+          visibility: 'internal',
+          custom_fields_data: {},
+          custom_fields_schema: {}
+        )
           config = PlanMyStuff.configuration
           now = Time.now.utc
 
@@ -74,7 +82,7 @@ module PlanMyStuff
           metadata.created_by = resolved.present? ? UserResolver.user_id(resolved) : nil
           metadata.visibility = visibility
           metadata.custom_fields = CustomFields.new(
-            config.custom_fields,
+            custom_fields_schema,
             custom_fields_data,
           )
         end
@@ -92,6 +100,7 @@ module PlanMyStuff
 
     def initialize
       @visibility = 'internal'
+      @custom_fields = {}
     end
 
     # @return [Hash]
@@ -119,6 +128,16 @@ module PlanMyStuff
       visibility == 'public'
     end
 
+    # Validates custom fields against the schema.
+    #
+    # @raise [ActiveModel::ValidationError] if validation fails
+    #
+    # @return [true]
+    #
+    def validate_custom_fields!
+      custom_fields.validate! if custom_fields.is_a?(PlanMyStuff::CustomFields)
+    end
+
     # @return [String]
     def to_json(...)
       to_h.to_json(...)

data/lib/plan_my_stuff/client.rb

@@ -70,34 +70,14 @@ module PlanMyStuff
 
     # Resolves a repo param to a full "Org/Repo" string.
     #
-    # @param repo [Symbol, String, nil] repo key, full string, or nil for default
+    # @param repo [Symbol, String, PlanMyStuff::Repo, nil] repo key, full string, Repo instance, or nil for default
     #
     # @return [String] full repo path (e.g. "BrandsInsurance/Element")
     #
     # @raise [ArgumentError] if repo cannot be resolved
     #
     def resolve_repo(repo = nil)
-      repo ||= PlanMyStuff.configuration.default_repo
-
-      if repo.nil?
-        raise(
-          PlanMyStuff::ConfigurationError,
-          'No repo provided and config.default_repo is not set. ' \
-            'Either pass repo: explicitly or set config.default_repo in your initializer.',
-        )
-      end
-
-      case repo
-      when Symbol
-        resolved = PlanMyStuff.configuration.repos[repo]
-        raise(ArgumentError, "Unknown repo key: #{repo.inspect}") if resolved.nil?
-
-        resolved
-      when String
-        repo
-      else
-        raise(ArgumentError, "Cannot resolve repo: #{repo.inspect}")
-      end
+      PlanMyStuff::Repo.resolve(repo).full_name
     end
 
     private

data/lib/plan_my_stuff/comment.rb

@@ -52,6 +52,7 @@ module PlanMyStuff
           custom_fields: custom_fields,
           issue_body: issue_body,
         )
+        comment_metadata.validate_custom_fields!
 
         header = build_header(resolved_user)
         full_body = "#{header}\n\n#{body}"
@@ -217,6 +218,7 @@ module PlanMyStuff
       raise_if_stale!
 
       new_body = attrs[:body] || body
+      new_body = preserve_header(new_body) if attrs.key?(:body)
       meta_hash = metadata.to_h
 
       if attrs.key?(:visibility)
@@ -293,6 +295,19 @@ module PlanMyStuff
 
     private
 
+      # Prepends the existing header to new_body if the comment currently has one.
+      #
+      # @param new_body [String]
+      #
+      # @return [String]
+      #
+      def preserve_header(new_body)
+        existing_header = header
+        return new_body if existing_header.blank?
+
+        "#{existing_header}\n\n#{new_body}"
+      end
+
       # Populates this instance from a GitHub API response.
       #
       # @param github_comment [Object] Octokit comment response

data/lib/plan_my_stuff/comment_metadata.rb

@@ -14,7 +14,7 @@ module PlanMyStuff
       #
       def from_hash(hash)
         metadata = new
-        apply_common_from_hash(metadata, hash)
+        apply_common_from_hash(metadata, hash, PlanMyStuff.configuration.custom_fields_for(:comment))
         metadata.issue_body = hash[:issue_body] || false
 
         metadata
@@ -31,7 +31,13 @@ module PlanMyStuff
       #
       def build(user:, visibility: 'internal', custom_fields: {}, issue_body: false)
         metadata = new
-        apply_common_build(metadata, user: user, visibility: visibility, custom_fields_data: custom_fields)
+        apply_common_build(
+          metadata,
+          user: user,
+          visibility: visibility,
+          custom_fields_data: custom_fields,
+          custom_fields_schema: PlanMyStuff.configuration.custom_fields_for(:comment),
+        )
         metadata.issue_body = issue_body
 
         metadata

data/lib/plan_my_stuff/configuration.rb

@@ -70,13 +70,28 @@ module PlanMyStuff
     # @return [String, nil] recipient address for built-in deferred request notifications
     attr_accessor :deferred_email_to
 
-    # App-defined field definitions stored in issue/comment metadata.
+    # Shared field definitions stored in issue/comment metadata.
     # Keys are field names, values are hashes with :type and :required.
+    # These fields apply to both issues and comments.
     #
     # @return [Hash{Symbol => Hash}]
     #
     attr_accessor :custom_fields
 
+    # Issue-only field definitions, deep-merged on top of shared custom_fields.
+    # Context-specific config wins on key conflicts.
+    #
+    # @return [Hash{Symbol => Hash}]
+    #
+    attr_accessor :issue_custom_fields
+
+    # Comment-only field definitions, deep-merged on top of shared custom_fields.
+    # Context-specific config wins on key conflicts.
+    #
+    # @return [Hash{Symbol => Hash}]
+    #
+    attr_accessor :comment_custom_fields
+
     # @return [String, nil] URL prefix for building user-facing ticket URLs in the consuming app
     attr_accessor :issues_url_prefix
 
@@ -100,6 +115,8 @@ module PlanMyStuff
       @markdown_options = {}
       @job_classes = {}
       @custom_fields = {}
+      @issue_custom_fields = {}
+      @comment_custom_fields = {}
     end
 
     # Sets the authentication block for engine controllers.
@@ -132,6 +149,24 @@ module PlanMyStuff
         "Missing required PlanMyStuff configuration: #{missing.join(', ')}",
       )
     end
+
+    # Returns the merged custom fields schema for the given context.
+    # Context-specific fields deep-merge on top of shared fields.
+    #
+    # @param context [Symbol] :issue or :comment
+    #
+    # @return [Hash{Symbol => Hash}]
+    #
+    def custom_fields_for(context)
+      context_fields =
+        case context
+        when :issue then issue_custom_fields
+        when :comment then comment_custom_fields
+        else {}
+        end
+
+      custom_fields.deep_merge(context_fields)
+    end
   end
 
   class ConfigurationError < StandardError

data/lib/plan_my_stuff/custom_fields.rb

@@ -1,10 +1,30 @@
 # frozen_string_literal: true
 
+require 'active_model'
+
 module PlanMyStuff
   # Dynamic accessor object for app-defined custom fields stored in metadata.
   # Backed by the config.custom_fields schema, provides both hash-style and
   # method-style access to field values.
+  #
+  # Includes ActiveModel::Validations for type checking, required field
+  # enforcement, and unknown field detection.
   class CustomFields
+    TYPE_MAP = {
+      string: [String],
+      integer: [Integer],
+      boolean: [TrueClass, FalseClass],
+      array: [Array],
+      hash: [Hash],
+    }.freeze
+
+    include ActiveModel::Validations
+
+    validate :validate_custom_fields
+
+    # @return [Hash{Symbol => Hash}]
+    attr_reader :schema
+
     # @param schema [Hash{Symbol => Hash}] field definitions from config.custom_fields
     # @param data [Hash] parsed field data from metadata JSON
     #
@@ -61,5 +81,55 @@ module PlanMyStuff
 
         super
       end
+
+      # @return [void]
+      def validate_custom_fields
+        validate_unknown_fields
+        validate_required_fields
+        validate_field_types
+      end
+
+      # @return [void]
+      def validate_unknown_fields
+        known_keys = @schema.keys
+        @data.each_key do |key|
+          if known_keys.exclude?(key)
+            errors.add(:base, "#{key} is not a recognized custom field")
+          end
+        end
+      end
+
+      # @return [void]
+      def validate_required_fields
+        @schema.each do |field_name, field_config|
+          if field_config[:required] && !@data.key?(field_name)
+            errors.add(:base, "#{field_name} is required")
+          end
+        end
+      end
+
+      # @return [void]
+      def validate_field_types
+        @schema.each do |field_name, field_config|
+          next unless @data.key?(field_name)
+
+          value = @data[field_name]
+          next if value.nil?
+
+          expected_type = field_config[:type]
+          ruby_types = TYPE_MAP[expected_type]
+          next if ruby_types.nil?
+          next if ruby_types.any? { |t| value.is_a?(t) }
+
+          expected_name =
+            if expected_type == :boolean
+              'TrueClass/FalseClass'
+            else
+              ruby_types.first.name
+            end
+
+          errors.add(:base, "#{field_name} must be a #{expected_name}, got #{value.class}")
+        end
+      end
   end
 end

data/lib/plan_my_stuff/issue.rb

@@ -24,8 +24,8 @@ module PlanMyStuff
     attr_accessor :state
     # @return [Array<String>] label names
     attr_accessor :labels
-    # @return [String] resolved repo path (e.g. "Org/Repo")
-    attr_accessor :repo
+    # @return [PlanMyStuff::Repo, nil]
+    attr_reader :repo
 
     class << self
       # Creates a GitHub issue with PMS metadata embedded in the body.
@@ -61,6 +61,7 @@ module PlanMyStuff
           custom_fields: metadata,
         )
         issue_metadata.visibility_allowlist = Array.wrap(visibility_allowlist)
+        issue_metadata.validate_custom_fields!
 
         serialized_body = MetadataParser.serialize(issue_metadata.to_h, '')
 
@@ -68,8 +69,9 @@ module PlanMyStuff
         options[:labels] = labels if labels.any?
 
         result = client.rest(:create_issue, resolved_repo, title, serialized_body, **options)
+        number = read_field(result, :number)
 
-        issue = build(result, repo: resolved_repo)
+        issue = find(number, repo: resolved_repo)
 
         if add_to_project.present?
           project_number = resolve_project_number(add_to_project)
@@ -119,6 +121,10 @@ module PlanMyStuff
           merged_custom_fields = (existing_metadata[:custom_fields] || {}).merge(metadata[:custom_fields] || {})
           existing_metadata = existing_metadata.merge(metadata)
           existing_metadata[:custom_fields] = merged_custom_fields
+          PlanMyStuff::CustomFields.new(
+            PlanMyStuff.configuration.custom_fields_for(:issue),
+            merged_custom_fields,
+          ).validate!
 
           existing_metadata[:updated_at] = Time.now.utc.iso8601
           options[:body] = MetadataParser.serialize(existing_metadata, '')
@@ -264,16 +270,7 @@ module PlanMyStuff
           body_comment = issue.body_comment
           raise(PlanMyStuff::Error, "No body comment found on issue ##{number}") if body_comment.nil?
 
-          header = body_comment.header
-
-          updated_body =
-            if header.present?
-              "#{header}\n\n#{new_body}"
-            else
-              new_body
-            end
-
-          body_comment.update!(body: updated_body)
+          body_comment.update!(body: new_body)
         end
     end
 
@@ -285,6 +282,11 @@ module PlanMyStuff
       @labels ||= []
     end
 
+    # @param value [PlanMyStuff::Repo, Symbol, String, nil]
+    def repo=(value)
+      @repo = value.present? ? PlanMyStuff::Repo.resolve(value) : nil
+    end
+
     # Persists the issue. Creates if new, updates if persisted.
     #
     # @raise [PlanMyStuff::StaleObjectError] on update if stale
@@ -411,7 +413,7 @@ module PlanMyStuff
         @state = read_field(github_issue, :state)
         @raw_body = read_field(github_issue, :body) || ''
         @labels = extract_labels(github_issue)
-        @repo = repo
+        self.repo = repo
 
         parsed = MetadataParser.parse(@raw_body)
         @metadata = IssueMetadata.from_hash(parsed[:metadata])

data/lib/plan_my_stuff/issue_metadata.rb

@@ -22,7 +22,7 @@ module PlanMyStuff
       #
       def from_hash(hash)
         metadata = new
-        apply_common_from_hash(metadata, hash)
+        apply_common_from_hash(metadata, hash, PlanMyStuff.configuration.custom_fields_for(:issue))
 
         metadata.responded_at = parse_time(hash[:responded_at])
         metadata.issues_url = hash[:issues_url]
@@ -42,7 +42,13 @@ module PlanMyStuff
       #
       def build(user:, visibility: 'public', custom_fields: {})
         metadata = new
-        apply_common_build(metadata, user: user, visibility: visibility, custom_fields_data: custom_fields)
+        apply_common_build(
+          metadata,
+          user: user,
+          visibility: visibility,
+          custom_fields_data: custom_fields,
+          custom_fields_schema: PlanMyStuff.configuration.custom_fields_for(:issue),
+        )
 
         metadata.responded_at = nil
         metadata.issues_url = build_issues_url(PlanMyStuff.configuration)

data/lib/plan_my_stuff/markdown.rb

@@ -26,7 +26,7 @@ module PlanMyStuff
         when :redcarpet
           render_redcarpet(text, merged)
         when nil
-          "<code>#{text}</code>"
+          "<code>#{ERB::Util.html_escape(text)}</code>"
         else
           raise(
             ArgumentError,

data/lib/plan_my_stuff/project.rb

@@ -90,20 +90,20 @@ module PlanMyStuff
         end
       end
 
-      private
+      # Resolves a project number, falling back to config.default_project_number.
+      #
+      # @param project_number [Integer, nil]
+      #
+      # @return [Integer]
+      #
+      def resolve_default_project_number(project_number)
+        return project_number if project_number.present?
 
-        # Resolves a project number, falling back to config.default_project_number.
-        #
-        # @param project_number [Integer, nil]
-        #
-        # @return [Integer]
-        #
-        def resolve_default_project_number(project_number)
-          return project_number if project_number.present?
+        PlanMyStuff.configuration.default_project_number ||
+          raise(ArgumentError, 'project_number is required when config.default_project_number is not set')
+      end
 
-          PlanMyStuff.configuration.default_project_number ||
-            raise(ArgumentError, 'project_number is required when config.default_project_number is not set')
-        end
+      private
 
         # @return [String]
         def list_query
@@ -170,6 +170,7 @@ module PlanMyStuff
                           number
                           url
                           state
+                          repository { nameWithOwner }
                         }
                         ... on PullRequest {
                           id
@@ -177,6 +178,7 @@ module PlanMyStuff
                           number
                           url
                           state
+                          repository { nameWithOwner }
                         }
                         ... on DraftIssue {
                           id
@@ -342,6 +344,7 @@ module PlanMyStuff
         def parse_project_item(item)
           content = item[:content] || {}
           field_values = item.dig(:fieldValues, :nodes) || []
+          repo_name = content.dig(:repository, :nameWithOwner)
 
           {
             id: item[:id],
@@ -351,6 +354,7 @@ module PlanMyStuff
             number: content[:number],
             url: content[:url],
             state: content[:state],
+            repo: repo_name.present? ? PlanMyStuff::Repo.resolve(repo_name) : nil,
             status: extract_item_status(field_values),
             field_values: parse_field_values(field_values),
           }

data/lib/plan_my_stuff/project_item.rb

@@ -29,6 +29,8 @@ module PlanMyStuff
     attr_accessor :number
     # @return [String, nil]
     attr_accessor :url
+    # @return [PlanMyStuff::Repo, nil]
+    attr_accessor :repo
     # @return [String, nil]
     attr_accessor :state
     # @return [String, nil]
@@ -38,7 +40,7 @@ module PlanMyStuff
     # @return [PlanMyStuff::Project, nil]
     attr_accessor :project
     # @return [PlanMyStuff::Issue, nil] linked issue (nil for draft items)
-    attr_accessor :issue
+    attr_writer :issue
 
     class << self
       # Builds a persisted ProjectItem from parsed item data.
@@ -56,6 +58,7 @@ module PlanMyStuff
           title: item_hash[:title],
           number: item_hash[:number],
           url: item_hash[:url],
+          repo: item_hash[:repo],
           state: item_hash[:state],
           status: item_hash[:status],
           field_values: item_hash[:field_values] || {},
@@ -170,6 +173,7 @@ module PlanMyStuff
           item = build(
             {
               id: item_data[:id],
+              content_node_id: node_id,
               title: issue.title,
               number: issue.number,
               url: nil,
@@ -210,6 +214,8 @@ module PlanMyStuff
           build(
             {
               id: item_data[:id],
+              content_node_id: item_data.dig(:content, :id),
+              type: 'DRAFT_ISSUE',
               title: title,
               number: nil,
               url: nil,
@@ -221,17 +227,9 @@ module PlanMyStuff
           )
         end
 
-        # Resolves a project number, falling back to config.default_project_number.
-        #
-        # @param project_number [Integer, nil]
-        #
-        # @return [Integer]
-        #
+        # @see PlanMyStuff::Project.resolve_default_project_number
         def resolve_default_project_number(project_number)
-          return project_number if project_number.present?
-
-          PlanMyStuff.configuration.default_project_number ||
-            raise(ArgumentError, 'project_number is required when config.default_project_number is not set')
+          PlanMyStuff::Project.resolve_default_project_number(project_number)
         end
 
         # @return [String]
@@ -261,6 +259,7 @@ module PlanMyStuff
               }) {
                 projectItem {
                   id
+                  content { ... on DraftIssue { id } }
                 }
               }
             }
@@ -393,6 +392,7 @@ module PlanMyStuff
         content_node_id: content_node_id,
         assignees: Array.wrap(assignees),
         draft: draft?,
+        repo: repo,
       )
     end
 
@@ -401,6 +401,14 @@ module PlanMyStuff
       type == 'DRAFT_ISSUE'
     end
 
+    # @return [PlanMyStuff::Issue, nil]
+    def issue
+      return @issue if defined?(@issue)
+      return if draft?
+
+      @issue = PMS::Issue.find(number, repo: repo)
+    end
+
     private
 
       # Marks this record as persisted.

data/lib/plan_my_stuff/repo.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module PlanMyStuff
+  class Repo
+    # @return [Symbol, nil] configured key (e.g. :my_repo)
+    attr_reader :key
+
+    # @return [String] repo name (e.g. "MyRepository")
+    attr_reader :name
+
+    # @return [String] organization name (e.g. "YourOrgName")
+    attr_reader :organization
+
+    delegate :split, to: :to_s
+
+    class << self
+      # Builds a Repo instance from a Symbol key, full name String, or nil (default).
+      #
+      # @param repo [Symbol, String, PlanMyStuff::Repo, nil]
+      #
+      # @return [PlanMyStuff::Repo]
+      #
+      def resolve(repo = nil)
+        return repo if repo.is_a?(PlanMyStuff::Repo)
+
+        repo ||= PlanMyStuff.configuration.default_repo
+
+        if repo.nil?
+          raise(
+            PlanMyStuff::ConfigurationError,
+            'No repo provided and config.default_repo is not set. ' \
+              'Either pass repo: explicitly or set config.default_repo in your initializer.',
+          )
+        end
+
+        case repo
+        when Symbol
+          full_name = PlanMyStuff.configuration.repos[repo]
+          raise(ArgumentError, "Unknown repo key: #{repo.inspect}") if full_name.nil?
+
+          from_full_name(full_name, key: repo)
+        when String
+          key = PlanMyStuff.configuration.repos.key(repo)
+          from_full_name(repo, key: key)
+        else
+          raise(ArgumentError, "Cannot resolve repo: #{repo.inspect}")
+        end
+      end
+
+      private
+
+        # @param full_name [String] e.g. "YourOrgName/MyRepository"
+        # @param key [Symbol, nil]
+        #
+        # @return [PlanMyStuff::Repo]
+        #
+        def from_full_name(full_name, key: nil)
+          org, name = full_name.split('/', 2)
+
+          raise(ArgumentError, "Invalid repo full_name: #{full_name.inspect}") if name.nil?
+
+          new(name: name, organization: org, key: key)
+        end
+    end
+
+    # @param name [String]
+    # @param organization [String]
+    # @param key [Symbol, nil]
+    #
+    def initialize(name:, organization:, key: nil)
+      @key = key
+      @name = name
+      @organization = organization
+    end
+
+    # @return [String] full repo path (e.g. "YourOrgName/MyRepository")
+    def full_name
+      "#{organization}/#{name}"
+    end
+
+    # @see #full_name
+    alias to_s full_name
+
+    # Enables implicit string coercion so Repo instances behave as
+    # strings when passed to Octokit or compared with String#==.
+    #
+    # @see #full_name
+    alias to_str full_name
+
+    # Compares by full_name. Accepts another Repo or a String.
+    #
+    # @param other [PlanMyStuff::Repo, String, Object]
+    #
+    # @return [Boolean]
+    #
+    def ==(other)
+      case other
+      when PlanMyStuff::Repo
+        full_name == other.full_name
+      when String
+        full_name == other
+      else
+        super
+      end
+    end
+  end
+end

data/lib/plan_my_stuff/test_helpers.rb

@@ -316,10 +316,17 @@ module PlanMyStuff
             },
           }
 
+          resolved_repo =
+            if params[:repo]
+              PlanMyStuff::Repo.resolve(params[:repo]).full_name
+            else
+              'TestOrg/TestRepo'
+            end
+
           PlanMyStuff::TestHelpers.build_issue(
             title: params[:title],
             body: params[:body],
-            repo: params[:repo]&.to_s || 'TestOrg/TestRepo',
+            repo: resolved_repo,
             labels: params[:labels] || [],
           )
         end
@@ -330,7 +337,8 @@ module PlanMyStuff
             params: { number: number, repo: repo },
           }
 
-          PlanMyStuff::TestHelpers.build_issue(number: number, repo: repo&.to_s || 'TestOrg/TestRepo')
+          resolved_repo = repo ? PlanMyStuff::Repo.resolve(repo).full_name : 'TestOrg/TestRepo'
+          PlanMyStuff::TestHelpers.build_issue(number: number, repo: resolved_repo)
         end
 
         issue_mod.define_singleton_method(:list) do |**params|

data/lib/plan_my_stuff/version.rb

@@ -3,8 +3,8 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 1
-    TINY = 1
+    MINOR = 2
+    TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)
     PRE = nil

data/lib/plan_my_stuff.rb

@@ -19,6 +19,7 @@ require_relative 'plan_my_stuff/markdown'
 require_relative 'plan_my_stuff/metadata_parser'
 require_relative 'plan_my_stuff/project'
 require_relative 'plan_my_stuff/project_item'
+require_relative 'plan_my_stuff/repo'
 require_relative 'plan_my_stuff/user_resolver'
 require_relative 'plan_my_stuff/verifier'
 require_relative 'plan_my_stuff/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Brands Insurance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-01 00:00:00.000000000 Z
+date: 2026-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,6 +51,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - app/controllers/plan_my_stuff/application_controller.rb
@@ -91,6 +92,7 @@ files:
 - lib/plan_my_stuff/metadata_parser.rb
 - lib/plan_my_stuff/project.rb
 - lib/plan_my_stuff/project_item.rb
+- lib/plan_my_stuff/repo.rb
 - lib/plan_my_stuff/test_helpers.rb
 - lib/plan_my_stuff/user_resolver.rb
 - lib/plan_my_stuff/verifier.rb