ruby-lint 1.1.0 → 2.0.0

data/lib/ruby-lint/cache.rb

@@ -1,121 +0,0 @@
-module RubyLint
-  ##
-  # The Cache class is used for storing arbitrary Ruby objects in a cache
-  # directory. The primary use case of this class is to store cached ASTs and
-  # their comment associations (as is done by {RubyLint::Runner}).
-  #
-  # @!attribute [r] directory
-  #  @return [String]
-  #
-  class Cache
-    attr_reader :directory
-
-    ##
-    # The version of the cache format.
-    #
-    # @return [String]
-    #
-    FORMAT_VERSION = '1'
-
-    ##
-    # @param [String] directory Path to the cache directory.
-    #
-    def initialize(directory)
-      @directory = directory
-    end
-
-    ##
-    # Creates the directory specified in {#directory} unless it already exists.
-    #
-    def create_directory!
-      Dir.mkdir(directory) unless File.directory?(directory)
-    end
-
-    ##
-    # Checks if there's a cache entry for the given name.
-    #
-    # @return [TrueClass|FalseClass]
-    #
-    def exists?(name)
-      return File.file?(entry_filepath(name))
-    end
-
-    ##
-    # Returns the cache entry for the given name or `nil` if the entry doesn't
-    # exist.
-    #
-    # @param [String] name
-    # @return [Mixed]
-    #
-    def get(name)
-      return unless exists?(name)
-
-      data = File.read(entry_filepath(name))
-
-      return decode(data)
-    end
-
-    ##
-    # Sets the cache entry to the given value. Existing cache entries are
-    # overwritten.
-    #
-    # @param [String] name
-    # @param [Mixed] value
-    #
-    def set(name, value)
-      File.open(entry_filepath(name), 'w') do |handle|
-        handle.write(encode(value))
-      end
-    end
-
-    ##
-    # Removes a cache entry.
-    #
-    # @param [String] name
-    #
-    def delete(name)
-      File.unlink(entry_filepath(name)) if exists?(name)
-    end
-
-    private
-
-    ##
-    # Returns the filename for the given entry name.
-    #
-    # @param [String] name
-    # @return [String]
-    #
-    def entry_filename(name)
-      return "#{name}.#{FORMAT_VERSION}.cache"
-    end
-
-    ##
-    # Returns the full filename of the cache entry's name.
-    #
-    # @param [String] name
-    # @return [String]
-    #
-    def entry_filepath(name)
-      return File.join(directory, entry_filename(name))
-    end
-
-    ##
-    # Decodes a cache entry.
-    #
-    # @param [String] input
-    # @return [Mixed]
-    #
-    def decode(input)
-      return Marshal.load(Zlib::Inflate.inflate(input))
-    end
-
-    ##
-    # Encodes a cache entry.
-    #
-    # @param [String] input
-    #
-    def encode(input)
-      return Zlib::Deflate.deflate(Marshal.dump(input))
-    end
-  end # Cache
-end # RubyLint

data/lib/ruby-lint/cache_entry.rb

@@ -1,44 +0,0 @@
-module RubyLint
-  ##
-  # The CacheEntry class is used to store nodes, comments and file modification
-  # times that belong to a certain root AST. It's primarily used by
-  # {RubyLint::Runner}.
-  #
-  # @!attribute [r] nodes
-  #  @return [Array]
-  #
-  # @!attribute [r] comments
-  #  @return [Hash]
-  #
-  # @!attribute [r] mtimes
-  #  @return [Hash]
-  #
-  class CacheEntry
-    attr_reader :nodes, :comments, :mtimes
-
-    ##
-    # @param [Array] nodes
-    # @param [Hash] comments
-    # @param [Hash] mtimes
-    #
-    def initialize(nodes, comments, mtimes)
-      @nodes    = nodes
-      @comments = comments
-      @mtimes   = mtimes
-    end
-
-    ##
-    # Returns `true` if none of the associated files have been modified,
-    # `false` otherwise.
-    #
-    # @return [TrueClass|FalseClass]
-    #
-    def valid?
-      mtimes.each do |file, mtime|
-        return false if File.mtime(file) != mtime
-      end
-
-      return true
-    end
-  end # CacheEntry
-end # RubyLint

data/lib/ruby-lint/cli.rb

@@ -1,4 +0,0 @@
-require 'slop'
-require_relative 'cli/base'
-require_relative 'cli/analyze'
-require_relative 'cli/cache'

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

