ruby_git 0.2.0 → 0.3.1

data/lib/ruby_git/status/renamed_entry.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+require_relative 'entry'
+
+module RubyGit
+  module Status
+    # Represents a renamed file in git status
+    #
+    # @api public
+    class RenamedEntry < Entry
+      # @attribute [r] index_status
+      #
+      # The status in the staging area
+      #
+      # @example
+      #   entry.index_status #=> :renamed
+      #
+      # @return [Symbol] staging status
+      #
+      # @api public
+      attr_reader :index_status
+
+      # @attribute [r] worktree_status
+      #
+      # The status in the worktree
+      #
+      # @example
+      #   entry.worktree_status #=> :modified
+      #
+      # @return [Symbol] worktree status
+      #
+      # @api public
+      attr_reader :worktree_status
+
+      # @attribute [r] head_mode
+      #
+      # The mode of the file in HEAD
+      #
+      # @example
+      #   entry.head_mode #=> 0o100644
+      #
+      # @return [Integer] mode of the file in HEAD
+      #
+      # @api public
+      attr_reader :head_mode
+
+      # @attribute [r] index_mode
+      #
+      # The mode of the file in the index
+      #
+      # @example
+      #   entry.index_mode #=> 0o100644
+      #
+      # @return [Integer] mode of the file in the index
+      #
+      # @api public
+      attr_reader :index_mode
+
+      # @attribute [r] worktree_mode
+      #
+      # The mode of the file in the worktree
+      #
+      # @example
+      #   entry.worktree_mode #=> 0o100644
+      #
+      # @return [Integer] mode of the file in the worktree
+      #
+      # @api public
+      attr_reader :worktree_mode
+
+      # @attribute [r] head_sha
+      #
+      # The SHA of this object in HEAD
+      #
+      # @example
+      #   entry.head_sha #=> 'd670460b4b4aece5915caf5c68d12f560a9fe3e4'
+      #
+      # @return [String] SHA of this object in HEAD
+      #
+      # @api public
+      attr_reader :head_sha
+
+      # @attribute [r] index_sha
+      #
+      # The SHA of this object in the index
+      #
+      # @example
+      #   entry.index_sha #=> 'd670460b4b4aece5915caf5c68d12f560a9fe3e4'
+      #
+      # @return [String] SHA of this object in the index
+      #
+      # @api public
+      attr_reader :index_sha
+
+      # @attribute [r] operation
+      #
+      # The operation that was performed on the file: 'R' for  or 'C' for copy)
+      #
+      # @example
+      #   entry.operation #=> 'R'
+      #
+      # @return [String] operation
+      #
+      # @api public
+      attr_reader :operation
+
+      # @attribute [r] similarity
+      #
+      # The similarity index between the original and renamed file
+      #
+      # @example
+      #   entry.similarity #=> 95
+      #
+      # @return [Integer] similarity percentage
+      #
+      # @api public
+      attr_reader :similarity_score
+
+      # @attribute [r] path
+      #
+      # The path after the rename
+      #
+      # @example
+      #   entry.path #=> 'lib/new_name.rb'
+      #
+      # @return [String]
+      #
+      # @api public
+      attr_reader :path
+
+      # @attribute [r] original_path
+      #
+      # The original path before rename
+      #
+      # @example
+      #   entry.original_path #=> 'lib/old_name.rb'
+      #
+      # @return [String] original file path
+      #
+      # @api public
+      attr_reader :original_path
+
+      # Parse a git status line to create a renamed entry
+      #
+      # The line is expected to be in porcelain v2 format with NUL terminators.
+      #
+      # The format is as follows:
+      #   2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
+      #
+      # @example
+      #   line = '2 RM N... 100644 100644 100644 d670460b4b4aece5915caf5c68d12f560a9fe3e4 ' \
+      #     \d670460b4b4aece5915caf5c68d12f560a9fe3e4 50 lib/new_name.rb\0lib/old_name.rb'
+      #   RenamedEntry.parse(line) #=> #<RubyGit::Status::RenamedEntry:0x00000001046bd488 ...>
+      #
+      # @param line [String] line from git status
+      #
+      # @return [RubyGit::Status::RenamedEntry] parsed entry
+      #
+      def self.parse(line) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        tokens = line.split(' ', 10)
+        path, original_path = tokens[9].split("\0")
+
+        new(
+          index_status: Entry.status_to_symbol(tokens[1][0]),
+          worktree_status: Entry.status_to_symbol(tokens[1][1]),
+          submodule_status: SubmoduleStatus.parse(tokens[2]),
+          head_mode: Integer(tokens[3], 8),
+          index_mode: Integer(tokens[4], 8),
+          worktree_mode: Integer(tokens[5], 8),
+          head_sha: tokens[6],
+          index_sha: tokens[7],
+          operation: Entry.rename_operation_to_symbol(tokens[8][0]),
+          similarity_score: tokens[8][1..].to_i,
+          path: path,
+          original_path: original_path
+        )
+      end
+
+      # Initialize a new renamed entry
+      #
+      # @example
+      #   RenamedEntry.new(
+      #     index_status: :renamed,
+      #     worktree_status: :modified,
+      #     submodule_status: nil,
+      #     head_mode: 0o100644,
+      #     index_mode: 0o100644,
+      #     worktree_mode: 0o100644,
+      #     head_sha: 'd670460b4b4aece5915caf5c68d12f560a9fe3e4',
+      #     index_sha: 'd670460b4b4aece5915caf5c68d12f560a9fe3e4',
+      #     operation: :rename,
+      #     similarity_score: 50,
+      #     path: 'lib/new_name.rb',
+      #     original_path: 'lib/old_name.rb'
+      #   )
+      #
+      # @param index_status [Symbol] status in staging area
+      # @param worktree_status [Symbol] status in worktree
+      # @param submodule_status [SubmoduleStatus, nil] submodule status or nil
+      # @param head_mode [Integer] mode of the file in HEAD
+      # @param index_mode [Integer] mode of the file in the index
+      # @param worktree_mode [Integer] mode of the file in the worktree
+      # @param head_sha [String] SHA of this object in HEAD
+      # @param index_sha [String] SHA of this object in the index
+      # @param operation [Symbol] operation that was performed on the file
+      # @param similarity_score [Integer] similarity index between the original and renamed file
+      # @param path [String] new file path
+      # @param original_path [String] original file path
+      #
+      def initialize( # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+        index_status:, worktree_status:,
+        submodule_status:,
+        head_mode:, index_mode:, worktree_mode:,
+        head_sha:, index_sha:,
+        operation:, similarity_score:,
+        path:, original_path:
+      )
+        super(path)
+
+        @index_status = index_status
+        @worktree_status = worktree_status
+        @submodule_status = submodule_status
+        @head_mode = head_mode
+        @index_mode = index_mode
+        @worktree_mode = worktree_mode
+        @head_sha = head_sha
+        @index_sha = index_sha
+        @operation = operation
+        @similarity = similarity_score
+        @original_path = original_path
+      end
+
+      # Does the entry have unstaged changes in the worktree?
+      #
+      # * An entry can have both staged and unstaged changes
+      # * All untracked entries are considered unstaged
+      #
+      # @example
+      #   entry.ignored? #=> false
+      # @return [Boolean]
+      def unstaged?
+        worktree_status != :unmodified
+      end
+
+      # Does the entry have staged changes in the index?
+      #
+      # * An entry can have both staged and unstaged changes
+      #
+      # @example
+      #   entry.ignored? #=> false
+      # @return [Boolean]
+      def staged?
+        index_status != :unmodified
+      end
+    end
+  end
+end

