ruby-lint 0.0.3 → 0.0.4

data/Rakefile

@@ -3,7 +3,7 @@ require File.expand_path('../lib/ruby-lint/inspector', __FILE__)
 require File.expand_path('../lib/ruby-lint/definition_generator', __FILE__)
 
 require 'yaml'
-require 'rubygems/package_task'
+require 'bundler/gem_tasks'
 require 'digest/sha2'
 
 GEMSPEC = Gem::Specification.load('ruby-lint.gemspec')
@@ -12,9 +12,4 @@ Dir['./task/*.rake'].each do |task|
   import(task)
 end
 
-Gem::PackageTask.new(GEMSPEC) do |pkg|
-  pkg.need_tar = false
-  pkg.need_zip = false
-end
-
 task :default => :test

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

@@ -0,0 +1 @@
+0e13075c8e7eae96846a0be8a77890c2f2a5f6748341a582805c5091ed926e828c09baff38327b2edbb8f40b3d16015226342a5a10a366ade668b5247fd47dd7

data/debug/memory_usage.rb

@@ -0,0 +1,14 @@
+require 'ruby-prof'
+
+RubyProf.measure_mode = RubyProf::MEMORY
+
+result = RubyProf.profile do
+  require_relative '../lib/ruby-lint'
+  require_relative '../lib/ruby-lint/definitions/rails'
+end
+
+total    = result.threads[0].total_time
+total_kb = total.round(2)
+total_mb = (total / 1024).round(2)
+
+puts "Total memory usage: #{total_mb}MB (#{total_kb}KB)"

data/debug/profile.rb

@@ -0,0 +1,18 @@
+require 'ruby-prof'
+
+result = RubyProf.profile do
+  require_relative '../lib/ruby-lint'
+  require_relative '../lib/ruby-lint/definitions/rails'
+end
+
+result.eliminate_methods!([
+  /Kernel#require/,
+  /Kernel#gem_original_require/,
+  /Module#module_eval/,
+  /^Gem/,
+  /^Parser/
+])
+
+printer = RubyProf::FlatPrinter.new(result)
+
+printer.print(STDOUT)

data/doc/architecture.md

@@ -20,34 +20,28 @@ would look like the following:
 
     (string "hello")
 
-Each node is an instance of {RubyLint::Node}. Each node can contain a number of
-child nodes. If one were to format the above S expression as an Array you'd get
-the following:
+Each node is an instance of {RubyLint::AST::Node}. Each node can contain a
+number of child nodes. If one were to format the above S expression as an Array
+you'd get the following:
 
     [:string, ["hello"]]
 
-For more information see the documentation of {RubyLint::Node} and the
-corresponding tests found in `spec/ruby-lint/parser/`.
+The parser used by ruby-lint is the [parser gem][parser gem] and as such
+ruby-lint can support various Ruby implementations and versions.
 
-Currently the parser is based on Ripper, a library that comes with MRI 1.9 and
-newer. Because of this ruby-lint will be unable to support Rubinius and Jruby
-for the time being. In the future this parser will be replaced with something
-that runs on all the common Ruby implementations.
+## Virtual Machine
 
-## Definitions Builder
-
-The {RubyLint::DefinitionsBuilder definitions builder} iterates over the AST
-and evaluates it so that variables can be created, methods can be defined and
-so on. Once finished a single {RubyLint::Definition::RubyObject} definition is
-created that contains all the Ruby data of a block of Ruby code.
-
-One can see the definitions builder as a very basic virtual machine.
+The ruby-lint virtual machine is a stack based virtual machine used for
+partially evaluating Ruby code in order to build definitions of method
+definitions, class definitions, variable assignments and so on. For more
+information on the internals of this class see the documentation of
+{RubyLint::VirtualMachine}.
 
 ## Analysis
 
 This is where the real work start. The analysis step consists out of various
 Ruby classes of which each performs its own type of analysis. For example,
-{RubyLint::Analyze::UndefinedMethods} checks for the use of undefined methods.
+{RubyLint::Analysis::UndefinedMethods} checks for the use of undefined methods.
 
 ## Reports
 
@@ -61,3 +55,5 @@ as well as a message (e.g. an error message).
 Presenters are classes tasked with the job of presenting a report. Currently
 ruby-lint ships with a presenter that outputs a report in plain text as well as
 one that outputs a report in JSON.
