ruby-lint 0.9.1 → 1.0.0.pre.preview1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 939921e3e0b0860d74f54f2ddaefe22108be2b0c
-  data.tar.gz: 940ca31c4345114f3a7cd864acda3fd4d64a8b34
+  metadata.gz: 24fc661993350c12969fcf32d98a88a3539a1f71
+  data.tar.gz: 4ae7f0b1589d953aef60c3d027aa38e6de6dc17b
 SHA512:
-  metadata.gz: 8d4341b6d719cc515b69fa16eb2e76d5515a40655e63fbf88f60a6bd9bdcdfec59184ac62a151ce6e42920ff039206fc359a47e131ac2ab76de2a8a83f69fd2b
-  data.tar.gz: 3e3dfa77c8a7a0cad2c7ab54839f870c124cc1685c661de5881b6980678a498cc5a339772bb4800c93d6da85ebef7f71f57a522cb987b1e02c876cc6976aa1a7
+  metadata.gz: 053bc9734416821c16a410eef0b8b49bfcf16b84b29fb08f82a3d1ac73dfc41b5b144bc0695e681cc556a127e2af010abb501d4e45dfd5cbf3baecfcc725999d
+  data.tar.gz: 61a61089a5f673979e0fc696e2e36e0595dfaea73c29b7aaba677ce9134ac0c6f77375d9ea3c67bfe5074eb21a7e2b5843fc957d507ba3834daa532fc01afbdf

data/.travis.yml

@@ -4,7 +4,7 @@ script: rake travis
 rvm:
   - 1.9.3
   - 2.0.0
-  - rbx-19mode
+  - rbx-2.2.1
   - jruby-19mode
 
 notifications:

data/CONTRIBUTING.md

@@ -4,22 +4,20 @@ 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 basic set of guidelines is described at
-<http://yorickpeterse.com/articles/contributing-to-my-code/>. The article looks
-a bit daunting but most of what this article describes is already common
-practise in Ruby land. In short:
+The gist of this is as following:
 
-* write tests
-* write documentation using YARD (at the very least arguments and return values
+* Write tests
+* Write documentation using YARD (at the very least arguments and return values
   should be documented)
-* wrap lines at 79 characters per line
+* 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.
 
-These are the most important bits, the rest is all described in the above
-article. 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.
+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.
 
 ## Legal
 

data/Gemfile

@@ -2,6 +2,9 @@ source 'https://rubygems.org/'
 
 gemspec
 
-gem 'racc', :platforms => :rbx
-
-gem 'ruby-prof', :platforms => :mri
+group :testing do
+  gem 'rubysl', :platform => :rbx
+  gem 'rubinius-developer_tools', :platform => :rbx
+  gem 'racc', :platform => :rbx
+  gem 'ruby-prof', :platform => :mri
+end

data/MANIFEST

@@ -8,6 +8,7 @@ LICENSE
 MANIFEST
 README.md
 Rakefile
+benchmark/bootup.rb
 benchmark/virtual_machine.rb
 bin/ruby-lint
 checksum/.gitkeep
@@ -15,6 +16,7 @@ checksum/ruby-lint-0.0.3.gem.sha512
 checksum/ruby-lint-0.0.4.gem.sha512
 checksum/ruby-lint-0.0.5.gem.sha512
 checksum/ruby-lint-0.9.0.gem.sha512
+checksum/ruby-lint-0.9.1.gem.sha512
 doc/.gitkeep
 doc/DCO.md
 doc/architecture.md
@@ -36,6 +38,7 @@ lib/ruby-lint/analysis/undefined_variables.rb
 lib/ruby-lint/analysis/unused_variables.rb
 lib/ruby-lint/ast/builder.rb
 lib/ruby-lint/ast/node.rb
+lib/ruby-lint/benchmark/average.rb
 lib/ruby-lint/cache.rb
 lib/ruby-lint/cache_entry.rb
 lib/ruby-lint/cli.rb
@@ -45,6 +48,7 @@ lib/ruby-lint/cli/base.rb
 lib/ruby-lint/cli/plot.rb
 lib/ruby-lint/configuration.rb
 lib/ruby-lint/constant_loader.rb
+lib/ruby-lint/constant_path.rb
 lib/ruby-lint/default_names.rb
 lib/ruby-lint/definition/constant_proxy.rb
 lib/ruby-lint/definition/ruby_method.rb
@@ -218,7 +222,6 @@ lib/ruby-lint/file_loader.rb
 lib/ruby-lint/file_scanner.rb
 lib/ruby-lint/generated_constant.rb
 lib/ruby-lint/global_scope.rb
-lib/ruby-lint/helper/constant_paths.rb
 lib/ruby-lint/inspector.rb
 lib/ruby-lint/iterator.rb
 lib/ruby-lint/method_call/alias.rb
@@ -278,6 +281,7 @@ spec/ruby-lint/cache_spec.rb
 spec/ruby-lint/cli/analyze_spec.rb
 spec/ruby-lint/cli/ast_spec.rb
 spec/ruby-lint/configuration_spec.rb
+spec/ruby-lint/constant_path.rb
 spec/ruby-lint/definition/constant_proxy_spec.rb
 spec/ruby-lint/definition/dsl_spec.rb
 spec/ruby-lint/definition/ruby_method_spec.rb
@@ -305,6 +309,8 @@ spec/ruby-lint/report_spec.rb
 spec/ruby-lint/runner_spec.rb
 spec/ruby-lint/virtual_machine/alias_spec.rb
 spec/ruby-lint/virtual_machine/assignments/arrays_spec.rb
+spec/ruby-lint/virtual_machine/assignments/assignment_arguments_spec.rb
+spec/ruby-lint/virtual_machine/assignments/constants_spec.rb
 spec/ruby-lint/virtual_machine/assignments/hashes_spec.rb
 spec/ruby-lint/virtual_machine/assignments/optional_spec.rb
 spec/ruby-lint/virtual_machine/assignments/return_values_spec.rb

data/README.md

@@ -16,9 +16,9 @@ instead of focusing on semantics (e.g. the amount of characters per line).
 
 The following Ruby implementations/versions are officially supported:
 
-* Ruby 1.9.3 or 2.0 and newer
-* Rubinius head running in 1.9 mode
-* Jruby head running in 1.9 mode
+* MRI 1.9.3 and newer
+* Rubinius 2.0 and newer
+* Jruby 1.7 and newer
 
 Ruby implementations running a 1.8 based version of Ruby are not supported.
 
@@ -40,25 +40,18 @@ This builds a new version of the Gem and saves it in the pkg/ directory.
 
 ## Security
 
-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:
+As a basic form of security ruby-lint provides a set of SHA512 checksums for
+every Gem release. These checksums can be found in the `checksum/` directory.
+Although these checksums do not prevent malicious users from tampering with a
+built Gem they can be used for basic integrity verification purposes.
 
-    gem install ruby-lint --verify --trust
+The checksum of a file can be checked using the `sha512sum` command. For
+example:
 
-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>.
+    $ sha512sum pkg/ruby-lint-0.9.1.gem
+    10a51f27c455e5743fff7fefe29512cff20116b805bec148e09d4bade1727e3beab7f7f9ee97b020d290773edcb7bd1685858ccad0bbd1a35cc0282c00c760c6  pkg/ruby-lint-0.9.1.gem
 
-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.
+In the past Gems were also signed using PGP, this is no longer the case.
 
 ## Usage
 
@@ -91,9 +84,9 @@ Given the following code:
 Analysing this file using ruby-lint (with the default settings) would result in
 the following output:
 
-    test.rb: error: line 7, column 21: undefined instance variable @name
-    test.rb: warning: line 12, column 0: unused local variable greeting
-    test.rb: error: line 14, column 0: wrong number of arguments (expected 0 but got 1)
+    test.rb: error: line 7, column 22: undefined instance variable @name
+    test.rb: warning: line 12, column 1: unused local variable greeting
+    test.rb: error: line 14, column 1: wrong number of arguments (expected 0 but got 1)
 
 ## Documentation
 
@@ -107,5 +100,3 @@ the following output:
 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

data/benchmark/bootup.rb

@@ -0,0 +1,13 @@
+# This benchmark script measures the amount of time it takes to boot up the CLI
+# and analyze the VM with caching disabled.
+
+require_relative '../lib/ruby-lint/benchmark/average'
+
+script  = File.expand_path('../../bin/ruby-lint', __FILE__)
+command = "#{script} analyze --disable-cache lib/ruby-lint/virtual_machine.rb"
+
+RubyLint::Benchmark::Average.measure do
+  output = `#{command}`
+
+  raise "Command failed: #{output}" unless $?.success?
+end

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

@@ -0,0 +1 @@
+10a51f27c455e5743fff7fefe29512cff20116b805bec148e09d4bade1727e3beab7f7f9ee97b020d290773edcb7bd1685858ccad0bbd1a35cc0282c00c760c6

data/doc/code_analysis.md

@@ -8,6 +8,8 @@ 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} and {RubyLint::Analysis::Base} (which extends the former).
 
