ruumba 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 499ac4d5c4a2e6ed257da7a16218a65fe5f48c8b
-  data.tar.gz: 2068f31c26ad2011256ae53cbdbe978895898316
+  metadata.gz: 150e5c1981114be3f11e8f327ab80896264241e5
+  data.tar.gz: a043ba70111e3c987b6586f32424adac80ba0e26
 SHA512:
-  metadata.gz: 7050b2578545ba9d0c393e3829d8a824c0b9e175aa22afb26ade2518af446bc11a9e9ab84afc2d29500ac1764c37cb2d1c49bdc58e95111dfd18e6687eb544fe
-  data.tar.gz: 8ee48c0e20a55debd4cfce935ea843851fc5c4ee37ad496051b150af33eac51957839bc578a52ae22f963332bb66ab10584b83dbf9ef71788664b5c163190612
+  metadata.gz: 7b6657ec72b0e1c33625f39a890ff029281d1d20130ec8da9b346c19b8511ff0063d5eb37edb7040f1df67d13c64431ef11860b358b3b7917dabb71e8673746e
+  data.tar.gz: 27fa8094870b988a99a35409c55d0cc3fd2e20b60190a9aff43119d2d023b3f7d29d9b1b31fb3b148daec7ff704b04fef740cd2f70f164852225f81cee4a28a8

data/README.md

