Class: Gitlab::Git::Diff
- Inherits:
-
Object
- Object
- Gitlab::Git::Diff
- Includes:
- EncodingHelper
- Defined in:
- lib/gitlab_git/diff.rb
Defined Under Namespace
Classes: TimeoutError
Instance Attribute Summary collapse
-
#a_mode ⇒ Object
Diff properties.
-
#b_mode ⇒ Object
Diff properties.
-
#deleted_file ⇒ Object
Stats properties.
-
#diff ⇒ Object
Diff properties.
-
#new_file ⇒ Object
Stats properties.
-
#new_path ⇒ Object
Diff properties.
-
#old_path ⇒ Object
Diff properties.
-
#renamed_file ⇒ Object
Stats properties.
Class Method Summary collapse
- .between(repo, head, base, options = {}, *paths) ⇒ Object
-
.filter_diff_options(options, default_options = {}) ⇒ Object
Return a copy of the
options
hash containing only keys that can be passed to Rugged.
Instance Method Summary collapse
-
#initialize(raw_diff) ⇒ Diff
constructor
A new instance of Diff.
- #serialize_keys ⇒ Object
- #submodule? ⇒ Boolean
- #to_hash ⇒ Object
Methods included from EncodingHelper
Constructor Details
#initialize(raw_diff) ⇒ Diff
Returns a new instance of Diff.
158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/gitlab_git/diff.rb', line 158 def initialize(raw_diff) raise "Nil as raw diff passed" unless raw_diff if raw_diff.is_a?(Hash) init_from_hash(raw_diff) elsif raw_diff.is_a?(Rugged::Patch) init_from_rugged(raw_diff) else raise "Invalid raw diff type: #{raw_diff.class}" end end |
Instance Attribute Details
#a_mode ⇒ Object
Diff properties
9 10 11 |
# File 'lib/gitlab_git/diff.rb', line 9 def a_mode @a_mode end |
#b_mode ⇒ Object
Diff properties
9 10 11 |
# File 'lib/gitlab_git/diff.rb', line 9 def b_mode @b_mode end |
#deleted_file ⇒ Object
Stats properties
12 13 14 |
# File 'lib/gitlab_git/diff.rb', line 12 def deleted_file @deleted_file end |
#diff ⇒ Object
Diff properties
9 10 11 |
# File 'lib/gitlab_git/diff.rb', line 9 def diff @diff end |
#new_file ⇒ Object
Stats properties
12 13 14 |
# File 'lib/gitlab_git/diff.rb', line 12 def new_file @new_file end |
#new_path ⇒ Object
Diff properties
9 10 11 |
# File 'lib/gitlab_git/diff.rb', line 9 def new_path @new_path end |
#old_path ⇒ Object
Diff properties
9 10 11 |
# File 'lib/gitlab_git/diff.rb', line 9 def old_path @old_path end |
#renamed_file ⇒ Object
Stats properties
12 13 14 |
# File 'lib/gitlab_git/diff.rb', line 12 def renamed_file @renamed_file end |
Class Method Details
.between(repo, head, base, options = {}, *paths) ⇒ Object
15 16 17 18 19 20 21 22 23 24 25 |
# File 'lib/gitlab_git/diff.rb', line 15 def between(repo, head, base, = {}, *paths) # Only show what is new in the source branch compared to the target branch, not the other way around. # The linex below with merge_base is equivalent to diff with three dots (git diff branch1...branch2) # From the git documentation: "git diff A...B" is equivalent to "git diff $(git-merge-base A B) B" common_commit = repo.merge_base_commit(head, base) ||= {} break_rewrites = [:break_rewrites] = () repo.diff(common_commit, head, , *paths) end |
.filter_diff_options(options, default_options = {}) ⇒ Object
Return a copy of the options
hash containing only keys that can be passed to Rugged. Allowed options are:
:max_size ::
An integer specifying the maximum byte size of a file before a it
will be treated as binary. The default value is 512MB.
:context_lines ::
The number of unchanged lines that define the boundary of a hunk
(and to display before and after the actual changes). The default is
3.
:interhunk_lines ::
The maximum number of unchanged lines between hunk boundaries before
the hunks will be merged into a one. The default is 0.
:old_prefix ::
The virtual "directory" to prefix to old filenames in hunk headers.
The default is "a".
:new_prefix ::
The virtual "directory" to prefix to new filenames in hunk headers.
The default is "b".
:reverse ::
If true, the sides of the diff will be reversed.
:force_text ::
If true, all files will be treated as text, disabling binary
attributes & detection.
:ignore_whitespace ::
If true, all whitespace will be ignored.
:ignore_whitespace_change ::
If true, changes in amount of whitespace will be ignored.
:ignore_whitespace_eol ::
If true, whitespace at end of line will be ignored.
:ignore_submodules ::
if true, submodules will be excluded from the diff completely.
:patience ::
If true, the "patience diff" algorithm will be used (currenlty
unimplemented).
:include_ignored ::
If true, ignored files will be included in the diff.
:include_untracked ::
If true, untracked files will be included in the diff.
:include_unmodified ::
If true, unmodified files will be included in the diff.
:recurse_untracked_dirs ::
Even if +:include_untracked+ is true, untracked directories will
only be marked with a single entry in the diff. If this flag is set
to true, all files under ignored directories will be included in the
diff, too.
:disable_pathspec_match ::
If true, the given +*paths+ will be applied as exact matches,
instead of as fnmatch patterns.
:deltas_are_icase ::
If true, filename comparisons will be made with case-insensitivity.
:include_untracked_content ::
if true, untracked content will be contained in the the diff patch
text.
:skip_binary_check ::
If true, diff deltas will be generated without spending time on
binary detection. This is useful to improve performance in cases
where the actual file content difference is not needed.
:include_typechange ::
If true, type changes for files will not be interpreted as deletion
of the "old file" and addition of the "new file", but will generate
typechange records.
:include_typechange_trees ::
Even if +:include_typechange+ is true, blob -> tree changes will
still usually be handled as a deletion of the blob. If this flag is
set to true, blob -> tree changes will be marked as typechanges.
:ignore_filemode ::
If true, file mode changes will be ignored.
:recurse_ignored_dirs ::
Even if +:include_ignored+ is true, ignored directories will only be
marked with a single entry in the diff. If this flag is set to true,
all files under ignored directories will be included in the diff,
too.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/gitlab_git/diff.rb', line 123 def (, = {}) = [:max_size, :context_lines, :interhunk_lines, :old_prefix, :new_prefix, :reverse, :force_text, :ignore_whitespace, :ignore_whitespace_change, :ignore_whitespace_eol, :ignore_submodules, :patience, :include_ignored, :include_untracked, :include_unmodified, :recurse_untracked_dirs, :disable_pathspec_match, :deltas_are_icase, :include_untracked_content, :skip_binary_check, :include_typechange, :include_typechange_trees, :ignore_filemode, :recurse_ignored_dirs, :paths] if actual_defaults = .dup actual_defaults.keep_if do |key| .include?(key) end else actual_defaults = {} end if filtered_opts = .dup filtered_opts.keep_if do |key| .include?(key) end filtered_opts = actual_defaults.merge(filtered_opts) else filtered_opts = actual_defaults end filtered_opts end |
Instance Method Details
#serialize_keys ⇒ Object
170 171 172 |
# File 'lib/gitlab_git/diff.rb', line 170 def serialize_keys @serialize_keys ||= %w(diff new_path old_path a_mode b_mode new_file renamed_file deleted_file).map(&:to_sym) end |
#submodule? ⇒ Boolean
186 187 188 |
# File 'lib/gitlab_git/diff.rb', line 186 def submodule? a_mode == '160000' || b_mode == '160000' end |
#to_hash ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/gitlab_git/diff.rb', line 174 def to_hash hash = {} keys = serialize_keys keys.each do |key| hash[key] = send(key) end hash end |