ruby-lint 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47ffb8ab07bc9826ae519c992503c8c51659d042
-  data.tar.gz: bf6192f271bcce9c7db189a62c6eae8771302d6f
+  metadata.gz: 5e5bbee286e1be1ba6f024458ccf916d7aaa6f6d
+  data.tar.gz: 62be929b8a02f3e9fc701d3a9d5cc979d69614d1
 SHA512:
-  metadata.gz: 1497ad0011b0afb381368bd0142cef4c89393a73dbbfd8d1586433c616e6fc5cb05b9309667d56fc79fb2df4e5e8d2b25a369483a358f99e538a3690557b3ab0
-  data.tar.gz: 3f96aff18f82c1d2814fd46b85f3d263323fb695638e29965fabcd7a046a8c27290e5d470da35247a08ab4df2298641fd7ef68f34310cb99da70bf57dc1f45ce
+  metadata.gz: 45574e47f9dcb4017f64f80fd89bc8d7b10bffdbb4648ed3cc42b09373e04e3dd413a3ed4e68e84736082a1c377f0d6ce61b6b8729ef848bb26f0f4b4ce5574e
+  data.tar.gz: ab7b40f9108af2d2d6879ccfddf806cff09f413f9fd6adc4d499d874934a266be36d6884eb9629761c8dbc86d14559171cc8ef3863e6a3faffedc4f94e2a2494

data/.travis.yml

@@ -1,5 +1,5 @@
 ---
-script: rake travis
+script: bundle exec rake travis
 
 rvm:
   - 1.9.3
@@ -18,3 +18,5 @@ notifications:
 branches:
   only:
     - master
+
+cache: bundler

data/MANIFEST

@@ -18,6 +18,7 @@ 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
+checksum/ruby-lint-1.0.0.gem.sha512
 checksum/ruby-lint-1.0.0.pre.preview1.gem.sha512
 doc/.gitkeep
 doc/DCO.md
@@ -382,6 +383,8 @@ spec/ruby-lint/definition_builder/primitive_spec.rb
 spec/ruby-lint/definition_builder/ruby_class_spec.rb
 spec/ruby-lint/definition_builder/ruby_method_spec.rb
 spec/ruby-lint/definition_builder/ruby_module_spec.rb
+spec/ruby-lint/definitions/argv_spec.rb
+spec/ruby-lint/definitions/env_spec.rb
 spec/ruby-lint/definitions/io_spec.rb
 spec/ruby-lint/docstring/mapping.rb
 spec/ruby-lint/docstring/parser_spec.rb
@@ -390,6 +393,7 @@ spec/ruby-lint/file_loader_spec.rb
 spec/ruby-lint/file_scanner_spec.rb
 spec/ruby-lint/inspector_spec.rb
 spec/ruby-lint/iterator_spec.rb
+spec/ruby-lint/method_call/assign_member_spec.rb
 spec/ruby-lint/nested_stack_spec.rb
 spec/ruby-lint/node_hash_spec.rb
 spec/ruby-lint/parser_spec.rb

data/README.md

@@ -38,21 +38,6 @@ so as following:
 
 This builds a new version of the Gem and saves it in the pkg/ directory.
 
-## Security
-
-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.
-
-The checksum of a file can be checked using the `sha512sum` command. For
-example:
-
-    $ sha512sum pkg/ruby-lint-0.9.1.gem
-    10a51f27c455e5743fff7fefe29512cff20116b805bec148e09d4bade1727e3beab7f7f9ee97b020d290773edcb7bd1685858ccad0bbd1a35cc0282c00c760c6  pkg/ruby-lint-0.9.1.gem
-
-In the past Gems were also signed using PGP, this is no longer the case.
-
 ## Usage
 
 Using ruby-lint from the CLI is very easy. To analyze a set of files
@@ -88,6 +73,50 @@ the following output:
     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)
 
+## Integration
+
+* Vim using [Syntastic][syntastic]
+* Emacs using [Flycheck][flycheck]
+
+## ruby-lint versus Rubocop
+
+A question commonly asked is what purpose ruby-lint serves compared to other
+tools such as [Rubocop][rubocop]. After all, upon first sight the two tools
+look pretty similar.
+
+The big difference between ruby-lint and Rubocop is that ruby-lint focuses
+primarily on technical problems such as the use of undefined methods/variables,
+unused variables/method arguments and more. Rubocop on the other hand focuses
+mostly on style related issues based on a community driven Ruby style guide.
+This means that it will for example warn you about methods written using
+camelCase and method bodies that are considered to be too long.
+
+Personally I have little interest in adding style related analysis as Rubocop
+already does that and in my opinion does a far better job at it. I also simply
+think it's too boring to write analysis like this. Having said that, ruby-lint
+has some basic style related analysis (e.g. the use of `BEGIN`) but this mostly
+serves as a simple example on how to write analysis code.
+
+In the end it depends on what your needs are. If you have a team that's having
+trouble following a consistent coding style then Rubocop is probably the right
+tool for the job. On the other hand, if you're trying to debug a nasty bug then
+ruby-lint will most likely be more useful.
+
+## Security
+
+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.
+
+The checksum of a file can be checked using the `sha512sum` command. For
+example:
+
+    $ sha512sum pkg/ruby-lint-0.9.1.gem
+    10a51f27c455e5743fff7fefe29512cff20116b805bec148e09d4bade1727e3beab7f7f9ee97b020d290773edcb7bd1685858ccad0bbd1a35cc0282c00c760c6  pkg/ruby-lint-0.9.1.gem
+
+In the past Gems were also signed using PGP, this is no longer the case.
+
 ## Documentation
 
 * {file:contributing Contributing}
@@ -100,3 +129,7 @@ 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.
+
+[syntastic]: https://github.com/scrooloose/syntastic
+[flycheck]: https://github.com/flycheck/flycheck/
+[rubocop]: https://github.com/bbatsov/rubocop

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

@@ -0,0 +1 @@
+d02899dc114e6065d64bb5e8aed5735876740209d30c5549511d88d8966b3c0794f0bb16ed33a430829b918eba56e2764f91a51c299da47393c6256cf3cc9f62

data/doc/changelog.md

@@ -5,6 +5,21 @@ 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.1 - 2013-12-15
+
+A small bugfix release that contains the following changes/fixes:
+
+* Anonymous splat arguments (`def foo(_); end`) are now ignored by the
+  `UnusedVariables` class.
+* Frozen definitions no longer have their members updated, see
+  <https://github.com/YorickPeterse/ruby-lint/issues/75> for more information.
+* ENV is now treated as an instance.
+* When re-assigning a variable the VM now updates the corresponding definition
+  instead of overwriting it. This was added to fix
+  <https://github.com/YorickPeterse/ruby-lint/issues/77>.
+* Global variables are stored in the global scope opposed to the current scope.
+* ARGV is now treated as an instance and extends Array.
+
 ## 1.0.0 - 2013-12-01
 
 The first stable release of ruby-lint. The 1.0 series will not introduce any

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

@@ -82,7 +82,15 @@ module RubyLint
       # @return [TrueClass|FalseClass]
       #
       def add_warning?(variable)
-        return variable && !variable.used? && variable.name[0] != '_'
+        return variable && !variable.used? && !ignore_variable?(variable.name)
+      end
+
+      ##
+      # @param [String] name
+      # @return [TrueClass|FalseClass]
+      #
+      def ignore_variable?(name)
+        return name[0] == '_' || name.empty?
       end
     end # UnusedVariables
   end # Analysis

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

@@ -4,6 +4,8 @@
 # Platform: rbx 2.0.0.rc1
 #
 RubyLint::GlobalScope.definitions.define_constant('ARGV') do |klass|
+  klass.inherits(RubyLint::GlobalScope.constant_proxy('Array'))
+  klass.instance!
 end
 
