rubocop-git-kjanoudi 0.1.2

data/lib/rubocop/git.rb

@@ -0,0 +1,22 @@
+require 'rubocop/git/version'
+require 'rubocop'
+require 'tempfile'
+require 'fileutils'
+
+module RuboCop
+  module Git
+    autoload :Commit,            'rubocop/git/commit'
+    autoload :CommitFile,        'rubocop/git/commit_file'
+    autoload :DiffParser,        'rubocop/git/diff_parser'
+    autoload :FileViolation,     'rubocop/git/file_violation'
+    autoload :Line,              'rubocop/git/line'
+    autoload :Options,           'rubocop/git/options'
+    autoload :Patch,             'rubocop/git/patch'
+    autoload :PseudoPullRequest, 'rubocop/git/pseudo_pull_request'
+    autoload :PseudoResource,    'rubocop/git/pseudo_resource'
+    autoload :Runner,            'rubocop/git/runner'
+    autoload :StyleChecker,      'rubocop/git/style_checker'
+    autoload :StyleGuide,        'rubocop/git/style_guide'
+    autoload :RuboComment,       'rubocop/git/rubo_comment'
+  end
+end

data/lib/rubocop/git/cli.rb

@@ -0,0 +1,71 @@
+require 'rubocop/git'
+require 'optparse'
+
+module RuboCop
+  module Git
+    class CLI
+      def run(args = ARGV)
+        @options = Options.new
+        parse_arguments(args)
+        Runner.new.run(@options)
+      end
+
+      private
+
+      def parse_arguments(args)
+        @options.commits = option_parser.parse(args)
+      rescue OptionParser::InvalidOption, Options::Invalid => ex
+        warn "ERROR: #{ex.message}"
+        $stderr.puts
+        warn option_parser
+        exit 1
+      end
+
+      def option_parser
+        @option_parser ||= OptionParser.new do |opt|
+          opt.banner << ' [[commit] commit]'
+
+          opt.on('-c', '--config FILE',
+                 'Specify configuration file') do |config|
+            @options.config = config
+          end
+
+          opt.on('-r', '--require FILE',
+                 'Require Ruby file') do |file|
+            require file
+          end
+
+          opt.on('-a', '--auto-correct', 'Auto-correct offenses.') do
+            @options.rubocop[:auto_correct] = true
+          end
+
+          opt.on('-d', '--debug', 'Display debug info') do
+            @options.rubocop[:debug] = true
+          end
+
+          opt.on('-D', '--display-cop-names',
+                 'Display cop names in offense messages') do
+            @options.rubocop[:display_cop_names] = true
+          end
+
+          opt.on('--cached', 'git diff --cached') do
+            @options.cached = true
+          end
+
+          opt.on('--staged', 'synonym of --cached') do
+            @options.cached = true
+          end
+
+          opt.on('--hound', 'Hound compatibility mode') do
+            @options.hound = true
+          end
+
+          opt.on('--version', 'Display version') do
+            puts RuboCop::Git::VERSION
+            exit 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/git/commit.rb

@@ -0,0 +1,22 @@
+require 'shellwords'
+
+module RuboCop
+  module Git
+    # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/commit.rb
+    class Commit
+      def initialize(options)
+        @options = options
+      end
+
+      def file_content(filename)
+        if @options.cached
+          `git show :#{filename.shellescape}`
+        elsif @options.commit_last
+          `git show #{@options.commit_last.shellescape}:#{filename.shellescape}`
+        else
+          File.read(filename)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/git/commit_file.rb

@@ -0,0 +1,51 @@
+module RuboCop::Git
+# copy from https://github.com/thoughtbot/hound/blob/d2f3933/app/models/commit_file.rb
+class CommitFile
+  def initialize(file, commit)
+    @file = file
+    @commit = commit
+  end
+
+  def filename
+    @file.filename
+  end
+
+  def content
+    @content ||= begin
+      unless removed?
+        @commit.file_content(filename)
+      end
+    end
+  end
+
+  def relevant_line?(line_number)
+    modified_lines.detect do |modified_line|
+      modified_line.line_number == line_number
+    end
+  end
+
+  def removed?
+    @file.status == 'removed'
+  end
+
+  def ruby?
+    filename.match(/.*\.rb$/)
+  end
+
+  def modified_lines
+    @modified_lines ||= patch.additions
+  end
+
+  def modified_line_at(line_number)
+    modified_lines.detect do |modified_line|
+      modified_line.line_number == line_number
+    end
+  end
+
+  private
+
+  def patch
+    Patch.new(@file.patch)
+  end
+end
+end

data/lib/rubocop/git/diff_parser.rb

