ruby-lint 0.0.3 → 0.0.4

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

@@ -0,0 +1,39 @@
+module RubyLint
+  module AST
+    ##
+    # Extends the Node class provided by the `parser` Gem with various extra
+    # methods.
+    #
+    class Node < ::Parser::AST::Node
+      include ::RubyLint::VariablePredicates
+
+      ##
+      # @return [Numeric]
+      #
+      def line
+        return location.expression.line
+      end
+
+      ##
+      # @return [Numeric]
+      #
+      def column
+        return location.expression.column
+      end
+
+      ##
+      # @return [String]
+      #
+      def file
+        return location.expression.source_buffer.name
+      end
+
+      ##
+      # @return [String]
+      #
+      def name
+        return const? ? children[-1].to_s : children[0].to_s
+      end
+    end # Node
+  end # AST
+end # RubyLint

data/lib/ruby-lint/cli.rb

@@ -1,22 +1,3 @@
-RubyLint::Configuration.register_names 'analysis' do |names|
-  names['argument_amount']     = RubyLint::Analyze::ArgumentAmount
-  names['shadowing_variables'] = RubyLint::Analyze::ShadowingVariables
-  names['undefined_methods']   = RubyLint::Analyze::UndefinedMethods
-  names['undefined_variables'] = RubyLint::Analyze::UndefinedVariables
-  names['unused_variables']    = RubyLint::Analyze::UnusedVariables
-end
-
-RubyLint::Configuration.register_names 'presenters' do |names|
-  names['text'] = RubyLint::Presenter::Text
-  names['json'] = RubyLint::Presenter::JSON
-end
-
-RubyLint::Configuration.register_names 'levels' do |names|
-  RubyLint::Report.levels.each do |level|
-    names[level.to_s] = level
-  end
-end
-
 require 'slop'
 require_relative 'cli/base'
 require_relative 'cli/analyze'

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 'Analyzes the source code of Ruby files'
+  description 'Analysiss the source code of Ruby files'
 
   separator <<-EOF.chomp
 
@@ -59,41 +59,67 @@ Examples:
   on :p=, :presenter=, 'The presenter to use', :as => String
   on :a=, :analysis=, 'The analysis classes to use', :as => Array
 
-  run do |opts, args|
-    abort 'You must specify at least one file to analyze' if args.empty?
-
-    files = RubyLint::CLI.existing_files(args)
-
-    RubyLint.load_configuration
-
-    RubyLint.configuration.set_reporting_levels(opts[:l]) if opts[:l]
-    RubyLint.configuration.set_presenter(opts[:p]) if opts[:p]
-    RubyLint.configuration.set_analysis(opts[:a]) if opts[:a]
+  ##
+  # Returns an Array containing the file paths that exist. If a non existing
+  # file is encountered `abort` is called.
+  #
+  # @param [Array] files
+  # @return [Array]
+  #
+  def extract_files(files)
+    existing = []
 
     files.each do |file|
-      ast = RubyLint::Parser.new(File.read(file), file).parse
+      file = File.expand_path(file)
 
-      RubyLint::ConstantLoader.new.iterate(ast)
+      if File.file?(file)
+        existing << file
+      else
+        abort "The file #{file} does not exist"
+      end
+    end
 
-      report       = RubyLint.configuration.report
-      presenter    = RubyLint.configuration.presenter.new
-      defs_builder = RubyLint::DefinitionsBuilder.new
+    return existing
+  end
+
+  ##
+  # @return [Hash]
+  #
+  def option_mapping
+    return {
+      :levels    => :report_levels=,
+      :presenter => :presenter=,
+      :analysis  => :analysis_classes=
+    }
+  end
+
+  ##
+  # @return [IO]
+  #
+  def output_destination
+    return @output_destination ||= STDOUT
+  end
+
+  ##
+  # @param [IO] destination
+  #
+  def output_destination=(destination)
+    @output_destination = destination
+  end
 
-      defs_builder.iterate(ast)
+  run do |opts, args|
+    abort 'You must specify at least one file to analyze' if args.empty?
 
-      RubyLint.configuration.analysis.each do |constant|
-        instance = constant.new(
-          :report           => report,
-          :definitions      => defs_builder.options[:definitions],
-          :node_definitions => defs_builder.options[:node_definitions]
-        )
+    files         = extract_files(args)
+    configuration = RubyLint::Configuration.load_from_file
 
-        instance.iterate(ast)
-      end
+    option_mapping.each do |key, setter|
+      configuration.send(setter, opts[key]) if opts[key]
+    end
 
