plan_my_stuff 0.27.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4162f792a9b4fbc7cced8a9a91721c21d15010189cf38021b87d20d53dbcb56
-  data.tar.gz: 72c6220c9be50c083360357ba28f1cb7225c784ed9c8813430e24e9e27736f04
+  metadata.gz: 98cbaeb499aa1b3b22018b7145d2d8e0bd86051a237230d1b5cac3e884109e10
+  data.tar.gz: a66aa1aec786adca0853eed340e1f35e2639c7aca6aafae88a421b4cc2136b5d
 SHA512:
-  metadata.gz: af715bae691caff87d81935e140a3bc2d4af7ef49780686f85b8f145ce9e7a6ff32a6ea689c697a4bc6d193ca0612ff7147a850ea5088876282c4a6bf284ab26
-  data.tar.gz: 94d67d34bc302ceb3ec4fa815d5420f60323a9be1c6b4003af4948675861328d5c0ae74c7cd71031a9102c30af7e63a7586d72b64136263c865b7f3cdd46d8ce
+  metadata.gz: 8f4e1995d828ae83edfc94a9d2d0805b5787165e28f062bd0100f586de2c19e49fb6f9167ac0ee0ea88be5001012ffab5371315d2dcaee4b081a13e6be53a993
+  data.tar.gz: 95474b37f6f2bbd4c6074f3049086b1d643617c7c0a6dbf8562e9e0c29f9ad7bcbcabcedfda29f8e55cfcf12d5f0024a41cd69d0c9527dff91948a83e8dcde46

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.29.0
+
+### Changed
+
+- `Pipeline.complete_deployment!` now sets the linked issue's `Issue Status` field to `Fixed` on the auto-complete
+  success path (alongside moving the item to `Completed`). Gated on `config.issue_fields_enabled`, so completion still
+  succeeds when issue fields are disabled. The auto-complete-off early return is unchanged (closes #96).
+
+## 0.28.0
+
+### Added
+
+- `Issue.list_page_info(...)` returns a `PlanMyStuff::Issue::PageInfo` value object exposing `.issues`, `.page`,
+  `.per_page`, `.has_next?`, and `.has_prev?`. `Issue.list` now delegates to it; return type unchanged
+  (`Array<Issue>`). Closes #63.
+
 ## 0.27.0
 
 ### Added

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

@@ -23,10 +23,11 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id])
-        issue.request_approvals!(user_ids: user_ids, user: pms_current_user)
+        find_issue
 
-        yield(issue) if block_given?
+        @issue.request_approvals!(user_ids: user_ids, user: pms_current_user)
+
+        yield(@issue) if block_given?
         return if performed?
 
         flash[:success] = 'Approvers were successfully added.'
@@ -47,7 +48,7 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id])
+        find_issue
         caller_id = pms_current_user.present? ? PlanMyStuff::UserResolver.user_id(pms_current_user) : nil
 
         case status
@@ -56,25 +57,25 @@ module PlanMyStuff
             redirect_to_unauthorized(show_path)
             return
           end
-          issue.approve!(user: pms_current_user)
+          @issue.approve!(user: pms_current_user)
           flash[:success] = 'Approval recorded.'
         when 'rejected'
           unless caller_id == target_id
             redirect_to_unauthorized(show_path)
             return
           end
-          issue.reject!(user: pms_current_user)
+          @issue.reject!(user: pms_current_user)
           flash[:success] = 'Rejection recorded.'
         else
           if caller_id != target_id && !support_user?
             redirect_to_unauthorized(show_path)
             return
           end
-          issue.revoke_approval!(user: pms_current_user, target_user_id: target_id)
+          @issue.revoke_approval!(user: pms_current_user, target_user_id: target_id)
           flash[:success] = 'Response revoked.'
         end
 
-        yield(issue) if block_given?
+        yield(@issue) if block_given?
         return if performed?
 
         redirect_to(show_path)
@@ -91,10 +92,10 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id])
-        issue.remove_approvers!(user_ids: [params[:id].to_i], user: pms_current_user)
+        find_issue
+        @issue.remove_approvers!(user_ids: [params[:id].to_i], user: pms_current_user)
 
-        yield(issue) if block_given?
+        yield(@issue) if block_given?
         return if performed?
 
         flash[:success] = 'Approver was successfully removed.'
@@ -112,9 +113,14 @@ module PlanMyStuff
           params.fetch(:approval, {}).permit(:status, :user_ids)
         end
 
+        # :nodoc:
+        def find_issue
+          @issue = PlanMyStuff::Issue.find(params[:issue_id])
+        end
+
         # @return [String]
         def show_path
-          plan_my_stuff.issue_path(params[:issue_id])
+          plan_my_stuff.issue_path(@issue || params[:issue_id])
         end
     end
   end

data/lib/plan_my_stuff/engine.rb

@@ -16,7 +16,7 @@ module PlanMyStuff
       if loader.respond_to?(:eager_load_dir)
         loader.eager_load_dir(controllers_dir)
       else
-        Dir.glob(File.join(controllers_dir, '**/*.rb')).sort.each { |path| require path }
+        Dir.glob(File.join(controllers_dir, '**/*.rb')).each { |path| require path }
       end
     end
   end

data/lib/plan_my_stuff/issue.rb