+## Example
+
 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
 will be added informing the developer that he/she should use snake\_case
@@ -88,3 +90,21 @@ The full code of this exercise looks like the following:
     iterator.iterate(ast)
 
     puts presenter.present(report)
+
+## Conditional Analysis
+
+In some cases you want to use a certain analysis class but only enable it if a
+certain condition is met. In order to do so a analysis class should define a
+class method called `analyze?` that returns a boolean that indicates if the
+class should be used or not. The basic signature of this method can be seen at
+{RubyLint::Analysis::Base.analyze?}.
+
+For example, if you only want to analyze RSpec files:
+
+    class RSpecExample < RubyLint::Analysis::Base
+      def self.analyze?(ast, vm)
+        return ast.file =~ /_spec\.rb$/
+      end
+    end
+
+By default all analysis classes are enabled.

data/doc/css/common.css

@@ -17,6 +17,7 @@ pre.code
 {
     font-size:   13px;
     line-height: 1.4;
+    overflow:    auto;
 }
 
 /**

data/lib/ruby-lint.rb

@@ -1,7 +1,5 @@
-gem 'racc', '>= 1.4.10'
 gem 'parser', '>= 2.0.0'
 
-require 'racc'
 require 'parser'
 
 # Try to load the latest parser and fall back to 2.0. This should only occur on
@@ -37,7 +35,7 @@ require_relative 'ruby-lint/node_hash'
 require_relative 'ruby-lint/cache'
 require_relative 'ruby-lint/cache_entry'
 
-require_relative 'ruby-lint/helper/constant_paths'
+require_relative 'ruby-lint/constant_path'
 
 require_relative 'ruby-lint/definition_builder/base'
 require_relative 'ruby-lint/definition_builder/ruby_module'

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

@@ -11,8 +11,6 @@ module RubyLint
     #  @return [RubyLint::VirtualMachine]
     #
     class Base < Iterator
-      include Helper::ConstantPaths
-
       attr_reader :report, :vm
 
       ##
@@ -23,6 +21,18 @@ module RubyLint
       #
       SCOPES = [:root, :block, :class, :def, :module, :sclass]
 
+      ##
+      # Returns a boolean that indicates if the analysis class should be used
+      # or not.
+      #
+      # @param [RubyLint::AST::Node] ast
+      # @param [RubyLint::VirtualMachine] vm
+      # @return [TrueClass|FalseClass]
+      #
+      def self.analyze?(ast, vm)
+        return true
+      end
+
       ##
       # Called after a new instance of this class is created.
       #

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

@@ -36,8 +36,9 @@ module RubyLint
       # @param [RubyLint::AST::Node] node
       #
       def on_const(node)
-        variable = resolve_constant_path(node)
-        name     = constant_segments(node).join('::')
+        path     = ConstantPath.new(node)
+        variable = path.resolve(current_scope)
+        name     = path.to_s
 
         error("undefined constant #{name}", node) unless variable
       end

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

@@ -49,8 +49,9 @@ module RubyLint
       # @param [RubyLint::AST::Node] node
       #
       def on_casgn(node)
-        variable = resolve_constant_path(node)
-        name     = constant_segments(node).join('::')
+        path     = ConstantPath.new(node)
+        variable = path.resolve(current_scope)
+        name     = path.to_s
 
         if variable and !variable.used?
           warning("unused constant #{name}", node)

data/lib/ruby-lint/ast/node.rb

@@ -18,7 +18,7 @@ module RubyLint
       # @return [Numeric]
       #
       def column
-        return location.expression.column if location
+        return location.expression.column + 1 if location
       end
 
       ##

data/lib/ruby-lint/benchmark/average.rb

@@ -0,0 +1,115 @@
+require 'benchmark'
+
+module RubyLint
+  module Benchmark
+    ##
+    # Benchmark class for measuring min/max/avg timings of a block of Ruby
+    # code.
+    #
+    # @!attribute [r] iterations
+    #  @return [Numeric]
+    #
+    # @!attribute [r] precision
+    #  @return [Numeric]
+    #
+    class Average
+      attr_reader :iterations, :precision
+
+      ##
+      # @return [Array]
+      #
+      AVERAGE_COLUMNS = %w(Iterations Minimum Maximum Average)
+
+      ##
+      # @return [String]
+      #
+      SEPARATOR = ' | '
+
+      ##
+      # Shorthand method for easily measuring a block.
+      #
+      # @see #measure
+      #
+      def self.measure(*args, &block)
+        new(*args).measure(&block)
+      end
+
+      ##
+      # @param [Numeric] iterations The amount of times to call the block.
+      # @param [Numeric] precision The amount of decimals to display.
+      #
+      def initialize(iterations = 100, precision = 6)
+        @iterations = iterations
+        @precision  = precision
+      end
+
+      ##
+      # Runs the given block N times and displays the minimum, maximum and average
+      # execution times in secnds.
+      #
+      def measure
+        timings = []
+
+        iterations.times do
+          timings << ::Benchmark.measure { yield }.real
+        end
+
+        avg = timings.inject(:+) / iterations
+
+        show(timings.min, timings.max, avg)
+      end
+
+      ##
+      # @param [Numeric] min
+      # @param [Numeric] max
+      # @param [Numeric] avg
+      #
+      def show(min, max, avg)
+        values  = [iterations.to_s] + format_values([min, max, avg])
+        padding = padding_length(AVERAGE_COLUMNS + values)
+
+        show_header(padding)
+
+        puts values.map { |val| val.ljust(padding) }.join(SEPARATOR)
+      end
+
+      private
+
+      ##
+      # Display the header.
+      #
+      # @param [Numeric] padding
+      #
+      def show_header(padding)
+        header = format_header(padding)
+
+        puts header
+        puts header.gsub('|', '+').gsub(/[^+]/, '-')
+      end
+
+      ##
+      # @param [Array] values
+      # @return [Array<String>]
+      #
+      def format_values(values)
+        return values.map { |val| "#{val.round(precision)} sec" }
+      end
+
+      ##
+      # @param [Numeric] padding
+      # @return [String]
+      #
+      def format_header(padding)
+        return AVERAGE_COLUMNS.map { |val| val.ljust(padding) }.join(SEPARATOR)
+      end
+
+      ##
+      # @param [Array] values
+      # @return [Numeric]
+      #
+      def padding_length(values)
+        return values.sort_by { |value| value.length }.last.length
+      end
+    end # Average
+  end # Benchmark
+end # RubyLint

data/lib/ruby-lint/cli/analyze.rb

@@ -49,6 +49,10 @@ Examples:
   You can also specify multiple files:
 
       $ ruby-lint analyze first_file.rb second_file.rb
+
+  Run analysis on an entire directory:
+
+      $ ruby-lint analyze lib/
   EOF
 
   separator RubyLint::CLI::OPTIONS_HEADER
@@ -78,14 +82,28 @@ Examples:
 
       if File.file?(file)
         existing << file
+
+      elsif File.directory?(file)
+        existing = existing | glob_files(file)
+
       else
-        abort "The file #{file} does not exist"
+        abort "The file/directory #{file} does not exist"
       end
     end
 
     return existing
   end
 
+  ##
+  # Returns a list of Ruby files in the given directory. This list includes
+  # deeply nested files.
+  #
+  # @return [Array]
+  #
+  def glob_files(directory)
+    return Dir.glob(File.join(directory, '**/*.rb'))
+  end
+
   ##
   # @return [Hash]
   #