avm-tools 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6a03e86cba8b7cc3cefba9163e093176460fc22f9155414ad6cc113ebe3cd5d
-  data.tar.gz: bd31ac49d42c4020a81543f099b5cdc693628821601ef196f185b675d03285ed
+  metadata.gz: 7aac25bb0c585e13aa100af2ab6ff42d830b575cfd423a873c99b799bd1cd58c
+  data.tar.gz: f2b38abd01c102a189b2f224c09e32a3738d7168be4aa3eff2fcfe6c2c1c9f5e
 SHA512:
-  metadata.gz: 01b434bc5a5bc72b9de6ab1679886ef5587fba84e1095d114702dfae4d180b169fcc8c823df7adef6965a4c1a0b9c266649f0de86eb912bb0f5e3141663369a3
-  data.tar.gz: ee37b11970672b1c90b313517807349381f93ae0fd892e6d85dd0c7dbcbd766efe7073351a5bf4f5dc316516983ca7368636acbd1e7154b8911a44e548831972
+  metadata.gz: b72bb22e2fa79eb43f6adeb6c7aeb3021167055c8d903cab131caa9aca00aed799ba1aa12b968f3382cec180b7954ea7ad89b5db0cced4f474e15e2d0182da4e
+  data.tar.gz: 76c35f6f8f8023356b47f2866ce9e38291dd8bb256b2faf0c4da0859cde0c63f7fea138377e9d3370549aa82d6bd305feacbcd3cd79cbeb66b64dce2c4d891bc

data/lib/avm/git.rb

@@ -5,5 +5,6 @@ require 'eac_ruby_utils/require_sub'
 
 module Avm
   module Git
+    DEFAULT_REMOTE_NAME = 'origin'
   end
 end

data/lib/avm/stereotypes/eac_rails_base0.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub(__FILE__)
+
+module Avm
+  module Stereotypes
+    module EacRailsBase0
+    end
+  end
+end

data/lib/avm/stereotypes/eac_rails_base0/deploy.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'avm/stereotypes/eac_webapp_base0/deploy'
+
+module Avm
+  module Stereotypes
+    module EacRailsBase0
+      class Deploy < ::Avm::Stereotypes::EacWebappBase0::Deploy
+      end
+    end
+  end
+end

data/lib/avm/stereotypes/eac_rails_base0/instance.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'avm/stereotypes/eac_webapp_base0/instance'
+
+module Avm
+  module Stereotypes
+    module EacRailsBase0
+      class Instance < ::Avm::Stereotypes::EacWebappBase0::Instance
+        FILES_UNITS = { uploads: 'public/uploads' }.freeze
+      end
+    end
+  end
+end

data/lib/avm/stereotypes/eac_webapp_base0.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub(__FILE__)
+
+module Avm
+  module Stereotypes
+    module EacWebappBase0
+    end
+  end
+end

