plan_my_stuff 0.30.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf390e409623eaacc5e3dcd727984ed93212cdc23847fc9a848de150d1c025af
-  data.tar.gz: 70eeabeadf4d593c5a97806ad013e24da2175123e4f6e5bf071b3beee9da2937
+  metadata.gz: fb9b79b7a7ef0890f6cfe2d4be9f5886afaaeec2a032e11fc44b0948a41c680b
+  data.tar.gz: 6582b1c90d2a78dd0c07e7789efba2d1938f6ce62c0a986778d0001e1c073ea5
 SHA512:
-  metadata.gz: 928aa5abb220e785a6bb04586645af1a5bdc0c3a889f49d08ddc4882ecb0b21f5aa0bf53a724749d2458905ad58da4a116e09e31aeb59686ddeda1b16f53b9e1
-  data.tar.gz: 66d5e0ec45da7e3b5ed2e9d2a0e1a088012008a5bca1ff5dd4773d66fd3d84ad08ffb977c29ff9276611d011b25a543464d00c0063fda29786a6610d27c6166f
+  metadata.gz: 9e2c0221e7396240f4b5452b000caae6c5a180b474250c2dedebb8e4a899e5c7c6eccad178a242858f1e5a2f04a37c778c23b4a7f973198db59e4c8d8aa04ea6
+  data.tar.gz: c91d0a3aec30798acff56582232baa332c1e556a98e78844ea7c05ff82abde81e65e953c56a6ac3c248be33c789030963b7918fe1fc5a1286ab5d40fe5196837

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 1.0.1
+
+### Fixed
+
+- `eager_load_controllers_on_boot` no longer crashes host-app boot with `NameError: uninitialized constant
+  PlanMyStuff::Issues` when `config.eager_load` is `false` (dev/test/console/rake) on zeitwerk 2.6.x, as shipped with
+  Rails 7.1. The engine now requires its controller files directly instead of driving zeitwerk's `eager_load_dir`,
+  which fails to register child autoloads on the gem-defined `PlanMyStuff` namespace on those versions (closes #104).
+
+## 1.0.0
+
+Official release.
+
+### Breaking
+
+- `MetadataParser.parse` no longer recognizes the legacy `<!-- pms-metadata:... -->` HTML-comment format.
+  Bodies written before 0.17.0 that have not been re-saved will now be returned as plain body text with
+  empty metadata. The deprecation warning emitted by 0.17.0+ has been removed along with the legacy
+  pattern.
+- Removed the deprecated `IssueMetadata#priority_list`, `#priority_list=`, `#priority_list?`,
+  `#priority_list_priority`, and `#priority_list_priority=` accessors, along with the legacy-write forwarding
+  that turned `metadata.priority_list = true` into `Priority List` / `Priority List Priority` issue-field writes
+  on `save!` / `update!` / `create!`. Use `Issue#priority_list?` / `#priority_list_priority` for reads and
+  `Issue#add_to_priority_list!(priority: N)` / `#remove_from_priority_list!` for writes (closes #57).
+- `CommentMetadata` no longer parses the legacy `{filename, url}` attachment shape into structured fields.
+  Entries must now carry the `{filename, owner, repo, sha, path}` shape; legacy entries that were never
+  re-saved are dropped as malformed. The `LEGACY_URL_REGEXES` / `LEGACY_ATTACHMENT_DEPRECATION_MESSAGE`
+  constants and the migrate-on-write deprecation warning have been removed.
+
 ## 0.30.0
 
 ### Added

data/README.md

@@ -612,12 +612,20 @@ Cache keys include both the gem's `CACHE_VERSION` ("v1") and `config.cache_versi
 
 ## Metadata
 
-All state lives on GitHub. Each domain class carries a typed metadata object hidden in the corresponding GitHub body (issue/comment body, project readme) as an HTML comment that's invisible when rendered on github.com:
+All state lives on GitHub. Each domain class carries a typed metadata object embedded in the corresponding GitHub
+body (issue/comment body, project readme) as a collapsible `<details>` block containing a JSON code fence, which
+GitHub renders in-page:
 
-```html
-<!-- pms-metadata:{"schema_version":1,"gem_version":"0.0.0","app_name":"MyApp",...} -->
+````markdown
+<details><summary>pms-metadata</summary>
+
+```json
+{"schema_version":1,"gem_version":"0.0.0","app_name":"MyApp", ...}
 ```
 
+</details>
+````
+
 `MetadataParser` strips the block out of the raw body on read and re-inserts it on write — callers see `issue.body` (human text) and `issue.metadata` (typed object) separately.
 
 ### Metadata classes

data/lib/plan_my_stuff/comment_metadata.rb

@@ -2,17 +2,6 @@
 
 module PlanMyStuff
   class CommentMetadata < PlanMyStuff::BaseMetadata
-    LEGACY_URL_REGEXES = [
-      %r{\Ahttps://raw\.githubusercontent\.com/(?<owner>[^/\s]+)/(?<repo>[^/\s]+)/(?<sha>[^/\s]+)/(?<path>.+)\z},
-      %r{\Ahttps://github\.com/(?<owner>[^/\s]+)/(?<repo>[^/\s]+)/blob/(?<sha>[^/\s]+)/(?<path>.+)\z},
-    ].freeze
-
-    LEGACY_ATTACHMENT_DEPRECATION_MESSAGE =
-      'PlanMyStuff: legacy attachment metadata shape {filename, url} detected. It will continue to parse ' \
-        'until 1.0.0, at which point legacy detection will be removed. New writes use the structured ' \
-        '{filename, owner, repo, sha, path} shape introduced in #70; existing entries migrate on their ' \
-        'next write.'
-
     # @return [Boolean] true if this comment holds the issue's body content
     attr_accessor :issue_body
     # @return [Array<PlanMyStuff::Attachment>] consuming-app attachment records associated with this comment
@@ -95,11 +84,7 @@ module PlanMyStuff
       # Builds a +PlanMyStuff::Attachment+ from each parsed entry.
       # Accepts:
       # - an existing +PlanMyStuff::Attachment+
-      # - the new shape +{filename:, owner:, repo:, sha:, path:}+
-      # - the legacy shape +{filename:, url:}+ where +url+ is a raw
-      #   +raw.githubusercontent.com+ permalink or a +github.com/.../blob/...+
-      #   blob-viewer URL; parsed once into structured fields so the
-      #   next write drops the +url+ key (migrate-on-write).
+      # - the structured shape +{filename:, owner:, repo:, sha:, path:}+
       #
       # Malformed hash entries are silently dropped so a single bad
       # historical entry doesn't crash +Comment.find+. An already-
@@ -118,45 +103,17 @@ module PlanMyStuff
             if entry.is_a?(PlanMyStuff::Attachment)
               entry
             elsif entry.respond_to?(:transform_keys)
-              PlanMyStuff::Attachment.new(structured_attrs(entry.transform_keys(&:to_sym)))
+              PlanMyStuff::Attachment.new(entry.transform_keys(&:to_sym))
             end
           next if attachment.nil?
 
           attachment.validate!
           attachment
-        rescue ActiveModel::ValidationError, ArgumentError
+        rescue ActiveModel::ValidationError, ActiveModel::UnknownAttributeError, ArgumentError
           raise if entry.is_a?(PlanMyStuff::Attachment)
 
           next
         end
       end
-
-      # Returns +attrs+ untouched when it already carries structured
-      # fields, otherwise parses a legacy +url+ into
-      # +owner+/+repo+/+sha+/+path+. Unparseable URLs yield a hash
-      # with no structured fields, leaving +Attachment+ validation to
-      # drop the entry.
-      #
-      # @param attrs [Hash{Symbol=>Object}]
-      #
-      # @return [Hash{Symbol=>Object}]
-      #
-      def structured_attrs(attrs)
-        return attrs if attrs.key?(:owner)
-
-        PlanMyStuff.deprecator.warn(LEGACY_ATTACHMENT_DEPRECATION_MESSAGE)
-
-        url = attrs[:url].to_s
-        match = LEGACY_URL_REGEXES.lazy.filter_map { |re| re.match(url) }.first
-
-        return attrs.except(:url) if match.nil?
-
-        attrs.except(:url).merge(
-          owner: match[:owner],
-          repo: match[:repo],
-          sha: match[:sha],
-          path: match[:path],
-        )
-      end
   end
 end

data/lib/plan_my_stuff/engine.rb

@@ -10,14 +10,15 @@ module PlanMyStuff
     config.after_initialize do
       next unless PlanMyStuff.configuration.eager_load_controllers_on_boot
 
+      # Require the controller files directly rather than going through zeitwerk's +eager_load_dir+ /
+      # +eager_load_namespace+. +PlanMyStuff+ is an external namespace pre-defined by the gem's +lib/+, and some
+      # zeitwerk versions (notably 2.6.12, shipped with Rails 7.1) never register child autoloads on it. On those
+      # versions the namespace-aware loaders raise +NameError+ descending into +PlanMyStuff::Issues+ / +::Webhooks+
+      # -- and so does a plain +constantize+. Requiring the files defines the constants directly and works on every
+      # supported zeitwerk version: zeitwerk's +require+ decoration keeps its bookkeeping in sync on versions that do
+      # manage these files, and in eager-loading hosts the files are already loaded so +require+ is a no-op.
       controllers_dir = File.expand_path('../../app/controllers', __dir__)
-      loader = Rails.autoloaders.main
-
-      if loader.respond_to?(:eager_load_dir)
-        loader.eager_load_dir(controllers_dir)
-      else
-        Dir.glob(File.join(controllers_dir, '**/*.rb')).each { |path| require path }
-      end
+      Dir.glob(File.join(controllers_dir, '**/*.rb')).each { |path| require(path) }
     end
   end
 end

data/lib/plan_my_stuff/issue.rb

@@ -901,8 +901,6 @@ module PlanMyStuff
     # @return [self]
     #
     def save!(user: nil, skip_notification: false)
-      forward_legacy_priority_list_metadata!
-
       if new_record?
         created = self.class.create!(
           title: title,
@@ -1243,28 +1241,6 @@ module PlanMyStuff
         reload
       end
 
-      # Forwards a pending legacy +metadata.priority_list+ /
-      # +#priority_list_priority+ write into +@pending_issue_fields+ so the next
-      # +save!+ persists the values into the +Priority List+ /
-      # +Priority List Priority+ GitHub Issue Fields. Caller-supplied
-      # +issue_fields:+ entries win on key collision. Silently skipped when
-      # +config.issue_fields_enabled+ is +false+.
-      #
-      # @return [void]
-      #
-      def forward_legacy_priority_list_metadata!
-        return unless PlanMyStuff.configuration.issue_fields_enabled
-        return unless metadata.instance_variable_get(:@legacy_priority_list_pending)
-
-        legacy_pl = metadata.instance_variable_get(:@priority_list)
-        legacy_plp = metadata.instance_variable_get(:@priority_list_priority)
-
-        legacy_fields = { 'Priority List' => legacy_pl ? 'Yes' : nil }
-        legacy_fields['Priority List Priority'] = legacy_plp unless legacy_plp == -1
-
-        @pending_issue_fields = legacy_fields.merge(@pending_issue_fields || {})
-      end
-
       # Applies in-memory updates from an +update!+ kwargs hash. Top-level scalars go through their setters so
       # +@body_dirty+ and friends stay in sync; +metadata:+ is merged into +@metadata+ (top-level attrs assigned
       # directly, custom_fields merged key-by-key).

data/lib/plan_my_stuff/issue_metadata.rb

@@ -2,13 +2,6 @@
 
 module PlanMyStuff
   class IssueMetadata < PlanMyStuff::BaseMetadata
-    PRIORITY_LIST_METADATA_DEPRECATION =
-      'PlanMyStuff: IssueMetadata#priority_list / #priority_list_priority are deprecated. priority_list moved to ' \
-        "GitHub Issue Fields ('Priority List' single_select, 'Priority List Priority' number) in 0.20.0. Reads " \
-        'now come from Issue#priority_list? / #priority_list_priority; for writes, use ' \
-        'Issue#add_to_priority_list!(priority: N) and Issue#remove_from_priority_list!. The metadata accessors ' \
-        'will be removed in 1.0.0.'
-
     # @return [Time, nil] first support action timestamp, nil until set
     attr_accessor :responded_at
     # @return [String, nil] user-facing URL in the consuming app
@@ -53,14 +46,6 @@ module PlanMyStuff
 
         metadata.responded_at = parse_time(hash[:responded_at])
         metadata.issues_url = hash[:issues_url]
-        if hash.key?(:priority_list) || hash.key?(:priority_list_priority)
-          PlanMyStuff.deprecator.warn(PRIORITY_LIST_METADATA_DEPRECATION)
-          metadata.instance_variable_set(:@priority_list, hash[:priority_list]) if hash.key?(:priority_list)
-          if hash.key?(:priority_list_priority)
-            metadata.instance_variable_set(:@priority_list_priority, hash[:priority_list_priority])
-          end
-          metadata.instance_variable_set(:@legacy_priority_list_pending, true)
-        end
         metadata.visibility_allowlist = Array.wrap(hash[:visibility_allowlist])
         metadata.commit_sha = hash[:commit_sha]
         metadata.auto_complete = hash.fetch(:auto_complete, true)
@@ -193,57 +178,6 @@ module PlanMyStuff
       !!auto_complete
     end
 
-    # @deprecated Use +Issue#priority_list?+. Removed in 1.0.0.
-    #
-    # @return [Object, nil]
-    #
-    def priority_list
-      PlanMyStuff.deprecator.warn(PRIORITY_LIST_METADATA_DEPRECATION)
-      @priority_list
-    end
-
-    # @deprecated Use +Issue#add_to_priority_list!(priority: N)+ / +Issue#remove_from_priority_list!+. Removed in 1.0.0.
-    #
-    # @param value [Object]
-    #
-    # @return [Object]
-    #
-    def priority_list=(value)
-      PlanMyStuff.deprecator.warn(PRIORITY_LIST_METADATA_DEPRECATION)
-      @legacy_priority_list_pending = true
-      @priority_list = value
-    end
-
-    # @deprecated Use +Issue#priority_list?+. Removed in 1.0.0.
-    #
-    # @return [Boolean]
-    #
-    def priority_list?
-      PlanMyStuff.deprecator.warn(PRIORITY_LIST_METADATA_DEPRECATION)
-      !!@priority_list
-    end
-
-    # @deprecated Use +Issue#priority_list_priority+. Removed in 1.0.0.
-    #
-    # @return [Object, nil]
-    #
-    def priority_list_priority
-      PlanMyStuff.deprecator.warn(PRIORITY_LIST_METADATA_DEPRECATION)
-      @priority_list_priority
-    end
-
-    # @deprecated Use +Issue#add_to_priority_list!(priority: N)+ / +Issue#remove_from_priority_list!+. Removed in 1.0.0.
-    #
-    # @param value [Object]
-    #
-    # @return [Object]
-    #
-    def priority_list_priority=(value)
-      PlanMyStuff.deprecator.warn(PRIORITY_LIST_METADATA_DEPRECATION)
-      @legacy_priority_list_pending = true
-      @priority_list_priority = value
-    end
-
     # @return [Boolean]
     def responded?
       !responded_at.nil?

data/lib/plan_my_stuff/metadata_parser.rb

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
-require 'active_support/deprecation'
 require 'json'
 
 module PlanMyStuff
   module MetadataParser
-    LEGACY_DEPRECATION_MESSAGE =
-      'PlanMyStuff: legacy <!-- pms-metadata: ... --> body format detected. It will continue to parse ' \
-        'until 1.0.0, at which point legacy detection will be removed. New writes already use the visible ' \
-        '<details> block format introduced in 0.17.0; existing bodies migrate on their next write.'
-
-    # New format: collapsible <details> block containing a JSON code fence.
-    # Renders visibly on GitHub (issue #58) instead of being hidden in an HTML comment.
+    # Collapsible <details> block containing a JSON code fence. Renders visibly on
+    # GitHub (issue #58) instead of being hidden in an HTML comment.
     METADATA_PATTERN = %r{
       \A<details><summary>pms-metadata</summary>\n\n
       ```json\n(.*?)\n```\n\n
@@ -27,10 +21,6 @@ module PlanMyStuff
       </details>\n*
     }mx
 
-    # Legacy format kept for parsing only - existing issues serialized before 0.17.0
-    # used a hidden HTML comment. They migrate to the new format on the next write.
-    LEGACY_METADATA_PATTERN = /\A<!-- pms-metadata:(.*?) -->\n*/m
-
     module_function
 
     # Extracts metadata JSON from the raw body
@@ -41,15 +31,11 @@ module PlanMyStuff
     #
     def parse(raw_body)
       return { metadata: {}, body: '' } if raw_body.blank?
+      return { metadata: {}, body: raw_body } unless raw_body.match?(METADATA_PATTERN)
 
-      pattern = matching_pattern(raw_body)
-      return { metadata: {}, body: raw_body } if pattern.nil?
-
-      PlanMyStuff.deprecator.warn(LEGACY_DEPRECATION_MESSAGE) if pattern == LEGACY_METADATA_PATTERN
-
-      match = raw_body.match(pattern)
+      match = raw_body.match(METADATA_PATTERN)
       metadata = JSON.parse(match[1], symbolize_names: true)
-      body = raw_body.sub(pattern, '').sub(ATTACHMENTS_PATTERN, '')
+      body = raw_body.sub(METADATA_PATTERN, '').sub(ATTACHMENTS_PATTERN, '')
 
       { metadata: metadata, body: body }
     rescue JSON::ParserError
@@ -102,14 +88,5 @@ module PlanMyStuff
       safe_filename = attachment[:filename].to_s.gsub(']', '\]')
       "- [#{safe_filename}](#{url})"
     end
-
-    # @param raw_body [String]
-    #
-    # @return [Regexp, nil] the pattern that matches at the start of +raw_body+, or +nil+ when neither matches
-    #
-    def matching_pattern(raw_body)
-      return METADATA_PATTERN if raw_body.match?(METADATA_PATTERN)
-      return LEGACY_METADATA_PATTERN if raw_body.match?(LEGACY_METADATA_PATTERN)
-    end
   end
 end

data/lib/plan_my_stuff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brands Insurance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-29 00:00:00.000000000 Z
+date: 2026-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails