rubocop-eightyfourcodes 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3bdcf879f5dbd72c539cfb616e85279915721d3520667359a6613c8183425c5
-  data.tar.gz: 8052007c2529fef3406fa5a0b3560720ff373030ef1ddbd12b85c96b62e0eac1
+  metadata.gz: 19712be6c6408b1056c9c1c664e27d6663fc10a9722e3e185f730241817a25d4
+  data.tar.gz: a85bd64721dbe996d990ec7315da27f0ac6bf7dc7bd92a0ced8db3b6d916ccdd
 SHA512:
-  metadata.gz: 329bf23841b2ba450a8fa291fda6ec57bc709f47036e8cb528f6fec1abca6155febc27417fab729acbe6aed0f64456484ed8d2938795d23d71062703ffe3ba50
-  data.tar.gz: a8bd924b5f4e3dfe379d4ee2651ae156dd7c30654c4293de210b6973e03132449d414d45a8948fcd431d2b225844bea177d908fb16985cf019155a673d8e73ed
+  metadata.gz: 42b8a8f7ee06570552cabf4a2172956124ab78ce6f3a1ead118485f490f550a56389966e8c4ce1692b42cc974d0312186caae7384f14e7c96e62e527e816e9ec
+  data.tar.gz: d731529270d4e2ba9601e11baaf9f957e15be5971f8f9128a02eb52a5f2e171ea33158eefeb917207dc243d55ea0acae2149ffb1b9d5691832b1a81590be9b72

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-eightyfourcodes.rb
+RSpec/ExampleLength:
+  Max: 10

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.0.3 (2024-10-23)
+
+- Recreated entire project using <https://github.com/rubocop/rubocop-extension-generator>
+- Added `EnsureRedirect`
+
+## 0.0.2 (2020-09-24)
+
+- Added `RubyVersionFile`: Ensure we read Gemfile ruby version from `.ruby-version` file
+
 ## 0.0.1 (2019-09-11)
 
 - Forked from gitlab-security

data/Gemfile

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+# Specify your gem's dependencies in rubocop-eightyfourcodes.gemspec
 gemspec
 
 group :development, :test do
-  gem 'pry'
-  gem 'rspec', '~> 3.6.0'
-  gem 'rubocop-rspec', '~> 1.21.0'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
+  gem 'yard'
 end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    rubocop-eightyfourcodes (0.0.3)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.67.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.1.0)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.6.0)
+    yard (0.9.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  rubocop
+  rubocop-eightyfourcodes!
+  rubocop-rake
+  rubocop-rspec
+  yard
+
+BUNDLED WITH
+   2.5.22

data/LICENSE.md

@@ -1,4 +1,6 @@
-Copyright (c) 2019 eightyfourcodes AB
+The MIT License (MIT)
+
+Copyright (c) 2024 84codes AB
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -7,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,20 +1,16 @@
+# Rubocop::EightyFourCodes
+
 This is a collection of cops developed and used by 84codes AB
-This code is based heavily upon the [rubocop-gitlab-security](https://gitlab.com/gitlab-org/rubocop-gitlab-security)
-code released under the MIT License.
 
 ## Installation
 
-Just install the `rubocop-eightyfourcodes` gem
+Install the gem and add to the application's Gemfile by executing:
 
-```bash
-gem install rubocop-eightyfourcodes
-```
+    bundle add rubocop-eightyfourcodes --require=false
 
-or if you use bundler put this in your `Gemfile`
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-```yaml
-gem 'rubocop-eightyfourcodes'
-```
+    gem install rubocop-eightyfourcodes
 
 ## Usage
 
@@ -32,64 +28,20 @@ require: rubocop-eightyfourcodes
 Now you can run `rubocop` and it will automatically load the RuboCop eightyfourcodes
 cops together with the standard cops.
 
-### Command line
-
-```bash
-rubocop --require rubocop-eightyfourcodes
-```
-
-### Rake task
+## Development
 
-```ruby
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-eightyfourcodes'
-end
-```
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-## Inspecting specific files
+Use `bundle exec rake 'new_cop[EightyFourCodes/CommandLiteralInjection]'` to generate a new cop.
 
-By default, `rubocop-eightyfourcodes` inspects all files. You can override this setting in your config file by specifying one or more patterns:
+The [NodePattern Debugger](https://nodepattern.herokuapp.com/) is a very helpful resource when creating new AST matchers.
 
-```yaml
-# Inspect all files
-AllCops:
-  EightyFourCodes:
-    Patterns:
-    - '.+'
-```
-
-```yaml
-# Inspect only controller files.
-AllCops:
-  EightyFourCodes:
-    Patterns:
-    - app/controllers/**/*.rb
-```
-
-## The Cops
-
-All cops are located under
-[`lib/rubocop/cop/eightyfourcodes`](lib/rubocop/cop/eightyfourcodes), and contain
-examples/documentation.
-
-In your `.rubocop.yml`, you may treat the eightyfourcodes cops just like any other
-cop. For example:
-
-```yaml
-EightyFourCodes/CommandLiteralInjection:
-  Exclude:
-    - 'spec/**/*'
-```
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Merge Request
+Bug reports and pull requests are welcome on GitHub at <https://github.com/84codes/rubocop-eightyfourcodes>.
 
 ## License
 
-`rubocop-eightyfourcodes` is MIT licensed. [See the accompanying file](LICENSE.md) for
-the full text.
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/eightyfourcodes_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -1,9 +1,14 @@
----
-AllCops:
-  EightyFourCodes:
-    Patterns:
-      - ".+"
+# Write it!
 
 EightyFourCodes/CommandLiteralInjection:
-  Description: Check for Command Injection in `` and %x
+  Description: "Do not include variables command literals"
   Enabled: true
+  VersionAdded: "0.0.1"
+EightyFourCodes/RubyVersionFile:
+  Description: "Control Ruby version via .ruby-version"
+  Enabled: true
+  VersionAdded: "0.0.2"
+EightyFourCodes/EnsureRedirect:
+  Description: "Checks for `redirect` from an `ensure` block"
+  Enabled: true
+  VersionAdded: "0.0.3"

data/lib/rubocop/cop/{eightyfourcodes → eighty_four_codes}/command_literal_injection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop
     module EightyFourCodes
@@ -15,8 +17,8 @@ module RuboCop
       #   # even better
       #   exec("/bin/ls", shell_escape(filename))
       #
-      class CommandLiteralInjection < RuboCop::Cop::Cop
-        MSG = 'Do not include variables command literals. Use parameters "system(cmd, params)" or exec() instead'.freeze
+      class CommandLiteralInjection < Base
+        MSG = 'Do not include variables command literals. Use parameters "system(cmd, params)" or exec() instead'
 
         def_node_matcher :literal_var?, <<-PATTERN
           (begin ...)

data/lib/rubocop/cop/eighty_four_codes/ensure_redirect.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module EightyFourCodes
+      # Checks for `redirect` from an `ensure` block.
+      # `redirect` from an ensure block is a dangerous code smell as it
+      # will take precedence over any exception being raised,
+      # and the exception will be silently thrown away as if it were rescued.
+      #
+      # If you want to rescue some (or all) exceptions, best to do it explicitly
+      #
+      # @example
+      #
+      #   # bad
+      #   def foo
+      #     do_something
+      #   ensure
+      #     cleanup
+      #     redirect "/"
+      #   end
+      #
+      #
+      #   # good
+      #   def foo
+      #     begin
+      #       do_something
+      #     rescue SomeException
+      #       # Let's ignore this exception
+      #     end
+      #     redirect "/"
+      #   ensure
+      #     cleanup
+      #   end
+      class EnsureRedirect < Base
+        MSG = 'Do not redirect from an `ensure` block.'
+
+        def on_ensure(node)
+          # `:send` nodes represent method calls, so we look for send nodes and then check if they are `redirect`
+          node.body&.each_node(:send) do |send_node|
+            # Check if the method name being called is `redirect`
+            add_offense(send_node) if send_node.method?(:redirect)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/eighty_four_codes/ruby_version_file.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module EightyFourCodes
+      # Read Ruby version from a .ruby-version file
+      #
+      # Instead of staticly defining the Ruby runtime version in Gemfile, load it from
+      # a .ruby-version file definition. As this Ruby version file is read by rbenv, chruby etc
+      # it's much easier for the developer to work with multiple projects with different versions.
+      #
+      # @example
+      #   # bad
+      #   ruby 2.6.6
+      #
+      #   # good
+      #   ruby File.read('.ruby-version')
+      class RubyVersionFile < Base
+        extend AutoCorrector
+
+        MSG = "Control Ruby version via .ruby-version, fix by replacing with File.read('.ruby-version')"
+
+        RESTRICT_ON_SEND = %i[ruby].freeze
+
+        def_node_matcher :static_version_found?, <<~PATTERN
+          (send nil? :ruby
+            $(str _))
+        PATTERN
+
+        def on_send(node)
+          return unless File.basename(processed_source.file_path).eql?('Gemfile')
+
+          static_version_found?(node) do |source_node, source|
+            message = format(MSG, source: source)
+
+            add_offense(source_node, message: message) do |corrector|
+              corrector.replace(source_node, "File.read('.ruby-version')")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/eightyfourcodes_cops.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'eighty_four_codes/command_literal_injection'
+require_relative 'eighty_four_codes/ensure_redirect'
+require_relative 'eighty_four_codes/ruby_version_file'

data/lib/rubocop/eightyfourcodes/inject.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
 module RuboCop
   module EightyFourCodes
     # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
@@ -6,7 +10,7 @@ module RuboCop
       def self.defaults!
         path = CONFIG_DEFAULT.to_s
         hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
         puts "configuration from #{path}" if ConfigLoader.debug?
         config = ConfigLoader.merge_with_default(config, path)
         ConfigLoader.instance_variable_set(:@default_configuration, config)

data/lib/rubocop/eightyfourcodes/version.rb

@@ -2,9 +2,6 @@
 
 module RuboCop
   module EightyFourCodes
-    # Version information for the eightyfourcodes Rubocop plugin.
-    module Version
-      STRING = '0.0.1'
-    end
+    VERSION = '0.0.3'
   end
 end

data/lib/rubocop/eightyfourcodes.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'eightyfourcodes/version'
+
 module RuboCop
-  # RuboCop RSpec project namespace
+  # Namespace for EightyFourCodes cops
   module EightyFourCodes
+    class Error < StandardError; end
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
     CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze

data/lib/rubocop-eightyfourcodes.rb

@@ -1,22 +1,11 @@
-require 'pathname'
-require 'yaml'
+# frozen_string_literal: true
 
 require 'rubocop'
 
-require 'rubocop/eightyfourcodes'
-require 'rubocop/eightyfourcodes/version'
-require 'rubocop/eightyfourcodes/inject'
-require 'rubocop/eightyfourcodes/top_level_describe'
-require 'rubocop/eightyfourcodes/wording'
-require 'rubocop/eightyfourcodes/util'
-require 'rubocop/eightyfourcodes/language'
-require 'rubocop/eightyfourcodes/language/node_pattern'
-require 'rubocop/eightyfourcodes/concept'
-require 'rubocop/eightyfourcodes/example_group'
-require 'rubocop/eightyfourcodes/example'
-require 'rubocop/eightyfourcodes/hook'
-require 'rubocop/cop/eightyfourcodes/cop'
+require_relative 'rubocop/eightyfourcodes'
+require_relative 'rubocop/eightyfourcodes/version'
+require_relative 'rubocop/eightyfourcodes/inject'
 
 RuboCop::EightyFourCodes::Inject.defaults!
 
-require 'rubocop/cop/eightyfourcodes/command_literal_injection'
+require_relative 'rubocop/cop/eightyfourcodes_cops'

data/sig/rubocop/eightyfourcodes.rbs

@@ -0,0 +1,6 @@
+module Rubocop
+  module EightyFourCodes
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -1,85 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-eightyfourcodes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Anders Bälter
-- Brian Neel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2024-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.51'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.51'
-- !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  Basic security checking for Ruby files.
-  A plugin for the RuboCop code style enforcing & linting tool.
+description: 'A plugin for the RuboCop code style enforcing & linting tool.
+
+  '
 email:
-- anders@eightyfourcodes.com
-- brian@gitlab.com
+- anders@84codes.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.md
 - README.md
 files:
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
-- CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.md
 - README.md
+- Rakefile
 - config/default.yml
 - lib/rubocop-eightyfourcodes.rb
-- lib/rubocop/cop/eightyfourcodes/command_literal_injection.rb
-- lib/rubocop/cop/eightyfourcodes/cop.rb
+- lib/rubocop/cop/eighty_four_codes/command_literal_injection.rb
+- lib/rubocop/cop/eighty_four_codes/ensure_redirect.rb
+- lib/rubocop/cop/eighty_four_codes/ruby_version_file.rb
+- lib/rubocop/cop/eightyfourcodes_cops.rb
 - lib/rubocop/eightyfourcodes.rb
-- lib/rubocop/eightyfourcodes/concept.rb
-- lib/rubocop/eightyfourcodes/config_formatter.rb
-- lib/rubocop/eightyfourcodes/description_extractor.rb
-- lib/rubocop/eightyfourcodes/example.rb
-- lib/rubocop/eightyfourcodes/example_group.rb
-- lib/rubocop/eightyfourcodes/hook.rb
 - lib/rubocop/eightyfourcodes/inject.rb
-- lib/rubocop/eightyfourcodes/language.rb
-- lib/rubocop/eightyfourcodes/language/node_pattern.rb
-- lib/rubocop/eightyfourcodes/top_level_describe.rb
-- lib/rubocop/eightyfourcodes/util.rb
 - lib/rubocop/eightyfourcodes/version.rb
-- lib/rubocop/eightyfourcodes/wording.rb
-- rubocop-eightyfourcodes.gemspec
+- sig/rubocop/eightyfourcodes.rbs
 homepage: https://github.com/84codes/rubocop-eightyfourcodes/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,15 +65,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
-summary: Basic security checks for projects
+summary: This is a collection of cops developed and used by 84codes AB.
 test_files: []

data/CONTRIBUTING.md

@@ -1,3 +0,0 @@
-# Contributing
-
-<https://docs.rubocop.org/en/latest/contributing/>