data/lib/ruby_git/status/report.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module RubyGit
+  module Status
+    # Represents a full git status report
+    #
+    # @api public
+    class Report
+      # @attribute [r] branch
+      #
+      # Information about the current git branch
+      #
+      # @example
+      #   report.branch #=> #<RubyGit::Status::BranchInfo:0x00000001046bd488 ...>
+      #
+      # @return [RubyGit::Status::BranchInfo, nil] branch information or nil if not in a git repository
+      #
+      # @api public
+      attr_reader :branch
+
+      # @attribute [r] stash
+      #
+      # Information about git stash if available
+      #
+      # @example
+      #   report.stash #=> #<RubyGit::Status::Stash:0x00000001046bd488 ...>
+      #
+      # @return [RubyGit::Status::Stash, nil] stash information or nil if no stash
+      #
+      # @api public
+      attr_reader :stash
+
+      # @attribute [r] entries
+      #
+      # All entries in the git status
+      #
+      # @example
+      #   report.entries #=> [#<RubyGit::Status::Ordinary:0x00000001046bd488 ...>, ...]
+      #
+      # @return [Array<RubyGit::Status::Entry>] array of status entries
+      #
+      # @api public
+      attr_reader :entries
+
+      # Initialize a new status report
+      #
+      # @example
+      #   Report.new(
+      #     branch = Branch.new,
+      #     stash = Stash.new,
+      #     entries = [Ordinary.new, Renamed.new]
+      #   )
+      #
+      # @param branch [RubyGit::Status::BranchInfo, nil] branch information
+      # @param stash [RubyGit::Status::StashInfo, nil] stash information
+      # @param entries [Array<RubyGit::Status::Entry>] status entries
+      #
+      def initialize(branch, stash, entries)
+        @branch = branch
+        @stash = stash
+        @entries = entries
+      end
+
+      # The entries that are ignored
+      #
+      # @example
+      #   report.ignored #=> [#<RubyGit::Status::IgnoredEntry ...>, ...]
+      #
+      # @return [Array<IgnoredEntry>]
+      #
+      def ignored
+        entries.select(&:ignored?)
+      end
+
+      # The entries that are untracked
+      #
+      # @example
+      #   report.untracked #=> [#<RubyGit::Status::UntrackedEntry ...>, ...]
+      #
+      # @return [Array<UntrackedEntry>]
+      #
+      def untracked
+        entries.select(&:untracked?)
+      end
+
+      # The entries that have unstaged changes
+      #
+      # @example
+      #   report.unstaged #=> [#<RubyGit::Status::OrdinaryEntry ...>, ...]
+      #
+      # @return [Array<UntrackedEntry, OrdinaryEntry, RenamedEntry>]
+      #
+      def unstaged
+        entries.select(&:unstaged?)
+      end
+
+      # The entries that have staged changes
+      #
+      # @example
+      #   report.staged #=> [#<RubyGit::Status::OrdinaryEntry ...>, ...]
+      #
+      # @return [Array<UntrackedEntry, OrdinaryEntry, RenamedEntry>]
+      #
+      def staged
+        entries.select(&:staged?)
+      end
+
+      # The entries that have staged changes and no unstaged changes
+      #
+      # @example
+      #   report.fully_staged #=> [#<RubyGit::Status::OrdinaryEntry ...>, ...]
+      #
+      # @return [Array<UntrackedEntry, OrdinaryEntry, RenamedEntry>]
+      #
+      def fully_staged
+        entries.select(&:fully_staged?)
+      end
+
+      # The entries that represent merge conflicts
+      #
+      # @example
+      #   report.unmerged #=> [#<RubyGit::Status::UnmergedEntry ...>, ...]
+      #   report.merge_conflicts? #=> true
+      #
+      # @return [Array<UnmergedEntry>]
+      #
+      def unmerged
+        entries.select(&:unmerged?)
+      end
+
+      # Are there any unmerged entries?
+      #
+      # @example
+      #   report.merge_conflicts? #=> true
+      #
+      # @return [Boolean]
+      #
+      def merge_conflict?
+        unmerged.any?
+      end
+    end
+  end
+end

