sashimi_tanpopo 0.1.0

data/lib/sashimi_tanpopo/dsl.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module SashimiTanpopo
+  class DSL
+    # Apply recipe file
+    #
+    # @param recipe_path [String]
+    # @param target_dir [String]
+    # @param params [Hash<Symbol, String>]
+    # @param dry_run [Boolean]
+    # @param is_colored [Boolean] Whether show color diff
+    # @param is_update_local [Boolean] Whether update local file in `update_file`
+    #
+    # @return [Hash<String, { before_content: String, after_content: String, mode: String }>] changed files (key: file path, value: Hash)
+    #
+    # @example Response format
+    #   {
+    #     "path/to/changed-file.txt" => {
+    #       before_content: "foo",
+    #       after_content:  "bar",
+    #       mode:           "100644",
+    #     }
+    #   }
+    def perform(recipe_path:, target_dir:, params:, dry_run:, is_colored:, is_update_local:)
+      evaluate(
+        recipe_body:     File.read(recipe_path),
+        recipe_path:     recipe_path,
+        target_dir:      target_dir,
+        params:          params,
+        dry_run:         dry_run,
+        is_colored:      is_colored,
+        is_update_local: is_update_local,
+      )
+    end
+
+    # Apply recipe file for unit test
+    #
+    # @param recipe_body [String]
+    # @param recipe_path [String]
+    # @param target_dir [String]
+    # @param params [Hash<Symbol, String>]
+    # @param dry_run [Boolean]
+    # @param is_colored [Boolean] Whether show color diff
+    # @param is_update_local [Boolean] Whether update local file in `update_file`
+    #
+    # @return [Hash<String, { before_content: String, after_content: String, mode: String }>] changed files (key: file path, value: Hash)
+    #
+    # @example Response format
+    #   {
+    #     "path/to/changed-file.txt" => {
+    #       before_content: "foo",
+    #       after_content:  "bar",
+    #       mode:           "100644",
+    #     }
+    #   }
+    def evaluate(recipe_body:, recipe_path:, target_dir:, params:, dry_run:, is_colored:, is_update_local:)
+      context = EvalContext.new(params: params, dry_run: dry_run, is_colored: is_colored, target_dir: target_dir, is_update_local: is_update_local)
+      InstanceEval.new(recipe_body: recipe_body, recipe_path: recipe_path, target_dir: target_dir, context: context).call
+      context.changed_files
+    end
+
+    class EvalContext
+      # @param params [Hash<Symbol, String>]
+      # @param dry_run [Boolean]
+      # @param is_colored [Boolean] Whether show color diff
+      # @param target_dir [String]
+      # @param is_update_local [Boolean] Whether update local file in `update_file`
+      def initialize(params:, dry_run:, is_colored:, target_dir:, is_update_local:)
+        @__params__ = params
+        @__dry_run__ = dry_run
+        @__target_dir__ = target_dir
+        @__is_update_local__ = is_update_local
+
+        @__diffy_format__ = is_colored ? :color : :text
+      end
+
+      # passed from `--params`
+      #
+      # @return [Hash<Symbol, String>]
+      #
+      # @example Pass params via `--params`
+      #   sashimi_tanpopo local --params name:sue445 --params lang:ja recipe.rb
+      #
+      # @example within `recipe.rb`
+      #   # recipe.rb
+      #
+      #   params
+      #   #=> {name: "sue445", lang: "ja"}
+      def params
+        @__params__
+      end
+
+      # @return [Hash<String, { before_content: String, after_content: String, mode: String }>] key: file path, value: Hash
+      def changed_files
+        @__changed_files__ ||= {}
+      end
+
+      # @return [Boolean] Whether dry run
+      #
+      # @example
+      #   unless dry_run?
+      #     puts "This will be called when apply mode"
+      #   end
+      def dry_run?
+        @__dry_run__
+      end
+
+      # Update files if exists
+      #
+      # @param pattern [String] Path to target file (relative path from `--target-dir`). This supports [`Dir.glob`](https://ruby-doc.org/current/Dir.html#method-c-glob) pattern. (e.g. `.github/workflows/*.yml`)
+      #
+      # @yieldparam content [String] Content of file. If `content` is changed in block, file will be changed.
+      #
+      # @example Update single file
+      #   update_file "test.txt" do |content|
+      #     content.gsub!("name", params[:name])
+      #   end
+      #
+      # @example Update multiple files
+      #   update_file ".github/workflows/*.yml" do |content|
+      #     content.gsub!(/ruby-version: "(.+)"/, %Q{ruby-version: "#{params[:ruby_version]}"})
+      #   end
+      def update_file(pattern, &block)
+        Dir.glob(pattern).each do |path|
+          full_file_path = File.join(@__target_dir__, path)
+          before_content = File.read(full_file_path)
+
+          SashimiTanpopo.logger.info "Checking #{full_file_path}"
+
+          after_content = update_single_file(path, &block)
+
+          unless after_content
+            SashimiTanpopo.logger.info "#{full_file_path} isn't changed"
+            next
+          end
+
+          changed_files[path] = {
+            before_content: before_content,
+            after_content:  after_content,
+            mode:           File.stat(full_file_path).mode.to_s(8)
+          }
+
+          if dry_run?
+            SashimiTanpopo.logger.info "#{full_file_path} will be changed (dryrun)"
+          else
+            SashimiTanpopo.logger.info "#{full_file_path} is changed"
+          end
+        end
+      end
+
+      private
+
+      # @param path [String]
+      #
+      # @yieldparam content [String] content of file
+      #
+      # @return [String] Content of changed file if file is changed
+      # @return [nil] file isn't changed
+      def update_single_file(path)
+        return nil unless File.exist?(path)
+
+        content = File.read(path)
+        before_content = content.dup
+
+        yield content
+
+        # File isn't changed
+        return nil if content == before_content
+
+        show_diff(before_content, content)
+
+        File.write(path, content) if !dry_run? && @__is_update_local__
+
+        content
+      end
+
+      # @param str1 [String]
+      # @param str2 [String]
+      def show_diff(str1, str2)
+        diff_text = Diffy::Diff.new(str1, str2, context: 3).to_s(@__diffy_format__) # steep:ignore
+
+        SashimiTanpopo.logger.info "diff:"
+
+        diff_text.each_line do |line|
+          SashimiTanpopo.logger.info line
+        end
+      end
+    end
+
+    class InstanceEval
+      # @param recipe_body [String]
+      # @param recipe_path [String]
+      # @param target_dir [String]
+      # @param context [EvalContext]
+      def initialize(recipe_body:, recipe_path:, target_dir:, context:)
+        @code = <<~RUBY
+          Dir.chdir(@target_dir) do
+            @context.instance_eval do
+              eval(#{recipe_body.dump}, nil, #{recipe_path.dump}, 1)
+            end
+          end
+        RUBY
+
+        @target_dir = target_dir
+        @context = context
+      end
+
+      def call
+        eval(@code)
+      end
+    end
+    private_constant :InstanceEval
+  end
+end

data/lib/sashimi_tanpopo/logger.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SashimiTanpopo
+  module Logger
+    class Formatter
+      # @param severity [String]
+      # @param datetime [Time]
+      # @param progname [String]
+      # @param msg [String]
+      def call(severity, datetime, progname, msg)
+        log = "%s : %s" % ["%5s" % severity, msg.strip]
+
+        log + "\n"
+      end
+    end
+  end
+
+  @logger = ::Logger.new($stdout).tap do |l|
+    l.formatter = SashimiTanpopo::Logger::Formatter.new
+  end
+  $stdout.sync = true
+
+  class << self
+    # @return [::Logger]
+    def logger
+      @logger
+    end
+
+    # @param l [::Logger]
+    def logger=(l)
+      @logger = l
+    end
+  end
+end

data/lib/sashimi_tanpopo/provider/base.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SashimiTanpopo
+  module Provider
+    class 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
+      # @param is_update_local [Boolean] Whether update local file in `update_file`
+      def initialize(recipe_paths:, target_dir:, params:, dry_run:, is_colored:, is_update_local:)
+        @recipe_paths = recipe_paths
+        @target_dir = target_dir || Dir.pwd
+        @params = params
+        @dry_run = dry_run
+        @is_colored = is_colored
+        @is_update_local = is_update_local
+      end
+
+      # Apply recipe files
+      #
+      # @return [Hash<String, { before_content: String, after_content: String, mode: String }>] changed files (key: file path, value: Hash)
+      #
+      # @example Response format
+      #   {
+      #     "path/to/changed-file.txt" => {
+      #       before_content: "foo",
+      #       after_content:  "bar",
+      #       mode:           "100644",
+      #     }
+      #   }
+      def apply_recipe_files
+        all_changed_files = {} # : changed_files
+
+        @recipe_paths.each do |recipe_path|
+          changed_files =
+            DSL.new.perform(
+              recipe_path:     recipe_path,
+              target_dir:      @target_dir,
+              params:          @params,
+              dry_run:         @dry_run,
+              is_colored:      @is_colored,
+              is_update_local: @is_update_local,
+            )
+
+          all_changed_files.merge!(changed_files)
+        end
+
+        all_changed_files
+      end
+    end
+  end
+end

data/lib/sashimi_tanpopo/provider/github.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module SashimiTanpopo
+  module Provider
+    # Apply recipe files and create Pull Request
+    class GitHub < Base
+      DEFAULT_API_ENDPOINT = "https://api.github.com/"
+
+      DEFAULT_GITHUB_HOST = "github.com"
+
+      # @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 pr_title [String]
+      # @param pr_body [String]
+      # @param pr_source_branch [String] Pull Request source branch (a.k.a. head branch)
+      # @param pr_target_branch [String] Pull Request target branch (a.k.a. base branch)
+      # @param pr_assignees [Array<String>]
+      # @param pr_reviewers [Array<String>]
+      # @param pr_labels [Array<String>]
+      # @param is_draft_pr [Boolean] Whether create draft Pull Request
+      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,
+                     pr_title:, pr_body:, pr_source_branch:, pr_target_branch:,
+                     pr_assignees: [], pr_reviewers: [], pr_labels: [], is_draft_pr:)
+        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
+        @pr_title = pr_title
+        @pr_body = pr_body
+        @pr_source_branch = pr_source_branch
+        @pr_target_branch = pr_target_branch
+        @pr_assignees = pr_assignees
+        @pr_reviewers = pr_reviewers
+        @pr_labels = pr_labels
+        @is_draft_pr = is_draft_pr
+
+        @client = Octokit::Client.new(api_endpoint: api_endpoint, access_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}@users.noreply.#{self.class.github_host(api_endpoint)}"
+          end
+      end
+
+      # Apply recipe files
+      #
+      # @return [String] Created Pull Request URL
+      # @return [nil] Pull Request isn't created
+      def perform
+        changed_files = apply_recipe_files
+
+        return nil if changed_files.empty? || @dry_run
+
+        if exists_branch?(@pr_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)
+
+        pr = create_pull_request
+
+        add_pr_labels(pr[:number])
+        add_pr_assignees(pr[:number])
+        add_pr_reviewers(pr[:number])
+
+        pr[:html_url]
+      end
+
+      # Get GitHub host from api_endpoint
+      #
+      # @param api_endpoint [String]
+      #
+      # @return [String]
+      def self.github_host(api_endpoint)
+        return DEFAULT_GITHUB_HOST if api_endpoint == DEFAULT_API_ENDPOINT
+
+        matched = %r{^https?://(.+)/api}.match(api_endpoint)
+        return matched[1] if matched # steep:ignore
+
+        DEFAULT_GITHUB_HOST
+      end
+
+      private
+
+      # @return [String]
+      #
+      # @see https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user
+      def current_user_name
+        @client.user[:login]
+      end
+
+      # Whether exists branch on repository
+      #
+      # @param branch [String]
+      #
+      # @return [Boolean]
+      def exists_branch?(branch)
+        @client.branch(@repository, branch)
+        true
+      rescue Octokit::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.github.com/en/rest/git/refs?apiVersion=2022-11-28#get-a-reference
+      # @see https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#create-a-reference
+      # @see https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#get-a-commit
+      # @see https://docs.github.com/en/rest/git/trees#create-a-tree
+      # @see https://docs.github.com/en/rest/git/commits?apiVersion=2022-11-28#create-a-commit
+      # @see https://docs.github.com/en/rest/git/refs?apiVersion=2022-11-28#update-a-reference
+      def create_branch_and_push_changes(changed_files)
+        current_ref = @client.ref(@repository, "heads/#{@pr_target_branch}")
+        branch_ref = @client.create_ref(@repository, "heads/#{@pr_source_branch}", current_ref.object.sha) # steep:ignore
+
+        branch_commit = @client.commit(@repository, branch_ref.object.sha) # steep:ignore
+
+        tree_metas =
+          changed_files.map do |path, data|
+            create_tree_meta(path: path, body: data[:after_content], mode: data[:mode])
+          end
+        tree = @client.create_tree(@repository, tree_metas, base_tree: branch_commit.commit.tree.sha) # steep:ignore
+
+        commit = @client.create_commit(
+          @repository,
+          @commit_message,
+          tree.sha, # steep:ignore
+          branch_ref.object.sha, # steep:ignore
+          author: {
+            name: @git_username,
+            email: @git_email,
+          }
+        )
+
+        @client.update_ref(@repository, "heads/#{@pr_source_branch}", commit.sha) # steep:ignore
+      end
+
+      # @param path [String]
+      # @param body [String]
+      # @param mode [String]
+      #
+      # @return [Hash<{ path: String, mode: String, type: String, sha: String }>]
+      #
+      # @see https://docs.github.com/en/rest/git/blobs#create-a-blob
+      def create_tree_meta(path:, body:, mode:)
+        file_body_sha = @client.create_blob(@repository, body)
+
+        {
+          path: path,
+          mode: mode,
+          type: "blob",
+          sha:  file_body_sha,
+        }
+      end
+
+      # @return [Hash{pr_number: Integer, html_url: String}] Created Pull Request info
+      #
+      # @see https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#create-a-pull-request
+      def create_pull_request
+        pr = @client.create_pull_request(@repository, @pr_target_branch, @pr_source_branch, @pr_title, @pr_body, draft: @is_draft_pr)
+
+        SashimiTanpopo.logger.info "Pull Request is created: #{pr[:html_url]}"
+
+        {
+          number: pr[:number],
+          html_url: pr[:html_url],
+        }
+      end
+
+      # @param pr_number [Integer]
+      #
+      # @see https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#add-labels-to-an-issue
+      def add_pr_labels(pr_number)
+        return if @pr_labels.empty?
+
+        @client.add_labels_to_an_issue(@repository, pr_number, @pr_labels)
+      end
+
+      # @param pr_number [Integer]
+      #
+      # @see https://docs.github.com/en/rest/issues/assignees?apiVersion=2022-11-28#add-assignees-to-an-issue
+      def add_pr_assignees(pr_number)
+        return if @pr_assignees.empty?
+
+        @client.add_assignees(@repository, pr_number, @pr_assignees)
+      end
+
+      # @param pr_number [Integer]
+      #
+      # @see https://docs.github.com/en/rest/pulls/review-requests?apiVersion=2022-11-28#request-reviewers-for-a-pull-request
+      def add_pr_reviewers(pr_number)
+        return if @pr_reviewers.empty?
+
+        @client.request_pull_request_review(@repository, pr_number, reviewers: @pr_reviewers)
+      end
+    end
+  end
+end