@@ -0,0 +1,31 @@
+module RuboCop
+  module Git
+    class DiffParser
+      class << self
+        def parse(diff)
+          new.parse(diff)
+        end
+      end
+
+      def parse(diff)
+        files    = []
+        in_patch = false
+
+        diff.each_line do |line|
+          case line
+          when /^diff --git/
+            in_patch = false
+          when %r{^\+{3} b/(?<path>[^\t\n\r]+)}
+            files << PseudoResource.new(Regexp.last_match[:path])
+          when /^@@/
+            in_patch = true
+          end
+
+          files.last.patch << line if in_patch
+        end
+
+        files
+      end
+    end
+  end
+end

data/lib/rubocop/git/file_violation.rb

@@ -0,0 +1,5 @@
+module RuboCop::Git
+# ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/file_violation.rb
+class FileViolation < Struct.new(:filename, :offenses)
+end
+end

data/lib/rubocop/git/line.rb

@@ -0,0 +1,8 @@
+module RuboCop::Git
+# copy from https://github.com/thoughtbot/hound/blob/d2f3933/app/models/line.rb
+class Line < Struct.new(:content, :line_number, :patch_position)
+  def ==(other_line)
+    content == other_line.content
+  end
+end
+end

data/lib/rubocop/git/options.rb

@@ -0,0 +1,84 @@
+module RuboCop
+  module Git
+    class Options
+      class Invalid < StandardError; end
+
+      HOUND_DEFAULT_CONFIG_FILE =
+        File.expand_path('../../../../hound.yml', __FILE__)
+
+      attr_accessor :config
+      attr_reader   :cached, :hound, :rubocop
+
+      def initialize(hash_options = nil)
+        @config  = nil
+        @cached  = false
+        @hound   = false
+        @rubocop = {}
+        @commits = []
+
+        from_hash(hash_options) if hash_options
+      end
+
+      def cached=(cached_)
+        if cached_ && !@commits.empty?
+          fail Invalid, 'cached and commit cannot be specified together'
+        end
+        @cached = !!cached_
+      end
+
+      def hound=(hound_)
+        @hound = !!hound_
+      end
+
+      def rubocop=(rubocop_)
+        unless rubocop_.is_a?(Hash)
+          fail Invalid, "invalid rubocop: #{rubocop_.inspect}"
+        end
+        @rubocop = rubocop_
+      end
+
+      def commits=(commits)
+        unless commits.is_a?(Array) && commits.length <= 2
+          fail Invalid, "invalid commits: #{commits.inspect}"
+        end
+        if !commits.empty? && cached
+          fail Invalid, 'cached and commit cannot be specified together'
+        end
+        @commits = commits
+      end
+
+      def config_file
+        if hound
+          HOUND_DEFAULT_CONFIG_FILE
+        elsif config
+          config
+        elsif File.exist?(RuboCop::ConfigLoader::DOTFILE)
+          RuboCop::ConfigLoader::DOTFILE
+        else
+          RuboCop::ConfigLoader::DEFAULT_FILE
+        end
+      end
+
+      def commit_first
+        @commits.first
+      end
+
+      def commit_last
+        @commits.length == 1 ? false : @commits.last
+      end
+
+      private
+
+      def from_hash(hash_options)
+        hash_options = hash_options.dup
+        %w(config cached hound rubocop commits).each do |key|
+          value = hash_options.delete(key) || hash_options.delete(key.to_sym)
+          public_send("#{key}=", value)
+        end
+        unless hash_options.empty?
+          fail Invalid, "invalid keys: #{hash_options.keys.join(' ')}"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/git/patch.rb

@@ -0,0 +1,63 @@
+module RuboCop::Git
+# copy from https://github.com/thoughtbot/hound/blob/d2f3933/app/models/patch.rb
+class Patch
+  RANGE_INFORMATION_LINE = /^@@ .+\+(?<line_number>\d+),/
+  MODIFIED_LINE = /^\+(?!\+|\+)/
+  NOT_REMOVED_LINE = /^[^-]/
+  PATCH_INFO_LINE = /\+([0-9,]+)/
+
+  def initialize(body)
+    @body = body || ''
+    @changes = []
+  end
+
+  def additions
+    line_number = 0
+
+    lines.each_with_index.inject(@changes) do |additions, (content, patch_position)|
+      case content
+      when RANGE_INFORMATION_LINE
+        line_number = Regexp.last_match[:line_number].to_i
+      when MODIFIED_LINE
+        additions << Line.new(content, line_number, patch_position)
+        line_number += 1
+      when NOT_REMOVED_LINE
+        line_number += 1
+      end
+
+      additions
+    end
+  end
+
+  # maps out additions line numbers to indicate start and end of code changes
+  # [[5,7], [11,11]] indicates changes from line 5, 6, 7 and then
+  # another one at 11
+  def additions_map
+    if @changes.empty?
+      self.additions
+    end
+
+    map = []
+    starting_line = ending_line = 0
+
+    @changes.each do |addition|
+      if starting_line == 0
+        starting_line = ending_line = addition.line_number
+      elsif addition.line_number == ( ending_line + 1 )
+        ending_line = addition.line_number
+      else # this row is not part of the last rows "group"
+        map.push([starting_line, ending_line])
+        starting_line = ending_line = addition.line_number
+      end
+    end
+    map.push([starting_line, ending_line])
+    map
+  end
+
+  private
+
+  def lines
+    @body.lines
+  end
+end
+end

