lintron 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 395602bdec689110f8bdb9e08643197014a7db36
+  data.tar.gz: 9fb2bc909a2d0f52545538894f578a9ebf7a3863
+SHA512:
+  metadata.gz: f853f0c7d1a2e9e0ceda044944dc49ee538e4ef95c3dfacf47ac8122bd3d471edccdfa45d4e25b45d71e3ccd0615e97ff2ff6a28f267489bdc7c83d0dd1b9ced
+  data.tar.gz: 1d4ebf5fa5e6617be217fe13f3072bd8eceed553ba944de6073afe5c1010ee7f18572ad71169d4d5ca6a0411b453d81088d2642ca6fa67cbcd4eccf3408ac8bf

data/app/models/file_like.rb

@@ -0,0 +1,15 @@
+# Base class for Github API files and mock files that perform basic operations
+# on the blob and path
+class FileLike
+  def extname
+    File.extname(path).gsub(/^\./, '') # without leading .
+  end
+
+  def basename(ext = nil)
+    File.basename path, ext
+  end
+
+  def first_line_of_patch
+    patch.changed_lines.first.try(:number)
+  end
+end

data/app/models/local_pr_alike.rb

@@ -0,0 +1,84 @@
+require 'git_diff_parser'
+require_relative './stub_file'
+require_relative './patch'
+
+# An object that is similar enough to PullRequest to be linted. It can be
+# constructed from the CLI tool (compares local working tree to base_branch) or
+# from the JSON payload that the CLI tool sends to the API
+class LocalPrAlike
+  attr_accessor :files
+
+  def self.from_json(json)
+    LocalPrAlike.new.tap do |pr|
+      pr.files = json.map do |file_json|
+        StubFile.from_json(file_json)
+      end
+    end
+  end
+
+  def self.from_branch(base_branch)
+    LocalPrAlike.new.tap do |pr|
+      pr.files = pr.stubs_for_existing(base_branch) + pr.stubs_for_new
+    end
+  end
+
+  def stubs_for_existing(base_branch)
+    patches = GitDiffParser.parse(raw_diff(base_branch))
+
+    patches.map do |patch|
+      StubFile.new(
+        path: patch.file,
+        blob: File.read(patch.file),
+        patch: Patch.new(patch.body),
+      )
+    end
+  end
+
+  def raw_diff(base_branch)
+    diff = `git diff --no-ext-diff #{base_branch} .`
+    unless $CHILD_STATUS.success?
+      raise(
+        'git diff failed. You may need to set a default branch in .linty_rc.',
+      )
+    end
+    diff
+  end
+
+  def stubs_for_new
+    untracked_names = `git ls-files --others --exclude-standard`.split("\n")
+    untracked_names.map do |name|
+      body = File.read(name)
+      StubFile.new(
+        path: name,
+        blob: body,
+        patch: Patch.from_file_body(body),
+      )
+    end
+  end
+
+  def changed_files
+    files
+  end
+
+  def expected_url_from_path(path)
+    path
+  end
+
+  def as_json(_opts = {})
+    @files.map(&:as_json)
+  end
+
+  def to_json(_opts = {})
+    {
+      files: as_json.select do |file_json|
+        begin
+          JSON.dump(file_json)
+          file_json
+        rescue JSON::GeneratorError
+          puts "Ignoring #{file_json[:path]}, possible binary"
+          nil
+        end
+      end,
+    }.to_json
+  end
+end

data/app/models/patch.rb

@@ -0,0 +1,51 @@
+class Patch
+  RANGE_INFORMATION_LINE = /^@@ .+\+(?<line_number>\d+),/
+  MODIFIED_LINE = /^\+(?!\+|\+)/
+  NOT_REMOVED_LINE = /^[^-]/
+
+  attr_reader :body
+
+  def self.from_file_body(source)
+    lines = source.lines
+    header = "@@ -0,0 +1,#{lines.count} @@\n"
+    body = header + lines.map { |line| "+#{line}"}.join
+    new(body)
+  end
+
+  def initialize(body)
+    @body = body || ''
+  end
+
+  def changed_lines
+    line_number = 0
+
+    lines.each_with_index.inject([]) do |lines, (content, patch_position)|
+      case content
+      when RANGE_INFORMATION_LINE
+        line_number = Regexp.last_match[:line_number].to_i
+      when MODIFIED_LINE
+        line = Line.new(
+          content: content,
+          number: line_number,
+          patch_position: patch_position
+        )
+        lines << line
+        line_number += 1
+      when NOT_REMOVED_LINE
+        line_number += 1
+      end
+
+      lines
+    end
+  end
+
+  def position_for_line_number(line)
+    changed_lines.find { |patch_line| patch_line.number == line }.patch_position
+  end
+
+  private
+
+  def lines
+    @body.lines
+  end
+end

data/app/models/stub_file.rb

@@ -0,0 +1,40 @@
+require_relative './file_like'
+
+# A simple object we can use in place of a GithubFile as a test mock or for
+# debugging
+class StubFile < FileLike
+  attr_accessor :path, :blob
+
+  def self.from_json(json)
+    json = json.symbolize_keys
+    StubFile.new(
+      path: json[:path],
+      blob: json[:blob],
+      patch: Patch.new(json[:patch]),
+    )
+  end
+
+  def initialize(path:, blob:, patch: nil)
+    @path = path
+    @blob = blob
+    @patch = patch
+  end
+
+  def patch_from_blob
+    lines = @blob.lines
+    "@@ -0,0 +1,#{lines.length}\n" +
+    lines.map { |l| "+#{l}" }.join('')
+  end
+
+  def patch
+    @patch || Patch.new(patch_from_blob)
+  end
+
+  def as_json(_opts = {})
+    {
+      path: @path,
+      blob: @blob,
+      patch: patch.body,
+    }
+  end
+end

data/bin/lintron

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require_relative '../lib/lintron'
+
+begin
+  cli = Lintron::CLI.new
+  cli.go
+end

data/lib/lintron.rb

@@ -0,0 +1,7 @@
+require_relative 'lintron/api'
+require_relative 'lintron/cli'
+require_relative 'lintron/terminal_reporter'
+
+# Module for the local lintron gem
+module Lintron
+end

data/lib/lintron/api.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'httparty'
+require 'byebug'
+
+module Lintron
+  # Makes requests to the lintron local lint API
+  class API
+    def initialize(base_url)
+      @base_url = base_url
+    end
+
+    def violations(pr)
+      response = post_lint_request(pr)
+      violations =
+        JSON
+        .parse(response.body)
+        .map { |json| Lintron::ViolationLine.new(json) }
+
+      violations.sort_by(&:file_and_line)
+    rescue JSON::ParserError
+      puts 'Error occurred while parsing response from Lintron'.colorize(:red)
+      puts 'Raw response body: '
+      puts response.body
+    end
+
+    def post_lint_request(pr)
+      HTTParty.post(URI.join(@base_url, 'local_lints'), request_params(pr))
+    end
+
+    def request_params(pr)
+      {
+        body: pr.to_json,
+        headers: {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        },
+      }
+    end
+  end
+
+  # Represents one line of the lint results. Exists so that
+  # (1) We can use dot syntax to access members instead of []
+  # (2) I can define file_and_line which is used for display and sorting
+  class ViolationLine < OpenStruct
+    def file_and_line(padTo = 0)
+      file_and_line = "#{path}:#{format '%03i', line}    "
+
+      if padTo > file_and_line.length
+        file_and_line += ' ' * (padTo - file_and_line.length)
+      end
+
+      file_and_line
+    end
+  end
+end

data/lib/lintron/cli.rb

@@ -0,0 +1,101 @@
+require 'optparse'
+require 'rubygems'
+require 'active_support/all'
+require 'filewatcher'
+require_relative '../../app/models/local_pr_alike'
+
+module Lintron
+  # Handles setting up flags for CLI runs based on defaults, linty_rc, and
+  # command line arguments
+  class CLI
+    def initialize
+      @options = {}
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: linty [options]'
+
+        opts.on('--watch', 'Watch for changes') do |v|
+          @options[:watch] = v
+        end
+      end.parse!
+    end
+
+    def go
+      if config[:watch]
+        go_watch
+      else
+        go_once
+      end
+    end
+
+    def go_watch
+      system('clear')
+      go_once
+
+      watcher.watch do |filename|
+        system('clear')
+        puts "Re-linting because of #{filename}\n\n"
+        go_once
+      end
+    end
+
+    def watcher
+      FileWatcher.new(['*', '**/*'], exclude: config[:watch_exclude])
+    end
+
+    def go_once
+      violations = Lintron::API.new(config[:base_url]).violations(pr)
+      puts Lintron::TerminalReporter.new.format_violations(violations)
+    end
+
+    def pr
+      LocalPrAlike.from_branch(base_branch)
+    end
+
+    def base_branch
+      config[:base_branch]
+    end
+
+    def config
+      defaults
+        .merge(validated_config_from_file)
+        .merge(@options)
+        .merge(
+          {
+            base_branch: ARGV[0],
+          }.compact,
+        )
+    end
+
+    def defaults
+      {
+        base_branch: 'origin/develop',
+        watch_exclude: [
+          '**/*.log',
+          'tmp/**/*',
+        ],
+      }
+    end
+
+    def validated_config_from_file
+      config = config_from_file
+
+      unless config.key?(:base_url)
+        raise('.linty_rc missing required key: base_url')
+      end
+
+      config
+    end
+
+    def config_from_file
+      file_path = File.join(`git rev-parse --show-toplevel`.strip, '.linty_rc')
+
+      raise('.linty_rc is missing.') unless File.exist?(file_path)
+
+      begin
+        JSON.parse(File.read(file_path)).symbolize_keys
+      rescue JSON::ParserError
+        raise('Malformed .linty_rc')
+      end
+    end
+  end
+end

data/lib/lintron/terminal_reporter.rb

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'colorize'
+require 'terminfo'
+
+module Lintron
+  # Outputs lint results on the command line
+  class TerminalReporter
+    def format_violations(violations)
+      row_header_width = violations.map { |v| v.file_and_line.length }.max
+      return no_violations if violations.empty?
+      last_file = violations.first.path
+      buffer = ''
+
+      violations.each do |violation|
+        buffer += do_line(violation, last_file, row_header_width)
+        last_file = violation.path
+      end
+      buffer += "\n\n"
+      buffer
+    end
+
+    def no_violations
+      'No violations found!'.colorize(:green)
+    end
+
+    def do_line(violation, last_file, row_header_width)
+      rule = ''
+      if last_file != violation.path
+        colors.rewind
+        rule += hr
+      end
+
+      file_and_line = violation.file_and_line(row_header_width)
+      rule + wrap_pretty(
+        "#{file_and_line}#{violation['message']}".colorize(colors.next),
+        file_and_line.length,
+      )
+    end
+
+    def hr
+      '-' * TermInfo.screen_size[1] + "\n\n\n"
+    end
+
+    def colors
+      @_colors ||= [:magenta, :cyan].cycle.each
+    end
+
+    def wrap_pretty(string, indent_level)
+      width = TermInfo.screen_size[1] # Get the width of the term
+      buffer = ''
+      words = string.split(/\s/)
+
+      current_word = 0
+      line_length = 0
+      last_line_word = 0
+      while current_word < words.length
+        line_length += words[current_word].length
+        if line_length > width - 5 - indent_level &&
+           current_word > last_line_word
+
+          buffer += "\n"
+          buffer += ' ' * indent_level
+          line_length = indent_level
+          last_line_word = current_word
+        else
+          buffer += words[current_word]
+          buffer += ' '
+          current_word += 1
+        end
+      end
+      buffer + "\n"
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: lintron
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert Prehn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: git_diff_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+description: A command line tool for using the lintron service against local changes
+  (requires a lintron server).
+email: robert@revelry.co
+executables:
+- lintron
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/file_like.rb
+- app/models/local_pr_alike.rb
+- app/models/patch.rb
+- app/models/stub_file.rb
+- bin/lintron
+- lib/lintron.rb
+- lib/lintron/api.rb
+- lib/lintron/cli.rb
+- lib/lintron/terminal_reporter.rb
+homepage: https://github.com/prehnra/lintron
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A CLI for running lintron against your changes.
+test_files: []