capistrano-data_plane_api 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 297cd22ece0e041f4f66d9cc3152f484e3ae8b12521f90904231201fce8ab926
-  data.tar.gz: 40f67d1856921f004299cc98f536f4de2a9a9f5c50a5871a2bac73f860cfd74f
+  metadata.gz: 502c957860848750f102b26efbdc1bae2e4aacc70d4597394806fa48f877bde5
+  data.tar.gz: 6be72e9c47e67a70ed54833f74bce86a736a40750dada0892f9481009318c55a
 SHA512:
-  metadata.gz: 40544833867016abbd903eda2ae793e8ba8ec6c561d7d5d8358f1c0cd4b063acf6235c9dcc54027b3718f62e405fb0519df835a096867776bb6888d1425a9531
-  data.tar.gz: 5e0e7a3ccc2a118d3161542f0a31fde548ee5b7e228aa7b92936b109095bc46d1f3dd70df2847ebf2e5821eff6773d4967fc21bccfdac8be928d13a6ce4e34ce
+  metadata.gz: 2cf8ee103dbf52dc98e19c3f3927b3e997cb7b2b5fd504338dd8d3f754dd44f4073e53218baa6a821d7d0667af0f99e595786b6ad5cf2343aeb150df5265fa76
+  data.tar.gz: d3efeff078f47dce3c04aa93ffb169da6b8c575e2725313adceea52a706d34c0d3b1fce63b610c2ebb6b68828e7e92a47675044ef271968d0f4b8bc243c0a9f8

data/.rubocop.yml

@@ -1,5 +1,8 @@
 inherit_gem:
-  rubocop-espago: rubocop.yml
+  rubocop-espago: sorbet.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
+
+Naming/FileName:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.2.0
+3.4.5

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-12-28
+## [0.3.0] - 09.09.2025
+
+- Add `api_url` per HAProxy backend
+- Add `--no-asset-precompilation` CLI flag
+
+## [0.2.0] - 11.04.2025
+
+- Update `data_plane_api` to `>= 0.2.0`
+- Add the `-C`/`--check` flag to `bin/deploy`
+- Rewrite YARD to sorbet (with inline RBS)
+
+## [0.1.0] - 28.12.2022
 
 - Initial release

data/Gemfile

@@ -5,11 +5,14 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in capistrano-data_plane_api.gemspec
 gemspec
 
-gem 'minitest', '~> 5.0' # Test framework
+gem 'byebug', '~> 12.0' # debugger
+gem 'minitest', '~> 5.0' # Tests framework
 gem 'rake', '~> 13.0' # Ruby automation tasks
 gem 'rubocop', '~> 1.21' # Ruby linter
 gem 'rubocop-espago', '~> 1.0' # Custom Ruby linter config
-gem 'solargraph' # Ruby language server
+gem 'rubocop-sorbet', '~> 0.10.0' # Rubocop config for sorbet
 gem 'shoulda-context', '~> 2.0' # Testing utilities
-gem 'vcr' # Save HTTP interactions to files during tests
-gem 'webmock' # Mock network interactions
+gem 'sorbet', '~> 0.5' # static typechecker
+gem 'tapioca', '~> 0.16.11', require: false # RBI generator
+gem 'vcr', '~> 6.3.1' # Save HTTP interactions to files during tests
+gem 'webmock', '~> 3.25.1' # Mock network interactions

data/Gemfile.lock

@@ -1,10 +1,13 @@
 PATH
   remote: .
   specs:
-    capistrano-data_plane_api (0.1.5)
-      data_plane_api (~> 0.1)
+    capistrano-data_plane_api (0.3.0)
+      booleans (~> 0.1)
+      data_plane_api (>= 0.2)
       pastel (< 1)
       shale (>= 1, < 2)
+      shale-builder (~> 0.2.4)
+      sorbet-runtime (~> 0.5)
       thor (> 1, < 2)
       tty-box (< 1)
       tty-cursor (< 1)
@@ -12,117 +15,154 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    backport (1.2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.2.0)
     benchmark (0.2.1)
-    crack (0.4.5)
+    bigdecimal (3.1.9)
+    booleans (0.1.3)
+      sorbet-runtime (>= 0.5)
+    byebug (12.0.0)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    data_plane_api (0.1.2)
+    data_plane_api (0.2.0)
+      booleans (~> 0.1.3)
       faraday (> 1, < 3)
