rubocop-cobra 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ed15eb1f676621c8de867b79b277b407fb36c862ef88291a732d84859799dda
-  data.tar.gz: 9e9de6b0bcc5c13b049b86ac861d5986fe0b79d016b7b14cf3d3dc14ea098a17
+  metadata.gz: 07b98212c7432d3e5fd8d00f879f6c242d121c74e9d24ba1b1d56c708410d78b
+  data.tar.gz: bbc10babcde31d9bcbadebf4dd8970f113ecbfc2737c8c459a9a2677e2fa3e35
 SHA512:
-  metadata.gz: bea53660dadb8c6518e1bfd9da50655db656aa0780aac9c0414fc28d54da82484726cd4934ee9d293c618ea1043a5e2a762922873319fcefd946abc76847a2f2
-  data.tar.gz: edd88e7a7d8224e3c2bb968fbeb5fa519c21971978d97e92adb901f955e1526b159c348cbf93d1875627f752f1371ac5f194ffe891edb6ce60287b11278190bb
+  metadata.gz: 502c3e50f0e19b791160b2b0ef46e3439525ca0fa67fa1b3df225dcc854e8187221bb8004f4b2a926714c970fa8db38dfbca28a876c500297aaa403a79ec37b5
+  data.tar.gz: 00625d665102cbab491e723b57911c005078b89a41ddd5007e5394db1023f621ec192c45fc06ecec1fd78844bf658a8ac3d9b857362c6a5a4db21b24ff26d10a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.4.2] - 2023-02-08
+
+- Permit Rubocop upgrades again because bug was fixed.
+
+## [0.4.1] - 2023-02-08
+
+- Hold back version of Rubocop that's permitted due to incompatibility with our implementation.
+
+## [0.4.0] - 2022-06-01
+
+- Adds Cobra/ViewComponentFilePlacement cop
+
 ## [0.1.0] - 2022-05-18
 
 - Initial release

data/Gemfile

@@ -7,6 +7,6 @@ gemspec
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.29.1"
+gem "rubocop", "~> 1.44.0"
 
 gem "rubocop-powerhome", path: "../rubocop-powerhome"

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: ../rubocop-powerhome
   specs:
-    rubocop-powerhome (0.3.0)
-      rubocop
+    rubocop-powerhome (0.5.2)
+      rubocop (~> 1.37)
       rubocop-performance
       rubocop-rails
       rubocop-rake
@@ -11,82 +11,113 @@ PATH
 PATH
   remote: .
   specs:
-    rubocop-cobra (0.3.0)
-      rubocop
+    rubocop-cobra (0.4.2)
+      rubocop (~> 1.37)
       rubocop-powerhome
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.0)
     diff-lcs (1.5.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.15.0)
+    json (2.6.3)
+    license_finder (7.1.0)
+      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.17.0)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.2.0.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 (3.0.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.4.0)
+    regexp_parser (2.6.2)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.29.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.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.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.14.2)
+    rubocop-rails (2.17.4)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
+      rubocop (>= 1.33.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+    rubyzip (2.3.2)
+    thor (1.2.1)
+    tomlrb (2.0.3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
+    with_env (1.1.0)
+    xml-simple (1.1.9)
+      rexml
 
 PLATFORMS
   arm64-darwin-21
+  ruby
+  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.44.0)
   rubocop-cobra!
   rubocop-powerhome!
 
 BUNDLED WITH
-   2.3.7
+   2.3.14

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/doc/dependency_decisions.yml

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

data/lib/rubocop/cobra/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Cobra
-    VERSION = "0.3.0"
+    VERSION = "0.4.2"
   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/mkdocs.yml

@@ -0,0 +1,9 @@
+site_name: Rubocop Cobra
+site_description: Gem focused on providing Cops to support a healthy cobra app development
+repo_url: https://github.com/powerhome/power_linting
+edit_uri: edit/main/rubocop_cobra/docs/
+nav:
+  - 'Home': 'README.md'
+
+plugins:
+  - techdocs-core

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"
@@ -35,7 +35,10 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
 
-  spec.add_runtime_dependency "rubocop"
+  spec.add_runtime_dependency "rubocop", "~> 1.37"
   spec.add_runtime_dependency "rubocop-powerhome"
   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,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cobra
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Carlos Palhares
+- Garett Arrowood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.37'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.37'
 - !ruby/object:Gem::Dependency
   name: rubocop-powerhome
   requirement: !ruby/object:Gem::Requirement
@@ -38,9 +39,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: Cobra rubocop linters
 email:
 - chjunior@gmail.com
+- garettarrowood@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -51,9 +81,10 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.md
 - Rakefile
 - config/default.yml
+- doc/dependency_decisions.yml
+- docs/README.md
 - lib/rubocop-cobra.rb
 - lib/rubocop/cobra.rb
 - lib/rubocop/cobra/inject.rb
@@ -70,7 +101,9 @@ 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
+- mkdocs.yml
 - rubocop-cobra.gemspec
 - sig/rubocop/cobra.rbs
 homepage: https://github.com/powerhome/power_linting
@@ -96,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Cobra rubocop linters