sashimi_tanpopo 0.1.0

data/lib/sashimi_tanpopo/provider/gitlab.rb

@@ -0,0 +1,288 @@
+# frozen_string_literal: true
+
+module SashimiTanpopo
+  module Provider
+    # Apply recipe files and create Pull Request
+    class GitLab < Base
+      DEFAULT_API_ENDPOINT = "https://gitlab.com/api/v4"
+
+      MAX_RETRY_COUNT = 5
+
+      # @param recipe_paths [Array<String>]
+      # @param target_dir [String,nil]
+      # @param params [Hash<Symbol, String>]
+      # @param dry_run [Boolean]
+      # @param is_colored [Boolean] Whether show color diff
+      # @param git_username [String,nil]
+      # @param git_email [String,nil]
+      # @param commit_message [String]
+      # @param repository [String]
+      # @param access_token [String]
+      # @param api_endpoint [String]
+      # @param mr_title [String]
+      # @param mr_body [String]
+      # @param mr_source_branch [String] Merge Request source branch
+      # @param mr_target_branch [String] Merge Request target branch
+      # @param mr_assignees [Array<String>]
+      # @param mr_reviewers [Array<String>]
+      # @param mr_labels [Array<String>]
+      # @param is_draft_mr [Boolean] Whether create draft Pull Request
+      # @param is_auto_merge [Boolean] Whether enable auto-merge
+      def initialize(recipe_paths:, target_dir:, params:, dry_run:, is_colored:,
+                     git_username:, git_email:, commit_message:,
+                     repository:, access_token:, api_endpoint: DEFAULT_API_ENDPOINT,
+                     mr_title:, mr_body:, mr_source_branch:, mr_target_branch:,
+                     mr_assignees: [], mr_reviewers: [], mr_labels: [], is_draft_mr:, is_auto_merge:)
+        super(
+          recipe_paths:    recipe_paths,
+          target_dir:      target_dir,
+          params:          params,
+          dry_run:         dry_run,
+          is_colored:      is_colored,
+          is_update_local: false,
+        )
+
+        @commit_message = commit_message
+        @repository = repository
+        @mr_title = mr_title
+        @mr_body = mr_body
+        @mr_source_branch = mr_source_branch
+        @mr_target_branch = mr_target_branch
+        @mr_assignees = mr_assignees
+        @mr_reviewers = mr_reviewers
+        @mr_labels = mr_labels
+        @is_draft_mr = is_draft_mr
+        @is_auto_merge = is_auto_merge
+
+        @gitlab = Gitlab.client(endpoint: api_endpoint, private_token: access_token)
+
+        @git_username =
+          if git_username
+            git_username
+          else
+            current_user_name
+          end
+
+        @git_email =
+          if git_email
+            git_email
+          else
+            "#{@git_username}@noreply.#{self.class.gitlab_host(api_endpoint)}"
+          end
+      end
+
+      # Apply recipe files
+      #
+      # @return [String] Created Merge Request URL
+      # @return [nil] Merge Request isn't created
+      def perform
+        changed_files = apply_recipe_files
+
+        return nil if changed_files.empty? || @dry_run
+
+        if exists_branch?(@mr_source_branch)
+          SashimiTanpopo.logger.info "Skipped because branch #{@pr_source_branch} already exists on #{@repository}"
+          return nil
+        end
+
+        create_branch_and_push_changes(changed_files)
+
+        mr = create_merge_request
+        SashimiTanpopo.logger.info "Merge Request is created: #{mr[:web_url]}"
+
+        if @is_auto_merge
+          set_auto_merge(mr[:iid])
+          SashimiTanpopo.logger.info "Set auto-merge to #{mr[:web_url]}"
+        end
+
+        mr[:web_url]
+      end
+
+      # @param username [String]
+      #
+      # @return [Integer]
+      # @return [nil] user is not found
+      #
+      # @see https://docs.gitlab.com/api/users/#as-a-regular-user
+      def get_user_id_from_user_name(username)
+        user = with_retry do
+          @gitlab.users(username: username).first
+        end
+        return nil unless user
+
+        user["id"].to_i
+      end
+
+      # @param username [String]
+      #
+      # @return [Integer]
+      #
+      # @raise [SashimiTanpopo::NotFoundUserError]
+      #
+      # @see https://docs.gitlab.com/api/users/#as-a-regular-user
+      def get_user_id_from_user_name!(username)
+        user_id = get_user_id_from_user_name(username)
+        raise NotFoundUserError, "#{username} isn't found" unless user_id
+
+        user_id
+      end
+
+      # @param usernames [Array<String>]
+      #
+      # @return [Array<Integer>]
+      #
+      # @raise [SashimiTanpopo::NotFoundUserError]
+      #
+      # @see https://docs.gitlab.com/api/users/#as-a-regular-user
+      def get_user_ids_from_user_names!(usernames)
+        Parallel.map(usernames, in_threads: 2) do |username|
+          get_user_id_from_user_name!(username)
+        end
+      end
+
+      # @param mode [String] e.g. `100644`, `100755`
+      #
+      # @return [Boolean]
+      def self.executable_mode?(mode)
+        (mode.to_i(8) & 1) != 0
+      end
+
+      # Get GitLab host from api_endpoint
+      #
+      # @param api_endpoint [String]
+      #
+      # @return [String]
+      def self.gitlab_host(api_endpoint)
+        matched = %r{^https?://(.+)/api}.match(api_endpoint)
+        return matched[1] if matched # steep:ignore
+
+        "example.com"
+      end
+
+      private
+
+      def with_retry
+        retry_count ||= 0 # steep:ignore
+
+        yield
+      rescue Gitlab::Error::MethodNotAllowed, Gitlab::Error::NotAcceptable, Gitlab::Error::Unprocessable => error
+        retry_count += 1 # steep:ignore
+
+        raise error if retry_count > MAX_RETRY_COUNT
+
+        SashimiTanpopo.logger.warn "Error is occurred and auto retry (#{retry_count}/#{MAX_RETRY_COUNT}): #{error}"
+
+        # 1, 2, 4, 8, 16 ...
+        sleep_time = 2 ** (retry_count - 1)
+
+        sleep sleep_time # steep:ignore
+
+        retry
+      end
+
+      # @return [String]
+      def current_user_name
+        user = with_retry do
+          @gitlab.user
+        end
+
+        user["username"]
+      end
+
+      # Whether exists branch on repository
+      #
+      # @param branch [String]
+      #
+      # @return [Boolean]
+      #
+      # @see https://docs.gitlab.com/api/branches/#get-single-repository-branch
+      def exists_branch?(branch)
+        with_retry do
+          @gitlab.branch(@repository, branch)
+        end
+        true
+      rescue Gitlab::Error::NotFound
+        false
+      end
+
+      # Create branch on repository and push changes
+      #
+      # @param changed_files [Hash<String, { before_content: String, after_content: String, mode: String }>] key: file path, value: Hash
+      #
+      # @see https://docs.gitlab.com/api/commits/#create-a-commit-with-multiple-files-and-actions
+      def create_branch_and_push_changes(changed_files)
+        actions = changed_files.map do |file_path, changed_file|
+          {
+            action:           "update",
+            file_path:        file_path,
+            execute_filemode: self.class.executable_mode?(changed_file[:mode]),
+            content:          changed_file[:after_content],
+          }
+        end
+
+        with_retry do
+          @gitlab.create_commit(
+            @repository,
+            @mr_source_branch,
+            @commit_message,
+            actions,
+            start_branch: @mr_target_branch,
+            author_email: @git_email,
+            author_name:  @git_username,
+          )
+        end
+      end
+
+      # @return [Hash{iid: Integer, web_url: String}] Created Merge Request info
+      #
+      # @see https://docs.gitlab.com/api/merge_requests/#create-mr
+      def create_merge_request
+        params = {
+          source_branch:        @mr_source_branch,
+          target_branch:        @mr_target_branch,
+          remove_source_branch: true,
+          description:          @mr_body,
+        }
+
+        params[:labels] = @mr_labels.join(",") unless @mr_labels.empty?
+
+        unless @mr_assignees.empty?
+          params[:assignee_ids] = get_user_ids_from_user_names!(@mr_assignees) # steep:ignore
+        end
+
+        unless @mr_reviewers.empty?
+          params[:reviewer_ids] = get_user_ids_from_user_names!(@mr_reviewers) # steep:ignore
+        end
+
+        mr_title =
+          if @is_draft_mr
+            "Draft: " + @mr_title
+          else
+            @mr_title
+          end
+
+        mr = with_retry do
+          @gitlab.create_merge_request(
+            @repository,
+            mr_title,
+            params,
+          )
+        end
+
+        {
+          iid:     mr["iid"],
+          web_url: mr["web_url"],
+        }
+      end
+
+      # @param mr_iid [Integer]
+      #
+      # @see https://docs.gitlab.com/api/merge_requests/#merge-a-merge-request
+      def set_auto_merge(mr_iid)
+        with_retry do
+          @gitlab.accept_merge_request(@repository, mr_iid, auto_merge: true, should_remove_source_branch: true)
+        end
+      end
+    end
+  end
+end

data/lib/sashimi_tanpopo/provider/local.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SashimiTanpopo
+  module Provider
+    # Apply recipe files to local
+    class Local < Base
+      # @param recipe_paths [Array<String>]
+      # @param target_dir [String,nil]
+      # @param params [Hash<Symbol, String>]
+      # @param dry_run [Boolean]
+      # @param is_colored [Boolean] Whether show color diff
+      def initialize(recipe_paths:, target_dir:, params:, dry_run:, is_colored:)
+        super(
+          recipe_paths:    recipe_paths,
+          target_dir:      target_dir,
+          params:          params,
+          dry_run:         dry_run,
+          is_colored:      is_colored,
+          is_update_local: true
+        )
+      end
+
+      def perform
+        apply_recipe_files
+      end
+    end
+  end
+end

data/lib/sashimi_tanpopo/provider.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "provider/base"
+require_relative "provider/local"
+require_relative "provider/github"
+require_relative "provider/gitlab"

data/lib/sashimi_tanpopo/version.rb

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

data/lib/sashimi_tanpopo.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "logger"
+require "diffy"
+require "octokit"
+require "gitlab"
+require "parallel"
+
+require_relative "sashimi_tanpopo/version"
+require_relative "sashimi_tanpopo/dsl"
+require_relative "sashimi_tanpopo/logger"
+require_relative "sashimi_tanpopo/provider"
+
+module SashimiTanpopo
+  class Error < StandardError; end
+
+  class NotFoundUserError < Error; end
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,196 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: addressable
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: '0.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: bigdecimal
+  version: '3.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: csv
+  version: '3.3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: dbm
+  version: '0'
+  source:
+    type: stdlib
+- name: diff-lcs
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: faraday
+  version: '2.7'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: hashdiff
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: httparty
+  version: '0.18'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: io-console
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: mini_mime
+  version: '0.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: net-http
+  version: '0'
+  source:
+    type: stdlib
+- name: net-protocol
+  version: '0'
+  source:
+    type: stdlib
+- name: octokit
+  version: '8.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pp
+  version: '0'
+  source:
+    type: stdlib
+- name: prettyprint
+  version: '0'
+  source:
+    type: stdlib
+- name: pstore
+  version: '0'
+  source:
+    type: stdlib
+- name: psych
+  version: '0'
+  source:
+    type: stdlib
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: stringio
+  version: '0'
+  source:
+    type: stdlib
+- name: thor
+  version: '1.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+- name: webmock
+  version: '3.19'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 10d80b1f45dd4241d64d40b49e622cd5d3cfa903
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,23 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: logger
+  - name: rbs
+    ignore: true
+  - name: steep
+    ignore: true
+  - name: yard
+    ignore: true

data/sig/sashimi_tanpopo/cli.rbs

@@ -0,0 +1,28 @@
+module SashimiTanpopo
+  class CLI < Thor
+    def self.exit_on_failure?: () -> bool
+
+    def self.define_exec_common_options: () -> void
+
+    def self.normalize_params: (Hash[String, String] params) -> Hash[Symbol, String]
+
+    def version: () -> void
+
+    def local: (*String recipe_files) -> void
+
+    def github: (*String recipe_files) -> void
+
+    def gitlab: (*String recipe_files) -> void
+
+    def option_or_env: (
+        option_name: String | Symbol,
+        env_name: String | Array[String],
+        ?default: String?,
+      ) -> String?
+
+    def option_or_env!: (
+        option_name: String | Symbol,
+        env_name: String | Array[String],
+      ) -> String
+  end
+end

data/sig/sashimi_tanpopo/dsl.rbs

@@ -0,0 +1,68 @@
+module SashimiTanpopo
+  class DSL
+    def perform: (
+        recipe_path: String,
+        target_dir: String,
+        params: Hash[Symbol, String],
+        dry_run: bool,
+        is_colored: bool,
+        is_update_local: bool,
+      ) -> changed_files
+
+    def evaluate: (
+        recipe_body: String,
+        recipe_path: String,
+        target_dir: String,
+        params: Hash[Symbol, String],
+        dry_run: bool,
+        is_colored: bool,
+        is_update_local: bool,
+      ) -> changed_files
+
+    class EvalContext
+      @__params__: Hash[Symbol, String]
+      @__dry_run__: bool
+      @__target_dir__: String
+      @__is_update_local__: bool
+      @__diffy_format__: Symbol
+      @__changed_files__: changed_files
+
+      def initialize: (
+          params: Hash[Symbol, String],
+          dry_run: bool,
+          is_colored: bool,
+          target_dir: String,
+          is_update_local: bool,
+        ) -> void
+
+      def params: () -> Hash[Symbol, String]
+
+      def changed_files: () -> changed_files
+
+      def dry_run?: () -> bool
+
+      def update_file: (String pattern) { (String) -> void } -> void
+
+      private
+
+      def update_single_file: (String path) { (String) -> void } -> String?
+
+      def show_diff: (String str1, String str2) -> void
+    end
+
+    class InstanceEval
+      @code: String
+      @target_dir: String
+      @context: EvalContext
+
+      def initialize: (
+          recipe_body: String,
+          recipe_path: String,
+          target_dir: String,
+          context: EvalContext
+        ) -> void
+
+      def call: () -> void
+    end
+  end
+end

data/sig/sashimi_tanpopo/logger.rbs

@@ -0,0 +1,11 @@
+module SashimiTanpopo
+  module Logger
+    class Formatter
+      def call: (String, Time, String?, String) -> String
+    end
+  end
+
+  def self.logger: () -> ::Logger
+
+  def self.logger=: (::Logger) -> ::Logger
+end

data/sig/sashimi_tanpopo/provider/base.rbs

@@ -0,0 +1,25 @@
+module SashimiTanpopo
+  module Provider
+    class Base
+      @recipe_paths: Array[String]
+      @target_dir: String
+      @params: Hash[Symbol, String]
+      @dry_run: bool
+      @is_colored: bool
+      @is_update_local: bool
+
+      def initialize: (
+          recipe_paths: Array[String],
+          target_dir: String?,
+          params: Hash[Symbol, String],
+          dry_run: bool,
+          is_colored: bool,
+          is_update_local: bool,
+        ) -> void
+
+      def apply_recipe_files: () -> changed_files
+
+      def cleanup_target_dir: () -> void
+    end
+  end
+end