ruby-lint 0.0.4 → 0.0.5

data/lib/ruby-lint/ast/node.rb

@@ -34,6 +34,16 @@ module RubyLint
       def name
         return const? ? children[-1].to_s : children[0].to_s
       end
+
+      ##
+      # Similar to `#inspect` but formats the value so that it fits on a single
+      # line.
+      #
+      # @return [String]
+      #
+      def inspect_oneline
+        return inspect.gsub(/\s*\n\s*/, ' ')
+      end
     end # Node
   end # AST
 end # RubyLint

data/lib/ruby-lint/cli/analyze.rb

@@ -1,6 +1,6 @@
 RubyLint::CLI.options.command :analyze do
   banner      'Usage: ruby-lint analyze [FILES] [OPTIONS]'
-  description 'Analysiss the source code of Ruby files'
+  description 'Analyze the source code of Ruby files'
 
   separator <<-EOF.chomp
 
@@ -15,8 +15,8 @@ Configuration:
   When this command is executed it will try to load a configuration file in
   one of the following two locations (in this order):
 
-  * $PWD/ruby-lint.rb
-  * ~/.ruby-lint.rb
+  * $PWD/ruby-lint.yml
+  * ~/.ruby-lint.yml
 
   Only the first existing configuration file is loaded.
 
@@ -58,6 +58,8 @@ Examples:
   on :l=, :levels=, 'The reporting levels to enable', :as => Array
   on :p=, :presenter=, 'The presenter to use', :as => String
   on :a=, :analysis=, 'The analysis classes to use', :as => Array
+  on :b, :benchmark, 'Enables benchmarking mode'
+  on :d, :debug, 'Displays debugging output in STDERR'
 
   ##
   # Returns an Array containing the file paths that exist. If a non existing
@@ -89,7 +91,8 @@ Examples:
     return {
       :levels    => :report_levels=,
       :presenter => :presenter=,
-      :analysis  => :analysis_classes=
+      :analysis  => :analysis_classes=,
+      :debug     => :debug=
     }
   end
 
@@ -110,6 +113,7 @@ Examples:
   run do |opts, args|
     abort 'You must specify at least one file to analyze' if args.empty?
 
+    start_time    = Time.now.to_f
     files         = extract_files(args)
     configuration = RubyLint::Configuration.load_from_file
 
@@ -121,5 +125,19 @@ Examples:
     output = runner.analyze(files)
 
     output_destination.puts output unless output.empty?
+
+    exec_time = Time.now.to_f - start_time
+
+    if opts[:benchmark]
+      memory_kb = `ps -o rss= #{Process.pid}`.strip.to_f
+      memory_mb = memory_kb / 1024
+
+      output_destination.puts unless output.empty?
+
+      output_destination.puts "Execution time: #{exec_time.round(2)} seconds"
+
+      output_destination.puts "Memory usage: #{memory_mb.round(2)} MB " \
+        "(#{memory_kb.round(2)} KB)"
+    end
   end # run do |opts, args|
 end # RubyLint::CLI.options.command

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

@@ -18,6 +18,8 @@ module RubyLint
     #
     OPTIONS_HEADER = "\nOptions:\n"
 
+    #:nocov:
+
     ##
     # Returns a String containing a list of names as registered in
     # {RubyLint::Configuration.names}.
@@ -33,8 +35,10 @@ module RubyLint
     ##
     # Starts the CLI.
     #
-    def self.run
-      options.parse
+    # @param [Array] argv
+    #
+    def self.run(argv = ARGV)
+      options.parse(argv)
     end
 
     ##
@@ -93,5 +97,7 @@ module RubyLint
     def self.version_information
       return "ruby-lint v#{VERSION} on #{RUBY_DESCRIPTION}"
     end
+
+    #:nocov:
   end # CLI
 end # RubyLint

data/lib/ruby-lint/configuration.rb

@@ -6,13 +6,25 @@ module RubyLint
   #
   # @!attribute [r] analysis_classes
   #  @return [Array]
+  #
   # @!attribute [r] report_levels
   #  @return [Array]
+  #
   # @!attribute [r] presenter
   #  @return [Class]
   #
+  # @!attribute [r] directories
+  #  @return [Array]
+  #
+  # @!attribute [rw] debug
+  #  @return [TrueClass|FalseClass]
+  #
+  # @!attribute [rw] ignore_paths
+  #  @return [Array]
+  #
   class Configuration
-    attr_reader :analysis_classes, :report_levels, :presenter
+    attr_reader :analysis_classes, :report_levels, :presenter, :directories
+    attr_accessor :debug, :ignore_paths
 
     ##
     # Returns an Array of locations from which to load configuration files.
@@ -74,6 +86,8 @@ module RubyLint
     # @param [Hash] options
     #
     def initialize(options = {})
+      @debug = false
+
       options.each do |key, value|
         setter = "#{key}="
 
