capistrano-data_plane_api 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 129252a41d4e576802ee27f312f06875a71b8e9e116fe984c45d0ff4d83e0b08
-  data.tar.gz: f9ef93c427519821ca84336b437d3e9707992bc7550e075077c7ac42711becae
+  metadata.gz: 7e249ffdb15e8e4386e46dc9d188e4a7248ef4323adce5b66604d7589e06c4ff
+  data.tar.gz: 814dddc14e0b26f0ff6f98d388e4740410ca87322b53d53d7269e7d8d2b0a809
 SHA512:
-  metadata.gz: bb2eea9deb79ac6387b2d27b988074c3e9cd13e25ce05d057af29ef135407539f0896aba1ece6c68abf48472f70778e265f0031c664d1a9bd2486c2337596898
-  data.tar.gz: 7f8eedc6fa57fee424309618b5f5bdba5bde4c4fb9e19fb241484e4197a013cc01365d51a0fc26f2751704bc54fc4a77598b176211be8e8aea72959ba49ff07b
+  metadata.gz: 0511d4dcf7ea85ebbab93180092810408a6234dba46b1d61d28b28cbe1fd58ff32a08a8246eb094165f4e4c0360ea9f19313a8cdd24acfc1dae1abbab02b465a
+  data.tar.gz: fb92d42d547fe7a2d1ca586eb2996bfc155365abfea6edd996376eacc470118f954f6a188caa5b554897c54224d284326024b061e176f92f6f0ecc8a307d698b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capistrano-data_plane_api (0.4.0)
+    capistrano-data_plane_api (0.4.1)
       booleans (~> 0.1)
       data_plane_api (>= 0.2)
       pastel (< 1)
@@ -19,7 +19,7 @@ GEM
       public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.3)
     base64 (0.2.0)
-    benchmark (0.2.1)
+    benchmark (0.5.0)
     bigdecimal (3.1.9)
     booleans (0.1.3)
       sorbet-runtime (>= 0.5)
@@ -47,23 +47,23 @@ 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 (3.10.3)
       logger
+      tsort
     regexp_parser (2.10.0)
     rexml (3.4.1)
     rubocop (1.75.2)
@@ -92,18 +92,19 @@ GEM
       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.6.3)
       erubi (>= 1.10.0)
       prism (>= 0.28.0)
-      rbi (>= 0.2.3)
+      rbi (>= 0.3.3)
+      rexml (>= 3.2.6)
       sorbet-static-and-runtime (>= 0.5.10187)
       thor (>= 0.19.2)
     strings (0.2.1)
@@ -121,7 +122,8 @@ GEM
       spoom (>= 1.2.0)
       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 +139,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

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/version.rb

@@ -3,6 +3,6 @@
 
 module Capistrano
   module DataPlaneApi
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   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(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-data_plane_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mateusz Drewniak