+
+[parser gem]: https://github.com/whitequark/parser

data/doc/changelog.md

@@ -0,0 +1,29 @@
+# @title Changelog
+# Changelog
+
+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).
+
+## 0.0.4 - 2013-07-14
+
+Near total refactor of the entire project. New parser setup based on the
+"parser" Gem instead of using a custom built parser built using Ripper. More
+analysis classes, a more stable mechanism for building definitions, bug fixes
+and a lot more.
+
+This release (thanks to "parser") also introduces support for Jruby and
+Rubinius (2.0/Git HEAD, 1.X is not supported).
+
+## 0.0.3 - 2013-04-22
+
+Lots of internal changes for tasks such as building definitions. Also included
+a large set of bugfixes.
+
+## 0.0.2 - 2012-11-15
+
+Various changes to the old parser.
+
+## 0.0.1 - 2012-11-13
+
+First public release of ruby-lint.

data/doc/code_analysis.md

@@ -2,11 +2,11 @@
 # Code Analysis
 
 Code analysis in ruby-lint is done using a set of classes that extend
-{RubyLint::Iterator}. This base class provides various methods for easily
+{RubyLint::Analysis::Base}. This base class provides various methods for easily
 walking over an AST by using callback methods based on the node types. For
 example, the callback method `on_string` is used before a `(string)` node is
 processed. For more low level details see the API documentation of
-{RubyLint::Iterator}.
+{RubyLint::Iterator} and {RubyLint::Analysis::Base} (which extends the former).
 
 For this guide we'll be creating an analysis class that checks for local
 variables written in camelCase. Whenever it finds these variables a warning
@@ -15,7 +15,7 @@ instead.
 
 At the most basic level this class looks like the following:
 
-    class CamelCaseVariables < RubyLint::Iterator
+    class CamelCaseVariables < RubyLint::Analysis::Base
 
     end
 
@@ -26,7 +26,7 @@ adding errors and the likes.
 To use this class you'll have to create an instance of it and call
 {RubyLint::Iterator#iterate} and pass it an AST:
 
-    ast      = RubyLint::Parser.new('exampleNumber = 10').parse
+    ast      = RubyLint::Parser.new.parse('exampleNumber = 10')
     iterator = CamelCaseVariables.new
 
     iterator.iterate(ast)
@@ -42,13 +42,13 @@ Here X is the name of the node type. Methods that start with `on_` will be
 executed before any child nodes (of the current node) are processed.  Methods
 that start with `after_` will be executed after the node and its child nodes
 have been processed. Each callback method takes a single argument: an instance
-of {RubyLint::Node} containing information about the current node.
+of {RubyLint::AST::Node} containing information about the current node.
 
 In the above example we only need an `on_` callback:
 
-    class CamelCaseVariables < RubyLint::Iterator
-      def on_local_variable(node)
-        if node.name =~ /[a-z][A-Z]/
+    class CamelCaseVariables < RubyLint::Analysis::Base
+      def on_lvar(node)
+        if node.children[0].to_s =~ /[a-z][A-Z]/
           warning('use snake_case for local variables', node)
         end
       end
@@ -72,15 +72,15 @@ use:
 
 The full code of this exercise looks like the following:
 
-    class CamelCaseVariables < RubyLint::Iterator
-      def on_local_variable(node)
-        if node.name =~ /[a-z][A-Z]/
+    class CamelCaseVariables < RubyLint::Analysis::Base
+      def on_lvar(node)
+        if node.children[0].to_s =~ /[a-z][A-Z]/
           warning('use snake_case for local variables', node)
         end
       end
     end
 
-    ast       = RubyLint::Parser.new('exampleNumber = 10').parse
+    ast       = RubyLint::Parser.new.parse('exampleNumber = 10')
     report    = RubyLint::Report.new
     iterator  = CamelCaseVariables.new(:report => report)
     presenter = RubyLint::Presenter::Text.new

data/doc/configuration.md

@@ -3,7 +3,7 @@
 
 The default configuration of ruby-lint should be suitable for most people.
 However, depending on your code base you may get an usual amount of false
-positives. In particular the class {RubyLint::Analyze::UndefinedMethods} can
+positives. In particular the class {RubyLint::Analysis::UndefinedMethods} can
 produce a lot of false positives.
 
 ruby-lint allows developers to customize the various parts of the tool such as
@@ -22,8 +22,8 @@ changes to stick around you'll want to use a configuration file instead.
 When running the CLI ruby-lint will try to load one of the following two
 configuration files:
 
-* $PWD/ruby-lint.rb
-* $HOME/.ruby-lint.rb
+* $PWD/ruby-lint.yml
+* $HOME/.ruby-lint.yml
 
 Here `$PWD` refers to the current working directory and `$HOME` to the user's
 home directory. If ruby-lint finds a configuration file in the current working
@@ -33,54 +33,25 @@ fallback.
 
 ## Configuring ruby-lint
 
-The various configuration settings are set using plain old Ruby, there's no
-YAML nonsense that gets in your way.
+Configuration is done using simple YAML files with the following structure:
 
-Configuration settings are stored in {RubyLint.configuration} (as an instance
-of {RubyLint::Configuration}). Although you can access this object directly in
-the form of `RubyLint.configuration.foo = :bar` it's recommended that you use
-{RubyLint.configure} instead since it provides a shorter and friendlier syntax.
+* `requires`: an Array of files to require before running ruby-lint
+* `report_levels`: an Array of report levels to enable.
+* `analysis_classes`: an Array of the human friendly names of the analysis
+  classes to enable.
+* `presenter`: the human friendly name of the presenter to use.
 
-The boilerplate for configuring ruby-lint looks like the following:
+A basic example looks lik the following:
 
-    RubyLint.configure do |config|
+    ---
+    requires:
+      - ruby-lint/definitions/core/string
+    report_levels:
+      - error
+    analysis_classes:
+      - undefined_methods
+      - undefined_variables
+    presenter: json
 
-    end
-
-To change the presenter to use you'd use the following:
-
-    RubyLint.configure do |config|
-      config.presenter = RubyLint::Presenter::JSON
-    end
-
-Changing the analysis classes is done as following:
-
-    RubyLint.configure do |config|
-      # Only use the two classes listed below.
-      config.analysis = [
-        RubyLint::Analysis::UndefinedVariables,
-        RubyLint::Analysis::ShadowingVariables
-      ]
-    end
-
-And changing the reporting levels:
-
-    RubyLint.configure do |config|
-      config.report_levels = [:error]
-    end
-
-Combined together this leads to the following configuration:
-
-    RubyLint.configure do |config|
-      config.presenter = RubyLint::Presenter::JSON
-
-      # Only use the two classes listed below.
-      config.analysis = [
-        RubyLint::Analysis::UndefinedVariables,
-        RubyLint::Analysis::ShadowingVariables
-      ]
-
-      config.report_levels = [:error]
-    end
-
-For more information see the documentation of {RubyLint::Configuration}.
+If no value is given for a certain configuration option the default value(s)
+will be used instead.

data/doc/graphviz/flow.dot

@@ -2,6 +2,6 @@
 // ruby-lint.
 
 digraph flow {
-    "Source" -> "Parser" -> "Definitions Builder" -> "Analysis";
+    "Source" -> "Parser" -> "Virtual Machine" -> "Analysis";
     "Analysis" -> "Report" -> "Presenter";
 }

data/lib/ruby-lint.rb

@@ -1,37 +1,51 @@
-require 'ripper'
-require 'ast/node'
+require 'parser'
+require 'parser/current'
+require 'yaml'
 
 require_relative 'ruby-lint/extensions/string'
 
 require_relative 'ruby-lint/variable_predicates'
-require_relative 'ruby-lint/node'
+require_relative 'ruby-lint/ast/node'
+require_relative 'ruby-lint/ast/builder'
 require_relative 'ruby-lint/parser'
-require_relative 'ruby-lint/parser_error'
+require_relative 'ruby-lint/nested_stack'
+
+require_relative 'ruby-lint/helper/constant_paths'
+
+require_relative 'ruby-lint/definition_builder/base'
+require_relative 'ruby-lint/definition_builder/ruby_module'
+require_relative 'ruby-lint/definition_builder/ruby_class'
+require_relative 'ruby-lint/definition_builder/ruby_method'
+require_relative 'ruby-lint/definition_builder/ruby_array'
+require_relative 'ruby-lint/definition_builder/ruby_hash'
+require_relative 'ruby-lint/definition_builder/ruby_block'
+require_relative 'ruby-lint/definition_builder/primitive'
+
 require_relative 'ruby-lint/iterator'
-require_relative 'ruby-lint/definitions_builder'
+require_relative 'ruby-lint/virtual_machine'
 require_relative 'ruby-lint/constant_loader'
 
-require_relative 'ruby-lint/configuration'
-require_relative 'ruby-lint/version'
-require_relative 'ruby-lint/base'
-
 require_relative 'ruby-lint/definition/ruby_object'
 require_relative 'ruby-lint/definition/ruby_method'
+require_relative 'ruby-lint/definition/constant_proxy'
 require_relative 'ruby-lint/definitions/core'
 
-require_relative 'ruby-lint/helper/conversion'
-require_relative 'ruby-lint/helper/current_scope'
-require_relative 'ruby-lint/helper/constant_paths'
-require_relative 'ruby-lint/helper/methods'
-
-require_relative 'ruby-lint/analyze/unused_variables'
-require_relative 'ruby-lint/analyze/shadowing_variables'
-require_relative 'ruby-lint/analyze/undefined_variables'
-require_relative 'ruby-lint/analyze/undefined_methods'
-require_relative 'ruby-lint/analyze/argument_amount'
+require_relative 'ruby-lint/analysis/base'
+require_relative 'ruby-lint/analysis/unused_variables'
+require_relative 'ruby-lint/analysis/shadowing_variables'
+require_relative 'ruby-lint/analysis/undefined_variables'
+require_relative 'ruby-lint/analysis/undefined_methods'
+require_relative 'ruby-lint/analysis/argument_amount'
+require_relative 'ruby-lint/analysis/confusing_variables'
+require_relative 'ruby-lint/analysis/pedantics'
 
 require_relative 'ruby-lint/report'
 require_relative 'ruby-lint/report/entry'
 
 require_relative 'ruby-lint/presenter/text'
 require_relative 'ruby-lint/presenter/json'
+
+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

@@ -0,0 +1,84 @@
+module RubyLint
+  module Analysis
+    ##
+    # The ArgumentAmount class is an analysis class that verifies the amount of
+    # arguments given with each method call and adds errors whenever an invalid
+    # amount was given.
+    #
+    class ArgumentAmount < Base
+      ##
+      # @param [RubyLint::Node] node
+      #
+      def on_send(node)
+        receiver, name, args = *node
+
+        name  = name.to_s
+        scope = current_scope
+
+        if receiver and vm.associations.key?(receiver)
+          scope = vm.associations[receiver]
+        end
+
+        method = scope.lookup(scope.method_call_type, name)
+
+        return unless method
+
+        given    = args ? args.children.length : 0
+        min, max = argument_range(method)
+
+        unless correct_argument_amount(min, max, given)
+          text = argument_text(method, given)
+
+          error(
+            "wrong number of arguments (expected #{text} but got #{given})",
+            node
+          )
+        end
+      end
+
+      private
+
+      ##
+      # @param [Numeric] min
+      # @param [Numeric] max
+      # @param [Numeric] given
+      # @return [TrueClass|FalseClass]
+      #
+      def correct_argument_amount(min, max, given)
+        return given >= min && given <= max
+      end
+
+      ##
+      # Returns a String that indicates the amount of required arguments.
+      #
+      # @param [RubyLint::Definition::RubyMethod] method
+      # @param [Numeric] given
+      # @return [String]
+      #
+      def argument_text(method, given)
+        min = method.amount(:arg)
+        opt = method.amount(:optarg)
+
+        return opt > 0 ? "#{min}..#{min + opt}" : min.to_s
+      end
+
+      ##
+      # Returns the minimum and maximum amount of arguments for a method call.
+      #
+      # @param [RubyLint::Definition::RubyMethod] method
+      # @return [Array]
+      #
+      def argument_range(method)
+        min = method.amount(:arg)
+
+        if method.amount(:restarg) > 0
+          max = Float::INFINITY
+        else
+          max = min + method.amount(:optarg) + method.amount(:restarg)
+        end
+
+        return min, max
+      end
+    end # ArgumentAmount
+  end # Analysis
+end # RubyLint