ruby-lint 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd18d2ac845d4520591324dc3491cbd5a3d9b0ca
-  data.tar.gz: b7a344031e1b300104e1331486dbc4b8903ff9c8
+  metadata.gz: 512dbfa14fa8cd418ab6aa742b5b9674c8d099e5
+  data.tar.gz: 753e74eacbb26c7d0c1ca1e824811f50383eeb57
 SHA512:
-  metadata.gz: 78ad431d97cef27b33f53842e36b46771895a3d1cef0ce8982a77245e5ce3b1c1400318ece043a24a594277eb21ab5dad6026d74473c9d1c9354a5289ddf6309
-  data.tar.gz: c6010baaeb8aec96bdaf8a00eb80c92a186be594fa20136e45a3a374749c20588a3a0dd8bac2dd659d7f911eb40cd321f28f291dd1c3dd92daf6932d7fd3234f
+  metadata.gz: e9b624c1fe46dc6493a9fc0a85f4ce8a8c737a08f696b140e626b276b7e98f738a3e5722ea2773795b51cd33549542210dbafede324dd3ca5487ea5c197fdcfc
+  data.tar.gz: 439fe12246a52f2403101a738eedf13bbd95795ecc6cfb53c4585070a74e80e2ab13a8d5ff93a7dee6276b890791f2c006edec68d2efb349cfc7a51c0071d6ca

data/CONTRIBUTING.md

@@ -1,39 +1,53 @@
 # Contributing
 
-Those that wish to contribute to ruby-lint are more than welcome. However, to
-make the lifes of both me and others easier there are a few things one should
-keep in mind.
-
-The gist of this is as following:
-
-* Write tests
-* Write documentation using YARD (at the very least arguments and return values
-  should be documented)
-* Wrap lines at 79 characters per line
+Everybody is more than welcome to contribute to ruby-lint, no matter how small
+the change. To keep everything running smoothly there are a few guidelines that
+one should follow. These are as following:
+
+* When changing code make sure to write RSpec tests for the changes.
+* Document code using YARD. At the very least the method arguments and return
+  value(s) should be documented.
+* Wrap lines at 79 characters per line.
 * Git commits should have a <= 50 character summary, optionally followed by a
   blank line and a more in depth description of 79 characters per line.
 
-More information can be found here:
-<http://yorickpeterse.com/articles/contributing-to-my-code/>. If you have any
-questions or whatsoever don't hesitate to ask and don't worry about making
-mistakes (e.g. missing some documentation), I'll help wherever I can and won't
-slap you with a large trout.
+## Editor Setup
 
-## Legal
+Whatever editor you use doesn't matter as long as it can do two things:
+
+* Use spaces for indentation.
+* Hard wrap lines at 79 characters per line.
+
+To make this process easier Oga comes with an [EditorConfig][editorconfig]
+configuration file. If your editor supports this it will automatically apply
+the required settings for you.
+
+## Hacking on ruby-lint
+
+Assuming you have a local Git clone of ruby-lint, the first step should be to
+install all the required Gems:
 
-Legal wise there are two files to take into account:
+    bundle install
 
-* LICENSE
-* doc/DCO.md
+Next up, run the tests to make sure everything is working:
+
+    rake
+    rspec spec # also fine
+
+For more information about the available tasks, run `rake -T`.
+
+## Contact
+
+In case you have any further questions or would like to receive feedback before
+submitting a change, feel free to contact me. You can either open an issue,
+send a tweet to [@yorickpeterse][twitter] or send an Email to
+<yorickpeterse@gmail.com>.
+
+## Legal
 
-The LICENSE file contains a copy of the MIT license. All ruby-lint source code
-and related files (basically whatever this repository and the resulting Gem
-contains) are licensed under the MIT license unless specified otherwise.
+By contributing to ruby-lint you agree with both the Developer's Certificate of
+origin, found in `doc/DCO.md` and the license, found in `LICENSE`. This applies
+to all content in this repository unless stated otherwise.
 
