ruby-lint 0.0.2 → 0.0.3

data.tar.gz.asc

@@ -0,0 +1,17 @@
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG v2.0.19 (GNU/Linux)
+
+iQIcBAABAgAGBQJRdZvaAAoJEPMbESk2SfREdKYQAJQ2anToVom5wnIc/3ujvS4j
+EH4gzq+geMPJ4ZtqmVH+AVmNotQZ6tCYzWyMfQPb4QWCu1uTvVqmg0WNbMCwCGyJ
+aNmUiZTzN7Nit2vytiyFOUK+Y2KyDrLtqeKXkiCpOmb6MbMfQVSQg74QpOuf6O2H
+ND2mZvgBHfsMM1rBxHNnHrvkTMF0yjq7v83j6N1K2NmzOIDm5zpQUlA41G5oTQxp
+TWN163GuSVzzaOEuyLOIg10j9M34slFaumbTzQsF1cfrf/VXx8dldQ1ljeFggGLP
+nY1OrrCIKnc5cNv+NpBTtxMEDT49k2gO1T3bTVIqhuiMY30tGLlpNTev59OCM7iX
+m974eVth4XS2jCO9MoQRs7q4twz9NmtUOhQG/q5GqqLPD8BBmOw87I0cJsrONzD+
+dKIubK7RqZ4z1MLdgE9t0PZ18WturcCKxzxMuyC37x/a2Cx3ciE76EKVfQyo6kT1
+aHXtHogGIVNNUAtjY+EbetZmMkYE5YmuHr+3dDbrGYgN+tf+P7puB96smcGO54NE
+/x/cHtpYqWbpU0BUCT5SIQU19hnNaoodUoVycnkXlhb5OYg1k36Z+1xK92X9jKQf
+2jZlez4OAbF7AyUjR3AwM1M/d9nG9VpBStvaNARzksuCRuEGjvTqLnXEkjgZG+X2
+8hG6fF3zrf9uAT9GevoM
+=TlVu
+-----END PGP SIGNATURE-----

data/.gitignore

