ruby-lint 0.0.1a → 0.0.1a1

data/.yardopts

@@ -1,4 +1,4 @@
-./lib/rlint/**/*.rb ./lib/rlint.rb
+./lib/ruby-lint/**/*.rb ./lib/ruby-lint.rb
 -m markdown
 -M redcarpet
 -o ./doc/build

data/MANIFEST

@@ -6,74 +6,77 @@ LICENSE
 MANIFEST
 README.md
 Rakefile
-bin/rlint
+bin/ruby-lint
 doc/.gitkeep
 doc/build/.gitkeep
 doc/css/.gitkeep
 doc/css/common.css
-lib/rlint.rb
-lib/rlint/analyze/coding_style.rb
-lib/rlint/analyze/definitions.rb
-lib/rlint/analyze/method_validation.rb
-lib/rlint/analyze/shadowing_variables.rb
-lib/rlint/analyze/undefined_variables.rb
-lib/rlint/analyze/unused_variables.rb
-lib/rlint/callback.rb
-lib/rlint/cli.rb
-lib/rlint/constant_importer.rb
-lib/rlint/definition.rb
-lib/rlint/formatter/text.rb
-lib/rlint/helper/definition_resolver.rb
-lib/rlint/helper/scoping.rb
-lib/rlint/iterator.rb
-lib/rlint/options.rb
-lib/rlint/parser.rb
-lib/rlint/parser_error.rb
-lib/rlint/report.rb
-lib/rlint/token/assignment_token.rb
-lib/rlint/token/begin_rescue_token.rb
-lib/rlint/token/block_token.rb
-lib/rlint/token/case_token.rb
-lib/rlint/token/class_token.rb
-lib/rlint/token/method_definition_token.rb
-lib/rlint/token/method_token.rb
-lib/rlint/token/parameters_token.rb
-lib/rlint/token/regexp_token.rb
-lib/rlint/token/statement_token.rb
-lib/rlint/token/token.rb
-lib/rlint/token/variable_token.rb
-lib/rlint/version.rb
+lib/ruby-lint.rb
+lib/ruby-lint/analyze/coding_style.rb
+lib/ruby-lint/analyze/definitions.rb
+lib/ruby-lint/analyze/method_validation.rb
+lib/ruby-lint/analyze/shadowing_variables.rb
+lib/ruby-lint/analyze/undefined_variables.rb
+lib/ruby-lint/analyze/unused_variables.rb
+lib/ruby-lint/callback.rb
+lib/ruby-lint/cli.rb
+lib/ruby-lint/constant_importer.rb
+lib/ruby-lint/definition.rb
+lib/ruby-lint/formatter/text.rb
+lib/ruby-lint/helper/definition_resolver.rb
+lib/ruby-lint/helper/scoping.rb
+lib/ruby-lint/iterator.rb
+lib/ruby-lint/options.rb
+lib/ruby-lint/parser.rb
+lib/ruby-lint/parser_error.rb
+lib/ruby-lint/report.rb
+lib/ruby-lint/token/assignment_token.rb
+lib/ruby-lint/token/begin_rescue_token.rb
+lib/ruby-lint/token/block_token.rb
+lib/ruby-lint/token/case_token.rb
+lib/ruby-lint/token/class_token.rb
+lib/ruby-lint/token/method_definition_token.rb
+lib/ruby-lint/token/method_token.rb
+lib/ruby-lint/token/parameters_token.rb
+lib/ruby-lint/token/regexp_token.rb
+lib/ruby-lint/token/statement_token.rb
+lib/ruby-lint/token/token.rb
+lib/ruby-lint/token/variable_token.rb
+lib/ruby-lint/version.rb
 ruby-lint.gemspec
 spec/benchmarks/memory.rb
 spec/benchmarks/parse_parser.rb
+spec/fixtures/stdlib/un.rb
 spec/helper.rb
-spec/rlint/analyze/coding_style.rb
-spec/rlint/analyze/definitions/classes.rb
-spec/rlint/analyze/definitions/methods.rb
-spec/rlint/analyze/definitions/modules.rb
-spec/rlint/analyze/definitions/variables.rb
-spec/rlint/analyze/method_validation.rb
-spec/rlint/analyze/shadowing_variables.rb
-spec/rlint/analyze/undefined_variables.rb
-spec/rlint/analyze/unused_variables.rb
-spec/rlint/callback.rb
-spec/rlint/constant_importer.rb
-spec/rlint/definition.rb
-spec/rlint/formatter/text.rb
-spec/rlint/iterator.rb
-spec/rlint/parser/arrays.rb
-spec/rlint/parser/classes.rb
-spec/rlint/parser/errors.rb
-spec/rlint/parser/hashes.rb
-spec/rlint/parser/methods.rb
-spec/rlint/parser/modules.rb
-spec/rlint/parser/objects.rb
-spec/rlint/parser/operators.rb
-spec/rlint/parser/procs.rb
-spec/rlint/parser/ranges.rb
-spec/rlint/parser/regexp.rb
-spec/rlint/parser/scalars.rb
-spec/rlint/parser/statements.rb
-spec/rlint/parser/variables.rb
-spec/rlint/report.rb
+spec/ruby-lint/analyze/coding_style.rb
+spec/ruby-lint/analyze/complex/un.rb
+spec/ruby-lint/analyze/definitions/classes.rb
+spec/ruby-lint/analyze/definitions/methods.rb
+spec/ruby-lint/analyze/definitions/modules.rb
+spec/ruby-lint/analyze/definitions/variables.rb
+spec/ruby-lint/analyze/method_validation.rb
+spec/ruby-lint/analyze/shadowing_variables.rb
+spec/ruby-lint/analyze/undefined_variables.rb
+spec/ruby-lint/analyze/unused_variables.rb
+spec/ruby-lint/callback.rb
+spec/ruby-lint/constant_importer.rb
+spec/ruby-lint/definition.rb
+spec/ruby-lint/formatter/text.rb
+spec/ruby-lint/iterator.rb
+spec/ruby-lint/parser/arrays.rb
+spec/ruby-lint/parser/classes.rb
+spec/ruby-lint/parser/errors.rb
+spec/ruby-lint/parser/hashes.rb
+spec/ruby-lint/parser/methods.rb
+spec/ruby-lint/parser/modules.rb
+spec/ruby-lint/parser/objects.rb
+spec/ruby-lint/parser/operators.rb
+spec/ruby-lint/parser/procs.rb
+spec/ruby-lint/parser/ranges.rb
+spec/ruby-lint/parser/regexp.rb
+spec/ruby-lint/parser/scalars.rb
+spec/ruby-lint/parser/statements.rb
+spec/ruby-lint/parser/variables.rb
+spec/ruby-lint/report.rb
+task/manifest.rake
 task/test.rake

data/README.md

@@ -1,12 +1,12 @@
 # README
 
-**Rlint is currently alpha quality, expect things to break and change without
+**RubyLint is currently alpha quality, expect things to break and change without
 notice. Patches and bug reports are more than welcome.**
 
-Rlint (short name for Ruby Lint) is a linter and static code analysis tool for
-Ruby inspired by similar tools such as JSHint. It makes it possible for
-developers to detect errors such as undefined (or unused) variables and the
-use of non existing methods.
+Ruby Lint is a linter and static code analysis tool for Ruby inspired by
+similar tools such as JSHint. It makes it possible for developers to detect
+errors such as undefined (or unused) variables and the use of non existing
+methods.
 
 ## Requirements
 
@@ -15,32 +15,133 @@ use of non existing methods.
 
 ## Installation
 
-Rlint can be installed by running the following command:
+RubyLint can be installed by running the following command:
 
-    $ gem install ruby-lint
+    $ gem install ruby-lint --pre
+
+Once a stable version has been released the `--pre` switch is no longer
+required.
 
 Please note that there already is an existing gem called "rlint". This Gem is
 **not** the same, it just happens to be a similar project (one that seems
 abandoned) that uses the same name.
 
