git_diff_parser 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b9c1edf73e6e914929331d565114ba7f3514aba
-  data.tar.gz: 07cf0a06016067f4139ddc4e1b62abb2af88e250
+  metadata.gz: 5a39ab2710d525d8674cad580b457c9b91f26d42
+  data.tar.gz: 06e5e4229ec3638bb07484ef6ca38f68e01353ab
 SHA512:
-  metadata.gz: b18677c9b988875a4eba90a303b72c41943579367e300b7c39d6423dc092f58912cf22df02ffce849c320cd9392cd8177afb7be35c8de67a4d6aae8b483f2b82
-  data.tar.gz: fc63c6812d623d479e6b2e73eebc35f47941f29b5c4d9c8f9bece40d7bcf90a6aa65fd0a5a230420596c1f63de57822a5ba29dea7e4fd328b9f991b59389caa7
+  metadata.gz: b1455c92a35925da353a218db73d6f6f88be0799c037bad628b346f6f67df2232e1ec6de01a86c0935b46d1441705de15864e2cb680577674b242418a85f4469
+  data.tar.gz: a270ee8fe1e9fde3241d7143b5c5e85bcdfe03a2cd0ffd0b12ba3ae568e844a34e4596e2db2c98a0a17afbf90234a7eb840b7a58615ffe8286911414a9b4458a

data/README.md

@@ -7,6 +7,8 @@
 
 ## Examples
 
+### Parse entire `git diff`
+
 ```ruby
 diff = <<'EOL'
 diff --git a/lib/saddler/reporter/github.rb b/lib/saddler/reporter/github.rb
@@ -25,12 +27,8 @@ EOL
 
 patches = GitDiffParser.parse(diff)
 #=> [#<GitDiffParser::Patch:0x007fb313189430
-# @body="@@ -2,6 +2,7 @@\n require 'octokit'\n require
-# 'git'\n require 'saddler/reporter/github/version'\n+r
-# equire 'saddler/reporter/github/support'\n require 'sad
-# dler/reporter/github/helper'\n require 'saddler/reporte
-# r/github/client'\n require 'saddler/reporter/github/com
-# ment'\n", @file="lib/saddler/reporter/github.rb">]
+# @body="@@ -2,6 +2,7 @@\n require 'octokit'\n require 'git'\n require 'saddler/reporter/github/version'\n+r (snip)",
+# @file="lib/saddler/reporter/github.rb">]
 
 patches[0].file
 #=> "lib/saddler/reporter/github.rb"
@@ -42,6 +40,14 @@ patches[0].changed_lines
 # @patch_position=4>]
 ```
 