@@ -1,5 +1,6 @@
 doc/build/*
 !doc/build/.gitkeep
+coverage
 
 pkg
 Gemfile.lock

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+script: rake
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: 2.0.0
+    - rvm: jruby-head
+
+notifications:
+  email:
+    recipients:
+      - yorickpeterse@gmail.com
+    email:
+      on_success: change
+      on_failure: always
+
+branches:
+  only:
+    - master
+    - develop

data/.yardopts

@@ -6,5 +6,9 @@
 --private
 --protected
 --asset ./doc/css/common.css:css/common.css
+--asset ./doc/images:images
+--exclude lib/ruby-lint/definitions/core
+--verbose
 -
+./doc/*.md
 LICENSE

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org/'
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012, Yorick Peterse
+Copyright (c) 2012 - 2013, Yorick Peterse
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/MANIFEST

@@ -1,5 +1,5 @@
 .gitignore
-.rbenv-version
+.travis.yml
 .yardopts
 Gemfile
 LICENSE
@@ -7,80 +7,269 @@ MANIFEST
 README.md
 Rakefile
 bin/ruby-lint
+checksum/.gitkeep
 doc/.gitkeep
+doc/DCO.md
+doc/architecture.md
 doc/build/.gitkeep
+doc/code_analysis.md
+doc/configuration.md
+doc/contributing.md
 doc/css/.gitkeep
 doc/css/common.css
+doc/graphviz/flow.dot
+doc/images/.gitkeep
+doc/images/flow.png
 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/argument_amount.rb
 lib/ruby-lint/analyze/shadowing_variables.rb
+lib/ruby-lint/analyze/undefined_methods.rb
 lib/ruby-lint/analyze/undefined_variables.rb
 lib/ruby-lint/analyze/unused_variables.rb
-lib/ruby-lint/callback.rb
+lib/ruby-lint/base.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/cli/analyze.rb
+lib/ruby-lint/cli/ast.rb
+lib/ruby-lint/cli/base.rb
+lib/ruby-lint/configuration.rb
+lib/ruby-lint/constant_loader.rb
+lib/ruby-lint/definition/ruby_method.rb
+lib/ruby-lint/definition/ruby_object.rb
+lib/ruby-lint/definition_generator.rb
+lib/ruby-lint/definitions/core.rb
+lib/ruby-lint/definitions/core/arg0.rb
+lib/ruby-lint/definitions/core/argf.rb
+lib/ruby-lint/definitions/core/argument_error.rb
+lib/ruby-lint/definitions/core/argv.rb
+lib/ruby-lint/definitions/core/array.rb
+lib/ruby-lint/definitions/core/autoload.rb
+lib/ruby-lint/definitions/core/basic_object.rb
+lib/ruby-lint/definitions/core/bignum.rb
+lib/ruby-lint/definitions/core/binding.rb
+lib/ruby-lint/definitions/core/class.rb
+lib/ruby-lint/definitions/core/comparable.rb
+lib/ruby-lint/definitions/core/complex.rb
+lib/ruby-lint/definitions/core/condition_variable.rb
+lib/ruby-lint/definitions/core/continuation.rb
+lib/ruby-lint/definitions/core/data.rb
+lib/ruby-lint/definitions/core/date.rb
+lib/ruby-lint/definitions/core/date_time.rb
+lib/ruby-lint/definitions/core/default_record_separator.rb
+lib/ruby-lint/definitions/core/digest.rb
+lib/ruby-lint/definitions/core/dir.rb
+lib/ruby-lint/definitions/core/encoding.rb
+lib/ruby-lint/definitions/core/encoding_error.rb
+lib/ruby-lint/definitions/core/enumerable.rb
+lib/ruby-lint/definitions/core/enumerator.rb
+lib/ruby-lint/definitions/core/env.rb
+lib/ruby-lint/definitions/core/eoferror.rb
+lib/ruby-lint/definitions/core/erb.rb
+lib/ruby-lint/definitions/core/errno.rb
+lib/ruby-lint/definitions/core/etc.rb
+lib/ruby-lint/definitions/core/exception.rb
+lib/ruby-lint/definitions/core/false.rb
+lib/ruby-lint/definitions/core/false_class.rb
+lib/ruby-lint/definitions/core/fatal_error.rb
+lib/ruby-lint/definitions/core/fiber.rb
+lib/ruby-lint/definitions/core/fiber_error.rb
+lib/ruby-lint/definitions/core/file.rb
+lib/ruby-lint/definitions/core/file_list.rb
+lib/ruby-lint/definitions/core/file_test.rb
+lib/ruby-lint/definitions/core/file_utils.rb
+lib/ruby-lint/definitions/core/fixnum.rb
+lib/ruby-lint/definitions/core/float.rb
+lib/ruby-lint/definitions/core/float_domain_error.rb
+lib/ruby-lint/definitions/core/gc.rb
+lib/ruby-lint/definitions/core/gem.rb
+lib/ruby-lint/definitions/core/hash.rb
+lib/ruby-lint/definitions/core/immediate_value.rb
+lib/ruby-lint/definitions/core/index_error.rb
+lib/ruby-lint/definitions/core/integer.rb
+lib/ruby-lint/definitions/core/interrupt.rb
+lib/ruby-lint/definitions/core/io.rb
+lib/ruby-lint/definitions/core/ioerror.rb
+lib/ruby-lint/definitions/core/kernel.rb
+lib/ruby-lint/definitions/core/key_error.rb
+lib/ruby-lint/definitions/core/load_error.rb
+lib/ruby-lint/definitions/core/local_jump_error.rb
+lib/ruby-lint/definitions/core/main.rb
+lib/ruby-lint/definitions/core/marshal.rb
+lib/ruby-lint/definitions/core/match_data.rb
+lib/ruby-lint/definitions/core/math.rb
+lib/ruby-lint/definitions/core/memory_segmention_error.rb
+lib/ruby-lint/definitions/core/method.rb
+lib/ruby-lint/definitions/core/module.rb
+lib/ruby-lint/definitions/core/monitor.rb
+lib/ruby-lint/definitions/core/monitor_mixin.rb
+lib/ruby-lint/definitions/core/mutex.rb
+lib/ruby-lint/definitions/core/name_error.rb
+lib/ruby-lint/definitions/core/nil.rb
+lib/ruby-lint/definitions/core/nil_class.rb
+lib/ruby-lint/definitions/core/no_memory_error.rb
+lib/ruby-lint/definitions/core/no_method_error.rb
+lib/ruby-lint/definitions/core/not_implemented_error.rb
+lib/ruby-lint/definitions/core/numeric.rb
+lib/ruby-lint/definitions/core/object.rb
+lib/ruby-lint/definitions/core/object_space.rb
+lib/ruby-lint/definitions/core/open_struct.rb
+lib/ruby-lint/definitions/core/option_parser.rb
+lib/ruby-lint/definitions/core/precision.rb
+lib/ruby-lint/definitions/core/primitive_failure.rb
+lib/ruby-lint/definitions/core/proc.rb
+lib/ruby-lint/definitions/core/process.rb
+lib/ruby-lint/definitions/core/psych.rb
+lib/ruby-lint/definitions/core/queue.rb
+lib/ruby-lint/definitions/core/rake.rb
+lib/ruby-lint/definitions/core/rake_file_utils.rb
+lib/ruby-lint/definitions/core/rakeversion.rb
+lib/ruby-lint/definitions/core/random.rb
+lib/ruby-lint/definitions/core/range.rb
+lib/ruby-lint/definitions/core/range_error.rb
+lib/ruby-lint/definitions/core/rational.rb
+lib/ruby-lint/definitions/core/rb_config.rb
+lib/ruby-lint/definitions/core/regexp.rb
+lib/ruby-lint/definitions/core/regexp_error.rb
+lib/ruby-lint/definitions/core/rubinius.rb
+lib/ruby-lint/definitions/core/ruby_copyright.rb
+lib/ruby-lint/definitions/core/ruby_description.rb
+lib/ruby-lint/definitions/core/ruby_engine.rb
+lib/ruby-lint/definitions/core/ruby_lint.rb
+lib/ruby-lint/definitions/core/ruby_patchlevel.rb
+lib/ruby-lint/definitions/core/ruby_platform.rb
+lib/ruby-lint/definitions/core/ruby_release_date.rb
+lib/ruby-lint/definitions/core/ruby_version.rb
+lib/ruby-lint/definitions/core/runtime_error.rb
+lib/ruby-lint/definitions/core/scan_error.rb
+lib/ruby-lint/definitions/core/script_error.rb
+lib/ruby-lint/definitions/core/security_error.rb
+lib/ruby-lint/definitions/core/shellwords.rb
+lib/ruby-lint/definitions/core/signal.rb
+lib/ruby-lint/definitions/core/signal_exception.rb
+lib/ruby-lint/definitions/core/singleton.rb
+lib/ruby-lint/definitions/core/sized_queue.rb
+lib/ruby-lint/definitions/core/standard_error.rb
+lib/ruby-lint/definitions/core/stderr.rb
+lib/ruby-lint/definitions/core/stdin.rb
+lib/ruby-lint/definitions/core/stdout.rb
+lib/ruby-lint/definitions/core/stop_iteration.rb
+lib/ruby-lint/definitions/core/string.rb
+lib/ruby-lint/definitions/core/string_io.rb
+lib/ruby-lint/definitions/core/string_scanner.rb
+lib/ruby-lint/definitions/core/struct.rb
+lib/ruby-lint/definitions/core/syck.rb
+lib/ruby-lint/definitions/core/symbol.rb
+lib/ruby-lint/definitions/core/syntax_error.rb
+lib/ruby-lint/definitions/core/system_call_error.rb
+lib/ruby-lint/definitions/core/system_exit.rb
+lib/ruby-lint/definitions/core/system_stack_error.rb
+lib/ruby-lint/definitions/core/thread.rb
+lib/ruby-lint/definitions/core/thread_error.rb
+lib/ruby-lint/definitions/core/thread_group.rb
+lib/ruby-lint/definitions/core/time.rb
+lib/ruby-lint/definitions/core/toplevel_binding.rb
+lib/ruby-lint/definitions/core/true.rb
+lib/ruby-lint/definitions/core/true_class.rb
+lib/ruby-lint/definitions/core/type_error.rb
+lib/ruby-lint/definitions/core/unbound_method.rb
+lib/ruby-lint/definitions/core/unmarshalable.rb
+lib/ruby-lint/definitions/core/unsupported_library_error.rb
+lib/ruby-lint/definitions/core/weak_ref.rb
+lib/ruby-lint/definitions/core/zero_division_error.rb
+lib/ruby-lint/definitions_builder.rb
+lib/ruby-lint/extensions/string.rb
+lib/ruby-lint/helper/constant_paths.rb
+lib/ruby-lint/helper/conversion.rb
+lib/ruby-lint/helper/current_scope.rb
+lib/ruby-lint/helper/methods.rb
+lib/ruby-lint/inspector.rb
 lib/ruby-lint/iterator.rb
-lib/ruby-lint/options.rb
+lib/ruby-lint/node.rb
 lib/ruby-lint/parser.rb
 lib/ruby-lint/parser_error.rb
+lib/ruby-lint/presenter/json.rb
+lib/ruby-lint/presenter/text.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/keyword_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/report/entry.rb
+lib/ruby-lint/template/definition.erb
+lib/ruby-lint/template/scope.rb
+lib/ruby-lint/variable_predicates.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/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/argument_amount.rb
 spec/ruby-lint/analyze/shadowing_variables.rb
+spec/ruby-lint/analyze/undefined_methods.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/configuration.rb
+spec/ruby-lint/constant_loader.rb
+spec/ruby-lint/definition/dsl.rb
+spec/ruby-lint/definition/method_calls.rb
+spec/ruby-lint/definition/ruby_method.rb
+spec/ruby-lint/definition/ruby_object.rb
+spec/ruby-lint/definitions_builder/assignments/arrays.rb
+spec/ruby-lint/definitions_builder/assignments/hashes.rb
+spec/ruby-lint/definitions_builder/assignments/objects.rb
+spec/ruby-lint/definitions_builder/assignments/optional.rb
+spec/ruby-lint/definitions_builder/assignments/return_values.rb
+spec/ruby-lint/definitions_builder/assignments/variables.rb
+spec/ruby-lint/definitions_builder/associate_nodes.rb
+spec/ruby-lint/definitions_builder/blocks.rb
+spec/ruby-lint/definitions_builder/classes.rb
+spec/ruby-lint/definitions_builder/for.rb
+spec/ruby-lint/definitions_builder/methods.rb
+spec/ruby-lint/definitions_builder/modules.rb
+spec/ruby-lint/definitions_builder/reference_amount.rb
+spec/ruby-lint/definitions_builder/unused.rb
+spec/ruby-lint/extensions/string.rb
 spec/ruby-lint/iterator.rb
-spec/ruby-lint/parser/arrays.rb
+spec/ruby-lint/node.rb
+spec/ruby-lint/parser/assignments.rb
 spec/ruby-lint/parser/classes.rb
 spec/ruby-lint/parser/errors.rb
-spec/ruby-lint/parser/expander_assignments.rb
-spec/ruby-lint/parser/hashes.rb
-spec/ruby-lint/parser/keywords.rb
+spec/ruby-lint/parser/metadata.rb
+spec/ruby-lint/parser/method_definitions.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/parser/statements/begin.rb
+spec/ruby-lint/parser/statements/case.rb
+spec/ruby-lint/parser/statements/defined.rb
+spec/ruby-lint/parser/statements/for.rb
+spec/ruby-lint/parser/statements/if.rb
+spec/ruby-lint/parser/statements/return.rb
+spec/ruby-lint/parser/statements/super.rb
+spec/ruby-lint/parser/statements/unless.rb
+spec/ruby-lint/parser/statements/until.rb
+spec/ruby-lint/parser/statements/while.rb
+spec/ruby-lint/parser/statements/yield.rb
+spec/ruby-lint/parser/types/arrays.rb
+spec/ruby-lint/parser/types/booleans.rb
+spec/ruby-lint/parser/types/constants.rb
+spec/ruby-lint/parser/types/hashes.rb
+spec/ruby-lint/parser/types/nil.rb
+spec/ruby-lint/parser/types/numbers.rb
+spec/ruby-lint/parser/types/procs.rb
+spec/ruby-lint/parser/types/ranges.rb
+spec/ruby-lint/parser/types/regexp.rb
+spec/ruby-lint/parser/types/strings.rb
+spec/ruby-lint/parser/types/symbols.rb
+spec/ruby-lint/presenter/json.rb
+spec/ruby-lint/presenter/text.rb
 spec/ruby-lint/report.rb
+spec/ruby-lint/report/entry.rb
+spec/support/bacon.rb
+spec/support/building.rb
+spec/support/definitions.rb
+spec/support/parsing.rb
+spec/support/simplecov.rb
+task/build.rake
+task/checksum.rake
+task/coverage.rake
+task/doc.rake
+task/generate.rake
+task/graphviz.rake
 task/manifest.rake
 task/stdlib.rake
+task/tag.rake
 task/test.rake

data/README.md

@@ -1,150 +1,103 @@
-# README
+# ruby-lint
 
-**RubyLint is currently alpha quality, expect things to break and change without
-notice. Patches and bug reports are more than welcome.**
-
-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. It is inspired by
+similar tools such as jshint, flake8 and similar tools. ruby-lint primarily
+focuses on logic related errors such as the use of non existing variables
+instead of focusing on semantics (e.g. the amount of characters per line).
 
 ## Requirements
 
-* Ruby 1.9 or newer
-* Ripper (comes bundled with Ruby 1.9)
+* Ruby (MRI) 1.9.3 or newer
+* a Unix based Operating System
 
 ## Installation
 
-RubyLint can be installed by running the following command:
+The easiest way to install ruby-lint is to install it from RubyGems:
+
+    $ gem install ruby-lint
+
+Alternatively you can install it from a RubyGems mirror that I run (updated
+daily and only mirrors a very small subset of RubyGems):
+
+    $ gem install --source=http://rubygems.yorickpeterse.com/
+
+If you prefer to install (and build) ruby-lint from the source code you can do
+so as following:
+
+    $ git clone git://github.com/YorickPeterse/ruby-lint.git
+    $ cd ruby-lint
+    $ bundle install # you can also install the dependencies manually
+    $ rake gem
 
-    $ gem install ruby-lint --pre
+This builds a new version of the Gem and saves it in the pkg/ directory.
 
-Once a stable version has been released the `--pre` switch is no longer
-required.
+## Security
 
-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.
+To ensure that people can't tamper with the ruby-lint Gem once it's being
+distributed as a `.gem` file the Gem is signed using GNUPG (using the
+[rubygems-openpgp][rubygems-openpgp] Gem). If you have this Gem installed it's
+recommended that you install ruby-lint as following:
+
+    $ gem install ruby-lint --verify --trust
+
+Unless you have my GPG public key and have marked it as trusted this process
+will fail. For signing Gems I use the public key **3649F444** registered to
+"Yorick Peterse" using Email address <yorickpeterse@gmail.com>.
+
+You can add this key by running the following command:
+
+    $ gpg --recv-keys 3649F444
+
+In case you don't use GPG but still want some form of verification you can use
+the checksums that are located in the "checksum" directory. These checksums are
+SHA512 checksums of entire Gem files and can be verified using the `sha512sum`
+command.
 
 ## 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 `ruby-lint`, see the output of `ruby-lint
---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 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
-RubyLint doesn't properly handle at the moment.
-
-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
-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 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.
+Using ruby-lint from the CLI is very easy. To analyze a set of files
+you run the following:
+
+    $ ruby-lint file1.rb file2.rb
+
+For more information specify either the `-h` or `--help` option.
+
+## Compatibility
+
+For the time being ruby-lint only runs on MRI 1.9 due to its dependency on
+Ripper, a library that is not available on Rubinius, Jruby and other Ruby
+implementations.
+
+In the future I intend to move away from Ripper but when this happens depends
+on when I can find something that suits my needs. Most existing solutions, such
+as `ruby_parser` lack features that I require (such as storing column numbers
+of AST nodes), are either unmaintained or severely limited in what they can do.
+
+## Documentation
+
+* {file:contributing Contributing}
+* {file:architecture Architecture}
+* {file:code\_analysis Code Analysis}
+* {file:configuration Configuration}
+
+Noteworthy constants:
+
+* {RubyLint::Node}
+* {RubyLint::Iterator}
+* {RubyLint::Report}
+* {RubyLint::Presenter::Text}
+
+Helper modules:
+
+* {RubyLint::Helper::ConstantPaths}
+* {RubyLint::Helper::Conversion}
+* {RubyLint::Helper::CurrentScope}
+* {RubyLint::Helper::Methods}
 
 ## License
 
 All source code in this repository is licensed under the MIT license unless
 specified otherwise. A copy of this license can be found in the file "LICENSE"
 in the root directory of this repository.
+
+[rubygems-openpgp]: https://github.com/grant-olson/rubygems-openpgp