datarockets-style 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7abb7599f2b6308e1bf7ba21af09f8d6d10658d
-  data.tar.gz: 064e54aa27dbe9e00453ad91eac3dcf7b33592c6
+  metadata.gz: a3ade75e0b19c3f2b41a520e098d424d304c20be
+  data.tar.gz: 3a7e44ccc88f575b2b304fa80dfa92c2264131fd
 SHA512:
-  metadata.gz: b751d28c3f3f239d426f2e80f99be7866e1f63562b674175366ca2290e2c8e2cb9a7051abd00a9f3b7b695979ac801556230f7a49f67483ddeaa4fcd7629cf54
-  data.tar.gz: 72db0bda1af9bb3b9ad45c8b57482014a649d453fdc8dc7218293bb9ee9cfa18085488f1c9c8e40b5a8ccc3c809d39ae895d6c91a6159729dc9556e8a6156e43
+  metadata.gz: 4edf5fa617146f569cb0309a3d2afb759bb5cda8dfea4da7c330506771bfbc57a539ce726d5137d186ea3b66258a284974ec2e6a3ec839bade5c4ef587ea8683
+  data.tar.gz: 1814b31a4678a7bedc82aa112ee5327234b8c73e8671e3de6c87df41fd97d4e1f8d54da39dd84a71a0a6178e07a40948cd01fba8b239f884fa14041088dcb33b

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from:
+  - config/ruby.yml
+  - config/rspec.yml
+
+AllCops:
+  TargetRubyVersion: 2.3

data/CHANGELOG.md

@@ -4,6 +4,18 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 
 ## master (unreleased)
 
+## 0.5.0 (2019-11-06)
+
+### Added
+
+* [#107](https://github.com/datarockets/datarockets-style/issues/107): Add ToDo list formatter. ([@r.dubrovsky][])
+
+### Changed
+
+* Update rubocop to `0.76`. ([@r.dubrovsky][])
+* Change default value for `RSpec/ExampleLength` cop. ([@a.branzeanu][])
+* Disable `RSpec/NestedGroups` cop by default. ([@r.dubrovsky][])
+
 ## 0.5.0 (2019-10-26)
 
 ### Changed
@@ -79,3 +91,5 @@ The format is described in [Contributing notes](CONTRIBUTING.md#changelog-entry-
 [@aleks]: https://github.com/AleksSenkou
 [@ula]: https://github.com/lazycoder9
 [@v.kuzmik]: https://github.com/TheBlackArroVV/
+[@a.branzeanu]: https://github.com/texpert
+

data/Gemfile

@@ -1,6 +1,9 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in datarockets-style.gemspec
 gemspec
+
+gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.7"

data/Gemfile.lock

@@ -1,21 +1,44 @@
 PATH
   remote: .
   specs:
-    datarockets-style (0.5.0)
-      rubocop (>= 0.74, < 0.76)
+    datarockets-style (0.6.0)
+      rubocop (~> 0.76)
       rubocop-rspec (~> 1.36)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    jaro_winkler (1.5.3)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
     parallel (1.18.0)
     parser (2.6.5.0)
       ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     rainbow (3.0.0)
     rake (13.0.0)
-    rubocop (0.75.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)
@@ -32,7 +55,9 @@ PLATFORMS
 
 DEPENDENCIES
   datarockets-style!
+  pry-byebug
   rake (~> 13.0)
+  rspec (~> 3.7)
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -88,6 +88,65 @@ P.S. The string literals in this gem are using double quotes by default.
 
 For an existing project, we suggest to run rubocop with both styles and choose which has fewer offenses (which is more popular in the current project).
 
+## Formatters
+
+### ToDo list formatter
+
+This formatter allows us to get list of files for some offense and with number of offenses in each file. This file can be useful if you need to fix a large some cop cop step by step.
+
+Result of the formatter is compatible with rubocop config or rubocop todo file.
+
+For running that cop, just print in your command like
+
+```bash
+$ bundle exec rubocop -f TodoListFormatter -r datarockets/style
+Inspecting 10 files
+...CC.CC..
+10 files inspected, 7 offenses detected
+
+Layout/IndentationConsistency
+  Exclude:
+    - 'spec/datarockets/style/formatter/todo_list_formatter_spec.rb' # 1
+
+Naming/MemoizedInstanceVariableName
+  Exclude:
+    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
+
+RSpec/ExampleLength
+  Exclude:
+    - 'spec/datarockets/style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
+    - 'spec/datarockets/style/formatter/todo_list_formatter_spec.rb' # 2
+
+Style/Documentation
+  Exclude:
+    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
+    - 'lib/datarockets/style/formatter/todo_list_formatter.rb' # 1
+```
+
+#### Autocorrection
+
+If you run the formatter with autocorrection options, the formatter skip corrected cop and does not include it to the result.
+
+```bash
+$ bundle exec rubocop -f TodoListFormatter -r datarockets/style -a
+Inspecting 10 files
+...CC.CC..
+10 files inspected, 7 offenses detected, 1 offenses corrected
+
+Naming/MemoizedInstanceVariableName
+  Exclude:
+    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
+
+RSpec/ExampleLength
+  Exclude:
+    - 'spec/datarockets/style/formatter/todo_list_formatter/report_summary_spec.rb' # 1
+    - 'spec/datarockets/style/formatter/todo_list_formatter_spec.rb' # 2
+
+Style/Documentation
+  Exclude:
+    - 'lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb' # 1
+    - 'lib/datarockets/style/formatter/todo_list_formatter.rb' # 1
+```
 
 ## Changelog
 

data/config/rspec.yml

@@ -15,6 +15,10 @@ RSpec/ContextWording:
     - without
     - for
 
+RSpec/ExampleLength:
+  Enabled: true
+  Max: 10
+
 RSpec/ExpectChange:
   EnforcedStyle: block
 
@@ -23,3 +27,6 @@ RSpec/ImplicitSubject:
 
 RSpec/MessageSpies:
   EnforcedStyle: have_received
+
+RSpec/NestedGroups:
+  Enabled: false

data/config/ruby.yml

@@ -1,5 +1,6 @@
 AllCops:
   Exclude:
+    - "bundler/**/*"
     - "bin/*"
     - "lib/tasks/**/*"
     - "vendor/**/*"

data/datarockets-style.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "datarockets/style/version"
 
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/datarockets/datarockets-style"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = ">= 2.3.0"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -23,15 +23,13 @@ Gem::Specification.new do |spec|
       "public gem pushes."
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubocop", ">= 0.74", "< 0.76"
+  spec.add_dependency "rubocop", "~> 0.76"
   spec.add_dependency "rubocop-rspec", "~> 1.36"
-
-  spec.add_development_dependency "rake", "~> 13.0"
 end

data/doc/STYLE_GUIDE_RSPEC.md

@@ -10,6 +10,11 @@ This style guide recommends best practices for writing a clear Rspec tests and e
   We're not limiting a length of rspec files.
   <sup>[[link](#rspec-file-length)]</sup>
 
+* <a name="rspec-nested-groups"></a>
+  Nested context is a nice approach for organizing your code and tests structure.
+  So there are not any limits for deep or nested groups.
+  <sup>[[link](#rspec-nested-groups)]</sup>
+
 * <a name="rspec-subject"></a>
   Each subject should be named and we should not use `subject` in our test cases.
   Prefer to use `is_expected` that `expect(subject_name)` for small tests.
@@ -54,6 +59,43 @@ context "when the display name is not present" do
 end
 ```
 
+* <a name="rspec-example-length"></a>
+ A long example is usually more difficult to understand. Consider extracting out some behaviour, e.g. with a `let` block, or a helper method.
+
+  <sup>[[link](#rspec-example-length)]</sup>
+
+```ruby
+# bad
+it 'creates correct deal config object' do
+  expect(ZohoUtil::DealConfig).to receive(:new)
+    .with(
+      deal_name: translated_deal_name,
+      stage_uid: zoho_post.stage_uid,
+      change_existing_stage: zoho_post.change_existing_stage,
+      note_title: translated_note_title,
+      note: translated_note
+    )
+
+  execute_action
+end
+
+# good
+let(:service_arguments) do
+  {
+    deal_name: translated_deal_name,
+    stage_uid: zoho_post.stage_uid,
+    change_existing_stage: zoho_post.change_existing_stage,
+    note_title: translated_note_title,
+    note: translated_note
+  }
+end
+
+it 'creates correct deal config object' do
+  expect(ZohoUtil::DealConfig).to receive(:new).with(**service_arguments)
+  execute_action
+end
+```
+
 * <a name="rspec-expect-change"></a>
   Prefer using blocks for change matcher than method calls.
   <sup>[[link](#rspec-expect-change)]</sup>

data/lib/datarockets/style.rb

@@ -1,6 +1,10 @@
+require "rubocop"
+require "datarockets/style/formatter/todo_list_formatter"
+
 require "datarockets/style/version"
 
 module Datarockets
+  # Datarickors sharable config
   module Style
     # Your code goes here...
   end

data/lib/datarockets/style/formatter/todo_list_formatter.rb

@@ -0,0 +1,50 @@
+require "pathname"
+require_relative "./todo_list_formatter/report_summary"
+
+# This formatter works like default formattter (display dots for files with no offenses and
+# letters for files with problems in the them).
+#
+# In the end, it shows report with sorted cops and files which can be added to rubocop config.
+#
+# Here's the format:
+#
+# Inspecting 3 files
+# .CC
+# 3 files inspected, 1005001 offenses detected
+#
+# LineLength
+#   Exclude:
+#     - "really/bad/file.rb" # 100500
+#     - "almost/ok.rb" # 1
+class TodoListFormatter < RuboCop::Formatter::ProgressFormatter
+  attr_reader :offense_list
+
+  FileOffence = Struct.new(:file_path, :cop_name)
+
+  def started(target_files)
+    super
+    @offense_list = []
+  end
+
+  def file_finished(file, offenses)
+    count_stats(offenses)
+    report_file_as_mark(offenses)
+
+    return if offenses.empty?
+
+    path = Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd))
+
+    offenses.reject(&:corrected?).each do |offense|
+      offense_list << FileOffence.new(path, offense.cop_name)
+    end
+  end
+
+  def finished(inspected_files)
+    report_summary(inspected_files.length,
+      @total_offense_count,
+      @total_correction_count)
+    output.puts
+
+    Datarockets::Style::Formatter::TodoListFormatter::ReportSummary.new(offense_list).call(output)
+  end
+end

data/lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb

@@ -0,0 +1,57 @@
+module Datarockets
+  module Style
+    module Formatter
+      module TodoListFormatter
+        # Get file of pairs: file path and cop name - and prepare report for ToDo list formatter.
+        #
+        # Example of result:
+        #
+        # LineLength
+        #   Exclude:
+        #     - "really/bad/file.rb" # 100500
+        #     - "almost/ok.rb" # 1
+        class ReportSummary
+          attr_reader :offense_list
+
+          FileGroup = Struct.new(:file, :count) do
+            def print(output)
+              output.puts "    - '#{file}' # #{count}"
+            end
+          end
+
+          OffenseGroup = Struct.new(:cop_name, :offenses) do
+            def file_groups
+              @_file_groups ||= offenses.group_by(&:file_path).map do |file, offenses|
+                FileGroup.new(file, offenses.length)
+              end
+            end
+
+            def print(output)
+              output.puts(cop_name)
+              output.puts("  Exclude:")
+              file_groups.sort_by(&:file).each do |file_group|
+                file_group.print(output)
+              end
+              output.puts
+            end
+          end
+
+          def initialize(offense_list)
+            @offense_list = offense_list
+          end
+
+          def call(output)
+            offense_groups.sort_by(&:cop_name).each { |group| group.print(output) }
+          end
+
+          private
+
+          def offense_groups
+            @_offense_groups ||= offense_list.group_by(&:cop_name)
+              .map { |cop_name, offenses| OffenseGroup.new(cop_name, offenses) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datarockets/style/version.rb

@@ -1,5 +1,5 @@
 module Datarockets
   module Style
-    VERSION = "0.5.0"
+    VERSION = "0.6.0".freeze
   end
 end

metadata

@@ -1,33 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: datarockets-style
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Roman Dubrovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-26 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.74'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.76'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.74'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.76'
 - !ruby/object:Gem::Dependency
@@ -44,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.36'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
 description: 
 email:
 - r.dubrovsky@datarockets.com
@@ -69,6 +49,8 @@ files:
 - ".github/ISSUE_TEMPLATE/update-dependencies.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -89,6 +71,8 @@ files:
 - doc/STYLE_GUIDE_RAILS.md
 - doc/STYLE_GUIDE_RSPEC.md
 - lib/datarockets/style.rb
+- lib/datarockets/style/formatter/todo_list_formatter.rb
+- lib/datarockets/style/formatter/todo_list_formatter/report_summary.rb
 - lib/datarockets/style/version.rb
 homepage: https://github.com/datarockets/datarockets-style
 licenses: