rubocop-powerhome 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 188b7b1d68d7953212e66f35202529d4aea4f587f3d72468c02909e2fc5eb45f
-  data.tar.gz: c87fa112d9c4d86f8f901e6598ac5d7850927b2166598f5f7d50e529219d82de
+  metadata.gz: 4767dc6020167a8b615233306ea599f1c4cf365fd98ea11754d6a2cdc24d2053
+  data.tar.gz: ecf9e2336b5f5c7e65b41e3de04d0b5aeec78e0f91d58b9508b93b79aef17173
 SHA512:
-  metadata.gz: d18733226e47c335fabf4a64e5886a65fa8cf97c8e05fe90b51f0654644d314a4ef50d1d4585d3c56dc156f609f0c42ad1133b65fc1843cb897d50297953b769
-  data.tar.gz: 1c2530786425086cb940b9495faae2e4d0c6879f7113bcb0a2abb1a5b971d16dc3fd37b108c67cc1d58b16299cbbfcd5e92d50bdf2a7c22171da12d9a7360c78
+  metadata.gz: 8034ef4be62dffc22cc653c6911f81a0cb2cddf3b0f93f380e8a5eabd214834c54c271829a415d005aa60ec55c146be1dfa68db5b1c3ec97cadb57d93ff1343b
+  data.tar.gz: 0b79e02933282bd833ee4f38aabe65034aa42e2fa8e19241d2eb4b94fc1f574cb2a81c8d76bd752dd28c2ccd5935e67430cbc0aafdfbd4ba49fe43782c55962e

data/.rubocop.yml

@@ -5,5 +5,10 @@ Naming/FileName:
   Exclude:
     - lib/rubocop-powerhome.rb
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'rubocop-powerhome.gemspec'
+
 Rails:
   Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,36 @@
-## [Unreleased]
+## [0.5.0] - 2022-07-22
+
+### Features
+
+- Provide style guide references and helpful hints on violations. (#36)
+- Ignore Metrics/BlockLength on Rspec's context and describe (#43)
+
+### Documentation
+- Fix rel links in README (#37)
+- Initial portal setup (#34)
+
+### Updates
+- Lock file maintenance
+- Update tj-actions/changed-files action to v24 (#47)
+- Update dependency rubocop to ~> 1.32.0 (#46)
+- Update dependency babel-eslint to v10 (#45)
+- Update all non-major dependencies (#44)
+- Update typescript-eslint monorepo to v5 (major) (#24)
+- Update dependency eslint-webpack-plugin to v3 (#23)
+- Update dependency eslint-plugin-jsx-control-statements to v3 (#22)
+- Update dependency eslint-plugin-flowtype to v8 (#21)
+- Update dependency babel-eslint to v10 (#19)
+- Update all non-major dependencies (#16)
+- Pin dependency babel-eslint to v (#15)
+
+## [0.4.1] - 2022-06-02
+
+- Fix bug in Naming/ViewComponent when class does not inherit
+
+## [0.4.0] - 2022-06-01
+
+- Adds Naming/ViewComponent cop
+- Adds Style/NoHelpers cop
 
 ## [0.1.0] - 2022-05-18
 

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.29.1"
+gem "rubocop", "~> 1.32.0"
 gem "rubocop-performance"
 gem "rubocop-rails"
 gem "rubocop-rake"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-powerhome (0.3.0)
+    rubocop-powerhome (0.5.0)
       rubocop
       rubocop-performance
       rubocop-rails
@@ -11,24 +11,41 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
+    json (2.6.2)
+    license_finder (7.0.1)
+      bundler
+      rubyzip (>= 1, < 3)
+      thor (~> 1.2)
+      tomlrb (>= 1.3, < 2.1)
+      with_env (= 1.1.0)
+      xml-simple (~> 1.1.9)
+    method_source (1.0.0)
+    minitest (5.16.2)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rack (2.2.4)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.4.0)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -43,42 +60,51 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.29.1)
+    rubocop (1.32.0)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-performance (1.14.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.12.2)
+    rubocop-rails (2.15.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    thor (1.2.1)
+    tomlrb (2.0.3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
+    with_env (1.1.0)
+    xml-simple (1.1.9)
+      rexml
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
+  license_finder (~> 7.0)
+  pry-byebug (= 3.9.0)
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.29.1)
+  rubocop (~> 1.32.0)
   rubocop-performance
   rubocop-powerhome!
   rubocop-rails
@@ -86,4 +112,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.3.7
+   2.3.14

data/config/default.yml

@@ -1,6 +1,8 @@
 AllCops:
   TargetRubyVersion: 2.7
   NewCops: enable
+  DisplayStyleGuide: true
+  ExtraDetails: true
 
 Gemspec/RequiredRubyVersion:
   Enabled: false
@@ -24,6 +26,11 @@ Naming/MethodParameterName:
     - in
     - at
 
+Naming/ViewComponent:
+  Description: 'This cop requires ViewComponent classes to end with Component in their classname.'
+  Enabled: true
+  VersionAdded: '0.4.0'
+
 Rails:
   Enabled: true
 
@@ -59,6 +66,11 @@ Style/HashTransformValues:
 Style/Lambda:
   EnforcedStyle: literal
 
+Style/NoHelpers:
+  Description: 'This cop blocks global helper modules from existing in an application.'
+  Enabled: true
+  VersionAdded: '0.4.0'
+
 Style/NumericPredicate:
   Enabled: false
 
@@ -76,3 +88,8 @@ Style/TrailingCommaInArrayLiteral:
 
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
+
+Metrics/BlockLength:
+  IgnoredMethods:
+    - describe
+    - context

data/doc/dependency_decisions.yml

@@ -0,0 +1,3 @@
+---
+- - :inherit_from
+  - https://raw.githubusercontent.com/powerhome/oss-guide/master/license_rules.yml

data/lib/rubocop/cop/naming/view_component.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      # This cop requires ViewComponent classes to end with Component in their classname.
+      #
+      # @example
+      #   # bad
+      #   class Foo < ::ViewComponent::Base
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   class FooComponent < ::ViewComponent::Base
+      #     # ...
+      #   end
+      #
+      class ViewComponent < RuboCop::Cop::Cop
+        def on_class(node)
+          inheritance_klass = node.node_parts[1]&.source
+          return unless view_component_class?(inheritance_klass)
+
+          klass = node.node_parts[0]&.source
+          return if klass.end_with?("Component")
+
+          add_offense(node.node_parts[0], message: "End ViewComponent classnames with 'Component'")
+        end
+
+      private
+
+        def view_component_class?(inheritance_klass)
+          inheritance_klass&.end_with?("::ApplicationComponent", "ViewComponent::Base")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/naming_cops.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Naming
+      require_relative "naming/view_component"
+    end
+  end
+end

data/lib/rubocop/cop/style/no_helpers.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop does not allow helpers to be placed in an application. View objects,
+      # specifically ViewComponent, create better Object Oriented design.
+      # Global helper methods tightly couple templates.
+      #
+      class NoHelpers < RuboCop::Cop::Cop
+        MSG = "Helpers create global view methods. Instead, use view objects to " \
+              "encapsulate your display logic."
+
+        def investigate(processed_source)
+          return if processed_source.blank?
+          return unless helper_path?
+
+          add_offense(processed_source.ast, message: format(MSG))
+        end
+
+      private
+
+        def helper_path?
+          processed_source.file_path.include?("app/helpers/")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style_cops.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      require_relative "style/no_helpers"
+    end
+  end
+end

data/lib/rubocop/powerhome/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Powerhome
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/rubocop-powerhome.rb

@@ -9,3 +9,6 @@ require "rubocop-rspec"
 require_relative "rubocop/powerhome"
 
 RuboCop::Powerhome::Inject.defaults!
+
+require_relative "rubocop/cop/naming_cops"
+require_relative "rubocop/cop/style_cops"

data/mkdocs.yml

@@ -0,0 +1,9 @@
+site_name: Rubocop Powerhome
+site_description: Gem focused on providing standard Rubocop configuration for Power Home Remodeling ruby apps
+repo_url: https://github.com/powerhome/power_linting
+edit_uri: edit/main/rubocop_powerhome/docs/
+nav:
+  - 'Home': 'README.md'
+
+plugins:
+  - techdocs-core

data/rubocop-powerhome.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/rubocop/powerhome/version"
 Gem::Specification.new do |spec|
   spec.name = "rubocop-powerhome"
   spec.version = RuboCop::Powerhome::VERSION
-  spec.authors = ["Carlos Palhares"]
-  spec.email = ["chjunior@gmail.com"]
+  spec.authors = ["Carlos Palhares", "Garett Arrowood"]
+  spec.email = ["chjunior@gmail.com", "garettarrowood@gmail.com"]
 
   spec.summary = "Powerhome Rubocop standard rules"
   spec.description = "Powerhome Rubocop standard rules"
@@ -41,4 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rubocop-rake"
   spec.add_runtime_dependency "rubocop-rspec"
   spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.add_development_dependency "license_finder", "~> 7.0"
+  spec.add_development_dependency "pry-byebug", "3.9.0"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-powerhome
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Carlos Palhares
+- Garett Arrowood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,9 +81,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: license_finder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 description: Powerhome Rubocop standard rules
 email:
 - chjunior@gmail.com
+- garettarrowood@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -92,13 +122,19 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.md
 - Rakefile
 - config/default.yml
+- doc/dependency_decisions.yml
+- docs/README.md
 - lib/rubocop-powerhome.rb
+- lib/rubocop/cop/naming/view_component.rb
+- lib/rubocop/cop/naming_cops.rb
+- lib/rubocop/cop/style/no_helpers.rb
+- lib/rubocop/cop/style_cops.rb
 - lib/rubocop/powerhome.rb
 - lib/rubocop/powerhome/inject.rb
 - lib/rubocop/powerhome/version.rb
+- mkdocs.yml
 - rubocop-powerhome.gemspec
 - sig/rubocop/powerhome.rbs
 homepage: https://github.com/powerhome/power_linting