plan_my_stuff 0.9.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6457257ef431e923519943cd227ffc70488b023467253873e20f52c47fd75f52
-  data.tar.gz: b5a16da4dc6c6c3ce45b307879f5146720f2b878809b7a071b7cc9e33986d210
+  metadata.gz: f89dac35aac34b782834f0f282cff8670d5aa5898c70d40bba296713c277b8dc
+  data.tar.gz: f065369ec7bbec7b04aa1908bc147b53b9e1041cd0ddea6c4888fe76166289ee
 SHA512:
-  metadata.gz: efee5f594d9bd014b0ce575781790768a8d51277010d9ad9902ac11beea06c17d39232d65a77532768326eccece3ebcbe3bdb18c464341c963eda9b12b1d6075
-  data.tar.gz: ef94bc70d08874c2347e243d0f7967ca7bca2e631cda775494a714df6501d22fe5011a09db805dbb53f5fe8397eb32b8bdf19bbf8a235da39d3f5dd4810c011a
+  metadata.gz: 3d9e2fd53f3a4c81091253c5b10b8af9ea89ae2ca6db713f0545f814e67e4ee5a72e2a8fc53b570aeaaf16219aff0e7104d8ce6611adb612da0772560251bb94
+  data.tar.gz: 2d07daa9e21da4cb72ff55796db32de43ed86627d8e2bfab5311472b81c4db4d323573556a5a22f7d4cb4751675b2f6b0e6fc08998abda6e07b25d36be21bbc2

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.10.1
+
+### Changed
+
+- Nothing, just a version bump
+
+## 0.10.0
+
+### Changed
+
+- `Issue` slimmed from 1791 to 911 lines by extracting feature clusters into per-feature modules under a sibling
+  `PlanMyStuff::IssueExtractions::*` namespace, included into `Issue`. Public API unchanged (`issue.approve!`,
+  `issue.add_related!`, `issue.enter_waiting_on_user!`, `issue.add_viewers!`, etc. still resolve to the same methods).
+  - `PlanMyStuff::IssueExtractions::Approvals` - `lib/plan_my_stuff/issue_extractions/approvals.rb`
+  - `PlanMyStuff::IssueExtractions::Links` - `lib/plan_my_stuff/issue_extractions/links.rb`
+  - `PlanMyStuff::IssueExtractions::Waiting` - `lib/plan_my_stuff/issue_extractions/waiting.rb`
+  - `PlanMyStuff::IssueExtractions::Viewers` - `lib/plan_my_stuff/issue_extractions/viewers.rb`
+- `BaseProject` slimmed from 661 to 504 lines by extracting GraphQL hydration helpers into
+  `PlanMyStuff::BaseProjectExtractions::GraphqlHydration` (`lib/plan_my_stuff/base_project_extractions/graphql_hydration.rb`),
+  included into `BaseProject`'s singleton class. `BaseProject.find` / `BaseProject.list` remain public entry points.
+- Specs for `Issue` features now live alongside the modules at `spec/plan_my_stuff/issue_extractions/<feature>_spec.rb`.
+
 ## 0.9.0
 
 ### Breaking

data/lib/plan_my_stuff/base_project.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'base_project_extractions/graphql_hydration'
+
 module PlanMyStuff
   # Shared base for GitHub Projects V2 wrappers. Holds attribute definitions, generic find/list/update machinery,
   # hydration, and instance helpers. Concrete subclasses (Project, TestingProject) add their own +create!+ behavior
@@ -43,6 +45,8 @@ module PlanMyStuff
     attribute :has_next_page
 
     class << self
+      include PlanMyStuff::BaseProjectExtractions::GraphqlHydration
+
       # Generic find - returns whichever concrete project type is at the given number, dispatching on metadata kind.
       # Subclasses may override to apply filtering (e.g. Project raises for testing projects by default).
       #
@@ -180,47 +184,6 @@ module PlanMyStuff
 
       private
 
-        # Builds a summary Project from a list query node. Dispatches to TestingProject when the readme metadata has
-        # kind: "testing".
-        #
-        # @param node [Hash]
-        #
-        # @return [PlanMyStuff::BaseProject]
-        #
-        def build_summary(node)
-          raw_readme = node[:readme] || ''
-          parsed_meta = PlanMyStuff::MetadataParser.parse(raw_readme)
-          klass = dispatch_project_class(parsed_meta[:metadata])
-          project = klass.new
-          project.__send__(:hydrate_summary, node, raw_readme: raw_readme, parsed_meta: parsed_meta)
-          project
-        end
-
-        # Builds a detailed Project from a find query response. Dispatches to TestingProject when the readme metadata
-        # has kind: "testing".
-        #
-        # @param graphql_project [Hash]
-        # @param items [Array<Hash>]
-        # @param next_cursor [String, nil]
-        # @param has_next_page [Boolean, nil]
-        #
-        # @return [PlanMyStuff::BaseProject]
-        #
-        def build_detail(graphql_project, items:, next_cursor: nil, has_next_page: nil)
-          raw_readme = graphql_project[:readme] || ''
-          parsed_meta = PlanMyStuff::MetadataParser.parse(raw_readme)
-          klass = dispatch_project_class(parsed_meta[:metadata])
-          project = klass.new
-          project.__send__(
-            :hydrate_detail,
-            graphql_project,
-            items: items,
-            next_cursor: next_cursor,
-            has_next_page: has_next_page,
-          )
-          project
-        end
-
         # Returns the appropriate project class based on the metadata kind field. Always dispatches to a concrete
         # subclass (never BaseProject itself).
         #
