plan_my_stuff 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 782add7d506a645b1f2c19c413de0ef21c91d31a91e07280c003523767a48368
-  data.tar.gz: c20c6aa1e5f98d297cfbcbae5c57c7c5d13dd24b746d26374294196e50b983a5
+  metadata.gz: fe4f92dc92eca010b6fc7f53f4ce7701c6852420c9a537fdf0902e591c3309ad
+  data.tar.gz: b167fd42a3b5a37fc897bebf8f3696ed2cd863ac7049359445a329d9a7861988
 SHA512:
-  metadata.gz: bfcd02d86fa108d59ba15c75b3a7741c0d5c6c2cac701ac785d5d73aeee57025926910785383f5eac0f0c9fdb63ef32a9f72e2174e55ce0cf0c69dcac0c96f00
-  data.tar.gz: 8439a857e4d4a170b3802cbe34e040e940915c2b07dca61ea0cf9cd2e9a2995f7b02d447318ecda24ad8891ec080b6b2317a9b9e4b471dd11862002064b3ea19
+  metadata.gz: 746332e19a507f81dc0ee902a87664dcb0a55e3170d688d878b14faf508bfb67cc5dd3236a4961c6b15768fd47e7489b6b0cdbe5bdd5d328bcf9836f805d561d
+  data.tar.gz: 26a20b3318c99f34360bba90eee5698242f4043043991bf53d59e55b2507516452a5094c14366b19f6f53a140ff0b8a41f326a7048c13c4077f447eb2a083513

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.17.0
+
+### Added
+
+- `PlanMyStuff.deprecator` returns a gem-scoped `ActiveSupport::Deprecation` instance.
+  Consuming apps can silence, filter, or re-route PMS deprecation warnings independently
+  of Rails' own deprecator.
+
+### Changed
+
+- Issue, comment, and project-readme metadata is now stored in a visible `<details>` block
+  with a JSON code fence instead of a hidden HTML comment. GitHub renders the block in-page
+  so the metadata is inspectable without opening the body editor (closes #58).
+  `MetadataParser.parse` still accepts the legacy `<!-- pms-metadata:... -->` format and
+  emits a deprecation warning when it sees one; pre-0.17.0 bodies keep parsing and
+  re-serialize to the new format on their next write. Legacy detection will be removed
+  in 1.0.0.
+
 ## 0.16.0
 
 ### Added

data/lib/plan_my_stuff/metadata_parser.rb

@@ -1,10 +1,26 @@
 # frozen_string_literal: true
 
+require 'active_support/deprecation'
 require 'json'
 
 module PlanMyStuff
   module MetadataParser
-    METADATA_PATTERN = /\A<!-- pms-metadata:(.*?) -->\n*/m
+    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.
+    METADATA_PATTERN = %r{
+      \A<details><summary>pms-metadata</summary>\n\n
+      ```json\n(.*?)\n```\n\n
+      </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
 
@@ -17,11 +33,14 @@ module PlanMyStuff
     def parse(raw_body)
       return { metadata: {}, body: '' } if raw_body.blank?
 
-      match = raw_body.match(METADATA_PATTERN)
-      return { metadata: {}, body: raw_body } if match.nil?
+      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)
       metadata = JSON.parse(match[1], symbolize_names: true)
-      body = raw_body.sub(METADATA_PATTERN, '')
+      body = raw_body.sub(pattern, '')
 
       { metadata: metadata, body: body }
     rescue JSON::ParserError
@@ -44,12 +63,21 @@ module PlanMyStuff
 
       json =
         if metadata.is_a?(PlanMyStuff::CustomFields)
-          metadata.to_json
+          JSON.pretty_generate(metadata.to_h)
         else
           JSON.pretty_generate(metadata)
         end
 
-      "<!-- pms-metadata:#{json} -->\n\n#{body}"
+      "<details><summary>pms-metadata</summary>\n\n```json\n#{json}\n```\n\n</details>\n\n#{body}"
+    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

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

data/lib/plan_my_stuff.rb

@@ -38,6 +38,11 @@ module PlanMyStuff
       @configuration ||= PlanMyStuff::Configuration.new
     end
 
+    # @return [ActiveSupport::Deprecation]
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new('1.0', 'PlanMyStuff')
+    end
+
     # @return [PlanMyStuff::Configuration]
     def configure
       yield(configuration)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Brands Insurance