rubocop-cobra 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ed15eb1f676621c8de867b79b277b407fb36c862ef88291a732d84859799dda
-  data.tar.gz: 9e9de6b0bcc5c13b049b86ac861d5986fe0b79d016b7b14cf3d3dc14ea098a17
+  metadata.gz: 76f52eec926c6471df7602e1b37f8a71b95e3f912e9b9dfa68e7630e51c775aa
+  data.tar.gz: 0ab74366792c29c478052b70ad37c082b14950e708d2112fbd7ab762686d2391
 SHA512:
-  metadata.gz: bea53660dadb8c6518e1bfd9da50655db656aa0780aac9c0414fc28d54da82484726cd4934ee9d293c618ea1043a5e2a762922873319fcefd946abc76847a2f2
-  data.tar.gz: edd88e7a7d8224e3c2bb968fbeb5fa519c21971978d97e92adb901f955e1526b159c348cbf93d1875627f752f1371ac5f194ffe891edb6ce60287b11278190bb
+  metadata.gz: 6df224d48e7b2f42150dcab95017a47fdaf0565becfab8d2582e981f989c793aa373932bbc7fd73966efb0bfd92abf391e0ee8559fdbcde61b7986fd4b29cf96
+  data.tar.gz: 4ff949b8763fb54ded35ff09b3250c46d64a2a69a1b67c79aa346716c0cd6d7410e027c04ee87c5d7705e7fa0febfb3774a94b3c02a3e1c93a0f3e7da9cf8d0f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.4.0] - 2022-06-01
+
+- Adds Cobra/ViewComponentFilePlacement cop
+
 ## [0.1.0] - 2022-05-18
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../rubocop-powerhome
   specs:
-    rubocop-powerhome (0.3.0)
+    rubocop-powerhome (0.4.0)
       rubocop
       rubocop-performance
       rubocop-rails
@@ -11,7 +11,7 @@ PATH
 PATH
   remote: .
   specs:
-    rubocop-cobra (0.3.0)
+    rubocop-cobra (0.4.0)
       rubocop
       rubocop-powerhome
 
@@ -24,15 +24,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)
@@ -61,7 +70,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-performance (1.14.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rails (2.14.2)
@@ -82,6 +91,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

@@ -55,3 +55,8 @@ Cobra/PresenterFilePlacement:
   Description: 'This cop disallows adding global presenters to the `app/presenters` directory.'
   Enabled: true
   VersionAdded: '0.1.0'
+
+Cobra/ViewComponentFilePlacement:
+  Description: 'This cop disallows adding global view_components to the `app/components` directory.'
+  Enabled: true
+  VersionAdded: '0.4.0'

data/lib/rubocop/cobra/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Cobra
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/rubocop/cop/cobra/view_component_file_placement.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Cobra
+      # This cop disallows adding global view_components to the `app/components` directory.
+      #
+      # The goal is to encourage developers to put new view_components inside the correct
+      # namespace, where they can be more modularly isolated and ownership is clear.
+      #
+      # The correct namespace is `app/components/my_component/resource/view_component.rb.
+      # Similar to how `app/views` templates are nested in a directory named after the controller's resource.
+      #
+      # @example
+      #   # bad
+      #   # path: components/my_component/app/components/foo_component.rb
+      #   class FooComponent < ::ViewComponent::Base
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #   # path: components/my_component/app/components/my_component/foo_component.rb
+      #   module MyComponent
+      #     class FooComponent < MyComponent::ApplicationComponent
+      #       # ...
+      #     end
+      #   end
+      #
+      #   # acceptable
+      #   # path: components/my_component/app/components/my_component/application_component.rb
+      #   module MyComponent
+      #     class ApplicationComponent < ::ViewComponent::Base
+      #         # ...
+      #       end
+      #     end
+      #   end
+      #
+      #   # good
+      #   # path: components/my_component/app/components/my_component/resource/foo_component.rb
+      #   module MyComponent
+      #     module Resource
+      #       class FooComponent < MyComponent::ApplicationComponent
+      #         # ...
+      #       end
+      #     end
+      #   end
+      #
+      class ViewComponentFilePlacement < RuboCop::Cop::Cop
+        FILE_PLACEMENT_MSG =
+          "Nest ViewComponent definitions in the parent component and resource namespace. " \
+          "For example: `%<correct_path>s`"
+
+        def investigate(processed_source)
+          return if processed_source.blank?
+          return unless path_contains_matcher?
+          return if namespaced_correctly?
+
+          add_offense(processed_source.ast,
+                      message: format(FILE_PLACEMENT_MSG, correct_path: correct_path))
+        end
+
+      private
+
+        def view_components_path
+          "app/components/"
+        end
+
+        def path
+          @path ||= processed_source.file_path
+        end
+
+        def namespaced_correctly?
+          potential_component_name = component_name
+          component_path = File.join(
+            potential_component_name,
+            view_components_path,
+            potential_component_name
+          )
+          return false unless path.include?("#{component_path}/")
+
+          sub_path = path.split("#{component_path}/").last
+          sub_path.include?("/") || sub_path == "application_component.rb"
+        end
+
+        def correct_path
+          file = path.split("/").last
+          "#{view_components_path}#{component_name}/<resource>/#{file}"
+        end
+
+        def component_name
+          path.split(view_components_path).first.split("/").last
+        end
+
+        def path_contains_matcher?
+          path.include?(view_components_path)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cobra_cops.rb

@@ -16,6 +16,7 @@ module RuboCop
       require_relative "cobra/mailer_file_placement"
       require_relative "cobra/model_file_placement"
       require_relative "cobra/presenter_file_placement"
+      require_relative "cobra/view_component_file_placement"
     end
   end
 end

data/rubocop-cobra.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/rubocop/cobra/version"
 Gem::Specification.new do |spec|
   spec.name = "rubocop-cobra"
   spec.version = RuboCop::Cobra::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 = "Cobra rubocop linters"
   spec.description = "Cobra rubocop linters"
@@ -38,4 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rubocop"
   spec.add_runtime_dependency "rubocop-powerhome"
   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-cobra
 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
@@ -38,9 +39,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: Cobra rubocop linters
 email:
 - chjunior@gmail.com
+- garettarrowood@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -70,6 +86,7 @@ files:
 - lib/rubocop/cop/cobra/mailer_file_placement.rb
 - lib/rubocop/cop/cobra/model_file_placement.rb
 - lib/rubocop/cop/cobra/presenter_file_placement.rb
+- lib/rubocop/cop/cobra/view_component_file_placement.rb
 - lib/rubocop/cop/cobra_cops.rb
 - rubocop-cobra.gemspec
 - sig/rubocop/cobra.rbs