ducalis 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b9c876d0a00b147a1b951611b7ad2f0e7c1acfaecdb03f00a76a206e582678b
-  data.tar.gz: 447e6dbfb3ae6d84b6f63234ae66aa7db0741ef463daaca07ed3715bcccdf160
+  metadata.gz: 4558fbf8708c836a3ed1b13c07831f92f02f60a3e428996df38002ba68540440
+  data.tar.gz: b8423308b7ad62219226f0db48bebbcd9bde088f7ba3a938e93c078e914c08ee
 SHA512:
-  metadata.gz: cc5cfd83af5d1754ece8f915ffcf04850f39f167fa79c89845b610c9e1b53835a536479598241d1e81e7559f4265ee04d665073f7190e734acea05c270667d74
-  data.tar.gz: 36ee864dfdd14acc6f941ca5ade14876cff2cfd2a49020d146326010340e9ee7f519c5e36c740f6e46b5323c04a64ab3aeea4fe20277594fa6b5c72c236fff1b
+  metadata.gz: c91904bc9d0a53b0d626e642d4cc86b0436457e20e4d623c530116869dcd34c6df8e41f9447ab3688f3e2c0b4f7866ca300c83f91e5a67587379f1e7676cb14d
+  data.tar.gz: 45307edbf9c217bf7f757b59f3d98e5fec1902a60bb8079c043a4a846d3d653ce301a8de146cd911b74603c80c08a64db524292046b5f0dfdf0fc66567fc3148

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    ducalis (0.8.0)
+    ducalis (0.9.0)
       git (~> 1.3, >= 1.3.0)
-      policial (= 0.0.4)
+      octokit (>= 4.1.0)
       regexp-examples (~> 1.3, >= 1.3.2)
       rubocop (>= 0.45.0)
 
@@ -14,37 +14,17 @@ GEM
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     coderay (1.1.2)
-    coffee-script (2.4.1)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.12.2)
-    coffeelint (1.16.1)
-      coffee-script
-      execjs
-      json
     diff-lcs (1.3)
-    eslintrb (2.1.0)
-      execjs
-      multi_json (>= 1.3)
-      rake
-    execjs (2.7.0)
-    faraday (0.14.0)
+    faraday (0.15.0)
       multipart-post (>= 1.2, < 3)
     git (1.3.0)
-    json (2.1.0)
     method_source (0.9.0)
-    multi_json (1.13.1)
     multipart-post (2.0.0)
-    octokit (4.8.0)
+    octokit (4.6.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.12.1)
     parser (2.5.0.0)
       ast (~> 2.4.0)
-    policial (0.0.4)
-      coffeelint (~> 1.14)
-      eslintrb (~> 2.0)
-      octokit (~> 4.3)
-      rubocop (~> 0.39)
     powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -77,7 +57,7 @@ GEM
     sawyer (0.8.1)
       addressable (>= 2.3.5, < 2.6)
       faraday (~> 0.8, < 1.0)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.3.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -20,37 +20,32 @@ Add this line to your application's `Gemfile`:
 gem 'ducalis'
 ```
 
-There are a lot of variants how you can use __Ducalis__:
+__Ducalis__ is CLI application. By defaukt it will notify you about any possible
+ violations in CLI.
 
-1. As CLI application. In this mode __Ducalis__ will notify you about any
-possible violations in CLI.
 ```
 ducalis
 ducalis app/controllers/
 ```
-As __Ducalis__ allows to pass build even with violations it's make sense to run
+
+__Ducalis__ allows to pass build even with violations it's make sense to run
 __Ducalis__ across current branch or index:
+
 ```
 ducalis --branch
 ducalis --index
 ```
 
-2. As CLI application in CI mode: In this mode __Ducalis__ will notify you about
-any violations in your PR.
+Additionally you can pass `--reporter` argument to notify about found violations
+ in boundaries of PR:
+
 ```
-ducalis --ci --repo="author/repo" --id=3575 --dry
-ducalis --ci --repo="author/repo" --id=3575
-ducalis --ci --adapter=circle # mode for running on CircleCI
+ducalis --reporter "author/repo#42"
+ducalis --reporter "circleci"
 ```
-`--dry` option declares that output will be printed in console, if you will run
-without this option __Ducalis__ will notify about violations in your PR.
-_N.B._ You should provide GITHUB_TOKEN Env to allow __Ducalis__ download your PR
-code and write review comments.
-
-3. As stand-alone server mode: In this mode __Ducalis__ will work as server,
-listen webhooks from GitHub, and notify about any violations in PR. There is a
-`Dockerfile` which you could use to run server for this or run it manually like
-rack application. All related files are located in the `client/` directory.
+
+_N.B._ You should provide `GITHUB_TOKEN` Env to allow __Ducalis__ download your
+PR code and write review comments.
 
 In CLI modes you can provide yours `.ducalis.yml` file based on
 [default](https://github.com/ignat-z/ducalis/blob/master/config/.ducalis.yml) by

data/bin/ducalis

@@ -6,38 +6,38 @@ $LOAD_PATH.unshift("#{__dir__}/../lib")
 require 'ducalis'
 require 'benchmark'
 
-if Ducalis::PassedArgs.help_command?
+cli_arguments = Ducalis::CliArguments.new
+
+if cli_arguments.help_command?
   puts 'You can start Ducalis in the next modes:'
-  puts "     --ci   check files from remote PR. \
-Env `GITHUB_TOKEN` should be available to receive PRs files."
   puts ' --branch   check files in RuboCop style against branch.'
   puts '  --index   check files in RuboCop style against index.'
   puts '    --all   [default] check all files in RuboCop style.'
-  puts ''
+  puts
+  puts 'Use --reporter flag to pass how to report violations'
+  puts '  Ex: ducalis --reporter "user/repo#42"'
+  puts '      ducalis --reporter "circleci"'
 
-  Ducalis::CLI.new(ARGV).start
   exit 0
 end
 
-if ARGV.any? { |arg| arg == '--docs' }
+if cli_arguments.docs_command?
   require 'ducalis/documentation'
+
   File.write(ARGV[1] || 'DOCUMENTATION.md', Documentation.new.call)
+
   exit 0
 end
 
-if Ducalis::PassedArgs.ci_mode?
-  Ducalis::CLI.new(ARGV - %w[--ci]).start
-else
-  Ducalis::PassedArgs.process_args!
+cli_arguments.process!
 
-  result = 0
-  cli = RuboCop::CLI.new
-  time = Benchmark.realtime do
-    result = cli.run
-  end
-
-  puts "Finished in #{time} seconds" if cli.options[:debug]
-  puts "\033[42mBuild still green. Nothing to worry about\033[0m" if result == 1
+result = 0
+cli = RuboCop::CLI.new
+time = Benchmark.realtime do
+  result = cli.run
 end
 
+puts "Finished in #{time} seconds" if cli.options[:debug]
+puts "\033[32mBuild still green. Nothing to worry about\033[0m" if result == 1
+
 exit 0

data/ducalis.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 
   spec.add_dependency 'git', '~> 1.3', '>= 1.3.0'
-  spec.add_dependency 'policial', '0.0.4'
+  spec.add_dependency 'octokit', '>= 4.1.0'
   spec.add_dependency 'regexp-examples', '~> 1.3', '>= 1.3.2'
   spec.add_dependency 'rubocop', '>= 0.45.0'
 end

data/lib/ducalis.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'parser/current'
-require 'policial'
+require 'rubocop'
 
 module Ducalis
   DOTFILE = '.ducalis.yml'.freeze
@@ -10,41 +9,41 @@ module Ducalis
 end
 
 require 'ducalis/version'
+require 'ducalis/errors'
 
-require 'ducalis/adapters/base'
 require 'ducalis/adapters/circle_ci'
-require 'ducalis/adapters/custom'
-require 'ducalis/adapters/pull_request'
+require 'ducalis/adapters/default'
 
-require 'ducalis/commentators/console'
-require 'ducalis/commentators/github'
-
-require 'ducalis/cli'
-require 'ducalis/passed_args'
-require 'ducalis/runner'
-require 'ducalis/utils'
-
-require 'ducalis/patched_rubocop/diffs'
 require 'ducalis/patched_rubocop/ducalis_config_loader'
-require 'ducalis/patched_rubocop/git_files_access'
 require 'ducalis/patched_rubocop/git_runner'
 require 'ducalis/patched_rubocop/git_turget_finder'
-require 'ducalis/patched_rubocop/rubo_cop'
+require 'ducalis/patched_rubocop/inject'
+require 'ducalis/patched_rubocop/cop_cast'
+
+require 'ducalis/commentators/github'
+require 'ducalis/github_formatter'
+
+require 'ducalis/utils'
+require 'ducalis/diffs'
+require 'ducalis/rubo_cop'
+require 'ducalis/cli_arguments'
+require 'ducalis/patch'
+require 'ducalis/git_access'
 
-require 'ducalis/cops/extensions/type_resolving'
 require 'ducalis/cops/black_list_suffix'
 require 'ducalis/cops/callbacks_activerecord'
 require 'ducalis/cops/case_mapping'
 require 'ducalis/cops/controllers_except'
 require 'ducalis/cops/data_access_objects'
 require 'ducalis/cops/descriptive_block_names'
+require 'ducalis/cops/enforce_namespace'
+require 'ducalis/cops/evlis_overusing'
+require 'ducalis/cops/extensions/type_resolving'
 require 'ducalis/cops/fetch_expression'
-require 'ducalis/cops/only_defs'
 require 'ducalis/cops/keyword_defaults'
 require 'ducalis/cops/module_like_class'
 require 'ducalis/cops/multiple_times'
-require 'ducalis/cops/evlis_overusing'
-require 'ducalis/cops/enforce_namespace'
+require 'ducalis/cops/only_defs'
 require 'ducalis/cops/options_argument'
 require 'ducalis/cops/params_passing'
 require 'ducalis/cops/possible_tap'
@@ -62,7 +61,3 @@ require 'ducalis/cops/too_long_workers'
 require 'ducalis/cops/uncommented_gem'
 require 'ducalis/cops/unlocked_gem'
 require 'ducalis/cops/useless_only'
-
-require 'ducalis/cops/extensions/rubocop_cast'
-
-RuboCop::Cop::Cop.prepend(RubocopCast)

data/lib/ducalis/adapters/circle_ci.rb

@@ -1,22 +1,32 @@
 # frozen_string_literal: true
 
-module Ducalis
-  module Adapters
-    class CircleCi < Base
-      def repo
-        @repo ||= ENV.fetch('CIRCLE_REPOSITORY_URL')
-                     .sub('https://github.com/', '')
-                     .sub('git@github.com:', '')
-                     .sub('.git', '')
-      end
+module Adapters
+  class CircleCI
+    CODE = 'circleci'.freeze
 
-      def id
-        @id ||= ENV.fetch('CI_PULL_REQUEST').split('/').last
-      end
+    def self.suitable_for?(value)
+      value == CODE
+    end
+
+    def initialize(_value); end
+
+    def call
+      [repo, id]
+    end
+
+    private
+
+    def repo
+      @repo ||= ENV.fetch('CIRCLE_REPOSITORY_URL')
+                   .sub('https://github.com/', '')
+                   .sub('git@github.com:', '')
+                   .sub('.git', '')
+    end
 
-      def sha
-        @sha ||= ENV.fetch('CIRCLE_SHA1')
-      end
+    def id
+      @id   ||= ENV.fetch('CI_PULL_REQUEST')
+                   .split('/')
+                   .last
     end
   end
 end

data/lib/ducalis/adapters/default.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Adapters
+  class Default
+    def self.suitable_for?(_value)
+      true
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def call
+      @value.split('#')
+    end
+  end
+end

data/lib/ducalis/cli_arguments.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Ducalis
+  class CliArguments
+    ADAPTERS = [
+      Adapters::CircleCI,
+      Adapters::Default
+    ].freeze
+
+    HELP_FLAGS   = %w[-h -? --help].freeze
+    FORMATTER    = %w[--format GithubFormatter].freeze
+    DOCS_ARG     = :docs
+    REPORTER_ARG = :reporter
+
+    def docs_command?
+      ARGV.any? { |arg| arg == to_key(DOCS_ARG) }
+    end
+
+    def help_command?
+      ARGV.any? { |arg| HELP_FLAGS.include?(arg) }
+    end
+
+    def process!
+      detect_git_mode!
+      detect_reporter!
+    end
+
+    private
+
+    def detect_reporter!
+      reporter_index = ARGV.index(to_key(REPORTER_ARG)) || return
+      reporter = ARGV[reporter_index + 1]
+      [to_key(REPORTER_ARG), reporter].each { |arg| ARGV.delete(arg) }
+      ARGV.push(*FORMATTER)
+      GitAccess.instance.store_pull_request!(find_pull_request(reporter))
+    end
+
+    def detect_git_mode!
+      git_mode = GitAccess::MODES.keys.find do |mode|
+        ARGV.include?(to_key(mode))
+      end
+      return unless git_mode
+      ARGV.delete(to_key(git_mode))
+      GitAccess.instance.flag = git_mode
+    end
+
+    def find_pull_request(value)
+      ADAPTERS.find { |adapter| adapter.suitable_for?(value) }.new(value).call
+    end
+
+    def to_key(key)
+      "--#{key}"
+    end
+  end
+end

data/lib/ducalis/commentators/github.rb

@@ -6,29 +6,31 @@ module Ducalis
       STATUS = 'COMMENT'.freeze
       SIMILARITY_THRESHOLD = 0.8
 
-      def initialize(config)
-        @config = config
+      def initialize(repo, id)
+        @repo = repo
+        @id = id
       end
 
-      def call(violations)
-        comments = violations.map do |violation|
-          next if commented?(violation)
-          generate_comment(violation)
-        end.compact
+      def call(offenses)
+        comments = offenses.reject { |offense| already_commented?(offense) }
+                           .map { |offense| present_offense(offense) }
+
         return if comments.empty?
+
         Utils.octokit
-             .create_pull_request_review(@config.repo, @config.id,
+             .create_pull_request_review(@repo, @id,
                                          event: STATUS, comments: comments)
       end
 
       private
 
-      def commented?(violation)
-        commented_violations.find do |commented_violation|
+      def already_commented?(offense)
+        current_offence = present_offense(offense)
+        commented_offenses.find do |commented_offense|
           [
-            violation.filename == commented_violation[:path],
-            violation.line.patch_position == commented_violation[:position],
-            similar_messages?(violation.message, commented_violation[:body])
+            current_offence[:path] == commented_offense[:path],
+            current_offence[:position] == commented_offense[:position],
+            similar_messages?(current_offence[:body], commented_offense[:body])
           ].all?
         end
       end
@@ -38,18 +40,21 @@ module Ducalis
           Utils.similarity(message, body) > SIMILARITY_THRESHOLD
       end
 
-      def commented_violations
-        @commented_violations ||=
-          Utils.octokit.pull_request_comments(@config.repo, @config.id)
-      end
-
-      def generate_comment(violation)
+      def present_offense(offense)
         {
-          body: violation.message,
-          path: violation.filename,
-          position: violation.line.patch_position
+          body: offense.message,
+          path: diff_for(offense).path,
+          position: diff_for(offense).patch_line(offense.line)
         }
       end
+
+      def diff_for(offense)
+        GitAccess.instance.for(offense.location.source_buffer.name)
+      end
+
+      def commented_offenses
+        @_commented_offenses ||= Utils.octokit.pull_request_comments(@repo, @id)
+      end
     end
   end
 end

data/lib/ducalis/diffs.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Diffs
+  class BaseDiff
+    attr_reader :diff, :path
+
+    def initialize(diff, path)
+      @diff = diff
+      @path = path
+    end
+  end
+
+  class NilDiff < BaseDiff
+    def changed?(*)
+      true
+    end
+
+    def patch_line(*)
+      -1
+    end
+  end
+
+  class GitDiff < BaseDiff
+    def changed?(changed_line)
+      patch.line_for(changed_line).changed?
+    end
+
+    def patch_line(changed_line)
+      patch.line_for(changed_line).patch_position
+    end
+
+    private
+
+    def patch
+      Ducalis::Patch.new(diff.patch)
+    end
+  end
+
+  private_constant :BaseDiff, :NilDiff, :GitDiff
+end

data/lib/ducalis/errors.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ducalis
+  class MissingGit < ::StandardError
+    MESSAGE = "Can't find .git folder.".freeze
+
+    def initialize(msg = MESSAGE)
+      super
+    end
+  end
+
+  class MissingToken < ::StandardError
+    MESSAGE = 'You should provide token in order to interact with GitHub'.freeze
+
+    def initialize(msg = MESSAGE)
+      super
+    end
+  end
+end

data/lib/ducalis/git_access.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'git'
+require 'singleton'
+
+class GitAccess
+  DELETED = 'deleted'.freeze
+  GIT_DIR = '.git'.freeze
+
+  MODES = {
+    branch: ->(git) { git.diff('origin/master') },
+    index:  ->(git) { git.diff('HEAD') }
+  }.freeze
+
+  include Diffs
+  include Singleton
+
+  attr_accessor :flag, :repo, :id
+
+  def store_pull_request!(repo, id)
+    self.repo = repo
+    self.id = id
+  end
+
+  def changed_files
+    changes.map(&:path)
+  end
+
+  def for(path)
+    find(path)
+  end
+
+  private
+
+  def under_git?
+    @_under_git ||= Dir.exist?(File.join(Dir.pwd, GIT_DIR))
+  end
+
+  def changes
+    return default_value if flag.nil? || !under_git?
+    @_changes ||= patch_diffs
+  end
+
+  def patch_diffs
+    MODES.fetch(flag)
+         .call(Git.open(Dir.pwd))
+         .reject { |diff| diff.type == DELETED }
+         .select { |diff| File.exist?(diff.path) }
+         .map    { |diff| GitDiff.new(diff, diff.path) }
+  end
+
+  def default_value
+    raise MissingGit unless flag.nil?
+    []
+  end
+
+  def find(path)
+    return NilDiff.new(nil, path) if changes.empty?
+    changes.find { |diff| diff.path == path }
+  end
+end

data/lib/ducalis/github_formatter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class GithubFormatter < RuboCop::Formatter::BaseFormatter
+  def started(_target_files)
+    @all = []
+  end
+
+  def file_finished(_file, offenses)
+    print '.'
+    @all << offenses unless offenses.empty?
+  end
+
+  def finished(_inspected_files)
+    print "\n"
+    Ducalis::Commentators::Github.new(
+      GitAccess.instance.repo,
+      GitAccess.instance.id
+    ).call(@all.flatten)
+  end
+end

data/lib/ducalis/patch.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Ducalis
+  class Patch
+    RANGE_LINE = /^@@ .+\+(?<line_number>\d+),/
+    MODIFIED_LINE = /^\+(?!\+|\+)/
+    NOT_REMOVED_LINE = /^[^-]/
+    ANY_LINE = /.*/
+
+    DIFF_LINES = {
+      RANGE_LINE => lambda do |lines, _line_number, line, _position|
+        [lines, line.match(RANGE_LINE)[:line_number].to_i]
+      end,
+      MODIFIED_LINE => lambda do |lines, line_number, line, position|
+        [lines + [Line.new(line_number, line, position)], line_number + 1]
+      end,
+      NOT_REMOVED_LINE => lambda do |lines, line_number, _line, _position|
+        [lines, line_number + 1]
+      end,
+      ANY_LINE => lambda do |lines, line_number, _line, _position|
+        [lines, line_number]
+      end
+    }.freeze
+
+    def initialize(patch)
+      diff_only = patch[patch.match(RANGE_LINE).begin(0)..-1]
+      @patch_lines = diff_only.lines.to_enum.with_index
+    end
+
+    def line_for(line_number)
+      changed_lines.detect do |line|
+        line.number == line_number
+      end || UnchangedLine.new
+    end
+
+    private
+
+    attr_reader :patch_lines
+
+    def changed_lines
+      patch_lines.inject([[], 0]) do |(lines, line_number), (line, position)|
+        _regex, action = DIFF_LINES.find { |regex, _action| line =~ regex }
+        action.call(lines, line_number, line, position)
+      end.first
+    end
+  end
+
+  class UnchangedLine
+    def initialize(*); end
+
+    def patch_position
+      -1
+    end
+
+    def changed?
+      false
+    end
+  end
+
+  class Line
+    attr_reader :number, :content, :patch_position
+
+    def initialize(number, content, patch_position)
+      @number = number
+      @content = content
+      @patch_position = patch_position
+    end
+
+    def changed?
+      true
+    end
+  end
+  private_constant :Line, :UnchangedLine
+end

data/lib/ducalis/patched_rubocop/cop_cast.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PatchedRubocop
+  module CopCast
+    def add_offense(node, loc, message = nil, severity = nil)
+      if PatchedRubocop::CURRENT_VERSION > PatchedRubocop::ADAPTED_VERSION
+        super(node, location: loc, message: message, severity: severity)
+      else
+        super(node, loc, message, severity)
+      end
+    end
+  end
+end

data/lib/ducalis/patched_rubocop/git_runner.rb

@@ -5,7 +5,7 @@ module PatchedRubocop
     def inspect_file(file)
       offenses, updated = super
       offenses = offenses.select do |offense|
-        GitFilesAccess.instance.changed?(file.path, offense.line)
+        GitAccess.instance.for(file.path).changed?(offense.line)
       end
 
       [offenses, updated]

data/lib/ducalis/patched_rubocop/git_turget_finder.rb

@@ -3,8 +3,8 @@
 module PatchedRubocop
   module GitTurgetFinder
     def find_files(base_dir, flags)
-      replacement = GitFilesAccess.instance.changes
-      return replacement.map(&:full_path) unless replacement.empty?
+      replacement = GitAccess.instance.changed_files
+      return replacement unless replacement.empty?
       super
     end
   end

data/lib/ducalis/patched_rubocop/inject.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PatchedRubocop
+  module Inject
+    PATH = Ducalis::DEFAULT_FILE.to_s
+
+    def self.defaults!
+      hash = RuboCop::ConfigLoader.send(:load_yaml_configuration, PATH)
+      config = RuboCop::Config.new(hash, PATH)
+      puts "configuration from #{PATH}" if RuboCop::ConfigLoader.debug?
+      config = RuboCop::ConfigLoader.merge_with_default(config, PATH)
+      RuboCop::ConfigLoader
+        .instance_variable_set(:@default_configuration, config)
+    end
+  end
+end

data/lib/ducalis/{patched_rubocop/rubo_cop.rb → rubo_cop.rb}

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+module PatchedRubocop
+  CURRENT_VERSION = Gem::Version.new(RuboCop::Version.version)
+  ADAPTED_VERSION = Gem::Version.new('0.46.0')
+end
+
 module RuboCop
   class ConfigLoader
     ::Ducalis::Utils.silence_warnings { DOTFILE = ::Ducalis::DOTFILE }
@@ -25,16 +30,5 @@ module RuboCop
   end
 end
 
-module PatchedRubocop
-  MODES = {
-    branch: ->(git)  { git.diff('origin/master') },
-    index:  ->(git)  { git.diff('HEAD') },
-    all:    ->(_git) { [] }
-  }.freeze
-
-  module_function
-
-  def configure!(flag)
-    GitFilesAccess.instance.flag = flag
-  end
-end
+RuboCop::Cop::Cop.prepend(PatchedRubocop::CopCast)
+PatchedRubocop::Inject.defaults!

data/lib/ducalis/utils.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+require 'octokit'
+
 module Ducalis
   module Utils
     module_function
 
     def octokit
-      @octokit ||= Octokit::Client.new(access_token: ENV.fetch('GITHUB_TOKEN'))
+      @octokit ||= begin
+        token = ENV.fetch('GITHUB_TOKEN') { raise MissingToken }
+        Octokit::Client.new(access_token: token)
+      end
     end
 
     def similarity(string1, string2)

data/lib/ducalis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ducalis
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducalis
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ignat Zakrevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-05 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: policial
+  name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: regexp-examples
   requirement: !ruby/object:Gem::Requirement
@@ -104,12 +104,9 @@ files:
 - config/.ducalis.yml
 - ducalis.gemspec
 - lib/ducalis.rb
-- lib/ducalis/adapters/base.rb
 - lib/ducalis/adapters/circle_ci.rb
-- lib/ducalis/adapters/custom.rb
-- lib/ducalis/adapters/pull_request.rb
-- lib/ducalis/cli.rb
-- lib/ducalis/commentators/console.rb
+- lib/ducalis/adapters/default.rb
+- lib/ducalis/cli_arguments.rb
 - lib/ducalis/commentators/github.rb
 - lib/ducalis/cops/black_list_suffix.rb
 - lib/ducalis/cops/callbacks_activerecord.rb
@@ -119,7 +116,6 @@ files:
 - lib/ducalis/cops/descriptive_block_names.rb
 - lib/ducalis/cops/enforce_namespace.rb
 - lib/ducalis/cops/evlis_overusing.rb
-- lib/ducalis/cops/extensions/rubocop_cast.rb
 - lib/ducalis/cops/extensions/type_resolving.rb
 - lib/ducalis/cops/fetch_expression.rb
 - lib/ducalis/cops/keyword_defaults.rb
@@ -143,15 +139,18 @@ files:
 - lib/ducalis/cops/uncommented_gem.rb
 - lib/ducalis/cops/unlocked_gem.rb
 - lib/ducalis/cops/useless_only.rb
+- lib/ducalis/diffs.rb
 - lib/ducalis/documentation.rb
-- lib/ducalis/passed_args.rb
-- lib/ducalis/patched_rubocop/diffs.rb
+- lib/ducalis/errors.rb
+- lib/ducalis/git_access.rb
+- lib/ducalis/github_formatter.rb
+- lib/ducalis/patch.rb
+- lib/ducalis/patched_rubocop/cop_cast.rb
 - lib/ducalis/patched_rubocop/ducalis_config_loader.rb
-- lib/ducalis/patched_rubocop/git_files_access.rb
 - lib/ducalis/patched_rubocop/git_runner.rb
 - lib/ducalis/patched_rubocop/git_turget_finder.rb
-- lib/ducalis/patched_rubocop/rubo_cop.rb
-- lib/ducalis/runner.rb
+- lib/ducalis/patched_rubocop/inject.rb
+- lib/ducalis/rubo_cop.rb
 - lib/ducalis/utils.rb
 - lib/ducalis/version.rb
 homepage: https://github.com/ignat-z/ducalis

data/lib/ducalis/adapters/base.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Ducalis
-  module Adapters
-    class Base
-      attr_reader :options
-
-      def initialize(options)
-        @options = options
-      end
-
-      def dry?
-        @dry ||= @options.fetch(:dry, false)
-      end
-    end
-  end
-end

data/lib/ducalis/adapters/custom.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Ducalis
-  module Adapters
-    class Custom < Base
-      def repo
-        @repo ||= options.fetch(:repo)
-      end
-
-      def id
-        @id ||= options.fetch(:id)
-      end
-
-      def sha
-        @sha ||= options.fetch(:sha) do
-          Utils.octokit.pull_request(repo, id).head.sha
-        end
-      end
-    end
-  end
-end

data/lib/ducalis/adapters/pull_request.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Ducalis
-  module Adapters
-    class PullRequest < Base
-      def repo
-        @repo ||= attributes[:repo]
-      end
-
-      def id
-        @id ||= attributes[:number]
-      end
-
-      def sha
-        @sha ||= attributes[:head_sha]
-      end
-
-      private
-
-      def attributes
-        @attributes ||= Policial::PullRequestEvent.new(options)
-                                                  .pull_request_attributes
-      end
-    end
-  end
-end

data/lib/ducalis/cli.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require 'optparse'
-
-module Ducalis
-  class CLI
-    ADAPTERS = {
-      circle: Adapters::CircleCi,
-      custom: Adapters::Custom
-    }.freeze
-    DEFAULT_ADAPTER = ADAPTERS.keys.last
-
-    def initialize(arguments)
-      @arguments = arguments
-      @options   = {}
-      @parser    = OptionParser.new
-      configure_parser!
-    end
-
-    def start
-      @parser.parse(@arguments)
-      Runner.new(adapter.new(@options)).call
-    end
-
-    private
-
-    def adapter
-      ADAPTERS.fetch(@options.fetch(:adapter, DEFAULT_ADAPTER)) do
-        raise "Unsupported adapter #{@options[:adapter]}"
-      end
-    end
-
-    def configure_parser!
-      @parser.banner = 'Usage: ducalis --ci --adapter=ADAPTER'
-      adapter_option_parsing
-      id_option_parsing
-      repo_option_parsing
-      sha_option_parsing
-      dry_option_parsing
-      help_command
-    end
-
-    def help_command
-      @parser.on_tail('--help', 'Show this message') do
-        puts @parser
-        RuboCop::CLI.new.run(@arguments)
-      end
-    end
-
-    def adapter_option_parsing
-      @parser.on(
-        '--adapter=ADAPTER',
-        'Describes how Ducalis will receive PR information. Default: custom'
-      ) do |adapter|
-        @options[:adapter] = adapter.to_sym
-      end
-    end
-
-    def id_option_parsing
-      @parser.on(
-        '--id=N',
-        'PR id, ex: 2347'
-      ) do |id|
-        @options[:id] = id
-      end
-    end
-
-    def repo_option_parsing
-      @parser.on(
-        '--repo=REPO',
-        'PR repository, ex: author/repo'
-      ) do |repo|
-        @options[:repo] = repo
-      end
-    end
-
-    def sha_option_parsing
-      @parser.on(
-        '--sha=SHA',
-        'Starting commit, can be omitted'
-      ) do |sha|
-        @options[:sha] = sha
-      end
-    end
-
-    def dry_option_parsing
-      @options[:dry] = false # default
-      @parser.on(
-        '--dry',
-        'Allows user to run dry mode, default: false'
-      ) do |_dry|
-        @options[:dry] = true
-      end
-    end
-  end
-end

data/lib/ducalis/commentators/console.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'logger'
-
-module Ducalis
-  module Commentators
-    class Console
-      DOCUMENTATION_PATH = 'https://ducalis-rb.github.io/'.freeze
-
-      def initialize(config)
-        @config = config
-      end
-
-      def call(violations)
-        violations.each do |violation|
-          logger.info(generate_message(violation))
-        end
-      end
-
-      private
-
-      def generate_message(violation)
-        [
-          [cyan(violation.filename), violation.line.patch_position].join(':'),
-          brown(violation.linter),
-          bold(ancor(violation))
-        ].join(' ')
-      end
-
-      def logger
-        @logger ||= Logger.new(STDOUT).tap do |logger|
-          logger.formatter = proc do |_severity, _datetime, _progname, msg|
-            "#{msg}\n"
-          end
-        end
-      end
-
-      def ancor(violation)
-        [
-          DOCUMENTATION_PATH,
-          '#',
-          violation.linter.downcase.gsub(/[^[:alpha:]]/, '')
-        ].join
-      end
-
-      def bold(text)
-        "\e[1m#{text}\e[22m"
-      end
-
-      def brown(text)
-        "\e[33m#{text}\e[0m"
-      end
-
-      def cyan(text)
-        "\e[36m#{text}\e[0m"
-      end
-    end
-  end
-end

data/lib/ducalis/cops/extensions/rubocop_cast.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubocopCast
-  OLD_RUBOCOP_VERSION = Gem::Version.new('0.46.0')
-
-  def add_offense(node, loc, message = nil, severity = nil)
-    if Gem::Version.new(RuboCop::Version.version) > OLD_RUBOCOP_VERSION
-      super(node, location: loc, message: message, severity: severity)
-    else
-      super(node, loc, message, severity)
-    end
-  end
-end

data/lib/ducalis/passed_args.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Ducalis
-  module PassedArgs
-    module_function
-
-    HELP_FLAGS = ['-h', '-?', '--help'].freeze
-
-    def help_command?
-      ARGV.any? { |arg| HELP_FLAGS.include?(arg) }
-    end
-
-    def ci_mode?
-      ARGV.any? { |arg| arg == '--ci' }
-    end
-
-    def process_args!
-      flag = PatchedRubocop::MODES.keys
-                                  .map { |key| key if ARGV.delete("--#{key}") }
-                                  .find { |possible_flag| !possible_flag.nil? }
-      PatchedRubocop.configure!(flag || :all)
-    end
-  end
-end

data/lib/ducalis/patched_rubocop/diffs.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module PatchedRubocop
-  module Diffs
-    class BaseDiff
-      attr_reader :full_path, :diff
-
-      def initialize(full_path, diff)
-        @full_path = full_path
-        @diff = diff
-      end
-    end
-
-    class NilDiff < BaseDiff
-      def changed?(*)
-        true
-      end
-    end
-
-    class GitDiff < BaseDiff
-      def changed?(changed_line)
-        (Policial::Patch.new(diff.patch).changed_lines.detect do |line|
-          line.number == changed_line
-        end || Policial::UnchangedLine.new).changed?
-      end
-    end
-
-    private_constant :BaseDiff, :NilDiff, :GitDiff
-  end
-end

data/lib/ducalis/patched_rubocop/git_files_access.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'git'
-require 'singleton'
-
-module PatchedRubocop
-  class GitFilesAccess
-    DELETED = 'deleted'.freeze
-
-    include PatchedRubocop::Diffs
-    include Singleton
-
-    attr_accessor :flag
-
-    def initialize
-      @dir = Dir.pwd
-      @git = Git.open(@dir)
-    end
-
-    def changes
-      @changes ||= MODES.fetch(@flag)
-                        .call(@git)
-                        .map { |diff| GitDiff.new(full_path(diff.path), diff) }
-                        .reject { |diff| diff.diff.type == DELETED }
-    end
-
-    def changed?(path, line)
-      find(path).changed?(line)
-    end
-
-    private
-
-    def full_path(path)
-      [@dir, path].join('/')
-    end
-
-    def find(path)
-      return NilDiff.new(full_path(path), nil) if changes.empty?
-      changes.find { |x| x.full_path == path }
-    end
-  end
-end

data/lib/ducalis/runner.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Policial
-  class ConfigLoader
-    def raw(filename)
-      File.read(filename)
-    end
-  end
-end
-
-module Ducalis
-  class Runner
-    def initialize(config)
-      @config = config
-      configure
-    end
-
-    def call
-      detective = Policial::Detective.new(Utils.octokit)
-      detective.brief(commit_info)
-      detective.investigate(ruby: { config_file: Ducalis::DEFAULT_FILE })
-      commentator.new(config).call(detective.violations)
-    end
-
-    private
-
-    attr_reader :config
-
-    def commit_info
-      { repo: config.repo, number: config.id, head_sha: config.sha }
-    end
-
-    def configure
-      Octokit.auto_paginate = true
-      # Style guides were changed to linters in `policial` upstream
-      if Policial.respond_to?(:linters)
-        Policial.linters = [Policial::Linters::Ruby]
-      else
-        Policial.style_guides = [Policial::StyleGuides::Ruby]
-      end
-    end
-
-    def commentator
-      @commentator ||=
-        config.dry? ? Commentators::Console : Commentators::Github
-    end
-  end
-end