add CSV support

Author: markburns

lib/problematic_variable_finder.rb

@@ -19,5 +19,42 @@ def read_file(path)
       @files ||= {}
       @files[path] ||= File.read(path)
     end
+
+    def options
+      @options ||= parse_options
+    end
+
+    private
+
+    def parse_options
+      options = {}
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{__FILE__} [options]"
+
+        opts.on("-fFORMAT", "--format=FORMAT", "output format default stdout, options [csv]") do |f|
+          options[:format] = (f || 'stdout').to_sym
+        end
+
+        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+          options[:verbose] = v
+        end
+
+        opts.on("-d", "--directory", "Directory to find app in") do |d|
+          options[:directory] = d
+        end
+
+        opts.on("-i", "--ignore rails,activerecord", Array, "Ignore gems") do |i|
+          options[:ignore] = i
+        end
+
+        opts.on("-g", "--gems rails,activerecord", Array, "List of gems") do |g|
+          options[:gems] = g
+        end
+      end.parse!
+
+      options
+    end
+
   end
 end

lib/problematic_variable_finder/formatters/cli_formatter.rb

@@ -11,11 +11,14 @@ def initialize(gem_name, problems)
       end 
 
       def call
+        csv = CSV.new(STDOUT)
+        csv << ['gem', 'location', 'type', 'value']
+
         problems.each do |path, (full_path, file_problems)|
           puts
 
           file_problems.each do |problem|
-            display_problem(full_path, path, problem)
+            csv << display_problem(full_path, path, problem)
           end
         end
       end

lib/problematic_variable_finder/formatters/csv.rb

@@ -0,0 +1,13 @@
+require 'problematic_variable_finder/formatters/display_cli_problem'
+
+module ProblematicVariableFinder
+  module Formatters
+    class Csv < CliFormatter
+      private
+
+      def display_problem(full_path, path, problem)
+        DisplayCsvProblem.new(gem_name, full_path, path, problem).call
+      end
+    end
+  end
+end

lib/problematic_variable_finder/formatters/display_csv_problem.rb

@@ -0,0 +1,9 @@
+module ProblematicVariableFinder
+  module Formatters
+    class DisplayCsvProblem < DisplayCliProblem
+      def call
+        [gem_name, "#{path}:#{line_number}", problem[:type],  problem[:name].to_s]
+      end
+    end
+  end
+end

lib/problematic_variable_finder/fs_caching.rb

@@ -5,9 +5,7 @@ def store
     end
 
     def cache(key)
-      return yield
-
-      case @in_transaction 
+      case @in_transaction
       when true
         store[key] ||= yield
       else

lib/problematic_variable_finder/gem_problems.rb

@@ -2,12 +2,11 @@ module ProblematicVariableFinder
   class GemProblems
     include FsCaching
 
-    def initialize(gem_path, gems, options)
+    def initialize(gem_path, gems)
       @gem_path, @gems = gem_path, gems
-      @options = options
     end
 
-    attr_reader :gem_path, :gems, :options
+    attr_reader :gem_path, :gems
 
     def problems
       @problems ||= determine_problems
@@ -51,6 +50,8 @@ def ignore_gem?(name)
       options[:ignore] && Array(options[:ignore]).include?(name)
     end
 
+    delegate :options, to: ProblematicVariableFinder
+
     def ignore_list
       @ignore_list ||= ProblematicVariableFinder.read_file(File.expand_path('DEFAULT_IGNORED_GEMS', __dir__)).map(&:strip)
     end

lib/problematic_variable_finder/runner.rb

@@ -8,6 +8,7 @@
 require 'problematic_variable_finder/gem_problems'
 require 'problematic_variable_finder/problem_finder'
 require 'problematic_variable_finder/formatters/cli_formatter'
+require 'problematic_variable_finder/formatters/csv'
 
 module ProblematicVariableFinder
   class Runner
@@ -39,7 +40,14 @@ def display_gem_problems
     end
 
     def display_problems(gem_name, problems)
-      Formatters::CliFormatter.new(gem_name, problems).call
+      klass = case options[:format]
+              when :csv
+                Formatters::Csv
+              else
+                Formatters::CliFormatter
+              end
+
+      klass.new(gem_name, problems).call
     end
 
     def each_gem_problem
@@ -52,11 +60,11 @@ def main_problems
       app_problems.merge(lib_problems)
     end
 
-    def app_problems 
+    def app_problems
       problem_finder.find_problems_in_directory("app")
     end
 
-    def lib_problems 
+    def lib_problems
       problem_finder.find_problems_in_directory("lib")
     end
 
@@ -73,41 +81,13 @@ def gems
     end
 
     def gem_problems
-      @gem_problems ||= GemProblems.new(gem_path, gems, options)
+      @gem_problems ||= GemProblems.new(gem_path, gems)
     end
 
     def problem_finder
       @problem_finder ||= ProblemFinder.new
     end
 
-    def options
-      @options ||= parse_options
-    end
-
-    def parse_options
-      options = {}
-
-      OptionParser.new do |opts|
-        opts.banner = "Usage: #{__FILE__} [options]"
-
-        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-          options[:verbose] = v
-        end
-
-        opts.on("-d", "--directory", "Directory to find app in") do |d|
-          options[:directory] = d
-        end
-
-        opts.on("-i", "--ignore rails,activerecord", Array, "Ignore gems") do |i|
-          options[:ignore] = i
-        end
-
-        opts.on("-g", "--gems rails,activerecord", Array, "List of gems") do |g|
-          options[:gems] = g
-        end
-      end.parse!
-
-      options
-    end
+    delegate :options, to: ProblematicVariableFinder
   end
 end