Points out annoying things in Ruby code
Ruby Cucumber
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
features
lib
spec
.document
.gitignore
.rspec
.rvmrc
CHANGELOG.md
Gemfile
LICENSE.txt
README.markdown
Rakefile
VERSION
skeptic.gemspec

README.markdown

skeptic

Skeptic is a very experimental static code analyzer for Ruby 1.9. It points out annoying things in your Ruby code.

I am using it for a Ruby course in the University of Sofia. All the assignments the students hand it should adhere to specific style, that is automatically checked with Skeptic. Assignments that fail to meet the criteria are rejected outright. The main assumption is the "theory" of constraints - when one operates under constraints, one is more creative and ends up learning more.

You should probably not use it for anything.

Installation

Skeptic can be installed as a Ruby gem, either via gem install skeptic, or better yet via Bundler.

Make sure that you have the aspell package installed in your system, along with its shared libraries (libaspell). If you're on OS X, you can use Homebrew to do that:

brew install aspell

You may have to set the following ruby ENV variables. You can do this by adding them to your shell initialization file.

export LANGUAGE=en_US.UTF-8
export LC_CTYPE=en_US.UTF-8
export LC_ALL=en_US.UTF-8

On other Linux/Unix distributions, you are free to use a package manager or another installation method of choice.

For Windows systems, check out GNU Aspell for Win32. Install Aspell using the "Full Installer" linked in that page, then locate aspell-15.dll in the installation (usually in C:\Program Files (x86)\Aspell\bin) and copy it in the same folder as aspell.dll. After that, add the path to aspell.dll in your PATH environment variable (again, you'd usually have to add C:\Program Files (x86)\Aspell\bin). These instructions have been verified to work with a 32-bit version of Ruby. They might not be applicable to a 64-bit Ruby installation.

A lot of people miss that. You need to install an English dictionary from the list in the Aspell home page (precompiled dictionaries section). Otherwise Aspell will crash with segmentation fault if you try to use the `english-words-for-names' check.

Rules

Skeptic checks if the code complies to a number of rules and reports the violations. Here is a list of the rules:

  • Valid syntax - skeptic can check if your syntax is valid.
  • Line length - line length does not exceed a certain number.
  • Lines per method - methods are at most N lines long. Ignores empty lines and lines with end
  • Max nesting depth - at most N levels of nesting. Blocks, conditions and loops are considered a level of nesting.
  • Methods per class - the number of methods per class does not exceed a certain number
  • No semicolons - stops you from using semicolons as expression delimiters.
  • No trailing whitespace - points out if your lines end on whitespace.
  • Naming conventions - checks if the names of variables/methods/classes follow the conventions
  • No global variables - does not allow the use of global variables
  • Max method arity - limits the arguments count per method
  • Spaces around operators - checks for spaces around operators
  • English words for names - detection of non-English words in names

Copyright

Copyright (c) 2011 Stefan Kanev. See LICENSE.txt for further details.