plan_my_stuff 0.10.2 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35e23ebdd170bd3c29874da833e2fed058b04319ce5d0441daf0e7837e9ef2d7
-  data.tar.gz: 5f1387007a2be2ef848420257f7ba9887dc6118a358b8aefd6ce36fb146057f0
+  metadata.gz: ce0e2f02e6063ab2fe3238671d06182fc5447f428e6dc01d336ba6e00379e86a
+  data.tar.gz: f80f58ce32e19ea6e7b8aca34a62110379e6ea65f10c943fd108c409ec50a669
 SHA512:
-  metadata.gz: 69f11b3b68728cc78cc32b0f9abe0516daae40f888c4feba2bd5b813e4fcb5501f2d628548ae6413da2712dd00007a278c215a18d1ce360150e8ca99a56014ff
-  data.tar.gz: 3d490025bd4edc8179868b6cb88adaf2a6c3c555f342532f4db603c37d1d397f89133a470871b7807b53875c5b737cb0bcc1b64a7e8bb5ad38ddc19e775c588d
+  metadata.gz: 3aaf1478091d45cbf8caa72a8a0f14b6cc445c5ec7c17382b92d50bb593d36b04ab00ade2973b2e8c67e19b3dfe1b7841022a9f336da2fe7ba3d27ea6c6b7eb5
+  data.tar.gz: 680bbb80160eaa20b20c05d4585e167e143c5be6c4735869bf8d138605cd11a52bacc1f3564cc6b8ea57e772b13aa22bdc7cd720c8254f5cf576c3207b15826e

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## 0.10.5
+
+### Added
+
+- `config.parent_controller` (default `'::ApplicationController'`) lets consuming apps that don't use the
+  `ApplicationController` name (e.g. `ActionController::Base`, `RawrApplicationController`) tell the engine
+  what to inherit from. The `plan_my_stuff:verify` rake task now reports whether the configured class
+  resolves.
+
+### Fixed
+
+- Example config option showed `url_options = Rails.application.config.action_mailer.default_url_options`. Now it shows
+`url_options = Rails.application.routes.default_url_options`
+
+## 0.10.4
+
+### Changed
+
+- Internal: unit specs now use VCR cassettes against `BrandsInsurance/ubiquitous-adventure` instead of
+  `instance_double(Octokit::Client)`. No effect on consuming apps.
+
+### Removed
+
+- ETag caching on `Issue.list`. The cache key included `state`, `labels`, `page`, and `per_page`,
+  so an etag stored under one combo never matched a request with different params - the cache wrote
+  on every call and effectively never hit. `Issue.list` now always issues a fresh GitHub request.
+  `Comment.list` keeps ETag caching (param surface is just `issue` + `pms_only`).
+  `PlanMyStuff::Cache.read_list` / `write_list` remain available for `Comment.list`.
+
+## 0.10.3
+
+### Added
+
+- `BaseProjectItem#assignees` returns the GitHub logins of users assigned to the underlying Issue,
+  PullRequest, or DraftIssue. Populated from the `FIND_PROJECT` GraphQL response (the query was extended
+  with `assignees(first: 10)` on each content fragment).
+
 ## 0.10.2
 
 ### Changed

data/CONFIGURATION.md

@@ -67,7 +67,7 @@ config.testing_template_project_number = 42
 ```ruby
 config.app_name = 'MyApp'
 
-url_options = Rails.application.config.action_mailer.default_url_options
+url_options = Rails.application.routes.default_url_options
 config.issues_url_prefix = "#{url_options[:protocol] || 'http'}://#{url_options[:host]}/issues"
 ```
 
@@ -349,3 +349,16 @@ Controllable keys (with gem defaults):
 | `:'testing_project_items/results'` | `plan_my_stuff/testing_project_items/results` |
 | `:'webhooks/github'` | `plan_my_stuff/webhooks/github` |
 | `:'webhooks/aws'` | `plan_my_stuff/webhooks/aws` |
