capistrano-data_plane_api 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 129252a41d4e576802ee27f312f06875a71b8e9e116fe984c45d0ff4d83e0b08
-  data.tar.gz: f9ef93c427519821ca84336b437d3e9707992bc7550e075077c7ac42711becae
+  metadata.gz: a0e6727cc66e642fbe370bcc6cf1ca1bac711c35d69359e2f0c6ac554621ef0b
+  data.tar.gz: cce5d8e17731e5f50c9150416f6462e97b7a07432ac6c077c6cc04e77cb72b06
 SHA512:
-  metadata.gz: bb2eea9deb79ac6387b2d27b988074c3e9cd13e25ce05d057af29ef135407539f0896aba1ece6c68abf48472f70778e265f0031c664d1a9bd2486c2337596898
-  data.tar.gz: 7f8eedc6fa57fee424309618b5f5bdba5bde4c4fb9e19fb241484e4197a013cc01365d51a0fc26f2751704bc54fc4a77598b176211be8e8aea72959ba49ff07b
+  metadata.gz: 40ae759ffc262e1c6df3bfbcc954658440965694b51cd86c9e65d358cb99a778660213137515ff92283062eafb1d9d31c679ca157ddda183913ecd3598914965
+  data.tar.gz: 565d673a69a68f8f9c0e1cc488390bf4b9ad0d8eab8c685611c1491f1f0befc2a9dec6a6f469ca4a2fb53dc6c55e6770dcdd3fb191e9c1352672fdf6eeee42b7

data/Gemfile

@@ -12,7 +12,7 @@ gem 'rubocop', '~> 1.21' # Ruby linter
 gem 'rubocop-espago', '~> 1.0' # Custom Ruby linter config
 gem 'rubocop-sorbet', '~> 0.10.0' # Rubocop config for sorbet
 gem 'shoulda-context', '~> 2.0' # Testing utilities
-gem 'sorbet', '~> 0.5' # static typechecker
-gem 'tapioca', '~> 0.16.11', require: false # RBI generator
+gem 'sorbet', '~> 0.6.12940' # static typechecker
+gem 'tapioca', '~> 0.17.10', 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,12 +1,12 @@
 PATH
   remote: .
   specs:
-    capistrano-data_plane_api (0.4.0)
+    capistrano-data_plane_api (0.4.2)
       booleans (~> 0.1)
       data_plane_api (>= 0.2)
       pastel (< 1)
       shale (>= 1, < 2)
-      shale-builder (>= 0.2.4, < 1.0)
+      shale-builder (>= 0.2.4, <= 0.8.5)
       sorbet-runtime (~> 0.5)
       thor (> 1, < 2)
       tty-box (< 1)
@@ -19,8 +19,8 @@ GEM
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.3)
     base64 (0.2.0)
-    benchmark (0.2.1)
-    bigdecimal (3.1.9)
+    benchmark (0.5.0)
+    bigdecimal (4.0.1)
     booleans (0.1.3)
       sorbet-runtime (>= 0.5)
     byebug (12.0.0)
@@ -47,24 +47,26 @@ GEM
     net-http (0.6.0)
       uri
     netrc (0.11.0)
-    parallel (1.26.3)
+    parallel (1.27.0)
     parser (3.3.7.4)
       ast (~> 2.4.1)
       racc
     pastel (0.8.0)
       tty-color (~> 0.5)
-    prism (1.4.0)
+    prism (1.9.0)
     public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rbi (0.3.1)
+    rbi (0.3.9)
       prism (~> 1.0)
       rbs (>= 3.4.4)
-      sorbet-runtime (>= 0.5.9204)
-    rbs (3.9.2)
+    rbs (4.0.0.dev.5)
       logger
+      prism (>= 1.3.0)
+      tsort
     regexp_parser (2.10.0)
+    require-hooks (0.2.3)
     rexml (3.4.1)
     rubocop (1.75.2)
       json (~> 2.3)
@@ -87,23 +89,25 @@ GEM
     ruby-progressbar (1.13.0)
     shale (1.2.2)
       bigdecimal
-    shale-builder (0.5.0)
+    shale-builder (0.8.5)
       booleans (>= 0.1)
       shale (< 2.0)
       sorbet-runtime (> 0.5)
     shoulda-context (2.0.0)
-    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)
+    sorbet (0.6.12940)
+      sorbet-static (= 0.6.12940)
+    sorbet-runtime (0.6.12940)
+    sorbet-static (0.6.12940-universal-darwin)
+    sorbet-static (0.6.12940-x86_64-linux)
+    sorbet-static-and-runtime (0.6.12940)
+      sorbet (= 0.6.12940)
+      sorbet-runtime (= 0.6.12940)
+    spoom (1.7.11)
       erubi (>= 1.10.0)
       prism (>= 0.28.0)
-      rbi (>= 0.2.3)
+      rbi (>= 0.3.3)
+      rbs (>= 4.0.0.dev.4)
+      rexml (>= 3.2.6)
       sorbet-static-and-runtime (>= 0.5.10187)
       thor (>= 0.19.2)
     strings (0.2.1)
@@ -111,17 +115,19 @@ GEM
       unicode-display_width (>= 1.5, < 3.0)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
-    tapioca (0.16.11)
+    tapioca (0.17.10)
       benchmark
       bundler (>= 2.2.25)
       netrc (>= 0.11.0)
       parallel (>= 1.21.0)
-      rbi (~> 0.2)
+      rbi (>= 0.3.7)
+      require-hooks (>= 0.2.2)
       sorbet-static-and-runtime (>= 0.5.11087)
-      spoom (>= 1.2.0)
+      spoom (>= 1.7.9)
       thor (>= 1.2.0)
       yard-sorbet
-    thor (1.2.1)
+    thor (1.5.0)
+    tsort (0.2.0)
     tty-box (0.7.0)
       pastel (~> 0.8)
       strings (~> 0.2.0)
@@ -137,9 +143,7 @@ GEM
       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 (0.9.38)
     yard-sorbet (0.9.0)
       sorbet-runtime
       yard
@@ -159,8 +163,8 @@ DEPENDENCIES
   rubocop-espago (~> 1.0)
   rubocop-sorbet (~> 0.10.0)
   shoulda-context (~> 2.0)
-  sorbet (~> 0.5)
-  tapioca (~> 0.16.11)
+  sorbet (~> 0.6.12940)
+  tapioca (~> 0.17.10)
   vcr (~> 6.3.1)
   webmock (~> 3.25.1)
 

data/capistrano-data_plane_api.gemspec

@@ -34,7 +34,7 @@ require_relative 'lib/capistrano/data_plane_api/version'
   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', '< 1.0'
+  spec.add_dependency 'shale-builder', '>= 0.2.4', '<= 0.8.5'
   spec.add_dependency 'sorbet-runtime', '~> 0.5'
   spec.add_dependency 'thor', '> 1', '< 2'
   spec.add_dependency 'tty-box', '< 1'

data/lib/capistrano/data_plane_api/deploy/args.rb

@@ -13,7 +13,7 @@ module Capistrano
       class Args
         PRINTABLE_ENV_VARS = %w[BRANCH NO_MIGRATIONS NO_ASSET_PRECOMPILATION].freeze
 
-        #: (Array[untyped]?) -> instance
+        #: (?Array[untyped]?) -> instance
         def self.parse(options = nil) # rubocop:disable Metrics/MethodLength, Style/ClassMethodsDefinitions
           args = new
 
@@ -237,13 +237,13 @@ module Capistrano
           @group = backend.name
         end
 
-        #: (String | Symbol | nil) -> String
+        #: (?String | Symbol | nil) -> String
         def deploy_command(stage = nil)
           used_stage = stage || self.stage
           "cap #{used_stage} #{rake}"
         end
 
-        #: (String | Symbol | nil) -> String
+        #: (?String | Symbol | nil) -> String
         def humanized_deploy_command(stage = nil)
           result = ::String.new
           PRINTABLE_ENV_VARS.each do |env_var_name|

data/lib/capistrano/data_plane_api/deploy/deployment_stats.rb

@@ -30,10 +30,10 @@ module Capistrano
           @backend = nil
           @start_time = nil
           @end_time = nil
-          @state = T.let(:pending, Symbol)
-          @server_stats = T.let({}, T::Hash[String, Deploy::ServerStats])
-          @seconds = T.let(nil, T.nilable(Integer))
-          @update_states_in_stats = T.let(false, T::Boolean)
+          @state = :pending #: Symbol
+          @server_stats = {} #: Hash[String, Deploy::ServerStats]
+          @seconds = nil #: Integer?
+          @update_states_in_stats = false #: bool
         end
 
         #: (String) -> Deploy::ServerStats

data/lib/capistrano/data_plane_api/deploy/group.rb

@@ -8,28 +8,41 @@ module Capistrano
       # in a particular HAProxy backend/group.
       class Group
         class << self
