eac_tools 0.111.1 → 0.112.0

data/sub/avm-eac_webapp_base0/avm-eac_webapp_base0.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'avm/eac_webapp_base0/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'avm-eac_webapp_base0'
+  s.version     = Avm::EacWebappBase0::VERSION
+  s.authors     = ['Put here the authors']
+  s.summary     = 'Put here de description.'
+
+  s.files = Dir['{lib,template}/**/{*,.*}']
+  s.required_ruby_version = '>= 2.7'
+
+  s.add_dependency 'avm', '~> 0.98', '>= 0.98.5'
+  s.add_dependency 'avm-eac_generic_base0', '~> 0.15', '>= 0.15.2'
+  s.add_dependency 'avm-eac_postgresql_base0', '~> 0.6'
+  s.add_dependency 'avm-eac_ubuntu_base0', '~> 0.7'
+  s.add_dependency 'eac_ruby_utils', '~> 0.130'
+  s.add_dependency 'htmlbeautifier', '~> 1.4', '>= 1.4.3'
+
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.12', '>= 0.12.2'
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/executables.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Executables
+      class << self
+        enable_simple_cache
+
+        def env
+          ::EacRubyUtils::Envs.local
+        end
+
+        private
+
+        %w[cssbeautify-cli js-beautify tidy].each do |program|
+          define_method("#{program.underscore}_uncached") do
+            env.executable(program, '--version')
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/file_formats/css/file_apply.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module FileFormats
+      class Css < ::Avm::EacGenericBase0::FileFormats::Base
+        class FileApply
+          EXECUTABLE_NAME = 'cssbeautify-cli'
+          EXECUTABLE_CHECK_ARGS = ['--version'].freeze
+          EXECUTABLE_STATIC_ARGS = ['--autosemicolon', '--indent', '  ', '--openbrace',
+                                    'end-of-line', '--stdin'].freeze
+
+          common_constructor :file
+
+          def perform
+            on_temp_output_file do |_temp_file|
+              run_command
+            end
+          end
+
+          private
+
+          attr_accessor :output_file
+
+          def command
+            ::Avm::EacWebappBase0::Executables.cssbeautify_cli.command(*EXECUTABLE_STATIC_ARGS)
+          end
+
+          def on_temp_output_file
+            ::EacRubyUtils::Fs::Temp.on_file do |temp_output_file|
+              self.output_file = temp_output_file
+              yield
+              ::FileUtils.mv(temp_output_file.to_path, file)
+            end
+          end
+
+          def run_command
+            command.system!(input_file: file, output_file: output_file.to_path)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/file_formats/css.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module FileFormats
+      class Css < ::Avm::EacGenericBase0::FileFormats::Base
+        VALID_BASENAMES = %w[*.css *.scss].freeze
+        VALID_TYPES = [].freeze
+
+        def file_apply(file)
+          ::Avm::EacWebappBase0::FileFormats::Css::FileApply.new(file).perform
+          super
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/file_formats/html.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'htmlbeautifier'
+
+module Avm
+  module EacWebappBase0
+    module FileFormats
+      class Html < ::Avm::EacGenericBase0::FileFormats::Base
+        VALID_BASENAMES = %w[*.html *.html.erb].freeze
+        VALID_TYPES = [].freeze
+
+        def file_apply(path)
+          input = ::File.read(path)
+          temppath = tempfile_path
+          ::File.open(temppath, 'w') do |output|
+            beautify path, input, output
+          end
+          ::FileUtils.mv(temppath, path)
+          super
+        end
+
+        private
+
+        def beautify(name, input, output)
+          output.puts ::HtmlBeautifier.beautify(input, htmlbeautify_options)
+        rescue StandardError => e
+          raise "Error parsing #{name}: #{e}"
+        end
+
+        def htmlbeautify_options
+          @htmlbeautify_options ||= { indent: '  ' }
+        end
+
+        def tempfile_path
+          tempfile = ::Tempfile.new
+          tempfile.close
+          tempfile.path
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/file_formats/javascript.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module FileFormats
+      class Javascript < ::Avm::EacGenericBase0::FileFormats::Base
+        VALID_BASENAMES = %w[*.js].freeze
+        VALID_TYPES = [].freeze
+
+        def internal_apply(files)
+          ::Avm::EacWebappBase0::Executables.js_beautify.command.append(
+            ['--indent-size=2', '--end-with-newline', '--replace', *files]
+          ).system!
+          super
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/file_formats/json.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module FileFormats
+      class Json < ::Avm::EacGenericBase0::FileFormats::Base
+        VALID_BASENAMES = %w[*.json].freeze
+        VALID_TYPES = [].freeze
+
+        def file_apply(file)
+          ::File.write(file, ::JSON.pretty_generate(::JSON.parse(::File.read(file))))
+        end
+
+        def json_file?(file)
+          ::JSON.parse(::File.read(file))
+          true
+        rescue JSON::ParserError
+          false
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/file_formats/provider.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module FileFormats
+      class Provider
+        ALL_NAMES = %w[css html javascript json xml].freeze
+
+        def all
+          @all ||= ALL_NAMES.map do |name|
+            ::Avm::EacWebappBase0::FileFormats.const_get(name.camelize)
+          end.freeze
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/file_formats/xml.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module FileFormats
+      class Xml < ::Avm::EacGenericBase0::FileFormats::Base
+        VALID_BASENAMES = %w[*.svg *.xml].freeze
+        VALID_TYPES = ['image/svg+xml', 'xml'].freeze
+
+        def internal_apply(files)
+          format_command(files).system!
+          super
+        end
+
+        def format_command(files)
+          ::Avm::EacWebappBase0::Executables.tidy.command.append(
+            %w[-xml -modify --indent auto --indent-spaces 2 --wrap 100] + files
+          )
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/apache_base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class ApacheBase
+        # @return [String]
+        def document_root
+          instance.read_entry(::Avm::Instances::EntryKeys::INSTALL_PATH)
+        end
+
+        protected
+
+        def reload_apache
+          infom 'Reloading Apache...'
+          apache.service('reload')
+        end
+
+        private
+
+        # @return [Avm::EacUbuntuBase0::Apache]
+        def apache_uncached
+          instance.platform_instance.apache
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/apache_host.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class ApacheHost < ::Avm::EacWebappBase0::Instances::ApacheBase
+        APACHE_DIRECTORY_EXTRA_CONFIG_KEY = 'install.apache_directory_extra_config'
+        JOBS = %w[write_available_no_ssl_site enable_no_ssl_site remove_ssl_site reload_apache
+                  run_certbot enable_ssl_site reload_apache].freeze
+        include ::Avm::Entries::Jobs::Base
+
+        def directory_extra_config
+          instance.entry(APACHE_DIRECTORY_EXTRA_CONFIG_KEY).optional_value
+            .if_present { |v| "  #{v}\n" }
+        end
+
+        def no_ssl_site_content
+          ::Avm::EacWebappBase0::Instances::ApacheHost
+            .template.child('no_ssl.conf')
+            .apply(variables_source)
+        end
+
+        def ssl?
+          options[:certbot]
+        end
+
+        private
+
+        def enable_no_ssl_site
+          infom 'Enabling no SSL site...'
+          no_ssl_site.enable
+        end
+
+        def enable_ssl_site
+          return unless ssl?
+
+          infom 'Enabling SSL site...'
+          ssl_site.enable
+        end
+
+        def no_ssl_site_uncached
+          apache.site(instance.id)
+        end
+
+        def remove_ssl_site
+          infom 'Removing SSL site...'
+          ssl_site.remove
+        end
+
+        def run_certbot
+          return unless ssl?
+
+          infom 'Running Certbot...'
+          instance.host_env.command(
+            'sudo', 'certbot', '--apache', '--domain', instance.read_entry('web.hostname'),
+            '--redirect', '--non-interactive', '--agree-tos',
+            '--email', instance.install_email
+          ).system!
+        end
+
+        def ssl_site_uncached
+          apache.site("#{no_ssl_site.name}-le-ssl")
+        end
+
+        def write_available_no_ssl_site
+          infom 'Writing no SSL site conf...'
+          no_ssl_site.write(no_ssl_site_content)
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/apache_path.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class ApachePath < ::Avm::EacWebappBase0::Instances::ApacheBase
+        JOBS = %w[write_available_conf enable_conf reload_apache].freeze
+        include ::Avm::Entries::Jobs::Base
+
+        def content
+          ::Avm::EacWebappBase0::Instances::ApachePath.template.child('default.conf')
+            .apply(variables_source)
+        end
+
+        def extra_content
+          ''
+        end
+
+        private
+
+        def enable_conf
+          infom 'Enabling configuration...'
+          conf.enable
+        end
+
+        def conf_uncached
+          apache.conf(instance.id)
+        end
+
+        def write_available_conf
+          infom 'Writing available configuration...'
+          conf.write(content)
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base/apache.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        module Apache
+          common_concern
+
+          class_methods do
+            # @return [Class]
+            def apache_path_class
+              ancestors.lazy.map { |ancestor| apache_path_class_by_ancestor(ancestor) }
+                .find(&:present?) || raise("No apache patch class found for \"#{self}\"")
+            end
+
+            private
+
+            # @param ancestor [Module]
+            # @return [Class]
+            def apache_path_class_by_ancestor(ancestor)
+              "#{ancestor.name.deconstantize}::ApachePath".constantize
+            rescue ::NameError
+              nil
+            end
+          end
+
+          # @return [Class]
+          delegate :apache_path_class, to: :class
+
+          # @return [Avm::EacUbuntuBase0::Apache::Resource, nil]
+          def apache_resource
+            %i[conf site]
+              .lazy
+              .map { |type| platform_instance.apache.send(type, install_apache_resource_name) }
+              .find(&:available?)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base/deploy.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        module Deploy
+          common_concern
+
+          # @param options [Class<Avm::EacWebappBase0::Instances::Deploy>]
+          def deploy_class
+            application.stereotype.namespace_module.const_get('Instances').const_get('Deploy')
+          end
+
+          # @param options [Hash]
+          # return [Avm::EacWebappBase0::Instances::Deploy]
+          def deploy_instance(**options)
+            deploy_class.new(self, options)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base/deploy_info.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        module DeployInfo
+          common_concern
+
+          DEPLOY_INFO_SUBPATH = '.deploy.yaml'
+
+          # @return [Avm::EacWebappBase0::Instances::DeployInfo]
+          def deploy_info
+            ::Avm::EacWebappBase0::Instances::DeployInfo.from_string(
+              host_env.command('cat', deploy_info_path).execute!
+            )
+          end
+
+          # @return [Pathname]
+          def deploy_info_path
+            install_path.to_pathname.join(DEPLOY_INFO_SUBPATH)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base/install.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        module Install
+          common_concern do
+            uri_components_entries_values 'install', %w[apache_resource_name request_test_timeout]
+          end
+
+          def install_apache_resource_name_default_value
+            id
+          end
+
+          # @return [Integer]
+          def install_request_test_timeout_default_value
+            ::EacEnvs::Http::Request::FaradayConnection::DEFAULT_TIMEOUT.in_seconds
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        require_sub __FILE__, include_modules: true
+        include ::Avm::EacPostgresqlBase0::InstanceWith
+
+        enable_simple_cache
+
+        def run_subcommand(subcommand_class, argv)
+          subcommand_class.create(
+            argv: argv,
+            parent: ::Avm::Instances::Base::SubcommandParent.new(self)
+          ).run
+        end
+
+        def database_unit
+          pg_data_unit
+        end
+
+        # @return [Array<Avm::Instances::Process>]
+        def processes
+          super + [::Avm::EacWebappBase0::Instances::Processes::WebServer.new(self)]
+        end
+
+        private
+
+        # @return [Avm::EacUbuntuBase0::Instances::Base]
+        def platform_instance_uncached
+          ::Avm::EacUbuntuBase0::Instances::Base.by_id(id)
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/appended_directories.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module AppendedDirectories
+          APPENDED_DIRECTORIES_ENTRY_KEY = 'deploy.appended_directories'
+
+          def appended_directories
+            appended_directories_from_instance_entry + appended_directories_from_options
+          end
+
+          def appended_directories_from_instance_entry
+            ::Avm::PathString.paths(instance.read_entry_optional(APPENDED_DIRECTORIES_ENTRY_KEY))
+          end
+
+          def appended_directories_from_options
+            options[OPTION_APPENDED_DIRECTORIES] || []
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/build.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module Build
+          private
+
+          attr_accessor :build_dir
+
+          def append_instance_content
+            ::Avm::Files::Appender
+              .new
+              .variables_source_set(variables_source)
+              .append_templatized_directory(template)
+              .append_templatized_directories(appended_directories)
+              .append_file_content(version_target_path, version)
+              .write_appended_on(build_dir)
+          end
+
+          def build_dir_env
+            ::EacRubyUtils::Envs.local
+          end
+
+          def create_build_dir
+            self.build_dir = ::EacRubyUtils::Fs::Temp.directory
+          end
+
+          def remove_build_dir
+            build_dir&.remove
+          end
+
+          def build_content
+            infom 'Writing Git source code...'
+            scm.commit(commit_reference).deploy_to_env_path(
+              build_dir_env,
+              build_dir
+            ).variables_source_set(variables_source).run
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/info.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module Info
+          # @return [Hash]
+          def deploy_info
+            ::Avm::EacWebappBase0::Instances::DeployInfo.from_hash(
+              {
+                instance_id: instance.id,
+                time: ::Time.now,
+                commit_id: commit_reference,
+                commit_refs: version_git_refs,
+                version: version_number
+              }
+            )
+          end
+
+          # @return [String]
+          def version
+            deploy_info.to_yaml
+          end
+
+          def version_git_refs
+            git_remote_hashs.select { |_name, sha1| sha1 == commit_reference }.keys
+              .map { |ref| ref.gsub(%r{\Arefs/}, '') }.reject { |ref| ref == 'HEAD' }
+          end
+
+          # @return [String, nil]
+          def version_number
+            instance.application.local_source.version.if_present(&:to_s)
+          end
+
+          # @return [String]
+          def version_target_path
+            ::Avm::EacWebappBase0::Instances::Base::DeployInfo::DEPLOY_INFO_SUBPATH
+          end
+        end
+      end
+    end
+  end
+end