git-conflict-blame 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a86c8e97cedc6efef883350c97235a1022bdcd5e
-  data.tar.gz: fce9caad34072ce10ccfb6fcf3409a8f3cc996f5
+  metadata.gz: 0546d98781bc0da7566751e77e34d01ec9b00d3b
+  data.tar.gz: 9d75e270618d36a51db1d23879e075602dab13a4
 SHA512:
-  metadata.gz: 0c2046509bf36923cd590742157f28da0ee731e48cb437fc791be52aebd14a6ee88ca2ca264b6db3fb76689b33b0a57a8d68eadeb97b19d502a04a4a351e1562
-  data.tar.gz: aab146a0103c4eee5d0b2e49bca2e3bc89b5215a6f621a7faf2ba6b87b7bfd5afd3650a1063a678eb8fed925462928585683ba1686cd7e98088ebf038e9c271b
+  metadata.gz: d5cffc2bfaf1b0d5fd72814a806fb12ab664ee62d7f0ad310ec94410a9234043af3b7cf0471592486555dce7419a095c4c0447d25bc8a753657cc753369c7195
+  data.tar.gz: 07f0af656c3e8f4bd333c1b2f22128ba84d0ad892d26a5a99761a56fe0b54a43586e9437bc91f96b904751987270a09a1d967518d0a86963a3005197cc97f7ee

data/{LICENSE.txt → LICENSE}

@@ -9,13 +9,14 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -1,41 +1,46 @@
-# Git::Conflict::Blame
+# Git Conflict Blame
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/conflict/blame`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Git command that shows the blame on the lines that are in conflict. This should be ran
+after a `git merge` command has been ran and there are files that are in conflict.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+This gem depends on [Rugged](http://www.rubydoc.info/gems/rugged), which requires
+certain dependencies installed.  Make sure you have `cmake`, `make`, or `gmake` installed
+on your system.
 
-```ruby
-gem 'git-conflict-blame'
+```bash
+gem install git-conflict-blame
 ```
 
-And then execute:
-
-    $ bundle
+## Usage
 
-Or install it yourself as:
+Run this inside a directory of your git repository. If there are no conflicts,
+nothing will be displayed.
 
-    $ gem install git-conflict-blame
+To output in a colorized pretty format:
 
-## Usage
+```bash
+git conflict-blame
+```
 
-TODO: Write usage instructions here
+To output machine-readable data:
 
-## Development
+```bash
+git conflict-blame --json
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To output pretty machine-readable data:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+git conflict-blame --json --pretty
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-conflict-blame.
+Bug reports and pull requests are welcome on GitHub at https://github.com/eterry1388/git-conflict-blame.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/git-conflict-blame

@@ -1,72 +1,34 @@
 #!/usr/bin/env ruby
 
-# This needs a lot of work.  It was VERY quickly slapped together!
+require 'git-conflict-blame'
 
-require 'git'
-require 'colorize'
-
-begin
-  git = Git.open( '.' )
-  status = git.status
-  changed = status.changed
-  unmerged = changed.select { |filename, data| data.stage.to_i == 3 }
-rescue Exception => e
-  puts 'Could not find valid GIT repo!'
-  exit 1
+def show_version
+  require 'git-conflict-blame/version'
+  puts "git-conflict-blame #{GitConflictBlame::VERSION}"
 end
 
-data = {}
-unmerged.keys.each do |filename|
-  raw = `git blame --show-email -c --date short #{filename}`
-
-  start_indexes = []
-  end_indexes = []
-  lines = raw.split( "\n" )
-  lines.each do |line|
-    start_indexes << lines.index( line ) if line.include?( '<<<<<<<' )
-    end_indexes   << lines.index( line ) if line.include?( '>>>>>>>' )
-  end
-
-  index = 0
-  all_lines = []
-  start_indexes.count.times do
-    start_index = start_indexes[index]
-    end_index = end_indexes[index]
-    all_lines << lines[start_index..end_index]
-    index += 1
-  end
-
-  data[filename] = all_lines
+show_help = ARGV.include?( '--help' ) || ARGV.include?( '-h' )
+if show_help
+  show_version
+  puts
+  puts 'Git command that shows the blame on the lines that are in conflict.'
+  puts 'This should be ran after a "git merge" command has been ran and there'
+  puts 'are files that are in conflict.'
+  puts
+  puts 'Usage: git conflict-blame [options]'
+  puts "\t -j, --json    \t Output machine-readable data"
+  puts "\t -p, --pretty  \t Output in pretty format (only valid if using '--json')"
+  puts "\t -v, --version \t Show the version of this tool"
+  puts "\t -h, --help    \t Show this message"
+  exit 0
 end
 
