ruby-lint 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26f5ebcb21cde063e50e4f8cc406f06632d686dd
-  data.tar.gz: b2496b982aae763c97b28b96570338e71f4b1ddc
+  metadata.gz: 0b345fdf9724a766a2684c0977f862cd7e408ce9
+  data.tar.gz: a6d56efba7d749595035211678c38c8a4323c94d
 SHA512:
-  metadata.gz: 15371f1e7dc8130470e8ef9a5ea60e178cbddd60d10394ba6f77f40de77e2c053be9ab3e4864fe5feba714e0a6765a12d30bcacf88cbd2b81edf5ec27f2e2785
-  data.tar.gz: e257a03edb2834d66484d9969c4bcfd31c2ff12bd4e63da105bd217643d9c26182b78a1d17d37314f9ce2435821072af2f0c2a8ee1950a34bf72da1017cc7010
+  metadata.gz: efe10626ab798f0d8069d5bceb3c39efb634c1afbf009490c0a01670ca2f049ddabbbf9f17f3f9a84058cb69fe14c9b42f3031da4d9211c1d8f075d3889596af
+  data.tar.gz: 14f98dd7fdf7875035021f5830da8574c0f4ab82bbbc7775a1476a26e56052dd4259ba0d67e9c8a1893e090bc5c4db3dc069e6f2ac2d0ddd4ceae06617872813

data/doc/changelog.md

@@ -5,6 +5,23 @@ 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).
 
+## 1.0.3 - 2013-12-23
+
+* `self` is now defined as a class and instance method to ensure that the right
+  data is used in these two scopes. See
+  `28f604ded884be2e43ef7ce93892a3cade4c93d7` for a more in depth explanation.
+* Block arguments passed to methods are now ignored by the `ArgumentAmount`
+  analysis class.
+* Configuration objects are now passed to analysis classes.
+* ruby-lint can now parse empty Ruby files! Previously this would crash the
+  parser.
+* Range now inherits from Enumerable.
+* The definitions for Array have been re-generated.
+* Fix for searching for Ruby files when no directories were given to the file
+  scanner class. Previously this would cause ruby-lint to start scanning from
+  `/`. See <https://github.com/YorickPeterse/ruby-lint/issues/83> for more
+  information.
+
 ## 1.0.2 - 2013-12-19
 
 This release changes the default file scanner directories from `$PWD` to

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

@@ -27,7 +27,7 @@ module RubyLint
 
         return unless method
 
-        given    = args ? args.length : 0
+        given    = argument_amount(args)
         min, max = argument_range(method)
 
         unless correct_argument_amount(min, max, given)
@@ -112,6 +112,14 @@ module RubyLint
 
         return min, max
       end
+
+      ##
+      # @param [RubyLint::AST::Node] nodes
+      # @return [Fixnum]
+      #
+      def argument_amount(nodes)
+        return nodes.reject { |n| n.type == :block_pass }.length
+      end
     end # ArgumentAmount
   end # Analysis
 end # RubyLint

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

@@ -10,8 +10,11 @@ module RubyLint
     # @!attribute [r] vm
     #  @return [RubyLint::VirtualMachine]
     #
+    # @!attribute [r] config
+    #  @return [RubyLint::Configuration]
+    #
     class Base < Iterator
-      attr_reader :report, :vm
+      attr_reader :report, :vm, :config
 
       ##
       # Array containing the callback names for which a new scope should be

data/lib/ruby-lint/definition/ruby_object.rb

@@ -83,7 +83,6 @@ module RubyLint
         :gvar,
         :instance_method,
         :ivar,
-        :keyword,
         :method
       ].freeze
 
@@ -107,7 +106,6 @@ module RubyLint
         :gvar,
         :instance_method,
         :ivar,
-        :keyword,
         :kwoptarg,
         :lvar,
         :member,
@@ -543,7 +541,7 @@ module RubyLint
           definition = add_child_definition(:const, name, &block)
         end
 
-        definition.add(:keyword, 'self', definition)
+        definition.define_self
 
         return definition
       end
@@ -610,6 +608,28 @@ module RubyLint
         self.parents.concat(definitions)
       end
 
