sashimi_tanpopo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '099fb0f8aa9d08ee9e8c1bf6c005b7df432489e959cd8e5cf29b621952fa3ab3'
+  data.tar.gz: 846da9967f9288a7cd0d3bc0aea82d8e958941a048188e7e4dc4bbc0aa05e3b8
+SHA512:
+  metadata.gz: ec54ab868a5855195d011bec93a2c4c62f1255fe9a75bda3a4677dec4a08de20da100407284e6fdd823c7cbc0883bb713a7b24f4c127cc700fb731bc791ef2de
+  data.tar.gz: 6c26659eb9d35b2cf79260f1f3dff44e30d310bf0008ccbbba3811d988984e9d7ad78ad3f7b84e62654251fe4bb6fa584bffdd99d3cce86049a781ac1aa3c1bf

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1,8 @@
+--markup markdown
+--no-private
+--hide-void-return
+--output-dir ./.doc
+-
+CHANGELOG.md
+LICENSE.txt
+docs/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-07
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 sue445
+
+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,148 @@
+# SashimiTanpopo :sushi: :blossom:
+Change files and create patches
+
+[![test](https://github.com/sue445/sashimi_tanpopo/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/sashimi_tanpopo/actions/workflows/test.yml)
+
+## Example
+```ruby
+# recipe.rb
+
+update_file ".ruby-version" do |content|
+  content.gsub!(/^[\d.]+$/, params[:ruby_version])
+end
+
+update_file "Dockerfile" do |content|
+  content.gsub!(/^FROM ruby:([\d.]+)$/, %Q{FROM ruby:#{params[:ruby_version]}})
+end
+
+@ruby_minor_version = params[:ruby_version].to_f
+
+update_file ".rubocop.yml" do |content|
+  content.gsub!(/TargetRubyVersion: ([\d.]+)/, "TargetRubyVersion: #{@ruby_minor_version}")
+end
+
+update_file ".github/workflows/*.yml" do |content|
+  content.gsub!(/ruby-version: "(.+)"/, %Q{ruby-version: "#{params[:ruby_version]}"})
+end
+```
+
+```bash
+# Update local app files using recipe.rb
+$ sashimi_tanpopo local --target-dir=/path/to/app --params=ruby_version:3.4.5 /path/to/recipe.rb
+
+# Update local app files using recipe.rb and create Pull Request
+$ sashimi_tanpopo github --target-dir=/path/to/app --params=ruby_version:3.4.5 \
+--message="Upgrade to Ruby 3.4.5" --github-repository=yourname/yourrepo --pr-title="Upgrade to Ruby 3.4.5" \
+--pr-source-branch=ruby_3.4.5 --pr-target-branch=main --pr-draft /path/to/recipe.rb
+```
+
+## Installation
+```bash
+gem install sashimi_tanpopo
+```
+
+## Usage
+### sashimi_tanpopo local
+Change local files using recipe files
+
+```bash
+$ sashimi_tanpopo help local
+
+Usage:
+  sashimi_tanpopo local RECIPE [RECIPE...]
+
+Options:
+  -d, [--target-dir=TARGET_DIR]                      # Target directory. Default: current directory
+  -p, [--params=key:value]                           # Params passed to recipe file
+      [--dry-run], [--no-dry-run], [--skip-dry-run]  # Whether to run dry run
+                                                     # Default: false
+      [--color], [--no-color], [--skip-color]        # Whether to colorize output
+                                                     # Default: true
+```
+
+### sashimi_tanpopo github
+Change local files using recipe files and create Pull Request
+
+```bash
+$ sashimi_tanpopo help github
+
+Usage:
+  sashimi_tanpopo github RECIPE [RECIPE...] --pr-source-branch=pr_branch --pr-title=PR_TITLE -m, --message=COMMIT_MESSAGE
+
+Options:
+  -d, [--target-dir=TARGET_DIR]                         # Target directory. Default: current directory
+  -p, [--params=key:value]                              # Params passed to recipe file
+      [--dry-run], [--no-dry-run], [--skip-dry-run]     # Whether to run dry run
+                                                        # Default: false
+      [--color], [--no-color], [--skip-color]           # Whether to colorize output
+                                                        # Default: true
+      [--git-user-name=GIT_USER_NAME]                   # user name for git commit. Default: username of user authenticated with token
+      [--git-email=GIT_EMAIL]                           # email for git commit. Default: <git_user_name>@users.noreply.<github_host>
+  -m, --message=COMMIT_MESSAGE                          # commit message
+      [--github-repository=user/repo]                   # GitHub repository for Pull Request. One of --github--repository or $GITHUB_REPOSITORY is required [$GITHUB_REPOSITORY]
+      [--github-api-url=GITHUB_API_URL]                 # GitHub API endpoint. One of --github-api-url or $GITHUB_API_URL is required [$GITHUB_API_URL]
+                                                        # Default: https://api.github.com
+      [--github-token=GITHUB_TOKEN]                     # GitHub access token. One of --github-token or $GITHUB_TOKEN is required [$GITHUB_TOKEN]
+      --pr-title=PR_TITLE                               # Pull Request title
+      [--pr-body=PR_BODY]                               # Pull Request body
+      --pr-source-branch=pr_branch                      # Pull Request source branch (a.k.a. head branch)
+      [--pr-target-branch=main]                         # Pull Request target branch (a.k.a. base branch). One of --pr-target-branch or $GITHUB_REF_NAME is required [$GITHUB_REF_NAME]
+      [--pr-assignees=one two three]                    # Pull Request assignees
+      [--pr-reviewers=one two three]                    # Pull Request reviewers
+      [--pr-labels=one two three]                       # Pull Request labels
+      [--pr-draft], [--no-pr-draft], [--skip-pr-draft]  # Whether to create draft Pull Request
+                                                        # Default: false
+```
+
+### sashimi_tanpopo gitlab
+Change local files using recipe files and create Merge Request
+
+```bash
+$ sashimi_tanpopo help gitlab
+
+Usage:
+  sashimi_tanpopo gitlab RECIPE [RECIPE...] --mr-source-branch=mr_branch --mr-title=MR_TITLE -m, --message=COMMIT_MESSAGE
+
+Options:
+  -d, [--target-dir=TARGET_DIR]                                        # Target directory. Default: current directory
+  -p, [--params=key:value]                                             # Params passed to recipe file
+      [--dry-run], [--no-dry-run], [--skip-dry-run]                    # Whether to run dry run
+                                                                       # Default: false
+      [--color], [--no-color], [--skip-color]                          # Whether to colorize output
+                                                                       # Default: true
+      [--git-user-name=GIT_USER_NAME]                                  # user name for git commit. Default: username of user authenticated with token
+      [--git-email=GIT_EMAIL]                                          # email for git commit. Default: <git_user_name>@noreply.<gitlab_host>
+  -m, --message=COMMIT_MESSAGE                                         # commit message
+      [--gitlab-project=user/repo]                                     # GitLab project for Merge Request. One of --gitlab-project, $GITLAB_PROJECT or $CI_PROJECT_PATH is required [$GITLAB_PROJECT, $CI_PROJECT_PATH]
+      [--gitlab-api-url=GITLAB_API_URL]                                # GitLab API endpoint. One of --gitlab-api-url, $GITLAB_API_URL or $CI_API_V4_URL is required [$GITLAB_API_URL, $CI_API_V4_URL]
+                                                                       # Default: https://gitlab.com/api/v4
+      [--gitlab-token=GITLAB_TOKEN]                                    # GitLab access token. One of --gitlab-token or $GITLAB_TOKEN is required [$GITLAB_TOKEN]
+      --mr-title=MR_TITLE                                              # Merge Request title
+      [--mr-body=MR_BODY]                                              # Merge Request body
+      --mr-source-branch=mr_branch                                     # Merge Request source branch
+      [--mr-target-branch=main]                                        # Merge Request target branch). One of --mr-target-branch, $MR_TARGET_BRANCH or $CI_DEFAULT_BRANCH is required [$MR_TARGET_BRANCH, $CI_DEFAULT_BRANCH]
+      [--mr-assignees=one two three]                                   # Merge Request assignees
+      [--mr-reviewers=one two three]                                   # Merge Request reviewers
+      [--mr-labels=one two three]                                      # Merge Request labels
+      [--mr-draft], [--no-mr-draft], [--skip-mr-draft]                 # Whether to create draft Merge Request
+                                                                       # Default: false
+      [--mr-auto-merge], [--no-mr-auto-merge], [--skip-mr-auto-merge]  # Whether to set auto-merge to Merge Request
+                                                                       # Default: false
+```
+
+## Recipe file specification
+See [docs/RECIPE.md](docs/RECIPE.md)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/sashimi_tanpopo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :rbs do
+  desc "`rbs collection install` and `git commit`"
+  task :install do
+    sh "rbs collection install"
+    sh "git add rbs_collection.lock.yaml"
+    sh "git commit -m 'rbs collection install' || true"
+  end
+end
+
+desc "Check rbs"
+task :rbs do
+  sh "rbs validate"
+  sh "steep check"
+end
+
+task default: %i[spec rbs]

data/Steepfile

@@ -0,0 +1,32 @@
+# D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  ignore_signature "sig/test"
+
+  check "lib"                       # Directory name
+  # check "path/to/source.rb"         # File name
+  # check "app/models/**/*.rb"        # Glob
+  # ignore "lib/templates/*.rb"
+
+  # library "pathname"              # Standard libraries
+  # library "strong_json"           # Gems
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   unreferenced!                     # Skip type checking the `lib` code when types in `test` target is changed
+#   signature "sig/test"              # Put RBS files for tests under `sig/test`
+#   check "test"                      # Type check Ruby scripts under `test`
+#
+#   configure_code_diagnostics(D::Ruby.lenient)      # Weak type checking for test code
+#
+#   # library "pathname"              # Standard libraries
+# end

data/docs/RECIPE.md

@@ -0,0 +1,63 @@
+# Recipe file specification
+Recipe file is simple Ruby script, with some exceptions.
+
+By avoiding the DSL methods listed below, you are free to write code as you like.
+
+## Special methods available within recipe file
+The following methods are special variables available within recipe file.
+
+### `dry_run?`
+Whether dry run
+
+e.g.
+
+```rb
+unless dry_run?
+  puts "This will be called when apply mode"
+end
+```
+
+### `params`
+Passed from `--params`
+
+Returns:
+
+* `Hash<Symbol, String>`
+
+e.g.
+
+```bash
+sashimi_tanpopo local --params name:sue445 --params lang:ja recipe.rb
+```
+
+within `recipe.rb`
+
+```rb
+# recipe.rb
+
+params
+#=> {name: "sue445", lang: "ja"}
+```
+
+### `update_file`
+Update files if exists
+
+```ruby
+# Update single file
+update_file "test.txt" do |content|
+  content.gsub!("name", params[:name])
+end
+
+# Update multiple files
+update_file ".github/workflows/*.yml" do |content|
+  content.gsub!(/ruby-version: "(.+)"/, %Q{ruby-version: "#{params[:ruby_version]}"})
+end
+```
+
+Parameters:
+
+* `pattern`: 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`)
+
+Yield Parameters:
+
+* `content`: Content of file. If `content` is changed in block, file will be changed.

data/exe/sashimi_tanpopo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "sashimi_tanpopo/cli"
+
+SashimiTanpopo::CLI.start(ARGV)

data/lib/sashimi_tanpopo/cli.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require "thor"
+require "sashimi_tanpopo"
+
+module SashimiTanpopo
+  class CLI < Thor
+    desc "version", "Show sashimi_tanpopo version"
+    def version
+      puts "sashimi_tanpopo v#{SashimiTanpopo::VERSION}"
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def self.define_exec_common_options
+      option :target_dir, type: :string, aliases: "-d", desc: "Target directory. Default: current directory"
+      option :params,     type: :hash, aliases: "-p", default: {}, desc: "Params passed to recipe file", repeatable: true
+      option :dry_run,    type: :boolean, default: false, desc: "Whether to run dry run"
+      option :color,      type: :boolean, default: true, desc: "Whether to colorize output"
+    end
+
+    desc "local RECIPE [RECIPE...]", "Change local files using recipe files"
+    define_exec_common_options
+    def local(*recipe_files)
+      Provider::Local.new(
+        recipe_paths: recipe_files,
+        target_dir:   options[:target_dir],
+        params:       self.class.normalize_params(options[:params]),
+        dry_run:      options[:dry_run],
+        is_colored:   options[:color],
+      ).perform
+    end
+
+    desc "github RECIPE [RECIPE...]", "Change local files using recipe files and create Pull Request"
+    define_exec_common_options
+    option :git_user_name,     type: :string,  desc: "user name for git commit. Default: username of user authenticated with token"
+    option :git_email,         type: :string,  desc: "email for git commit. Default: <git_user_name>@users.noreply.<github_host>"
+    option :message,           type: :string,  desc: "commit message", required: true, aliases: "-m", banner: "COMMIT_MESSAGE"
+    option :github_repository, type: :string,  desc: "GitHub repository for Pull Request. One of --github--repository or $GITHUB_REPOSITORY is required [$GITHUB_REPOSITORY]", banner: "user/repo"
+    option :github_api_url,    type: :string,  desc: "GitHub API endpoint. One of --github-api-url or $GITHUB_API_URL is required [$GITHUB_API_URL]", default: "https://api.github.com"
+    option :github_token,      type: :string,  desc: "GitHub access token. One of --github-token or $GITHUB_TOKEN is required [$GITHUB_TOKEN]"
+    option :pr_title,          type: :string,  desc: "Pull Request title", required: true
+    option :pr_body,           type: :string,  desc: "Pull Request body"
+    option :pr_source_branch,  type: :string,  desc: "Pull Request source branch (a.k.a. head branch)", required: true, banner: "pr_branch"
+    option :pr_target_branch,  type: :string,  desc: "Pull Request target branch (a.k.a. base branch). One of --pr-target-branch or $GITHUB_REF_NAME is required [$GITHUB_REF_NAME]", banner: "main"
+    option :pr_assignees,      type: :array,   desc: "Pull Request assignees", default: []
+    option :pr_reviewers,      type: :array,   desc: "Pull Request reviewers", default: []
+    option :pr_labels,         type: :array,   desc: "Pull Request labels", default: []
+    option :pr_draft,          type: :boolean, desc: "Whether to create draft Pull Request", default: false
+    def github(*recipe_files)
+      repository       = option_or_env!(option_name: :github_repository, env_name: "GITHUB_REPOSITORY")
+      api_endpoint     = option_or_env!(option_name: :github_api_url,    env_name: "GITHUB_API_URL")
+      access_token     = option_or_env!(option_name: :github_token,      env_name: "GITHUB_TOKEN")
+      pr_target_branch = option_or_env!(option_name: :pr_target_branch,  env_name: "GITHUB_REF_NAME")
+
+      Provider::GitHub.new(
+        recipe_paths:     recipe_files,
+        target_dir:       options[:target_dir],
+        params:           self.class.normalize_params(options[:params]),
+        dry_run:          options[:dry_run],
+        is_colored:       options[:color],
+        git_username:     options[:git_user_name],
+        git_email:        options[:git_email],
+        commit_message:   options[:message],
+        repository:       repository,
+        api_endpoint:     api_endpoint,
+        access_token:     access_token,
+        pr_title:         options[:pr_title],
+        pr_body:          options[:pr_body],
+        pr_source_branch: options[:pr_source_branch],
+        pr_target_branch: pr_target_branch,
+        pr_assignees:     options[:pr_assignees],
+        pr_reviewers:     options[:pr_reviewers],
+        pr_labels:        options[:pr_labels],
+        is_draft_pr:      options[:pr_draft],
+      ).perform
+    end
+
+    desc "gitlab RECIPE [RECIPE...]", "Change local files using recipe files and create Merge Request"
+    define_exec_common_options
+    option :git_user_name,     type: :string,  desc: "user name for git commit. Default: username of user authenticated with token"
+    option :git_email,         type: :string,  desc: "email for git commit. Default: <git_user_name>@noreply.<gitlab_host>"
+    option :message,           type: :string,  desc: "commit message", required: true, aliases: "-m", banner: "COMMIT_MESSAGE"
+    option :gitlab_project,    type: :string,  desc: "GitLab project for Merge Request. One of --gitlab-project, $GITLAB_PROJECT or $CI_PROJECT_PATH is required [$GITLAB_PROJECT, $CI_PROJECT_PATH]", banner: "user/repo"
+    option :gitlab_api_url,    type: :string,  desc: "GitLab API endpoint. One of --gitlab-api-url, $GITLAB_API_URL or $CI_API_V4_URL is required [$GITLAB_API_URL, $CI_API_V4_URL]", default: "https://gitlab.com/api/v4"
+    option :gitlab_token,      type: :string,  desc: "GitLab access token. One of --gitlab-token or $GITLAB_TOKEN is required [$GITLAB_TOKEN]"
+    option :mr_title,          type: :string,  desc: "Merge Request title", required: true
+    option :mr_body,           type: :string,  desc: "Merge Request body"
+    option :mr_source_branch,  type: :string,  desc: "Merge Request source branch", required: true, banner: "mr_branch"
+    option :mr_target_branch,  type: :string,  desc: "Merge Request target branch). One of --mr-target-branch, $MR_TARGET_BRANCH or $CI_DEFAULT_BRANCH is required [$MR_TARGET_BRANCH, $CI_DEFAULT_BRANCH]", banner: "main"
+    option :mr_assignees,      type: :array,   desc: "Merge Request assignees", default: []
+    option :mr_reviewers,      type: :array,   desc: "Merge Request reviewers", default: []
+    option :mr_labels,         type: :array,   desc: "Merge Request labels", default: []
+    option :mr_draft,          type: :boolean, desc: "Whether to create draft Merge Request", default: false
+    option :mr_auto_merge,     type: :boolean, desc: "Whether to set auto-merge to Merge Request", default: false
+    def gitlab(*recipe_files)
+      repository       = option_or_env!(option_name: :gitlab_project,   env_name: %w[GITLAB_PROJECT CI_PROJECT_PATH])
+      api_endpoint     = option_or_env!(option_name: :gitlab_api_url,   env_name: %w[GITLAB_API_URL CI_API_V4_URL])
+      access_token     = option_or_env!(option_name: :gitlab_token,     env_name: "GITLAB_TOKEN")
+      mr_target_branch = option_or_env!(option_name: :mr_target_branch, env_name: %w[MR_TARGET_BRANCH CI_DEFAULT_BRANCH])
+
+      Provider::GitLab.new(
+        recipe_paths:     recipe_files,
+        target_dir:       options[:target_dir],
+        params:           self.class.normalize_params(options[:params]),
+        dry_run:          options[:dry_run],
+        is_colored:       options[:color],
+        git_username:     options[:git_user_name],
+        git_email:        options[:git_email],
+        commit_message:   options[:message],
+        repository:       repository,
+        api_endpoint:     api_endpoint,
+        access_token:     access_token,
+        mr_title:         options[:mr_title],
+        mr_body:          options[:mr_body],
+        mr_source_branch: options[:mr_source_branch],
+        mr_target_branch: mr_target_branch,
+        mr_assignees:     options[:mr_assignees],
+        mr_reviewers:     options[:mr_reviewers],
+        mr_labels:        options[:mr_labels],
+        is_draft_mr:      options[:mr_draft],
+        is_auto_merge:    options[:mr_auto_merge],
+      ).perform
+    end
+
+    # @param params [Hash<String, String>]
+    # @return [Hash<Symbol,String>]
+    #
+    # @example
+    #   normalize_params({"k1"=>"v1", "k2"=>"v2"})
+    #   #=> {k1: "v1", k2: "v2"}
+    def self.normalize_params(params)
+      params.transform_keys(&:to_sym)
+    end
+
+    private
+
+    no_commands do
+      # @param option_name [String,Symbol]
+      # @param env_name [String, Array<String>]
+      # @param default [String,nil]
+      # @return [String,nil]
+      def option_or_env(option_name:, env_name:, default:  nil)
+        return options[option_name] if options[option_name] && !options[option_name].empty?
+
+        env_names = Array(env_name) #: Array[String]
+        env_names.each do |name|
+          return ENV[name] unless ENV.fetch(name, "") == ""
+        end
+
+        default
+      end
+
+      # @param option_name [String,Symbol]
+      # @param env_name [String, Array<String>]
+      # @return [String]
+      def option_or_env!(option_name:, env_name:)
+        value = option_or_env(option_name: option_name, env_name: env_name)
+        return value if value
+
+        env_names = Array(env_name)
+        SashimiTanpopo.logger.error "Error: One of --#{option_name.to_s.gsub("_", "-")}, #{env_names.join(", ")} is required!"
+        exit!
+      end
+    end
+  end
+end