plan_my_stuff 0.8.0 → 0.10.0

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

data/lib/plan_my_stuff/base_project_item.rb

@@ -73,6 +73,7 @@ module PlanMyStuff
           repo: item_hash[:repo],
           state: item_hash[:state],
           status: item_hash[:status],
+          updated_at: item_hash[:updated_at],
           field_values: item_hash[:field_values] || {},
           project: project,
         )

data/lib/plan_my_stuff/comment.rb

@@ -32,6 +32,8 @@ module PlanMyStuff
     class << self
       # Creates a comment on a GitHub issue with PMS metadata and a visible header.
       #
+      # @raise [PlanMyStuff::LockedIssueError] if the parent issue is locked
+      #
       # @param issue [PlanMyStuff::Issue] parent issue
       # @param body [String]
       # @param user [Object, Integer] user object or user_id
@@ -41,8 +43,6 @@ module PlanMyStuff
       # @param waiting_on_reply [Boolean] when true and the author is a support user, marks the issue as waiting on
       #   an end-user reply. Ignored for non-support authors.
       #
-      # @raise [PlanMyStuff::LockedIssueError] if the parent issue is locked
-      #
       # @return [PlanMyStuff::Comment]
       #
       def create!(
@@ -279,7 +279,9 @@ module PlanMyStuff
         )
         hydrate_from_comment(created)
       else
-        update!(user: user, body: body)
+        update_attrs = { user: user, body: body }
+        update_attrs[:visibility] = visibility if visibility_changed?
+        update!(**update_attrs)
       end
 
       self

data/lib/plan_my_stuff/configuration.rb

@@ -84,19 +84,6 @@ module PlanMyStuff
     #
     attr_accessor :markdown_options
 
-    # Proc returning boolean, or nil (always send). When it returns false the request is deferred to a background job
-    # instead of hitting GitHub.
-    #
-    # @return [Proc, nil]
-    #
-    attr_accessor :should_send_request
-
-    # Map of action type to job class name for deferred requests. Keys: :create_ticket, :post_comment, :update_status.
-    #
-    # @return [Hash{Symbol => String}]
-    #
-    attr_accessor :job_classes
-
     # Fallback actor for notification events when a caller does not pass +user:+. Set to a proc/lambda that returns the
     # current request user.
     #
@@ -344,11 +331,12 @@ module PlanMyStuff
     #
     attr_accessor :sns_verifier_error
 
-    # Named repo configs. Set via config.repos[:element] = 'BrandsInsurance/Element'.
+    # Named repo configs. Set via config.repos[:element] = 'BrandsInsurance/Element', or assign a whole hash with
+    # config.repos = { element: 'BrandsInsurance/Element', underwriter: 'BrandsInsurance/Underwriter' }.
     #
     # @return [Hash{Symbol => String}]
     #
-    attr_reader :repos
+    attr_accessor :repos
 
     # @return [Configuration]
     def initialize
@@ -359,7 +347,6 @@ module PlanMyStuff
       @support_method = :support?
       @markdown_renderer = :commonmarker
       @markdown_options = {}
-      @job_classes = {}
       @custom_fields = {}
       @issue_custom_fields = {}
       @comment_custom_fields = {}