data/lib/avm/stereotypes/eac_webapp_base0/deploy.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'eac_ruby_utils/core_ext'
+require 'eac_launcher/git/base'
+require 'avm/git'
+require 'avm/patches/object/template'
+
+module Avm
+  module Stereotypes
+    module EacWebappBase0
+      class Deploy
+        enable_console_speaker
+        enable_simple_cache
+
+        attr_reader :instance, :git_reference
+
+        def initialize(instance, git_reference)
+          @instance = instance
+          @git_reference = git_reference
+        end
+
+        def run
+          start_banner
+          git_deploy
+          setup_files_units
+          assert_instance_branch
+          ::Avm::Result.success('Deployed')
+        rescue ::Avm::Result::Error => e
+          e.to_result
+        end
+
+        def start_banner
+          infov 'Instance', instance
+          infov 'Git reference (User)', git_reference.if_present('- BLANK -')
+          infov 'Git remote name', git_remote_name
+          infov 'Git reference (Found)', git_reference_found
+          infov 'Git commit SHA1', commit_sha1
+        end
+
+        def git_deploy
+          infom 'Deploying source code and appended content...'
+          ::Avm::Git::Commit.new(git, commit_sha1).deploy_to_env_path(
+            instance.host_env,
+            instance.read_entry(:fs_path)
+          ).append_directory(template_path).variables_source_set(instance).run
+        end
+
+        def setup_files_units
+          instance.class.const_get('FILES_UNITS').each do |data_key, fs_path_subpath|
+            FilesUnit.new(self, data_key, fs_path_subpath).run
+          end
+        end
+
+        def assert_instance_branch
+          infom 'Setting instance branch...'
+          git.execute!('push', git_remote_name, "#{commit_sha1}:refs/heads/#{instance.id}", '-f')
+        end
+
+        def commit_sha1_uncached
+          git_fetch
+          r = git.rev_parse(git_reference_found)
+          return r if r
+
+          raise ::Avm::Result::Error, "No commit SHA1 found for \"#{git_reference_found}\""
+        end
+
+        def git_reference_found_uncached
+          %w[git_reference instance_branch master_branch].map { |b| send(b) }.find(&:present?) ||
+            raise(
+              ::Avm::Result::Error,
+              'No git reference found (Searched for option, instance and master)'
+            )
+        end
+
+        def git_uncached
+          ::EacLauncher::Git::Base.new(git_repository_path)
+        end
+
+        def instance_branch
+          remote_branch(instance.id)
+        end
+
+        def master_branch
+          remote_branch('master')
+        end
+
+        def git_remote_name
+          ::Avm::Git::DEFAULT_REMOTE_NAME
+        end
+
+        def git_remote_hashs_uncached
+          git.remote_hashs(git_remote_name)
+        end
+
+        def git_fetch_uncached
+          infom "Fetching remote \"#{git_remote_name}\" from \"#{git_repository_path}\"..."
+          git.fetch(git_remote_name)
+        end
+
+        def git_repository_path
+          instance.source_instance.read_entry(:fs_path)
+        end
+
+        def remote_branch(name)
+          git_remote_hashs.key?("refs/heads/#{name}") ? "#{git_remote_name}/#{name}" : nil
+        end
+
+        class FilesUnit < ::SimpleDelegator
+          attr_reader :data_key, :fs_path_subpath
+
+          def initialize(deploy, data_key, fs_path_subpath)
+            super(deploy)
+            @data_key = data_key
+            @fs_path_subpath = fs_path_subpath
+          end
+
+          def run
+            assert_source_directory
+            link_source_target
+          end
+
+          def assert_source_directory
+            infom "Asserting \"#{data_key}\" source directory..."
+            instance.host_env.command('mkdir', '-p', source_path).execute!
+          end
+
+          def source_path
+            ::File.join(instance.read_entry(:data_fs_path), data_key.to_s)
+          end
+
+          def target_path
+            ::File.join(instance.read_entry(:fs_path), fs_path_subpath.to_s)
+          end
+
+          def link_source_target
+            infom "Linking \"#{data_key}\" directory..."
+            instance.host_env.command('rm', '-rf', target_path).execute!
+            instance.host_env.command('ln', '-s', source_path, target_path).execute!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/stereotypes/eac_webapp_base0/instance.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'avm/instances/base'
+require 'avm/stereotypes/postgresql/instance_with'
+require 'avm/data/instance/files_unit'
+require 'avm/data/instance/package'
+
+module Avm
+  module Stereotypes
+    module EacWebappBase0
+      class Instance < ::Avm::Instances::Base
+        include ::Avm::Stereotypes::Postgresql::InstanceWith
+
+        FILES_UNITS = { uploads: 'wp-content/uploads', themes: 'wp-content/themes' }.freeze
+
+        def stereotype_name
+          self.class.name.desconstantize.demodulize
+        end
+
+        def data_dump(argv = [])
+          run_subcommand(::Avm::Tools::Runner::EacWordpressBase0::Data::Dump, argv)
+        end
+
+        def data_dump_runner_class
+          "::Avm::Tools::Runner::#{stereotype_name}::Data::Dump".constantize
+        end
+
+        def run_subcommand(subcommand_class, argv)
+          parent = ::OpenStruct.new(instance: self)
+          subcommand_class.new(argv: argv, parent: parent).run
+        end
+
+        def data_package
+          @data_package ||= ::Avm::Data::Instance::Package.new(
+            self, units: { database: database_unit }.merge(files_units)
+          )
+        end
+
+        def database_unit
+          pg.data_unit
+        end
+
+        private
+
+        def files_units
+          FILES_UNITS.map do |data_key, fs_path_subpath|
+            [data_key, ::Avm::Data::Instance::FilesUnit.new(self, fs_path_subpath)]
+          end.to_h
+        end
+      end
+    end
+  end
+end

