github_diff_parser 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26631fa3bed73629263398b5a5956aeb3f680ecdc3d990a86ff3c68cbb4e93fc
-  data.tar.gz: 1268de53cf2e150fb1667955c0b4b5b24e045c9b413c81441310f98f4c564046
+  metadata.gz: 1d048ece303a1deffcfd8c90f1f9ff01ae8ecd3e4cd933227b4e6fe37b895e82
+  data.tar.gz: 81f8202228089acd92296c2504ec8689598a59ff01fdac8df3c089e9d1bb7658
 SHA512:
-  metadata.gz: b12c80f92786394271ec785c6b22db9111d20c17c3ee859b23cae2f54a9ef757b01d1cac2666df3b512eeae88524e37646efe98ba51ddcf94c3188d87bc7d42c
-  data.tar.gz: 53d34cc940811a050a26f214ab18db26acd638adaf26c717a740977cf01394682f0c3b165843449c09587b75dc54cf8e1dcc1d9419b1bda3794b751ddedd6fc2
+  metadata.gz: b9edb9abb99bf74763577a06801429e2accb3af1b806a434d83f1ea518a694411fd528c080e5fefeed9ab603ac405861d631e416cbc5236f77b6f6e4ac52fb36
+  data.tar.gz: ca25e44f9e0cc56fdc3044ea85b09e4f59e9a2cca5f172f44b50d5570dda436228b1b1c8b905b890a7bdcc7d1097e1c1876d75927291bfe34d3f4619cd7b35b7

data/.rubocop.yml

@@ -4,6 +4,8 @@ inherit_gem:
 AllCops:
   NewCops: disable
   SuggestExtensions: false
+  Exclude:
+    - "test/data/**/*"
 
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## [1.1.0] - 2024-2-21
+### Added
+- Github Diff Parser parses the permissions bits and you now have have access to various method
+  such as:
+  - `GithubDiffParser::Diff#normal_file?` when the bits are 100644
+  - `GithubDiffParser::Diff#executable?` when the bits are 107555
+  - `GithubDiffParser::Diff#symlink?` when the bits are 120000
+- Introduce `GithubDiffParser::Diff#symlink_source`. When the diff applies to a symbolic link, `symlink_source` will
+  return the path to where the symbolic link points to.
+- Introduce `GithubDiffParser::Diff#apply`, a simple implementation of `git apply`.
+- Introduce `GithubDiffParser::Diff#revert`, a simple implementation of `git apply -R`.
+
+### Fixed
+- `GithubDiffParser::Line#content` didn't include `\n` (if the line had one).

data/Gemfile.lock

@@ -1,39 +1,46 @@
 PATH
   remote: .
   specs:
-    github_diff_parser (0.1.0)
+    github_diff_parser (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     byebug (11.1.3)
-    minitest (5.15.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.3.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
-    rubocop (1.27.0)
+    rubocop (1.53.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    rubocop-shopify (2.5.0)
-      rubocop (~> 1.25)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -44,4 +51,4 @@ DEPENDENCIES
   rubocop-shopify
 
 BUNDLED WITH
-   2.2.32
+   2.4.14

data/lib/github_diff_parser/diff.rb

@@ -2,6 +2,8 @@
 
 module GithubDiffParser
   class Diff
+    Mode = Struct.new(:operation, :bits)
+
     # @return [String] (see #initialize)
     attr_reader :previous_filename
 
@@ -11,8 +13,19 @@ module GithubDiffParser
     # @return [Array<GithubDiffParser::Hunk>] the hunks belonging to this diff
     attr_reader :hunks
 
+    # @return [String] the hash of the previous file. This is indicate in the diff
+    #   by the line `index abc..def`. The +abc+ part is the previous_index.
+    attr_reader :previous_index
+
+    # @return [String] the hash of the new file. This is indicate in the diff
+    #   by the line `index abc..def`. The +def+ part is the previous_index.
+    attr_reader :new_index
+
     # @private
-    attr_writer :file_mode
+    attr_writer :previous_index, :new_index
+
+    # @private
+    attr_accessor :mode
 
     # @param previous_filename [String] the original filename. Represented by "diff --git /a filename"
     # @param new_filename [String]      the new filename. Represented by "diff --git /b filename"
@@ -22,6 +35,11 @@ module GithubDiffParser
       @hunks = []
     end
 
+    # Get all the lines in this diff. Shortcut for `diff.hunks.each { |h| h.lines }`
+    def lines
+      hunks.flat_map(&:lines)
+    end
+
     # Add a Git Hunk to the diff.
     #
     # @param previous_lino_start [String] the starting line number of the hunk for the original file
@@ -60,7 +78,7 @@ module GithubDiffParser
     #
     # @return [Boolean]
     def deleted_mode?
-      @file_mode == "deleted"
+      @mode.operation == "deleted"
     end
 
     # Check if this Diff is set to new mode.
@@ -76,7 +94,7 @@ module GithubDiffParser
     #
     # @return [Boolean]
     def new_mode?
-      @file_mode == "new"
+      @mode.operation == "new"
     end
 
     # Check if this Diff is set to rename mode.
@@ -92,6 +110,29 @@ module GithubDiffParser
       previous_filename != new_filename
     end
 
+    # @return [Boolean] True if this diff applies to a regular file.
+    def normal_file?
+      @mode.bits == "100644"
+    end
+
+    # @return [Boolean] True if this diff applies to an executable.
+    def executable?
+      @mode.bits == "100755"
+    end
+
+    # @return [Boolean] True if this diff applies to a symlink.
+    def symlink?
+      @mode.bits == "120000"
+    end
+
+    # @return [String] The source of the symlink
+    # @raise If this diff doesn't apply to a symlink
+    def symlink_source
+      raise(Error, "This diff doen't apply to a symbolic link") unless symlink?
+
+      lines.first.content
+    end
+
     # A utility method that returns the current number of a line who might not be present in the diff.
     # This is useful if you need to keep track of the updated line numbers in a file for every changes.
     #
@@ -111,6 +152,48 @@ module GithubDiffParser
       end
     end
 
+    # A naive implementation of `$ git apply`.
+    #
+    # @param previous_content [String] The previous content related to this diff.
+    # @return [String] The content after applying this diff to the `previous_content`.
+    def apply(previous_content)
+      lines = previous_content.lines
+      offset = 0
+
+      self.lines.each do |line|
+        if line.addition?
+          lines.insert(line.current_number - 1, line.content)
+          offset += 1
+        elsif line.deletion?
+          lines.delete_at(line.previous_number - 1 + offset)
+          offset -= 1
+        end
+      end
+
+      lines.join
+    end
+
+    # A naive implementation of `$ git apply -R`.
+    #
+    # @param current_content [String] The current content related to this diff.
+    # @return [String] The content after reverting this diff to the `current_content`.
+    def revert(current_content)
+      lines = current_content.lines
+      offset = 0
+
+      self.lines.each do |line|
+        if line.addition?
+          lines.delete_at(line.current_number - 1 + offset)
+          offset -= 1
+        elsif line.deletion?
+          lines.insert(line.previous_number - 1, line.content)
+          offset += 1
+        end
+      end
+
+      lines.join
+    end
+
     private
 
     # Check if a line was shifted. A line is considered shifted if its number is superior to the first hunk's start

data/lib/github_diff_parser/parser.rb

@@ -18,6 +18,8 @@ module GithubDiffParser
         case line
         when Regexes::DIFF_HEADER
           process_new_diff(Regexp.last_match)
+        when Regexes::INDEX_HEADER
+          process_index(Regexp.last_match)
         when Regexes::MODE_HEADER
           process_diff_file_mode(Regexp.last_match)
         when Regexes::ORIGINAL_FILE_HEADER, Regexes::NEW_FILE_HEADER
@@ -26,6 +28,8 @@ module GithubDiffParser
           add_hunk_to_diff(Regexp.last_match)
         when Regexes::LINE_DIFF
           add_line_to_hunk(Regexp.last_match)
+        when Regexes::NO_NEWLINE_AT_EOF
+          @current_diff.lines.last.content.sub!(/\n$/, "")
         end
       end
 
@@ -47,6 +51,17 @@ module GithubDiffParser
       @current_diff = Diff.new(match_data[:previous_filename], match_data[:new_filename])
     end
 
+    # Called when encountering a `index abc..def` in the Git Diff output.
+    #
+    # @param match_data [MatchData]
+    def process_index(match_data)
+      validate_diff
+
+      @current_diff.previous_index = match_data[:previous_index]
+      @current_diff.new_index = match_data[:new_index]
+      @current_diff.mode ||= Diff::Mode.new("modified", match_data[:bits])
+    end
+
     # Called when encountering a `new file mode 100644` or `delete file mode 100644` in the Git Diff output.
     #
     # @param match_data [MatchData]
@@ -55,7 +70,7 @@ module GithubDiffParser
     def process_diff_file_mode(match_data)
       validate_diff
 
-      @current_diff.file_mode = match_data[:file_mode]
+      @current_diff.mode = Diff::Mode.new(match_data[:file_mode], match_data[:bits])
     end
 
     # Called when encountering a `@@ -0,0 +1,10 @@` in the Git Diff output.

data/lib/github_diff_parser/regexes.rb

@@ -19,6 +19,24 @@ module GithubDiffParser
       \Z                                               # End of line
     }x
 
+    # This Regexp is used to match the sha of the previous and the file
+    #
+    # @example
+    #
+    #   diff --git a/app/my_file.rb b/app/my_file.rb
+    #   index d3dfbe4..ac0e8b3 100644                   <-- Match this line -->
+    #   --- a/app/my_file.rb
+    #   +++ b/app/my_file.rb
+    #   @@ -5,6 +5,6 @@ def test1
+    INDEX_HEADER = %r{
+      \A                                               # Start of line
+      index\s                                          # Match 'index '
+      (?<previous_index>[a-z0-9]+)                     # Match and capture alphanumerical chars
+      ..                                               # Match '..' literally
+      (?<new_index>[a-z0-9]+)\s                        # Match and capture alphanumerical chars
+      (?<bits>\d+)?                                    # Optionaly capture the mode bits
+    }x
+
     # This Regexp is used to match the header containing the original filename.
     #
     # @example Possible header on a diff.
@@ -71,7 +89,7 @@ module GithubDiffParser
     MODE_HEADER = %r{
       \A                                               # Start of line
       (?<file_mode>new|deleted)                        # Match 'new' or 'deleted' and capture the group
-      \sfile\smode\s\d+                                # Match ' file mode 100655'
+      \sfile\smode\s(?<bits>\d+)                       # Match ' file mode 100655' and capture the "100655" part
       \Z                                               # End of line
     }x
 
@@ -153,8 +171,10 @@ module GithubDiffParser
         |                                              # OR
         \s                                             # Match empty space ' ' (Considered as a contextual line)
       )                                                # End of named group
-      (?<line>.*)                                      # Match the content of the line itself
+      (?<line>.*\n?)                                   # Match the content of the line itself
       \Z                                               # End of line
     }x
+
+    NO_NEWLINE_AT_EOF = /\/
   end
 end

data/lib/github_diff_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GithubDiffParser
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

data/lib/github_diff_parser.rb

@@ -3,6 +3,7 @@
 require_relative "github_diff_parser/version"
 
 module GithubDiffParser
+  Error = Class.new(StandardError)
   InvalidDiff = Class.new(ArgumentError)
 
   autoload :Parser,  "github_diff_parser/parser"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_diff_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Edouard CHIN
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -61,13 +62,13 @@ files:
 - lib/github_diff_parser/parser.rb
 - lib/github_diff_parser/regexes.rb
 - lib/github_diff_parser/version.rb
-homepage: https://github.com/Edouard-chin/git_diff_parser
+homepage: https://github.com/CatanaCorp/github_diff_parser
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/Edouard-chin/git_diff_parser
-  source_code_uri: https://github.com/Edouard-chin/git_diff_parser
+  homepage_uri: https://github.com/CatanaCorp/github_diff_parser
+  source_code_uri: https://github.com/CatanaCorp/github_diff_parser
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -77,14 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: A Ruby Gem to parse unified git diff output.