+
+### Parse single patch
+
+* patch section in `git diff`.
+* GitHub's [pull request file's patch](https://developer.github.com/v3/pulls/#list-pull-requests-files).
+* GitHub's [commit file's patch](https://developer.github.com/v3/repos/commits/#get-a-single-commit).
+
+
 ```ruby
 diff = <<-'EOS'
 @@ -2,6 +2,7 @@ module Saddler

data/changelog.md

@@ -1,3 +1,15 @@
+<a name="2.2.0"></a>
+# [2.2.0](https://github.com/packsaddle/ruby-git_diff_parser/compare/v2.1.3...v2.2.0) (2015-10-01)
+
+
+### Features
+
+* **line:** remove default, and use meaningful variable name ([3b14ae7](https://github.com/packsaddle/ruby-git_diff_parser/commit/3b14ae7))
+* **parser:** add deprecated tag ([0e88b7c](https://github.com/packsaddle/ruby-git_diff_parser/commit/0e88b7c))
+* **patches:** use Patches.parse instead of DiffParser.parse ([6597e6d](https://github.com/packsaddle/ruby-git_diff_parser/commit/6597e6d))
+
+
+
 <a name="2.1.3"></a>
 ## [2.1.3](https://github.com/packsaddle/ruby-git_diff_parser/compare/v2.1.2...v2.1.3) (2015-10-01)
 

data/lib/git_diff_parser.rb

@@ -6,11 +6,10 @@ require 'git_diff_parser/diff_parser'
 
 # Parse `git diff` into patches and lines
 module GitDiffParser
-
   # @param contents [String] `git diff` result.
   #
   # @return [Patches<Patch>] parsed patches and lines
   def self.parse(contents)
-    DiffParser.parse(contents)
+    Patches.parse(contents)
   end
 end

data/lib/git_diff_parser/diff_parser.rb

@@ -1,41 +1,18 @@
 module GitDiffParser
   # Parse entire `git diff` into Patches and Patch
+  #
+  # @deprecated
   class DiffParser
     # Parse entire `git diff` into Patches and Patch
     #
+    # @deprecated Use {Patches.parse} instead.
+    #
     # @param contents [String] `git diff` result
     #
     # @return [Patches<Patch>] parsed object
     def self.parse(contents)
-      body = false
-      file_name = ''
-      patch = []
-      lines = contents.lines
-      line_count = lines.count
-      parsed = Patches.new
-      lines.each_with_index do |line, count|
-        case line.chomp
-        when /^diff/
-          unless patch.empty?
-            parsed << Patch.new(patch.join("\n") + "\n", file: file_name)
-            patch.clear
-            file_name = ''
-          end
-          body = false
-        when /^\-\-\-/
-        when %r{^\+\+\+ b/(?<file_name>.*)}
-          file_name = Regexp.last_match[:file_name]
-          body = true
-        when /^(?<body>[\ @\+\-\\].*)/
-          patch << Regexp.last_match[:body] if body
-          if !patch.empty? && body && line_count == count + 1
-            parsed << Patch.new(patch.join("\n") + "\n", file: file_name)
-            patch.clear
-            file_name = ''
-          end
-        end
-      end
-      parsed
+      warn '[DEPRECATION] `DiffParser.parse` is deprecated.  Please use `Patches.parse` instead.'
+      Patches.parse(contents)
     end
   end
 end

data/lib/git_diff_parser/line.rb

@@ -7,17 +7,17 @@ module GitDiffParser
     # @!attribute [r] patch_position
     #   @return [Integer] line patch position
 
-    # @param options [Hash] this is not options
-    # @option options [Integer] :number line number (required)
-    # @option options [String] :content content (required)
-    # @option options [Integer] :patch_position patch position (required)
-    def initialize(options = {})
-      fail(ArgumentError('number is required')) unless options[:number]
-      fail(ArgumentError('content is required')) unless options[:content]
-      fail(ArgumentError('patch_position is required')) unless options[:patch_position]
-      @number = options[:number]
-      @content = options[:content]
-      @patch_position = options[:patch_position]
+    # @param params [Hash] required params
+    # @option params [Integer] :number line number (required)
+    # @option params [String] :content content (required)
+    # @option params [Integer] :patch_position patch position (required)
+    def initialize(params)
+      fail(ArgumentError('number is required')) unless params[:number]
+      fail(ArgumentError('content is required')) unless params[:content]
+      fail(ArgumentError('patch_position is required')) unless params[:patch_position]
+      @number = params[:number]
+      @content = params[:content]
+      @patch_position = params[:patch_position]
     end
 
     # @return [Boolean] true if line changed

data/lib/git_diff_parser/patches.rb

@@ -7,6 +7,41 @@ module GitDiffParser
       new(ary)
     end
 
+    # @param contents [String] `git diff` result
+    #
+    # @return [Patches<Patch>] parsed object
+    def self.parse(contents)
+      body = false
+      file_name = ''
+      patch = []
+      lines = contents.lines
+      line_count = lines.count
+      parsed = new
+      lines.each_with_index do |line, count|
+        case line.chomp
+        when /^diff/
+          unless patch.empty?
+            parsed << Patch.new(patch.join("\n") + "\n", file: file_name)
+            patch.clear
+            file_name = ''
+          end
+          body = false
+        when /^\-\-\-/
+        when %r{^\+\+\+ b/(?<file_name>.*)}
+          file_name = Regexp.last_match[:file_name]
+          body = true
+        when /^(?<body>[\ @\+\-\\].*)/
+          patch << Regexp.last_match[:body] if body
+          if !patch.empty? && body && line_count == count + 1
+            parsed << Patch.new(patch.join("\n") + "\n", file: file_name)
+            patch.clear
+            file_name = ''
+          end
+        end
+      end
+      parsed
+    end
+
     # @return [Patches<Patch>]
     def initialize(*args)
       super Array.new(*args)

data/lib/git_diff_parser/version.rb

@@ -1,3 +1,3 @@
 module GitDiffParser
-  VERSION = '2.1.3'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_diff_parser
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - sanemat