plan_my_stuff 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64667e99c4a5b732a987a483072636d81c8d36840433feaf83f4d89b71f96934
-  data.tar.gz: 4675d511991935756e77c8730c57588bcbea68fd48acecfc67753c2062cd48ab
+  metadata.gz: 6561200ae8220464aa3e705f21ae4d6695a4c3ae3db222677bb1deddddcd37b7
+  data.tar.gz: 98d519079e5c203741de10ce667341246d20335253033357a5d3ae8e1b48feee
 SHA512:
-  metadata.gz: 2393fea9842e2c1ee5656f4123416933b0021ba5fcdf80962ddc1e15ea72f12682dbd353cde0f8931066eb2a656be4a34bcf8a6c7ab886e200c52df66c30876b
-  data.tar.gz: 3aea3806e8ca62fc0de5bf2b94544f0cb5888c3a20a224e8104b85f4d99095715d845e4509a80930c9eb2d9652a16b05151c659b53b19eda3e8f77ce6b5e7bb6
+  metadata.gz: 8c78d58f9322827d0483389f56dd82d02786929b851cfc6bf81bdc11973f7cdb06e3866b12c40054d4db71f44a24f5c817fd41213b374cf96eeec75e4c384b44
+  data.tar.gz: 9b1464ab72de0568958a73d75bb79f4d7e4095bbebc9e97dcf5f97445c79eace14f83d65da99de36f61c10f5ca37e178e5ffb2ef59afa941cad8f49b3ba56be2

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 0.26.0
+
+### Added
+
+- `PlanMyStuff::Issue#awaiting_reply?` - returns `true` when the issue's `Issue Status` field is `Waiting on Reply`.
+- `config.issue_field_names` (canonical field name => consumer field name) and `config.issue_field_values` (canonical
+  field name => `{ canonical value => consumer value }`) let a consuming org rename the native Issue Fields / option
+  labels the gem refers to internally. Translation runs via the new `PlanMyStuff::IssueFieldTranslation` module:
+  canonical => consumer on writes and filters (`set_issue_fields!`, `Issue.list` / `.count` `issue_fields:` +
+  `priority_list:`), consumer => canonical on reads (`Issue#issue_fields`), so internal comparisons like
+  `awaiting_reply?` / `priority_list?` keep working regardless of the org's naming. Unmapped names / values pass
+  through unchanged (identity fallback, mirroring `config.pipeline_statuses`).
+
+### Changed
+
+- The waiting/inactivity lifecycle methods now write the native `Issue Status` issue field alongside their existing
+  label/metadata changes (gated on `config.issue_fields_enabled`): `enter_waiting_on_user!` sets `Waiting on Reply`,
+  `clear_waiting_on_user!` sets `Open`, and `reopen_by_reply!` sets `Reopened`. No-op when `issue_fields_enabled` is
+  `false`.
+
 ## 0.25.0
 
 ### Added

data/CONFIGURATION.md

@@ -214,6 +214,8 @@ config.issue_types = {
 | Option | Type | Default | Description |
 |---|---|---|---|
 | `issue_fields_enabled` | `Boolean` | `true` | Whether the Issue Fields public preview is wired up for the org. |
+| `issue_field_names` | `Hash{String => String}` | `{}` | Canonical Issue Field name => the consumer org's field name. |
+| `issue_field_values` | `Hash` | `{}` | Per field: canonical value => consumer value (single-select labels). |
 
 GitHub Issue Fields are structured per-issue metadata (text, number, date, or single-select)
 configured once at the org level. The preview is rolling out org-by-org. Leave this flag at its
@@ -229,6 +231,27 @@ With the flag off:
 config.issue_fields_enabled = false   # org not admitted to the preview yet
 ```
 
+`issue_field_names` and `issue_field_values` let a consuming org rename the native Issue Fields (and their
+single-select option labels) the gem refers to internally, the same way `pipeline_statuses` aliases pipeline
+statuses. Translation is bidirectional via `PlanMyStuff::IssueFieldTranslation`: canonical => consumer on writes and
+filters, consumer => canonical on reads, so internal comparisons (`awaiting_reply?`, `priority_list?`) keep working.
+Unmapped names / values pass through unchanged.
+
+```ruby
+config.issue_field_names = {
+  'Issue Status' => 'Status',
+  'Priority'     => 'Prio',
+}
+config.issue_field_values = {
+  'Issue Status' => {
+    'Submitted'        => 'Triaged',
+    'Waiting on Reply' => 'Awaiting Customer',
+    'Open'             => 'Open',
+    'Reopened'         => 'Reopened',
+  },
+}
+```
+
 ## Release pipeline
 
 | Option | Type | Default | Description |

data/app/controllers/plan_my_stuff/issues/closures_controller.rb

@@ -12,7 +12,11 @@ module PlanMyStuff
       # POST /issues/:issue_id/closure
       def create
         issue = PlanMyStuff::Issue.find(params[:issue_id])
-        issue.update!(state: :closed)
+        to_update = {}
+        if PlanMyStuff.configuration.issue_fields_enabled
+          to_update[:issue_fields] = { 'Issue Status' => 'Fixed' }
+        end
+        issue.update!(state: :closed, **to_update)
 
         yield(issue) if block_given?
         return if performed?
@@ -28,7 +32,11 @@ module PlanMyStuff
       # DELETE /issues/:issue_id/closure
       def destroy
         issue = PlanMyStuff::Issue.find(params[:issue_id])
-        issue.update!(state: :open)
+        to_update = {}
+        if PlanMyStuff.configuration.issue_fields_enabled
+          to_update[:issue_fields] = { 'Issue Status' => 'Reopened' }
+        end
+        issue.update!(state: :open, **to_update)
 
         yield(issue) if block_given?
         return if performed?

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

@@ -193,6 +193,27 @@ PlanMyStuff.configure do |config|
   #
   # 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
   # --------------------------------------------------------------------------

data/lib/plan_my_stuff/configuration.rb

@@ -197,6 +197,23 @@ module PlanMyStuff
     #
     attr_accessor :pipeline_testing_values
 
+    # Canonical Issue Field name to consumer field name map. Lets a consuming org rename the native issue fields the
+    # gem refers to internally (e.g. +"Issue Status"+ -> +"Status"+) without touching gem code. Applied via
+    # +PlanMyStuff::IssueFieldTranslation+ on reads, writes, and filters; unmapped names pass through unchanged.
+    #
+    # @return [Hash{String => String}]
+    #
+    attr_accessor :issue_field_names
+
+    # Canonical Issue Field value translations, nested by canonical field name:
+    # +{ 'Issue Status' => { 'Waiting on Reply' => 'Awaiting Customer', ... } }+. Lets a consuming org rename
+    # single-select option labels without touching gem code. Applied via +PlanMyStuff::IssueFieldTranslation+;
+    # unmapped fields / values pass through unchanged.
+    #
+    # @return [Hash{String => Hash{String => String}}]
+    #
+    attr_accessor :issue_field_values
+
     # @return [String] branch name that PRs merge into for "Ready for release" transition
     attr_accessor :main_branch
 
@@ -404,6 +421,8 @@ module PlanMyStuff
       @pipeline_statuses = {}
       @pipeline_testing_field_name = PlanMyStuff::Pipeline::Testing::FIELD_NAME
       @pipeline_testing_values = PlanMyStuff::Pipeline::Testing::VALUES.dup
+      @issue_field_names = {}
+      @issue_field_values = {}
       @main_branch = 'main'
       @production_branch = 'production'
       @mount_groups = { webhooks: true, issues: true, projects: true }

data/lib/plan_my_stuff/issue.rb

@@ -108,6 +108,11 @@ module PlanMyStuff
           raise(PlanMyStuff::IssueFieldsNotEnabledError)
         end
 
+        if issue_fields.present?
+          issue_fields = issue_fields.to_h.transform_keys(&:to_s)
+          issue_fields['Issue Status'] = 'Submitted' if issue_fields['Issue Status'].blank?
+        end
+
         if body.blank?
           raise(PlanMyStuff::ValidationError.new('body must be present', field: :body, expected_type: :string))
         end
@@ -356,7 +361,7 @@ module PlanMyStuff
         field_pairs = []
         field_pairs.concat(build_issue_field_filter_pairs(issue_fields)) if issue_fields.present?
         if priority_list && PlanMyStuff.configuration.issue_fields_enabled
-          field_pairs << 'priority-list:Yes'
+          field_pairs.concat(build_issue_field_filter_pairs('Priority List' => 'Yes'))
         end
         params[:issue_field_values] = field_pairs.join(',') if field_pairs.present?
 
@@ -428,7 +433,7 @@ module PlanMyStuff
         field_pairs = []
         field_pairs.concat(build_issue_field_filter_pairs(issue_fields)) if issue_fields.present?
         if priority_list && PlanMyStuff.configuration.issue_fields_enabled
-          field_pairs << 'priority-list:Yes'
+          field_pairs.concat(build_issue_field_filter_pairs('Priority List' => 'Yes'))
         end
         qualifiers += field_pairs.map { |pair| "field.#{pair}" }
 
@@ -644,11 +649,13 @@ module PlanMyStuff
         #
         def build_issue_field_filter_pairs(hash)
           hash.flat_map do |name, value|
-            slug = field_filter_slug(name)
+            slug = field_filter_slug(PlanMyStuff::IssueFieldTranslation.consumer_field_name(name))
             case value
             when nil then []
             when Range then range_field_filter_pairs(slug, value)
-            else ["#{slug}:#{format_field_filter_value(value)}"]
+            else
+              consumer_value = PlanMyStuff::IssueFieldTranslation.consumer_value(name, value)
+              ["#{slug}:#{format_field_filter_value(consumer_value)}"]
             end
           end
         end
@@ -1028,7 +1035,13 @@ module PlanMyStuff
       raise(PlanMyStuff::IssueFieldsNotEnabledError) unless PlanMyStuff.configuration.issue_fields_enabled
 
       fields_by_name = PlanMyStuff::IssueField.list(org: repo.organization).index_by { |field| field.name.downcase }
-      inputs = updates.map { |name, value| build_issue_field_input(fields_by_name, name, value) }
+      inputs = updates.map do |name, value|
+        build_issue_field_input(
+          fields_by_name,
+          PlanMyStuff::IssueFieldTranslation.consumer_field_name(name),
+          PlanMyStuff::IssueFieldTranslation.consumer_value(name, value),
+        )
+      end
 
       PlanMyStuff.client.graphql(
         PlanMyStuff::GraphQL::Queries::SET_ISSUE_FIELD_VALUES,

data/lib/plan_my_stuff/issue_extractions/waiting.rb

@@ -3,6 +3,11 @@
 module PlanMyStuff
   module IssueExtractions
     module Waiting
+      # @return [Boolean]
+      def awaiting_reply?
+        issue_fields['Issue Status'] == 'Waiting on Reply'
+      end
+
       # Marks the issue as waiting on an end-user reply. Sets +metadata.waiting_on_user_at+ to now, (re)computes
       # +metadata.next_reminder_at+, and adds the configured +waiting_on_user_label+ to the issue. Called from
       # +Comment.create!+ when a support user posts a comment with +waiting_on_reply: true+, and from the
@@ -19,6 +24,11 @@ module PlanMyStuff
         PlanMyStuff::Label.ensure!(repo: repo, name: label)
         PlanMyStuff::Label.add!(issue: self, labels: [label], user: user) if labels.exclude?(label)
 
+        to_update = {}
+        if PlanMyStuff.configuration.issue_fields_enabled
+          to_update[:issue_fields] = { 'Issue Status' => 'Waiting on Reply' }
+        end
+
         self.class.update!(
           number: number,
           repo: repo,
@@ -26,6 +36,7 @@ module PlanMyStuff
             waiting_on_user_at: PlanMyStuff.format_time(now),
             next_reminder_at: format_next_reminder_at(from: now),
           },
+          **to_update,
         )
         reload
       end
@@ -42,6 +53,11 @@ module PlanMyStuff
 
         PlanMyStuff::Label.remove!(issue: self, labels: [label]) if labels.include?(label)
 
+        to_update = {}
+        if PlanMyStuff.configuration.issue_fields_enabled
+          to_update[:issue_fields] = { 'Issue Status' => 'Open' }
+        end
+
         self.class.update!(
           number: number,
           repo: repo,
@@ -50,6 +66,7 @@ module PlanMyStuff
             next_reminder_at:
               metadata.waiting_on_approval_at ? PlanMyStuff.format_time(metadata.next_reminder_at) : nil,
           },
+          **to_update,
         )
         reload
       end
@@ -67,11 +84,17 @@ module PlanMyStuff
         inactive_label = PlanMyStuff.configuration.user_inactive_label
         PlanMyStuff::Label.remove!(issue: self, labels: [inactive_label]) if labels.include?(inactive_label)
 
+        to_update = {}
+        if PlanMyStuff.configuration.issue_fields_enabled
+          to_update[:issue_fields] = { 'Issue Status' => 'Reopened' }
+        end
+
         self.class.update!(
           number: number,
           repo: repo,
           state: :open,
           metadata: { closed_by_inactivity: false },
+          **to_update,
         )
         reload
 

data/lib/plan_my_stuff/issue_field_translation.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module PlanMyStuff
+  # Translates between the canonical Issue Field names / values the gem refers to internally (e.g. +"Issue Status"+,
+  # +"Waiting on Reply"+) and the names / values a consuming org actually uses on GitHub. Driven by
+  # +config.issue_field_names+ (canonical field name => consumer field name) and +config.issue_field_values+
+  # (canonical field name => { canonical value => consumer value }).
+  #
+  # Outbound (canonical -> consumer) translation happens on writes and filters; inbound (consumer -> canonical) on
+  # reads, so internal comparisons like +issue_fields['Issue Status'] == 'Waiting on Reply'+ keep working regardless of
+  # how the org named the field or option. Unconfigured names / values pass through unchanged (identity fallback,
+  # mirroring +config.pipeline_statuses+).
+  module IssueFieldTranslation
+    module_function
+
+    # @param canonical [String, Symbol] canonical field name
+    #
+    # @return [String] the consumer's field name, or the canonical name when unmapped
+    #
+    def consumer_field_name(canonical)
+      PlanMyStuff.configuration.issue_field_names.fetch(canonical.to_s, canonical.to_s)
+    end
+
+    # @param consumer [String] the consumer's field name (as GitHub returns it)
+    #
+    # @return [String] the canonical field name, or the consumer name when unmapped
+    #
+    def canonical_field_name(consumer)
+      PlanMyStuff.configuration.issue_field_names.invert.fetch(consumer, consumer)
+    end
+
+    # Translates a canonical value to the consumer's value for the given canonical field. Non-String values (numbers,
+    # dates, +nil+) pass through untouched -- only single-select / text labels are translatable.
+    #
+    # @param canonical_field [String, Symbol] canonical field name
+    # @param value [Object, nil] canonical value
+    #
+    # @return [Object, nil] the consumer's value, or the input when unmapped / non-String
+    #
+    def consumer_value(canonical_field, value)
+      return value unless value.is_a?(String)
+
+      value_map(canonical_field).fetch(value, value)
+    end
+
+    # Translates a consumer value back to the canonical value for the given canonical field.
+    #
+    # @param canonical_field [String, Symbol] canonical field name
+    # @param value [Object, nil] consumer value
+    #
+    # @return [Object, nil] the canonical value, or the input when unmapped / non-String
+    #
+    def canonical_value(canonical_field, value)
+      return value unless value.is_a?(String)
+
+      value_map(canonical_field).invert.fetch(value, value)
+    end
+
+    # @param canonical_field [String, Symbol]
+    #
+    # @return [Hash{String => String}] canonical-value => consumer-value map for the field (empty when unconfigured)
+    #
+    def value_map(canonical_field)
+      PlanMyStuff.configuration.issue_field_values.fetch(canonical_field.to_s, {})
+    end
+  end
+end

data/lib/plan_my_stuff/issue_field_value_set.rb

@@ -6,7 +6,8 @@ module PlanMyStuff
   # as +Date+, number fields as +Float+, single-select fields as the option name +String+, and
   # text fields as the raw +String+.
   #
-  # Access is by field display name; string and symbol keys both work. Iteration yields
+  # Access is by canonical field name (consumer names / values are reverse-translated via
+  # +PlanMyStuff::IssueFieldTranslation+ on construction); string and symbol keys both work. Iteration yields
   # +[name, value]+ pairs in the order GitHub returned them.
   class IssueFieldValueSet
     include Enumerable
@@ -19,7 +20,10 @@ module PlanMyStuff
       # @return [PlanMyStuff::IssueFieldValueSet]
       #
       def from_graphql(nodes)
-        pairs = Array.wrap(nodes).map { |node| [node.dig(:field, :name), coerce(node)] }
+        pairs = Array.wrap(nodes).map do |node|
+          canonical_name = PlanMyStuff::IssueFieldTranslation.canonical_field_name(node.dig(:field, :name))
+          [canonical_name, PlanMyStuff::IssueFieldTranslation.canonical_value(canonical_name, coerce(node))]
+        end
         new(pairs.to_h)
       end
 

data/lib/plan_my_stuff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Brands Insurance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-21 00:00:00.000000000 Z
+date: 2026-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -134,6 +134,7 @@ files:
 - lib/plan_my_stuff/issue_extractions/viewers.rb
 - lib/plan_my_stuff/issue_extractions/waiting.rb
 - lib/plan_my_stuff/issue_field.rb
+- lib/plan_my_stuff/issue_field_translation.rb
 - lib/plan_my_stuff/issue_field_value_set.rb
 - lib/plan_my_stuff/issue_metadata.rb
 - lib/plan_my_stuff/label.rb