nexocop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1def61da2ee28929e12ef3c9397ab4581d03953d
+  data.tar.gz: 7cd746e821d8b0ea33da7b035c56abd6ac751ad9
+SHA512:
+  metadata.gz: cadcce64b1ce92491cee48d4bd917f6ad7f072757be0f3bcbab437fa410d61aa7ef27061626edf11e192ab58d5ebbe3053cc9b86af534f041bbba4a224aa4bcf
+  data.tar.gz: fe1dfafe43828b7a9dfdaed923b56d8e9092cc13bc2e187824919fc4a9dc40c32389116162f02463ead5e46259a59aa588f8e38d30cc31455ac73d8e1dd297ec

data/bin/nexocop

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rainbow/refinement'
+using Rainbow
+
+require 'nexocop'
+
+module Nexocop
+  #
+  # Mutates the argument by adding the file path to each offense
+  #
+  def self.add_path_to_offenses!(part_json)
+    part_json['files'].each do |file|
+      file['offenses'].map! do |offense|
+        offense['path'] = file['path']
+        offense
+      end
+    end
+  end
+
+  #
+  # Mutates the argument by removing files that
+  # weren't changed by this branch
+  #
+  def self.filter_files_not_in_diff!(part_json, changed_lines)
+    part_json['files'].select! do |file|
+      changed_lines.key?(file['path'])
+    end
+  end
+
+  #
+  # Mutates the argument by removing files that
+  # have no offenses
+  #
+  def self.filter_files_without_offenses!(part_json)
+    part_json['files'].select! do |file|
+      file['offenses'].count.positive?
+    end
+  end
+
+  #
+  # Mutates the argument by removing offenses that
+  # weren't added by this branch
+  #
+  def self.filter_offenses_not_in_diff!(part_json, changed_lines)
+    part_json['files'].each do |file|
+      file['offenses'].select! do |offense|
+        Rubocop.offense_in_diff?(offense, changed_lines)
+      end
+    end
+  end
+
+  #
+  # Mutates the argument by adjusting the summary numbers
+  # to be accurate based on our trimming
+  #
+  def self.update_summary!(part_json)
+    part_json['summary']['offense_count'] = Rubocop.count_offenses(part_json)
+    part_json['summary']['target_file_count'] = Rubocop.count_files(part_json)
+    part_json
+  end
+
+  #
+  # Only include offenses pertaining to code that has changed
+  #
+  def self.trim_results(full_json)
+    changed_lines = Git.changed_lines
+    part_json = full_json.dup
+    add_path_to_offenses!(part_json)
+    filter_files_not_in_diff!(part_json, changed_lines)
+    filter_offenses_not_in_diff!(part_json, changed_lines)
+    filter_files_without_offenses!(part_json)
+    update_summary!(part_json)
+    part_json
+  end
+
+  def self.run(json_file:, rubocop_args:)
+    unless Rubocop.available?
+      puts 'Could not find rubocop!  Please make sure it is installed'.red
+      exit 1
+    end
+
+    res = Rubocop.run(rubocop_args)
+
+    if res.success?
+      puts 'Rubocop found no violations!'.green
+      exit 0
+    elsif !File.exist?(json_file)
+      puts "Rubocop found violations but did not save the file at #{json_file} as expected!".red
+      exit 2
+    else
+      part_json = trim_results(JSON.parse(File.read(json_file)))
+      File.write(json_file, JSON.pretty_generate(part_json))
+      if Rubocop.has_offenses?(part_json)
+        count = Rubocop.count_offenses(part_json)
+        violations_that_need = count == 1 ? 'violation that needs' : 'violations that need'
+        puts "Found #{count} #{violations_that_need} to be fixed:\n".yellow
+        puts JSON.pretty_generate(part_json)
+        exit 3
+      else
+        puts 'No offenses found in the new code!'.green
+        exit 0
+      end
+    end
+  end
+end
+
+args = Nexocop::Options.parse_args(ARGV)
+Nexocop.run(json_file: args.json_outfile, rubocop_args: args.rubocop_args)

data/lib/nexocop.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Gem.find_files('nexocop/**/*.rb').each do |path|
+  require path.gsub(/\.rb$/, '') unless path =~ /bot.*cli/
+end

