rubocop-powerhome 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39410b7a81b2f413f11e1d7a47c47fcff5a16d5ad1c0967cc687fb94595354e4
-  data.tar.gz: 4e8c866ddee5a181de4b72a28aa739052e74c5071d7f75dbc4b2fa546574eeac
+  metadata.gz: dd64fd1998b87999ae9bb7099b5679bb6a30761b12737cd35f88e49781fc4e7c
+  data.tar.gz: 4396dfb22ae26ef117a7c68c90deaba21702c47621eb70c5a4685118aec74850
 SHA512:
-  metadata.gz: dc6ddad8767fe3f5f5c8a1574f3a69214d870e46e8b7e182bd53c4d4f02a3a586e5a74cd9d85d18a5cc01419171849ef71bb64c1503f5f50ed55b1404d62aee8
-  data.tar.gz: 219f37850a53709de7b8953899da72ff31edb5e3dcb50b459d55451d24f0050a7e5ec685449ebbded657106bc1f21ee4820e05e90444f6cee6f2a3055cb05212
+  metadata.gz: e402c21a5d9f395620d5681c40f7738aebbd50666f94dacb14db765f66f749768bbe8f4cf030e4761449b99073264315c945b65b49229b55c91d632280d21600
+  data.tar.gz: 7b722eab1a5f6bdbcb4d2e3b52b5d694aca839745079263e421d6c4740216d0ca4d0148783032fa119ecc07e35f6a0fe2f2ab6a9139ee41f408c4a5ca32f984b

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,14 @@
 ## [Unreleased]
 
+## [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
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-powerhome (0.2.0)
+    rubocop-powerhome (0.4.1)
       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/README.md

@@ -1,13 +1,13 @@
 # Rubocop::Powerhome
 
-This gem is focused on providing standard rubocop configuration for Power Home Remodeling ruby apps.
+This gem is focused on providing standard Rubocop configuration for Power Home Remodeling ruby apps.
 
 ## Installation
 
 Add this line to your application's Gemfile under development:
 
 ```ruby
-gem 'rubocop-powerhome', require: false
+gem "rubocop-powerhome", require: false
 ```
 
 And then execute:
@@ -25,6 +25,8 @@ require:
 
 That's it! You can override the standard configuration after that.
 
+It's recommended that you set `AllCops/TargetRubyVersion` in your project because some cops are Ruby version-dependent. See more [here](https://docs.rubocop.org/rubocop/configuration.html#setting-the-target-ruby-version).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -37,4 +39,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/powerh
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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.2.0"
+    VERSION = "0.4.1"
   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,14 +5,14 @@ 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"
   spec.homepage = "https://github.com/powerhome/power_linting"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -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.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Carlos Palhares
+- Garett Arrowood
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2022-06-02 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
@@ -117,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="