git_diff_map 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ed2eb190188362d25d103a92f9795bfc63f6adc
+  data.tar.gz: 308b6cfb4fc8b1f6a4b939c18b4b075cb9faf9a5
+SHA512:
+  metadata.gz: ccde2d761de0939dd6db2e8e3767cb13e79ae5abb061684cecd46039a512065f461b273b4aad5d100827fb5ebe01f2c82caf44917af7ec9441f2b403d569b3d7
+  data.tar.gz: 2865ee95276ca6878cb2d66ffff3c69c38944dd0169779c1c19108348135074f239f60a3af8f05b74bb0c88e70513c8b7e97de325e4e33e9464695cfe0b17152

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Soutaro Matsumoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# GitDiffMap
+
+Line number mapping through `git diff` output.
+
+## What is *mapping*?
+
+If the line is not changed in diff, there should be pair of numbers of:
+
+* A number to identify where the line was located in *original* file
+* A number to identify where the line is located in *new* file
+
+This library is to compute the relation.
+
+This is an example from GitDiffParser.
+
+```
+@@ -2,6 +2,7 @@ module Saddler
+   module Reporter
+     module Github
+       class CommitComment
++        include Support
+         include Helper
+
+         # https://developer.github.com/v3/repos/comments/#create-a-commit-comment
+@@ -11,7 +12,7 @@ def report(messages, options)
+           data = parse(messages)
+
+           # build comment
+-          body = build_body(data)
++          body = concat_body(data)
+           return if body.empty?
+           comment = Comment.new(sha1, body, nil, nil)
+
+@@ -25,20 +26,6 @@ def report(messages, options)
+           # create commit_comment
+           client.create_commit_comment(comment)
+         end
+-
+-        def build_body(data)
+-          buffer = []
+-          files = data['checkstyle']['file'] ||= []
+-          files.each do |file|
+-            errors = file['error'] ||= []
+-            errors.each do |error|
+-              severity = error['@severity'] && error['@severity'].upcase
+-              message = error['@message']
+-              buffer << [severity, message].compact.join(': ')
+-            end
+-          end
+-          buffer.join("\n")
+-        end
+       end
+     end
+   end
+```
+
+We can find some relations between lines:
+
+* Line 4 `class CommitComment` in *new* file was at line 4 in *original* file too
+* Line 5 `include Support` in *new* file is newly inserted
+* Line 6 `include Helper` in *new* file was at line 5 in *original* file
+* Line 14 `body = build_body(data)` in *original* file is not included in *new* file
+* Line 15 `body = concat_body(data)` in *new* file is not included in *original* file
+
+These relations can be calculated by this library as:
+
+```rb
+diff = "..."
+map = GitDiffMap.parse(diff)
+
+map.translate_new_to_original(4)   # => 4
+map.translate_new_to_original(5)   # => nil
+map.translate_new_to_original(6)   # => 6
+map.translate_original_to_new(14)  # => nil
+map.translate_new_to_original(15)  # => nil
+```
+
+## API
+
+* `GitDiffMap#translate_new_to_original(line)`
+* `GitDiffMap#translate_original_to_new(line)`
+* `GitDiffMap#translate_new_lines_to_original_lines([lines])` `lines` must be sorted in ascending order
+* `GitDiffMap#translate_original_lines_to_new_lines([lines])` `lines` must be sorted in ascending order
+
+# Install
+
+```
+$ gem install git_diff_map
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task default: [:test]

data/git_diff_map.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git_diff_map/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_diff_map"
+  spec.version       = GitDiffMap::VERSION
+  spec.authors       = ["Soutaro Matsumoto"]
+  spec.email         = ["matsumoto@soutaro.com"]
+
+  spec.summary       = %q{Maps line from old version to new version.}
+  spec.description   = %q{Maps line from old version to new version.}
+  spec.homepage      = "https://github.com/soutaro/git_diff_map"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.licenses = ['MIT']
+
+  spec.add_runtime_dependency 'git_diff_parser', '~> 2.3'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.9"
+end

data/lib/git_diff_map.rb

@@ -0,0 +1,112 @@
+require 'git_diff_parser'
+require 'git_diff_map/line'
+require 'git_diff_map/patch'
+
+class GitDiffMap
+  attr_reader :patch
+
+  def initialize(patch:)
+    @patch = patch
+  end
+
+  def self.parse(diff)
+    patch = GitDiffMap::Patch.new(GitDiffParser::Patch.new(diff))
+    self.new(patch: patch)
+  end
+
+  def translate_new_to_original(new_line)
+    translate_new_lines_to_original_lines([new_line]).first
+  end
+
+  def translate_new_lines_to_original_lines(lines)
+    results = []
+
+    all_changes = patch.changed_lines.dup
+    offset = 0
+
+    lines.each do |new_line|
+      while true
+        if all_changes.empty?
+          results << new_line + offset
+          break
+        else
+          change = all_changes.first
+
+          case change.type
+          when '-'
+            if new_line + offset < change.number
+              results << new_line + offset
+              break
+            end
+
+            offset += 1
+          when '+'
+            if new_line < change.number
+              results << new_line + offset
+              break
+            end
+
+            if new_line == change.number
+              results << nil
+              break
+            end
+
+            offset -= 1
+          end
+
+          all_changes.shift
+        end
+      end
+    end
+
+    results
+  end
+
+  def translate_original_to_new(original_line)
+    translate_original_lines_to_new_lines([original_line]).first
+  end
+
+  def translate_original_lines_to_new_lines(lines)
+    results = []
+
+    all_changes = patch.changed_lines.dup
+    offset = 0
+
+    lines.each do |original_line|
+      while true
+        if all_changes.empty?
+          results << original_line + offset
+          break
+        else
+          change = all_changes.first
+
+          case change.type
+          when '+'
+            if original_line + offset < change.number
+              results << original_line + offset
+              break
+            end
+
+            offset += 1
+          when '-'
+            if original_line < change.number
+              results << original_line + offset
+              break
+            end
+
+            if original_line == change.number
+              results << nil
+              break
+            end
+
+            offset -= 1
+          end
+
+          all_changes.shift
+        end
+      end
+    end
+
+    results
+  end
+end

data/lib/git_diff_map/line.rb

@@ -0,0 +1,22 @@
+#
+# Originally from rubocop-definition_validator
+#
+# Encoding of `line` is changed:
+# `line` in added line is the number of line in old file (not changed).
+# `line` in deleted line is the number of line in new file (changed).
+#
+class GitDiffMap
+  class Line < GitDiffParser::Line
+    attr_reader :content
+
+    # trim `+` or `-` prefix
+    def body
+      content[1..-1]
+    end
+
+    # @return [String] + or -
+    def type
+      content[0]
+    end
+  end
+end

data/lib/git_diff_map/patch.rb

@@ -0,0 +1,74 @@
+#
+# Originally from rubocop-definition_validator
+#
+# This class override `changed_lines` method.
+# The original method retuns only added lines.
+# However we want added and removed lines.
+#
+
+class GitDiffMap
+  class Patch < GitDiffParser::Patch
+    RANGE_INFORMATION_LINE = /^@@ -(?<original_base_line>\d+),\d+ \+(?<new_base_line>\d+),/
+    ADDED_LINE   = -> (line) { line.start_with?('+') && line !~ /^\+\+\+/ }
+    REMOVED_LINE = -> (line) { line.start_with?('-') && line !~ /^\-\-\-/ }
+
+    def initialize(original_patch)
+      @body = original_patch.body
+      @file = original_patch.file
+      @secure_hash = original_patch.secure_hash
+    end
+
+    # @return [Array<Line>] changed lines
+    def changed_lines
+      original_line = 0
+      new_line = 0
+
+      lines.each_with_index.inject([]) do |lines, (content, patch_position)|
+        case content
+        when RANGE_INFORMATION_LINE
+          original_line = Regexp.last_match[:original_base_line].to_i
+          new_line = Regexp.last_match[:new_base_line].to_i
+        when ADDED_LINE
+          line = Line.new(
+            content: content,
+            number: new_line,
+            patch_position: patch_position
+          )
+          lines << line
+          new_line += 1
+        when REMOVED_LINE
+          line = Line.new(
+            content: content,
+            number: original_line,
+            patch_position: patch_position
+          )
+          lines << line
+          original_line += 1
+        when NOT_REMOVED_LINE
+          original_line += 1
+          new_line += 1
+        end
+
+        lines
+      end
+    end
+
+    def changed_methods
+      lines = changed_lines
+      lines
+        .group_by{|l| l.number}
+        .select{|_, v| v.size == 2}
+        .select{|_, v| t = v.map(&:type); t.include?('-') && t.include?('+')}
+        .select{|_, v| v.all?{|x| x.content =~ /def\s+\w+/}}
+        .map{|line, v|
+        sorted = v.sort_by(&:type)
+        begin
+          ChangedMethod.new(sorted.first, sorted.last, line, @file)
+        rescue Method::InvalidAST => ex
+          warn "Warning: #{ex}\n#{ex.backtrace.join("\n")}"if RuboCop::ConfigLoader.debug
+        end
+      }
+        .compact
+    end
+  end
+end

data/lib/git_diff_map/version.rb

@@ -0,0 +1,3 @@
+class GitDiffMap
+  VERSION = "0.1"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: git_diff_map
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Soutaro Matsumoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git_diff_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+description: Maps line from old version to new version.
+email:
+- matsumoto@soutaro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- git_diff_map.gemspec
+- lib/git_diff_map.rb
+- lib/git_diff_map/line.rb
+- lib/git_diff_map/patch.rb
+- lib/git_diff_map/version.rb
+homepage: https://github.com/soutaro/git_diff_map
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Maps line from old version to new version.
+test_files: []