kuby-core 0.10.1 → 0.11.0

data/lib/kuby/docker/tags.rb

@@ -1,26 +1,56 @@
+# typed: strict
+
 module Kuby
   module Docker
     class Tags
+      extend T::Sig
+
       LATEST = Metadata::LATEST_TAG
 
-      attr_reader :cli, :remote_client, :metadata
+      sig { returns(CLI) }
+      attr_reader :cli
+
+      sig { returns(::Docker::Remote::Client) }
+      attr_reader :remote_client
 
+      sig { returns Metadata }
+      attr_reader :metadata
+
+      sig {
+        params(
+          cli: CLI,
+          remote_client: ::Docker::Remote::Client,
+          metadata: Metadata
+        )
+        .void
+      }
       def initialize(cli, remote_client, metadata)
         @cli = cli
         @remote_client = remote_client
         @metadata = metadata
+
+        @local = T.let(@local, T.nilable(LocalTags))
+        @remote = T.let(@remote, T.nilable(RemoteTags))
+        @latest_timestamp_tag = T.let(@latest_timestamp_tag, T.nilable(TimestampTag))
       end
 
+      sig { returns(T::Array[String]) }
       def tags
         (local.tags + remote.tags).uniq
       end
 
+      sig { returns(T::Array[String]) }
       def latest_tags
         (local.latest_tags + remote.latest_tags).uniq
       end
 
+      sig {
+        params(current_tag: String).returns(T.nilable(TimestampTag))
+      }
       def previous_timestamp_tag(current_tag)
-        current_tag = ::Kuby::Docker::TimestampTag.try_parse(current_tag)
+        current_tag = TimestampTag.try_parse(current_tag)
+        return nil unless current_tag
+
         all_tags = timestamp_tags.sort
 
         idx = all_tags.index do |tag|
@@ -33,22 +63,27 @@ module Kuby
         all_tags[idx - 1]
       end
 
+      sig { returns(T::Array[TimestampTag]) }
       def timestamp_tags
         (local.timestamp_tags + remote.timestamp_tags).uniq
       end
 
+      sig { returns(T.nilable(TimestampTag)) }
       def latest_timestamp_tag
         @latest_timestamp_tag ||= timestamp_tags.sort.last
       end
 
+      sig { returns(T.self_type) }
       def all
         self
       end
 
+      sig { returns(LocalTags) }
       def local
         @local ||= LocalTags.new(cli, metadata)
       end
 
+      sig { returns(RemoteTags) }
       def remote
         @remote ||= RemoteTags.new(remote_client, metadata)
       end

data/lib/kuby/docker/timestamp_tag.rb

@@ -1,10 +1,15 @@
+# typed: strict
+
 require 'time'
 
 module Kuby
   module Docker
     class TimestampTag
-      FORMAT = '%Y%m%d%H%M%S'.freeze
+      extend T::Sig
+
+      FORMAT = T.let('%Y%m%d%H%M%S'.freeze, String)
 
+      sig { params(str: String).returns(T.nilable(TimestampTag)) }
       def self.try_parse(str)
         time = begin
           Time.strptime(str, FORMAT)
@@ -15,28 +20,35 @@ module Kuby
         new(time)
       end
 
+      sig { returns(Time) }
       attr_reader :time
 
+      sig { params(time: Time).void }
       def initialize(time)
-        @time = time
+        @time = T.let(time, Time)
       end
 
+      sig { returns(String) }
       def to_s
         time.strftime(FORMAT)
       end
 
+      sig { params(other: TimestampTag).returns(T.nilable(Integer)) }
       def <=>(other)
         time <=> other.time
       end
 
+      sig { params(other: TimestampTag).returns(T::Boolean) }
       def ==(other)
         time == other.time
       end
 
+      sig { returns(Integer) }
       def hash
         time.hash
       end
 
+      sig { params(other: TimestampTag).returns(T::Boolean) }
       def eql?(other)
         time == other.time
       end

data/lib/kuby/docker/webserver_phase.rb

@@ -1,13 +1,30 @@
+# typed: strict
+
 module Kuby
   module Docker
     class WebserverPhase < Layer
-      class Puma
+      extend T::Sig
+
+      class Webserver
+        extend T::Sig
+        extend T::Helpers
+
+        abstract!
+
+        sig { returns(WebserverPhase) }
         attr_reader :phase
 
+        sig { params(phase: WebserverPhase).void }
         def initialize(phase)
           @phase = phase
         end
 
+        sig { abstract.params(dockerfile: Dockerfile).void }
+        def apply_to(dockerfile); end
+      end
+
+      class Puma < Webserver
+        sig { override.params(dockerfile: Dockerfile).void }
         def apply_to(dockerfile)
           dockerfile.cmd(
             'puma',
@@ -22,25 +39,43 @@ module Kuby
         end
       end
 
-      DEFAULT_PORT = 8080
-      WEBSERVER_MAP = { puma: Puma }.freeze
+      DEFAULT_PORT = T.let('8080', String)
+      WEBSERVER_MAP = T.let({ puma: Puma }.freeze, T::Hash[Symbol, T.class_of(Webserver)])
 
-      attr_accessor :port, :webserver
+      sig { params(port: String).void }
+      attr_writer :port
+
+      sig { returns(T.nilable(Symbol)) }
+      attr_reader :webserver
+
+      sig { params(webserver: Symbol).void }
+      attr_writer :webserver
+
+      sig { override.params(environment: Environment).void }
+      def initialize(environment)
+        super
+
+        @port = T.let(@port, T.nilable(String))
+        @webserver = T.let(@webserver, T.nilable(Symbol))
+      end
 
+      sig { override.params(dockerfile: Dockerfile).void }
       def apply_to(dockerfile)
         ws = webserver || default_webserver
-        ws_class = WEBSERVER_MAP[ws]
+        ws_class = WEBSERVER_MAP[T.must(ws)]
         raise "No webserver named #{ws}" unless ws_class
 
         ws_class.new(self).apply_to(dockerfile)
       end
 
+      sig { returns(String) }
       def port
         @port || DEFAULT_PORT
       end
 
       private
 
+      sig { returns(T.nilable(Symbol)) }
       def default_webserver
         if Gem.loaded_specs.include?('puma')
           :puma

data/lib/kuby/docker/yarn_phase.rb

@@ -1,6 +1,11 @@
+# typed: strict
+
 module Kuby
   module Docker
     class YarnPhase < Layer
+      extend T::Sig
+
+      sig { params(dockerfile: Dockerfile).void }
       def apply_to(dockerfile)
         dockerfile.copy('package.json', '.')
         dockerfile.copy('yarn.lock*', '.')

data/lib/kuby/environment.rb

@@ -1,6 +1,10 @@
+# typed: true
 module Kuby
   class Environment
     attr_reader :name, :definition
+    attr_accessor :configured
+
+    alias_method :configured?, :configured
 
     def initialize(name, definition, &block)
       @name = name

data/lib/kuby/kubernetes.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require 'kuby/kubernetes/errors'
 
 module Kuby

data/lib/kuby/kubernetes/deploy_task.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'krane'
 require 'kubectl-rb'
 

data/lib/kuby/kubernetes/deployer.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'fileutils'
 require 'securerandom'
 require 'yaml'

data/lib/kuby/kubernetes/docker_config.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'base64'
 require 'kube-dsl'
 

data/lib/kuby/kubernetes/docker_desktop_provider.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'kube-dsl'
 
 module Kuby

data/lib/kuby/kubernetes/errors.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Kuby
   module Kubernetes
     class MissingDeploymentError < StandardError; end

data/lib/kuby/kubernetes/manifest.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'set'
 
 module Kuby

data/lib/kuby/kubernetes/provider.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'kubernetes-cli'
 
 module Kuby

data/lib/kuby/kubernetes/registry_secret.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'base64'
 
 module Kuby

data/lib/kuby/kubernetes/spec.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'kube-dsl'
 
 module Kuby

data/lib/kuby/middleware.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Kuby
   module Middleware
     autoload :HealthCheck, 'kuby/middleware/health_check'

data/lib/kuby/middleware/health_check.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Kuby
   module Middleware
     class HealthCheck

data/lib/kuby/plugin.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Kuby
   class Plugin
     attr_reader :environment

data/lib/kuby/plugin_registry.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Kuby
   class PluginRegistry
     ANY = 'any'.freeze

data/lib/kuby/plugins.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Kuby
   module Plugins
     autoload :NginxIngress, 'kuby/plugins/nginx_ingress'

data/lib/kuby/plugins/nginx_ingress.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'kube-dsl'
 
 module Kuby

data/lib/kuby/plugins/rails_app.rb

@@ -1,3 +1,4 @@
+# typed: strict
 module Kuby
   module Plugins
     module RailsApp

data/lib/kuby/plugins/rails_app/asset_copy_task.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'fileutils'
 require 'pathname'
 

data/lib/kuby/plugins/rails_app/assets.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'kube-dsl'
 
 module Kuby

data/lib/kuby/plugins/rails_app/database.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'yaml'
 
 module Kuby
@@ -56,17 +57,18 @@ module Kuby
         def db_config_path
           @db_config_path ||= begin
             db_config_paths.first or
-              raise "Couldn't find database config at #{rails_app.root}"
+              raise "Couldn't find database config in #{db_config_pattern}"
           end
         end
 
         def db_config_paths
-          @db_config_paths ||=
-            Dir.glob(
-              File.join(
-                rails_app.root, 'config', 'database.{yml,erb,yml.erb,yaml,yaml.erb}'
-              )
-            )
+          @db_config_paths ||= Dir.glob(db_config_pattern)
+        end
+
+        def db_config_pattern
+          @db_config_pattern ||= File.join(
+            rails_app.root, 'config', 'database.{yml,erb,yml.erb,yaml,yaml.erb}'
+          )
         end
       end
     end

data/lib/kuby/plugins/rails_app/generators/kuby.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'rails/generators'
 require 'rails/generators/base'
 
@@ -10,51 +11,53 @@ class KubyGenerator < Rails::Generators::Base
         require 'active_support/encrypted_configuration'
 
         # Define a production Kuby deploy environment
-        Kuby.define(:production) do
-          # Because the Rails environment isn't always loaded when
-          # your Kuby config is loaded, provide access to Rails
-          # credentials manually.
-          app_creds = ActiveSupport::EncryptedConfiguration.new(
-            config_path: File.join('config', 'credentials.yml.enc'),
-            key_path: File.join('config', 'master.key'),
-            env_key: 'RAILS_MASTER_KEY',
-            raise_if_missing_key: true
-          )
+        Kuby.define('#{Rails.application.class.module_parent_name}') do
+          environment(:production) do
+            # Because the Rails environment isn't always loaded when
+            # your Kuby config is loaded, provide access to Rails
+            # credentials manually.
+            app_creds = ActiveSupport::EncryptedConfiguration.new(
+              config_path: File.join('config', 'credentials.yml.enc'),
+              key_path: File.join('config', 'master.key'),
+              env_key: 'RAILS_MASTER_KEY',
+              raise_if_missing_key: true
+            )
 
-          docker do
-            # Configure your Docker registry credentials here. Add them to your
-            # Rails credentials file by running `bundle exec rake credentials:edit`.
-            credentials do
-              username app_creds[:KUBY_DOCKER_USERNAME]
-              password app_creds[:KUBY_DOCKER_PASSWORD]
-              email app_creds[:KUBY_DOCKER_EMAIL]
-            end
+            docker do
+              # Configure your Docker registry credentials here. Add them to your
+              # Rails credentials file by running `bundle exec rake credentials:edit`.
+              credentials do
+                username app_creds[:KUBY_DOCKER_USERNAME]
+                password app_creds[:KUBY_DOCKER_PASSWORD]
+                email app_creds[:KUBY_DOCKER_EMAIL]
+              end
 
-            # Configure the URL to your Docker image here, eg:
-            # image_url 'foo.bar.com/me/myproject'
-            #
-            # If you're using Gitlab's Docker registry, try something like this:
-            # image_url 'registry.gitlab.com/<username>/<repo>'
-          end
+              # Configure the URL to your Docker image here, eg:
+              # image_url 'foo.bar.com/me/myproject'
+              #
+              # If you're using Gitlab's Docker registry, try something like this:
+              # image_url 'registry.gitlab.com/<username>/<repo>'
+            end
 
-          kubernetes do
-            # Add a plugin that facilitates deploying a Rails app.
-            add_plugin :rails_app do
-              # configure database credentials
-              database do
-                user app_creds[:KUBY_DB_USER]
-                password app_creds[:KUBY_DB_PASSWORD]
+            kubernetes do
+              # Add a plugin that facilitates deploying a Rails app.
+              add_plugin :rails_app do
+                # configure database credentials
+                database do
+                  user app_creds[:KUBY_DB_USER]
+                  password app_creds[:KUBY_DB_PASSWORD]
+                end
               end
-            end
 
-            # Use Docker Desktop as the provider.
-            # See: https://www.docker.com/products/docker-desktop
-            #
-            # Note: you will likely want to use a different provider when deploying
-            # your application into a production environment. To configure a different
-            # provider, add the corresponding gem to your gemfile and update the
-            # following line according to the provider gem's README.
-            provider :docker_desktop
+              # Use Docker Desktop as the provider.
+              # See: https://www.docker.com/products/docker-desktop
+              #
+              # Note: you will likely want to use a different provider when deploying
+              # your application into a production environment. To configure a different
+              # provider, add the corresponding gem to your gemfile and update the
+              # following line according to the provider gem's README.
+              provider :docker_desktop
+            end
           end
         end
       END