rubocop-redis 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479c3bae5bed1f65f985ba12a41b57828d03a74a822066112fde6fa9f478214a
-  data.tar.gz: fb9ea8b8ff4c8f586d9e060a49a085abef336c15e04f5a8d6155f568fa6c9854
+  metadata.gz: 88c0751305ae0be68873bb027ea34611d02059c3654606f6d5b77ff935edd243
+  data.tar.gz: 6e2c5281ebbe7fa262938b722aeabe69c07f9ed20ad3966b2e70ad4e14b06454
 SHA512:
-  metadata.gz: a72c9dd2111a7708d6a2be7dd647c429f6eb35ed4be3f9b241d708ea6120b245608dfa87458eaf9f926162cf42882b950cc86ea82e1500275ade15e2047f61ce
-  data.tar.gz: 440440c4c738fc46270389dbc1810ab63066bcd420703d8776c79cce00f5fba9d98f92d78384916ad731addd1d8abfae335fb8160fc4602cf9067d19716f467d
+  metadata.gz: 2b9afb62bf8d1c0c49c5aa12ad03d1b53bc2d2eee67b24414fb0ee0ea373d682c7611eee4e4f4d97fc996305e8f64619b4c44f109dc1cd77e6a0f1884a57f3b3
+  data.tar.gz: 275ad6cee5146caed431c517a661ac9d919029a55e3412374dccaaed47628751595d89e54a863515caffafbb05b2e302559afa346ef3877b0378cbb0cdfa6d26

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "yard", "~> 0.9.28"

data/LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2022 9sako6
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,6 +2,10 @@
 
 An extension of RuboCop for [redis/redis-rb](https://github.com/redis/redis-rb) Redis client.
 
+## Documentation
+
+You can read a lot more about rubocop-redis in its [docs](docs/modules/ROOT/pages/cops_redis.adoc).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,8 +24,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You need to tell RuboCop to load the Redis extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-redis
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-redis
+```
+
+Now you can run `rubocop` and it will automatically load the rubocop-redis
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-redis
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-redis'
+end
+```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/9sako6/rubocop-redis.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+load "tasks/doc.rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -9,4 +10,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[spec rubocop update_cops_documentation]

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

@@ -0,0 +1,35 @@
+= Redis
+
+== Redis/NotKeys
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Enabled
+| Yes
+| No
+| 0.1
+| -
+|===
+
+This cop detects the use of `KEYS` query that should be noted when used in a production environment.
+Consider using `SCAN` query instead of `KEYS` query.
+See https://redis.io/commands/keys/ for details.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+Redis.current.keys("pattern-*")
+
+# good
+cursor = 0
+all_keys = []
+loop do
+  cursor, keys = Redis.current.scan(cursor, match: "pattern-*")
+  all_keys += keys
+  break if cursor == "0"
+end
+all_keys
+----

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

@@ -4,6 +4,23 @@ module RuboCop
   module Cop
     module Redis
       # This cop detects the use of `KEYS` query that should be noted when used in a production environment.
+      # Consider using `SCAN` query instead of `KEYS` query.
+      # See https://redis.io/commands/keys/ for details.
+      #
+      # @example
+      #   # bad
+      #   Redis.current.keys("pattern-*")
+      #
+      #   # good
+      #   cursor = 0
+      #   all_keys = []
+      #   loop do
+      #     cursor, keys = Redis.current.scan(cursor, match: "pattern-*")
+      #     all_keys += keys
+      #     break if cursor == "0"
+      #   end
+      #   all_keys
+      #
       class NotKeys < Base
         MSG = "Do not use `.keys`. It may ruin performance when it is executed against large databases. See https://redis.io/commands/keys/ for details."
 
@@ -13,6 +30,8 @@ module RuboCop
               (const {cbase nil?} :Redis) :current) :keys $...)
         PATTERN
 
+        RESTRICT_ON_SEND = %i[keys].freeze
+
         def on_send(node)
           return unless keys_call?(node)
 

data/lib/rubocop/redis/version.rb

@@ -2,6 +2,6 @@
 
 module Rubocop
   module Redis
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/rubocop-redis.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |spec|
   spec.summary = "An extension of RuboCop for redis/redis gem."
   spec.description = "An extension of RuboCop for redis/redis gem."
   spec.homepage = "https://github.com/9sako6/rubocop-redis"
+  spec.license = 'MIT'
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/9sako6/rubocop-redis"
-  spec.metadata["changelog_uri"] = "https://github.com/9sako6/rubocop-redis"
+  spec.metadata["changelog_uri"] = "https://github.com/9sako6/rubocop-redis/releases"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/tasks/doc.rake

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'rubocop'
+require_relative '../lib/rubocop-redis'
+require 'rubocop/cops_documentation_generator'
+
+YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
+  task.files = ['lib/rubocop/cop/**/*.rb']
+  task.options = ['--no-output']
+end
+
+task update_cops_documentation: :yard_for_generate_documentation do
+  deps = ['Redis']
+
+  # NOTE: Update `<<next>>` version for docs/modules/ROOT/pages/cops_redis.adoc
+  # when running release tasks.
+  RuboCop::Redis::Inject.defaults!
+
+  CopsDocumentationGenerator.new(departments: deps).call
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - 9sako6
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies: []
 description: An extension of RuboCop for redis/redis gem.
 email:
@@ -20,9 +20,12 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - config/default.yml
+- docs/modules/ROOT/pages/cops.adoc
+- docs/modules/ROOT/pages/cops_redis.adoc
 - lib/rubocop-redis.rb
 - lib/rubocop/cop/redis/not_keys.rb
 - lib/rubocop/cop/redis_cops.rb
@@ -30,13 +33,15 @@ files:
 - lib/rubocop/redis/inject.rb
 - lib/rubocop/redis/version.rb
 - rubocop-redis.gemspec
+- tasks/doc.rake
 homepage: https://github.com/9sako6/rubocop-redis
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/9sako6/rubocop-redis
   source_code_uri: https://github.com/9sako6/rubocop-redis
-  changelog_uri: https://github.com/9sako6/rubocop-redis
-post_install_message: 
+  changelog_uri: https://github.com/9sako6/rubocop-redis/releases
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: An extension of RuboCop for redis/redis gem.
 test_files: []