github_diff_parser 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d048ece303a1deffcfd8c90f1f9ff01ae8ecd3e4cd933227b4e6fe37b895e82
-  data.tar.gz: 81f8202228089acd92296c2504ec8689598a59ff01fdac8df3c089e9d1bb7658
+  metadata.gz: 59fc3a134cc5315f7d28ff394d4aa87d367ad31265f294c8a34e604802eca1de
+  data.tar.gz: 8f547b86fb5495a0f8a5b4749cfa7aa034077d4056d2d5862228ebe6e75559f2
 SHA512:
-  metadata.gz: b9edb9abb99bf74763577a06801429e2accb3af1b806a434d83f1ea518a694411fd528c080e5fefeed9ab603ac405861d631e416cbc5236f77b6f6e4ac52fb36
-  data.tar.gz: ca25e44f9e0cc56fdc3044ea85b09e4f59e9a2cca5f172f44b50d5570dda436228b1b1c8b905b890a7bdcc7d1097e1c1876d75927291bfe34d3f4619cd7b35b7
+  metadata.gz: 3927c8a434063bf2f3f159d3e745e7553f8a3add0755b5e13f2607b3a4d4a1c2bc6dd0ebc83dac9db7137e0b197b3a26771790e3e02377e30633b9a0935d39ec
+  data.tar.gz: 38f190c40a078858227c3995028562245c7d2db128482de36b0a376e8fbcc6ecb057564d3bd2752c6f7e498e8c72d4ccfba239e11ccb539600ea26b081cbceaf

data/CHANGELOG.md