@@ -1,209 +0,0 @@
-RubyLint::CLI.options.command :analyze do
-  banner      'Usage: ruby-lint analyze [FILES] [OPTIONS]'
-  description 'Analyze the source code of Ruby files'
-
-  separator <<-EOF.chomp
-
-About:
-
-  This command analyses the source code of a Ruby file and presents a report
-  containing information such as errors about invalid code, warnings and
-  informational messages.
-
-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.yml
-  * ~/.ruby-lint.yml
-
-  Only the first existing configuration file is loaded.
-
-  These configuration files can be used for specifying the presenter, reporting
-  levels and various other options.
-
-  You can also configure various parts using the supplied commandline options.
-  For example, to use the JSON presenter you'd run the following:
-
-    $ ruby-lint analyze ./test_file.rb --presenter=json
-
-Analysis Classes:
-
-  #{RubyLint::CLI.format_names('analysis')}
-
-Presenters:
-
-  #{RubyLint::CLI.format_names('presenters')}
-
-Reporting Levels:
-
-  #{RubyLint::CLI.format_names('levels')}
-
-Examples:
-
-  To analyze a single file you can run the following command:
-
-      $ ruby-lint analyze ./test_file.rb
-
-  You can also specify multiple files:
-
-      $ ruby-lint analyze first_file.rb second_file.rb
-
-  Run analysis on an entire directory:
-
-      $ ruby-lint analyze lib/
-  EOF
-
-  separator RubyLint::CLI::OPTIONS_HEADER
-
-  RubyLint::CLI.help_option(self)
-
-  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'
-
-  on :'disable-cache', 'Disables caching of external files'
-
-  ##
-  # 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)
-    return RubyLint::FileList.new.process(files)
-
-  rescue Errno::ENOENT => error
-    abort error.message
-  end
-
-  ##
-  # @return [Hash]
-  #
-  def option_mapping
-    return {
-      :levels    => :report_levels=,
-      :presenter => :presenter=,
-      :analysis  => :analysis_classes=,
-      :debug     => :debug=
-    }
-  end
-
-  ##
-  # @return [IO]
-  #
-  def output_destination
-    return @output_destination ||= STDOUT
-  end
-
-  ##
-  # @param [IO] destination
-  #
-  def output_destination=(destination)
-    @output_destination = destination
-  end
-
-  # The stdout and stderr methods mainly exist to make testing a bit easier.
-
-  ##
-  # @return [IO]
-  #
-  def stdout
-    return STDOUT
-  end
-
-  ##
-  # @return [IO]
-  #
-  def stderr
-    return STDERR
-  end
-
-  ##
-  # @param [RubyLint::Configuration] configuration
-  # @param [Hash] opts
-  #
-  def configure(configuration, options)
-    option_mapping.each do |key, setter|
-      configuration.send(setter, options[key]) if options[key]
-    end
-
-    if options[:'disable-cache']
-      configuration.enable_cache = false
-    end
-  end
-
-  ##
-  # @param [String] output
-  # @param [Float] exec_time
-  #
-  def show_benchmark_info(output, exec_time)
-    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(4)} seconds"
-
-    output_destination.puts "Memory usage: #{memory_mb.round(2)} MB " \
-      "(#{memory_kb.round(2)} KB)"
-  end
-
-  ##
-  # Shows a lump of debugging information before the rest of the output.
-  #
-  # @param [RubyLint::Configuration] config
-  #
-  #:nocov:
-  def debug_header(config)
-    directories = config.directories.map do |dir|
-      File.directory?(dir) ? "#{dir}: exists" : "#{dir}: doesn't exist"
-    end
-
-    directories = directories.empty? ? 'None' : directories.join("\n")
-
-    stderr.puts <<-EOF.strip
-ruby:      #{RUBY_DESCRIPTION}
-ruby-lint: #{RubyLint::VERSION}
-directory: #{Dir.pwd}
-
-Caching:
-
-enabled:   #{config.enable_cache}
-directory: #{config.cache_directory}
-
-Directories:
-
-#{directories}
-
-------
-    EOF
-
-    stderr.puts
-  end
-  #:nocov:
-
-  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
-
-    configure(configuration, opts)
-
-    debug_header(configuration) if configuration.debug
-
-    runner    = RubyLint::Runner.new(configuration)
-    output    = runner.analyze(files)
-    exec_time = Time.now.to_f - start_time
-
-    output_destination.puts output unless output.empty?
-
-    show_benchmark_info(output, exec_time) if opts[:benchmark]
-  end # run do |opts, args|
-end # RubyLint::CLI.options.command

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

@@ -1,103 +0,0 @@
-module RubyLint
-  module CLI
-    ##
-    # Hash containing configuration options for Slop.
-    #
-    # @return [Hash]
-    #
-    SLOP_OPTIONS = {
-      :strict => true,
-      :banner => 'Usage: ruby-lint [COMMAND] [OPTIONS]'
-    }
-
-    ##
-    # The header to use for separating options with other bits of information
-    # in help messages.
-    #
-    # @return [String]
-    #
-    OPTIONS_HEADER = "\nOptions:\n"
-
-    #:nocov:
-
-    ##
-    # Returns a String containing a list of names as registered in
-    # {RubyLint::Configuration.names}.
-    #
-    # @param [String] scope
-    # @see RubyLint::Configuration.names
-    # @return [String]
-    #
-    def self.format_names(scope)
-      return "* #{Configuration.names[scope].keys.sort.join("\n  * ")}"
-    end
-
-    ##
-    # Starts the CLI.
-    #
-    # @param [Array] argv
-    #
-    def self.run(argv = ARGV)
-      options.parse(argv)
-    end
-
-    ##
-    # @return [Slop]
-    #
-    def self.options
-      return @options ||= default_options
-    end
-
-    ##
-    # @return [Slop]
-    #
-    def self.default_options
-      return Slop.new(SLOP_OPTIONS) do
-        separator OPTIONS_HEADER
-
-        CLI.help_option(self)
-
-        on :v, :version, 'Shows the current version' do
-          puts CLI.version_information
-          exit
-        end
-
-        run do |opts, args|
-          if args.empty?
-            puts self
-            exit
-          else
-            CLI.options.commands['analyze'].parse(args)
-          end
-        end
-      end
-    end
-
-    ##
-    # Adds a `-h/--help` option for a command. This method should be executed
-    # in the context of a Slop command.
-    #
-    # @param [Mixed] command
-    #
-    def self.help_option(command)
-      command.instance_eval do
-        on :h, :help, 'Shows this help message' do
-          puts self
-          exit
-        end
-      end
-    end
-
-    ##
-    # Returns a String containing information about the current ruby-lint
-    # version and platform.
-    #
-    # @return [String]
-    #
-    def self.version_information
-      return "ruby-lint v#{VERSION} on #{RUBY_DESCRIPTION}"
-    end
-
-    #:nocov:
-  end # CLI
-end # RubyLint