-      output = presenter.present(report)
+    runner = RubyLint::Runner.new(configuration)
+    output = runner.analyze(files)
 
-      puts output unless output.empty?
-    end
+    output_destination.puts output unless output.empty?
   end # run do |opts, args|
 end # RubyLint::CLI.options.command

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

@@ -19,17 +19,32 @@ Examples:
     $ ruby-lint ast ./test_file.rb
   EOF
 
-  separator   RubyLint::CLI::OPTIONS_HEADER
+  separator RubyLint::CLI::OPTIONS_HEADER
 
   RubyLint::CLI.help_option(self)
 
+  ##
+  # @return [IO]
+  #
+  def output_destination
+    return @output_destination ||= STDOUT
+  end
+
+  ##
+  # @param [IO] destination
+  #
+  def output_destination=(destination)
+    @output_destination = destination
+  end
+
   run do |opts, args|
-    file = args[0]
+    file = File.expand_path(args[0])
+
+    abort 'You must specify an existing file' unless File.file?(file)
 
-    if !file or !File.file?(file)
-      abort 'You must specify an existing file'
-    end
+    code   = File.read(file)
+    parser = RubyLint::Parser.new
 
-    puts RubyLint::Parser.new(File.read(file), file).parse.inspect
+    output_destination.puts parser.parse(code, file).inspect
   end
 end

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

@@ -18,29 +18,6 @@ module RubyLint
     #
     OPTIONS_HEADER = "\nOptions:\n"
 
-    ##
-    # Returns an Array containing the file paths that exist. If a non existing
-    # file is encountered `abort` is called.
-    #
-    # @param [Array] files
-    # @return [Array]
-    #
-    def self.existing_files(files)
-      existing = []
-
-      files.each do |file|
-        file = File.expand_path(file)
-
-        if File.file?(file)
-          existing << file
-        else
-          abort "The file #{file} does not exist"
-        end
-      end
-
-      return existing
-    end
-
     ##
     # Returns a String containing a list of names as registered in
     # {RubyLint::Configuration.names}.

data/lib/ruby-lint/configuration.rb

@@ -2,17 +2,49 @@ module RubyLint
   ##
   # The Configuration class is used for storing configuration information used
   # when running the CLI of ruby-lint. It contains information such as the
-  # reporting levels, the formatter to use and so on.
+  # available analysis classes and report levels.
   #
-  # @!attribute [rw] presenter
-  #  @return [RubyLint::Presenter] The presenter to use for displaying reports.
-  # @!attribute [rw] report_levels
-  #  @return [Array] The reporting levels to use.
-  # @!attribute [rw] analysis
-  #  @return [Array] The analysis classes to enable.
+  # @!attribute [r] analysis_classes
+  #  @return [Array]
+  # @!attribute [r] report_levels
+  #  @return [Array]
+  # @!attribute [r] presenter
+  #  @return [Class]
   #
   class Configuration
-    attr_accessor :presenter, :report_levels, :analysis
+    attr_reader :analysis_classes, :report_levels, :presenter
+
+    ##
+    # Returns an Array of locations from which to load configuration files.
+    #
+    # @return [Array]
+    #
+    def self.configuration_files
+      return [
+        File.join(Dir.pwd, 'ruby-lint.yml'),
+        File.expand_path('~/.ruby-lint.yml', __FILE__)
+      ]
+    end
+
+    ##
+    # Creates a new configuration instance by loading a configuration file.
+    #
+    # @param [Array] paths The Array of configuration files to process. Only
+    #  the first existing file will be loaded.
+    # @return [RubyLint::Configuration]
+    #
+    def self.load_from_file(paths = configuration_files)
+      paths.each do |path|
+        if File.file?(path)
+          options       = YAML.load_file(path)
+          configuration = new(options)
+
+          return configuration
+        end
+      end
+
+      return new
+    end
 
     ##
     # Provides a small block based DSL for registering multiple names.
@@ -43,70 +75,108 @@ module RubyLint
     #
     def initialize(options = {})
       options.each do |key, value|
-        instance_variable_set("@#{key}", value)
+        setter = "#{key}="
+
+        if respond_to?(setter)
+          send(setter, value)
+        end
       end
 
-      @presenter     ||= RubyLint::Presenter::Text
-      @report_levels ||= Report::DEFAULT_LEVELS
-      @analysis      ||= default_analysis_classes
+      @analysis_classes ||= default_analysis_classes
+      @report_levels    ||= default_report_levels
+      @presenter        ||= default_presenter
     end
 
     ##
-    # @return [Array]
+    # Requires a list of files.
     #
-    def default_analysis_classes
-      return Analyze.constants.map do |const|
-        Analyze.const_get(const)
-      end
+    # @param [Array] files
+    #
+    def requires=(files)
+      files.each { |file| require(file) }
     end
 
     ##
-    # Returns a report with the report levels set based on this configuration
-    # instance.
+    # Returns a list of the enabled report levels.
     #
-    # @return [RubyLint::Report]
+    # @param [Array] given The report levels specified by the user.
+    # @return [Array]
     #
-    def report
-      return Report.new(report_levels)
+    def report_levels=(given)
+      available = self.class.names['levels']
+      levels    = []
+
+      given.each do |level|
+        levels << available[level] if available[level]
+      end
+
+      if levels.empty?
+        levels = default_report_levels
+      end
+
+      @report_levels = levels
     end
 
     ##
-    # Set the reporting levels based on a set of CLI options.
+    # Returns the presenter to use.
     #
-    # @param [Array] levels
+    # @param [String] name The friendly name of the presenter as set by the
+    #  user.
+    # @return [RubyLint::Presenter]
+    # @raise ArgumentError Raised when an invalid presenter is specified.
     #
-    def set_reporting_levels(levels)
-      self.report_levels = []
-      available          = self.class.names['levels']
+    def presenter=(name)
+      found = self.class.names['presenters'][name]
 
-      levels.each do |level|
-        report_levels << available[level] if available[level]
+      if found
+        @presenter = found
+      else
+        raise ArgumentError, "Invalid presenter: #{name}"
       end
     end
 
     ##
-    # Sets the presenter based on a set of CLI options.
+    # Returns a collection of the analysis constants to use.
     #
-    # @param [String] name
+    # @param [Array] names The analysis names as given by the user.
+    # @return [Array]
     #
-    def set_presenter(name)
-      if self.class.names['presenters'][name]
-        self.presenter = self.class.names['presenters'][name]
+    def analysis_classes=(names)
+      classes   = []
+      available = self.class.names['analysis']
+
+      names.each do |name|
+        classes << available[name] if available[name]
       end
+
+      if classes.empty?
+        classes = default_analysis_classes
+      end
+
+      @analysis_classes = classes
     end
 
     ##
-    # Sets the analysis classes based on a set of CLI options.
+    # Returns the default (= all) analysis classes to use.
     #
-    # @param [Array] names
+    # @return [Array]
     #
-    def set_analysis(names)
-      self.analysis = []
-      available     = self.class.names['analysis']
+    def default_analysis_classes
+      return self.class.names['analysis'].values
+    end
 
-      names.each do |name|
-        self.analysis << available[name] if available[name]
-      end
+    ##
+    # @return [Array]
+    #
+    def default_report_levels
+      return RubyLint::Report::DEFAULT_LEVELS
+    end
+
+    ##
+    # @return [Class]
+    #
+    def default_presenter
+      return RubyLint::Presenter::Text
     end
   end # Configuration
 end # RubyLint

data/lib/ruby-lint/constant_loader.rb

@@ -11,6 +11,8 @@ module RubyLint
   #  @return [Hash] Hash containing the loaded constants.
   #
   class ConstantLoader < Iterator
+    include Helper::ConstantPaths
+
     attr_reader :loaded
 
     ##
@@ -19,42 +21,22 @@ module RubyLint
     # @return [Array]
     #
     LOAD_PATH = [
-      File.expand_path('../definitions/core', __FILE__)
+      File.expand_path('../definitions/core', __FILE__),
+      File.expand_path('../definitions/rails', __FILE__)
     ]
 
     ##
-    # @see RubyLint::Iterator#initialize
-    #
-    def initialize(*args)
-      super
-
-      @loaded           = {}
-      @in_constant_path = false
-    end
-
-    ##
-    # @param [RubyLint::Node] node
-    #
-    def on_constant_path(node)
-      @in_constant_path = true
-
-      load(node.children.first.name)
-    end
-
-    ##
-    # @param [RubyLint::Node] node
+    # Called after a new instance of the class is created.
     #
-    def after_constant_path(node)
-      @in_constant_path = false
+    def after_initialize
+      @loaded = {}
     end
 
     ##
     # @param [RubyLint::Node] node
     #
-    def on_constant(node)
-      return if @in_constant_path
-
-      load(node.name)
+    def on_const(node)
+      load_constant(constant_segments(node).first)
     end
 
     ##
@@ -72,7 +54,7 @@ module RubyLint
     #
     # @param [String] constant
     #
-    def load(constant)
+    def load_constant(constant)
       return if loaded?(constant)
 
       filename = constant.snake_case + '.rb'