ridecharge-rubocop 0.0.1

data/config/standard-todo.yml

@@ -0,0 +1,24 @@
+AllCops:
+  Excludes:
+    - vendor/**
+
+# Offence count: 4
+BlockNesting:
+  Max: 5
+
+# Offence count: 12
+# Configuration parameters: CountComments.
+ClassLength:
+  Max: 2721
+
+
+# Offence count: 30
+CyclomaticComplexity:
+  Max: 56
+
+
+# Offence count: 54
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 327
+

data/config/tabs.yml

@@ -0,0 +1,15 @@
+# Decision: Don't use tabs for indentation.
+# Rationale: Because actual tab characters cause different editors and 
+#  code viewers to align the code differently, reducing readability.
+# Workflow: 
+# In Emacs: 
+#  ;;; (require 'ruby-mode) ;; is needed for this setting
+#  (setq indent-tabs-mode nil) ; always replace tabs with spaces
+# In Sublime Text:
+#  Should be set automatically via ruby-mode.
+# In Vim:
+#  autocmd FileType ruby setlocal expandtab shiftwidth=4 softtabstop=4
+
+
+Tab:
+  Enabled: true

data/config/vehicle-todo.yml

@@ -0,0 +1,195 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+AccessModifierIndentation:
+  Enabled: false
+
+AccessorMethodName:
+  Enabled: false
+
+AlignArray:
+  Enabled: false
+
+AlignHash:
+  Enabled: false
+
+AlignParameters:
+  Enabled: false
+
+AndOr:
+  Enabled: false
+
+BlockNesting:
+  Max: 4
+
+BracesAroundHashParameters:
+  Enabled: false
+
+CaseIndentation:
+  Enabled: false
+
+ClassLength:
+  Max: 142
+
+ClassVars:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+ConstantName:
+  Enabled: false
+
+CyclomaticComplexity:
+  Max: 16
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  Enabled: false
+
+EmptyLines:
+  Enabled: false
+
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+EmptyLinesAroundBody:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EndAlignment:
+  Enabled: false
+
+FinalNewline:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+HashMethods:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IndentationWidth:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LeadingCommentSpace:
+  Enabled: false
+
+LineLength:
+  Max: 11108
+
+MethodCallParentheses:
+  Enabled: false
+
+MethodLength:
+  Max: 77
+
+MultilineTernaryOperator:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+Output:
+  Enabled: false
+
+ParenthesesAroundCondition:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+PredicateName:
+  Enabled: false
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RedundantReturn:
+  Enabled: false
+
+RedundantSelf:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+RescueException:
+  Enabled: false
+
+Semicolon:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpaceAfterColon:
+  Enabled: false
+
+SpaceAfterComma:
+  Enabled: false
+
+SpaceAroundBlockBraces:
+  Enabled: false
+
+SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+SpaceAroundOperators:
+  Enabled: false
+
+SpaceInsideBrackets:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+SpaceInsideParens:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+TrailingBlankLines:
+  Enabled: false
+
+TrailingWhitespace:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+UselessAssignment:
+  Enabled: false
+
+Validation:
+  Enabled: false
+
+Void:
+  Enabled: false
+
+WordArray:
+  Enabled: false

data/lib/ridecharge/rubocop.rb

@@ -0,0 +1,2 @@
+require "ridecharge/rubocop/version"
+require 'rubocop/ridecharge'

data/lib/ridecharge/rubocop/version.rb

@@ -0,0 +1,5 @@
+module Ridecharge
+  module Rubocop
+    VERSION = "0.0.1"
+  end
+end

data/lib/rubocop/config_loader_monkeypatch.rb

@@ -0,0 +1,117 @@
+require 'rubocop'
+module Rubocop
+  class ConfigLoader
+    RIDECHARGE_RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
+    DEFAULT_RIDECHARGE_FILE= File.join(RIDECHARGE_RUBOCOP_HOME, 'config', '0default.yml')
+
+    # https://github.com/bbatsov/rubocop/blob/ff167d8f202baf7a68955db0aaf0dc29afb7e7ee/lib/rubocop/config_loader.rb#L88
+=begin 
+      def configuration_file_for(target_dir)
+        config_files_in_path(target_dir).first || DEFAULT_FILE
+      end
+
+      def configuration_from_file(config_file)
+        config = load_file(config_file)
+        return config if config_file == DEFAULT_FILE
+
+        found_files = config_files_in_path(config_file)
+        if found_files.any? && found_files.last != config_file
+          print 'AllCops/Excludes ' if debug?
+          add_excludes_from_higher_level(config, load_file(found_files.last))
+        end
+        make_excludes_absolute(config)
+        merge_with_default(config, config_file)
+      end
+      def default_configuration
+        @default_configuration ||= begin
+                                     print 'Default ' if debug?
+                                     load_file(DEFAULT_FILE)
+                                   end
+      end
+=end
+    class << self
+      def configuration_file_for(target_dir)
+        config_files_in_path(target_dir).first || DEFAULT_RIDECHARGE_FILE
+      end
+      def configuration_from_file(config_file)
+        config = load_file(config_file)
+        return config if config_file == DEFAULT_RIDECHARGE_FILE
+
+        found_files = config_files_in_path(config_file)
+        if found_files.any? && found_files.last != config_file
+          print 'AllCops/Excludes ' if debug?
+          add_excludes_from_higher_level(config, load_file(found_files.last))
+        end
+        make_excludes_absolute(config)
+        merge_with_default(config, config_file)
+      end
+      def default_configuration
+        @default_configuration ||= begin
+                                     print 'Ridecharge Default ' if debug?
+                                     load_file(DEFAULT_RIDECHARGE_FILE)
+                                   end
+      end
+    end
+  end
+  class Config
+    #https://github.com/bbatsov/rubocop/blob/v0.18.1/lib/rubocop/config.rb#L41
+=begin
+    # TODO: This should be a private method
+    def validate
+      # Don't validate RuboCop's own files. Avoids inifinite
+      # recursion.
+      return if @loaded_path.start_with?(ConfigLoader::RUBOCOP_HOME)
+
+      default_config = ConfigLoader.default_configuration
+
+      valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
+        default_config.key?(key)
+      end
+
+      invalid_cop_names.each do |name|
+        fail ValidationError,
+             "unrecognized cop #{name} found in #{loaded_path || self}"
+      end
+
+      valid_cop_names.each do |name|
+        @hash[name].each_key do |param|
+          unless COMMON_PARAMS.include?(param) ||
+                 default_config[name].key?(param)
+            fail ValidationError,
+                 "unrecognized parameter #{name}:#{param} found " +
+                 "in #{loaded_path || self}"
+          end
+        end
+      end
+    end
+=end
+
+    def validate
+      # Don't validate RuboCop's own files. Avoids inifinite
+      # recursion.
+      return if @loaded_path.start_with?(ConfigLoader::RIDECHARGE_RUBOCOP_HOME)
+
+      default_config = ConfigLoader.default_configuration
+
+      valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
+        default_config.key?(key)
+      end
+
+      invalid_cop_names.each do |name|
+        fail ValidationError,
+                     "unrecognized cop #{name} found in #{loaded_path || self}"
+      end
+
+      valid_cop_names.each do |name|
+        @hash[name].each_key do |param|
+          unless COMMON_PARAMS.include?(param) ||
+              default_config[name].key?(param)
+            fail ValidationError,
+                             "unrecognized parameter #{name}:#{param} found in #{loaded_path || self}"
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/rubocop/ridecharge.rb

@@ -0,0 +1 @@
+require 'rubocop/config_loader_monkeypatch'

data/ridecharge-rubocop.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ridecharge/rubocop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ridecharge-rubocop"
+  spec.version       = Ridecharge::Rubocop::VERSION
+  spec.authors       = ["Tim Snowhite"]
+  spec.email         = ["tsnowhite@taximagic.com"]
+  spec.summary       = %q{Ridecharge Rubocop configuration}
+  spec.description   = %q{our special blend of crazy}
+  spec.homepage      = ""
+  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_dependency "rubocop", "0.18.1"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rspec', '~> 2.14')
+end

data/spec/isolated_environment_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'isolated environment', :isolated_environment do
+  include FileHelper
+
+  let(:cli) { Rubocop::CLI.new }
+
+  before(:each) { $stdout = StringIO.new }
+  after(:each) { $stdout = STDOUT }
+
+  # Configuration files above the work directory shall not disturb the
+  # tests. This is especially important on Windows where the temporary
+  # directory is under the user's home directory. On any platform we don't want
+  # a .rubocop.yml file in the temporary directory to affect the outcome of
+  # rspec.
+  it 'is not affected by a config file above the work directory' do
+    create_file('../.rubocop.yml', ['inherit_from: missing_file.yml'])
+    create_file('ex.rb', ['# encoding: utf-8'])
+    # A return value of 0 means that the erroneous config file was not read.
+    expect(cli.run([])).to eq(0)
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'RuboCop Project' do
+  describe 'default configuration file' do
+    let(:cop_names) { Rubocop::Cop::Cop.all.map(&:cop_name) }
+
+    subject(:default_config) do
+      Rubocop::ConfigLoader.load_file('config/0default.yml')
+    end
+
+    it 'has configuration for all cops' do
+      expect(default_config.keys.sort).to eq((['AllCops'] + cop_names).sort)
+    end
+
+    it 'has a nicely formatted description for all cops' do
+      cop_names.each do |name|
+        description = default_config[name]['Description']
+        expect(description).not_to be_nil
+        expect(description).not_to include("\n")
+      end
+    end
+  end
+
+  describe 'changelog' do
+    subject(:changelog) do
+      path = File.join(File.dirname(__FILE__), '..', 'CHANGELOG.md')
+      File.read(path)
+    end
+
+    it 'has link definitions for all implicit links' do
+      implicit_link_names = changelog.scan(/\[([^\]]+)\]\[\]/).flatten.uniq
+      implicit_link_names.each do |name|
+        expect(changelog).to include("[#{name}]: http")
+      end
+    end
+
+    describe 'entry' do
+      subject(:entries) { lines.grep(/^\*/).map(&:chomp) }
+      let(:lines) { changelog.each_line }
+
+      it 'has a whitespace between the * and the body' do
+        entries.each do |entry|
+          expect(entry).to match(/^\* \S/)
+        end
+      end
+
+      context 'after version 0.14.0' do
+        let(:lines) do
+          changelog.each_line.take_while do |line|
+            !line.start_with?('## 0.14.0')
+          end
+        end
+
+        it 'has a link to the contributors at the end' do
+          entries.each do |entry|
+            expect(entry).to match(/\(\[@\S+\]\[\](?:, \[@\S+\]\[\])*\)$/)
+          end
+        end
+      end
+
+      describe 'link to related issue' do
+        let(:issues) do
+          entries.map do |entry|
+            entry.match(/\[(?<number>[#\d]+)\]\((?<url>[^\)]+)\)/)
+          end.compact
+        end
+
+        it 'has an issue number prefixed with #' do
+          issues.each do |issue|
+            expect(issue[:number]).to match(/^#\d+$/)
+          end
+        end
+
+        it 'has a valid URL' do
+          issues.each do |issue|
+            number = issue[:number].gsub(/\D/, '')
+            pattern = %r{^https://github\.com/bbatsov/rubocop/(?:issues|pull)/#{number}$} # rubocop:disable LineLength
+            expect(issue[:url]).to match(pattern)
+          end
+        end
+
+        it 'has a colon and a whitespace at the end' do
+          entries_including_issue_link = entries.select do |entry|
+            entry.match(/^\*\s*\[/)
+          end
+
+          entries_including_issue_link.each do |entry|
+            expect(entry).to include('): ')
+          end
+        end
+      end
+
+      describe 'body' do
+        let(:bodies) do
+          entries.map do |entry|
+            entry
+              .sub(/^\*\s*(?:\[.+?\):\s*)?/, '')
+              .sub(/\s*\([^\)]+\)$/, '')
+          end
+        end
+
+        it 'does not start with a lower case' do
+          bodies.each do |body|
+            expect(body).not_to match(/^[a-z]/)
+          end
+        end
+
+        it 'ends with a punctuation' do
+          bodies.each do |body|
+            expect(body).to match(/[\.\!]$/)
+          end
+        end
+      end
+    end
+  end
+end