+## Usage
+
+RubyLint can be used in two different ways: using the CLI interface and by using
+the Ruby code directly.
+
+The CLI can be used using the command `rlint`, see the output of `rlint --help`
+for more information on how to configure it and how to analyze Ruby files.
+
+The Ruby code itself takes a bit more effort but gives you more flexibility. In
+the future you'll also be able to customize RubyLint using a Ruby configuration
+files. In order to analyze Ruby code you'll need a few things:
+
+* An instance of `RubyLint::Iterator`
+* An instance of `RubyLint::Report`
+* A formatter for the report
+* A block of Ruby code
+* A number of analyzer classes such as `RubyLint::Analyze::UndefinedVariables`
+
+A short example is the following:
+
+    require 'ruby-lint'
+
+    code      = 'obviously your Ruby code goes in here'
+    tokens    = RubyLint::Parser.new(code).parse
+    report    = RubyLint::Report.new
+    formatter = RubyLint::Formatter.new
+    iterator  = RubyLint::Iterator.new(report)
+
+    iterator.bind(RubyLint::Analyze::Definitions)
+    iterator.bind(RubyLint::Analyze::MethodValidation)
+
+    iterator.run(tokens)
+
+    puts formatter.format(report)
+
+## Design
+
+RubyLint's design is broken up into 5 different parts:
+
+* A parser that turns a block of Ruby code into an AST.
+* A class that iterates over this AST and executes callback methods (aptly
+  named `RubyLint::Iterator`).
+* A set of callback classes that are used by an iterator. These callback
+  classes perform the actual data analysis.
+* A report for storing error messages, warnings and informal messages.
+* A formatter that turns a report into something useful such as plain text or
+  JSON.
+
+The process of analyzing code basically looks like the following:
+
+              +------+
+              | Code |
+              +------+
+                 |
+                 v
+          +---------------+
+          | RubyLint::Parser |
+          +---------------+
+                 |
+                 v
+         +-----------------+
+         | RubyLint::Iterator |
+         +-----------------+
+                 |
+                 v
+     +---------------------------+
+     | RubyLint::Callback instances |
+     +---------------------------+
+                 |
+                 v
+         +---------------+
+         | RubyLint::Report |
+         +---------------+
+                 |
+                 v
+    +----------------------------+
+    | RubyLint::Formatter instances |
+    +----------------------------+
+                 |
+                 v
+        +------------------+
+        | Something useful |
+        +------------------+
+
+The advantage of this setup is that different tasks are decoupled (where
+possible) and that it's fairly trivial to write custom formatters that spit out
+JSON, HTML, XML or something else. It also makes things easier to maintain as
+there's no single giant lump of code that does everything.
+
 ## Compatibility Issues
 
-Currently Rlint can only be executed using MRI 1.9.3, it does not run on MRI
+Currently RubyLint can only be executed using MRI 1.9.3, it does not run on MRI
 1.8.x due to the lack of Ripper. It also does not yet run without errors on
 MRI 2.0 as the addition of named variables changes the Ripper output, something
-Rlint doesn't properly handle at the moment.
+RubyLint doesn't properly handle at the moment.
 
-For the time being Rlint will stick to using Ripper which means it's also
+For the time being RubyLint will stick to using Ripper which means it's also
 limited to MRI 1.9.x/2.0.x. I've been looking around for alternatives so that
-Rlint can be run on Jruby/Rubinius in the future but so far I haven't really
-found a worthy alternative. For now I'd rather focus on making Rlint work on
+RubyLint can be run on Jruby/Rubinius in the future but so far I haven't really
+found a worthy alternative. For now I'd rather focus on making RubyLint work on
 one implementation instead of a number of different ones.
 
-Also keep in mind that while in theory Rlint should run on MRI 1.8.x I couldn't
+Also keep in mind that while in theory RubyLint should run on MRI 1.8.x I couldn't
 get the "ripper" gem to install properly, thus I'm unable to confirm this. Feel
 free to try it out but I won't bother with MRI 1.8.x myself if it requires more
 than a few minutes worth of work.
 
+## TODO
+
+* Allow options to be set and libraries to be loaded using a configuration
+  file (`./.rlint.rb` and `~/.rlint.rb`).
+* Handle named parameters in Ruby 2.0 (and other potential differences).
+* Validate the parameters passed to method calls where possible.
+* Better/more up to date documentation.
+* Testing, testing and more testing.
+
 ## License
 
 All source code in this repository is licensed under the MIT license unless

data/bin/ruby-lint

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../lib/ruby-lint', __FILE__)
+require 'ruby-lint/cli'
+
+RubyLint::CLI.new.run

data/lib/ruby-lint.rb

@@ -0,0 +1,36 @@
+require 'ripper'
+
+unless $:.include?(File.expand_path('../', __FILE__))
+  $:.unshift(File.expand_path('../', __FILE__))
+end
+
+require 'ruby-lint/version'
+require 'ruby-lint/parser'
+require 'ruby-lint/token/token'
+require 'ruby-lint/token/variable_token'
+require 'ruby-lint/token/statement_token'
+require 'ruby-lint/token/begin_rescue_token'
+require 'ruby-lint/token/method_definition_token'
+require 'ruby-lint/token/parameters_token'
+require 'ruby-lint/token/method_token'
+require 'ruby-lint/token/block_token'
+require 'ruby-lint/token/assignment_token'
+require 'ruby-lint/token/case_token'
+require 'ruby-lint/token/regexp_token'
+require 'ruby-lint/token/class_token'
+require 'ruby-lint/parser_error'
+require 'ruby-lint/iterator'
+require 'ruby-lint/callback'
+require 'ruby-lint/report'
+require 'ruby-lint/definition'
+require 'ruby-lint/constant_importer'
+require 'ruby-lint/formatter/text'
+require 'ruby-lint/helper/scoping'
+require 'ruby-lint/helper/definition_resolver'
+require 'ruby-lint/analyze/coding_style'
+require 'ruby-lint/analyze/definitions'
+require 'ruby-lint/analyze/unused_variables'
+require 'ruby-lint/analyze/undefined_variables'
+require 'ruby-lint/analyze/shadowing_variables'
+require 'ruby-lint/analyze/method_validation'
+require 'ruby-lint/options'

data/lib/{rlint → ruby-lint}/analyze/coding_style.rb

@@ -1,7 +1,7 @@
-module Rlint
+module RubyLint
   module Analyze
     ##
-    # {Rlint::Analyze::CodingStyle} checks if a block of code matches a given
+    # {RubyLint::Analyze::CodingStyle} checks if a block of code matches a given
     # set of coding standards. While none of the problems found by this class
     # are considered harmful they are usually frowned upon as they do not
     # follow the unofficial but generally accepted Ruby coding standards.
@@ -21,7 +21,7 @@ module Rlint
     # This class checks for the following:
     #
     # * The length of method and variable names, should be less than the value
-    #   set in {Rlint::Analyze::CodingStyle::MAXIMUM\_NAME\_LENGTH}.
+    #   set in {RubyLint::Analyze::CodingStyle::MAXIMUM\_NAME\_LENGTH}.
     # * The use of class variables (it's relatively rare that you actually need
     #   those).
     # * The use of parenthesis around various statements: these are not needed
@@ -32,7 +32,7 @@ module Rlint
     # * If a particular method name should be replaced by a different one (e.g.
     #   "map" instead of "collect").
     #
-    class CodingStyle < Rlint::Callback
+    class CodingStyle < RubyLint::Callback
       ##
       # A short description of this class.
       #
@@ -62,7 +62,7 @@ module Rlint
       }
 
       ##
-      # @see Rlint::Callback#initialize
+      # @see RubyLint::Callback#initialize
       #
       def initialize(*args)
         super