@@ -11,7 +11,7 @@ Ruumba
 Ruumba is [RuboCop's](https://github.com/bbatsov/rubocop) sidekick, allowing you to lint your .erb Rubies as well as your regular-type ones.
 
 ## Dependencies
-* Ruby 2.2.2+
+* Ruby 2.3+
 
 ## Installation
 ```bash

data/bin/ruumba

@@ -17,6 +17,15 @@ opts_parser = OptionParser.new do |opts|
     options[:arguments] << '--auto-gen-config'
   end
 
+  opts.on('--exclude-limit COUNT', 'Used together with --auto-gen-config to set the limit for how many Exclude properties to generate. Default is 15.') do |count|
+    options[:arguments] << '--exclude-limit'
+    options[:arguments] << count
+  end
+
+  opts.on('--no-offense-counts', 'Do not include offense counts in configuration file generated by --auto-gen-config.') do
+    options[:arguments] << '--no-offense-counts'
+  end
+
   opts.on('-t', '--tmp-folder [TEMP_FOLDER]', 'Use this suffix for the temporary folder') do |f|
     options[:tmp_folder] = f
   end
@@ -31,11 +40,11 @@ opts_parser = OptionParser.new do |opts|
     options[:arguments] << flag
   end
 
-  opts.on('-d', '--debug', 'Display debug info.') do ||
+  opts.on('-d', '--debug', 'Display debug info.') do
     options[:arguments] << '--debug'
   end
 
-  opts.on('-D', '--display-cop-names', 'Display cop names') do ||
+  opts.on('-D', '--display-cop-names', 'Display cop names') do
     options[:arguments] << '--display-cop-names'
   end
 
@@ -71,6 +80,22 @@ opts_parser = OptionParser.new do |opts|
     options[:arguments] << '--format'
     options[:arguments] << format
   end
+
+  opts.on('-s', '--stdin [FILE]', 'Pipe source from STDIN, using FILE in offense reports. This is useful for editor integration') do |file|
+    options[:stdin] = file
+  end
+
+  opts.on('--force-exclusion', 'Force excluding files specified in the configuration `Exclude` even if they are explicitly passed as arguments.') do
+    options[:arguments] << '--force-exclusion'
+  end
+
+  opts.on('-P', '--parallel', 'Use available CPUs to execute inspection in parallel.') do
+    options[:arguments] << '--parallel'
+  end
+
+  opts.on('-L', '--list-target-files', 'List all files Ruumba will inspect.') do
+    options[:arguments] << '--list-target-files'
+  end
 end
 
 begin

data/lib/ruumba/analyzer.rb

@@ -6,14 +6,15 @@ require 'tmpdir'
 require 'open3'
 require 'English'
 
+require 'ruumba/iterators'
+require 'ruumba/parser'
+require 'ruumba/rubocop_runner'
+
 # Ruumba: RuboCop's sidekick.
 module Ruumba
   # Generates analyzer objects that, when run, delegate
   # to RuboCop for linting (style, correctness, &c).
   class Analyzer
-    # The regular expression to capture interpolated Ruby.
-    ERB_REGEX = /<%[-=]?(.*?)-?%>/m
-
     def initialize(opts = nil)
       @options = opts || {}
     end
@@ -21,143 +22,77 @@ module Ruumba
     # Performs static analysis on the provided directory.
     # @param [Array<String>] dir The directories / files to analyze.
     def run(files_or_dirs = ARGV)
-      files_or_dirs = ['.'] if files_or_dirs.empty?
-      fq_files_or_dirs = files_or_dirs.map { |file_or_dir| Pathname.new(File.expand_path(file_or_dir)) }
-      pwd = Pathname.new(ENV['PWD'])
-      tmp = create_temp_dir
-
-      copy_erb_files(fq_files_or_dirs, tmp, pwd)
-
-      target = '.'
-      run_rubocop(target, tmp)
-    end
-
-    # Extracts Ruby code from an ERB template.
-    # @param [String] filename The filename.
-    # @return [String] The extracted Ruby code.
-    def extract(filename)
-      file_text, matches = parse_file(filename)
-
-      extracted_ruby = ''
-
-      last_match = [0, 0]
-      matches.each do |start_index, end_index|
-        handled_region_before(start_index, last_match.last, file_text, extracted_ruby)
-
-        extracted_ruby << extract_match(file_text, start_index, end_index)
+      iterator =
+        if stdin?
+          Iterators::StdinIterator.new(stdin_filename)
+        else
+          Iterators::DirectoryIterator.new(files_or_dirs)
+        end
 
-        last_match = [start_index, end_index]
+      iterator.each do |file, contents|
+        copy_erb_file(file, contents)
       end
 
-      extracted_ruby << file_text[last_match.last..-1].gsub(/./, ' ')
+      RubocopRunner.new(arguments, pwd, temp_dir, !disable_rb_extension?).execute
     end
 
     private
 
-    def parse_file(filename)
-      # http://edgeguides.rubyonrails.org/active_support_core_extensions.html#output-safety
-      # replace '<%==' with '<%= raw' to avoid generating invalid ruby code
-      file_text = File.read(filename).gsub(/<%==/, '<%= raw')
-
-      matching_regions = file_text.enum_for(:scan, ERB_REGEX)
-                                  .map { Regexp.last_match.offset(1) }
+    attr_reader :options
 
-      [file_text, matching_regions]
+    def extension
+      '.rb' unless disable_rb_extension?
     end
 
-    def handled_region_before(match_start, prev_end_index,
-                              file_text, extracted_ruby)
-      return unless match_start > prev_end_index
-
-      region_before = file_text[prev_end_index..match_start - 1]
-
-      extracted_ruby << region_before.gsub(/./, ' ')
-
-      # if the last match was on the same line, we need to use a semicolon to
-      # separate statements
-      extracted_ruby[prev_end_index] = ';' if needs_stmt_delimiter?(prev_end_index, region_before)
+    def stdin?
+      stdin_filename
     end
 
-    def needs_stmt_delimiter?(last_match, region_before)
-      last_match.positive? && region_before.index("\n").nil?
+    def stdin_filename
+      options[:stdin]
     end
 
-    def extract_match(file_text, start_index, end_index)
-      file_text[start_index...end_index].tap do |region|
-        region.gsub!(/./, ' ') if region[0] == '#'
-      end
+    def arguments
+      options[:arguments]
     end
 
-    def create_temp_dir
-      if @options[:tmp_folder]
-        Pathname.new(File.expand_path(@options[:tmp_folder]))
-      else
-        Pathname.new(Dir.mktmpdir)
-      end
+    def disable_rb_extension?
+      options[:disable_rb_extension]
     end
 
-    def copy_erb_files(fq_files_or_dirs, tmp, pwd)
-      extension = '.rb' unless @options[:disable_rb_extension]
+    def pwd
+      @pwd ||= Pathname.new(ENV['PWD'])
+    end
 
-      fq_files_or_dirs.each do |fq_file_or_dir|
-        if fq_file_or_dir.file?
-          copy_erb_file(fq_file_or_dir, tmp, pwd, extension) if fq_file_or_dir.to_s.end_with?('.erb')
+    def temp_dir
+      @temp_dir ||= begin
+        if options[:tmp_folder]
+          Pathname.new(File.expand_path(options[:tmp_folder]))
         else
-          Dir["#{fq_file_or_dir}/**/*.erb"].each do |f|
-            copy_erb_file(f, tmp, pwd, extension)
-          end
+          Pathname.new(Dir.mktmpdir)
         end
       end
     end
 
-    def copy_erb_file(file, tmp, pwd, extension)
-      n = tmp + Pathname.new(file).relative_path_from(pwd)
-      FileUtils.mkdir_p(File.dirname(n))
-
-      File.open("#{n}#{extension}", 'w+') do |tmp_file|
-        code = extract(file)
-        tmp_file.write(code)
-      end
+    def parser
+      @parser ||= Parser.new
     end
 
-    def run_rubocop(target, tmp)
-      args = ['rubocop'] + (@options[:arguments] || []) + [target.to_s]
-      todo = tmp + '.rubocop_todo.yml'
-
-      pwd = Dir.pwd
-
-      replacements = []
-
-      unless @options[:disable_rb_extension]
-        replacements << [/\.erb\.rb/, '.erb']
-      end
-
-      result = Dir.chdir(tmp) do
-        replacements.unshift([/^#{Regexp.quote(Dir.pwd)}/, pwd])
+    def copy_erb_file(file, contents)
+      code = parser.extract(contents)
 
-        stdout, stderr, status = Open3.capture3(*args)
-
-        munge_output(stdout, stderr, replacements)
+      n = temp_filename_for(file)
+      FileUtils.mkdir_p(File.dirname(n))
 
-        status.exitstatus.zero?
+      File.open(n, 'w+') do |tmp_file|
+        tmp_file.write(code)
       end
-
-      FileUtils.cp(todo, pwd) if File.exist?(todo)
-      FileUtils.rm_rf(tmp) unless @options[:tmp_folder]
-
-      result
     end
 
-    def munge_output(stdout, stderr, replacements)
-      [[STDOUT, stdout], [STDERR, stderr]].each do |output_stream, output|
-        next if output.nil? || output.empty?
-
-        replacements.each do |pattern, replacement|
-          output.gsub!(pattern, replacement)
-        end
+    def temp_filename_for(file)
+      name = temp_dir.join(Pathname.new(file).relative_path_from(pwd))
 
-        output_stream.puts(output)
-      end
+      "#{name}#{extension}"
     end
   end
 end

data/lib/ruumba/iterators.rb

@@ -0,0 +1,70 @@
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+# Ruumba: RuboCop's sidekick.
+module Ruumba
+  # Generates analyzer objects that, when run, delegate
+  # to RuboCop for linting (style, correctness, &c).
+  module Iterators
+    # Iterator which returns the file passed in via stdin
+    class StdinIterator
+      include Enumerable
+
+      def initialize(file)
+        @file = file
+      end
+
+      def each(&block)
+        [[file, STDIN.read]].each(&block)
+      end
+
+      private
+
+      attr_reader :file
+    end
+
+    # Iterator which returns matching files from the given directory or file list
+    class DirectoryIterator
+      include Enumerable
+
+      def initialize(files_or_dirs)
+        @files_or_dirs = files_or_dirs
+      end
+
+      def each(&block)
+        files.map do |file|
+          [file, File.read(file)]
+        end.each(&block)
+      end
+
+      private
+
+      attr_reader :files_or_dirs
+
+      def files
+        full_list.flat_map do |file_or_dir|
+          if file_or_dir.file?
+            file_or_dir if file_or_dir.to_s.end_with?('.erb')
+          else
+            Dir["#{file_or_dir}/**/*.erb"].map do |file|
+              Pathname.new(file)
+            end
+          end
+        end.compact
+      end
+
+      def full_list
+        if files_or_dirs.nil? || files_or_dirs.empty?
+          [expand_path('.')]
+        else
+          files_or_dirs.map do |file_or_dir|
+            expand_path(file_or_dir)
+          end
+        end
+      end
+
+      def expand_path(file_or_dir)
+        Pathname.new(File.expand_path(file_or_dir))
+      end
+    end
+  end
+end

data/lib/ruumba/parser.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+module Ruumba
+  # Responsible for extracting interpolated Ruby.
+  class Parser
+    # The regular expression to capture interpolated Ruby.
+    ERB_REGEX = /<%[-=]?(.*?)-?%>/m
+
+    # Extracts Ruby code from an ERB template.
+    # @return [String] The extracted ruby code
+    def extract(contents)
+      file_text, matches = parse(contents)
+
+      extracted_ruby = +''
+
+      last_match = [0, 0]
+      matches.each do |start_index, end_index|
+        handle_region_before(start_index, last_match.last, file_text, extracted_ruby)
+
+        extracted_ruby << extract_match(file_text, start_index, end_index)
+
+        last_match = [start_index, end_index]
+      end
+
+      extracted_ruby << file_text[last_match.last..-1].gsub(/./, ' ')
+      extracted_ruby.gsub!(/[^\S\r\n]+$/, '')
+
+      # if we replaced <%== with <%= raw, try to shift the columns back to the
+      # left so they match the original again
+      extracted_ruby.gsub!(/   raw/, 'raw')
+
+      extracted_ruby
+    end
+
+    private
+
+    def parse(contents)
+      # http://edgeguides.rubyonrails.org/active_support_core_extensions.html#output-safety
+      # replace '<%==' with '<%= raw' to avoid generating invalid ruby code
+      file_text = contents.gsub(/<%==/, '<%= raw')
+
+      matching_regions = file_text.enum_for(:scan, ERB_REGEX)
+                                  .map { Regexp.last_match.offset(1) }
+
+      [file_text, matching_regions]
+    end
+
+    def handle_region_before(match_start, prev_end_index, file_text, extracted_ruby)
+      return unless match_start > prev_end_index
+
+      region_before = file_text[prev_end_index..match_start - 1]
+
+      extracted_ruby << region_before.gsub(/./, ' ')
+
+      # if the last match was on the same line, we need to use a semicolon to
+      # separate statements
+      extracted_ruby[prev_end_index] = ';' if needs_stmt_delimiter?(prev_end_index, region_before)
+    end
+
+    def needs_stmt_delimiter?(last_match, region_before)
+      last_match.positive? && region_before.index("\n").nil?
+    end
+
+    def extract_match(file_text, start_index, end_index)
+      file_text[start_index...end_index].tap do |region|
+        # if this is a ruby comment inside, replace the whole match with spaces
+        region.gsub!(/[^\r\n]/, ' ') if region[0] == '#'
+      end
+    end
+  end
+end

data/lib/ruumba/rake_task.rb

@@ -36,7 +36,7 @@ module Ruumba
       analyzer = Ruumba::Analyzer.new(@options)
       puts 'Running Ruumba...'
 
-      analyzer.run(@dir) || exit(1)
+      exit(analyzer.run(@dir))
     end
   end
 end

data/lib/ruumba/rubocop_runner.rb

@@ -0,0 +1,58 @@
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+require 'open3'
+
+module Ruumba
+  # Runs rubocop on the files in the given target_directory
+  class RubocopRunner
+    def initialize(arguments, current_directory, target_directory, rb_extension_enabled)
+      @arguments = Array(arguments)
+      @current_directory = current_directory
+      @rb_extension_enabled = rb_extension_enabled
+      @target_directory = target_directory
+    end
+
+    # Executes rubocop, updating filenames in the output if needed.
+    # @return the exit code of the rubocop process
+    def execute
+      args = ['rubocop'] + arguments
+      todo = target_directory.join('.rubocop_todo.yml')
+
+      replacements = []
+
+      # if adding the .rb extension is enabled, remove the extension again from
+      # any output so it matches the actual files names we are linting
+      replacements << [/\.erb\.rb/, '.erb'] if rb_extension_enabled
+
+      result = Dir.chdir(target_directory) do
+        replacements.unshift([/^#{Regexp.quote(Dir.pwd)}/, current_directory.to_s])
+        stdout, stderr, status = Open3.capture3(*args)
+
+        munge_output(stdout, stderr, replacements)
+
+        status.exitstatus
+      end
+
+      # copy the todo file back for the case where we've used --auto-gen-config
+      FileUtils.cp(todo, current_directory) if todo.exist?
+
+      result
+    end
+
+    private
+
+    attr_reader :arguments, :current_directory, :rb_extension_enabled, :target_directory
+
+    def munge_output(stdout, stderr, replacements)
+      [[STDOUT, stdout], [STDERR, stderr]].each do |output_stream, output|
+        next if output.nil? || output.empty?
+
+        replacements.each do |pattern, replacement|
+          output.gsub!(pattern, replacement)
+        end
+
+        output_stream.puts(output)
+      end
+    end
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: ruumba
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Eric Weinstein
 - Jan Biniok
 - Yvan Barthélemy
+- Andrew Clemons
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,7 +39,10 @@ files:
 - bin/ruumba
 - lib/ruumba.rb
 - lib/ruumba/analyzer.rb
+- lib/ruumba/iterators.rb
+- lib/ruumba/parser.rb
 - lib/ruumba/rake_task.rb
+- lib/ruumba/rubocop_runner.rb
 homepage: https://github.com/ericqweinstein/ruumba
 licenses:
 - MIT
@@ -59,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Allows users to lint Ruby code in ERB templates the same way they lint source