eac_tools 0.31.0 → 0.31.1

data/sub/eac_git/lib/eac_git/local/commit/diff_tree_line.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module EacGit
+  class Local
+    class Commit
+      class DiffTreeLine
+        DIFF_TREE_PATTERN = /\A:(\d{6}) (\d{6}) (\S+) (\S+) (\S+)\t(\S.*)\z/.freeze
+        FIELDS = %w[src_mode dst_mode src_sha1 dst_sha1 status path].freeze
+        GIT_COMMAND_ARGS = %w[-c core.quotepath=off diff-tree --no-commit-id -r --full-index].freeze
+
+        attr_reader(*FIELDS)
+
+        # line: a line of command "git [GIT_COMMAND_ARGS]"'s output.
+        # Reference: https://git-scm.com/docs/git-diff-tree
+        def initialize(line)
+          m = DIFF_TREE_PATTERN.match(line.strip)
+          raise "\"#{line}\" did not match pattern" unless m
+
+          FIELDS.count.times { |i| send("#{FIELDS[i]}=", m[i + 1]) }
+        end
+
+        def fields
+          FIELDS.map { |field| [field, send(field)] }.to_h
+        end
+
+        private
+
+        attr_writer(*FIELDS)
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local/commit.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  class Local
+    class Commit
+      require_sub __FILE__, include_modules: true
+      enable_simple_cache
+      include ::Comparable
+
+      FIELDS = {
+        author_name: '%an', author_email: '%ae', author_date: '%ai',
+        subject: '%s',
+        author_all: '%an <%ae>, %ai',
+        commit_hash: '%H', abbreviated_commit_hash: '%h',
+        commiter_name: '%cn', commiter_email: '%ce', commiter_date: '%ci',
+        commiter_all: '%cn <%ce>, %ci',
+        raw_body: '%B'
+      }.freeze
+
+      common_constructor :repo, :id
+
+      def <=>(other)
+        [repo, id] <=> [other.repo, other.id]
+      end
+
+      def format(format)
+        repo.command('--no-pager', 'log', '-1', "--pretty=format:#{format}", id).execute!.strip
+      end
+
+      FIELDS.each do |field, format|
+        define_method(field) { format(format) }
+      end
+
+      def changed_files_uncached
+        diff_tree_execute.each_line.map do |line|
+          ::EacGit::Local::Commit::ChangedFile.new(self, line)
+        end
+      end
+
+      def changed_files_size_uncached
+        changed_files.inject(0) { |a, e| a + e.dst_size }
+      end
+
+      # @return [EacGit::Local::Commit, nil]
+      def parent
+        ps = parents
+        raise "#{self} has more than one parent" if ps.count > 2
+
+        ps.empty? ? nil : ps.first
+      end
+
+      # @return [Array<EacGit::Local::Commit>]
+      def parents
+        format('%P').each_line.map { |line| repo.commitize(line) }
+      end
+
+      def root_child?
+        parents.empty?
+      end
+
+      private
+
+      def diff_tree_execute
+        args = []
+        args << '--root' if root_child?
+        args << id
+        repo.command(*::EacGit::Local::Commit::DiffTreeLine::GIT_COMMAND_ARGS, *args).execute!
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local/dirty_files.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'ostruct'
+
+module EacGit
+  class Local
+    module DirtyFiles
+      STATUS_LINE_PATTERN = /\A(.)(.)\s(.+)\z/.freeze
+
+      def dirty?
+        dirty_files.any?
+      end
+
+      def dirty_file?(path)
+        absolute_path = path.to_pathname.expand_path(root_path)
+        dirty_files.any? do |df|
+          df.absolute_path == absolute_path
+        end
+      end
+
+      def dirty_files
+        command('status', '--porcelain=v1', '--untracked-files', '--no-renames')
+          .execute!.each_line.map { |line| parse_status_line(line.gsub(/\n\z/, '')) }
+      end
+
+      private
+
+      def parse_status_line(line)
+        STATUS_LINE_PATTERN.if_match(line) do |m|
+          ::OpenStruct.new(index: m[1], worktree: m[2], path: m[3].to_pathname,
+                           absolute_path: m[3].to_pathname.expand_path(root_path))
+        end
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local/log.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'eac_git/remote'
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  class Local
+    module Log
+      def log(until_commit = nil, from_commit = nil)
+        until_commit, from_commit = [until_commit, from_commit].map { |c| commitize(c) }
+        from_commit ||= head
+        command('log', '--format=%H', "#{until_commit.id}..#{from_commit.id}")
+          .execute!.each_line.map { |line| commitize(line.strip) }
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local/remote.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_git/remote'
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  class Local
+    class Remote
+      NO_SUCH_REMOTE_CODE = 128
+
+      enable_simple_cache
+
+      common_constructor :local, :name
+
+      def exist?
+        url
+      end
+
+      # @return [String, nil]
+      def url
+        local.command('remote', 'get-url', name)
+          .execute!(exit_outputs: { NO_SUCH_REMOTE_CODE => nil })
+          .if_present(nil, &:strip)
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local/remotes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_git/local/remote'
+
+module EacGit
+  class Local
+    module Remotes
+      def remote(name)
+        ::EacGit::Local::Remote.new(self, name)
+      end
+
+      def remotes
+        command('remote').execute!.each_line.map(&:strip).reject(&:blank?).map do |name|
+          remote(name)
+        end
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local/subrepo/config.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'parseconfig'
+
+module EacGit
+  class Local
+    class Subrepo
+      class Config
+        MAPPING = {
+          command_version: :cmdver, commit_id: :commit, join_method: :method,
+          parent_commit_id: :parent, remote_branch: :branch, remote_uri: :remote
+        }.freeze
+
+        class << self
+          def from_file(file_path)
+            new(
+              ::ParseConfig.new(file_path.to_pathname)['subrepo']
+            )
+          end
+        end
+
+        common_constructor :values do
+          self.values = values.with_indifferent_access
+        end
+
+        MAPPING.each do |method_name, _config_key|
+          define_method(method_name) do
+            values[MAPPING.fetch(method_name)]
+          end
+
+          define_method("#{method_name}=") do |value|
+            values[MAPPING.fetch(method_name)] = value
+          end
+        end
+
+        def to_content
+          "[subrepo]\n" + MAPPING.map { |k, v| "  #{v} = #{send(k)}\n" }.join
+        end
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local/subrepo.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'eac_git/remote'
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  class Local
+    # A git-subrepo (https://github.com/ingydotnet/git-subrepo) in a [EacGit::Local].
+    class Subrepo
+      require_sub __FILE__
+      enable_simple_cache
+
+      common_constructor :local, :subpath do
+        self.subpath = subpath.to_pathname
+        local.raise_error "Config file \"#{config_absolute_path}\" not found" unless
+          config_absolute_path.file?
+      end
+
+      def command(subrepo_subcommand, *subrepo_subcommand_args)
+        local.command('subrepo', subrepo_subcommand, subpath.to_path,
+                      *subrepo_subcommand_args)
+      end
+
+      delegate(*::EacGit::Local::Subrepo::Config::MAPPING.keys, to: :config)
+
+      def write_config
+        config_absolute_path.write(config.to_content)
+      end
+
+      private
+
+      def config_uncached
+        ::EacGit::Local::Subrepo::Config.from_file(config_absolute_path)
+      end
+
+      def config_absolute_path_uncached
+        config_relative_path.expand_path(local.root_path)
+      end
+
+      def config_relative_path_uncached
+        subpath.join('.gitrepo')
+      end
+
+      def remote_uncached
+        ::EacGit::Remote.new(remote_uri)
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/local.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'eac_git/executables'
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  # A Git repository in local filesystem.
+  class Local
+    require_sub __FILE__, include_modules: true
+    include ::Comparable
+
+    HEAD_REFERENCE = 'HEAD'
+
+    class << self
+      def find(path)
+        path = path.to_pathname.expand_path
+        if path.join('.git').exist?
+          new(path)
+        elsif path.to_path != '/'
+          find(path.parent)
+        end
+      end
+    end
+
+    common_constructor :root_path do
+      self.root_path = root_path.to_pathname
+    end
+
+    def <=>(other)
+      root_path <=> other.root_path
+    end
+
+    # Retrieves a local branch.
+    #
+    # @param name [String] Ex.: for "refs/heads/master", name should be "master".
+    # @return [EacGit::Local::Branch]
+    def branch(name)
+      ::EacGit::Local::Branch.new(self, name)
+    end
+
+    def commit(ref, required = false)
+      rev_parse(ref, required).if_present { |v| ::EacGit::Local::Commit.new(self, v) }
+    end
+
+    def commitize(source)
+      if source.is_a?(::EacGit::Local::Commit)
+        return source if source.repo == self
+
+        source = source.id
+      end
+
+      source.to_s.strip.if_present(nil) { |v| ::EacGit::Local::Commit.new(self, v) }
+    end
+
+    # Retrieves the current local branch.
+    #
+    # @return [EacGit::Local::Branch, nil]
+    def current_branch
+      command('symbolic-ref', '--quiet', HEAD_REFERENCE)
+        .execute!(exit_outputs: { 256 => '' })
+        .gsub(%r{\Arefs/heads/}, '').strip
+        .if_present { |v| branch(v) }
+    end
+
+    def descendant?(descendant, ancestor)
+      base = merge_base(descendant, ancestor)
+      return false if base.blank?
+
+      revparse = command('rev-parse', '--verify', ancestor).execute!.strip
+      base == revparse
+    end
+
+    # @return [EacGit::Local::Commit
+    def head(required = true)
+      commit(HEAD_REFERENCE, required)
+    end
+
+    def merge_base(*commits)
+      refs = commits.dup
+      while refs.count > 1
+        refs[1] = merge_base_pair(refs[0], refs[1])
+        return nil if refs[1].blank?
+
+        refs.shift
+      end
+      refs.first
+    end
+
+    def command(*args)
+      ::EacGit::Executables.git.command('-C', root_path.to_path, *args)
+    end
+
+    def raise_error(message)
+      raise "#{root_path}: #{message}"
+    end
+
+    def rev_parse(ref, required = false)
+      r = command('rev-parse', ref).execute!(exit_outputs: { 128 => nil, 32_768 => nil })
+      r.strip! if r.is_a?(String)
+      return r if r.present?
+      return nil unless required
+
+      raise_error "Reference \"#{ref}\" not found"
+    end
+
+    def subrepo(subpath)
+      ::EacGit::Local::Subrepo.new(self, subpath)
+    end
+
+    # @return [Array<EacGit::Local::Subrepo>]
+    def subrepos
+      command('subrepo', '-q', 'status').execute!.split("\n").map(&:strip).select(&:present?)
+        .map { |subpath| subrepo(subpath) }
+    end
+
+    def to_s
+      "#{self.class}[#{root_path}]"
+    end
+
+    private
+
+    def merge_base_pair(commit1, commit2)
+      command('merge-base', commit1, commit2).execute!(exit_outputs: { 256 => nil })
+        .if_present(nil, &:strip)
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/remote/ls_result.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  class Remote
+    class LsResult
+      class << self
+        def by_ls_remote_command_output(output)
+          new(
+            output.each_line.map { |line| line.strip.split(/\s+/) }.map { |x| [x[1], x[0]] }.to_h
+          )
+        end
+      end
+
+      common_constructor :hashes
+      delegate :fetch, :'[]', :count, :any?, :empty?, to: :hashes
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/remote.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'eac_git/executables'
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  # A Git remote repository referenced by URI.
+  class Remote
+    require_sub __FILE__
+
+    common_constructor :uri
+
+    def ls
+      ::EacGit::Remote::LsResult.by_ls_remote_command_output(
+        ::EacGit::Executables.git.command('ls-remote', uri).execute!
+      )
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_git/executables'
+require 'eac_git/rspec/stubbed_git_local_repo'
+
+module EacGit
+  module Rspec
+    module Setup
+      def self.extended(setup_obj)
+        setup_obj.setup_conditional_git
+        setup_obj.setup_stubbed_git_local_repo
+      end
+
+      def setup_conditional_git
+        conditional(:git) { ::EacGit::Executables.git.validate }
+      end
+
+      def setup_stubbed_git_local_repo
+        rspec_config.include ::EacGit::Rspec::StubbedGitLocalRepo
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/rspec/stubbed_git_local_repo.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'eac_git/local'
+require 'eac_ruby_utils/envs'
+require 'fileutils'
+require 'securerandom'
+require 'tmpdir'
+
+module EacGit
+  module Rspec
+    module StubbedGitLocalRepo
+      def stubbed_git_local_repo(bare = false)
+        path = ::Dir.mktmpdir
+        ::EacRubyUtils::Envs.local.command(stubbed_git_local_repo_args(path, bare)).execute!
+        repo = StubbedGitRepository.new(path)
+        repo.command('config', 'user.email', 'theuser@example.net').execute!
+        repo.command('config', 'user.name', 'The User').execute!
+        repo
+      end
+
+      private
+
+      def stubbed_git_local_repo_args(path, bare)
+        r = %w[git init]
+        r << '--bare' if bare
+        r + [path]
+      end
+
+      class StubbedGitRepository < ::EacGit::Local
+        def file(*subpath)
+          StubbedGitRepositoryFile.new(self, subpath)
+        end
+
+        # @return [EacGit::Local::Commit
+        def random_commit
+          content = ::SecureRandom.hex
+          file = "#{content}.txt"
+          file(file).write(content)
+          command('add', file).execute!
+          command('commit', '-m', "Random commit: #{file}.").execute!
+          head
+        end
+      end
+
+      class StubbedGitRepositoryFile
+        attr_reader :git, :subpath
+
+        def initialize(git, subpath)
+          @git = git
+          @subpath = subpath
+        end
+
+        def path
+          git.root_path.join(*subpath)
+        end
+
+        def touch
+          ::FileUtils.touch(path.to_path)
+        end
+
+        def delete
+          path.unlink
+        end
+
+        def write(content)
+          path.write(content)
+        end
+      end
+    end
+  end
+end