data/lib/avm/stereotypes/eac_wordpress_base0/deploy.rb

@@ -1,147 +1,11 @@
 # frozen_string_literal: true
 
-require 'delegate'
-require 'eac_ruby_utils/core_ext'
-require 'eac_launcher/git/base'
-require 'avm/git/commit'
-require 'avm/patches/object/template'
+require 'avm/stereotypes/eac_webapp_base0/deploy'
 
 module Avm
   module Stereotypes
     module EacWordpressBase0
-      class Deploy
-        enable_console_speaker
-        enable_simple_cache
-
-        attr_reader :instance, :git_reference
-
-        DEFAULT_REMOTE_NAME = 'origin'
-
-        def initialize(instance, git_reference)
-          @instance = instance
-          @git_reference = git_reference
-        end
-
-        def run
-          start_banner
-          git_deploy
-          setup_files_units
-          assert_instance_branch
-          ::Avm::Result.success('Deployed')
-        rescue ::Avm::Result::Error => e
-          e.to_result
-        end
-
-        def start_banner
-          infov 'Instance', instance
-          infov 'Git reference (User)', git_reference.if_present('- BLANK -')
-          infov 'Git remote name', git_remote_name
-          infov 'Git reference (Found)', git_reference_found
-          infov 'Git commit SHA1', commit_sha1
-        end
-
-        def git_deploy
-          infom 'Deploying source code and appended content...'
-          ::Avm::Git::Commit.new(git, commit_sha1).deploy_to_env_path(
-            instance.host_env,
-            instance.read_entry(:fs_path)
-          ).append_directory(template_path).variables_source_set(instance).run
-        end
-
-        def setup_files_units
-          ::Avm::Stereotypes::EacWordpressBase0::Instance::FILES_UNITS
-            .each do |data_key, fs_path_subpath|
-            FilesUnit.new(self, data_key, fs_path_subpath).run
-          end
-        end
-
-        def assert_instance_branch
-          infom 'Setting instance branch...'
-          git.execute!('push', git_remote_name, "#{commit_sha1}:refs/heads/#{instance.id}", '-f')
-        end
-
-        def commit_sha1_uncached
-          git_fetch
-          r = git.rev_parse(git_reference_found)
-          return r if r
-
-          raise ::Avm::Result::Error, "No commit SHA1 found for \"#{git_reference_found}\""
-        end
-
-        def git_reference_found_uncached
-          %w[git_reference instance_branch master_branch].map { |b| send(b) }.find(&:present?) ||
-            raise(
-              ::Avm::Result::Error,
-              'No git reference found (Searched for option, instance and master)'
-            )
-        end
-
-        def git_uncached
-          ::EacLauncher::Git::Base.new(git_repository_path)
-        end
-
-        def instance_branch
-          remote_branch(instance.id)
-        end
-
-        def master_branch
-          remote_branch('master')
-        end
-
-        def git_remote_name
-          DEFAULT_REMOTE_NAME
-        end
-
-        def git_remote_hashs_uncached
-          git.remote_hashs(git_remote_name)
-        end
-
-        def git_fetch_uncached
-          infom "Fetching remote \"#{git_remote_name}\" from \"#{git_repository_path}\"..."
-          git.fetch(git_remote_name)
-        end
-
-        def git_repository_path
-          instance.source_instance.read_entry(:fs_path)
-        end
-
-        def remote_branch(name)
-          git_remote_hashs.key?("refs/heads/#{name}") ? "#{git_remote_name}/#{name}" : nil
-        end
-
-        class FilesUnit < ::SimpleDelegator
-          attr_reader :data_key, :fs_path_subpath
-
-          def initialize(deploy, data_key, fs_path_subpath)
-            super(deploy)
-            @data_key = data_key
-            @fs_path_subpath = fs_path_subpath
-          end
-
-          def run
-            assert_source_directory
-            link_source_target
-          end
-
-          def assert_source_directory
-            infom "Asserting \"#{data_key}\" source directory..."
-            instance.host_env.command('mkdir', '-p', source_path).execute!
-          end
-
-          def source_path
-            ::File.join(instance.read_entry(:data_fs_path), data_key.to_s)
-          end
-
-          def target_path
-            ::File.join(instance.read_entry(:fs_path), fs_path_subpath.to_s)
-          end
-
-          def link_source_target
-            infom "Linking \"#{data_key}\" directory..."
-            instance.host_env.command('rm', '-rf', target_path).execute!
-            instance.host_env.command('ln', '-s', source_path, target_path).execute!
-          end
-        end
+      class Deploy < ::Avm::Stereotypes::EacWebappBase0::Deploy
       end
     end
   end

