rubocop-elegant 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1e7cbb7f9a216f6af388b39673690dc32c43b5323e3119444595311d2c23432
-  data.tar.gz: 431149fbe696fbdf3b4518b8974bb78fef11821356e88c6ee1a3696dd22e38fb
+  metadata.gz: 553704ade44156d5f125292999bde77fdf3a4fec42e2b6f418dfb345c02db576
+  data.tar.gz: 559c7644091c2b1d118d40e2a3da04c82144dd4ffebdcd661c21eb112c5aa4df
 SHA512:
-  metadata.gz: 976cb8a76831de48fa4ab1bec22476692bb876950dcc2fb766d7051e7234b4d00928e5a36c5ac37e13b7a36501ac60133062d2d825bc8f64770b695be38f9343
-  data.tar.gz: b06d9147bd791c0cacd452c08fe513846b8c4d3e610810faff16c339abbdbb4652be647b89ba96524dee4e7c9e17af9c03e88a8d5c827f75a2c0c937b77286ba
+  metadata.gz: 6e5afbc202a78a2d443cde89542deb99bfff11d97d6226f9aa305fcabfbdb87c20b771a9addf0854a56552c4652851cceaef3a75a716d1bec0144f4ac03f5515
+  data.tar.gz: 5b4f2752fe049e3e4b7c1bf2f8685dbb53b9362e9b0170e87a6cb33600e3a36228c7a6d915f32426782df00a80dac13228f39fb38ff23a396e35fb76add19252

data/README.md

@@ -25,14 +25,21 @@ First, install it:
 gem install rubocop-elegant
 ```
 
-Then, add it to your `.rubocop.yml`:
+Then, format your `.rubocop.yml` like this:
 
 ```yaml
+AllCops:
+  EnabledByDefault: true
+  NewCops: enable
 plugins:
-  - rubocop-elegant
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-elegant # must be the last one
 ```
 
-Should work.
+The `rubocop-elegant` not only provides its own cops, but also configures
+  default ones the "right" way.
 
 ## How to contribute
 

data/config/default.yml

@@ -41,8 +41,6 @@ Naming/FileName:
   Regex: '^[a-z0-9\-._]*$'
 Minitest/EmptyLineBeforeAssertionMethods:
   Enabled: false
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
 Layout/RescueEnsureAlignment:
   Enabled: false
 Layout/MultilineMethodCallIndentation:
@@ -93,17 +91,37 @@ Metrics/CyclomaticComplexity:
   Max: 15
 Metrics/PerceivedComplexity:
   Max: 15
-Style/Copyright:
-  Enabled: false
 Lint/ConstantResolution:
   Enabled: false
-Style/DocumentationMethod:
+Style/IpAddresses:
+  Enabled: false
+Minitest/NoAssertions:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Bundler/GemComment:
   Enabled: false
-Minitest/NoTestCases:
+Style/DocumentationMethod:
   Enabled: false
-Style/ArrayFirstLast:
+Style/MissingElse:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
   Enabled: false
 Style/StringHashKeys:
   Enabled: false
+Style/HashLookupMethod:
+  Enabled: false
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+Layout/RedundantLineBreak:
+  Enabled: true
+Performance/Casecmp:
+  Enabled: false
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+Style/ArrayFirstLast:
+  Enabled: false
+Minitest/AssertEmptyLiteral:
+  Enabled: false

data/lib/rubocop/cop/elegant/no_comments.rb

@@ -21,7 +21,7 @@ module RuboCop
         private
 
         def allowed?(comment)
-          spdx?(comment) || magic?(comment) || rubocop?(comment)
+          spdx?(comment) || magic?(comment) || rubocop?(comment) || (gemspec? && docblock?(comment))
         end
 
         def spdx?(comment)
@@ -36,6 +36,42 @@ module RuboCop
           comment.text.match?(/^#\s*rubocop:(disable|enable|todo)\s/)
         end
 
+        def gemspec?
+          return @gemspec if defined?(@gemspec)
+          path = processed_source.path
+          return @gemspec = false if path.nil?
+          dir = File.dirname(path)
+          @gemspec = Dir.glob(File.join(dir, '*.gemspec')).any?
+        end
+
+        def docblock?(comment)
+          line = comment.location.line
+          successor = codeline(line)
+          return false if successor.nil?
+          definition?(successor)
+        end
+
+        def codeline(start)
+          lines = processed_source.lines
+          (start...lines.size).each do |idx|
+            content = lines[idx]
+            next if content.nil?
+            stripped = content.strip
+            next if stripped.empty? || stripped.start_with?('#')
+            return idx + 1
+          end
+          nil
+        end
+
+        def definition?(line)
+          ast = processed_source.ast
+          return false if ast.nil?
+          ast.each_node(:class, :module, :def, :defs) do |node|
+            return true if node.location.line == line
+          end
+          false
+        end
+
         def register(comment)
           add_offense(comment) do |corrector|
             corrector.remove(removal(comment))

data/rubocop-elegant.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to?(:required_rubygems_version=)
   s.required_ruby_version = '>=2.2'
   s.name = 'rubocop-elegant'
-  s.version = '0.0.9'
+  s.version = '0.0.11'
   s.license = 'MIT'
   s.summary = 'Set of custom RuboCop cops for elegant Ruby coding'
   s.description =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-elegant
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Yegor Bugayenko