data/sub/eac_git/lib/eac_git/rspec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  module Rspec
+    require_sub __FILE__
+  end
+end

data/sub/eac_git/lib/eac_git/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EacGit
+  VERSION = '0.12.3'
+end

data/sub/eac_git/lib/eac_git.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacGit
+  require_sub __FILE__
+end

data/sub/eac_git/spec/lib/eac_git/executables_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_git/executables'
+
+RSpec.describe(::EacGit::Executables, git: true) do
+  it 'output version' do
+    expect(described_class.git.command('--version').execute!).to be_present
+  end
+
+  it 'subrepo output version' do
+    expect(described_class.git.command('subrepo', '--version').execute!).to be_present
+  end
+end

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_git/local/commit/diff_tree_line'
+
+RSpec.describe ::EacGit::Local::Commit::DiffTreeLine, git: true do
+  include_examples 'source_target_fixtures', __FILE__ do
+    def source_data(source_file)
+      ::File.read(source_file).each_line.map do |line|
+        described_class.new(line).fields
+      end
+    end
+  end
+end

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/add.source.out

@@ -0,0 +1 @@
+:000000 100644 0000000000000000000000000000000000000000 f380aec0bd8dd777edac43b11636e46cad04273a A	nomes.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/add.target.yaml

@@ -0,0 +1,7 @@
+---
+- src_mode: '000000'
+  dst_mode: '100644'
+  src_sha1: '0000000000000000000000000000000000000000'
+  dst_sha1: f380aec0bd8dd777edac43b11636e46cad04273a
+  status: A
+  path: nomes.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/modify.source.out