@@ -234,140 +197,6 @@ module PlanMyStuff
           PlanMyStuff::Project
         end
 
-        # @param org [String]
-        # @param number [Integer]
-        #
-        # @return [PlanMyStuff::BaseProject]
-        #
-        def find_auto_paginated(org, number)
-          all_items = []
-          cursor = nil
-          raw_project = nil
-          page = nil
-
-          loop do
-            page = fetch_project_page(org, number, cursor)
-            raw_project ||= page[:raw]
-            all_items.concat(page[:items])
-
-            break if !page[:has_next_page] || all_items.length >= MAX_AUTO_PAGINATE_ITEMS
-
-            cursor = page[:next_cursor]
-          end
-
-          build_detail(
-            raw_project,
-            items: all_items,
-            next_cursor: page[:next_cursor],
-            has_next_page: page[:has_next_page],
-          )
-        end
-
-        # @param org [String]
-        # @param number [Integer]
-        # @param cursor [String, nil]
-        #
-        # @return [PlanMyStuff::BaseProject]
-        #
-        def find_with_cursor(org, number, cursor:)
-          page = fetch_project_page(org, number, cursor)
-          build_detail(
-            page[:raw],
-            items: page[:items],
-            next_cursor: page[:next_cursor],
-            has_next_page: page[:has_next_page],
-          )
-        end
-
-        # Fetches a single page of project data. Returns a lightweight hash for pagination loop consumption (not a
-        # Project instance).
-        #
-        # @param org [String]
-        # @param number [Integer]
-        # @param cursor [String, nil]
-        #
-        # @return [Hash] with :raw, :items, :next_cursor, :has_next_page
-        #
-        def fetch_project_page(org, number, cursor)
-          variables = { org: org, number: number }
-          variables[:cursor] = cursor if cursor
-
-          data = PlanMyStuff.client.graphql(
-            PlanMyStuff::GraphQL::Queries::FIND_PROJECT,
-            variables: variables,
-          )
-
-          raw_project = data.dig(:organization, :projectV2)
-          page_info = raw_project.dig(:items, :pageInfo) || {}
-          items_data = raw_project.dig(:items, :nodes) || []
-
-          {
-            raw: raw_project,
-            items: items_data.map { |item| parse_project_item(item) },
-            next_cursor: page_info[:endCursor],
-            has_next_page: page_info[:hasNextPage],
-          }
-        end
-
-        # @param item [Hash] raw GraphQL project item node
-        #
-        # @return [Hash]
-        #
-        def parse_project_item(item)
-          content = item[:content] || {}
-          field_values = item.dig(:fieldValues, :nodes) || []
-          repo_name = content.dig(:repository, :nameWithOwner)
-
-          {
-            id: item[:id],
-            type: item[:type],
-            content_node_id: content[:id],
-            title: content[:title],
-            body: content[:body],
-            number: content[:number],
-            url: content[:url],
-            state: content[:state],
-            repo: repo_name.present? ? PlanMyStuff::Repo.resolve!(repo_name) : nil,
-            status: extract_item_status(field_values),
-            field_values: parse_field_values(field_values),
-            updated_at: item[:updatedAt],
-            github_response: item,
-          }
-        end
-
-        # @param field_values [Array<Hash>]
-        #
-        # @return [String, nil]
-        #
-        def extract_item_status(field_values)
-          status_value = field_values.find { |fv| fv.dig(:field, :name) == 'Status' }
-
-          status_value&.dig(:name)
-        end
-
-        # @param field_values [Array<Hash>]
-        #
-        # @return [Hash]
-        #
-        def parse_field_values(field_values)
-          result = {}
-
-          field_values.each do |fv|
-            field_name = fv.dig(:field, :name)
-            next unless field_name
-
-            value = fv[:name] || fv[:text]
-            users_node = fv[:users]
-            if users_node
-              value = (users_node[:nodes] || []).map { |u| u[:login] }
-            end
-
-            result[field_name] = value
-          end
-
-          result
-        end
-
         # Resolves a project number to its node ID.
         #
         # @param org [String]