+
+### Parent controller
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `parent_controller` | `String` | `'::ApplicationController'` | Parent of `PlanMyStuff::ApplicationController`. |
+
+Set this in `config/initializers/plan_my_stuff.rb`; Rails resolves the superclass once at class definition, so the
+value must be set before the engine's controllers load.
+
+```ruby
+config.parent_controller = 'RawrApplicationController'
+```

data/app/controllers/plan_my_stuff/application_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PlanMyStuff
-  class ApplicationController < ::ApplicationController
+  class ApplicationController < PlanMyStuff.configuration.parent_controller.constantize
     protect_from_forgery with: :exception
     helper Rails.application.routes.url_helpers
 

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

@@ -101,7 +101,7 @@ PlanMyStuff.configure do |config|
   # number is appended to form `Issue#user_link`, which the gem also
   # writes as the visible body of the GitHub issue.
   # Recommended default:
-  #   url_options = Rails.application.config.action_mailer.default_url_options
+  #   url_options = Rails.application.routes.default_url_options
   #   config.issues_url_prefix =
   #     "#{url_options[:protocol] || 'http'}://#{url_options[:host]}/issues"
 
@@ -321,4 +321,11 @@ PlanMyStuff.configure do |config|
   #   :'testing_project_items/results'  => 'plan_my_stuff/testing_project_items/results'
   #   :'webhooks/github'                => 'plan_my_stuff/webhooks/github'
   #   :'webhooks/aws'                   => 'plan_my_stuff/webhooks/aws'
+
+  # --------------------------------------------------------------------------
+  # Parent controller
+  # --------------------------------------------------------------------------
+  # Parent class for PlanMyStuff::ApplicationController. Override when the
+  # consuming app does not use the `ApplicationController` name.
+  # config.parent_controller = 'MyOtherApplicationController'
 end

data/lib/plan_my_stuff/base_project_extractions/graphql_hydration.rb

@@ -129,6 +129,7 @@ module PlanMyStuff
           content = item[:content] || {}
           field_values = item.dig(:fieldValues, :nodes) || []
           repo_name = content.dig(:repository, :nameWithOwner)
+          assignee_nodes = content.dig(:assignees, :nodes) || []
 
           {
             id: item[:id],
@@ -142,6 +143,7 @@ module PlanMyStuff
             repo: repo_name.present? ? PlanMyStuff::Repo.resolve!(repo_name) : nil,
             status: extract_item_status(field_values),
             field_values: parse_field_values(field_values),
+            assignees: assignee_nodes.pluck(:login).compact,
             updated_at: item[:updatedAt],
             github_response: item,
           }
@@ -168,7 +170,7 @@ module PlanMyStuff
             field_name = fv.dig(:field, :name)
             next unless field_name
 
-            value = fv[:name] || fv[:text]
+            value = fv[:name] || fv[:text] || fv[:date]&.to_date
             users_node = fv[:users]
             if users_node
               value = (users_node[:nodes] || []).map { |u| u[:login] }

data/lib/plan_my_stuff/base_project_item.rb

@@ -46,6 +46,8 @@ module PlanMyStuff
     attribute :updated_at, :datetime
     # @return [Hash]
     attribute :field_values, default: -> { {} }
+    # @return [Array<String>] GitHub logins assigned to the underlying Issue, PullRequest, or DraftIssue
+    attribute :assignees, default: -> { [] }
     # @return [PlanMyStuff::BaseProject, nil]
     attribute :project
     # @return [PlanMyStuff::Issue, nil] linked issue (nil for draft items)
@@ -75,6 +77,7 @@ module PlanMyStuff
           status: item_hash[:status],
           updated_at: item_hash[:updated_at],
           field_values: item_hash[:field_values] || {},
+          assignees: item_hash[:assignees] || [],
           project: project,
         )
 

data/lib/plan_my_stuff/configuration.rb

@@ -227,6 +227,16 @@ module PlanMyStuff
     #
     attr_accessor :controllers
 
+    # Parent class string for +PlanMyStuff::ApplicationController+. Defaults to +'::ApplicationController'+. Override
+    # when the consuming app does not use the +ApplicationController+ name (e.g. +'ActionController::Base'+,
+    # +'RawrApplicationController'+). Must be set before the gem's controllers load - the standard
+    # +config/initializers/plan_my_stuff.rb+ location is correct, since Rails resolves the superclass once at class
+    # definition time.
+    #
+    # @return [String]
+    #
+    attr_accessor :parent_controller
+
     # Whether to use Rails.cache for ETag-based HTTP caching of GitHub reads. Defaults to true; set to false to bypass
     # the cache entirely.
     #
@@ -361,6 +371,7 @@ module PlanMyStuff
       @production_branch = 'production'
       @mount_groups = { webhooks: true, issues: true, projects: true }
       @controllers = {}
+      @parent_controller = '::ApplicationController'
       @cache_enabled = true
       @github_login_for = {}
       @reminders_enabled = true

data/lib/plan_my_stuff/graphql/queries.rb

@@ -63,7 +63,7 @@ module PlanMyStuff
         }
       GRAPHQL
 
-      FIND_PROJECT = <<~GRAPHQL
+      FIND_PROJECT = <<~GRAPHQL.freeze
         query($org: String!, $number: Int!, $cursor: String) {
           organization(login: $org) {
             projectV2(number: $number) {
@@ -95,7 +95,7 @@ module PlanMyStuff
                   }
                 }
               }
-              items(first: 100, after: $cursor) {
+              items(first: #{PlanMyStuff::BaseProject::ITEMS_PER_PAGE}, after: $cursor) {
                 pageInfo {
                   hasNextPage
                   endCursor
@@ -112,6 +112,7 @@ module PlanMyStuff
                       url
                       state
                       repository { nameWithOwner }
+                      assignees(first: 10) { nodes { login } }
                     }
                     ... on PullRequest {
                       id
@@ -120,11 +121,13 @@ module PlanMyStuff
                       url
                       state
                       repository { nameWithOwner }
+                      assignees(first: 10) { nodes { login } }
                     }
                     ... on DraftIssue {
                       id
                       title
                       body
+                      assignees(first: 10) { nodes { login } }
                     }
                   }
                   fieldValues(first: 20) {
@@ -145,6 +148,14 @@ module PlanMyStuff
                           }
                         }
                       }
+                      ... on ProjectV2ItemFieldDateValue {
+                        date
+                        field {
+                          ... on ProjectV2Field {
+                            name
+                          }
+                        }
+                      }
                       ... on ProjectV2ItemFieldUserValue {
                         users(first: 10) {
                           nodes {

data/lib/plan_my_stuff/issue.rb

@@ -290,17 +290,8 @@ module PlanMyStuff
         params = { state: state.to_s, page: page, per_page: per_page }
         params[:labels] = labels.sort.join(',') if labels.present?
 
-        cached = PlanMyStuff::Cache.read_list(:issue, resolved_repo, params)
-        request_options = cached ? params.merge(headers: { 'If-None-Match' => cached[:etag] }) : params
-
-        github_issues = client.rest(:list_issues, resolved_repo, **request_options)
-
-        if cached && not_modified?(client)
-          return cached[:body].map { |gi| build(gi, repo: resolved_repo) }
-        end
-
+        github_issues = client.rest(:list_issues, resolved_repo, **params)
         filtered = github_issues.reject { |gi| gi.respond_to?(:pull_request) && gi.pull_request }
-        store_list_etag_to_cache(client, :issue, resolved_repo, params, filtered)
         filtered.map { |gi| build(gi, repo: resolved_repo) }
       end
 

data/lib/plan_my_stuff/test_helpers.rb

@@ -3,17 +3,25 @@
 require 'plan_my_stuff'
 
 module PlanMyStuff
-  # Test support for consuming apps. Provides:
+  # Test support for apps that *consume* PlanMyStuff. Provides:
   # - `PlanMyStuff.test_mode!` to stub all API calls
   # - Factory-style builders: `build_issue`, `build_comment`, `build_project`
   # - RSpec matchers: `expect_pms_issue_created`, `expect_pms_comment_created`, `expect_pms_item_moved`
   #
-  # Usage:
+  # Usage (in a consuming Rails app):
   #   require 'plan_my_stuff/test_helpers'
   #
   #   RSpec.configure do |config|
   #     config.include PlanMyStuff::TestHelpers
   #   end
+  #
+  # Not the harness for PlanMyStuff's own unit specs. Gem-internal specs go
+  # through VCR cassettes against a real GitHub sandbox (see `spec/support/vcr.rb`
+  # and the `:pms_vcr_configured` shared context). Calling `PlanMyStuff.test_mode!`
+  # inside the gem would monkey-patch the very class methods the cassettes were
+  # recorded against, defeating the VCR coverage. The builder utilities
+  # (`build_issue`, `build_comment`, `build_project`, `stub_approvals`) are safe
+  # to use inside the gem as plain factories - they don't replace any methods.
   module TestHelpers
     # Recorded actions during test mode, keyed by type:
     #   :issue_created, :comment_created, :item_moved

data/lib/plan_my_stuff/verifier.rb

@@ -23,6 +23,7 @@ module PlanMyStuff
       check_organization
       check_repos
       check_default_project
+      check_parent_controller
       self
     end
 
@@ -80,6 +81,15 @@ module PlanMyStuff
         @results << Result.new("Repo :#{key}", false, "#{full_name}: #{e.message}")
       end
 
+      # @return [void]
+      def check_parent_controller
+        parent = PlanMyStuff.configuration.parent_controller.to_s
+        klass = parent.constantize
+        @results << Result.new('Parent controller', true, "#{parent} resolved to #{klass}")
+      rescue NameError => e
+        @results << Result.new('Parent controller', false, "#{parent.inspect}: #{e.message}")
+      end
+
       # @return [void]
       def check_default_project
         project_number = PlanMyStuff.configuration.default_project_number

data/lib/plan_my_stuff/version.rb

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

data/lib/tasks/plan_my_stuff.rake

@@ -193,6 +193,32 @@ namespace :plan_my_stuff do
     end
   end
 
+  desc 'Print all GitHub primary rate-limit buckets for the configured token. ' \
+    'Note: secondary/abuse limits and content-creation limits are NOT surfaced by GitHub ' \
+    'until you hit them, so a healthy report here does not guarantee writes will succeed.'
+  task rate_limit: :environment do
+    data = PlanMyStuff.client.rest(:get, '/rate_limit').to_h
+    resources = data[:resources] || {}
+
+    width = resources.keys.map { |k| k.to_s.length }.max || 0
+    resources.sort.each do |name, bucket|
+      next if bucket[:used].zero?
+
+      reset_at = Time.at(bucket[:reset]).utc
+      reset_in = [bucket[:reset] - Time.now.to_i, 0].max
+      puts(format(
+        '%-*s  used=%-5d remaining=%-5d limit=%-5d resets_at=%s (in %ds)',
+        width,
+        name,
+        bucket[:used],
+        bucket[:remaining],
+        bucket[:limit],
+        reset_at.iso8601,
+        reset_in,
+      ))
+    end
+  end
+
   desc 'Verify PlanMyStuff configuration: token, org, repos, and project access'
   task verify: :environment do
     require 'plan_my_stuff/verifier'

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.5
 platform: ruby
 authors:
 - Brands Insurance
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +44,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 10.0.0
+description:
 email:
 - documents@brandsinsurance.com
 executables: []
@@ -206,7 +208,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Shared PMS
 test_files: []