rubocop-redis 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32561f1c19ab9a331fbf7a88828bae2c51e3b688235e8f8d632439c7ed4e94a6
-  data.tar.gz: ffb1a9c65495fff2393ec0f8a3ad5550c1a469b018bc5fce2772890c1bb7167b
+  metadata.gz: 819ed1dc44a32d761db56ef63fff4c104deab950463ab50eca791ae2c566b94e
+  data.tar.gz: d1934717d789352034216cda7d24d5d3daf4e27b33bf6e9b3e9eeb1c3efc91c5
 SHA512:
-  metadata.gz: fe622f73bfcbabf171f47123943bf8be995cbfd2725190126d377bda9b2e0b504db423706b027e8935050a06d60a4ba9e35845059b4acf9dd7652a4043c5e135
-  data.tar.gz: 57d7310c4f3f42fa851aaa6114c38ac221ebcb330ae342a89a12d27b3a0b2c3f935e8e66aedda59bf69068202c135d2afa5f23163e4651a0feeb70678c20e5b7
+  metadata.gz: 5dcee7ad178036bb28f08abf1d41834833471642aa4ed7e414052a20f694ca5d00a4fdd363f494565fef3051d70876aee9fae24b04510f26424ad5a4905d259e
+  data.tar.gz: 33b33abc9a8d42ba38752a7380dd48bb702aa9ccef3e00a8089f9f922073058d5813a0cd66f8090dd0dad53e0f1c130a0473baad0fa51c230c645ac744fc5707

data/README.md

@@ -1,5 +1,7 @@
 # rubocop-redis
 
+[![test](https://github.com/9sako6/rubocop-redis/actions/workflows/test.yml/badge.svg)](https://github.com/9sako6/rubocop-redis/actions/workflows/test.yml)
+
 An extension of RuboCop for [redis/redis-rb](https://github.com/redis/redis-rb) Redis client.
 
 ## Documentation

data/config/default.yml

@@ -4,3 +4,10 @@ Redis/NotKeys:
   Description: "Do not use `.keys`. It may ruin performance when it is executed against large databases. See https://redis.io/commands/keys/ for details."
   Enabled: true
   VersionAdded: "0.1"
+  Safe: false
+
+Redis/Setex:
+  Description: "Use `setex`"
+  Enabled: true
+  VersionAdded: "0.1"
+  Safe: true

data/docs/modules/ROOT/pages/cops_redis.adoc

@@ -6,7 +6,7 @@
 | Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Enabled
-| Yes
+| No
 | No
 | 0.1
 | -
@@ -16,7 +16,7 @@ This cop detects the use of `KEYS` query that should be noted when used in a pro
 Consider using `SCAN` query instead of `KEYS` query.
 See https://redis.io/commands/keys/ for details.
 
-To avoid detecting `Hash#keys` calling, this cop adds an offense if a receiver of `keys` method is named `redis`.
+To avoid detecting `Hash#keys` calling, this cop adds an offense only if a receiver of `keys` method is named `redis`.
 
 === Examples
 
@@ -38,3 +38,32 @@ loop do
 end
 all_keys
 ----
+
+== Redis/Setex
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Enabled
+| Yes
+| No
+| 0.1
+| -
+|===
+
+Use `setex` method instead of calling both `set` and `expire` methods in a transaction.
+See https://redis.io/commands/setex/ for details.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+redis.multi do
+  redis.set(key, value)
+  redis.expire(key, 120)
+end
+
+# good
+redis.setex(key, 120, value)
+----

data/lib/rubocop/cop/redis/setex.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Redis
+      # Use `setex` method instead of calling both `set` and `expire` methods in a transaction.
+      # See https://redis.io/commands/setex/ for details.
+      #
+      # @example
+      #   # bad
+      #   redis.multi do
+      #     redis.set(key, value)
+      #     redis.expire(key, 120)
+      #   end
+      #
+      #   # good
+      #   redis.setex(key, 120, value)
+      #
+      class Setex < Base
+        MSG = "Use `setex` method instead of calling both `set` and `expire` methods in a transaction."
+
+        def_node_matcher :multi_block?, <<~PATTERN
+          (block $(send ... :multi) args (begin $...))
+        PATTERN
+
+        def_node_matcher :match_set_call?, <<~PATTERN
+          (send ($...) :set ...)
+        PATTERN
+
+        def_node_matcher :match_expire_call?, <<~PATTERN
+          (send ($...) :expire ...)
+        PATTERN
+
+        RESTRICT_ON_SEND = %i[sets expire].freeze
+
+        def on_block(node)
+          return unless multi_block?(node)
+          return unless match_set_and_expire_in_multi_block?(node)
+
+          add_offense(node)
+        end
+
+        private
+
+        def match_set_and_expire_in_multi_block?(node)
+          _, statements = multi_block?(node)
+          result = false
+          called_set = false
+
+          statements.each do |statement|
+            called_set = true if match_set_call?(statement)
+
+            result = true if called_set && match_expire_call?(statement)
+          end
+
+          result
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/redis_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'redis/not_keys'
+require_relative 'redis/setex'

data/lib/rubocop/redis/version.rb

@@ -2,6 +2,6 @@
 
 module Rubocop
   module Redis
-    VERSION = "0.1.4"
+    VERSION = "0.1.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - 9sako6
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies: []
 description: An extension of RuboCop for redis/redis gem.
 email:
@@ -28,6 +28,7 @@ files:
 - docs/modules/ROOT/pages/cops_redis.adoc
 - lib/rubocop-redis.rb
 - lib/rubocop/cop/redis/not_keys.rb
+- lib/rubocop/cop/redis/setex.rb
 - lib/rubocop/cop/redis_cops.rb
 - lib/rubocop/redis.rb
 - lib/rubocop/redis/inject.rb