@@ -6,6 +6,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [1.2.0] - 2024-9-2
+### Added
+- Added `GithubDiffParser::Hunk#context` which returns the context of the hunk.
+  In this example, it would return "def blabla"
+  ```diff
+  @@ +1,6 -1,18 def blabla
+  ```
+
+- Added `GithubDiffParser::Hunk#previous_line_count` which returns the prevous line count in a hunk.
+  In this example, it would return 6.
+  ```diff
+  @@ +1,6 -1,18 def blabla
+  ```
+
+- Added `GithubDiffParser::Hunk#new_line_count` which returns the prevous line count in a hunk.
+  In this example, it would return 18.
+  ```diff
+  @@ +1,6 -1,18 def blabla
+  ```
+
+### Fixed
+- `GithubDiffParser::Diff#previous_line_number_is_now` could return a wrong value
+  for the line number 1 in a file.
+
+## [1.1.1] - 2024-2-21
+### Fixed
+- `GithubDiffParser::Diff#new_mode?` and ``GithubDiffParser::Diff#deleted_mode?` would raise
+  an error with this kind of diff:
+
+  ```diff
+  diff --git a/blabla.rb b/app/my_file.rb
+  similarity index 100%
+  rename from blabla.rb
+  rename to app/my_file.rb
+  ```
+
 ## [1.1.0] - 2024-2-21
 ### Added
 - Github Diff Parser parses the permissions bits and you now have have access to various method

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_diff_parser (1.1.0)
+    github_diff_parser (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/github_diff_parser/diff.rb

@@ -47,8 +47,8 @@ module GithubDiffParser
     #
     # @example Representation of the previous_lino_start and new_lino_start in a Git Diff
     #   @@ -6,5 +6,6 @@ def test1 # => The first 6 is the previous_lino_start, the second is the new_lino_start
-    def add_hunk(previous_lino_start, new_lino_start)
-      hunks << Hunk.new(previous_lino_start, new_lino_start)
+    def add_hunk(previous_lino_start, new_lino_start, context)
+      hunks << Hunk.new(previous_lino_start, new_lino_start, context)
     end
 
     # Add a line belonging to the previously processed Git Hunk.
@@ -78,7 +78,7 @@ module GithubDiffParser
     #
     # @return [Boolean]
     def deleted_mode?
-      @mode.operation == "deleted"
+      @mode&.operation == "deleted"
     end
 
     # Check if this Diff is set to new mode.
@@ -94,7 +94,7 @@ module GithubDiffParser
     #
     # @return [Boolean]
     def new_mode?
-      @mode.operation == "new"
+      @mode&.operation == "new"
     end
 
     # Check if this Diff is set to rename mode.
@@ -112,17 +112,17 @@ module GithubDiffParser
 
     # @return [Boolean] True if this diff applies to a regular file.
     def normal_file?
-      @mode.bits == "100644"
+      @mode&.bits == "100644"
     end
 
     # @return [Boolean] True if this diff applies to an executable.
     def executable?
-      @mode.bits == "100755"
+      @mode&.bits == "100755"
     end
 
     # @return [Boolean] True if this diff applies to a symlink.
     def symlink?
-      @mode.bits == "120000"
+      @mode&.bits == "120000"
     end
 
     # @return [String] The source of the symlink
@@ -140,7 +140,7 @@ module GithubDiffParser
     #
     # @return [Integer]
     def previous_line_number_is_now(line_number)
-      return line_number unless line_shifted?(line_number)
+      return line_number if line_unchanged?(line_number)
 
       applicable_hunk = last_applicable_hunk_for_line(line_number)
       line = applicable_hunk.find_previous_line(line_number)
@@ -196,16 +196,13 @@ module GithubDiffParser
 
     private
 
-    # Check if a line was shifted. A line is considered shifted if its number is superior to the first hunk's start
-    # range.
-    #
     # @param line_number [Integer]
     #
     # @return [Boolean]
-    def line_shifted?(line_number)
+    def line_unchanged?(line_number)
       first_hunk = hunks.first
 
-      line_number > first_hunk.new_file_start_line
+      line_number < first_hunk.new_file_start_line
     end
 
     # Find the last hunk that shifts the line. We need the last because we know it's the one that will shift the line

data/lib/github_diff_parser/hunk.rb

@@ -11,14 +11,19 @@ module GithubDiffParser
     # @return [Integer] (see #initialize)
     attr_reader :new_file_start_line
 
+    # @return [String] (see #initialize)
+    attr_reader :context
+
     # @param previous_file_start_line [String] the starting line number of the hunk for the original file
     # @param new_file_start_line [String] the starting line number of the hunk for the new file
+    # @param context [String]
     #
     # @example Representation of the previous_file_start_line and new_file_start_line in a Git Diff
     #   @@ -6,5 +6,6 @@ def test1 # => The first 6 is the previous_file_start_line the second is the new_file_start_line
-    def initialize(previous_file_start_line, new_file_start_line)
+    def initialize(previous_file_start_line, new_file_start_line, context)
       @previous_file_start_line = Integer(previous_file_start_line)
       @new_file_start_line = Integer(new_file_start_line)
+      @context = context
       @lines = []
     end
 
@@ -82,5 +87,23 @@ module GithubDiffParser
     def find_current_line(line_number)
       lines.find { |line| line.current_number == line_number }
     end
+
+    # The number of lines in the previous version.
+    #
+    # @example
+    #   "@@ +3,4 -3,8 @@" This would return "4"
+    #   "@@ +3 -3 @@"     This would return "1"
+    def previous_line_count
+      contextual_lines.count + deletion_lines.count
+    end
+
+    # The number of lines in the new version.
+    #
+    # @example
+    #   "@@ +3,4 -3,8 @@" This would return "8"
+    #   "@@ +3 -3 @@"     This would return "1"
+    def new_line_count
+      contextual_lines.count + addition_lines.count
+    end
   end
 end

data/lib/github_diff_parser/parser.rb

@@ -81,7 +81,7 @@ module GithubDiffParser
     def add_hunk_to_diff(match_data)
       validate_diff
 
-      @current_diff.add_hunk(match_data[:previous_lino_start], match_data[:new_lino_start])
+      @current_diff.add_hunk(match_data[:previous_lino_start], match_data[:new_lino_start], match_data[:context])
     end
 
     # Called when encountering a `-text` or `+text` or ` text` in the Git Diff output.

data/lib/github_diff_parser/regexes.rb

@@ -115,7 +115,7 @@ module GithubDiffParser
       @@\s                                             # Match '@@ '
       -(?<previous_lino_start>\d+)(,\d+)?\s            # Match '-1,11 ' or match '-1 ' and capture the '1' part
       \+(?<new_lino_start>\d+)(,\d+)?\s                # Match '+1,34 ' or match '+1 ' and capture the '1' part
-      @@.*                                             # Match '@@ Any text'
+      @@\s?(?<context>.*)                              # Match '@@ Any text' and capture the 'Any text' part
       \Z                                               # End of line
     }x
 

data/lib/github_diff_parser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_diff_parser
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Edouard CHIN
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A Ruby Gem to parse unified git diff output.