-RubyLint::GlobalScope.definitions.lookup(:const, 'ARGV').deep_freeze
+RubyLint::GlobalScope.definitions.lookup(:const, 'ARGV').deep_freeze

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

@@ -5,6 +5,8 @@
 #
 RubyLint::GlobalScope.definitions.define_constant('ENV') do |klass|
   klass.inherits(RubyLint::GlobalScope.constant_proxy('Hash'))
+
+  klass.instance!
 end
 
 RubyLint::GlobalScope.definitions.lookup(:const, 'ENV').deep_freeze

data/lib/ruby-lint/method_call/assign_member.rb

@@ -12,6 +12,8 @@ module RubyLint
       # @see Base#evaluate
       #
       def evaluate(arguments, context, block = nil)
+        return if context.frozen?
+
         *members, values = arguments
         member_values    = prepare_values(values)
 

data/lib/ruby-lint/version.rb

@@ -1,3 +1,3 @@
 module RubyLint
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end # RubyLint

data/lib/ruby-lint/virtual_machine.rb

@@ -141,6 +141,13 @@ module RubyLint
     #
     EXPORT_VARIABLES = [:ivar, :cvar, :const]
 
+    ##
+    # List of variable types that should be assigned in the global scope.
+    #
+    # @return [Array]
+    #
+    ASSIGN_GLOBAL = [:gvar]
+
     ##
     # The available method visibilities.
     #
@@ -874,28 +881,48 @@ Received: #{arguments.length}
     # @param [RubyLint::AST::Node] node
     #
     def assign_variable(type, name, value, node)
-      existing   = current_scope.lookup(type, name)
-      ref_amount = existing ? existing.reference_amount + 1 : 0
-      variable   = Definition::RubyObject.new(
-        :type             => type,
-        :name             => name,
-        :value            => value,
-        :instance_type    => :instance,
-        :reference_amount => ref_amount,
-        :line             => node.line,
-        :column           => node.column,
-        :file             => node.file
-      )
+      scope    = assignment_scope(type)
+      variable = scope.lookup(type, name)
+
+      # If there's already a variable we'll just update it.
+      if variable
+        variable.reference_amount += 1
+
+        # `value` is not for conditional assignments as those are handled
+        # manually.
+        variable.value = value if value
+      else
+        variable = Definition::RubyObject.new(
+          :type             => type,
+          :name             => name,
+          :value            => value,
+          :instance_type    => :instance,
+          :reference_amount => 0,
+          :line             => node.line,
+          :column           => node.column,
+          :file             => node.file
+        )
+      end
 
-      buffer_assignment_value(variable.value)
+      buffer_assignment_value(value)
 
       # Primarily used by #after_send to support variable assignments as method
       # call arguments.
       if value and !value_stack.empty?
-        value_stack.push(value)
+        value_stack.push(variable.value)
       end
 
-      add_variable(variable)
+      add_variable(variable, scope)
+    end
+
+    ##
+    # Determines the scope to use for a variable assignment.
+    #
+    # @param [Symbol] type
+    # @return [RubyLint::Definition::RubyObject]
+    #
+    def assignment_scope(type)
+      return ASSIGN_GLOBAL.include?(type) ? definitions : current_scope
     end
 
     ##

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

@@ -227,6 +227,17 @@ end
 
       report.entries.empty?.should == true
     end
+
+    example 'do not warn for unused anonymous splat arguments' do
+      code = <<-CODE
+def example(*)
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+
+      report.entries.empty?.should == true
+    end
   end
 
   context 'block arguments' do

data/spec/ruby-lint/definitions/argv_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'ruby-lint definitions' do
+  context 'ARGV' do
+    before do
+      @const = RubyLint::GlobalScope.global_constant('ARGV')
+    end
+
+    example 'treat ARGV as an instance' do
+      @const.instance?.should == true
+    end
+
+    example 'ARGV should be an Array' do
+      @const.has_definition?(:instance_method, 'each').should == true
+    end
+  end
+end