@@ -79,9 +79,9 @@ module Rlint
       # * Whether or not instance variables are `snake_cased` instead of
       #   camelCased.
       # * Whether or not the length of an instance variable is smaller than the
-      #   value defined in {Rlint::Analyze::CodingStyle::MAXIMUM\_NAME\_LENGTH}.
+      #   value defined in {RubyLint::Analyze::CodingStyle::MAXIMUM\_NAME\_LENGTH}.
       #
-      # @param [Rlint::Token::VariableToken] token The token containing details
+      # @param [RubyLint::Token::VariableToken] token The token containing details
       #  about the variable.
       #
       def on_instance_variable(token)
@@ -92,10 +92,10 @@ module Rlint
       # Called when a class variable is found.
       #
       # This method will check for the same things as
-      # {Rlint::Analyze::CodingStyle#on_instance_variable} along with adding an
+      # {RubyLint::Analyze::CodingStyle#on_instance_variable} along with adding an
       # info message about class variables being discouraged.
       #
-      # @see Rlint::Analyze::CodingStyle#on_instance_variable
+      # @see RubyLint::Analyze::CodingStyle#on_instance_variable
       #
       def on_class_variable(token)
         validate_name(token)
@@ -110,7 +110,7 @@ module Rlint
       ##
       # Called when a constant is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_instance_variable
+      # @see RubyLint::Analyze::CodingStyle#on_instance_variable
       #
       def on_constant(token)
         validate_name_length(token)
@@ -119,7 +119,7 @@ module Rlint
       ##
       # Called when a global variable is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_instance_variable
+      # @see RubyLint::Analyze::CodingStyle#on_instance_variable
       #
       def on_global_variable(token)
         validate_name(token)
@@ -128,7 +128,7 @@ module Rlint
       ##
       # Called when an instance variable is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_instance_variable
+      # @see RubyLint::Analyze::CodingStyle#on_instance_variable
       #
       def on_local_variable(token)
         validate_name(token)
@@ -141,8 +141,8 @@ module Rlint
       # instance variables) as well as adding a warning when an instance
       # variable is assigned.
       #
-      # @see Rlint::Analyze::CodingStyle#on_instance_variable
-      # @see Rlint::Analyze::CodingStyle#on_class_variable
+      # @see RubyLint::Analyze::CodingStyle#on_instance_variable
+      # @see RubyLint::Analyze::CodingStyle#on_class_variable
       #
       def on_assignment(token)
         validate_name(token)
@@ -159,7 +159,7 @@ module Rlint
       ##
       # Called when a return statement is found.
       #
-      # @param [Rlint::Token::StatementToken] token The token of the return
+      # @param [RubyLint::Token::StatementToken] token The token of the return
       #  statement.
       #
       def on_return(token)
@@ -184,7 +184,7 @@ module Rlint
       # to instance variables as well as checking if the method definition
       # modifies a core Ruby constant.
       #
-      # @see Rlint::Analyze::CodingStyle#on_instance_variable
+      # @see RubyLint::Analyze::CodingStyle#on_instance_variable
       #
       def on_method_definition(token)
         validate_name(token)
@@ -200,7 +200,7 @@ module Rlint
       # Called when a class is created. This callback adds a warning if a core
       # Ruby constant is modified.
       #
-      # @param [Rlint::Token::ClassToken] token Token class containing details
+      # @param [RubyLint::Token::ClassToken] token Token class containing details
       #  about the newly created class.
       #
       def on_class(token)
@@ -211,7 +211,7 @@ module Rlint
       # Called after a method token has been processed. This callback checks if
       # a method is a predicate method and if so if the name is set correctly.
       #
-      # @param [Rlint::Token::MethodDefinitionToken] token The token containing
+      # @param [RubyLint::Token::MethodDefinitionToken] token The token containing
       #  details about the method definition.
       # @todo This method currently only performs a very limited check for
       #  predicate methods. Once a proper scoping system has been implemented
