ruby-lint 0.0.5 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf30514aa5a1f824fa2dd56dfb776da2f19b02f1
-  data.tar.gz: 333fe29270d161bba23bbeeb077647eb482758e6
+  metadata.gz: fe09b414c536802b61ad8624935086a8a190485e
+  data.tar.gz: 38f69287cc16982dee093653557848a8d2ce940d
 SHA512:
-  metadata.gz: 68e08f78c67e18632afd43aadd45dd0eb7e95c3abbe505ff1f5fd64bd5c8cc019a3c4f7e22456cee7359acc05188551e60484e4e8ceae5417d5c623ee69f26eb
-  data.tar.gz: af1bdbb7036b5e2c728a2f31f2dc074baf268f083337f04b4cbc5389db6d6c82e3ed87db8bd7113ea695a947b66b02c28e07726c461453615f98b6326eb2f359
+  metadata.gz: 46e3649eb9b98b1deb98c22e38797295b1016caae028eddf3191e1b871bf0381e5bafd02b8fa6c8cdb38c1a5cf8624f020a7dde85946aeb4752b0c8e9b505ab1
+  data.tar.gz: 3005aaed981fb405931e820a6e757459651112d83126ad5ec83a2be1373157867a7dd1f7da5ca86e5dd3c7f91adec6283f17daa08e094944f9a0661bb956fa7b

checksums.yaml.gz.asc

@@ -1,17 +1,17 @@
 -----BEGIN PGP SIGNATURE-----
-Version: GnuPG v2.0.21 (GNU/Linux)
+Version: GnuPG v2.0.22 (GNU/Linux)
 
-iQIcBAABAgAGBQJSI1ZdAAoJEPMbESk2SfREreIQAK4KVRJ8W9NfaMaoIAt9PqrK
-9F82AF819tV9Yp8pzv+QhzXeQf/HStRtqGgUu/TeH3OLQ9+i866xTUZPPUtL0WRC
-D3YuTRtRcaL6DKei4PwnUkzxr4Vyc+ESZHy0MtR7brYyXntjWAwpgE7scZiP/6h5
-lP8LKmGFmdt/cviz03byGFM7AIQ2H7Bn7y6E8Z+SLzSVhgQtuVfvrxrM3CLiTLCB
-l3efJyuhWfWnDRWcL6mxDAD3yJmx68v9RnpPF/uDFAf/UxzSCKzxxIgPVqc3GdCL
-fyuZhnmYVxkgVdVKx0emEp1uVOP5Ab7CpTQcnQ7SptrgQ726Hllr2hbg5o/Yyc4c
-KGcsOsqVbp4ADfuPcBGPBGSNEXsUBWuhCJbLX3L/WpCa+efyDVJ9Q1ibSwo8T1Db
-NGcKWE95MEbgwrL2kQVZLWP0+EFK15B5Ejpj4l6wUiKaPphScVwbHbrfVtWT4Ol4
-D9G5FFEX5VSYVjJD9md2/IiBsZEtOxn10p+6bYrFZKP1ebcGI+7lIbjuSBv/bsla
-HSH1aiF5DyuJo5Sl7gcHkLUJSncyIoRJkYGDeDzXq5X77WK38P7QRgNYUFKeAvn8
-IFW4u8nv3RMIuQoPeXDd29OzCz6dwfwpCU0Ru84IBpuxj3FD5Pki4UrjkjE13W30
-/kVP2nSbwCKsmcT/G5mp
-=ovVB
+iQIcBAABAgAGBQJSWugYAAoJEPMbESk2SfREECsP/0XuJJCH46m/b8fxkAYUf2M3
+GdO8/8hMQDBgBRjx6Q1vvebuJNTl6b5AdEo6LnwbZMYURA/7YGzYDjkk7rUsF9WC
+Zsc5vAfOwGS5bnVpvVqjIiuCt2349lKQyVAmD57270WXKu6QYZJRQ9PQZ+0/BDGQ
+3X9aOJIURWW1kTRylmYu4ZXHc5s72qGKg2zsJqBcY6GMaeEsv0+578XFuReVcsyY
+xBxdp4GzLE3cK5E5a5JVwmzE5/TNZr9TzktNgqeGOYldKSdENCGkp8M1MfRhlSaN
+Hm5bUtPPkpz2bUVKVN0Ipk79d65Nmk3U28MCbKgSx+w2v6nw+AaU0H/9ktLsf8iO
+q2PLXsk3op/Ds3laTP3OZgKxYoW6jb/Tq4y0sjdcJimZv6ID4BRs95/iCsPsgTi3
+K8uUhOHWb9wYhwB/WbFjIQcLhblgVStekcIUCMgGYGRt1Mv4rc++gMPVCFNgJ3Qa
+zraKQcMB6xASwIcUhzkQ/ritgSev66V6q4iXn+sskEwXXzsaK3jvoWp4dDShMl84
+sKhP+dVdXW7YAjfM1l53YwLvObHaf7u6YbykPv3bKWxrbb9E68OH66x2h1DjBAUR
+4ssbGFOaXDl6EimYqoWWIaE7FPwt1FMnnoHlXZLOH/zCJkxfnZkLV6PMO8JSpvkV
+zh8/IQvpvhW1oFlhLYV/
+=gb/s
 -----END PGP SIGNATURE-----

data/.gitignore

@@ -3,3 +3,4 @@ coverage
 
 pkg
 Gemfile.lock
+.ruby-lint

data/.yardopts

@@ -7,7 +7,7 @@
 --protected
 --asset ./doc/css/common.css:css/common.css
 --asset ./doc/images:images
---exclude lib/ruby-lint/definitions/core
+--exclude lib/ruby-lint/definitions
 --verbose
 -
 ./doc/*.md

data/Gemfile

@@ -2,6 +2,6 @@ source 'https://rubygems.org/'
 
 gemspec
 
-group :profile do
-  gem 'ruby-prof', :platforms => :mri
-end
+gem 'racc', :platforms => :rbx
+
+gem 'ruby-prof', :platforms => :mri

data/MANIFEST

@@ -8,12 +8,12 @@ LICENSE
 MANIFEST
 README.md
 Rakefile
+benchmark/virtual_machine.rb
 bin/ruby-lint
 checksum/.gitkeep
 checksum/ruby-lint-0.0.3.gem.sha512
 checksum/ruby-lint-0.0.4.gem.sha512
-debug/memory_usage.rb
-debug/profile.rb
+checksum/ruby-lint-0.0.5.gem.sha512
 doc/.gitkeep
 doc/DCO.md
 doc/architecture.md
@@ -35,10 +35,13 @@ 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/cache.rb
+lib/ruby-lint/cache_entry.rb
 lib/ruby-lint/cli.rb
 lib/ruby-lint/cli/analyze.rb
 lib/ruby-lint/cli/ast.rb
 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/default_names.rb
@@ -190,6 +193,7 @@ lib/ruby-lint/definitions/core/unsupported_library_error.rb
 lib/ruby-lint/definitions/core/weak_ref.rb
 lib/ruby-lint/definitions/core/yaml.rb
 lib/ruby-lint/definitions/core/zero_division_error.rb
+lib/ruby-lint/definitions/core/zlib.rb
 lib/ruby-lint/definitions/global_variables.rb
 lib/ruby-lint/definitions/rails.rb
 lib/ruby-lint/definitions/rails/abstract_controller.rb
@@ -222,7 +226,9 @@ lib/ruby-lint/method_call/attribute.rb
 lib/ruby-lint/method_call/base.rb
 lib/ruby-lint/method_call/define_method.rb
 lib/ruby-lint/method_call/include.rb
+lib/ruby-lint/method_call_info.rb
 lib/ruby-lint/nested_stack.rb
+lib/ruby-lint/node_hash.rb
 lib/ruby-lint/parser.rb
 lib/ruby-lint/presenter/json.rb
 lib/ruby-lint/presenter/text.rb
@@ -234,6 +240,7 @@ lib/ruby-lint/template/scope.rb
 lib/ruby-lint/variable_predicates.rb
 lib/ruby-lint/version.rb
 lib/ruby-lint/virtual_machine.rb
+profiling/virtual_machine.rb
 ruby-lint.gemspec
 ruby-lint.yml
 spec/fixtures/associating.rb
@@ -244,6 +251,8 @@ spec/fixtures/config.yml
 spec/fixtures/file_scanner/lib/example/recursive/source.rb
 spec/fixtures/file_scanner/lib/example/recursive/target.rb
 spec/fixtures/file_scanner/lib/example/user.rb
+spec/fixtures/file_scanner/lib/ruby-lint/definition/constant_proxy.rb
+spec/fixtures/file_scanner/lib/ruby-lint/global_scope.rb
 spec/fixtures/file_scanner/lib/test-dashes/foo.rb
 spec/fixtures/file_scanner/rails/app/models/example/user.rb
 spec/fixtures/file_scanner/rails/app/models/user.rb
@@ -262,6 +271,8 @@ spec/ruby-lint/analysis/undefined_methods_spec.rb
 spec/ruby-lint/analysis/undefined_variables_spec.rb
 spec/ruby-lint/analysis/unused_variables_spec.rb
 spec/ruby-lint/ast/node_spec.rb
+spec/ruby-lint/cache_entry_spec.rb
+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
@@ -281,6 +292,7 @@ spec/ruby-lint/file_scanner_spec.rb
 spec/ruby-lint/inspector_spec.rb
 spec/ruby-lint/iterator_spec.rb
 spec/ruby-lint/nested_stack_spec.rb
+spec/ruby-lint/node_hash_spec.rb
 spec/ruby-lint/parser_spec.rb
 spec/ruby-lint/presenter/json_spec.rb
 spec/ruby-lint/presenter/text_spec.rb
@@ -310,6 +322,8 @@ spec/ruby-lint/virtual_machine/freeze_spec.rb
 spec/ruby-lint/virtual_machine/global_variables_spec.rb
 spec/ruby-lint/virtual_machine/inherit_kernel_spec.rb
 spec/ruby-lint/virtual_machine/interpolation_spec.rb
+spec/ruby-lint/virtual_machine/location_spec.rb
+spec/ruby-lint/virtual_machine/method_call_tracking_spec.rb
 spec/ruby-lint/virtual_machine/methods/attr_spec.rb
 spec/ruby-lint/virtual_machine/methods/define_method_spec.rb
 spec/ruby-lint/virtual_machine/methods/defining_spec.rb
@@ -337,7 +351,6 @@ task/doc.rake
 task/generate.rake
 task/graphviz.rake
 task/manifest.rake
-task/profile.rake
 task/tag.rake
 task/test.rake
 task/todo.rake

data/benchmark/virtual_machine.rb

@@ -0,0 +1,17 @@
+# This benchmarks N runs of the VM and outputs them to the console making it
+# easy to pass the data to tools such as `ministat`
+# (http://www.freebsd.org/cgi/man.cgi?ministat).
+
+require_relative '../lib/ruby-lint'
+require 'benchmark'
+
+parser = RubyLint::Parser.new
+file   = File.expand_path('../../lib/ruby-lint/virtual_machine.rb', __FILE__)
+ast    = parser.parse(File.read(file), file)
+amount = 1000
+
+amount.times do
+  timing = Benchmark.measure { RubyLint::VirtualMachine.new.run(ast) }
+
+  puts timing.real
+end

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

@@ -0,0 +1 @@
+dcc8326dec9cc6bdfdcf19e73a1f69172ffcdf4105be974ab644af00a44cd08306569d1001fe5a680e1ed5158bd2b73be6af801df096a037e7e06fcc116dd086

data/doc/changelog.md

@@ -5,6 +5,47 @@ 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.9.0 - 2013-10-13
+
+Although the version number increased by quite a bit this release in itself is
+fairly small. Seeing how the ruby-lint internals are slowly becoming more and
+more stable I'd like the version numbers to correspond with that. I'm not
+jumping to 1.0 right away since I do want to make various changes to the
+internals before I release 1.0.
+
+Having said that, this release contains the following:
+
+* Caching of ASTs required for finding externally defined constants.
+* An extra CLI command (`plot`) for plotting analysis timings.
+* Method call tracking.
+* Warnings for unused method/block arguments.
+* Support for Rubinius 2.0.
+
+The two most noteworthy changes are the caching system and support for method
+call tracking, these are highlighted below.
+
+### Caching
+
+In previous releases ruby-lint would re-parse extra files needed (those that
+contain the definitions of referenced constants) every time you'd analyze a
+file. This was rather problematic since [parser][parser] sadly isn't the
+fastest kid on the block. By caching the resulting ASTs performance of the same
+file (assuming it doesn't change between runs) can be increased drastically. If
+the analyzed file or an external one is changed the cache is invalidated
+automatically.
+
+Caching is enabled by default so you don't need to add any extra command-line
+flags or configuration options in your ruby-lint configuration file.
+
+### Method Call Tracking
+
+This new features makes it possible for ruby-lint to keep track of what methods
+are called from another method, both in the direction of caller to callee and
+the other way around. Currently this isn't used yet for any analysis but I have
+some ideas on adding useful analysis using this new feature. Another use case
+for this feature is generating Graphviz call graphs without actually having to
+run the corresponding Ruby source code.
+
 ## 0.0.5 - 2013-09-01
 
 Originally slated for August 1st I decided to push this release back one month
@@ -121,3 +162,4 @@ Various changes to the old parser.
 First public release of ruby-lint.
 
 [yard]: http://yardoc.org/
+[parser]: https://github.com/whitequark/parser

data/doc/configuration.md

@@ -33,25 +33,145 @@ fallback.
 
 ## Configuring ruby-lint
 
-Configuration is done using simple YAML files with the following structure:
+Configuration files are simple YAML files. An example of such a configuration
+file is the following:
 
-* `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.
+    ---
+    directories:
+      - lib
+
+    ignore_paths:
+      - lib/ruby-lint/definitions
+      - lib/ruby-lint/cli
+
+### requires
+
+The `requires` option can be used to specify a list of Ruby files that should
+be loaded before analysis is performed. The primary use case of this option is
+to load extra definitions that don't come with ruby-lint by default.
 
-A basic example looks lik the following:
+Example:
 
     ---
     requires:
-      - ruby-lint/definitions/core/string
+      - ruby-lint/definitions/rails
+
+By default this option is left empty.
+
+### report_levels
+
+The `report_levels` option can be used to specify a list of the enabled
+reporting levels. The following levels are currently available:
+
+* info
+* warning
+* error
+
+By default all of these are enabled.
+
+Example:
+
+    ---
     report_levels:
+      - warning
       - error
+
+### presenter
+
+The short, human readable name of the presenter to use for displaying the
+analysis results. The following presenters are currently available:
+
+* text
+* json
+
+The default presenter is `text`.
+
+Example:
+
+    ---
+    presenter: text
+
+### analysis_classes
+
+A list of the short, human readable names of the analysis classes to enable.
+The following analysis classes are currently available:
+
+* `argument_amount`
+* `pedantics`
+* `shadowing_variables`
+* `undefined_methods`
+* `undefined_variables`
+* `unused_variables`
+
+By default all of these are enabled.
+
+Example:
+
+    ---
     analysis_classes:
-      - undefined_methods
-      - undefined_variables
-    presenter: json
+      - argument_amount
+      - pedantics
+
+### directories
 
-If no value is given for a certain configuration option the default value(s)
-will be used instead.
+A list of directories to search in for externally defined constants. By
+default this is set to the current working directory which, for big projects,
+can slow things down.
+
+Example:
+
+    ---
+    directories:
+      - app
+      - lib
+
+### debug
+
+A boolean that indicates that debugging mode should be enabled or disabled, by
+default this is disabled.
+
+Example:
+
+    ---
+    debug: true
+
+### ignore_paths
+
+A list of patterns to apply to the `directories` option to filter out unwanted
+directories. For example, you could use this to search for files in the lib/
+directory but exclude lib/foo/bar:
+
+    ---
+    directories:
+      - lib
+
+    ignore_paths:
+      - lib/foo/bar
+
+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/analysis/shadowing_variables.rb

@@ -17,28 +17,22 @@ module RubyLint
       # @param [RubyLint::AST::Node] node
       #
       def on_block(node)
-        @outer_scope = current_scope
-        @in_block    = true
+        arguments = node.children[1].children
 
-        super
-      end
-
-      ##
-      # @param [RubyLint::AST::Node] node
-      #
-      def after_block(node)
-        @in_block    = false
-        @outer_scope = nil
+        arguments.each do |arg|
+          validate_argument(arg)
+        end
 
         super
       end
 
+      private
+
       ##
       # @param [RubyLint::AST::Node] node
       #
-      def on_arg(node)
-        if @in_block \
-        and @outer_scope.has_definition?(:lvar, node.name)
+      def validate_argument(node)
+        if current_scope.has_definition?(:lvar, node.name)
           warning("shadowing outer local variable #{node.name}", node)
         end
       end

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

@@ -57,8 +57,25 @@ module RubyLint
         end
       end
 
+      VirtualMachine::ARGUMENT_TYPES.each do |name|
+        define_method("on_#{name}") { |node| verify_argument(node) }
+      end
+
       private
 
+      ##
+      # Adds warnings for unused method arguments.
+      #
+      # @param [RubyLint::AST::Node] node
+      #
+      def verify_argument(node)
+        variable = current_scope.lookup(:lvar, node.name)
+
+        if add_warning?(variable)
+          warning("unused argument #{variable.name}", node)
+        end
+      end
+
       ##
       # @param [RubyLint::Definition::RubyObject] variable
       # @return [TrueClass|FalseClass]