-    diff-lcs (1.5.0)
-    e2mmap (0.1.0)
-    faraday (2.7.2)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    hashdiff (1.0.1)
-    jaro_winkler (1.5.4)
-    json (2.6.3)
-    kramdown (2.4.0)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    mini_portile2 (2.8.1)
-    minitest (5.16.3)
-    nokogiri (1.13.10)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.3.0)
+      sorbet-runtime (~> 0.5)
+    erubi (1.13.1)
+    faraday (2.13.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    hashdiff (1.1.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    net-http (0.6.0)
+      uri
+    netrc (0.11.0)
+    parallel (1.26.3)
+    parser (3.3.7.4)
       ast (~> 2.4.1)
+      racc
     pastel (0.8.0)
       tty-color (~> 0.5)
-    public_suffix (5.0.1)
-    racc (1.6.2)
+    prism (1.4.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
-    reverse_markdown (2.1.1)
-      nokogiri
-    rexml (3.2.5)
-    rubocop (1.41.1)
+    rbi (0.3.1)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+      sorbet-runtime (>= 0.5.9204)
+    rbs (3.9.2)
+      logger
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.75.2)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    rubocop-espago (1.0.2)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-espago (1.1.8)
       rubocop
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    shale (1.0.0)
+    rubocop-sorbet (0.10.0)
+      rubocop (>= 1)
+    ruby-progressbar (1.13.0)
+    shale (1.2.2)
+      bigdecimal
+    shale-builder (0.2.4)
+      booleans (>= 0.1)
+      shale (< 2.0)
+      sorbet-runtime (> 0.5)
     shoulda-context (2.0.0)
-    solargraph (0.48.0)
-      backport (~> 1.2)
-      benchmark
-      bundler (>= 1.17.2)
-      diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.1)
-      parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
-      thor (~> 1.0)
-      tilt (~> 2.0)
-      yard (~> 0.9, >= 0.9.24)
+    sorbet (0.5.12003)
+      sorbet-static (= 0.5.12003)
+    sorbet-runtime (0.5.12003)
+    sorbet-static (0.5.12003-universal-darwin)
+    sorbet-static (0.5.12003-x86_64-linux)
+    sorbet-static-and-runtime (0.5.12003)
+      sorbet (= 0.5.12003)
+      sorbet-runtime (= 0.5.12003)
+    spoom (1.6.1)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.2.3)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
     strings (0.2.1)
       strings-ansi (~> 0.2)
       unicode-display_width (>= 1.5, < 3.0)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
+    tapioca (0.16.11)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
     thor (1.2.1)
-    tilt (2.0.11)
     tty-box (0.7.0)
       pastel (~> 0.8)
       strings (~> 0.2.0)
       tty-cursor (~> 0.7)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.6.0)
     unicode_utils (1.4.0)
-    vcr (6.1.0)
-    webmock (3.18.1)
+    uri (1.0.3)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-23
+  arm64-darwin-24
   x86_64-linux
 
 DEPENDENCIES
+  byebug (~> 12.0)
   capistrano-data_plane_api!
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-espago (~> 1.0)
+  rubocop-sorbet (~> 0.10.0)
   shoulda-context (~> 2.0)
-  solargraph
-  vcr
-  webmock
+  sorbet (~> 0.5)
+  tapioca (~> 0.16.11)
+  vcr (~> 6.3.1)
+  webmock (~> 3.25.1)
 
 BUNDLED WITH
-   2.4.1
+   2.7.2

data/README.md

@@ -73,6 +73,7 @@ This script can be used to deploy this app to remote servers.
 
     -c, --current                    Deploy from the currently checked out branch
     -t, --test                       Show the commands that would be executed but do not carry out the deployment
+    -C, --check                      Test deployment dependencies. Checks things like directory permissions, necessary utilities, HaProxy backends and servers
     -g, --group=GROUP                Deploy the code to every server in the passed HAProxy backend/group
         --no-haproxy                 Do not modify the state of any server in HAProxy
         --force-haproxy              Ignore the current state of servers in HAProxy
@@ -84,6 +85,7 @@ This script can be used to deploy this app to remote servers.
     -h, --help                       Prints this help
     -b, --branch=BRANCH              Deploy the code from the passed Git branch
         --no-migrations              Do not carry out migrations
+        --no-asset-precompilation    Skip asset precompilation during deployment
 ```
 
 ### Example of commands
@@ -144,6 +146,7 @@ $ bin/deploy -g production -r deploy:restart
 
 There are three new Rake tasks:
 
+- `data_plane_api:server:check` -- check the state of the currently deployed server and log it to stdout
 - `data_plane_api:server:set_drain` -- sets the admin state of the currently deployed server to `DRAIN`
 - `data_plane_api:server:set_maint` -- sets the admin state of the currently deployed server to `MAINT`
 - `data_plane_api:server:set_ready` -- sets the admin state of the currently deployed server to `READY`
@@ -175,6 +178,9 @@ Our config works as follows:
 ```
 deploy
   deploy:starting