@@ -0,0 +1 @@
+:100644 100644 40bcdecb4214cd8a3fcf96cd25a2beb87e7e7cd8 4a30dfae816b984f05cfb594e0d5958bb8c387ae M	nomes.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/modify.target.yaml

@@ -0,0 +1,7 @@
+---
+- src_mode: '100644'
+  dst_mode: '100644'
+  src_sha1: 40bcdecb4214cd8a3fcf96cd25a2beb87e7e7cd8
+  dst_sha1: 4a30dfae816b984f05cfb594e0d5958bb8c387ae
+  status: M
+  path: nomes.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/remove.source.out

@@ -0,0 +1 @@
+:100644 000000 10728718a2915256ab162f1e05178ebff9efa6ce 0000000000000000000000000000000000000000 D	nomes3.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/remove.target.yaml

@@ -0,0 +1,7 @@
+---
+- src_mode: '100644'
+  dst_mode: '000000'
+  src_sha1: 10728718a2915256ab162f1e05178ebff9efa6ce
+  dst_sha1: '0000000000000000000000000000000000000000'
+  status: D
+  path: nomes3.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/rename.source.out

@@ -0,0 +1,2 @@
+:100644 000000 4a30dfae816b984f05cfb594e0d5958bb8c387ae 0000000000000000000000000000000000000000 D	nomes.txt
+:000000 100644 0000000000000000000000000000000000000000 4a30dfae816b984f05cfb594e0d5958bb8c387ae A	nomes2.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/rename.target.yaml

@@ -0,0 +1,13 @@
+---
+- src_mode: '100644'
+  dst_mode: '000000'
+  src_sha1: 4a30dfae816b984f05cfb594e0d5958bb8c387ae
+  dst_sha1: '0000000000000000000000000000000000000000'
+  status: D
+  path: nomes.txt
+- src_mode: '000000'
+  dst_mode: '100644'
+  src_sha1: '0000000000000000000000000000000000000000'
+  dst_sha1: 4a30dfae816b984f05cfb594e0d5958bb8c387ae
+  status: A
+  path: nomes2.txt

data/sub/eac_git/spec/lib/eac_git/local/commit/diff_tree_line_spec_files/rename_modify.source.out

@@ -0,0 +1,2 @@
+:100644 000000 4a30dfae816b984f05cfb594e0d5958bb8c387ae 0000000000000000000000000000000000000000 D	nomes2.txt
+:000000 100644 0000000000000000000000000000000000000000 10728718a2915256ab162f1e05178ebff9efa6ce A	nomes3.txt