-data.delete_if { |_, all_lines| all_lines.nil? || all_lines.empty? }
-
-data.each do |filename, conflicts|
-  puts filename.green
-  conflicts.each do |lines|
-    lines.each do |line|
-      line_array = line.split( "\t" )
-
-      commit_id = line_array[0]
-      email     = line_array[1].delete( "(" )[0..30]
-      date      = line_array[2]
+if ARGV.include?( '--version' ) || ARGV.include?( '-v' )
+  show_version
+  exit 0
+end
 
-      git_info = [commit_id, email, date]
-      raw_line = line_array[3..999].join( "\t" )
-      raw_line_array = raw_line.split( ")" )
-      line_number = raw_line_array.first
-      raw_line_string = raw_line_array[1..999].join( ")" )
+json        = ARGV.include?( '--json' )   || ARGV.include?( '-j' )
+pretty_json = ARGV.include?( '--pretty' ) || ARGV.include?( '-p' )
 
-      formatted_git_info =  "\t%-10s %-30s %-13s" % git_info
-      if raw_line.include?( '<<<<<<<' ) || raw_line.include?( '>>>>>>>' )
-        raw_line_string = raw_line_string.red
-      elsif raw_line.include?( '=======' )
-        raw_line_string = raw_line_string.yellow
-      else
-        raw_line_string = raw_line_string.light_blue
-      end
-      puts "%s [%-22s]  %-s" % [formatted_git_info, line_number.bold, raw_line_string]
-      puts if raw_line.include?( '>>>>>>>' )
-    end
-  end
-end
+GitConflictBlame.run( json: json, pretty_json: pretty_json )

data/git-conflict-blame.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.3'
 
-  spec.add_dependency 'git'
-  spec.add_dependency 'colorize'
+  spec.add_dependency 'rugged', '~> 0.23'
+  spec.add_dependency 'colorize', '~> 0.7'
+  spec.add_dependency 'nesty', '~> 1.0'
 end

data/lib/git-conflict-blame/exceptions.rb

@@ -0,0 +1,4 @@
+require 'nesty'
+
+GitError = Class.new( Nesty::NestedStandardError )
+CmdError = Class.new( Nesty::NestedStandardError )

data/lib/git-conflict-blame/version.rb

@@ -1,3 +1,3 @@
-module GitConflictBlame
-  VERSION = '0.1.0'
+class GitConflictBlame
+  VERSION = '0.2.0'
 end

data/lib/git-conflict-blame.rb

@@ -1,4 +1,227 @@
-require 'git-conflict-blame/version'
+require 'git-conflict-blame/exceptions'
+require 'rugged'
+require 'colorize'
+require 'open3'
+require 'json'
 