data/lib/avm/stereotypes/eac_wordpress_base0/instance.rb

@@ -1,36 +1,16 @@
 # frozen_string_literal: true
 
-require 'avm/instances/base'
-require 'avm/stereotypes/postgresql/instance_with'
-require 'avm/data/instance/files_unit'
-require 'avm/data/instance/package'
+require 'avm/stereotypes/eac_webapp_base0/instance'
 
 module Avm
   module Stereotypes
     module EacWordpressBase0
-      class Instance < ::Avm::Instances::Base
-        include ::Avm::Stereotypes::Postgresql::InstanceWith
-
+      class Instance < ::Avm::Stereotypes::EacWebappBase0::Instance
         FILES_UNITS = { uploads: 'wp-content/uploads', themes: 'wp-content/themes' }.freeze
 
-        def data_dump(argv = [])
-          run_subcommand(::Avm::Tools::Runner::EacWordpressBase0::Data::Dump, argv)
-        end
-
-        def run_subcommand(subcommand_class, argv)
-          parent = ::OpenStruct.new(instance: self)
-          subcommand_class.new(argv: argv, parent: parent).run
-        end
-
-        def data_package
-          @data_package ||= ::Avm::Data::Instance::Package.new(
-            self, units: { database: database_unit }.merge(files_units)
-          )
-        end
-
         def database_unit
           self_instance = self
-          pg.data_unit.after_load do
+          super.after_load do
             info 'Fixing web addresses...'
             run_sql(<<~SQL)
               update wp_options
@@ -39,14 +19,6 @@ module Avm
             SQL
           end
         end
-
-        private
-
-        def files_units
-          FILES_UNITS.map do |data_key, fs_path_subpath|
-            [data_key, ::Avm::Data::Instance::FilesUnit.new(self, fs_path_subpath)]
-          end.to_h
-        end
       end
     end
   end

data/lib/avm/tools/runner/eac_rails_base0.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/console/docopt_runner'
+require 'eac_ruby_utils/simple_cache'
+require 'avm/stereotypes/eac_rails_base0/instance'
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub(__FILE__)
+
+module Avm
+  module Tools
+    class Runner < ::EacRubyUtils::Console::DocoptRunner
+      class EacRailsBase0 < ::EacRubyUtils::Console::DocoptRunner
+        include ::EacRubyUtils::SimpleCache
+
+        DOC = <<~DOCOPT
+          Utilities for EacRailsBase0 instances.
+
+          Usage:
+            __PROGRAM__ [options] <instance_id> __SUBCOMMANDS__
+            __PROGRAM__ -h | --help
+
+          Options:
+            -h --help             Show this screen.
+        DOCOPT
+
+        private
+
+        def instance_uncached
+          ::Avm::Stereotypes::EacRailsBase0::Instance.by_id(options['<instance_id>'])
+        end
+      end
+    end
+  end
+end

