rubocop-aha 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8793b3d95494dcf76bfc09519c0167bfa0a4b709
+  data.tar.gz: 51ee300e73e2f12f6eae259b9dc8bf052ea977f6
+SHA512:
+  metadata.gz: efd209fa9820c789a3e28e03f08ac639d7f0eb53162667721897eda710ad02f3f6e490d5700b6d957da21c7f6dd46903ec72463754eaff55214f7fbcae1ee899
+  data.tar.gz: eba7fa55b47f8a345b0897594e4349e05b87cd2ad2ed01a8d553ec83d669cd359b44c2b45ddac4f8805d7edc61c6e988724b178d675783be00d7c01094a1756c

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aha! Labs Inc
+
+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.

data/README.md

@@ -0,0 +1,42 @@
+[![Gem Version](https://badge.fury.io/rb/rubocop-aha.svg)](https://badge.fury.io/rb/rubocop-aha)
+
+# rubocop
+
+Common rubocop configuration for [Aha!](https://www.aha.io) projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-aha'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rubocop-aha
+```
+
+## Usage
+
+Add the following to your project's `.rubocop.yml`:
+
+```
+inherit_gem:
+  rubocop-aha: lib/config.yml
+```
+
+## Contributing
+
+We are unlikely to accept external contributions to change configuration rules. You are welcome to fork or extend for your own purposes if you like the baseline but disagree with some of our settings. :)
+
+## License
+
+MIT

data/Rakefile

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

data/lib/config.yml

@@ -0,0 +1,149 @@
+require:
+ - ./rubocop-aha/cops/empty_gsub_replacement.rb
+ - rubocop/rspec/focused
+ - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - bin/**/*
+    - node_modules/**/*
+    - db/**/*
+    - tmp/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+Rails:
+  Enabled: true
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: false
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Lint/BlockAlignment:
+  EnforcedStyleAlignWith: start_of_block
+  
+Lint/DefEndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+  
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Lint/InheritException:
+  EnforcedStyle: standard_error
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize: 
+  Enabled: false 
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Performance/EmptyGsubReplacement:
+  Enabled: true
+
+Performance/StringReplacement:
+  Enabled: false
+
+Performance/TimesMap:
+  Enabled: false
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+Rails/RequestReferer:
+  EnforcedStyle: referrer
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+RSpec/BeEql:
+  Enabled: false
+
+RSpec/EmptyLineAfterSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/Focused:
+  Enabled: true
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+RSpec/ScatteredSetup:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/ClassCheck:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/TernaryParentheses:
+  Enabled: false
+  
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/WordArray:
+  Enabled: false

data/lib/rubocop-aha/cops/empty_gsub_replacement.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+# Copied from https://raw.githubusercontent.com/bbatsov/rubocop/master/lib/rubocop/cop/performance/string_replacement.rb
+# Becker: Removed tr replacement
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop identifies places where `gsub` can be replaced by
+      # `delete`.
+      #
+      # @example
+      #   @bad
+      #   'abc'.gsub('b', 'd')
+      #   'abc'.gsub('a', '')
+      #   'abc'.gsub(/a/, 'd')
+      #   'abc'.gsub!('a', 'd')
+      #
+      #   @good
+      #   'abc'.gsub(/.*/, 'a')
+      #   'abc'.gsub(/a+/, 'd')
+      #   'a b c'.delete(' ')
+      class EmptyGsubReplacement < Cop
+        MSG = 'Use `%s` instead of `%s`.'.freeze
+        DETERMINISTIC_REGEX = /\A(?:#{LITERAL_REGEX})+\Z/
+        DELETE = 'delete'.freeze
+        BANG = '!'.freeze
+        SINGLE_QUOTE = "'".freeze
+
+        def_node_matcher :string_replacement?, <<-PATTERN
+          (send _ {:gsub :gsub!}
+                    ${regexp str (send (const nil :Regexp) {:new :compile} _)}
+                    $str)
+        PATTERN
+
+        def on_send(node)
+          string_replacement?(node) do |first_param, second_param|
+            return if accept_second_param?(second_param)
+            return if accept_first_param?(first_param)
+            
+            offense(node, first_param, second_param)
+          end
+        end
+
+        def autocorrect(node)
+          _string, _method, first_param, second_param = *node
+          first_source, = first_source(first_param)
+          second_source, = *second_param
+
+          unless first_param.str_type?
+            first_source = interpret_string_escapes(first_source)
+          end
+
+          replacement_method =
+            replacement_method(node, first_source, second_source)
+
+          replace_method(node, first_source, second_source, first_param,
+                         replacement_method)
+        end
+
+        def replace_method(node, first, second, first_param, replacement)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, replacement)
+            unless first_param.str_type?
+              corrector.replace(first_param.source_range,
+                                to_string_literal(first))
+            end
+
+            if second.empty? && first.length == 1
+              remove_second_param(corrector, node, first_param)
+            end
+          end
+        end
+
+        private
+
+        def accept_second_param?(second_param)
+          second_source, = *second_param
+          second_source.length >= 1
+        end
+
+        def accept_first_param?(first_param)
+          first_source, options = first_source(first_param)
+          return true if first_source.nil?
+
+          unless first_param.str_type?
+            return true if options
+            return true unless first_source =~ DETERMINISTIC_REGEX
+            # This must be done after checking DETERMINISTIC_REGEX
+            # Otherwise things like \s will trip us up
+            first_source = interpret_string_escapes(first_source)
+          end
+
+          first_source.length != 1
+        end
+
+        def offense(node, first_param, second_param)
+          first_source, = first_source(first_param)
+          unless first_param.str_type?
+            first_source = interpret_string_escapes(first_source)
+          end
+          second_source, = *second_param
+          message = message(node, first_source, second_source)
+
+          add_offense(node, range(node), message)
+        end
+
+        def first_source(first_param)
+          case first_param.type
+          when :regexp
+            source_from_regex_literal(first_param)
+          when :send
+            source_from_regex_constructor(first_param)
+          when :str
+            first_param.children.first
+          end
+        end
+
+        def source_from_regex_literal(node)
+          regex, options = *node
+          source, = *regex
+          options, = *options
+          [source, options]
+        end
+
+        def source_from_regex_constructor(node)
+          _const, _init, regex = *node
+          case regex.type
+          when :regexp
+            source_from_regex_literal(regex)
+          when :str
+            source, = *regex
+            source
+          end
+        end
+
+        def range(node)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
+        end
+
+        def replacement_method(node, first_source, second_source)
+          replacement = if second_source.empty? && first_source.length == 1
+                          DELETE
+                        end
+
+          add_bang = node.method_name.to_s.end_with?('!')
+          "#{replacement}#{BANG if add_bang}"
+        end
+
+        def message(node, first_source, second_source)
+          replacement_method =
+            replacement_method(node, first_source, second_source)
+
+          format(MSG, replacement_method, node.method_name)
+        end
+
+        def method_suffix(node)
+          node.loc.end ? node.loc.end.source : ''
+        end
+
+        def remove_second_param(corrector, node, first_param)
+          end_range = range_between(first_param.source_range.end_pos,
+                                    node.source_range.end_pos)
+
+          corrector.replace(end_range, method_suffix(node))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-aha/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Aha
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/rubocop-aha.rb

@@ -0,0 +1 @@
+require 'rubocop-aha/version'

data/rubocop-aha.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop-aha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-aha'
+  spec.version       = RuboCop::Aha::VERSION
+  spec.authors       = ['Zach Schneider']
+  spec.email         = ['zach@aha.io']
+
+  spec.summary       = 'Aha! rubocop config'
+  spec.description   = 'Aha! rubocop config'
+  spec.homepage      = 'https://github.com/aha-app/rubocop-aha'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop', '>= 0.49.0'
+
+  spec.add_dependency 'rubocop-rspec', '~> 1.15'
+  spec.add_dependency 'rubocop-rspec-focused', '~> 0.1'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-aha
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zach Schneider
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec-focused
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Aha! rubocop config
+email:
+- zach@aha.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/config.yml
+- lib/rubocop-aha.rb
+- lib/rubocop-aha/cops/empty_gsub_replacement.rb
+- lib/rubocop-aha/version.rb
+- rubocop-aha.gemspec
+homepage: https://github.com/aha-app/rubocop-aha
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Aha! rubocop config
+test_files: []