-module GitConflictBlame
+# Git command that shows the blame on the lines that are in conflict. This should be ran
+# after a "git merge" command has been ran and there are files that are in conflict.
+class GitConflictBlame
+
+  # @param json [Boolean] Whether or not to output in JSON format
+  # @param pretty_json [Boolean] Whether or not to output in pretty JSON format
+  def initialize( json: false, pretty_json: false )
+    @json        = json
+    @pretty_json = pretty_json
+    @current_dir = Dir.pwd
+    @repo = Rugged::Repository.discover( @current_dir )
+  end
+
+  # Main public method to run on the class
+  #
+  # @param options [Hash] Run options
+  def self.run( options )
+    new( options ).run!
+  end
+
+  # Actually performs the conflict blame
+  def run!
+    Dir.chdir( @repo.workdir )
+    raise GitError, 'No conflicts found' unless conflicts?
+    log "#{conflicts.count} conflicts found!".red
+    log "Parsing files to find out who is to blame..."
+    data = find_conflict_blames
+    if @json
+      json_data = {
+        exception: false,
+        count:     conflicts.count,
+        data:      data
+      }
+      output_json( json_data )
+    else
+      display_results( data )
+    end
+  rescue GitError => e
+    log_error( e )
+    exit 1
+  rescue CmdError => e
+    message =  "This is probably a bug. Please log it here:\n"
+    message << "https://github.com/eterry1388/git-conflict-blame/issues"
+    log_error( e, message: message )
+    exit 1
+  rescue Exception => e
+    message =  "#{e.backtrace.join( "\n" )}\n"
+    message << "Unhandled exception! This is probably a bug. Please log it here:\n"
+    message << "https://github.com/eterry1388/git-conflict-blame/issues"
+    log_error( e, message: message )
+    exit 1
+  ensure
+    Dir.chdir( @current_dir )
+  end
+
+  private
+
+  # Outputs a message
+  #
+  # @note This will not output anything if @json is set!
+  # @param message [String]
+  def log( message = '' )
+    return if @json
+    puts message
+  end
+
+  # Outputs an error message
+  #
+  # @param e [Exception]
+  # @param message [String] Error message
+  def log_error( e, message: )
+    if @json
+      message = "#{e.message}\n#{message}" 
+      error_hash = {
+        exception: true,
+        type:      e.class,
+        message:   message
+      }
+      output_json( error_hash )
+    else
+      puts "#{e.class}: #{e.message}"
+      puts message if message
+    end
+  end
+
+  # Run a command
+  #
+  # @param command [String] the command to run
+  # @raise [CmdError] if command is not successful
+  # @return [String] the output (stdout) of running the command
+  def cmd( command )
+    stdout, stderr, status = Open3.capture3( command )
+    unless status.success?
+      raise CmdError, "Command: '#{command}', Stdout: '#{stdout}', Stderr: '#{stderr}'"
+    end
+    stdout
+  rescue Errno::ENOENT => e
+    raise CmdError, "Command: '#{command}', Error: '#{e}'"
+  end
+
+  # Figures out if there are any conflicts in the git repo
+  #
+  # @return [Boolean]
+  def conflicts?
+    @repo.index.conflicts?
+  end
+
+  # Gets all the filenames that are in conflict
+  #
+  # @return [Array<String>]
+  def conflicts
+    @conflicts ||= @repo.index.conflicts.map { |conflict| conflict[:ours][:path] }
+  end
+
+  # Runs the "git blame" command
+  #
+  # @param filename [String]
+  # @return [String] Raw results of the "git blame" command
+  def raw_blame( filename )
+    cmd( "git blame --show-email -c --date short #{filename}" )
+  end
+
+  # Parses through the conflicted files and finds the blame on each line
+  #
+  # @return [Hash]
+  def find_conflict_blames
+    data = {}
+    conflicts.each do |conflict|
+      raw = raw_blame( conflict )
+      start_indexes = []
+      end_indexes = []
+      lines = raw.split( "\n" )
+      lines.each do |line|
+        start_indexes << lines.index( line ) if line.include?( '<<<<<<<' )
+        end_indexes   << lines.index( line ) if line.include?( '>>>>>>>' )
+      end
+
+      index = 0
+      all_line_sets = []
+      start_indexes.count.times do
+        start_index = start_indexes[index]
+        end_index = end_indexes[index]
+        line_set = lines[start_index..end_index]
+        all_line_sets << parse_lines( line_set )
+        index += 1
+      end
+      data[conflict] = all_line_sets
+    end
+    data.delete_if { |_, all_line_sets| all_line_sets.nil? || all_line_sets.empty? }
+    data
+  end
+
+  # Iterates through a line set and parses them
+  #
+  # @param lines [Array<String>]
+  # @return [Array<Hash>]
+  def parse_lines( lines )
+    lines.map { |line| parse_line( line ) }
+  end
+
+  # Parses a line from the "git blame" command
+  #
+  # @param line [String]
+  # @return [Hash]
+  def parse_line( line )
+    line_array = line.split( "\t" )
+    commit_id = line_array[0]
+    email     = line_array[1].delete( '(' ).delete( '<' ).delete( '>' )
+    date      = line_array[2]
+    raw_line  = line_array[3..999].join( "\t" )
+    raw_line_array = raw_line.split( ')' )
+    line_number  = raw_line_array[0].to_i
+    line_content = raw_line_array[1..999].join( ')' )
+
+    {
+      commit_id:    commit_id,
+      email:        email,
+      date:         date,
+      line_number:  line_number,
+      line_content: line_content
+    }
+  end
+
+  # Outputs a Hash in JSON format
+  #
+  # @param hash [Hash]
+  def output_json( hash )
+    if @pretty_json
+      puts JSON.pretty_generate( hash )
+    else
+      puts hash.to_json
+    end
+  end
+
+  # Outputs the results of {#find_conflict_blames} to the console
+  #
+  # @param data [Hash]
+  def display_results( data )
+    data.each do |filename, conflicts|
+      log filename.green
+      conflicts.each do |lines|
+        lines.each do |line|
+          git_info = [line[:commit_id], line[:email][0..30], line[:date]]
+          formatted_git_info =  "\t%-10s %-30s %-13s" % git_info
+
+          if line[:line_content].include?( '<<<<<<<' ) || line[:line_content].include?( '>>>>>>>' )
+            line_color = :red
+          elsif line[:line_content].include?( '=======' )
+            line_color = :yellow
+          else
+            line_color = :light_blue
+          end
+
+          line_data = [formatted_git_info, line[:line_number].to_s.bold, line[:line_content].colorize( line_color )]
+          log "%s [%-20s]  %-s" % line_data
+        end
+        log # New line
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-conflict-blame
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Terry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,44 +42,58 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: rugged
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: nesty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: Git command that shows the blame on the lines that are in conflict
 email:
 - eterry1388@aol.com
@@ -93,7 +107,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -101,6 +115,7 @@ files:
 - bin/setup
 - git-conflict-blame.gemspec
 - lib/git-conflict-blame.rb
+- lib/git-conflict-blame/exceptions.rb
 - lib/git-conflict-blame/version.rb
 homepage: https://github.com/eterry1388/git-conflict-blame
 licenses: