rubocop-git 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e847268b1ab1d8961bb6afed3402f75cbc1abf60
+  data.tar.gz: 713c38e0742d3793d6234ab0ac8d971b3b821cae
+SHA512:
+  metadata.gz: 3ab7b0885da47ed39deb523fa5dbd7daac6b406b9ebf260982120fa071b8c340eca530e032a04ad959cd61cf1a4ae9d98913d0bb0126fcd87b4d0df5c93508f5
+  data.tar.gz: c3016b240f51a4645938202dc43c955ef91e95847d6881742bce4baca3ef7c6e9c11068ea005f94d6772f7266ebe7b6ad32f44315b85e5e8ad65afd5259e4f38

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Masaki Takeuchi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights 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 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.
+
+Some code is:
+Copyright (c) 2014 thoughtbot, inc.
+Released under the MIT License in Hound, https://github.com/thoughtbot/hound

data/README.md

@@ -0,0 +1,34 @@
+# RuboCop::Git
+
+RuboCop for git diff.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubocop-git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-git
+
+## Usage
+
+    Usage: rubocop-git [options]
+        -c, --config FILE                Specify configuration file
+        -D, --display-cop-names          Display cop names in offense messages
+            --cached                     git diff --cached
+            --staged                     synonym of --cached
+            --hound                      Hound compatibility mode (require rubocop 0.22.0)
+
+## Contributing
+
+1. Fork it ( https://github.com/m4i/rubocop-git/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/rubocop-git

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rubocop/git/cli'
+
+RuboCop::Git::CLI.new.run

data/hound.yml

@@ -0,0 +1,242 @@
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+AccessorMethodName:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 80
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%': '{}'
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false

data/lib/rubocop/git.rb

@@ -0,0 +1,24 @@
+require 'rubocop/git/version'
+require 'rubocop'
+
+if defined?(Rubocop)
+  # rubocop 0.22.0
+  RuboCop::Formatter = Rubocop::Formatter
+else
+  # rubocop >= 0.23.0
+  Rubocop = RuboCop
+end
+
+module RuboCop
+  module Git
+    autoload :CommitFile,        'rubocop/git/commit_file'
+    autoload :FileViolation,     'rubocop/git/file_violation'
+    autoload :Line,              'rubocop/git/line'
+    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'
+  end
+end

data/lib/rubocop/git/cli.rb

@@ -0,0 +1,49 @@
+require 'rubocop/git'
+require 'optparse'
+
+module RuboCop
+  module Git
+    class CLI
+      def run(args = ARGV)
+        options = parse_arguments(args)
+        Runner.new.run(options)
+      end
+
+      private
+
+      def parse_arguments(args)
+        options = {}
+
+        OptionParser.new do |opt|
+          opt.on('-c', '--config FILE',
+                 'Specify configuration file') do |config|
+            options[:config] = config
+          end
+
+          opt.on('-D', '--display-cop-names',
+                 'Display cop names in offense messages') do
+            options[:rubocop] ||= {}
+            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 (require rubocop 0.22.0)') do
+            options[:hound] = true
+          end
+
+          opt.parse(args)
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/rubocop/git/commit_file.rb

@@ -0,0 +1,45 @@
+module RuboCop::Git
+# copy from https://github.com/thoughtbot/hound/blob/be2dd34/app/models/commit_file.rb
+class CommitFile
+  attr_reader :contents
+
+  def initialize(file, contents)
+    @file = file
+    @contents = contents
+  end
+
+  def filename
+    @file.filename
+  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/file_violation.rb

@@ -0,0 +1,5 @@
+module RuboCop::Git
+# ref. https://github.com/thoughtbot/hound/blob/be2dd34/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/be2dd34/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/patch.rb

@@ -0,0 +1,36 @@
+module RuboCop::Git
+# copy from https://github.com/thoughtbot/hound/blob/be2dd34/app/models/patch.rb
+class Patch
+  RANGE_INFORMATION_LINE = /^@@ .+\+(?<line_number>\d+),/
+  MODIFIED_LINE = /^\+(?!\+|\+)/
+  NOT_REMOVED_LINE = /^[^-]/
+
+  def initialize(body)
+    @body = body || ''
+  end
+
+  def additions
+    line_number = 0
+
+    lines.each_with_index.inject([]) 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
+
+  private
+
+  def lines
+    @body.lines
+  end
+end
+end

data/lib/rubocop/git/pseudo_pull_request.rb

@@ -0,0 +1,42 @@
+require 'shellwords'
+
+module RuboCop
+  module Git
+    # ref. https://github.com/thoughtbot/hound/blob/be2dd34/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, file_contents(file.filename))
+      end
+
+      def file_contents(filename)
+        if @options[:cached]
+          `git show :#{filename.shellescape}`
+        else
+          File.read(filename)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/git/pseudo_resource.rb

@@ -0,0 +1,6 @@
+module RuboCop
+  module Git
+    class PseudoResource < Struct.new(:filename, :status, :patch)
+    end
+  end
+end

data/lib/rubocop/git/runner.rb

@@ -0,0 +1,89 @@
+module RuboCop
+  module Git
+    # ref. https://github.com/thoughtbot/hound/blob/be2dd34/app/services/build_runner.rb
+    class Runner
+      DEFAULT_CONFIG_FILE = '.rubocop.yml'
+      HOUND_DEFAULT_CONFIG_FILE =
+        File.expand_path('../../../../hound.yml', __FILE__)
+
+      def run(options)
+        if options[:hound] && RuboCop::Version.version != '0.22.0'
+          warn 'Hound compatibility mode require rubocop 0.22.0'
+          exit 1
+        end
+
+        @options = options
+        @files = parse_diff(git_diff(options[:cached]))
+
+        display_violations($stdout)
+      end
+
+      private
+
+      def violations
+        @violations ||= style_checker.violations
+      end
+
+      def style_checker
+        StyleChecker.new(pull_request.pull_request_files,
+                         @options[:rubocop],
+                         config_path,
+                         pull_request.config)
+      end
+
+      def pull_request
+        @pull_request ||= PseudoPullRequest.new(@files, @options)
+      end
+
+      def git_diff(cached)
+        if cached
+          `git diff --diff-filter=AMCR --cached --find-renames --find-copies`
+        else
+          `git diff --diff-filter=AM`
+        end
+      end
+
+      def parse_diff(diff)
+        files    = []
+        in_patch = false
+
+        diff.each_line do |line|
+          case line
+          when /^diff --git/
+            in_patch = false
+          when %r{^\+{3} b/([^\t\n\r]+)}
+            files << PseudoResource.new($1, 'modified', '')
+          when /^@@/
+            in_patch = true
+          end
+
+          files.last.patch << line if in_patch
+        end
+
+        files
+      end
+
+      def config_path
+        if @options[:hound]
+          HOUND_DEFAULT_CONFIG_FILE
+        else
+          @options[:config] || DEFAULT_CONFIG_FILE
+        end
+      end
+
+      def display_violations(io)
+        formatter = RuboCop::Formatter::ClangStyleFormatter.new(io)
+        formatter.started(nil)
+
+        violations.map do |violation|
+          formatter.file_finished(
+            violation.filename,
+            violation.offenses.compact.sort.freeze
+          )
+        end
+
+        formatter.finished(@files.map(&:filename).freeze)
+      end
+    end
+  end
+end

data/lib/rubocop/git/style_checker.rb

@@ -0,0 +1,43 @@
+module RuboCop::Git
+# ref. https://github.com/thoughtbot/hound/blob/be2dd34/app/models/style_checker.rb
+class StyleChecker
+  def initialize(modified_files,
+                 rubocop_options,
+                 config_path,
+                 custom_config = nil)
+    @modified_files = modified_files
+    @rubocop_options = rubocop_options
+    @config_path = config_path
+    @custom_config = custom_config
+  end
+
+  def violations
+    file_violations = @modified_files.map do |modified_file|
+      FileViolation.new(modified_file.filename, offenses(modified_file))
+    end
+
+    file_violations.select do |file_violation|
+      file_violation.offenses.any?
+    end
+  end
+
+  private
+
+  def offenses(modified_file)
+    violations = style_guide.violations(modified_file)
+    violations_on_changed_lines(modified_file, violations)
+  end
+
+  def violations_on_changed_lines(modified_file, violations)
+    violations.select do |violation|
+      modified_file.relevant_line?(violation.line)
+    end
+  end
+
+  def style_guide
+    @style_guide ||= StyleGuide.new(@rubocop_options,
+                                    @config_path,
+                                    @custom_config)
+  end
+end
+end

data/lib/rubocop/git/style_guide.rb

@@ -0,0 +1,54 @@
+module RuboCop::Git
+# ref. https://github.com/thoughtbot/hound/blob/be2dd34/app/models/style_guide.rb
+class StyleGuide
+  def initialize(rubocop_options, config_path, override_config_content = nil)
+    @rubocop_options = rubocop_options
+    @config_path = config_path
+    @override_config_content = override_config_content
+  end
+
+  def violations(file)
+    if ignored_file?(file)
+      []
+    else
+      parsed_source = parse_source(file)
+      team = Rubocop::Cop::Team.new(
+               Rubocop::Cop::Cop.all, configuration, @rubocop_options)
+      commissioner = Rubocop::Cop::Commissioner.new(team.cops, [])
+      commissioner.investigate(parsed_source)
+    end
+  end
+
+  private
+
+  def ignored_file?(file)
+    !file.ruby? ||
+      file.removed? ||
+        configuration.file_to_exclude?(file.filename)
+  end
+
+  def parse_source(file)
+    Rubocop::SourceParser.parse(file.contents, file.filename)
+  end
+
+  def configuration
+    config = Rubocop::ConfigLoader.configuration_from_file(@config_path)
+
+    if override_config
+      config = Rubocop::Config.new(
+        Rubocop::ConfigLoader.merge(config, override_config),
+        ''
+      )
+      config.make_excludes_absolute
+    end
+
+    config
+  end
+
+  def override_config
+    if @override_config_content
+      Rubocop::Config.new(YAML.load(@override_config_content))
+    end
+  end
+end
+end

data/lib/rubocop/git/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Git
+    VERSION = '0.0.1'
+  end
+end

data/rubocop-git.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/git/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-git'
+  spec.version       = RuboCop::Git::VERSION
+  spec.authors       = ['Masaki Takeuchi']
+  spec.email         = ['m.ishihara@gmail.com']
+  spec.summary       = %q{RuboCop for git diff.}
+  spec.description   = %q{RuboCop for git diff.}
+  spec.homepage      = 'https://github.com/m4i/rubocop-git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'rubocop', ['>= 0.22.0', '< 0.24.0']
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-git
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masaki Takeuchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+description: RuboCop for git diff.
+email:
+- m.ishihara@gmail.com
+executables:
+- rubocop-git
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rubocop-git
+- hound.yml
+- lib/rubocop/git.rb
+- lib/rubocop/git/cli.rb
+- lib/rubocop/git/commit_file.rb
+- lib/rubocop/git/file_violation.rb
+- lib/rubocop/git/line.rb
+- lib/rubocop/git/patch.rb
+- lib/rubocop/git/pseudo_pull_request.rb
+- lib/rubocop/git/pseudo_resource.rb
+- lib/rubocop/git/runner.rb
+- lib/rubocop/git/style_checker.rb
+- lib/rubocop/git/style_guide.rb
+- lib/rubocop/git/version.rb
+- rubocop-git.gemspec
+homepage: https://github.com/m4i/rubocop-git
+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.2.2
+signing_key: 
+specification_version: 4
+summary: RuboCop for git diff.
+test_files: []