-          #: (Args) -> Symbol
+          #: (Args) -> DeploymentStats
           def call(args)
             new(args).call
           end
         end
 
+        #: Configuration::Backend?
+        attr_reader :backend
+
+        #: Array[Configuration::Server]?
+        attr_reader :servers
+
+        #: DeploymentStats
+        attr_reader :deployment_stats
+
+        #: Symbol
+        attr_reader :state
+
         #: (Args) -> void
         def initialize(args)
           @args = args
-          @deployment_stats = T.let(DeploymentStats.new, DeploymentStats)
-          @backend = T.let(nil, T.nilable(Configuration::Backend))
-          @servers = T.let(nil, T.nilable(T::Array[Configuration::Server]))
+          @deployment_stats = DeploymentStats.new #: DeploymentStats
+          @backend = nil #: Configuration::Backend?
+          @servers = nil #: Array[Configuration::Server]?
+          @state = :pending #: Symbol
         end
 
-        # Whether the deployment has been successful
-        #: -> Symbol
+        # Carries out the deployment and returns the stats
+        #
+        #: -> DeploymentStats
         def call
           @backend = ::Capistrano::DataPlaneApi.find_backend(T.must(@args.group))
-          @servers = servers(@backend)
+          @servers = get_servers(@backend)
           start_deployment
 
-          state = :pending
           @servers&.each do |server|
             server_stats = @deployment_stats[T.must(server.name)]
             puts COLORS.bold.blue("Deploying the app to `#{server.stage}` -- `#{@backend.name}:#{server.name}`")
@@ -43,27 +56,27 @@ module Capistrano
             deploy_command = @args.deploy_command(server.stage)
             case system deploy_command
             when true
-              state = :success
+              @state = :success
             when false
-              state = :failed
+              @state = :failed
             when nil
-              state = :pending
+              @state = :pending
             end
 
             server_stats.end_time = ::Time.now
-            server_stats.state = state
+            server_stats.state = @state
 
-            next if state == :success
+            next if @state == :success
 
             puts COLORS.bold.red("Command `#{deploy_command}` failed")
             break
           end
 
-          return :pending if @args.test?
+          return @deployment_stats if @args.test?
 
-          finish_deployment(state: state)
+          finish_deployment(state: @state)
           print_summary
-          state
+          @deployment_stats
         end
 
         private
@@ -77,7 +90,7 @@ module Capistrano
           end
         end
 
-        #: (Symbol) -> void
+        #: (?state: Symbol) -> void
         def finish_deployment(state: :success)
           @deployment_stats.end_time = ::Time.now
           @deployment_stats.state = state
@@ -89,7 +102,7 @@ module Capistrano
         end
 
         #: (Configuration::Backend) -> Array[Configuration::Server]?
-        def servers(backend)
+        def get_servers(backend)
           return backend.servers unless @args.only?
 
           chosen_servers = []

data/lib/capistrano/data_plane_api/deploy/helper.rb

@@ -39,7 +39,7 @@ module Capistrano
         # Calculate how many seconds have passed
         # since the given point in time.
         #
-        #: (Time, Time) -> Integer
+        #: (Time, ?to: Time) -> Integer
         def seconds_since(time, to: ::Time.now)
           (to - time).to_i
         end

data/lib/capistrano/data_plane_api/deploy/server_stats.rb

@@ -30,7 +30,7 @@ module Capistrano
         #: String
         attr_accessor :operational_state
 
-        #: (String, String, Symbol, String, String) -> void
+        #: (String, String, ?state: Symbol, ?admin_state: String, ?operational_state: String) -> void
         def initialize(
           server_name,
           backend_name,
@@ -43,7 +43,7 @@ module Capistrano
           @state = state
           @admin_state = admin_state
           @operational_state = operational_state
-          @seconds = T.let(nil, T.nilable(Integer))
+          @seconds = nil #: Integer?
         end
 
         #: -> String
@@ -87,15 +87,12 @@ module Capistrano
           HAPROXY
         end
 
-        SERVER_TITLE_COLORS = T.let(
-          {
-            pending: :yellow,
-            failed:  :red,
-            success: :green,
-            info:    :blue,
-          }.freeze,
-          T::Hash[Symbol, Symbol],
-        )
+        SERVER_TITLE_COLORS = {
+          pending: :yellow,
+          failed:  :red,
+          success: :green,
+          info:    :blue,
+        }.freeze #: Hash[Symbol, Symbol]
         private_constant :SERVER_TITLE_COLORS
 
         #: -> String
@@ -108,15 +105,12 @@ module Capistrano
           "#{@backend_name}:#{@server_name}"
         end
 
-        STATE_EMOJIS = T.let(
-          {
-            pending: '🟡',
-            failed:  '❌',
-            success: '✅',
-            info:    'ℹ️',
-          }.freeze,
-          T::Hash[Symbol, String],
-        )
+        STATE_EMOJIS = {
+          pending: '🟡',
+          failed:  '❌',
+          success: '✅',
+          info:    'ℹ️',
+        }.freeze #: Hash[Symbol, String]
         private_constant :STATE_EMOJIS
 
         #: -> String

data/lib/capistrano/data_plane_api/deploy.rb

@@ -13,14 +13,14 @@ module Capistrano
         #
         #: -> void
         def call
-          result = call!
-          abort if result == :failed
+          stats = call!
+          abort if stats.state == :failed
         end
 
         # Returns when the deployment is over.
         # Returns the final state of the deployment as a symbol `:failed`, `:pending` or `:success`
         #
-        #: -> Symbol
+        #: -> DeploymentStats
         def call!
           args = Args.parse
           puts COLORS.bold.blue('Running the deployment script')

data/lib/capistrano/data_plane_api/diggable.rb

@@ -14,7 +14,7 @@ module Capistrano
       # This implementation of `dig` uses `public_send` under the hood.
       #
       # @raise [TypeError] value has no #dig method
-      #: (untyped) -> untyped
+      #: (*untyped) -> untyped
       def dig(*args)
         return unless args.size.positive?
 

data/lib/capistrano/data_plane_api/helper.rb

@@ -5,25 +5,19 @@ module Capistrano
   module DataPlaneApi
     # Provides helper methods
     module Helper
-      ADMIN_STATE_COLORS = T.let(
-        {
-          'unknown' => :on_red,
-          'drain'   => :on_blue,
-          'ready'   => :on_green,
-          'maint'   => :on_yellow,
-        }.freeze,
-        T::Hash[String, Symbol],
-      )
-
-      OPERATIONAL_STATE_COLORS = T.let(
-        {
-          'unknown'  => :on_red,
-          'up'       => :on_green,
-          'down'     => :on_red,
-          'stopping' => :on_yellow,
-        }.freeze,
-        T::Hash[String, Symbol],
-      )
+      ADMIN_STATE_COLORS = {
+        'unknown' => :on_red,
+        'drain'   => :on_blue,
+        'ready'   => :on_green,
+        'maint'   => :on_yellow,
+      }.freeze #: Hash[String, Symbol]
+
+      OPERATIONAL_STATE_COLORS = {
+        'unknown'  => :on_red,
+        'up'       => :on_green,
+        'down'     => :on_red,
+        'stopping' => :on_yellow,
+      }.freeze #: Hash[String, Symbol]
 
       #: -> bool
       def no_haproxy?

data/lib/capistrano/data_plane_api/terminal_print_loop.rb

@@ -15,7 +15,7 @@ module Capistrano
         # before another frame is printed.
         #
         # @param interval: Number of seconds between each screen refresh
-        #: (Integer) { (String) -> Object } -> void
+        #: (?interval: Integer) { (String) -> Object } -> void
         def call(interval: 2, &_block)
           previous_line_count = 0
           previous_max_line_length = 0

data/lib/capistrano/data_plane_api/type.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'shale'
+require 'shale/builder'
 
 require_relative 'diggable'
 require_relative 'equatable'
@@ -14,6 +15,7 @@ module Capistrano
 
       abstract!
 
+      include ::Shale::Builder
       include Diggable
       include Equatable
 

data/lib/capistrano/data_plane_api/version.rb

@@ -3,6 +3,6 @@
 
 module Capistrano
   module DataPlaneApi
-    VERSION = '0.4.0'
+    VERSION = '0.4.2'
   end
 end

data/lib/capistrano/data_plane_api.rb

@@ -82,7 +82,7 @@ module Capistrano
       # @return: Server state after the change, or `nil`
       #   when no change happened
       # @raise [Error] The process failed due to some reason
-      #: (String | Symbol, bool, ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
+      #: (String | Symbol, ?force: bool, ?config: ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
       def server_set_drain(deployment_stage, force: false, config: nil)
         haproxy_server, haproxy_backend = find_server_and_backend(deployment_stage)
         servers = T.must haproxy_backend.servers
@@ -119,7 +119,7 @@ module Capistrano
       # @param force: Change the server's state even when no other server is `up`
       # @return: Server state after the change, or `nil` when no change happened
       # @raise [Error] The process failed due to some reason
-      #: (String | Symbol, bool, ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
+      #: (String | Symbol, ?force: bool, ?config: ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
       def server_set_maint(deployment_stage, force: false, config: nil)
         haproxy_server, haproxy_backend = find_server_and_backend(deployment_stage)
         servers = T.must haproxy_backend.servers
@@ -155,7 +155,7 @@ module Capistrano
       #
       # @return: Server state after the change, or `nil` when no change happened
       # @raise [Error] The process failed due to some reason
-      #: (String | Symbol, ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
+      #: (String | Symbol, ?config: ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
       def server_set_ready(deployment_stage, config: nil)
         haproxy_server, haproxy_backend = find_server_and_backend(deployment_stage)
         servers = T.must haproxy_backend.servers
@@ -192,7 +192,7 @@ module Capistrano
       #
       # @return: Server state
       # @raise [Error] The process failed due to some reason
-      #: (String | Symbol, ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
+      #: (String | Symbol, ?config: ::DataPlaneApi::Configuration?) -> Hash[String, untyped]?
       def server_get_state(deployment_stage, config: nil)
         haproxy_server, haproxy_backend = find_server_and_backend(deployment_stage)
 
@@ -246,7 +246,7 @@ module Capistrano
         [T.must(haproxy_server), haproxy_backend]
       end
 
-      #: (Symbol | String, ::DataPlaneApi::Configuration?) -> Faraday::Response
+      #: (Symbol | String, ?config: ::DataPlaneApi::Configuration?) -> Faraday::Response
       def get_backend_servers_settings(backend_name, config: nil)
         haproxy_backend = find_backend(backend_name)
         conf = ::DataPlaneApi::Configuration.new(
@@ -267,7 +267,7 @@ module Capistrano
         response
       end
 
-      #: (Symbol | String, Symbol | String, ::DataPlaneApi::Configuration?) -> Faraday::Response
+      #: (Symbol | String, Symbol | String, ?config: ::DataPlaneApi::Configuration?) -> Faraday::Response
       def get_server_settings(backend_name, server_name, config: nil)
         haproxy_backend = find_backend(backend_name)
         conf = ::DataPlaneApi::Configuration.new(

data/sorbet/rbi/annotations/minitest.rbi

@@ -60,6 +60,7 @@ module Minitest::Assertions
   sig { params(exp: T.anything, act: T.anything, msg: T.anything).returns(TrueClass) }
   def assert_same(exp, act, msg = nil); end
 
+  # @version < 6.0.0
   sig { params(send_ary: T::Array[T.anything], m: T.anything).returns(T::Boolean) }
   def assert_send(send_ary, m = nil); end
 

data/sorbet/rbi/dsl/capistrano/data_plane_api/configuration/backend.rbi

@@ -33,8 +33,13 @@ class Capistrano::DataPlaneApi::Configuration::Backend
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def name=(value); end
 
-    sig { returns(T.nilable(T::Array[Capistrano::DataPlaneApi::Configuration::Server])) }
-    def servers; end
+    sig { params(block: NilClass).returns(T.nilable(T::Array[Capistrano::DataPlaneApi::Configuration::Server])) }
+    sig do
+      params(
+        block: T.proc.params(arg0: Capistrano::DataPlaneApi::Configuration::Server).void
+      ).returns(Capistrano::DataPlaneApi::Configuration::Server)
+    end
+    def servers(&block); end
 
     sig do
       params(

data/sorbet/rbi/dsl/capistrano/data_plane_api/configuration.rbi

@@ -15,8 +15,13 @@ class Capistrano::DataPlaneApi::Configuration
     sig { params(value: T.nilable(String)).returns(T.nilable(String)) }
     def api_url=(value); end
 
-    sig { returns(T.nilable(T::Array[Capistrano::DataPlaneApi::Configuration::Backend])) }
-    def backends; end
+    sig { params(block: NilClass).returns(T.nilable(T::Array[Capistrano::DataPlaneApi::Configuration::Backend])) }
+    sig do
+      params(
+        block: T.proc.params(arg0: Capistrano::DataPlaneApi::Configuration::Backend).void
+      ).returns(Capistrano::DataPlaneApi::Configuration::Backend)
+    end
+    def backends(&block); end
 
     sig do
       params(