capistrano-ops 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c704ca49f84574a85d2c47a54a03973232d6186275e95d8058821b9576594f8b
-  data.tar.gz: dd1da7bb882eed3d1d94c7d3e7207747a7ec882308d7c6d543eaddffaf2da615
+  metadata.gz: 708599bef12f8e7ce1b96a36fb09c1bc9acc4d50d871f2d1d5a3790240455096
+  data.tar.gz: 8c13bfc221324e6303f474453185f868d9984dba83da63de7715b747d9113594
 SHA512:
-  metadata.gz: '011919060f16a1ac77da503fb9fda693a46a77f62ecba22946fc38c02c3a93f89f88ac92439813c7e533af9219f8bd9d8bb62fad3fd70fea0c9e783443f108f6'
-  data.tar.gz: a04fdf286d5cb8be105da2304d85011c063b3906d6d32d11923e678cd3433917e6da0db1a869048d97d26e1945530cc99e3435ba32520b686dfc9d25c59b5b5a
+  metadata.gz: 3bd6ada29edf5e6a3c077c35a83908d1b40e235b0f33497a33b309e7902ea4fe16910a078e41b5bd5feb58246d4903e31b31d32567d88341ec5847c89a435aa9
+  data.tar.gz: 2d987eaaab73c8c5a6f595226371c8979d816656e3014fa744b1725bb27dff4e82cdd66d79e92dcc89fd2963dc03f5c3e6f5ede7a85c0fc33f639c7ff9e0dcfa

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+    labels:
+      - dependencies
+      - ruby
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    labels:
+      - dependencies
+      - ci

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version-file: .ruby-version
+          bundler-cache: true
+      - run: bundle exec rubocop --parallel
+
+  audit:
+    name: bundler-audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version-file: .ruby-version
+          bundler-cache: true
+      - run: bundle exec bundle-audit check --update
+
+  test:
+    name: RSpec (Ruby ${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.3', '3.4']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  publish:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version-file: .ruby-version
+          bundler-cache: true
+
+      - uses: rubygems/release-gem@v1

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.ruby-lsp/
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/.rspec

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

data/.rubocop.yml

@@ -1,28 +1,88 @@
-require:
-  - rubocop-performance
-  - rubocop-rails
+inherit_from: .rubocop_todo.yml
+
+# RuboCop configuration for capistrano-ops gem
+
 AllCops:
-  NewCops: disable
-  TargetRubyVersion: 2.7
-Layout/LineLength:
-  Max: 160
-Metrics/MethodLength:
-  Max: 50
-Metrics/ClassLength:
-  Max: 750
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'bin/**/*'
+    - 'lib/capistrano/ops/local/**/*'
+
+# Metrics
+
 Metrics/BlockLength:
   Max: 50
-Metrics/ParameterLists:
-  Max: 6
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 40
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/AbcSize:
-  Max: 60
+  Max: 65
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/CyclomaticComplexity:
-  Max: 25
+  Max: 10
+
 Metrics/PerceivedComplexity:
-  Max: 25
+  Max: 10
+
+# Style
+
 Style/Documentation:
   Enabled: false
-Rails/RakeEnvironment:
-  Enabled: false
-Rails/Output:
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+# Layout
+
+Layout/LineLength:
+  Max: 150
+  AllowedPatterns:
+    - '\s+# '
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+# Lint
+
+Gemspec/DevelopmentDependencies:
   Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,55 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude --no-auto-gen-timestamp`
+# using RuboCop version 1.91.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/capistrano/ops/rails/lib/tasks/pg/dump.rake'
+    - 'lib/capistrano/ops/rails/lib/tasks/storage/storage_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, Max, CountAsOne.
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/capistrano/ops/rails/lib/backup/s3.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/capistrano/ops/rails/lib/backup/s3.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/capistrano/ops/rails/lib/backup/s3.rb'
+
+# Offense count: 2
+# Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
+# AllowedMethods: call
+# WaywardPredicates: infinite?, nonzero?
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/capistrano/ops/figaro_yml/helpers.rb'
+    - 'lib/capistrano/ops/logrotate/helpers.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/capistrano/ops/figaro_yml/helpers.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/capistrano/ops/rails/lib/tasks/storage/storage_helper.rb'

data/.ruby-version

@@ -1 +1 @@
-2.7.0
+3.4.10

data/CHANGELOG.md

@@ -0,0 +1,347 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2026-09-18
+
+### Added
+
+- Add CI workflow (`.github/workflows/ci.yml`) with a Ruby matrix (3.2, 3.3, 3.4) running RSpec, plus separate RuboCop and bundler-audit jobs
+- Add Dependabot config for weekly `bundler` and `github-actions` updates
+- Add `bundler-audit` dev-dependency and Rake task
+- Add minimal spec harness (`spec/spec_helper.rb`, `.rspec`, version smoke spec)
+- Add `.rubocop_todo.yml` baseline for new cops that would require API-shape changes (metrics, predicate naming, keyword args)
+
+### Changed
+
+- Widen `required_ruby_version` to `>= 3.2` (previously `>= 3.1.4, < 3.4.0` — blocked Ruby 3.4/3.5)
+- Add version bounds for `rails` (`>= 7.2, < 9`), `faraday` (`>= 2.0, < 3.0`) and `nokogiri` (`>= 1.15`)
+- Bump `.ruby-version` to `3.4.10`; release workflow now reads it via `ruby-version-file`
+- Bump `.rubocop.yml` `TargetRubyVersion` to `3.2` and enable `Gemspec/RequireMFA`
+- Bump dev-dependencies: `bundler >= 2.4, < 5`, `rubocop ~> 1.80`, `rubocop-rake ~> 0.7`, `rubocop-rspec ~> 3.0`
+- `rake` default now runs `spec` + `rubocop`
+
+### Removed
+
+- Remove obsolete `.travis.yml` (Travis CI is end-of-life)
+- Remove stray `release.gem` build artifact from repo root
+- Remove dead `lib/capistrano/ops/capistrano/v3/tasks/backup.rake`: never wired into `TaskLoader`, required a non-existent `backup_helper` file, and its deprecated tasks (`backup:create` / `backup:pull`) had been superseded by `backup:database:*`
+
+### Fixed
+
+- Fix `NameError` in `Notification::Webhook#backup_notification` when notification level was `error` on a successful backup (`_notification_level` param was referenced without the underscore)
+- Fix `bin/console`: required non-existent `capistrano/rake`; now requires `capistrano/ops`
+- Correct copy-paste header in `.rubocop.yml` (was labeled for `ms-graph-mailer`)
+
+### Docs
+
+- Clarify optional runtime dependencies (`whenever`, `figaro`, `wicked_pdf`) in README; state Ruby and Rails floors explicitly
+
+## [1.0.11] - 2025-12-22
+
+### Added
+
+- Add GitHub Actions workflow for automated gem releases to RubyGems.org
+- Add comprehensive CHANGELOG.md with complete version history
+- Add version bump script (bump_version.rb) for automated version management
+- Add RuboCop configuration for code style enforcement
+
+### Changed
+
+- Update aws-sdk-s3 dependency to ~> 1.208
+- Update Ruby version requirements to >= 3.1.4, < 3.4.0
+
+## [v1.0.10] - 2025-03-04
+
+### Changed
+
+- Update required Ruby version to < 3.4.0
+
+## [v1.0.9] - 2024-12-20
+
+### Fixed
+
+- Fix missing variables in S3 multipart upload
+- Update chunk size calculation for S3 uploads
+
+## [v1.0.8] - 2024-12-16
+
+### Fixed
+
+- Add retry logic to S3 uploads for improved reliability
+
+## [v1.0.7] - 2024-12-05
+
+### Fixed
+
+- Minor version bump with typo fixes
+
+## [v1.0.6] - 2024-12-04
+
+### Fixed
+
+- Fix inheritable_copy error
+
+## [v1.0.5] - 2024-12-04
+
+### Fixed
+
+- Update S3 upload to allow streaming directly into tar.gz file
+
+## [v1.0.4] - 2024-08-14
+
+### Fixed
+
+- Update configs helper to retain other stages locally when working with figaro_yml
+
+## [v1.0.3] - 2024-07-15
+
+### Added
+
+- Enhance gem presence check with regex for better Gemfile validation
+
+## [v1.0.2] - 2024-07-15
+
+### Fixed
+
+- Fix wkhtmltopdf broken functionality
+
+## [v1.0.1] - 2024-07-15
+
+### Fixed
+
+- Fix wkhtmltopdf broken functionality (additional fixes)
+
+## [v1.0.0] - 2024-07-11
+
+### Changed
+
+- Major version release - Prepare for v1 release
+- Stable API and feature set
+
+## [v0.2.14] - 2024-06-29
+
+### Changed
+
+- Cleanup figaro_yml tasks
+
+## [v0.2.13] - 2024-06-12
+
+### Added
+
+- Add wkhtmltopdf support
+- Add loader file for wkhtmltopdf Capistrano task
+- Add wkhtmltopdf setup and permission checks for deployment tasks
+
+## [v0.2.12] - 2024-06-10
+
+### Added
+
+- Implement comprehensive logrotate functionality
+
+## [v0.2.11] - 2024-04-16
+
+### Fixed
+
+- Fix logical issue with KEEP_LOCAL_STORAGE_BACKUPS environment variable
+
+## [v0.2.10] - 2024-04-15
+
+### Added
+
+- Add ENV option to remove local storage backups if external backups enabled
+- Update README with new configuration options
+
+## [v0.2.9] - 2024-01-15
+
+### Added
+
+- Add backup thinning functionality to manage backup retention
+
+## [v0.2.8] - 2023-09-07
+
+### Changed
+
+- Update required Ruby version
+
+## [v0.2.7] - 2023-08-31
+
+### Fixed
+
+- Fix missing download functionality in backup
+
+## [v0.2.6] - 2023-08-25
+
+### Fixed
+
+- Fix configuration error
+
+## [v0.2.5] - 2023-08-14
+
+### Changed
+
+- Optimize backups functionality
+
+## [v0.2.4] - 2023-08-13
+
+### Changed
+
+- Update README documentation
+- Add Faraday for HTTP requests
+- Add/split Capistrano backup tasks
+- Add deprecation warnings
+
+### Added
+
+- Add .rubocop.yml for code style enforcement
+
+## [v0.2.3] - 2023-07-24
+
+### Added
+
+- Add external backup provider support
+- Add S3 object storage provider
+- Update notification service
+
+### Changed
+
+- Major refactoring of backup system
+
+### Known Issues
+
+- Webhook notification service temporarily broken
+
+## [v0.2.2] - 2023-07-08
+
+### Changed
+
+- Let bundler choose versions for better dependency management
+- Only notify if update fails
+
+### Fixed
+
+- Resolve dependency conflicts for Rails 7 compatibility
+
+## [v0.1.5] - 2023-03-15
+
+### Fixed
+
+- Set dependencies by ruby_version
+
+## [v0.1.4] - 2023-03-13
+
+### Changed
+
+- Optimize database dumps
+
+## [v0.1.3] - 2023-03-08
+
+### Fixed
+
+- Fix bad class declaration in Railtie
+
+## [v0.1.2] - 2023-03-06
+
+### Added
+
+- Add functionality to get application.yml from server
+
+### Changed
+
+- Update README documentation
+
+## [v0.1.1] - 2023-03-06
+
+### Added
+
+- Add get application yaml functionality
+
+## [v0.1.0] - 2023-03-06
+
+### Changed
+
+- Rename gem to capistrano-ops
+- Major version bump for initial stable release
+
+## [v0.0.7] - 2022-12-14
+
+### Added
+
+- Add task to run rake task on server
+
+### Changed
+
+- Update readme and refactor backup.rake
+
+## [v0.0.6] - 2022-12-08
+
+### Fixed
+
+- Fix figaro_yml compare functionality
+
+## [v0.0.5] - 2022-12-07
+
+### Fixed
+
+- Fix issue with stdin handling
+
+## [v0.0.4] - 2022-12-07
+
+### Fixed
+
+- Fix issue with stdin handling (additional fixes)
+
+## [v0.0.3] - 2022-12-07
+
+### Fixed
+
+- Fix PGPASSWORD export
+
+## Initial Release - 2022-12-07
+
+### Added
+
+- Initial commit with core functionality
+- Database backup capabilities
+- Figaro YAML management
+- Basic Capistrano integration
+
+[Unreleased]: https://github.com/zauberware/capistrano-ops/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/zauberware/capistrano-ops/releases/tag/v1.1.0
+[1.0.11]: https://github.com/zauberware/capistrano-ops/releases/tag/v1.0.11
+[v1.0.10]: https://github.com/zauberware/capistrano-ops/compare/v1.0.9...v1.0.10
+[v1.0.9]: https://github.com/zauberware/capistrano-ops/compare/v1.0.8...v1.0.9
+[v1.0.8]: https://github.com/zauberware/capistrano-ops/compare/v1.0.7...v1.0.8
+[v1.0.7]: https://github.com/zauberware/capistrano-ops/compare/v1.0.6...v1.0.7
+[v1.0.6]: https://github.com/zauberware/capistrano-ops/compare/v1.0.5...v1.0.6
+[v1.0.5]: https://github.com/zauberware/capistrano-ops/compare/v1.0.4...v1.0.5
+[v1.0.4]: https://github.com/zauberware/capistrano-ops/compare/v1.0.3...v1.0.4
+[v1.0.3]: https://github.com/zauberware/capistrano-ops/compare/v1.0.2...v1.0.3
+[v1.0.2]: https://github.com/zauberware/capistrano-ops/compare/v1.0.1...v1.0.2
+[v1.0.1]: https://github.com/zauberware/capistrano-ops/compare/v1.0.0...v1.0.1
+[v1.0.0]: https://github.com/zauberware/capistrano-ops/compare/v0.2.14...v1.0.0
+[v0.2.14]: https://github.com/zauberware/capistrano-ops/compare/v0.2.13...v0.2.14
+[v0.2.13]: https://github.com/zauberware/capistrano-ops/compare/v0.2.12...v0.2.13
+[v0.2.12]: https://github.com/zauberware/capistrano-ops/compare/v0.2.11...v0.2.12
+[v0.2.11]: https://github.com/zauberware/capistrano-ops/compare/v0.2.10...v0.2.11
+[v0.2.10]: https://github.com/zauberware/capistrano-ops/compare/v0.2.9...v0.2.10
+[v0.2.9]: https://github.com/zauberware/capistrano-ops/compare/v0.2.8...v0.2.9
+[v0.2.8]: https://github.com/zauberware/capistrano-ops/compare/v0.2.7...v0.2.8
+[v0.2.7]: https://github.com/zauberware/capistrano-ops/compare/v0.2.6...v0.2.7
+[v0.2.6]: https://github.com/zauberware/capistrano-ops/compare/v0.2.5...v0.2.6
+[v0.2.5]: https://github.com/zauberware/capistrano-ops/compare/v0.2.4...v0.2.5
+[v0.2.4]: https://github.com/zauberware/capistrano-ops/compare/v0.2.3...v0.2.4
+[v0.2.3]: https://github.com/zauberware/capistrano-ops/compare/v0.2.2...v0.2.3
+[v0.2.2]: https://github.com/zauberware/capistrano-ops/compare/v0.1.5...v0.2.2
+[v0.1.5]: https://github.com/zauberware/capistrano-ops/compare/v0.1.4...v0.1.5
+[v0.1.4]: https://github.com/zauberware/capistrano-ops/compare/v0.1.3...v0.1.4
+[v0.1.3]: https://github.com/zauberware/capistrano-ops/compare/v0.1.2...v0.1.3
+[v0.1.2]: https://github.com/zauberware/capistrano-ops/compare/v0.1.1...v0.1.2
+[v0.1.1]: https://github.com/zauberware/capistrano-ops/compare/v0.1.0...v0.1.1
+[v0.1.0]: https://github.com/zauberware/capistrano-ops/compare/v0.0.7...v0.1.0
+[v0.0.7]: https://github.com/zauberware/capistrano-ops/releases/tag/v0.0.7

data/README.md

@@ -78,14 +78,23 @@ The capistrano-ops gem is a valuable library, tailor-made for Rails DevOps profe
 
 ## Requirements
 
-```ruby
-'capistrano', '~> 3.0'
-'whenever' # for scheduling tasks
-'figaro' # for environment variables if you use figaro_yml tasks
+Runtime requirements pulled in by the gem itself:
+
+- Ruby `>= 3.2`
+- Rails `>= 7.2, < 9`
+- `capistrano ~> 3.0` (in your app)
+
+Optional runtime dependencies — the corresponding task groups are only
+loaded when the gem is present in your `Gemfile`:
 
-# hint: if you use other aws-sdk gems, its possible that you have to update them too
+```ruby
+gem 'whenever'    # enables whenever:show_crontab
+gem 'figaro'      # enables figaro_yml:* tasks
+gem 'wicked_pdf'  # enables wkhtmltopdf:setup (with wkhtmltopdf-binary)
 ```
 
+> hint: if you use other aws-sdk gems, it's possible that you have to update them too
+
 [↑](#)
 
 ## Installation

data/Rakefile

@@ -2,7 +2,28 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'bundler/audit/task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+Bundler::Audit::Task.new
 
-task default: :spec
+task default: %i[spec rubocop]
+
+namespace :version do
+  desc 'Bump patch version (0.1.0 -> 0.1.1)'
+  task :patch do
+    ruby 'scripts/bump_version.rb patch'
+  end
+
+  desc 'Bump minor version (0.1.0 -> 0.2.0)'
+  task :minor do
+    ruby 'scripts/bump_version.rb minor'
+  end
+
+  desc 'Bump major version (0.1.0 -> 1.0.0)'
+  task :major do
+    ruby 'scripts/bump_version.rb major'
+  end
+end

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'capistrano/rake'
+require 'capistrano/ops'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.