data/lib/rubocop/git/pseudo_pull_request.rb

@@ -0,0 +1,36 @@
+module RuboCop
+  module Git
+    # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/pull_request.rb
+    class PseudoPullRequest
+      HOUND_CONFIG_FILE = '.hound.yml'
+
+      def initialize(files, options)
+        @files = files
+        @options = options
+      end
+
+      def pull_request_files
+        @files.map do |file|
+          build_commit_file(file)
+        end
+      end
+
+      def config
+        return unless @options.hound
+        File.read(HOUND_CONFIG_FILE)
+      rescue Errno::ENOENT
+        nil
+      end
+
+      private
+
+      def build_commit_file(file)
+        CommitFile.new(file, head_commit)
+      end
+
+      def head_commit
+        @head_commit ||= Commit.new(@options)
+      end
+    end
+  end
+end

data/lib/rubocop/git/pseudo_resource.rb

@@ -0,0 +1,16 @@
+module RuboCop
+  module Git
+    class PseudoResource
+      attr_reader :filename, :patch
+
+      def initialize(filename)
+        @filename = filename
+        @patch    = ''
+      end
+
+      def status
+        'modified'
+      end
+    end
+  end
+end

data/lib/rubocop/git/rubo_comment.rb

@@ -0,0 +1,92 @@
+module RuboCop::Git
+class RuboComment
+  RUBOCOP_DISABLE = "# rubocop:disable all\n"
+  RUBOCOP_ENABLE = "# rubocop:enable all\n"
+  WHITE_SPACE = /^\s*/
+
+  def initialize(files)
+    @edit_map = {}
+    @files = files
+  end
+
+  # adds rubocop enable and disabled comments to files
+  # making sure only edited lines are processed by rubocop
+  def add_comments
+    @files.each do |file|
+      patch_info = Patch.new(file.patch).additions_map
+      temp_file = Tempfile.new('temp')
+
+      line_count = edited_line_count = current_patch = 0
+      in_patch = false
+      edit_locations = []
+
+      begin
+        File.open(file.filename, "r").each_line do |line|
+          line_count += 1
+          edited_line_count += 1
+
+          if line_count == patch_info[current_patch].first
+            temp_file.puts generate_spaces(line) + RUBOCOP_ENABLE
+            in_patch = true
+            edit_locations.push edited_line_count
+            edited_line_count += 1
+
+          elsif in_patch && patch_info[current_patch].last + 1 == line_count
+            temp_file.puts generate_spaces(line) + RUBOCOP_DISABLE
+            in_patch = false
+            edit_locations.push edited_line_count
+            edited_line_count += 1
+            current_patch += 1 unless (current_patch + 1) >= patch_info.size
+
+          elsif line_count == 1 #adds disable at top of file
+            temp_file.puts generate_spaces(line) + RUBOCOP_DISABLE
+            edit_locations.push edited_line_count
+            edited_line_count += 1
+
+          end
+          temp_file.puts line
+        end
+
+        temp_file.close
+        FileUtils.mv(temp_file.path, file.filename)
+        @edit_map[file.filename] = edit_locations
+      ensure
+        temp_file.close
+        temp_file.unlink
+      end
+    end
+  end
+
+  # removes all added comments that where added from add_comments
+  def remove_comments
+    @files.each do |file|
+      temp_file = Tempfile.new('temp')
+      line_count = 0
+
+      begin
+        File.open(file.filename, "r").each_line do |line|
+          line_count += 1
+          temp_file.puts line unless @edit_map[file.filename].find_index line_count
+        end
+        
+        temp_file.close
+        FileUtils.mv(temp_file.path, file.filename)
+      ensure
+        temp_file.close
+        temp_file.unlink
+      end
+    end
+  end
+
+  private
+
+  # generates whitespaces to make en/disable comments match line indent
+  # preventing rubocop errors
+  def generate_spaces(line)
+    whitespaces = ""
+    WHITE_SPACE.match(line).to_s.split('').size.times { whitespaces << " " }
+    whitespaces
+  end
+
+end
+end