gh_draft_issues_conerter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d5bc58f8fe58746a0118f9ba194049141d6bec1627c093434349183d9633064
+  data.tar.gz: d2a288fbd37cdca69e17b0f4f9244b53c7f6e5bc220d7a92d139587dbc60d7b4
+SHA512:
+  metadata.gz: f48081331c0d159a3a4a39962a786fe343c51f821465001ae2778f463d7d51a5a28e0254f48846e6496d42e8b629119edfd3a792be9756cba83b5755126be187
+  data.tar.gz: 3f48a9ab22191c40ee8eca092be41aee23aeae23fd93dd9ec5cae8ce61935c17dc4326e8a32059cf79f3af9a3e51ffceb4c4cd187beaaa6b2ece0974493dec95

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "graphlient"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.2.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      logger
+    faraday-net_http (3.3.0)
+      net-http
+    fiber-storage (1.0.0)
+    graphlient (0.8.0)
+      faraday (~> 2.0)
+      graphql-client
+    graphql (2.3.14)
+      base64
+      fiber-storage
+    graphql-client (0.23.0)
+      activesupport (>= 3.0)
+      graphql (>= 1.13.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    logger (1.6.0)
+    minitest (5.25.1)
+    net-http (0.4.1)
+      uri
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    securerandom (0.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uri (0.13.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  graphlient
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Akira kure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Overview
+A tool to batch convert Draft Issues to Issues in GitHub Projects.
+
+# Installation
+
+```sh
+% gem install gh_draft_issues_converter
+```
+
+# Usage
+
+Prerequisites:
+
+- Project number (specify with `-p`)
+  - ex) "In the URL `https://github.com/users/kuredev/projects/1`, the `1` corresponds to the project number."
+- Repository name (owner/repository, specify with `-r`)
+- GitHub Personal Token (register it as `GITHUB_KEY`)
+
+## Example
+
+```sh
+% gh_draft_issues_converter -p 1 -r kuredev/gh-draft-issues-converter   
+```
+
+# Limitations
+- Only single-select custom fields will be migrated.
+- Among standard fields, only the assignee will be migrated.
+
+# Notes
+To avoid rate limits with the CreateIssue API, a default interval of 25 seconds is set. This interval can be adjusted using the `-i` option.
+
+https://github.com/cli/cli/issues/4801#issuecomment-1431812916

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/gh_draft_issues_conerter

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "gh_draft_issues_conerter"
+
+GhDraftIssuesConerter::CLI.start(ARGV)

data/gh_draft_issues_conerter.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/gh_draft_issues_conerter/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gh_draft_issues_conerter"
+  spec.version = GhDraftIssuesConerter::VERSION
+  spec.authors = ["Akira Kure"]
+  spec.email = ["kuredev@users.noreply.github.com"]
+
+  spec.summary = "Convert GitHub's DraftIssues to Issues"
+  spec.description = "Convert GitHub's DraftIssues to Issues"
+  spec.homepage = "https://github.com/kuredev/gh_draft_issues_conerter"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kuredev/gh_draft_issues_conerter"
+  spec.metadata["changelog_uri"] = "https://github.com/kuredev/gh_draft_issues_conerter"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "graphlient"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gh_draft_issues_conerter/cli.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+# Example
+#   bundle exec ruby　gh_draft_issues_conerter --projects_number N --repository_name "XXX"
+
+module GhDraftIssuesConerter
+  class CLI
+    def self.start(argv)
+      options = {}
+      options[:interval] = 25 # Default
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: bundle exec ruby gh-draft-issues-conerter --projects_number N --repository_name xxxxx"
+
+        opts.on("-p N", "--projects_number N", "project number") do |projects_number|
+          options[:projects_number] = projects_number.to_i
+        end
+
+        opts.on("-r NAME", "--repository_name NAME", "full repository name. ex: [owner]/[repository]") do |repository_name|
+          options[:repository_name] = repository_name
+        end
+
+        opts.on("-i SECONDS", "--interval SECONDS", "(option)interval seconds for create issue.default: 25s") do |interval|
+          options[:interval] = interval.to_i
+        end
+      end.parse!(argv)
+
+      # Check must option
+      if options[:projects_number].nil?
+        puts "Error: --projects_number option is required."
+        exit 1
+      end
+
+      # Check must option
+      if options[:repository_name].nil?
+        puts "Error: --repository_name option is required. ex: sample_user/sample_repository"
+        exit 1
+      end
+
+      if ENV["GITHUB_KEY"].nil?
+        puts "Environment value `GITHUB_KEY` is required."
+        exit 1
+      end
+
+      converter = GhDraftIssueConverter::Converter.new(ENV["GITHUB_KEY"])
+      repository = GhDraftIssueConverter::Repository.new(options[:repository_name])
+      converter.run(
+        options[:projects_number],
+        repository,
+        options[:interval],
+      )
+    end
+  end
+end

data/lib/gh_draft_issues_conerter/gh_draft_issues_conerter.rb

@@ -0,0 +1,362 @@
+# frozen_string_literal: true
+
+require "graphlient"
+
+module GhDraftIssueConverter
+  class DraftIssue
+    attr_reader :id, :title, :body, :field_values, :assign_user_ids
+
+    # @param assign_user_ids [Array<String>]
+    # @field_values [Hash]
+    # [
+    #   FieldValue, FieldValue
+    # ]
+    def initialize(id, title, body, assign_user_ids, field_values)
+      @id = id
+      @title = title
+      @body = body
+      @field_values = field_values
+      @assign_user_ids = assign_user_ids
+    end
+
+    def unnecessary_for_convert_issue?
+      false
+
+      #field_values.any? do |field_value|
+      #  field_value.field_name == "Status" && field_value.field_value_name == "🚫unnecessary"
+      #end
+    end
+
+    def user_ids_github_format
+      assign_user_ids.map { |id| "\"#{id}\""}.join(", ")
+    end
+  end
+
+  class FieldValue
+    attr_reader :field_value_id,
+                :field_value_name,
+                :field_value_option_id,
+                :field_id,
+                :field_name
+
+    def initialize(field_value_id, field_value_name, field_value_option_id, field_id, field_name)
+      @field_value_id = field_value_id
+      @field_value_name = field_value_name
+      @field_value_option_id = field_value_option_id
+      @field_id = field_id
+      @field_name = field_name
+    end
+  end
+
+  class Repository
+    attr_reader :full_repository_name
+    def initialize(full_repository_name)
+      parts = full_repository_name.split('/')
+
+      if full_repository_name.include?('/')
+        parts = full_repository_name.split('/')
+
+        if parts.length != 2
+          puts "repository_name is invalid"
+          exit 1
+        elsif parts[0].empty? || parts[1].empty?
+          puts "repository_name is invalid"
+          exit 1
+        else
+          # OK
+        end
+      else
+        puts "repository_name is invalid"
+        exit 1
+      end
+
+      @full_repository_name = full_repository_name
+    end
+
+    def name
+      full_repository_name.split("/")[1]
+    end
+
+    def owner
+      full_repository_name.split("/")[0]
+    end
+  end
+
+  class GhResoucesManager
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [String] Issue ID
+    def add_issue_projectv2(project_id, issue_id)
+      response = client.query <<~GRAPHQL
+        mutation {
+          addProjectV2ItemById(input: {projectId: "#{project_id}", contentId: "#{issue_id}"}) {
+            item {
+              id
+            }
+          }
+        }
+      GRAPHQL
+
+      response.to_h["data"]["addProjectV2ItemById"]["item"]["id"]
+    end
+
+    def fetch_draft_issues(project_id)
+      # https://docs.github.com/ja/graphql/reference/objects#user
+      response = client.query <<~GRAPHQL
+      query {
+          node(id: "#{project_id}") {
+            ... on ProjectV2 {
+              items {
+                nodes {
+                  id,
+                  content {
+                    ... on DraftIssue {
+                      title
+                      body
+                      assignees(first: 10) {
+                        nodes {
+                          id
+                        }
+                      }
+                    }
+                  }
+                  fieldValues(first: 10) {
+                    nodes {
+                      ... on ProjectV2ItemFieldSingleSelectValue {
+                        id
+                        optionId
+                        name
+                        field {
+                          ... on ProjectV2SingleSelectField {
+                            id
+                            name
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+      }
+      GRAPHQL
+
+      nodes = response.to_h["data"]["node"]["items"]["nodes"]
+      nodes.map do |node|
+        next if node["content"]["__typename"] == "Issue"
+
+        assign_user_ids = node["content"]["assignees"]["nodes"]
+        assign_user_ids = assign_user_ids.map { |item| item["id"] }
+
+        DraftIssue.new(
+          node["id"],
+          node["content"]["title"],
+          node["content"]["body"],
+          assign_user_ids,
+          convert_field_nodes_to_objs(node["fieldValues"]["nodes"])
+        )
+      end.compact
+    end
+
+    # @return [Array<FieldValue>]
+    def convert_field_nodes_to_objs(nodes)
+      nodes.map do |node|
+        next if node.empty?
+        next if node["__typename"] != "ProjectV2ItemFieldSingleSelectValue"
+
+        FieldValue.new(
+          node["id"],
+          node["name"],
+          node["optionId"],
+          node["field"]["id"],
+          node["field"]["name"]
+        )
+      end.compact
+    end
+
+    def fetch_project_id(project_number, repository)
+      owner_is_user = owner_is_user?(repository)
+      if owner_is_user
+        response = client.query <<~GRAPHQL
+        query {
+          user(login: "#{repository.owner}") {
+            projectV2(number: #{project_number}) {
+              id,
+              title
+            }
+          }
+        }
+        GRAPHQL
+        response.to_h["data"]["user"]["projectV2"]["id"]
+      else
+        response = client.query <<~GRAPHQL
+        query {
+          organization(login: "#{repository.owner}") {
+              projectV2(number: #{project_number}) {
+                id,
+                title
+              }
+          }
+        }
+        GRAPHQL
+        response.to_h["data"]["organization"]["projectV2"]["id"]
+      end
+    end
+
+    def fetch_repository_id(repository)
+      owner_is_user = owner_is_user?(repository)
+      if owner_is_user
+        response = client.query <<~GRAPHQL
+        query {
+          repository(owner: "#{repository.owner}", name: "#{repository.name}") {
+            id
+          }
+        }
+        GRAPHQL
+
+        response.to_h["data"]["repository"]["id"]
+      else
+        response = client.query <<~GRAPHQL
+        query {
+          organization(login: "#{repository.owner}") {
+            repository(name: "#{repository.name}") {
+              id
+            }
+          }
+        }
+        GRAPHQL
+
+        response.to_h["data"]["organization"]["repository"]["id"]
+      end
+    end
+
+    def update_item_field_values(project_id, draft_issue, item_id)
+      draft_issue.field_values.each do |field_value|
+        response = client.query <<~GRAPHQL
+        mutation {
+          updateProjectV2ItemFieldValue(input: {
+            projectId: "#{project_id}",
+            itemId: "#{item_id}",
+            fieldId: "#{field_value.field_id}",
+            value: {singleSelectOptionId: "#{field_value.field_value_option_id}"}}
+            ) {
+            projectV2Item {
+              id
+            }
+          }
+        }
+        GRAPHQL
+      end
+    end
+
+    # memo: https://docs.github.com/en/graphql/reference/input-objects#createissueinput
+    # @return [String] item_id
+    def create_issue_from_draft(draft_issue, repository_id, project_id)
+      response = client.query <<~GRAPHQL
+        mutation {
+          createIssue(input: {
+            repositoryId: "#{repository_id}",
+            assigneeIds: [#{draft_issue.user_ids_github_format}],
+            title: "#{draft_issue.title}",
+            body: "#{draft_issue.body.gsub("\n", "\\n").gsub('"', '\"')}"
+          }) {
+            issue {
+              id
+            }
+          }
+        }
+      GRAPHQL
+
+      response.original_hash["data"]["createIssue"]["issue"]["id"]
+    end
+
+    def delete_draft_issue(project_id, draft_issue)
+      response = client.query <<~GRAPHQL
+      mutation {
+        deleteProjectV2Item(input: {
+          projectId: "#{project_id}",
+          itemId: "#{draft_issue.id}"
+        }) {
+          clientMutationId
+        }
+      }
+      GRAPHQL
+    end
+
+    def owner_is_user?(repository)
+      response = client.query <<~GRAPHQL
+      query {
+        repositoryOwner(login: "#{repository.owner}") {
+          __typename
+          login
+        }
+      }
+      GRAPHQL
+
+      response.to_h["data"]["repositoryOwner"]["__typename"] == "User"
+    end
+  end
+
+  class Converter
+    def initialize(github_key)
+      client = Graphlient::Client.new(
+        'https://api.github.com/graphql',
+        headers: {
+          'Authorization' => "Bearer #{github_key}"
+        },
+        http_options: {
+          read_timeout: 20,
+          write_timeout: 30
+        }
+      )
+
+      @resource_manager = GhResoucesManager.new(client)
+    end
+
+    # @param [Number] project_number
+    # @param [Repository] repository
+    def run(project_number, repository, interval = 25)
+      repository_id = @resource_manager.fetch_repository_id(repository)
+      project_id = @resource_manager.fetch_project_id(project_number, repository)
+
+      draft_issues = @resource_manager.fetch_draft_issues(project_id)
+      draft_issues.select! do |draft_issue|
+        !draft_issue.unnecessary_for_convert_issue?
+      end
+
+      draft_issues.each_with_index do |draft_issue, index|
+        puts "Converting: #{draft_issue.title}"
+
+        issue_repository_id = @resource_manager.create_issue_from_draft(
+          draft_issue,
+          repository_id,
+          project_id
+        )
+
+        puts "Add ProjectV2..."
+        issue_projectv2_id = @resource_manager.add_issue_projectv2(project_id, issue_repository_id)
+
+        puts "Update Field Values..."
+        @resource_manager.update_item_field_values(project_id, draft_issue, issue_projectv2_id)
+
+        puts "Delete DraftIssue..."
+        @resource_manager.delete_draft_issue(project_id, draft_issue)
+
+        puts "Complete Convert."
+
+        if index == draft_issues.length - 1
+          puts "All DraftIssue Converted."
+        else
+          # https://github.com/cli/cli/issues/4801#issuecomment-1431812916
+          puts "Sleep(25s) for rate limit..."
+          sleep interval
+        end
+      end
+    end
+  end
+end

data/lib/gh_draft_issues_conerter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GhDraftIssuesConerter
+  VERSION = "0.1.0"
+end

data/lib/gh_draft_issues_conerter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "gh_draft_issues_conerter/version"
+require_relative "gh_draft_issues_conerter/cli"
+require_relative "gh_draft_issues_conerter/gh_draft_issues_conerter"
+
+module GhDraftIssuesConerter
+  class Error < StandardError; end
+end

data/sig/gh_draft_issues_conerter.rbs

@@ -0,0 +1,4 @@
+module GhDraftIssuesConerter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: gh_draft_issues_conerter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Kure
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphlient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert GitHub's DraftIssues to Issues
+email:
+- kuredev@users.noreply.github.com
+executables:
+- gh_draft_issues_conerter
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- exe/gh_draft_issues_conerter
+- gh_draft_issues_conerter.gemspec
+- lib/gh_draft_issues_conerter.rb
+- lib/gh_draft_issues_conerter/cli.rb
+- lib/gh_draft_issues_conerter/gh_draft_issues_conerter.rb
+- lib/gh_draft_issues_conerter/version.rb
+- sig/gh_draft_issues_conerter.rbs
+homepage: https://github.com/kuredev/gh_draft_issues_conerter
+licenses: []
+metadata:
+  homepage_uri: https://github.com/kuredev/gh_draft_issues_conerter
+  source_code_uri: https://github.com/kuredev/gh_draft_issues_conerter
+  changelog_uri: https://github.com/kuredev/gh_draft_issues_conerter
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Convert GitHub's DraftIssues to Issues
+test_files: []