Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEV: Fix linting #353

Merged
merged 6 commits into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 30 additions & 16 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,34 @@ on:
pull_request:

jobs:
build:
lint:
runs-on: ubuntu-latest
timeout-minutes: 5

steps:
- uses: actions/checkout@v4

- uses: ruby/setup-ruby@v1
with:
ruby-version: "3.3"
bundler-cache: true

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Setup npm
run: npm install

- name: Rubocop
run: bundle exec rubocop

- name: ESLint
run: npx eslint .

test:
runs-on: ubuntu-latest
name: Ruby ${{ matrix.ruby }} (redis ${{ matrix.redis }})
timeout-minutes: 10
Expand All @@ -20,7 +47,7 @@ jobs:
strategy:
fail-fast: false
matrix:
ruby: [2.6, 2.7, '3.0', 3.1]
ruby: [2.6, 2.7, "3.0", 3.1]
redis: [5, 6]

services:
Expand Down Expand Up @@ -50,27 +77,14 @@ jobs:
ruby-version: ${{ matrix.ruby }}
bundler-cache: true

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: npm

- name: Setup npm
run: npm install

- name: Tests
env:
TESTOPTS: --verbose
run: bundle exec rake
timeout-minutes: 3

- name: Linting
run: npx eslint .

publish:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
needs: build
needs: [lint, test]
runs-on: ubuntu-latest

steps:
Expand Down
8 changes: 6 additions & 2 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
inherit_gem:
rubocop-discourse: .rubocop.yml
rubocop-discourse: stree-compat.yml
inherit_mode:
merge:
- Exclude

AllCops:
Exclude:
- 'examples/**/*'
- "examples/**/*"

Discourse/Plugins:
Enabled: false

RSpec:
Enabled: false
6 changes: 2 additions & 4 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ require 'rake/testtask'
require 'bundler'
require 'bundler/gem_tasks'
require 'bundler/setup'
require 'rubocop/rake_task'
require 'yard'

Bundler.require(:default, :test)

RuboCop::RakeTask.new
YARD::Rake::YardocTask.new

BACKENDS = Dir["lib/message_bus/backends/*.rb"].map { |file| file.match(%r{backends/(?<backend>.*).rb})[:backend] } - ["base"]
Expand Down Expand Up @@ -99,5 +97,5 @@ task :performance do
end
end

desc "Run all tests, link checks and confirms documentation compiles without error"
task default: [:spec, :rubocop, :test_doc]
desc "Run all tests and confirm the documentation compiles without error"
task default: [:spec, :test_doc]
3 changes: 1 addition & 2 deletions lib/message_bus.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# frozen_string_literal: true

require "monitor"
require "set"

require_relative "message_bus/version"
require_relative "message_bus/message"
Expand Down Expand Up @@ -772,7 +771,7 @@ def global_subscribe_thread
globals, locals, local_globals, global_globals = nil

@mutex.synchronize do
return if @destroyed
return if @destroyed # rubocop:disable Lint/NonLocalExitFromIterator
next unless @subscriptions

globals = @subscriptions[nil]
Expand Down
1 change: 0 additions & 1 deletion lib/message_bus/backends/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ module Backends
#
# @abstract
class Base
# rubocop:disable Lint/UnusedMethodArgument

# Raised to indicate that the concrete backend implementation does not implement part of the API
ConcreteClassMustImplementError = Class.new(StandardError)
Expand Down
2 changes: 1 addition & 1 deletion lib/message_bus/backends/postgres.rb
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ def global_subscribe(last_id = nil)
on.message do |_c, m|
if m == UNSUB_MESSAGE
@subscribed = false
return
return # rubocop:disable Lint/NonLocalExitFromIterator
end
m = MessageBus::Message.decode m

Expand Down
2 changes: 1 addition & 1 deletion lib/message_bus/backends/redis.rb
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ def global_subscribe(last_id = nil, &blk)
if m == UNSUB_MESSAGE
@subscribed = false
global_redis.unsubscribe
return
return # rubocop:disable Lint/NonLocalExitFromIterator
end
m = MessageBus::Message.decode m

Expand Down
6 changes: 4 additions & 2 deletions message_bus.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Gem::Specification.new do |gem|
gem.add_development_dependency 'byebug'
gem.add_development_dependency 'oj'
gem.add_development_dependency 'yard'
gem.add_development_dependency 'rubocop-discourse'
gem.add_development_dependency 'rubocop-rspec'

if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
gem.add_development_dependency 'rubocop-discourse', '3.8.1'
end
end
2 changes: 1 addition & 1 deletion spec/lib/message_bus/multi_process_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def work_it
if msg.data == "done"
bus.global_unsubscribe
else
bus.publish("/response", "#{msg.data}-#{Process.pid.to_s}")
bus.publish("/response", "#{msg.data}-#{Process.pid}")
end
end
ensure
Expand Down
2 changes: 1 addition & 1 deletion spec/spec_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
puts "Running with backend: #{CURRENT_BACKEND}"

def test_only(*backends)
skip "Test doesn't apply to #{CURRENT_BACKEND}" unless backends.include?(CURRENT_BACKEND)
skip "Test doesn't apply to #{CURRENT_BACKEND}" if backends.exclude?(CURRENT_BACKEND)
end

def test_never(*backends)
Expand Down
Loading