@@ -85,6 +99,8 @@ module RubyLint
       @analysis_classes ||= default_analysis_classes
       @report_levels    ||= default_report_levels
       @presenter        ||= default_presenter
+      @directories      ||= default_directories
+      @ignore_paths     ||= []
     end
 
     ##
@@ -97,7 +113,7 @@ module RubyLint
     end
 
     ##
-    # Returns a list of the enabled report levels.
+    # Sets a list of the enabled report levels.
     #
     # @param [Array] given The report levels specified by the user.
     # @return [Array]
@@ -118,7 +134,7 @@ module RubyLint
     end
 
     ##
-    # Returns the presenter to use.
+    # Sets the presenter to use.
     #
     # @param [String] name The friendly name of the presenter as set by the
     #  user.
@@ -136,7 +152,7 @@ module RubyLint
     end
 
     ##
-    # Returns a collection of the analysis constants to use.
+    # Sets a collection of the analysis constants to use.
     #
     # @param [Array] names The analysis names as given by the user.
     # @return [Array]
@@ -156,6 +172,22 @@ module RubyLint
       @analysis_classes = classes
     end
 
+    ##
+    # Sets the directories to scan for external Ruby files using
+    # {RubyLint::FileLoader}.
+    #
+    # @param [Array] directories
+    #
+    def directories=(directories)
+      directories.each do |dir|
+        unless File.directory?(dir)
+          raise ArgumentError, "The directory #{dir} does not exist"
+        end
+      end
+
+      @directories = directories
+    end
+
     ##
     # Returns the default (= all) analysis classes to use.
     #
@@ -178,5 +210,12 @@ module RubyLint
     def default_presenter
       return RubyLint::Presenter::Text
     end
+
+    ##
+    # @return [Array]
+    #
+    def default_directories
+      return [Dir.pwd]
+    end
   end # Configuration
 end # RubyLint

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

@@ -13,7 +13,7 @@ module RubyLint
     # @!attribute [r] proxy_name
     #  @return [String]
     #
-    # @!attribut [r] proxy_definition
+    # @!attribute [r] proxy_definition
     #  @return [RubyLint::Definition::RubyObject]
     #
     class ConstantProxy
@@ -41,6 +41,15 @@ module RubyLint
         end
       end
 
+      ##
+      # @return [String]
+      #
+      def inspect
+        lookup_proxy_definition
+
+        return proxy_definition ? proxy_definition.inspect : super
+      end
+
       private
 
       ##

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

@@ -9,40 +9,45 @@ module RubyLint
     # @!attribute [r] visibility
     #  @return [Symbol] The method visibility such as `:public`.
     #
-    # @!attribute [r] arguments
-    #  @return [Array] The required/specified arguments of a method definition
-    #   or method call.
-    #
-    # @!attribute [r] optional_arguments
-    #  @return [Array] Array containing the optional arguments of a method
-    #   definition.
-    #
-    # @!attribute [r] rest_argument
-    #  @return [RubyLint::Definition::RubyObject] The rest argument of a
-    #   method definition.
-    #
-    # @!attribute [r] block_argument
-    #  @return [RubyLint::Definition::RubyObject] The block argument of a
-    #   method definition.
-    #
     # @!attribute [r] return_value
     #  @return [Mixed] The value that is returned by the method.
     #
     class RubyMethod < RubyObject
-      attr_reader :block_argument,
-        :arguments,
-        :optional_arguments,
-        :rest_argument,
-        :return_value,
-        :visibility
+      attr_reader :return_value, :visibility
+
+      ##
+      # @return [Array]
+      #
+      def arguments
+        return list(:arg)
+      end
+
+      ##
+      # @return [RubyLint::Definition::RubyObject]
+      #
+      def block_argument
+        return list(:blockarg).first
+      end
+
+      ##
+      # @return [Array]
+      #
+      def keyword_arguments
+        return list(:kwoptarg)
+      end
+
+      ##
+      # @return [Array]
+      #
+      def optional_arguments
+        return list(:optarg)
+      end
 
       ##
-      # Called after a new instance is created of this class. This method is
-      # called before calling any supplied blocks.
+      # @return [RubyLint::Definition::RubyObject]
       #
-      def after_initialize
-        @arguments          ||= []
-        @optional_arguments ||= []
+      def rest_argument
+        return list(:restarg).first
       end
 
       ##
@@ -70,7 +75,16 @@ module RubyLint
       # @param [String] name The name of the argument.
       #
       def define_argument(name)
-        @arguments << create_argument(:arg, name)
+        create_argument(:arg, name)
+      end
+
+      ##
+      # Defines a keyword argument for the method.
+      #
+      # @see RubyLint::Definition::RubyObject#define_argument
+      #
+      def define_keyword_argument(name)
+        create_argument(:kwoptarg, name)
       end
 
       ##