+      ##
+      # Defines `self` on the current definition as both a class and instance
+      # method.
+      #
+      def define_self
+        if instance?
+          self_instance = self
+          self_class    = instance(:instance_type => :class)
+        else
+          self_instance = self.instance
+          self_class    = self
+        end
+
+        define_method('self') do |method|
+          method.returns(self_class)
+        end
+
+        define_instance_method('self') do |method|
+          method.returns(self_instance)
+        end
+      end
+
       ##
       # Returns a pretty formatted String that shows some info about the
       # current definition.

data/lib/ruby-lint/definition_builder/ruby_method.rb

@@ -51,17 +51,22 @@ module RubyLint
       # @return [RubyLint::Definition::RubyObject]
       #
       def new_definition(parents)
-        type = options[:type]
+        type          = options[:type]
+        instance_type = :instance
 
-        if has_receiver?
-          type = :method if options[:receiver].class?
+        # FIXME: setting the instance type of a method to a `class` is a bit of
+        # a hack to ensure that class methods cause lookups inside them to be
+        # performed on class level.
+        if has_receiver? and options[:receiver].class?
+          type          = :method
+          instance_type = :class
         end
 
         return Definition::RubyMethod.new(
           :name          => method_name,
           :parents       => parents,
           :type          => type,
-          :instance_type => :instance,
+          :instance_type => instance_type,
           :visibility    => options[:visibility],
           :line          => node.line,
           :column        => node.column,

data/lib/ruby-lint/definition_builder/ruby_module.rb

@@ -64,7 +64,7 @@ module RubyLint
           :file             => node.file
         )
 
-        definition.add(:keyword, 'self', definition)
+        definition.define_self
 
         return definition
       end

data/lib/ruby-lint/definitions/core/array.rb

@@ -1,8 +1,8 @@
 # This file was automatically generated, any manual changes will be lost the
 # next time this file is generated.
 #
-# Created:  2013-11-11 20:16:57 +0100
-# Platform: rbx 2.1.1
+# Created:  2013-12-23 09:38:51 +0100
+# Platform: rbx 2.2.1
 
 RubyLint::GlobalScope.definitions.define_constant('Array') do |klass|
   klass.inherits(RubyLint::GlobalScope.constant_proxy('Object'))
@@ -17,6 +17,8 @@ RubyLint::GlobalScope.definitions.define_constant('Array') do |klass|
     method.define_argument('obj')
   end
 
+  klass.define_method('yaml_tag_subclasses?')
+
   klass.define_instance_method('&') do |method|
     method.define_argument('other')
   end
@@ -217,6 +219,11 @@ RubyLint::GlobalScope.definitions.define_constant('Array') do |klass|
     method.define_optional_argument('obj')
   end
 
+  klass.define_instance_method('initialize') do |method|
+    method.define_optional_argument('size_or_array')
+    method.define_optional_argument('obj')
+  end
+
   klass.define_instance_method('inject') do |method|
     method.define_optional_argument('initial')
     method.define_optional_argument('sym')
@@ -396,6 +403,10 @@ RubyLint::GlobalScope.definitions.define_constant('Array') do |klass|
 
   klass.define_instance_method('start=')
 
+  klass.define_instance_method('taguri')
+
+  klass.define_instance_method('taguri=')
+
   klass.define_instance_method('take') do |method|
     method.define_argument('n')
   end
@@ -416,6 +427,10 @@ RubyLint::GlobalScope.definitions.define_constant('Array') do |klass|
 
   klass.define_instance_method('to_tuple')
 
+  klass.define_instance_method('to_yaml') do |method|
+    method.define_optional_argument('opts')
+  end
+
   klass.define_instance_method('total')
 
   klass.define_instance_method('total=')
@@ -442,6 +457,11 @@ RubyLint::GlobalScope.definitions.define_constant('Array') do |klass|
     method.define_argument('memo')
   end
 
+  klass.define_instance_method('yaml_initialize') do |method|
+    method.define_argument('tag')
+    method.define_argument('val')
+  end
+
   klass.define_instance_method('zip') do |method|
     method.define_rest_argument('others')
   end
@@ -536,6 +556,12 @@ RubyLint::GlobalScope.definitions.define_constant('Array::Enumerator') do |klass
     method.define_argument('obj')
   end
 
