rubocop-redis 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 479c3bae5bed1f65f985ba12a41b57828d03a74a822066112fde6fa9f478214a
+  data.tar.gz: fb9ea8b8ff4c8f586d9e060a49a085abef336c15e04f5a8d6155f568fa6c9854
+SHA512:
+  metadata.gz: a72c9dd2111a7708d6a2be7dd647c429f6eb35ed4be3f9b241d708ea6120b245608dfa87458eaf9f926162cf42882b950cc86ea82e1500275ade15e2047f61ce
+  data.tar.gz: 440440c4c738fc46270389dbc1810ab63066bcd420703d8776c79cce00f5fba9d98f92d78384916ad731addd1d8abfae335fb8160fc4602cf9067d19716f467d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiterals:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 999
+
+Naming/FileName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-redis-rb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/README.md

@@ -0,0 +1,27 @@
+# rubocop-redis
+
+An extension of RuboCop for [redis/redis-rb](https://github.com/redis/redis-rb) Redis client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-redis'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-redis
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/9sako6/rubocop-redis.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/default.yml

@@ -0,0 +1,6 @@
+# This is the default configuration file.
+
+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"

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Redis
+      # This cop detects the use of `KEYS` query that should be noted when used in a production environment.
+      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."
+
+        def_node_matcher :keys_call?, <<~PATTERN
+          (send
+            (send
+              (const {cbase nil?} :Redis) :current) :keys $...)
+        PATTERN
+
+        def on_send(node)
+          return unless keys_call?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/redis_cops.rb

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

data/lib/rubocop/redis/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Redis
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        project_root = Pathname.new(__dir__).parent.parent.parent.expand_path
+        config_default = project_root.join('config', 'default.yml')
+        path = config_default.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = RuboCop::Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/redis/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rubocop
+  module Redis
+    VERSION = "0.1.2"
+  end
+end

data/lib/rubocop/redis.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # RuboCop Redis project namespace
+  module Redis
+  end
+end

data/lib/rubocop-redis.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require_relative "rubocop/redis"
+require_relative "rubocop/redis/version"
+require_relative "rubocop/redis/inject"
+
+RuboCop::Redis::Inject.defaults!
+
+require_relative 'rubocop/cop/redis_cops'

data/rubocop-redis.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rubocop/redis/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rubocop-redis"
+  spec.version = Rubocop::Redis::VERSION
+  spec.authors = ["9sako6"]
+  spec.email = ["31821663+9sako6@users.noreply.github.com"]
+
+  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.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"
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- 9sako6
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-24 00:00:00.000000000 Z
+dependencies: []
+description: An extension of RuboCop for redis/redis gem.
+email:
+- 31821663+9sako6@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-redis.rb
+- lib/rubocop/cop/redis/not_keys.rb
+- lib/rubocop/cop/redis_cops.rb
+- lib/rubocop/redis.rb
+- lib/rubocop/redis/inject.rb
+- lib/rubocop/redis/version.rb
+- rubocop-redis.gemspec
+homepage: https://github.com/9sako6/rubocop-redis
+licenses: []
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.4
+signing_key: 
+specification_version: 4
+summary: An extension of RuboCop for redis/redis gem.
+test_files: []