data/lib/plan_my_stuff/base_project_extractions/graphql_hydration.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module PlanMyStuff
+  module BaseProjectExtractions
+    module GraphqlHydration
+      private
+
+        # Builds a summary Project from a list query node. Dispatches to TestingProject when the readme metadata has
+        # kind: "testing".
+        #
+        # @param node [Hash]
+        #
+        # @return [PlanMyStuff::BaseProject]
+        #
+        def build_summary(node)
+          raw_readme = node[:readme] || ''
+          parsed_meta = PlanMyStuff::MetadataParser.parse(raw_readme)
+          klass = dispatch_project_class(parsed_meta[:metadata])
+          project = klass.new
+          project.__send__(:hydrate_summary, node, raw_readme: raw_readme, parsed_meta: parsed_meta)
+          project
+        end
+
+        # Builds a detailed Project from a find query response. Dispatches to TestingProject when the readme metadata
+        # has kind: "testing".
+        #
+        # @param graphql_project [Hash]
+        # @param items [Array<Hash>]
+        # @param next_cursor [String, nil]
+        # @param has_next_page [Boolean, nil]
+        #
+        # @return [PlanMyStuff::BaseProject]
+        #
+        def build_detail(graphql_project, items:, next_cursor: nil, has_next_page: nil)
+          raw_readme = graphql_project[:readme] || ''
+          parsed_meta = PlanMyStuff::MetadataParser.parse(raw_readme)
+          klass = dispatch_project_class(parsed_meta[:metadata])
+          project = klass.new
+          project.__send__(
+            :hydrate_detail,
+            graphql_project,
+            items: items,
+            next_cursor: next_cursor,
+            has_next_page: has_next_page,
+          )
+          project
+        end
+
+        # @param org [String]
+        # @param number [Integer]
+        #
+        # @return [PlanMyStuff::BaseProject]
+        #
+        def find_auto_paginated(org, number)
+          all_items = []
+          cursor = nil
+          raw_project = nil
+          page = nil
+
+          loop do
+            page = fetch_project_page(org, number, cursor)
+            raw_project ||= page[:raw]
+            all_items.concat(page[:items])
+
+            break if !page[:has_next_page] || all_items.length >= PlanMyStuff::BaseProject::MAX_AUTO_PAGINATE_ITEMS
+
+            cursor = page[:next_cursor]
+          end
+
+          build_detail(
+            raw_project,
+            items: all_items,
+            next_cursor: page[:next_cursor],
+            has_next_page: page[:has_next_page],
+          )
+        end
+
+        # @param org [String]
+        # @param number [Integer]
+        # @param cursor [String, nil]
+        #
+        # @return [PlanMyStuff::BaseProject]
+        #
+        def find_with_cursor(org, number, cursor:)
+          page = fetch_project_page(org, number, cursor)
+          build_detail(
+            page[:raw],
+            items: page[:items],
+            next_cursor: page[:next_cursor],
+            has_next_page: page[:has_next_page],
+          )
+        end
+
+        # Fetches a single page of project data. Returns a lightweight hash for pagination loop consumption (not a
+        # Project instance).
+        #
+        # @param org [String]
+        # @param number [Integer]
+        # @param cursor [String, nil]
+        #
+        # @return [Hash] with :raw, :items, :next_cursor, :has_next_page
+        #
+        def fetch_project_page(org, number, cursor)
+          variables = { org: org, number: number }
+          variables[:cursor] = cursor if cursor
+
+          data = PlanMyStuff.client.graphql(
+            PlanMyStuff::GraphQL::Queries::FIND_PROJECT,
+            variables: variables,
+          )
+
+          raw_project = data.dig(:organization, :projectV2)
+          page_info = raw_project.dig(:items, :pageInfo) || {}
+          items_data = raw_project.dig(:items, :nodes) || []
+
+          {
+            raw: raw_project,
+            items: items_data.map { |item| parse_project_item(item) },
+            next_cursor: page_info[:endCursor],
+            has_next_page: page_info[:hasNextPage],
+          }
+        end
+
+        # @param item [Hash] raw GraphQL project item node
+        #
+        # @return [Hash]
+        #
+        def parse_project_item(item)
+          content = item[:content] || {}
+          field_values = item.dig(:fieldValues, :nodes) || []
+          repo_name = content.dig(:repository, :nameWithOwner)
+
+          {
+            id: item[:id],
+            type: item[:type],
+            content_node_id: content[:id],
+            title: content[:title],
+            body: content[:body],
+            number: content[:number],
+            url: content[:url],
+            state: content[:state],
+            repo: repo_name.present? ? PlanMyStuff::Repo.resolve!(repo_name) : nil,
+            status: extract_item_status(field_values),
+            field_values: parse_field_values(field_values),
+            updated_at: item[:updatedAt],
+            github_response: item,
+          }
+        end
+
+        # @param field_values [Array<Hash>]
+        #
+        # @return [String, nil]
+        #
+        def extract_item_status(field_values)
+          status_value = field_values.find { |fv| fv.dig(:field, :name) == 'Status' }
+
+          status_value&.dig(:name)
+        end
+
+        # @param field_values [Array<Hash>]
+        #
+        # @return [Hash]
+        #
+        def parse_field_values(field_values)
+          result = {}
+
+          field_values.each do |fv|
+            field_name = fv.dig(:field, :name)
+            next unless field_name
+
+            value = fv[:name] || fv[:text]
+            users_node = fv[:users]
+            if users_node
+              value = (users_node[:nodes] || []).map { |u| u[:login] }
+            end
+
+            result[field_name] = value
+          end
+
+          result
+        end
+    end
+  end
+end