+  klass.define_instance_method('initialize') do |method|
+    method.define_optional_argument('receiver_or_size')
+    method.define_optional_argument('method_name')
+    method.define_rest_argument('method_args')
+  end
+
   klass.define_instance_method('inject') do |method|
     method.define_optional_argument('initial')
     method.define_optional_argument('sym')

data/lib/ruby-lint/definitions/core/range.rb

@@ -4,7 +4,10 @@
 # Platform: rbx 2.0.0.rc1
 #
 RubyLint::GlobalScope.definitions.define_constant('Range') do |klass|
-  klass.inherits(RubyLint::GlobalScope.constant_proxy('Object'))
+  klass.inherits(
+    RubyLint::GlobalScope.constant_proxy('Object'),
+    RubyLint::GlobalScope.constant_proxy('Enumerable')
+  )
 
   klass.define_method('__class_init__')
 
@@ -103,4 +106,4 @@ RubyLint::GlobalScope.definitions.define_constant('Range::SortedElement') do |kl
   klass.define_instance_method('value')
 end
 
-RubyLint::GlobalScope.definitions.lookup(:const, 'Range').deep_freeze
+RubyLint::GlobalScope.definitions.lookup(:const, 'Range').deep_freeze

data/lib/ruby-lint/file_scanner.rb

@@ -60,9 +60,7 @@ module RubyLint
     # @return [Array]
     #
     def scan(constant)
-      # Globbing all files at once and then comparing those results is faster
-      # than running a Dir.glob for every call to #scan.
-      @glob_cache ||= Dir.glob("#{directories.join(',')}/**/*.rb")
+      @glob_cache ||= directories.empty? ? [] : glob_ruby_files
 
       unless constant_paths_cached?(constant)
         build_constant_paths_cache(constant)
@@ -73,6 +71,13 @@ module RubyLint
 
     private
 
+    ##
+    # @return [Array]
+    #
+    def glob_ruby_files
+      return Dir.glob("#{directories.join(',')}/**/*.rb")
+    end
+
     ##
     # Searches all the files that could potentially define the given constant
     # and caches them.

data/lib/ruby-lint/parser.rb

@@ -39,13 +39,47 @@ module RubyLint
       buffer        = ::Parser::Source::Buffer.new(file, line)
       buffer.source = code
       ast, comments = internal_parser.parse_with_comments(buffer)
-      associator    = ::Parser::Source::Comment::Associator.new(ast, comments)
 
       internal_parser.reset
 
-      root = AST::Node.new(:root, [ast], :location => ast.location)
+      associated = associate_comments(ast, comments)
 
-      return root, associator.associate
+      return create_root_node(ast), associated
+    end
+
+    private
+
+    ##
+    # @param [RubyLint::AST::Node|NilClass] ast
+    # @return [RubyLint::AST::Node]
+    #
+    def create_root_node(ast)
+      if ast
+        children = [ast]
+        location = ast.location
+      # empty input.
+      else
+        children = []
+        location = nil
+      end
+
+      return AST::Node.new(:root, children, :location => location)
+    end
+
+    ##
+    # @param [RubyLint::AST::Node|NilClass] ast
+    # @param [Mixed] comments
+    # @return [Hash]
+    #
+    def associate_comments(ast, comments)
+      if ast
+        associator = ::Parser::Source::Comment::Associator.new(ast, comments)
+        associated = associator.associate
+      else
+        associated = {}
+      end
+
+      return associated
     end
   end # Parser
 end # RubyLint

data/lib/ruby-lint/runner.rb

@@ -175,7 +175,12 @@ module RubyLint
       end
 
       classes.each do |const|
-        instance = const.new(:vm => vm, :report => report)
+        instance = const.new(
+          :vm     => vm,
+          :report => report,
+          :config => configuration
+        )
+
         instance.iterate(ast)
       end
     end

data/lib/ruby-lint/version.rb

@@ -1,3 +1,3 @@
 module RubyLint
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end # RubyLint

data/lib/ruby-lint/virtual_machine.rb

@@ -443,7 +443,10 @@ module RubyLint
     # Pushes the value of `self` onto the current stack.
     #
     def on_self
-      push_value(current_scope.lookup(:keyword, 'self'))
+      scope  = current_scope
+      method = scope.lookup(scope.method_call_type, 'self')
+
+      push_value(method.return_value)
     end
 
     ##
