Merge pull request #120 from basecamp/rubocop

Set up RuboCop with CI

Author: guilleiguaran

.github/workflows/rubocop.yml

@@ -0,0 +1,22 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Ruby 3.2
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+        bundler-cache: true
+
+    - name: Run RuboCop
+      run: bundle exec rubocop --parallel

.gitignore

@@ -1 +1,2 @@
 *.gem
+.rubocop-*

.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: https://raw.githubusercontent.com/rails/rails/main/.rubocop.yml

Gemfile

@@ -1,6 +1,14 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
 gem "rake"
 gem "debug", ">= 1.0.0"
+gem "rubocop"
+gem "rubocop-minitest"
+gem "rubocop-packaging"
+gem "rubocop-performance"
+gem "rubocop-rails"
+gem "rubocop-md"

Gemfile.lock

@@ -68,6 +68,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.1.8)
     connection_pool (2.4.1)
@@ -83,6 +84,8 @@ GEM
     io-console (0.6.0)
     irb (1.7.1)
       reline (>= 0.3.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -101,6 +104,10 @@ GEM
       racc (~> 1.4)
     nokogiri (1.15.2-x86_64-darwin)
       racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
     racc (1.7.1)
     rack (2.2.3)
     rack-test (1.1.0)
@@ -131,13 +138,43 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (~> 1.0)
+    rainbow (3.1.1)
     rake (13.0.3)
     redis (5.0.6)
       redis-client (>= 0.9.0)
     redis-client (0.14.1)
       connection_pool
+    regexp_parser (2.8.1)
     reline (0.3.6)
       io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.54.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-md (1.2.0)
+      rubocop (>= 1.0)
+    rubocop-minitest (0.31.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-packaging (0.5.2)
+      rubocop (>= 1.33, < 2.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.20.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-progressbar (1.13.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -148,6 +185,7 @@ GEM
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -163,6 +201,12 @@ DEPENDENCIES
   kredis!
   rails (>= 6.0.0)
   rake
+  rubocop
+  rubocop-md
+  rubocop-minitest
+  rubocop-packaging
+  rubocop-performance
+  rubocop-rails
 
 BUNDLED WITH
    2.3.12

README.md

@@ -21,11 +21,11 @@ integer.value = 5  # => SET myinteger "5"
 5 == integer.value # => GET myinteger
 
 decimal = Kredis.decimal "mydecimal" # accuracy!
-decimal.value = "%.47f" % (1.0/10) # => SET mydecimal "0.10000000000000000555111512312578270211815834045"
+decimal.value = "%.47f" % (1.0 / 10) # => SET mydecimal "0.10000000000000000555111512312578270211815834045"
 BigDecimal("0.10000000000000000555111512312578270211815834045e0") == decimal.value # => GET mydecimal
 
 float = Kredis.float "myfloat" # speed!
-float.value = 1.0/10 # => SET myfloat "0.1"
+float.value = 1.0 / 10 # => SET myfloat "0.1"
 0.1 == float.value # => GET myfloat
 
 boolean = Kredis.boolean "myboolean"
@@ -228,14 +228,14 @@ If you need to connect to Redis with SSL, the recommended approach is to set you
 
 ```ruby
 Kredis::Connections.connections[:shared] = Redis.new(
-  url: ENV['REDIS_URL'],
+  url: ENV["REDIS_URL"],
   ssl_params: {
     cert_store: OpenSSL::X509::Store.new.tap { |store|
-      store.add_file(Rails.root.join('config', 'ca_cert.pem').to_s)
+      store.add_file(Rails.root.join("config", "ca_cert.pem").to_s)
     },
 
     cert: OpenSSL::X509::Certificate.new(File.read(
-      Rails.root.join('config', 'client.crt')
+      Rails.root.join("config", "client.crt")
     )),
 
     key: OpenSSL::PKey::RSA.new(

bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "irb"
 require "bundler/inline"

bin/test

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 $: << File.expand_path("../test", __dir__)
 
 require "bundler/setup"

kredis.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/kredis/version"
 
 Gem::Specification.new do |s|

lib/install/install.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 yaml_path = Rails.root.join("config/redis/shared.yml")
 unless yaml_path.exist?
   say "Adding `config/redis/shared.yml`"