rubocop-view_component 0.1.0

data/spec/rubocop/cop/view_component/prefer_private_methods_spec.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
+  let(:config) { RuboCop::Config.new }
+
+  context "when component has public helper methods" do
+    it "registers offense for public helper method" do
+      expect_offense(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def initialize(title)
+            @title = title
+          end
+
+          def formatted_title
+          ^^^^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making this method private. Only ViewComponent interface methods should be public.
+            @title.upcase
+          end
+        end
+      RUBY
+    end
+
+    it "registers offense for multiple public helpers" do
+      expect_offense(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def helper_one
+          ^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making this method private. Only ViewComponent interface methods should be public.
+            'one'
+          end
+
+          def helper_two
+          ^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making this method private. Only ViewComponent interface methods should be public.
+            'two'
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when helper methods are already private" do
+    it "does not register offense" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def initialize(title)
+            @title = title
+          end
+
+          private
+
+          def formatted_title
+            @title.upcase
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "with allowed public interface methods" do
+    it "allows initialize" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def initialize(title)
+            @title = title
+          end
+        end
+      RUBY
+    end
+
+    it "allows call" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def call
+            'rendered'
+          end
+        end
+      RUBY
+    end
+
+    it "allows before_render" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def before_render
+            @computed = true
+          end
+        end
+      RUBY
+    end
+
+    it "allows render?" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def render?
+            @show
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "with mixed visibility" do
+    it "only flags public methods" do
+      expect_offense(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def public_helper
+          ^^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making this method private. Only ViewComponent interface methods should be public.
+            'public'
+          end
+
+          private
+
+          def private_helper
+            'private'
+          end
+
+          public
+
+          def another_public
+          ^^^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making this method private. Only ViewComponent interface methods should be public.
+            'public'
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when not a ViewComponent" do
+    it "does not register offense" do
+      expect_no_offenses(<<~RUBY)
+        class RegularClass
+          def public_method
+            'public'
+          end
+        end
+      RUBY
+    end
+  end
+end

data/spec/rubocop/cop/view_component/prefer_slots_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::ViewComponent::PreferSlots, :config do
+  let(:config) { RuboCop::Config.new }
+
+  context "when initialize has HTML parameter names" do
+    it "registers offense for _html suffix" do
+      expect_offense(<<~RUBY)
+        class ModalComponent < ViewComponent::Base
+          def initialize(title:, body_html:)
+                                 ^^^^^^^^^^ ViewComponent/PreferSlots: Consider using `renders_one :body` instead of passing HTML as a parameter. This maintains Rails' automatic HTML escaping.
+            @title = title
+            @body_html = body_html
+          end
+        end
+      RUBY
+    end
+
+    it "registers offense for _content suffix" do
+      expect_offense(<<~RUBY)
+        class ModalComponent < ViewComponent::Base
+          def initialize(title:, body_content:)
+                                 ^^^^^^^^^^^^^ ViewComponent/PreferSlots: Consider using `renders_one :body` instead of passing HTML as a parameter. This maintains Rails' automatic HTML escaping.
+            @title = title
+            @body_content = body_content
+          end
+        end
+      RUBY
+    end
+
+    it "registers offense for html_ prefix" do
+      expect_offense(<<~RUBY)
+        class ModalComponent < ViewComponent::Base
+          def initialize(title:, html_body:)
+                                 ^^^^^^^^^^ ViewComponent/PreferSlots: Consider using `renders_one :body` instead of passing HTML as a parameter. This maintains Rails' automatic HTML escaping.
+            @title = title
+            @html_body = html_body
+          end
+        end
+      RUBY
+    end
+
+    it "registers offense for content parameter" do
+      expect_offense(<<~RUBY)
+        class ModalComponent < ViewComponent::Base
+          def initialize(title:, content:)
+                                 ^^^^^^^^ ViewComponent/PreferSlots: Consider using `renders_one :content` instead of passing HTML as a parameter. This maintains Rails' automatic HTML escaping.
+            @title = title
+            @content = content
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when parameter has html_safe default value" do
+    it "registers offense" do
+      expect_offense(<<~RUBY)
+        class ModalComponent < ViewComponent::Base
+          def initialize(title:, body: "".html_safe)
+                                 ^^^^^^^^^^^^^^^^^^ ViewComponent/PreferSlots: Consider using `renders_one :body` instead of passing HTML as a parameter. This maintains Rails' automatic HTML escaping.
+            @title = title
+            @body = body
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when parameters are not HTML-related" do
+    it "does not register offense for regular parameters" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def initialize(title:, description:)
+            @title = title
+            @description = description
+          end
+        end
+      RUBY
+    end
+
+    it "does not register offense for html_class" do
+      expect_no_offenses(<<~RUBY)
+        class CardComponent < ViewComponent::Base
+          def initialize(title:, html_class:)
+            @title = title
+            @html_class = html_class
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when not a ViewComponent" do
+    it "does not register offense" do
+      expect_no_offenses(<<~RUBY)
+        class RegularClass
+          def initialize(body_html:)
+            @body_html = body_html
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when component uses slots" do
+    it "does not register offense" do
+      expect_no_offenses(<<~RUBY)
+        class ModalComponent < ViewComponent::Base
+          renders_one :body
+
+          def initialize(title:)
+            @title = title
+          end
+        end
+      RUBY
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rubocop-view_component"
+require "rubocop/rspec/support"
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
+  config.raise_on_warning = true
+  config.fail_if_no_examples = true
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-view_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Waite
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+description: A RuboCop extension that enforces ViewComponent best practices and conventions
+email:
+- andyw8@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- IMPLEMENTATION_SUMMARY.md
+- LICENSE.txt
+- PLAN.md
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-view_component.rb
+- lib/rubocop/cop/view_component/base.rb
+- lib/rubocop/cop/view_component/component_suffix.rb
+- lib/rubocop/cop/view_component/no_global_state.rb
+- lib/rubocop/cop/view_component/prefer_private_methods.rb
+- lib/rubocop/cop/view_component/prefer_slots.rb
+- lib/rubocop/cop/view_component_cops.rb
+- lib/rubocop/view_component.rb
+- lib/rubocop/view_component/plugin.rb
+- lib/rubocop/view_component/version.rb
+- spec/rubocop/cop/view_component/component_suffix_spec.rb
+- spec/rubocop/cop/view_component/no_global_state_spec.rb
+- spec/rubocop/cop/view_component/prefer_private_methods_spec.rb
+- spec/rubocop/cop/view_component/prefer_slots_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/andyw8/rubocop-view_component
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andyw8/rubocop-view_component
+  source_code_uri: https://github.com/andyw8/rubocop-view_component
+  default_lint_roller_plugin: RuboCop::ViewComponent::Plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: RuboCop extension for ViewComponent best practices
+test_files: []