@@ -9,6 +9,21 @@ module PlanMyStuff
   # - `Issue.create!` / `Issue.find` / `Issue.list` return persisted instances
   # - `issue.save!` / `issue.update!` / `issue.reload` for persistence
   class Issue < PlanMyStuff::ApplicationRecord
+    # Value object returned by +Issue.list_page_info+: the fetched issues plus pagination metadata read from the
+    # +Link+ header of the +list_issues+ response. +:total_pages+ is intentionally absent -- GitHub's issues endpoint
+    # is cursor-paginated and never advertises +rel="last"+.
+    #
+    # @!attribute [r] issues
+    #   @return [Array<PlanMyStuff::Issue>]
+    # @!attribute [r] page
+    #   @return [Integer] echo of the requested page
+    # @!attribute [r] per_page
+    #   @return [Integer] echo of the requested per_page
+    PageInfo = Data.define(:issues, :page, :per_page, :has_next, :has_prev) do
+      alias_method :has_next?, :has_next
+      alias_method :has_prev?, :has_prev
+    end
+
     include PlanMyStuff::IssueExtractions::Approvals
     include PlanMyStuff::IssueExtractions::Links
     include PlanMyStuff::IssueExtractions::Viewers
@@ -332,7 +347,38 @@ module PlanMyStuff
       #
       # @return [Array<PlanMyStuff::Issue>]
       #
-      def list(
+      def list(**)
+        list_page_info(**).issues
+      end
+
+      # Lists GitHub issues like +.list+, but returns a +PageInfo+ value object carrying the issues plus pagination
+      # metadata read from the response's +Link+ header in the same request. Use this over +.list+ when a caller needs
+      # to know whether more pages exist (e.g. to render "Next"/"Prev" controls) without an optimistic +page + 1+
+      # probe.
+      #
+      # Shares the entire parameter surface, filtering, and PR-rejection behavior of +.list+; see it for semantics.
+      #
+      # Note the PR-filter wart: +per_page+ caps GitHub's raw item count (issues + PRs), but PRs are stripped
+      # client-side afterward, so +page_info.issues.length+ may be smaller than +per_page+. +has_next?+ comes straight
+      # from the +Link+ header, so it reflects raw items too -- a page can report +has_next? == true+ while showing
+      # fewer than +per_page+ issues.
+      #
+      # @raise [ArgumentError] when +priority_list: false+ is passed, or when +issue_type:+ is an Array
+      # @raise [PlanMyStuff::IssueFieldsNotEnabledError] when +issue_fields:+ is passed and
+      #   +config.issue_fields_enabled+ is +false+
+      #
+      # @param repo [Symbol, String, nil] defaults to config.default_repo
+      # @param state [Symbol] :open, :closed, or :all
+      # @param labels [Array<String>]
+      # @param issue_type [String, Symbol, nil] a single GitHub issue type name
+      # @param issue_fields [Hash{String,Symbol => Object,Range,nil}, nil] GitHub Issue Field equality / range filters
+      # @param priority_list [Boolean, nil] when +true+, restricts to +Priority List+ +Yes+ issues
+      # @param page [Integer]
+      # @param per_page [Integer]
+      #
+      # @return [PlanMyStuff::Issue::PageInfo]
+      #
+      def list_page_info(
         repo: nil,
         state: :open,
         labels: [],
@@ -366,8 +412,16 @@ module PlanMyStuff
         params[:issue_field_values] = field_pairs.join(',') if field_pairs.present?
 
         github_issues = client.rest(:list_issues, resolved_repo, **params)
+        rels = client.last_response&.rels || {}
         filtered = github_issues.reject { |gi| gi.respond_to?(:pull_request) && gi.pull_request }
-        filtered.map { |gi| build(gi, repo: resolved_repo) }
+
+        PageInfo.new(
+          issues: filtered.map { |gi| build(gi, repo: resolved_repo) },
+          page: page,
+          per_page: per_page,
+          has_next: rels[:next].present?,
+          has_prev: rels[:prev].present?,
+        )
       end
 
       # Convenience shortcut for +list(priority_list: true, ...)+. See +.list+ for parameter semantics.

data/lib/plan_my_stuff/pipeline.rb

@@ -273,8 +273,10 @@ module PlanMyStuff
       items
     end
 
-    # Moves a project item to "Completed" if the linked issue has +auto_complete+ enabled. Returns +nil+ when
-    # auto-complete is off (item stays at "Release in Progress").
+    # Moves a project item to "Completed" if the linked issue has +auto_complete+ enabled, and sets the linked issue's
+    # "Issue Status" field to "Fixed". Returns +nil+ when auto-complete is off (item stays at "Release in Progress" and
+    # no field is touched). The "Issue Status" update is skipped when +config.issue_fields_enabled+ is +false+ so
+    # completion still succeeds.
     #
     # @param project_item [PlanMyStuff::ProjectItem]
     # @param deployment_id [String, nil]
@@ -288,6 +290,8 @@ module PlanMyStuff
       status = resolve_status_name(PlanMyStuff::Pipeline::Status::COMPLETED)
       result = project_item.move_to!(status)
 
+      issue.set_issue_fields!('Issue Status' => 'Fixed') if PlanMyStuff.configuration.issue_fields_enabled
+
       instrument(PlanMyStuff::Pipeline::Status::COMPLETED, project_item, deployment_id: deployment_id)
       result
     end

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 27
+    MINOR = 29
     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.27.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Brands Insurance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-26 00:00:00.000000000 Z
+date: 2026-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails