eac_tools 0.97.2 → 0.98.0

data/sub/avm/lib/avm/rspec/launcher_controller.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'avm/launcher/context'
+require 'eac_config/node'
+require 'eac_ruby_utils/core_ext'
+require 'fileutils'
+require 'ruby-progressbar'
+require 'tmpdir'
+
+module Avm
+  module Rspec
+    class LauncherController
+      attr_accessor :remotes_dir
+
+      # @param application_id [String]
+      # @param path [Pathname]
+      # @return void
+      def application_source_path(application_id, path)
+        EacConfig::Node.context.current.entry("#{application_id}_dev.install.path").value =
+          path.to_pathname.to_path
+      end
+
+      # @param settings_path [Pathname]
+      # @param projects_root [Pathname]
+      def context_set(settings_path, projects_root)
+        Avm::Launcher::Context.current = Avm::Launcher::Context.new(
+          settings_file: settings_path.to_pathname.to_path,
+          cache_root: Dir.mktmpdir
+        )
+        self.projects_root = projects_root
+      end
+
+      # @return [Pathname]
+      def default_settings_path
+        templates_directory.join('settings.yml')
+      end
+
+      # @return [Pathname]
+      def dummy_directory
+        templates_directory.join('dummy')
+      end
+
+      # @param settings_path [Pathname]
+      def temp_context(settings_path)
+        context_set(settings_path, Dir.mktmpdir)
+      end
+
+      def init_remote(name)
+        require 'avm/git/launcher/base'
+        r = Avm::Git::Launcher::Base.new(File.join(remotes_dir, name))
+        r.init_bare
+        r
+      end
+
+      def init_git(subdir)
+        require 'avm/git/launcher/base'
+        r = Avm::Git::Launcher::Base.new(File.join(projects_root, subdir))
+        r.git
+        r.execute!('config', 'user.email', 'theuser@example.net')
+        r.execute!('config', 'user.name', 'The User')
+        r
+      end
+
+      # @return [Avm::Launcher::Context]
+      def new_context
+        Avm::Launcher::Context.new(
+          settings_file: default_settings_path,
+          cache_root: Dir.mktmpdir
+        )
+      end
+
+      # @param path [String]
+      def projects_root
+        @projects_root ||= Dir.mktmpdir
+      end
+
+      # @param path [Pathname]
+      def projects_root=(path)
+        @projects_root = path.to_pathname.to_path
+      end
+
+      # @return [Pathname]
+      def templates_directory
+        '../../../template/avm/rspec/launcher_controller'.to_pathname.expand_path(__dir__)
+      end
+
+      def touch_commit(repos, subpath)
+        require 'fileutils'
+        FileUtils.mkdir_p(File.dirname(repos.subpath(subpath)))
+        FileUtils.touch(repos.subpath(subpath))
+        repos.execute!('add', repos.subpath(subpath))
+        repos.execute!('commit', '-m', subpath)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/setup/launcher.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'avm/launcher/context'
+require 'eac_ruby_utils/core_ext'
+require 'tmpdir'
+
+module Avm
+  module Rspec
+    module Setup
+      module Launcher
+        def temp_launcher_context(settings_file = nil)
+          settings_file ||= temp_file
+          ::Avm::Launcher::Context.current = ::Avm::Launcher::Context.new(
+            projects_root: ::Dir.mktmpdir, settings_file: settings_file, cache_root: ::Dir.mktmpdir
+          )
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/setup/source_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Rspec
+    module Setup
+      module SourceGenerator
+        DEFAULT_TARGET_BASENAME = 'generated_app'
+
+        # @return [Avm::Sources::Base]
+        def avm_source(stereotype_name, options = {})
+          options = options.dup
+          target_basename ||= options.delete(:target_basename) || DEFAULT_TARGET_BASENAME
+          target_path ||= options.delete(:target_path) || temp_dir.join(target_basename)
+          ::Avm::Registry.source_generators.detect(stereotype_name, target_path, options).perform
+          ::Avm::Registry.sources.detect(target_path)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/setup.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'avm/rspec/setup/source_generator'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Rspec
+    module Setup
+      require_sub __FILE__
+      EXAMPLES = %w[avm_file_formats_with_fixtures avm_file_format_file_resource_name
+                    avm_source_generated entries_values in_avm_registry not_in_avm_registry
+                    with_config with_launcher].freeze
+
+      def self.extended(obj)
+        obj.setup_examples
+        obj.rspec_config.include(::Avm::Rspec::Setup::Launcher)
+        obj.rspec_config.include(::Avm::Rspec::Setup::SourceGenerator)
+      end
+
+      def setup_examples
+        EXAMPLES.each do |example|
+          require "avm/rspec/shared_examples/#{example}"
+        end
+      end
+
+      # @return [self]
+      def stub_avm_contexts
+        stub_eac_config_node
+        stub_eac_fs_contexts
+        stub_eac_speaker
+
+        self
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/avm_file_format_file_resource_name.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+RSpec.shared_examples 'avm_file_format_file_resource_name' do |input_expected|
+  describe '#file_resource_name' do
+    input_expected.each do |path, expected_resource_name|
+      context "when path is \"#{path}\"" do
+        let(:instance) { described_class.new }
+
+        it { expect(instance.file_resource_name(path)).to eq(expected_resource_name) }
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/avm_file_formats_with_fixtures.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'avm/file_formats/search_formatter'
+require 'eac_ruby_utils/core_ext'
+
+RSpec.shared_examples 'avm_file_formats_with_fixtures' do |the_spec_file|
+  include_examples 'source_target_fixtures', the_spec_file
+
+  def format_files_in_directory(target_dir)
+    Avm::FileFormats::SearchFormatter
+      .new([target_dir], recursive: true, apply: true, verbose: false)
+      .run
+  end
+
+  def source_data(source_file)
+    dir = temp_dir
+    source_basename = source_file_basename_without_source_extname(source_file)
+    source_path = dir.join(source_basename)
+    FileUtils.cp(source_file, source_path)
+    format_files_in_directory(dir)
+    source_path.read
+  end
+
+  def source_file_basename_without_source_extname(source_file)
+    source_file.to_pathname.basename_sub { |b| b.to_path.gsub('.source', '') }.basename
+  end
+
+  def target_data(target_file)
+    File.read(target_file)
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/avm_source_generated.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'eac_fs/comparator'
+require 'eac_ruby_utils/core_ext'
+
+RSpec.shared_examples 'avm_source_generated' do |spec_file, stereotype, options = {}|
+  include_context 'spec_paths', spec_file
+  block_on_each_source = options.delete(:block_on_each_source)
+
+  spec_paths_controller.fixtures_directory.children.select(&:directory?).each do |target_dir|
+    context "when target is \"#{target_dir.basename}\"" do
+      let(:source) { avm_source(stereotype, options.merge(target_basename: target_dir.basename)) }
+
+      it do
+        expect(fs_comparator.build(source.path)).to eq(fs_comparator.build(target_dir))
+      end
+
+      instance_exec(&block_on_each_source) if block_on_each_source
+    end
+  end
+
+  # @return [EacFs::Comparato]
+  def fs_comparator
+    EacFs::Comparator.new.rename_file('.gitignore', '_gitignore')
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/entries_values.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+RSpec.shared_examples 'entries_values' do |spec_file, expected_values|
+  describe '#read_entry' do
+    include_examples 'with_config', spec_file
+
+    expected_values.each do |instance_id, values|
+      values.each do |input, expected|
+        context "when a auto value is requested for \"#{instance_id}.#{input}\"" do
+          let(:instance) { described_class.by_id(instance_id) }
+
+          it ".entry('#{input}').value should return \"#{expected}\"" do
+            expect(instance.entry(input).value).to eq(expected)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/in_avm_registry.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+
+RSpec.shared_examples 'in_avm_registry' do |registry_method|
+  let(:avm_registry) { Avm::Registry.send(registry_method) }
+
+  it 'is in the avm registry' do
+    expect(avm_registry.registered_modules).to include(described_class)
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/not_in_avm_registry.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+
+RSpec.shared_examples 'not_in_avm_registry' do |registry_method = nil|
+  registry_method.if_present(Avm::Registry.registries) { |v| [Avm::Registry.send(v)] }
+    .each do |registry|
+    context "when registry is #{registry}" do
+      it 'is not in the avm registry' do
+        expect(registry.available).not_to include(described_class)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/shared_examples/with_config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+RSpec.shared_examples 'with_config' do |spec_file|
+  config_path = spec_file.to_pathname
+  config_path = config_path.dirname.join("#{config_path.basename_noext}_files", 'config.yml')
+  temp_config_path = EacRubyUtils::Fs::Temp.file
+  FileUtils.cp(config_path, temp_config_path)
+  EacRubyUtils::Rspec.default_setup.stub_eac_config_node(self, temp_config_path)
+end

data/sub/avm/lib/avm/rspec/shared_examples/with_launcher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'avm/rspec/launcher_controller'
+
+RSpec.shared_context 'with_launcher' do
+  let(:launcher_controller) { Avm::Rspec::LauncherController.new }
+
+  before do
+    Avm::Launcher::Context.current = launcher_controller.new_context
+    launcher_controller.remotes_dir = Dir.mktmpdir
+    allow(ProgressBar).to receive(:create).and_return(double.as_null_object)
+  end
+
+  delegate :application_source_path, :context_set, :init_git, :init_remote, :temp_context,
+           :projects_root, :projects_root=, :touch_commit, to: :launcher_controller
+end

data/sub/{eac_config/lib/eac_config → avm/lib/avm}/rspec.rb

@@ -2,7 +2,7 @@
 
 require 'eac_ruby_utils/core_ext'
 
-module EacConfig
+module Avm
   module Rspec
     require_sub __FILE__
   end

data/sub/avm/lib/avm/runners/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module Runners
+    class Base
+      enable_abstract_methods
+
+      class << self
+        def command_argument
+          stereotype_name.underscore.dasherize
+        end
+
+        def stereotype_name
+          name.split('::')[-3]
+        end
+      end
+
+      delegate :command_argument, :stereotype_name, to: :class
+
+      def to_s
+        stereotype_name
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/file_resource_name.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Scms
+    module AutoCommit
+      class FileResourceName
+        require_sub __FILE__, include_modules: true
+        enable_simple_cache
+        common_constructor :source_root, :path do
+          self.source_root = source_root.to_pathname
+          self.path = path.to_pathname
+        end
+
+        def class_name
+          file_format.file_resource_name(relative_path)
+        end
+
+        def commit_message
+          r = class_name
+          r += ': remove' unless path.file?
+          "#{r}."
+        end
+
+        def relative_path
+          path.expand_path.relative_path_from(source_root.expand_path)
+        end
+
+        private
+
+        # @return [Avm::FileFormats::Base]
+        def file_format_uncached
+          ::Avm::Registry.file_formats.detect(path)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/for_file.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'avm/scms/commit_info'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Scms
+    module AutoCommit
+      class ForFile
+        enable_speaker
+        enable_simple_cache
+        enable_listable
+
+        common_constructor :scm, :path, :rules do
+          self.path = path.to_pathname.expand_path(scm.path)
+        end
+
+        COMMITS_SEARCH_INTERVAL = 'origin/master..HEAD'
+
+        def scm_relative_path
+          path.to_pathname.relative_path_from(scm.path)
+        end
+
+        def run
+          start_banner
+          run_commit || warn("No rule returned commit information for \"#{path}\"")
+        end
+
+        private
+
+        # @return [Boolean]
+        def changed?
+          scm.changed_files.any? { |cf| cf.path == scm_relative_path }
+        end
+
+        def commit_info_uncached
+          rules.lazy.map { |rule| rule.with_file(self).commit_info }.find(&:present?)
+            .if_present { |v| v.path(path) }
+        end
+
+        def start_banner
+          infov 'Path', path
+          infov '  Commits found', commits.count
+        end
+
+        def run_commit
+          return false if commit_info.blank?
+
+          infov '  Commit info', commit_info
+          if changed?
+            scm.run_commit(commit_info)
+            success '  Commited'
+          else
+            warn "  File \"#{path}\" unchanged"
+          end
+
+          true
+        end
+
+        def commits_uncached
+          scm.current_milestone_interval.commits
+            .select { |c| c.changed_files.include?(path.relative_path_from(scm.path)) }
+            .reject(&:fixup?).each_with_index
+            .map { |commit, index| CommitDelegator.new(commit, index) }
+        end
+
+        class CommitDelegator < ::SimpleDelegator
+          attr_reader :index
+
+          def initialize(commit, index)
+            super(commit)
+            @index = index
+          end
+
+          def position
+            index + 1
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/rules/base.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'avm/scms/commit_info'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Scms
+    module AutoCommit
+      module Rules
+        class Base
+          class << self
+            def keys
+              [long_key, short_key]
+            end
+
+            def long_key
+              name.demodulize.variableize
+            end
+
+            def short_key
+              long_key[0, 1]
+            end
+          end
+
+          def with_file(file)
+            self.class.const_get('WithFile').new(self, file)
+          end
+
+          class WithFile
+            common_constructor :rule, :file
+
+            def new_commit_info
+              ::Avm::Scms::CommitInfo.new
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/rules/last.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'avm/scms/auto_commit/rules/base'
+
+module Avm
+  module Scms
+    module AutoCommit
+      module Rules
+        class Last < ::Avm::Scms::AutoCommit::Rules::Base
+          class WithFile < ::Avm::Scms::AutoCommit::Rules::Base::WithFile
+            def commit_info
+              file.commits.last.if_present { |v| new_commit_info.fixup(v) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/rules/manual.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'avm/scms/auto_commit/rules/base'
+
+module Avm
+  module Scms
+    module AutoCommit
+      module Rules
+        class Manual < ::Avm::Scms::AutoCommit::Rules::Base
+          class WithFile < ::Avm::Scms::AutoCommit::Rules::Base::WithFile
+            enable_speaker
+
+            SKIP_OPTION = 's'
+
+            def commit_info
+              return nil unless file.commits.any?
+
+              commits_banner
+              input('Which commit?', list: commits_by_position).if_present do |v|
+                new_commit_info.fixup(v)
+              end
+            end
+
+            def commits_banner
+              file.commits.each_with_index do |commit, _index|
+                infov "    #{commit.position}", commit
+              end
+              infov "    #{SKIP_OPTION}", 'skip'
+            end
+
+            def commits_by_position
+              (file.commits.map { |commit| [commit.position.to_s, commit] } + [[SKIP_OPTION, nil]])
+                .to_h
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/rules/new.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'avm/scms/auto_commit/rules/base'
+require 'avm/scms/auto_commit/file_resource_name'
+
+module Avm
+  module Scms
+    module AutoCommit
+      module Rules
+        class New < ::Avm::Scms::AutoCommit::Rules::Base
+          class WithFile < ::Avm::Scms::AutoCommit::Rules::Base::WithFile
+            def auto_commit_path
+              ::Avm::Scms::AutoCommit::FileResourceName.new(file.scm.path, file.path)
+            end
+
+            def commit_info
+              new_commit_info.message(auto_commit_path.commit_message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/rules/nth.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'avm/scms/auto_commit/rules/base'
+
+module Avm
+  module Scms
+    module AutoCommit
+      module Rules
+        class Nth < ::Avm::Scms::AutoCommit::Rules::Base
+          SHORT_KEY = 't'
+
+          class << self
+            def short_key
+              SHORT_KEY
+            end
+          end
+
+          common_constructor :number do
+            self.number = number.to_i
+          end
+
+          class WithFile < ::Avm::Scms::AutoCommit::Rules::Base::WithFile
+            def commit_info
+              file.commits(number - 1).if_present { |v| new_commit_info.fixup(v) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/scms/auto_commit/rules/unique.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'avm/scms/auto_commit/rules/base'
+
+module Avm
+  module Scms
+    module AutoCommit
+      module Rules
+        class Unique < ::Avm::Scms::AutoCommit::Rules::Base
+          class WithFile < ::Avm::Scms::AutoCommit::Rules::Base::WithFile
+            def commit_info
+              return nil unless file.commits.count == 1
+
+              new_commit_info.fixup(file.commits.first)
+            end
+          end
+        end
+      end
+    end
+  end
+end