-The DCO contains a agreement for developers that basically specifies that they
-agree with the license and that whatever they contribute is something they are
-allowed to contribute. By contributing to ruby-lint you automatically agree
-with this DCO so it's worth giving a read. The DCO is put in to place to ensure
-that whenever somebody gets mad at me for using proprietary code contributed by
-somebody else I have at least something to defend myself with. Lets just hope I
-never have to.
+[editorconfig]:http://editorconfig.org/
+[twitter]: https://twitter.com/yorickpeterse

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 - 2013, Yorick Peterse
+Copyright (c) 2012 - 2014, 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/README.md

@@ -1,7 +1,6 @@
 # ruby-lint
 
 [![Build Status](https://travis-ci.org/YorickPeterse/ruby-lint.png?branch=master)](https://travis-ci.org/YorickPeterse/ruby-lint)
-[![Coverage Status](https://coveralls.io/repos/YorickPeterse/ruby-lint/badge.png?branch=master)](https://coveralls.io/r/YorickPeterse/ruby-lint)
 [![Code Climate](https://codeclimate.com/github/YorickPeterse/ruby-lint.png)](https://codeclimate.com/github/YorickPeterse/ruby-lint)
 
 ruby-lint is a static code analysis tool for Ruby. It is inspired by tools such

data/bin/ruby-lint

@@ -1,6 +1,94 @@
 #!/usr/bin/env ruby
 
-require File.expand_path('../../lib/ruby-lint', __FILE__)
-require File.expand_path('../../lib/ruby-lint/cli', __FILE__)
+require_relative '../lib/ruby-lint'
 
-RubyLint::CLI.run
+require 'slop'
+
+slop = Slop.new(:strict => true) do
+  banner      'Usage: ruby-lint [FILES] [OPTIONS]'
+  description 'Analyze the source code of Ruby files'
+
+  separator <<-EOF.chomp
+
+About:
+
+  Analyses the source code of a Ruby file and presents a report containing
+  information such as errors about invalid code, warnings and informational
+  messages.
+
+Configuration:
+
+  When this command is executed it will try to load a configuration file in
+  one of the following two locations (in this order):
+
+  * $PWD/ruby-lint.yml
+  * ~/.ruby-lint.yml
+
+  Only the first existing configuration file is loaded.
+
+  These configuration files can be used for specifying the presenter, reporting
+  levels and various other options.
+
+  You can also configure various parts using the supplied commandline options.
+  For example, to use the JSON presenter you'd run the following:
+
+    $ ruby-lint ./test_file.rb --presenter=json
+
+Analysis Classes:
+
+  #{RubyLint::Command.format_names(:available_analysis_classes)}
+
+Presenters:
+
+  #{RubyLint::Command.format_names(:available_presenters)}
+
+Reporting Levels:
+
+  #{RubyLint::Command.format_names(:available_report_levels)}
+
+Examples:
+
+  To analyze a single file you can run the following command:
+
+      $ ruby-lint ./test_file.rb
+
+  You can also specify multiple files:
+
+      $ ruby-lint first_file.rb second_file.rb
+
+  Run analysis on an entire directory:
+
+      $ ruby-lint lib/
+  EOF
+
+  separator "\nOptions:\n"
+
+  on :h, :help, 'Shows this help message' do
+    puts self
+    exit
+  end
+
+  on :v, :version, 'Shows the current version' do
+    puts "ruby-lint v#{RubyLint::VERSION} on #{RUBY_DESCRIPTION}"
+    exit
+  end
+
+  on :l=, :levels=, 'The reporting levels to enable', :as => Array
+  on :p=, :presenter=, 'The presenter to use', :as => String
+  on :a=, :analysis=, 'The analysis classes to use', :as => Array
+  on :b, :benchmark, 'Enables benchmarking mode'
+
+  run do |opts, args|
+    abort 'You must specify at least one file to analyze' if args.empty?
+
+    command = RubyLint::Command.new(opts)
+
+    begin
+      command.run(args)
+    rescue Errno::ENOENT => error
+      abort error.message
+    end
+  end
+end
+
+slop.parse

data/checksum/ruby-lint-1.1.0.gem.sha512

@@ -0,0 +1 @@
+4558bf03ee277a8334cd79eeaac6f0f8f0e59a4dd7fbc03b90de0f82f4bd6b873b505278b82b3bd15ae60c429a73eeb1e3efd4ca1f8210321c2ac7c9c720aace

data/doc/changelog.md

@@ -5,6 +5,36 @@ This document contains a short summary of the various releases of ruby-lint.
 For a full list of commits included in each release see the corresponding Git
 tags (named after the versions).
 
+## 2.0.0 - 2014-06-06
+
+Although the version number might suggest otherwise this is a rather modest
+release compared to previous releases.
+
+There are 3 big changes in this release:
+
+1. A refactored and less confusing CLI.
+2. The caching system has been removed as it was too problematic.
+3. The API used for registering analysis classes has been changed to make it
+   easier to register custom classes.
+
+The first change is not backwards compatible with previous releases of
+ruby-lint, hence the mayor version increase.
+
+The following other changes are included in this release:
+
+* Fuzzy file matching when scanning for external files has been removed. This
+  was too problematic and would cause problems such as
+  <https://github.com/YorickPeterse/ruby-lint/issues/105>.
+* Definitions for Minitest have been added.
+* Proper handling of methods called on block return values.
+* Constant paths with variables in them are handled properly.
+* Diagnostics emitted by the parser Gem are re-used properly by ruby-lint
+  instead of always being displayed as errors.
+* ARGF is handled with extra care so that ruby-lint doesn't throw tons of false
+  positives.
+* Debug output has been removed from the CLI, it will be replaced with a better
+  system in the near future.
+
 ## 1.1.0 - 2014-02-02
 
 This release changes the way the definitions system works so that it no longer

data/doc/code_analysis.md

@@ -108,3 +108,16 @@ For example, if you only want to analyze RSpec files:
     end
 
 By default all analysis classes are enabled.
+
+## Registering Analysis Classes
+
+In order for a analysis class to become available in {RubyLint::Configuration}
+objects, either via the CLI or via Ruby directly, you must register the
+analysis class. This can be done by calling the class method
+{RubyLint::Analysis::Base.register}:
+
+    class CamelCaseVariables < RubyLint::Analysis::Base
+      register 'camel_case_variables'
+    end
+
+The value should be a `snake_cased` string that matches the class name.

data/doc/configuration.md

@@ -54,9 +54,11 @@ Example:
 
     ---
     requires:
-      - ruby-lint/definitions/rails
+      - ruby-lint/definitions/gems/devise
 
-By default this option is left empty.
+By default this option is left empty. You do not need to use this option for
+loading built-in definitions unless stated otherwise. For example, definitions
+for Rails are loaded automatically.
 
 ### report_levels
 
@@ -103,6 +105,7 @@ The following analysis classes are currently available:
 * `undefined_methods`
 * `undefined_variables`
 * `unused_variables`
+* `useless_equality_checks`
 
 By default all of these are enabled.
 
@@ -154,25 +157,3 @@ Example:
     ---
     ignore_paths:
       - lib/ruby-lint/definitions
-
-### enable_cache
-
-A boolean that indicates that caching should be enabled or disabled, by default
-this is enabled. Disabling caching can slow down ruby-lint considerably.
-
-Example:
-
-    ---
-    enable_cache: true
-
-### cache_directory
-
-The directory to store cache files in if caching is enabled. By default this is
-set to `$XDG_CACHE_HOME/ruby-lint` or `$HOME/.cache/ruby-lint` if the former
-variable isn't set. If the cache directory doesn't exist it's created
-automatically.
-
-Example:
-
-    ---
-    cache_directory: ~/ruby-lint

data/lib/ruby-lint.rb

@@ -5,28 +5,29 @@ require 'parser/current'
 
 require 'yaml'
 require 'set'
-require 'digest/sha1'
 require 'zlib'
 
 require_relative 'ruby-lint/extensions/string'
 
 require_relative 'ruby-lint/ruby_lint'
+require_relative 'ruby-lint/version'
 require_relative 'ruby-lint/variable_predicates'
+require_relative 'ruby-lint/method_evaluation'
 require_relative 'ruby-lint/ast/node'
 require_relative 'ruby-lint/ast/builder'
 require_relative 'ruby-lint/parser'
 require_relative 'ruby-lint/file_scanner'
 require_relative 'ruby-lint/file_list'
 require_relative 'ruby-lint/nested_stack'
+require_relative 'ruby-lint/configuration'
+require_relative 'ruby-lint/runner'
+require_relative 'ruby-lint/command'
+
 require_relative 'ruby-lint/docstring/parser'
 require_relative 'ruby-lint/docstring/param_tag'
 require_relative 'ruby-lint/docstring/return_tag'
 require_relative 'ruby-lint/docstring/mapping'
 
-require_relative 'ruby-lint/node_hash'
-require_relative 'ruby-lint/cache'
-require_relative 'ruby-lint/cache_entry'
-
 require_relative 'ruby-lint/constant_path'
 require_relative 'ruby-lint/inspector'
 
@@ -70,11 +71,7 @@ require_relative 'ruby-lint/analysis/useless_equality_checks'
 require_relative 'ruby-lint/report'
 require_relative 'ruby-lint/report/entry'
 
+require_relative 'ruby-lint/presenter/base'
 require_relative 'ruby-lint/presenter/text'
 require_relative 'ruby-lint/presenter/json'
 require_relative 'ruby-lint/presenter/syntastic'
-
-require_relative 'ruby-lint/configuration'
-require_relative 'ruby-lint/default_names'
-require_relative 'ruby-lint/runner'
-require_relative 'ruby-lint/version'

data/lib/ruby-lint/analysis/argument_amount.rb

@@ -6,6 +6,8 @@ module RubyLint
     # amount was given.
     #
     class ArgumentAmount < Base
+      register 'argument_amount'
+
       ##
       # Hash that contains method names that should be used for analysis
       # instead of the ones specified in the keys.

data/lib/ruby-lint/analysis/base.rb

@@ -14,6 +14,8 @@ module RubyLint
     #  @return [RubyLint::Configuration]
     #
     class Base < Iterator
+      include MethodEvaluation
+
       attr_reader :report, :vm, :config
 
       ##
@@ -24,6 +26,16 @@ module RubyLint
       #
       SCOPES = [:root, :block, :class, :def, :module, :sclass]
 
+      ##
+      # Registers the current class in
+      # {RubyLint::Configuration.available_analysis_classes}.
+      #
+      # @param [String] name A human friendly name of the current class.
+      #
+      def self.register(name)
+        Configuration.available_analysis_classes[name] = self
+      end
+
       ##
       # Returns a boolean that indicates if the analysis class should be used
       # or not.

data/lib/ruby-lint/analysis/pedantics.rb

@@ -6,6 +6,8 @@ module RubyLint
     # statements and various other pedantics.
     #
     class Pedantics < Base
+      register 'pedantics'
+
       [:if, :unless, :until, :while].each do |type|
         define_method("on_#{type}") do |node|
           if node.location.respond_to?(:begin) and node.location.begin

data/lib/ruby-lint/analysis/shadowing_variables.rb

@@ -13,6 +13,8 @@ module RubyLint
     #     end
     #
     class ShadowingVariables < Base
+      register 'shadowing_variables'
+
       ##
       # @param [RubyLint::AST::Node] node
       #

data/lib/ruby-lint/analysis/undefined_methods.rb

@@ -12,14 +12,17 @@ module RubyLint
     #     'test'.foobar # => undefined method foobar on an instance of String
     #
     class UndefinedMethods < Base
+      register 'undefined_methods'
+
       ##
       # @param [RubyLint::AST::Node] node
       #
       def on_send(node)
         receiver, name, _  = *node
 
-        name  = name.to_s
-        scope = current_scope
+        receiver = unpack_block(receiver)
+        name     = name.to_s
+        scope    = current_scope
 
         if receiver and vm.associations.key?(receiver)
           scope = vm.associations[receiver]

data/lib/ruby-lint/analysis/undefined_variables.rb

@@ -10,6 +10,8 @@ module RubyLint
     # {RubyLint::Analysis::UndefinedMethods} instead.
     #
     class UndefinedVariables < Base
+      register 'undefined_variables'
+
       ##
       # Hash containing the various variable types to add errors for whenever
       # they are used but not defined.