+    deploy:check
+      [before]
+        data_plane_api:server:check
   deploy:started
     [after]
         data_plane_api:server:set_drain
@@ -192,6 +198,15 @@ deploy
 
 These tasks will only run when the `:web` role is added to the deployment stage.
 
+## Database migrations and asset precompilation
+
+In order for the `--no-migrations` and `--no-asset-precompilation` flags to work correctly, you need to use this configuration in your `Capfile`:
+
+```rb
+require 'capistrano/rails/assets' if ::ENV['NO_ASSET_PRECOMPILATION'].nil?
+require 'capistrano/rails/migrations' if ::ENV['NO_MIGRATIONS'].nil?
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/capistrano-data_plane_api.gemspec

@@ -12,7 +12,7 @@ require_relative 'lib/capistrano/data_plane_api/version'
   spec.description = 'Capistrano plugin which helps you automatically change the admin state of your HAProxy servers'
   spec.homepage = 'https://github.com/espago/capistrano-data_plane_api'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/espago/capistrano-data_plane_api'
@@ -30,9 +30,12 @@ require_relative 'lib/capistrano/data_plane_api/version'
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'data_plane_api', '~> 0.1'
+  spec.add_dependency 'booleans', '~> 0.1'
+  spec.add_dependency 'data_plane_api', '>= 0.2'
   spec.add_dependency 'pastel', '< 1'
   spec.add_dependency 'shale', '>= 1', '< 2'
+  spec.add_dependency 'shale-builder', '~> 0.2.4'
+  spec.add_dependency 'sorbet-runtime', '~> 0.5'
   spec.add_dependency 'thor', '> 1', '< 2'
   spec.add_dependency 'tty-box', '< 1'
   spec.add_dependency 'tty-cursor', '< 1'

data/exe/cap_data_plane_api

@@ -3,13 +3,14 @@
 
 require 'thor'
 
+# Implements the installer script for `capistrano-data_plane_api`
 class ::CapistranoDataPlaneApiCommand < ::Thor
   include ::Thor::Actions
 
   class << self
     # Define the generator's root folder
     #
-    # @return [String]
+    #: -> String
     def source_root
       ::File.expand_path('..', __dir__)
     end
@@ -17,7 +18,7 @@ class ::CapistranoDataPlaneApiCommand < ::Thor
 
   desc 'install', 'Install the `capistrano-data_plane_api` gem in your application'
 
-  # @return [void]
+  #: -> void
   def install
     copy_file 'templates/bin/deploy', 'bin/deploy'
     chmod 'bin/deploy', 'a+x'

data/lib/capistrano/data_plane_api/configuration/backend.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative 'symbol'
@@ -6,9 +7,11 @@ require_relative 'server'
 module Capistrano
   module DataPlaneApi
     class Configuration < Type
+      # Contains the configuration options of a backend
       class Backend < Type
         attribute :name, ::Shale::Type::String
         attribute :styles, Symbol, collection: true
+        attribute :api_url, ::Shale::Type::String
         attribute :basic_user, ::Shale::Type::String
         attribute :basic_password, ::Shale::Type::String
         attribute :servers, Server, collection: true

data/lib/capistrano/data_plane_api/configuration/server.rb

@@ -1,18 +1,20 @@
+# typed: true
 # frozen_string_literal: true
 
 module Capistrano
   module DataPlaneApi
     class Configuration < Type
+      # Contains the configuration options of a server
       class Server < Type
         attribute :name, ::Shale::Type::String
         attribute :stage, ::Shale::Type::String
 
-        # @return [String, nil]
+        #: -> String?
         def stage
           @stage || @name
         end
 
-        # @return [String, nil]
+        #: -> String?
         def name
           @name || @stage
         end

data/lib/capistrano/data_plane_api/configuration/symbol.rb

@@ -1,8 +1,10 @@
+# typed: true
 # frozen_string_literal: true
 
 module Capistrano
   module DataPlaneApi
     class Configuration < Type
+      # A Shale type that represents a ruby `Symbol`
       class Symbol < ::Shale::Type::String
         class << self
           def cast(value)

data/lib/capistrano/data_plane_api/configuration.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'yaml'
@@ -8,7 +9,7 @@ require 'shale'
 
 require_relative 'type'
 
-::Dir[::File.expand_path('configuration/*.rb', __dir__)].sort.each { require _1 }
+::Dir[::File.expand_path('configuration/*.rb', __dir__)].each { require _1 }
 
 module Capistrano
   module DataPlaneApi
@@ -22,8 +23,7 @@ module Capistrano
       attribute :basic_password, ::Shale::Type::String
 
       class << self
-        # @param path [String]
-        # @return [self]
+        #: (String) -> instance
         def from_file(path)
           from_yaml ::ERB.new(::File.read(path)).result
         end