data/lib/ruby_git/status/stash.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RubyGit
+  module Status
+    # Represents git stash information
+    #
+    # @api public
+    class Stash
+      # @attribute [rw] count
+      #
+      # The number of stashed changes
+      #
+      # @example
+      #   stash.count #=> 3
+      #
+      # @return [Integer] stash count
+      #
+      # @api public
+      attr_accessor :count
+
+      # Initialize a new stash info object
+      #
+      # @example
+      #   Stash.new(3)
+      #
+      # @param count [Integer] number of stashed changes
+      #
+      def initialize(count)
+        @count = count
+      end
+    end
+  end
+end

data/lib/ruby_git/status/submodule_status.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative 'entry'
+
+module RubyGit
+  module Status
+    # Represents an ordinary changed file in git status
+    #
+    # @api public
+    class SubmoduleStatus
+      # Parse the submodule status string
+      #
+      # @example Parse submodule status
+      #   SubmoduleStatus.parse('SC..')
+      #     #=> #<SubmoduleStatus @commit_changed=true, @tracked_changes=false, @untracked_changes=false>
+      #
+      # @example If not a submodule
+      #  SubmoduleStatus.parse('N..') #=> nil
+      #
+      # @param submodule_status [String] the submodule status string
+      #
+      # @return [SubmoduleStatus, nil] the parsed submodule status or nil
+      #  if the status is not a submodule
+      #
+      def self.parse(submodule_status)
+        return nil unless submodule_status[0] == 'S'
+
+        new(
+          commit_changed: (submodule_status[1] == 'C'),
+          tracked_changes: (submodule_status[2] == 'M'),
+          untracked_changes: (submodule_status[3] == 'U')
+        )
+      end
+
+      # Initialize a new submodule status
+      #
+      # @example
+      #   SubmoduleStatus.new(true, false, false)
+      #
+      # @param commit_changed [Boolean] the submodule commit changed
+      # @param tracked_changes [Boolean] the tracked files in the submodule changed
+      # @param untracked_changes [Boolean] the untracked files in the submodule changed
+      #
+      def initialize(commit_changed:, tracked_changes:, untracked_changes:)
+        @commit_changed = commit_changed
+        @tracked_changes = tracked_changes
+        @untracked_changes = untracked_changes
+      end
+
+      # @attribute [r] commit_changed?
+      #
+      # The submodule commit changed
+      #
+      # @example
+      #   submodule_status.commit_changed? #=> true
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def commit_changed? = @commit_changed
+
+      # @attribute [r] tracked_changes?
+      #
+      # The one or more tracked files in the submodule changed
+      #
+      # @example
+      #   submodule_status.tracked_changes? #=> true
+      #
+      # @return [Boolean]
+      #
+      def tracked_changes? = @tracked_changes
+
+      # @attribute [r] untracked_changes?
+      #
+      # The one or more untracked files in the submodule changed
+      #
+      # @example
+      #   submodule_status.untracked_changes? #=> true
+      #
+      # @return [Boolean]
+      #
+      def untracked_changes? = @untracked_changes
+    end
+  end
+end