Sign upLogin

igrigorik/vimgolf

View on GitHub
Star
lib/vimgolf/lib/vimgolf/cli.rb

Summary

Maintainability
C
1 day
Test Coverage
B
85%

Possible command injection
Open

        system(*vimcmd) # assembled as an array, bypasses the shell
Severity: Minor
Found in lib/vimgolf/lib/vimgolf/cli.rb by brakeman

Injection is #1 on the 2010 OWASP Top Ten web security risks. Command injection occurs when shell commands unsafely include user-manipulatable values.

There are many ways to run commands in Ruby:

`ls #{params[:file]}`

system("ls #{params[:dir]}")

exec("md5sum #{params[:input]}")

Brakeman will warn on any method like these that uses user input or unsafely interpolates variables.

See the Ruby Security Guide for details.

Method play has a Cognitive Complexity of 45 (exceeds 5 allowed). Consider refactoring.
Open

    def play(challenge)
      begin
        challenge.start
        VimGolf.ui.warn "Launching VimGolf session for challenge: #{challenge.id}"
        # -Z         - restricted mode, utilities not allowed
Severity: Minor
Found in lib/vimgolf/lib/vimgolf/cli.rb - About 6 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Method play has 82 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def play(challenge)
      begin
        challenge.start
        VimGolf.ui.warn "Launching VimGolf session for challenge: #{challenge.id}"
        # -Z         - restricted mode, utilities not allowed
Severity: Major
Found in lib/vimgolf/lib/vimgolf/cli.rb - About 3 hrs to fix

    There are no issues that match your filters.

    Category
    Status