@@ -522,7 +525,7 @@ module RubyLint
     def on_sclass(node)
       parent       = node.children[0]
       definition   = evaluate_node(parent)
-      @method_type = parent.self? ? :method : definition.method_call_type
+      @method_type = definition.method_call_type
 
       associate_node(node, definition)
 
@@ -748,7 +751,7 @@ Received: #{arguments.length}
         :instance_type => :instance
       )
 
-      definitions.add(:keyword, 'self', definitions)
+      definitions.define_self
 
       return definitions
     end

data/spec/ruby-lint/analysis/argument_amount_spec.rb

@@ -114,4 +114,18 @@ Person.new(10, 20)
     second.column.should  == 1
     second.message.should == 'wrong number of arguments (expected 1 but got 2)'
   end
+
+  example 'ignore block arguments' do
+    code = <<-CODE
+def example; end
+
+block = proc {}
+
+example(&block)
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::ArgumentAmount)
+
+    report.entries.empty?.should == true
+  end
 end

data/spec/ruby-lint/analysis/base_spec.rb

@@ -10,6 +10,14 @@ describe RubyLint::Analysis::Base do
     blk.should_not raise_error
   end
 
+  example 'allow config objects to be passed in' do
+    vm     = RubyLint::VirtualMachine.new
+    config = RubyLint::Configuration.new
+    base   = RubyLint::Analysis::Base.new(:vm => vm, :config => config)
+
+    base.config.should == config
+  end
+
   example 'enable analysis by default' do
     RubyLint::Analysis::Base.analyze?(double(:ast), double(:vm)).should == true
   end

data/spec/ruby-lint/definition/ruby_object_spec.rb

@@ -227,4 +227,38 @@ describe ruby_object do
       @method.callers.frozen?.should == true
     end
   end
+
+  context 'defining self' do
+    before do
+      @class    = ruby_object.new(:instance_type => :class)
+      @instance = ruby_object.new(:instance_type => :instance)
+
+      @class.define_self
+      @instance.define_self
+    end
+
+    example 'define instance level self for an instance' do
+      @instance.lookup(:instance_method, 'self')
+        .return_value
+        .should == @instance
+    end
+
+    example 'define class level self for an instance' do
+      @instance.lookup(:method, 'self')
+        .return_value
+        .parents
+        .should == [@instance]
+    end
+
+    example 'define instance level self for a class' do
+      @class.lookup(:instance_method, 'self')
+        .return_value
+        .parents
+        .should == [@class]
+    end
+
+    example 'define class level self for a class' do
+      @class.lookup(:method, 'self').return_value.should == @class
+    end
+  end
 end

data/spec/ruby-lint/file_scanner_spec.rb

@@ -61,4 +61,12 @@ describe RubyLint::FileScanner do
 
     scanner.scan('Example::User').empty?.should == true
   end
+
+  example 'do not scan when there are no directories' do
+    scanner = RubyLint::FileScanner.new([])
+
+    scanner.should_not receive(:glob_ruby_files)
+
+    scanner.scan('Foo')
+  end
 end

data/spec/ruby-lint/parser_spec.rb

@@ -28,4 +28,11 @@ end
     comment.text.should          == '# Hello world'
     comment.location.line.should == 1
   end
+
+  example 'parse an empty file' do
+    ast = parse('', false)
+
+    ast.type.should            == :root
+    ast.children.empty?.should == true
+  end
 end

data/spec/ruby-lint/virtual_machine/classes/sclass_spec.rb

@@ -20,7 +20,7 @@ end
         .should == true
     end
 
-    example 'define a class method using `class << self` in the global scope' do
+    example 'define an instance method using `class << self` in the global scope' do
       code = <<-CODE
 class << self
   def example
@@ -30,7 +30,9 @@ end
 
       defs = build_definitions(code)
 
-      defs.lookup(:method, 'example').is_a?(ruby_method).should == true
+      defs.lookup(:instance_method, 'example')
+        .is_a?(ruby_method)
+        .should == true
     end
 
     example 'define a class method using `class << String`' do
@@ -91,4 +93,4 @@ end
         .should == true
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lint
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Yorick Peterse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2013-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser