ruby-lint 0.0.2 → 0.0.3

data/lib/ruby-lint/formatter/text.rb

@@ -1,54 +0,0 @@
-module RubyLint
-  module Formatter
-    ##
-    # {RubyLint::Formatter::Text} is a formatter class that formats a report in a
-    # format similar to the one used by Ruby when validating a Ruby file using
-    # the `ruby` executable. An example of this format is the following:
-    #
-    #     b.rb: error: line 1, column 1: test error
-    #     b.rb: info: line 3, column 1: test info b.rb
-    #
-    # Basic usage of this formatter is as following:
-    #
-    #     report    = RubyLint::Report.new
-    #     formatter = RubyLint::Formatter::Text.new
-    #
-    #     # Add some data to the report.
-    #     # ...
-    #
-    #     puts formatter.format(report)
-    #
-    class Text
-      ##
-      # A short description of the class.
-      #
-      # @return [String]
-      #
-      DESCRIPTION = 'Formats a report in a human readable format.'
-
-      ##
-      # Formats the specified report.
-      #
-      # @param  [RubyLint::Report] report The report to format.
-      # @return [String]
-      #
-      def format(report)
-        lines = []
-
-        report.messages.sort.each do |level, messages|
-          messages.each do |message|
-            lines << '%s: %s: line %s, column %s: %s' % [
-              report.file,
-              level,
-              message[:line],
-              message[:column],
-              message[:message]
-            ]
-          end
-        end
-
-        return lines.join("\n")
-      end
-    end # Text
-  end # Formatter
-end # RubyLint

data/lib/ruby-lint/helper/definition_resolver.rb

@@ -1,143 +0,0 @@
-module RubyLint
-  module Helper
-    ##
-    # {RubyLint::Helper::DefinitionResolver} is a helper module that can be used
-    # to work with scoping information similar to {RubyLint::Helper::Scoping}.
-    #
-    # This module depends on {RubyLint::Helper::Scoping} and will include it
-    # automatically.
-    #
-    # ## Methods
-    #
-    # This module defines a set of methods that are called before and after a
-    # method, class or module is defined. These methods take care of retrieving
-    # the scope for each definition.
-    #
-    # These methods will also call two special callback methods that make it
-    # easier to run code whenever the scope changes:
-    #
-    # * `on_new_scope`: called when a new scope has been set.
-    # * `after_new_scope`: called when the code has reached the end of the
-    #   current scope.
-    #
-    # Using these methods classes including this module don't have to redefine
-    # methods such as `on_class` (unless explicitly needed of course). Both of
-    # these methods are called *after* the current scope has been updated.
-    #
-    module DefinitionResolver
-      include Scoping
-
-      ##
-      # Called before processing all the tokens.
-      #
-      def on_start
-        call_method(:on_new_scope)
-      end
-
-      ##
-      # Called after all the tokens have been processed.
-      #
-      def on_finish
-        call_method(:after_new_scope)
-      end
-
-      ##
-      # Sets the scope for the current method definition.
-      #
-      # @param [RubyLint::Token::MethodDefinitionToken] token
-      #
-      def on_method_definition(token)
-        @scopes << scope.lookup(
-          token.receiver ? :method : :instance_method,
-          token.name
-        )
-
-        @call_types << :instance_method
-
-        call_method(:on_new_scope)
-      end
-
-      ##
-      # Resets the scope back to the one used before the method definition.
-      #
-      # @see RubyLint::Helper::DefinitionResolver#on_method_definition
-      #
-      def after_method_definition(token)
-        @scopes.pop
-        @call_types.pop
-
-        call_method(:after_new_scope)
-      end
-
-      ##
-      # Sets the scope for the current class.
-      #
-      # @param [RubyLint::Token::ClassToken] token
-      #
-      def on_class(token)
-        name = token.name.join('::')
-
-        @scopes     << scope.lookup(:constant, name)
-        @namespace  << name
-        @call_types << :method
-
-        call_method(:on_new_scope)
-      end
-
-      ##
-      # Resets the scope back to the one used before the class definition.
-      #
-      # @see RubyLint::Helper::DefinitionResolver#on_class
-      #
-      def after_class(token)
-        @scopes.pop
-        @namespace.pop
-        @call_types.pop
-
-        call_method(:after_new_scope)
-      end
-
-      ##
-      # Sets the scope for the current module.
-      #
-      # @param [RubyLint::Token::Token] token
-      #
-      def on_module(token)
-        name = token.name.join('::')
-
-        @scopes     << scope.lookup(:constant, name)
-        @namespace  << name
-        @call_types << :method
-
-        call_method(:on_new_scope)
-      end
-
-      ##
-      # Resets the scope back to the one used before the module definition.
-      #
-      # @see RubyLint::Helper::DefinitionResolver#on_module
-      #
-      def after_module(token)
-        @scopes.pop
-        @namespace.pop
-        @call_types.pop
-
-        call_method(:after_new_scope)
-      end
-
-      private
-
-      ##
-      # Calls the specified method if it exists.
-      #
-      # @param [String|Symbol] method The name of the method to call.
-      # @param [Array] args Array of arguments to pass to the method that is
-      #  being called.
-      # @return [Mixed]
-      #
-      def call_method(method, *args)
-        return send(method, *args) if respond_to?(method)
-      end
-    end # DefinitionResolver
-  end # Helper
-end # RubyLint

data/lib/ruby-lint/helper/scoping.rb

@@ -1,138 +0,0 @@
-module RubyLint
-  module Helper
-    ##
-    # {RubyLint::Helper::Scoping} is a helper module that can be used to more
-    # easily access scoping related information in subclasses of
-    # {RubyLint::Callback}.
-    #
-    # Note that unlike {RubyLint::Helper::DefinitionResolver} this method does not
-    # automatically update the `@scopes` array mentioned below, it merely
-    # creates the required variables and provides a few helper methods.
-    #
-    # ## Methods
-    #
-    # This module provides two methods:
-    #
-    # * scope: a method that can be used to retrieve the current
-    #   scope/definition.
-    # * resolve_definition: a method that can be used to retrieve the
-    #   scope/definition for the last constant in a constant path.
-    #
-    # ## Variables
-    #
-    # The following instance variables are created upon initializing a class
-    # that includes this module:
-    #
-    # * `@scopes`: an array that should be updated with instance of
-    #   {RubyLint::Definition} based on the current scope.
-    # * `@namespace`: array containing the constant names for the current
-    #   namespace.
-    #
-    # The following keys are set in the `@storage` instance variable:
-    #
-    # * `:scope`: an instance of {RubyLint::Definition} that will contain the
-    #   definition list of the current block of code that's being analyzed.
-    #
-    module Scoping
-      ##
-      # @see RubyLint::Callback#initialize
-      #
-      def initialize(*args)
-        super
-
-        @scopes     = []
-        @namespace  = []
-        @call_types = []
-
-        unless @storage[:scope].is_a?(Definition)
-          @storage[:scope] = Definition.new(nil, :lazy => true, :kernel => true)
-        end
-      end
-
-      private
-
-      ##
-      # Returns the scope/definition for the last segment in the specified
-      # constant path.
-      #
-      # @param  [Array] path The constant path.
-      # @return [RubyLint::Definition]
-      #
-      def resolve_definition(path)
-        current = scope
-
-        path.each do |segment|
-          found   = current.lookup(:constant, segment)
-          current = found if found
-        end
-
-        return current
-      end
-
-      ##
-      # Checks if the specified token's name is a valid constant path.
-      #
-      # @param  [RubyLint::Token::VariableToken] token The token to validate.
-      # @return [TrueClass|FalseClass]
-      #
-      def valid_constant_path?(token)
-        current = scope
-
-        token.name.each do |segment|
-          found = current.lookup(:constant, segment)
-
-          if found and token.line > found.token.line
-            current = found
-          else
-            return false
-          end
-        end
-
-        return true
-      end
-
-      ##
-      # Checks if the specified type and token result in a valid
-      # {RubyLint::Definition} instance.
-      #
-      # @param [#to_sym] type The type of data to look up.
-      # @param [RubyLint::Token::VariableToken] token The token containing details
-      #  about the variable.
-      # @param [RubyLint::Definition] scope The scope to use for looking up the
-      #  data.
-      # @return [TrueClass|FalseClass]
-      #
-      def definition_exists?(type, token, scope = scope)
-        found    = scope.lookup(type, token.name)
-        has_line = found.respond_to?(:token) \
-          && !found.token.nil? \
-          && !found.token.line.nil?
-
-        if !found or (has_line and found.token.line > token.line)
-          return false
-        else
-          return true
-        end
-      end
-
-      ##
-      # Returns the call type to use for method calls.
-      #
-      # @return [Symbol]
-      #
-      def call_type
-        return !@call_types.empty? ? @call_types[-1] : :instance_method
-      end
-
-      ##
-      # Returns the current scope. This method is primarily used to make the
-      # code in this class a bit more pleasant to read.
-      #
-      # @return [RubyLint::Definition]
-      #
-      def scope
-        return !@scopes.empty? ? @scopes[-1] : @storage[:scope]
-      end
-    end # Scoping
-  end # Helper
-end # RubyLint

data/lib/ruby-lint/options.rb

@@ -1,58 +0,0 @@
-module RubyLint
-  ##
-  # {RubyLint::Options} is a class that can be used to configure various parts of
-  # RubyLint such as what formatter to use, the reporting levels, etc.
-  #
-  class Options
-    ##
-    # Array containing the analyzer classes that are always enabled. The order
-    # of these classes is preserved.
-    #
-    # @return [Array]
-    #
-    REQUIRED_ANALYZERS = [Analyze::Definitions]
-
-    ##
-    # The reporting formatter to use, set to {RubyLint::Formatter::Text} by
-    # default.
-    #
-    # @return [RubyLint::Formatter]
-    #
-    attr_accessor :formatter
-
-    ##
-    # The enabled reporting levels. See {RubyLint::Report#levels} and
-    # {RubyLint::Report#initialize} for more information.
-    #
-    # @return [Array]
-    #
-    attr_accessor :levels
-
-    ##
-    # Array of classes to use for analyzing code. By default all the classes
-    # defined under {RubyLint::Analyze} are used.
-    #
-    # @return [Array]
-    #
-    attr_accessor :analyzers
-
-    ##
-    # Sets the default values for various options.
-    #
-    def initialize
-      @formatter = Formatter::Text
-      @levels    = Report::DEFAULT_LEVELS
-      @analyzers = REQUIRED_ANALYZERS.dup
-
-      Analyze.constants.each do |c|
-        const = Analyze.const_get(c)
-
-        @analyzers << const unless @analyzers.include?(const)
-      end
-    end
-  end # Options
-
-  @options = Options.new
-
-  class << self; attr_reader :options; end
-end # RubyLint

data/lib/ruby-lint/token/assignment_token.rb

@@ -1,35 +0,0 @@
-module RubyLint
-  module Token
-    ##
-    # Token class that is used whenever a value is assigned to a variable,
-    # object attribute or similar.
-    #
-    class AssignmentToken < Token
-      ##
-      # The object receiver, set when a value is assigned to an object
-      # attribute.
-      #
-      # @return [RubyLint::Token::Token]
-      #
-      attr_accessor :receiver
-
-      ##
-      # Symbol containing the operator that was used to separate the receiver
-      # and attribute name.
-      #
-      # @return [Symbol]
-      #
-      attr_accessor :operator
-
-      ##
-      # @see RubyLint::Token::Token#initialize
-      #
-      def initialize(*args)
-        super
-
-        @type  = :local_variable if @type == :identifier
-        @event = :assignment
-      end
-    end # AssignmentToken
-  end # Token
-end # RubyLint

data/lib/ruby-lint/token/begin_rescue_token.rb

@@ -1,57 +0,0 @@
-module RubyLint
-  module Token
-    ##
-    # Token class used for storing information about begin/rescue/ensure
-    # statements.
-    #
-    class BeginRescueToken < Token
-      ##
-      # Array of rescue statements. Each item is an instance of
-      # {RubyLint::Token::StatementToken}.
-      #
-      # @return [Array]
-      #
-      attr_accessor :rescue
-
-      ##
-      # Attribute containing details about the ensure statement.
-      #
-      # @return [RubyLint::Token::StatementToken]
-      #
-      attr_accessor :ensure
-
-      ##
-      # Attribute containing details about the else statement.
-      #
-      # @return [RubyLint::Token::StatementToken]
-      #
-      attr_accessor :else
-
-      ##
-      # @see RubyLint::Token#initialize
-      #
-      def initialize(*args)
-        @type = :begin_rescue
-
-        super
-      end
-
-      ##
-      # @see RubyLint::Token::Token#child_nodes
-      #
-      def child_nodes
-        nodes = [@rescue]
-
-        if @ensure
-          nodes << [@ensure]
-        end
-
-        if @else
-          nodes << [@else]
-        end
-
-        return super + nodes
-      end
-    end # BeginRescueToken
-  end # Token
-end # RubyLint