ruby-lint 0.0.1a

data/lib/rlint/token/parameters_token.rb

@@ -0,0 +1,99 @@
+module Rlint
+  module Token
+    ##
+    # Token class that contains details about the parameters of a method.
+    #
+    # The following attributes are used:
+    #
+    # * value: contains the required parameters (aliased as `#required()`)
+    # * optional: contains all optional parameters
+    # * rest: contains the rest parameter (if any)
+    # * more: contains all more parameters (parameters specified after a rest
+    #   parameter).
+    # * block: contains the block parameter (if any)
+    #
+    class ParametersToken < Token
+      ##
+      # An array of optional parameters.
+      #
+      # @return [Array]
+      #
+      attr_accessor :optional
+
+      ##
+      # The rest parameter (if any).
+      #
+      # @return [Rlint::Token::Token]
+      #
+      attr_accessor :rest
+
+      ##
+      # An array of more parameters.
+      #
+      # @return [Array]
+      #
+      attr_accessor :more
+
+      ##
+      # The block parameter (if any).
+      #
+      # @return [Rlint::Token::Token]
+      #
+      attr_accessor :block
+
+      ##
+      # @see Rlint::Token::Token#initialize
+      #
+      def initialize(*args)
+        @optional = []
+        @more     = []
+        @value    = []
+
+        super
+      end
+
+      ##
+      # @see Rlint::Token::Token#child_nodes
+      #
+      def child_nodes
+        nodes = super
+
+        if @optional
+          nodes << @optional
+        end
+
+        if @rest
+          nodes << [@rest]
+        end
+
+        if @more
+          nodes << @more
+        end
+
+        if @block
+          nodes << [@block]
+        end
+
+        return nodes.select { |array| array.length > 0 }
+      end
+
+      ##
+      # Executes the provided block for every parameter of the method. The
+      # order in which parameters are processed is the following:
+      #
+      # 1. Required parameters
+      # 2. Optional parameters
+      # 3. Rest parameters
+      # 4. "More" parameters
+      # 5. Block parameters
+      #
+      def each
+        params = [@value, @optional, @rest, @more, @block].select do |p|
+          !p.nil?
+        end
+
+        params.flatten.each { |param| yield param }
+      end
+    end # ParametersToken
+  end # Token
+end # Rlint

data/lib/rlint/token/regexp_token.rb

@@ -0,0 +1,15 @@
+module Rlint
+  module Token
+    ##
+    # Token class for storing information about regular expressions.
+    #
+    class RegexpToken < Token
+      ##
+      # Array containing the modes of the regular expression.
+      #
+      # @return [Array]
+      #
+      attr_accessor :modes
+    end # RegexpToken
+  end # Token
+end # Rlint

data/lib/rlint/token/statement_token.rb

@@ -0,0 +1,69 @@
+module Rlint
+  module Token
+    ##
+    # Token class for storing information about statements such as `return`
+    # statements and `elsif` statements.
+    #
+    # @since 2012-08-08
+    #
+    class StatementToken < Token
+      ##
+      # The value of the statement in case of `if` and `elsif` statements.
+      #
+      # @return [Rlint::Token::Token|Array]
+      #
+      attr_accessor :statement
+
+      ##
+      # The content of the `else` statement.
+      #
+      # @return [Rlint::Token::StatementToken]
+      #
+      attr_accessor :else
+
+      ##
+      # Array containing the `elsif` statement in their original order.
+      #
+      # @return [Array]
+      #
+      attr_accessor :elsif
+
+      ##
+      # @see Rlint::Token::Token#initialize
+      #
+      def initialize(*args)
+        @type  = :statement
+        @elsif = []
+
+        super
+      end
+
+      ##
+      # @see Rlint::Token::Token#child_nodes
+      #
+      def child_nodes
+        nodes = []
+
+        if @statement
+          if @statement.is_a?(Array)
+            nodes << @statement.flatten
+          else
+            nodes << [@statement]
+          end
+        end
+
+        nodes += super
+
+        if @elsif
+          nodes << @elsif
+        end
+
+        if @else
+          nodes << [@else]
+        end
+
+        return nodes.select { |array| array.length > 0 }
+      end
+    end # StatementToken
+  end # Token
+end # Rlint

data/lib/rlint/token/token.rb

@@ -0,0 +1,162 @@
+module Rlint
+  module Token
+    ##
+    # Generic token class used for data that doesn't require its own specific
+    # token.
+    #
+    # @since 2012-07-29
+    #
+    class Token
+      ##
+      # Hash containing various Ripper types and the Rlint types to use
+      # instead.
+      #
+      # @since  2012-07-29
+      # @return [Hash]
+      #
+      TYPE_MAPPING = {
+        :ident           => :identifier,
+        :gvar            => :global_variable,
+        :ivar            => :instance_variable,
+        :cvar            => :class_variable,
+        :const           => :constant,
+        :int             => :integer,
+        :float           => :float,
+        :tstring_content => :string,
+        :label           => :symbol,
+        :kw              => :keyword
+      }
+
+      ##
+      # The name of the token. For example, when the token is an identifier
+      # this value is set to `:ident`.
+      #
+      # @since  2012-07-29
+      # @return [String]
+      #
+      attr_accessor :name
+
+      ##
+      # The value of the token. For example, if the token is a variable this
+      # attribute is set to the token for the variable's value.
+      #
+      # @since  2012-07-29
+      # @return [Rlint::Token::Token]
+      #
+      attr_accessor :value
+
+      ##
+      # The type of token. For example, if the token is a local variable then
+      # this value is set to `:local_variable`.
+      #
+      # @since  2012-07-29
+      # @return [Symbol]
+      #
+      attr_reader :type
+
+      ##
+      # The line number on which the token was defined.
+      #
+      # @since  2012-07-29
+      # @return [Fixnum|Bignum]
+      #
+      attr_accessor :line
+
+      ##
+      # The column number on which the token was defined.
+      #
+      # @since  2012-07-29
+      # @return [Fixnum|Bignum]
+      #
+      attr_accessor :column
+
+      ##
+      # The code of the current line.
+      #
+      # @return [String]
+      #
+      attr_accessor :code
+
+      ##
+      # The key, index or object member that was accessed from the token.
+      #
+      # @since  2012-08-24
+      # @return [Array]
+      #
+      attr_accessor :key
+
+      ##
+      # The name of the event to call when iterating over an AST. Set to the
+      # value of {Rlint::Token::Token#type} unless specified otherwise.
+      #
+      # @return [Symbol]
+      #
+      attr_reader :event
+
+      ##
+      # Creates a new instance of the token and sets various instance variables
+      # based on the specified hash.
+      #
+      # @since 2012-07-29
+      # @param [Hash] options A hash containing various instance variables to
+      #  set and their values. For a variable to be set it requires a
+      #  corresponding public getter mehtod to be set.
+      #
+      def initialize(options = {})
+        options.each do |key, value|
+          if respond_to?(key)
+            instance_variable_set("@#{key}", value)
+          end
+        end
+
+        if TYPE_MAPPING[@type]
+          @type = TYPE_MAPPING[@type]
+        end
+
+        @event = @type
+
+        # Remove NilClass instances from the `value` array, these serve no
+        # useful purpose.
+        @value.select! { |t| !t.nil? } if @value.is_a?(Array)
+      end
+
+      ##
+      # Sets the type of the token and updates the event name accordingly.
+      #
+      # @param [Symbol] type The new type of the token.
+      #
+      def type=(type)
+        if TYPE_MAPPING[type]
+          type = TYPE_MAPPING[type]
+        end
+
+        @type  = type
+        @event = type
+      end
+
+      ##
+      # Returns an array containing all the child nodes that can be iterated by
+      # {Rlint::Iterator}.
+      #
+      # @return [Array]
+      #
+      def child_nodes
+        nodes = []
+
+        if @value
+          if @value.is_a?(Array)
+            nodes << @value
+          else
+            nodes << [@value]
+          end
+        end
+
+        if @key
+          nodes << @key
+        end
+
+        return nodes
+      end
+    end # Token
+  end # Token
+end # Rlint

data/lib/rlint/token/variable_token.rb

@@ -0,0 +1,18 @@
+module Rlint
+  module Token
+    ##
+    # Token class used for storing information about variable references.
+    #
+    class VariableToken < Token
+      ##
+      # @see Rlint::Token::Token#initialize
+      #
+      def initialize(*args)
+        super
+
+        @type  = :local_variable if @type == :identifier
+        @event = @type
+      end
+    end # VariableToken
+  end # Token
+end # Rlint

data/lib/rlint/version.rb

@@ -0,0 +1,3 @@
+module Rlint
+  VERSION = '0.0.1a'
+end # Rlint

data/lib/rlint.rb

@@ -0,0 +1,36 @@
+require 'ripper'
+
+unless $:.include?(File.expand_path('../', __FILE__))
+  $:.unshift(File.expand_path('../', __FILE__))
+end
+
+require 'rlint/version'
+require 'rlint/parser'
+require 'rlint/token/token'
+require 'rlint/token/variable_token'
+require 'rlint/token/statement_token'
+require 'rlint/token/begin_rescue_token'
+require 'rlint/token/method_definition_token'
+require 'rlint/token/parameters_token'
+require 'rlint/token/method_token'
+require 'rlint/token/block_token'
+require 'rlint/token/assignment_token'
+require 'rlint/token/case_token'
+require 'rlint/token/regexp_token'
+require 'rlint/token/class_token'
+require 'rlint/parser_error'
+require 'rlint/iterator'
+require 'rlint/callback'
+require 'rlint/report'
+require 'rlint/definition'
+require 'rlint/constant_importer'
+require 'rlint/formatter/text'
+require 'rlint/helper/scoping'
+require 'rlint/helper/definition_resolver'
+require 'rlint/analyze/coding_style'
+require 'rlint/analyze/definitions'
+require 'rlint/analyze/unused_variables'
+require 'rlint/analyze/undefined_variables'
+require 'rlint/analyze/shadowing_variables'
+require 'rlint/analyze/method_validation'
+require 'rlint/options'

data/ruby-lint.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/rlint/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby-lint'
+  s.version     = Rlint::VERSION
+  s.date        = '2012-11-12'
+  s.authors     = ['Yorick Peterse']
+  s.email       = 'yorickpeterse@gmail.com'
+  s.summary     = 'Static code analysis tool and linter for Ruby'
+  s.homepage    = 'https://github.com/yorickpeterse/rlint/'
+  s.description = s.summary
+  s.executables = ['rlint']
+
+  s.files = File.read(File.expand_path('../MANIFEST', __FILE__)).split("\n")
+
+  s.has_rdoc              = 'yard'
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_development_dependency('rake', ['>= 0.9.2.2'])
+  s.add_development_dependency('redcarpet', ['>= 2.1.1'])
+  s.add_development_dependency('bacon', ['>= 1.1.0'])
+  s.add_development_dependency('yard', ['>= 0.8.2.1'])
+end

data/spec/benchmarks/memory.rb

@@ -0,0 +1,52 @@
+require File.expand_path('../../../lib/rlint', __FILE__)
+
+# This file benchmarks the memory increase after parsing a particular Rlint
+# file and performing code analysis on the resulting tokens.
+#
+# For each iteration (the amount is set in the "AMOUNT" environment variable)
+# the increase is measured. Once finished the average increase is displayed as
+# well as the total memory usage at the end of the script.
+
+def memory_usage
+  return `ps -o rss= #{Process.pid}`.strip.to_i
+end
+
+def benchmark_memory
+  start_memory = memory_usage
+
+  yield
+
+  return memory_usage - start_memory
+end
+
+memory_kb = 0.0
+amount    = ENV['AMOUNT'] ? ENV['AMOUNT'].to_i : 100
+path      = File.expand_path('../../../lib/rlint/parser.rb', __FILE__)
+code      = File.read(path, File.size(path))
+
+amount.times do
+  memory_kb += benchmark_memory do
+    tokens   = Rlint::Parser.new(code, path).parse
+    iterator = Rlint::Iterator.new
+
+    iterator.bind(Rlint::Analyze::CodingStyle)
+    iterator.bind(Rlint::Analyze::Definitions)
+
+    iterator.run(tokens)
+  end
+end
+
+memory_kb     /= amount
+memory_mb      = memory_kb / 1024
+memory_end_kb  = memory_usage
+memory_end_mb  = memory_end_kb / 1024
+
+puts "Average memory increase for each iteration (total of #{amount})"
+puts
+puts "Kilobytes: #{memory_kb.round}"
+puts "Megabytes: #{memory_mb.round(2)}"
+puts
+puts 'End memory usage'
+puts
+puts "Kilobytes: #{memory_end_kb.round}"
+puts "Megabytes: #{memory_end_mb.round(2)}"