data/lib/avm/tools/runner/eac_rails_base0/deploy.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/console/docopt_runner'
+require 'eac_ruby_utils/console/speaker'
+require 'avm/stereotypes/eac_rails_base0/deploy'
+
+module Avm
+  module Tools
+    class Runner < ::EacRubyUtils::Console::DocoptRunner
+      class EacRailsBase0 < ::EacRubyUtils::Console::DocoptRunner
+        class Deploy < ::EacRubyUtils::Console::DocoptRunner
+          include ::EacRubyUtils::Console::Speaker
+
+          DOC = <<~DOCOPT
+            Deploy for EacRailsBase0 instance.
+
+            Usage:
+              __PROGRAM__ [options]
+              __PROGRAM__ -h | --help
+
+            Options:
+              -h --help                       Show this screen.
+              -r --reference=<git-reference>  Git reference to deploy.
+          DOCOPT
+
+          def run
+            result = ::Avm::Stereotypes::EacRailsBase0::Deploy.new(
+              context(:instance),
+              options.fetch('--reference')
+            ).run
+            if result.error?
+              fatal_error result.to_s
+            else
+              infov 'Result', result.label
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/tools/runner/git/deploy.rb

@@ -40,6 +40,7 @@ module Avm
             infov 'Repository', git
             infov 'Reference', reference
             infov 'Instance ID', instance_id.if_present('- BLANK -')
+            infov 'Appended directories', appended_directories
           end
 
           def validate
@@ -67,7 +68,7 @@ module Avm
           def deploy
             ::Avm::Git::Commit.new(git, reference_sha1)
                               .deploy_to_url(options.fetch('<target-url>'))
-                              .append_directories(options.fetch('<append-directories>'))
+                              .append_directories(appended_directories)
                               .variables_source_set(variables_source)
                               .run
           end
@@ -83,6 +84,10 @@ module Avm
           def instance_id
             options.fetch('--instance')
           end
+
+          def appended_directories
+            options.fetch('<append-directories>')
+          end
         end
       end
     end

data/lib/avm/tools/version.rb

@@ -2,6 +2,6 @@
 
 module Avm
   module Tools
-    VERSION = '0.17.0'
+    VERSION = '0.18.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avm-tools
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Esquilo Azul Company
@@ -214,6 +214,12 @@ files:
 - lib/avm/patches/object/template.rb
 - lib/avm/result.rb
 - lib/avm/stereotypes.rb
+- lib/avm/stereotypes/eac_rails_base0.rb
+- lib/avm/stereotypes/eac_rails_base0/deploy.rb
+- lib/avm/stereotypes/eac_rails_base0/instance.rb
+- lib/avm/stereotypes/eac_webapp_base0.rb
+- lib/avm/stereotypes/eac_webapp_base0/deploy.rb
+- lib/avm/stereotypes/eac_webapp_base0/instance.rb
 - lib/avm/stereotypes/eac_wordpress_base0/deploy.rb
 - lib/avm/stereotypes/eac_wordpress_base0/instance.rb
 - lib/avm/stereotypes/postgresql.rb
@@ -226,6 +232,8 @@ files:
 - lib/avm/tools.rb
 - lib/avm/tools/git.rb
 - lib/avm/tools/runner.rb
+- lib/avm/tools/runner/eac_rails_base0.rb
+- lib/avm/tools/runner/eac_rails_base0/deploy.rb
 - lib/avm/tools/runner/eac_wordpress_base0.rb
 - lib/avm/tools/runner/eac_wordpress_base0/data.rb
 - lib/avm/tools/runner/eac_wordpress_base0/data/dump.rb