data/lib/nexocop/git.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'ostruct'
+
+module Nexocop
+  module Git
+    # Get an array of line numbers that have been changed
+    #
+    # For example, you will get a structure that looks like this:
+    #
+    # {
+    #     'Dockerfile' => [[12, 12], [15, 15]],
+    #     'docker-compose.yml' => [[24, 24], [52, 52]],
+    #     'bin/nexocop' => [[1, 31]]
+    # }
+    #
+    def self.changed_lines(git_diff = nil)
+      git_diff ||= Sh.run_command('git diff --unified=0 origin/master').stdout
+      lines = {}
+      cur_file = ''
+      git_diff.split("\n").each do |line|
+        # look for filenames and update cur_file, or for count lines
+        if filename?(line)
+          cur_file = parse_filename(line)
+        elsif count_line?(line)
+          lines[cur_file] ||= []
+          lines[cur_file].push(parse_count_line(line))
+        end
+      end
+      lines
+    end
+
+    def self.filename?(line)
+      line.start_with?('+++ b/')
+    end
+
+    def self.parse_filename(line)
+      line.gsub(%r{^\+\+\+\sb/}, '')
+    end
+
+    def self.count_line?(line)
+      line =~ /@@.*@@/
+    end
+
+    #
+    # Extract line numbers from this, return array of length 2 with
+    # beginning line num and ending line num respectively
+    #
+    def self.parse_count_line(line)
+      pos_block = line.split('@@')[1].strip.split('+')[1].split(',').map(&:to_i)
+      if pos_block.count == 1
+        [pos_block[0], pos_block[0]]
+      else
+        [pos_block[0], pos_block[0] + pos_block[1]]
+      end
+    end
+  end
+end

data/lib/nexocop/options.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'ostruct'
+
+module Nexocop
+  module Options
+    def self.default_json_file
+      'nexocop.json'
+    end
+
+    def self.parse_args(args)
+      # We need to know where the json file will be.  If one isn't specified,
+      # set it explicitly so that we know it is there
+
+      # Use Rubocop's parser so we stay synced
+      options, _paths = RuboCop::Options.new.parse(args)
+      rubocop_args = args.dup
+      json_outfile = nil
+
+      if options[:formatters] && options[:formatters].count { |f| f[0]['json'] } == 1
+        json_outfile = options[:formatters].select { |f| f[0]['json'] }[0][1]
+      else
+        options[:formatters] = [] unless options[:formatters]
+        json_outfile = default_json_file
+        rubocop_args.push(%w[--format json -o].push(default_json_file)).flatten!
+      end
+
+      OpenStruct.new(
+        json_outfile: json_outfile,
+        rubocop_args: rubocop_args
+      )
+    end
+  end
+end

data/lib/nexocop/rubocop.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'ostruct'
+
+module Nexocop
+  module Rubocop
+    def self.available?
+      !rubocop_cmd.empty?
+    end
+
+    def self.rubocop_cmd
+      if Sh.run_command('which bundle >/dev/null 2>&1').success?
+        'bundle exec rubocop'
+      elsif Sh.run_command('which rubocop >/dev/null 2>&1').success?
+        'rubocop'
+      else
+        ''
+      end
+    end
+
+    def self.run(rubocop_args)
+      Sh.run_command("#{rubocop_cmd} #{rubocop_args.join(' ')}")
+    end
+
+    def self.offense_in_diff?(offense, changed_lines)
+      # make sure this offense is in a file that has changed
+      return false unless changed_lines.key?(offense['path'])
+
+      changed_lines[offense['path']].any? do |line_range|
+        start_line = offense['location']['start_line']
+        last_line  = offense['location']['last_line']
+        range = (line_range[0]..line_range[1])
+        (start_line..last_line).to_a.any? { |line_num| range.include?(line_num) }
+      end
+    end
+
+    def self.has_offenses?(rubocop_json)
+      rubocop_json['files']
+        .map { |file| file['offenses'] }
+        .map(&:count)
+        .any?(&:positive?)
+    end
+
+    def self.count_offenses(rubocop_json)
+      rubocop_json['files']
+        .map { |file| file['offenses'] }
+        .map(&:count)
+        .reduce(:+)
+    end
+
+    def self.count_files(rubocop_json)
+      rubocop_json['files'].count
+    end
+  end
+end

data/lib/nexocop/shell.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Nexocop
+  module Sh
+    def self.run_command(command)
+      stdout = `#{command}`
+      OpenStruct.new(
+        success?: $?.exitstatus.zero?,
+        exitstatus: $?.exitstatus,
+        stdout: stdout
+      )
+    end
+  end
+
+  module Bash
+    def self.escape_double_quotes(str)
+      str.gsub('"', '\\"')
+    end
+
+    def self.run_command(command)
+      stdout = `bash -c "#{escape_double_quotes(command)}"`
+      OpenStruct.new(
+        success?: $?.exitstatus.zero?,
+        exitstatus: $?.exitstatus,
+        stdout: stdout
+      )
+    end
+  end
+end

data/lib/nexocop/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nexocop
+  def self.version
+    '0.0.1'
+  end
+
+  def self.date
+    '2018-10-02'
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: nexocop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Nexocop makes it trivial to add rubocop linting to your project that
+  will only check linting against lines that have changed in git.  Rubocop normally
+  is not git aware.  This gem makes it git aware.
+email: BenjaminPorter86@gmail.com
+executables:
+- nexocop
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/nexocop
+- lib/nexocop.rb
+- lib/nexocop/git.rb
+- lib/nexocop/options.rb
+- lib/nexocop/rubocop.rb
+- lib/nexocop/shell.rb
+- lib/nexocop/version.rb
+homepage: https://github.com/FreedomBen/nexocop
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Easy rubocop wrapping for git diffs
+test_files: []