@@ -236,7 +236,7 @@ module Rlint
       # This method checks if the used method should be named differently
       # instead (e.g. "map" instead of "collect").
       #
-      # @param [Rlint::Token::MethodToken] token Token containing details about
+      # @param [RubyLint::Token::MethodToken] token Token containing details about
       #  the method.
       #
       def on_method(token)
@@ -260,7 +260,7 @@ module Rlint
       # This method checks to see if there are any parenthesis around the
       # statement and adds an info message if this is the case.
       #
-      # @param [Rlint::Token::StatementToken] token The token containing
+      # @param [RubyLint::Token::StatementToken] token The token containing
       #  details about the if statement.
       #
       def on_if(token)
@@ -270,7 +270,7 @@ module Rlint
       ##
       # Called when an elsif statement is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_if
+      # @see RubyLint::Analyze::CodingStyle#on_if
       #
       def on_elsif(token)
         validate_parenthesis(token)
@@ -279,7 +279,7 @@ module Rlint
       ##
       # Called when a while statement is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_if
+      # @see RubyLint::Analyze::CodingStyle#on_if
       #
       def on_while(token)
         validate_parenthesis(token)
@@ -288,7 +288,7 @@ module Rlint
       ##
       # Called when a case statement is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_if
+      # @see RubyLint::Analyze::CodingStyle#on_if
       #
       def on_case(token)
         validate_parenthesis(token)
@@ -297,7 +297,7 @@ module Rlint
       ##
       # Called when a when statement is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_if
+      # @see RubyLint::Analyze::CodingStyle#on_if
       #
       def on_when(token)
         validate_parenthesis(token)
@@ -306,7 +306,7 @@ module Rlint
       ##
       # Called when an until statement is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_if
+      # @see RubyLint::Analyze::CodingStyle#on_if
       #
       def on_until(token)
         validate_parenthesis(token)
@@ -315,7 +315,7 @@ module Rlint
       ##
       # Called when an unless statement is found.
       #
-      # @see Rlint::Analyze::CodingStyle#on_if
+      # @see RubyLint::Analyze::CodingStyle#on_if
       #
       def on_unless(token)
         validate_parenthesis(token)
@@ -327,7 +327,7 @@ module Rlint
       # Validates the name of the specified token. This method will check for
       # the use of camelCase as well as checking for the length of the name.
       #
-      # @param [Rlint::Token::Token] token The token to validate.
+      # @param [RubyLint::Token::Token] token The token to validate.
       #
       def validate_name(token)
         if !token.respond_to?(:name) or !token.name
@@ -348,9 +348,9 @@ module Rlint
       ##
       # Checks if the name of the given token is too long or not. The maximum
       # length of names is set in
-      # {Rlint::Analyze::CodingStyle::MAXIMUM\_NAME\_LENGTH}.
+      # {RubyLint::Analyze::CodingStyle::MAXIMUM\_NAME\_LENGTH}.
       #
-      # @param [Rlint::Token::Token] token The token to validate.
+      # @param [RubyLint::Token::Token] token The token to validate.
       #
       def validate_name_length(token)
         if !token.respond_to?(:name) or !token.name
@@ -370,7 +370,7 @@ module Rlint
       ##
       # Checks if there are any parenthesis wrapped around a statement.
       #
-      # @param [Rlint::Token::Token] token The token to validate.
+      # @param [RubyLint::Token::Token] token The token to validate.
       #
       def validate_parenthesis(token)
         if token.code =~ /#{token.type}\s*\(/
@@ -385,7 +385,7 @@ module Rlint
       ##
       # Adds a warning for modifying a core Ruby constant.
       #
-      # @param [Rlint::Token::Token] token The token class to validate.
+      # @param [RubyLint::Token::Token] token The token class to validate.
       #
       def validate_ruby_constant_modification(token)
         if token.name.is_a?(Array)
@@ -404,4 +404,4 @@ module Rlint
       end
     end # CodingStyle
   end # Analyze
-end # Rlint
+end # RubyLint