rubocop-cable_ready 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2917b152ca55dac54178332b058c19488c338d586aa15e67b77061e474281011
-  data.tar.gz: 7411b6898d713a078fc49f7c8273e51fa351013a3888701e4f3a7f98a1d7af10
+  metadata.gz: 8d53a99f06039b50d0b41b94062a4eef19834fca34b749af1a9503e7acbef8ed
+  data.tar.gz: ecb21ade65d6d3c38a2d81d25355078c8c5a05d6442e8ca2bd9b13c1fb94b75f
 SHA512:
-  metadata.gz: 2fa42e00a308bb687d7fa06d9647b4a7740fb598b8d328e190f35210188e7d487f1284e1a022c2d5864c9730d139503500212495265ccab00dde53c118b9a1e0
-  data.tar.gz: 354c79132f70afeb1eeb85243f341d0025bcb2bf6ee8e0226ba4566941a67fed748972e9b5cb1eb7c90a769ad501f260bff4e2aac9838e2d99d23402e41ed96b
+  metadata.gz: 26ec37c74856e9c4d84830f13aaaf04973ab82d6e5a01caf011546bcf09a4f2bc8daa7a0e73833572abdfcdb438454fb9695a5cfaa40a8b3c9051f92ad478cf7
+  data.tar.gz: 488feee9dba724d37c8ecc0542bbf266ce610d9ad18d11ee67e7d3c7edd3b22c29b2e3850bf258bf78979856b65a985e055732a9fa9e0cf811bd6cb16a2b2e37

data/.github/workflows/ruby.yml

@@ -5,14 +5,20 @@ on: [push, pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+       matrix:
+         ruby-version: [2.6, 2.7, '3.0', 3.1, 3.2]
     steps:
     - uses: actions/checkout@v2
 
-    - name: Set up Ruby
+    - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.1
+        ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
 
+    - name: Lint
+      run: bundle exec rubocop
+
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rspec spec

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*~

data/.rubocop.yml

@@ -20,3 +20,7 @@ Layout/LineLength:
 Naming/FileName:
   Exclude:
     - lib/rubocop-cable_ready.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb

data/CHANGELOG.md

@@ -1,5 +1,3 @@
-## [Unreleased]
+## Changelog
 
-## [0.1.0] - 2021-06-28
-
-- Initial release
+Please see [GitHub](https://github.com/marcoroth/rubocop-cable_ready/releases) for detailed changelogs.

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    diff-lcs (1.4.4)
     minitest (5.14.4)
     parallel (1.20.1)
     parser (3.0.1.1)
@@ -17,6 +18,19 @@ GEM
     rake (13.0.3)
     regexp_parser (2.1.1)
     rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rubocop (1.17.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -32,12 +46,14 @@ GEM
     unicode-display_width (2.0.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-19
   x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
+  rspec
   rubocop (~> 1.7)
   rubocop-cable_ready!
 

data/README.md

@@ -1,4 +1,4 @@
-# Rubocop::CableReady
+# RuboCop::CableReady
 
 CableReady-specific analysis for your projects, as an extension to [RuboCop](https://github.com/rubocop/rubocop).
 
@@ -58,6 +58,100 @@ RuboCop::RakeTask.new do |task|
 end
 ```
 
+## Cops
+
+#### `CableReady/ApplicationRecordEnableUpdates`
+
+| Enabled by default | Supports autocorrection | Include | Version Added | Version Changed |
+| --- | --- | --- | --- | --- |
+| true | No | `app/models/**/*.rb` | 0.2.0 | 0.2.0 |
+
+The `enable_cable_ready_updates` class method shouldn't be called in `ApplicationRecord`. Instead call `enable_cable_ready_updates` in every model you want to track and broadcast updates.
+
+
+##### Examples
+
+```ruby
+# bad
+
+class ApplicationRecord < ActiveRecord::Base
+  include CableReady::Updatable
+
+  enable_cable_ready_updates on: :update
+end
+
+
+# good
+
+class Post < ApplicationRecord
+  include CableReady::Updatable
+
+  enable_cable_ready_updates on: :update
+end
+
+
+# good
+
+class ApplicationRecord < ActiveRecord::Base
+  include CableReady::Updatable
+end
+
+class Post < ApplicationRecord
+  enable_cable_ready_updates on: :update
+end
+```
+
+----
+
+#### `CableReady/BroadcasterControllerAction`
+
+| Enabled by default | Supports autocorrection | Include | Version Added | Version Changed |
+| --- | --- | --- | --- | --- |
+| false | No | `app/controllers/**/*.rb` | 0.2.0 | 0.2.0 |
+
+It's discouraged to broadcast CableReady broadcasts from Controller actions.
+
+##### Examples
+
+```ruby
+# bad
+
+def create
+  cable_ready[UserChannel]
+    .append(selector: "...", html: "...")
+    .broadcast
+end
+
+
+# good
+
+def create
+end
+```
+
+----
+
+#### `CableReady/UnusedCableReadyCall`
+
+| Enabled by default | Supports autocorrection | Include | Version Added | Version Changed |
+| --- | --- | --- | --- | --- |
+| true | No | `app/**/*.rb` | 0.1.0 | 0.1.0 |
+
+The `cable_ready` method shouldn't be called without being followed by an operation.
+
+##### Examples
+
+```ruby
+# bad
+
+cable_ready
+
+
+# good
+
+cable_ready.inner_html(...)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -74,4 +168,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rubocop::CableReady project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/rubocop-cable_ready/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RuboCop::CableReady project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/rubocop-cable_ready/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
+require "rubocop"
 require "rubocop/cable_ready"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/config/default.yml

@@ -1,5 +1,15 @@
 ---
-CableReady:
+CableReady/ApplicationRecordEnableUpdates:
+  Enabled: true
+  Include:
+    - "app/models/**/*.rb"
+
+CableReady/BroadcasterControllerAction:
+  Enabled: false
+  Include:
+    - "app/controllers/**/*.rb"
+
+CableReady/UnusedCableReadyCall:
   Enabled: true
   Include:
     - "**/*.rb"

data/lib/rubocop/cable_ready/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Rubocop
+module RuboCop
   module CableReady
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rubocop/cable_ready.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Rubocop
+module RuboCop
   module CableReady
   end
 end

data/lib/rubocop/cop/cable_ready/application_record_enable_updates.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module CableReady
+      class ApplicationRecordEnableUpdates < Base
+        MSG = "%<method_name>s should not be switched on globally"
+
+        def_node_search :active_record_base_class?, <<~PATTERN
+          (const (const nil? :ActiveRecord) :Base)
+        PATTERN
+
+        def_node_matcher :is_application_record?, <<~PATTERN
+          (const nil? :ApplicationRecord)
+        PATTERN
+
+        def on_send(node)
+          receiver_node, _method_name, *_arg_nodes = *node.parent.parent
+
+          return unless %i[enable_updates enable_cable_ready_updates].include?(node.method_name)
+
+          return unless is_application_record?(receiver_node)
+
+          return unless node.ancestors.any? { |ancestor| active_record_base_class?(ancestor) }
+
+          message = format(MSG, method_name: node.method_name)
+          add_offense(node, message: message)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cable_ready/broadcaster_controller_action.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module CableReady
+      class BroadcasterControllerAction < Base
+        MSG = "CableReady::Broadcaster should not be used in a Rails controller action"
+
+        def_node_search :action_controller_base_class?, <<~PATTERN
+          (const (const nil? :ActionController) :Base)
+        PATTERN
+
+        def on_send(node)
+          return if node.method_name != :include
+
+          return unless node.ancestors.any? { |ancestor| action_controller_base_class?(ancestor) }
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cable_ready_cops.rb

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
+require_relative "cable_ready/application_record_enable_updates"
+require_relative "cable_ready/broadcaster_controller_action"
 require_relative "cable_ready/unused_cable_ready_call"

data/rubocop-cable_ready.gemspec

@@ -4,7 +4,7 @@ require_relative "lib/rubocop/cable_ready/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rubocop-cable_ready"
-  spec.version       = Rubocop::CableReady::VERSION
+  spec.version       = RuboCop::CableReady::VERSION
   spec.authors       = ["Marco Roth"]
   spec.email         = ["marco.roth@hey.com"]
 
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rubocop-ast", ">= 1.1.0"
 
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cable_ready
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Code style checking for CableReady
 email:
 - marco.roth@hey.com
@@ -76,7 +90,9 @@ files:
 - lib/rubocop/cable_ready.rb
 - lib/rubocop/cable_ready/inject.rb
 - lib/rubocop/cable_ready/version.rb
+- lib/rubocop/cop/cable_ready/application_record_enable_updates.rb
 - lib/rubocop/cop/cable_ready/base.rb
+- lib/rubocop/cop/cable_ready/broadcaster_controller_action.rb
 - lib/rubocop/cop/cable_ready/unused_cable_ready_call.rb
 - lib/rubocop/cop/cable_ready_cops.rb
 - rubocop-cable_ready.gemspec
@@ -102,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Code style checking for CableReady