rubocop-powerhome 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 188b7b1d68d7953212e66f35202529d4aea4f587f3d72468c02909e2fc5eb45f
-  data.tar.gz: c87fa112d9c4d86f8f901e6598ac5d7850927b2166598f5f7d50e529219d82de
+  metadata.gz: f600a565fdbcc14fe35a92718726d3a6ad595608ac1ef2cf1f1577ee2a86699f
+  data.tar.gz: 0d7e2760b6bfa60936e79789bb43aaa28a1adb6ab2857c3b459d042e2dab0ff0
 SHA512:
-  metadata.gz: d18733226e47c335fabf4a64e5886a65fa8cf97c8e05fe90b51f0654644d314a4ef50d1d4585d3c56dc156f609f0c42ad1133b65fc1843cb897d50297953b769
-  data.tar.gz: 1c2530786425086cb940b9495faae2e4d0c6879f7113bcb0a2abb1a5b971d16dc3fd37b108c67cc1d58b16299cbbfcd5e92d50bdf2a7c22171da12d9a7360c78
+  metadata.gz: a02803ca4e2ed95884ff9e90e52c6b3c155bd2b7c3759479a6cda536d34f39488ff9b42a415706190e7a74e3d3c1251e261cdc3deb36249919ebb95580a0417f
+  data.tar.gz: dc326b826f6deb0b1704e6d720666c174dad28ba893287841cbdc11ba9b41f1cb208adbce6302d0eb9d27c77fdf38515c773c1aeca212a24c66246908a0a29ec

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,5 +1,10 @@
 ## [Unreleased]
 
+## [0.4.0] - 2022-06-01
+
+- Adds Naming/ViewComponent cop
+- Adds Style/NoHelpers cop
+
 ## [0.1.0] - 2022-05-18
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-powerhome (0.3.0)
+    rubocop-powerhome (0.4.0)
       rubocop
       rubocop-performance
       rubocop-rails
@@ -17,15 +17,24 @@ GEM
       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)
       concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
     minitest (5.15.0)
     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.3.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.4.0)
@@ -76,6 +85,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  pry-byebug (= 3.9.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.29.1)

data/config/default.yml

@@ -24,6 +24,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 +64,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
 

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.4.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/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,6 @@ 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 "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.4.0
 platform: ruby
 authors:
 - Carlos Palhares
+- Garett Arrowood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,9 +81,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: []
@@ -96,6 +112,10 @@ files:
 - Rakefile
 - config/default.yml
 - 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