data/spec/ruby-lint/definitions/env_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'ruby-lint definitions' do
+  context 'ENV' do
+    example 'treat ENV as an instance' do
+      const = RubyLint::GlobalScope.global_constant('ENV')
+
+      const.instance?.should == true
+    end
+  end
+end

data/spec/ruby-lint/method_call/assign_member_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe RubyLint::MethodCall::AssignMember do
+  before do
+    @vm   = RubyLint::VirtualMachine.new
+    @node = s(:send,
+      s(:const, nil, :ENV), :[]=, s(:str, 'FOO'), s(:str, 'bar')
+    )
+
+    @method_call = RubyLint::MethodCall::AssignMember.new(@node, @vm)
+    @arguments   = [
+      ruby_object.new(:type => :str, :value => 'FOO'),
+      ruby_object.new(:type => :str, :value => 'bar')
+    ]
+
+    @context = ruby_object.new(:type => :hash)
+    @context.deep_freeze
+  end
+
+  example 'do not update members of frozen definitions' do
+    @method_call.evaluate(@arguments, @context)
+
+    @context.has_definition?(:member, 'FOO').should == false
+  end
+end

data/spec/ruby-lint/virtual_machine/assignments/variables_spec.rb

@@ -112,5 +112,19 @@ d = c
 
       value.type.should == :unknown
     end
+
+    example 'global variables should be assigned in the global scope' do
+      code = <<-CODE
+class Foo
+  def foo
+    $bar = 10
+  end
+end
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:gvar, '$bar').value.value.should == 10
+    end
   end
 end

data/spec/ruby-lint/virtual_machine/reference_amount_spec.rb

@@ -57,5 +57,25 @@ number = 20
 
       defs.lookup(:lvar, 'number').reference_amount.should == 1
     end
+
+    example 'track ivar references in parent scopes' do
+      code = <<-CODE
+def first
+  @number = 10
+end
+
+def second
+  @number = 20
+  @number
+end
+      CODE
+
+      defs   = build_definitions(code)
+      first  = defs.lookup(:instance_method, 'first').lookup(:ivar, '@number')
+      second = defs.lookup(:instance_method, 'second').lookup(:ivar, '@number')
+
+      first.reference_amount.should  == 2
+      second.reference_amount.should == 2
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Yorick Peterse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-01 00:00:00.000000000 Z
+date: 2013-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -211,6 +211,7 @@ files:
 - checksum/ruby-lint-0.0.5.gem.sha512
 - checksum/ruby-lint-0.9.0.gem.sha512
 - checksum/ruby-lint-0.9.1.gem.sha512
+- checksum/ruby-lint-1.0.0.gem.sha512
 - checksum/ruby-lint-1.0.0.pre.preview1.gem.sha512
 - doc/.gitkeep
 - doc/DCO.md
@@ -575,6 +576,8 @@ files:
 - spec/ruby-lint/definition_builder/ruby_class_spec.rb
 - spec/ruby-lint/definition_builder/ruby_method_spec.rb
 - spec/ruby-lint/definition_builder/ruby_module_spec.rb
+- spec/ruby-lint/definitions/argv_spec.rb
+- spec/ruby-lint/definitions/env_spec.rb
 - spec/ruby-lint/definitions/io_spec.rb
 - spec/ruby-lint/docstring/mapping.rb
 - spec/ruby-lint/docstring/parser_spec.rb
@@ -583,6 +586,7 @@ files:
 - spec/ruby-lint/file_scanner_spec.rb
 - spec/ruby-lint/inspector_spec.rb
 - spec/ruby-lint/iterator_spec.rb
+- spec/ruby-lint/method_call/assign_member_spec.rb
 - spec/ruby-lint/nested_stack_spec.rb
 - spec/ruby-lint/node_hash_spec.rb
 - spec/ruby-lint/parser_spec.rb
@@ -680,7 +684,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A linter and static code analysis tool for Ruby.