@@ -79,7 +93,7 @@ module RubyLint
       # @see RubyLint::Definition::RubyObject#define_argument
       #
       def define_optional_argument(name)
-        @optional_arguments << create_argument(:optarg, name)
+        create_argument(:optarg, name)
       end
 
       ##
@@ -88,7 +102,7 @@ module RubyLint
       # @see RubyLint::Definition::RubyObject#define_argument
       #
       def define_rest_argument(name)
-        @rest_argument = create_argument(:restarg, name)
+        create_argument(:restarg, name)
       end
 
       ##
@@ -97,7 +111,7 @@ module RubyLint
       # @see RubyLint::Definition::RubyObject#define_argument
       #
       def define_block_argument(name)
-        @block_argument = create_argument(:blockarg, name)
+        create_argument(:blockarg, name)
       end
 
       private

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

@@ -91,19 +91,21 @@ module RubyLint
       # @return [Array<Symbol>]
       #
       VALID_TYPES = [
-        :lvar,
-        :ivar,
+        :arg,
+        :blockarg,
+        :const,
         :cvar,
         :gvar,
-        :const,
-        :method,
         :instance_method,
-        :member,
+        :ivar,
         :keyword,
-        :arg,
+        :kwoptarg,
+        :lvar,
+        :member,
+        :method,
         :optarg,
         :restarg,
-        :blockarg
+        :unknown
       ].freeze
 
       attr_reader :update_parents,
@@ -114,6 +116,15 @@ module RubyLint
 
       attr_accessor :instance_type, :parents, :reference_amount
 
+      ##
+      # Creates an object that represents an unknown value.
+      #
+      # @return [RubyLint::Definition::RubyObject]
+      #
+      def self.create_unknown
+        return new(:type => :unknown, :name => 'unknown')
+      end
+
       ##
       # @example
       #  string = RubyObject.new(:name => 'String', :type => :const)
@@ -243,10 +254,11 @@ module RubyLint
         if defines?(type, name)
           found = definitions[type][name]
 
-        # Look up the definition in the parent scope(s) (if any are set).
+        # Look up the definition in the parent scope(s) (if any are set). This
+        # takes the parents themselves also into account.
         elsif lookup_parent?(type) and lookup_parent
           parents.each do |parent|
-            parent_definition = parent.lookup(type, name)
+            parent_definition = determine_parent(parent, type, name)
 
             if parent_definition
               found = parent_definition
@@ -320,7 +332,7 @@ module RubyLint
       # @return [Mixed]
       #
       def call(context = self)
-        retval = return_value
+        retval = respond_to?(:return_value) ? return_value : nil
         retval = retval.call(context) if retval.respond_to?(:call)
 
         return retval
@@ -436,6 +448,8 @@ module RubyLint
       #  set to the `source_type` value by default.
       #
       def copy(source, source_type, target_type = source_type)
+        return unless source.definitions.key?(source_type)
+
         source.list(source_type).each do |definition|
           add(target_type, definition.name, definition)
         end
@@ -460,6 +474,14 @@ module RubyLint
         return self.class.new(options)
       end
 
+      ##
+      # Changes the instance type of the current definition to `:instance`. If
+      # you want to return a new definition use {#instance} instead.
+      #
+      def instance!
+        @instance_type = :instance
+      end
+
       ##
       # Returns `true` if the object was referenced more than once.
       #
@@ -501,7 +523,7 @@ module RubyLint
       # @param [String] name
       # @param [Mixed] value
       #
-      def define_global_variable(name, value = nil)
+      def define_global_variable(name, value = self.class.create_unknown)
         return add_child_definition(:gvar, name, value)
       end
 
@@ -587,6 +609,24 @@ module RubyLint
         end
       end
 
+      ##
+      # Determines what parent definition to use.
+      #
+      # @param [RubyLint::Definition::RubyObject] parent
+      # @param [Symbol] type
+      # @param [String] name
+      # @return [RubyLint::Definition::RubyObject]
+      #
+      def determine_parent(parent, type, name)
+        if parent.type == type and parent.name == name
+          parent_definition = parent
+        else
+          parent_definition = parent.lookup(type, name)
+        end
+
+        return parent_definition
+      end
+
       ##
       # Adds a new child definition to the current definition.
       #
@@ -599,7 +639,7 @@ module RubyLint
         definition = self.class.new(
           :name    => name,
           :type    => type,
-          :value   => nil,
+          :value   => value,
           :parents => [self],
           &block
         )
@@ -616,9 +656,10 @@ module RubyLint
       #
       def add_child_method(type, name, &block)
         definition = RubyMethod.new(
-          :name    => name,
-          :type    => type,
-          :parents => [self],
+          :name          => name,
+          :type          => type,
+          :parents       => [self],
+          :instance_type => :instance,
           &block
         )