Merge pull request #62 from dkarter/feature/specify_output_path

Feature/specify output path
makaroni4 · May 5, 2015 · 1751ea8 · 1751ea8
2 parents 73abf8c + 2074fc7
commit 1751ea8
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 19 deletions.
diff --git a/Gemfile b/Gemfile
@@ -4,4 +4,6 @@ gemspec
 
 group :test do
   gem 'rspec'
+  gem 'pry' # standard debugger
+  gem 'fakefs', require: 'fakefs/safe' # stubs out FS to avoid creating files during testing
 end
diff --git a/README.md b/README.md
@@ -20,6 +20,7 @@ sandi_meter --help
         --json                       Output as JSON
     -l, --log                        Show syntax error and indentation log output
     -p, --path PATH                  Path to folder or file to analyze (default is ".")
+    -o, --output_path PATH           Path to save output files (default is "./sandi_meter")
     -r, --rules                      Show rules
     -h, --help                       Help
 

diff --git a/lib/sandi_meter/cli.rb b/lib/sandi_meter/cli.rb
@@ -21,6 +21,11 @@ class CommandParser
       description: "Path to folder or file to analyze",
       default: "."
 
+    option :output_path,
+      short: "-o PATH",
+      long: "--output-path PATH",
+      description: "Path for storing generated output files (default: ./sandi_meter/)"
+
     option :log,
       short: "-l",
       long: "--log",
@@ -77,13 +82,14 @@ class << self
       def execute
         cli = CommandParser.new
         cli.parse_options
+
+        cli.config[:output_path] ||= File.expand_path(File.join(cli.config[:path], 'sandi_meter'))
 
         if cli.config[:graph]
-          log_dir_path = File.join(cli.config[:path], 'sandi_meter')
-          FileUtils.mkdir(log_dir_path) unless Dir.exists?(log_dir_path)
+          FileUtils.mkdir_p(cli.config[:output_path]) unless Dir.exists?(cli.config[:output_path])
 
-          create_config_file(cli.config[:path], 'sandi_meter/.sandi_meter', %w(db vendor).join("\n"))
-          create_config_file(cli.config[:path], 'sandi_meter/config.yml', YAML.dump({ threshold: 90 }))
+          create_config_file(cli.config[:output_path], '.sandi_meter', %w(db vendor).join("\n"))
+          create_config_file(cli.config[:output_path], 'config.yml', YAML.dump({ threshold: 90 }))
         end
 
         if cli.config[:version]
@@ -108,16 +114,16 @@ def execute
         formatter.print_data(data)
 
         if cli.config[:graph]
-          if File.directory?(cli.config[:path])
+          if File.directory?(cli.config[:output_path])
             logger = SandiMeter::Logger.new(data)
-            logger.log!(cli.config[:path])
+            logger.log!(cli.config[:output_path])
 
             html_generator = SandiMeter::HtmlGenerator.new
-            html_generator.copy_assets!(cli.config[:path])
-            html_generator.generate_data!(cli.config[:path])
-            html_generator.generate_details!(cli.config[:path], data)
+            html_generator.copy_assets!(cli.config[:output_path])
+            html_generator.generate_data!(cli.config[:output_path])
+            html_generator.generate_details!(cli.config[:output_path], data)
 
-            index_html_path = File.join(cli.config[:path], 'sandi_meter/index.html')
+            index_html_path = File.join(cli.config[:output_path], 'index.html')
             unless cli.config[:quiet]
               open_in_browser(index_html_path)
             end
@@ -126,7 +132,7 @@ def execute
           end
         end
 
-        config_file_path = File.join(cli.config[:path], 'sandi_meter', 'config.yml')
+        config_file_path = File.join(cli.config[:output_path], 'config.yml')
         config =  if File.exists?(config_file_path)
                     YAML.load(File.read(config_file_path))
                   else

diff --git a/lib/sandi_meter/html_generator.rb b/lib/sandi_meter/html_generator.rb
@@ -4,19 +4,19 @@
 module SandiMeter
   class HtmlGenerator
     def copy_assets!(path)
-      asset_dir_path = File.join(path, 'sandi_meter/assets')
+      asset_dir_path = File.join(path, 'assets')
       FileUtils.mkdir(asset_dir_path) unless Dir.exists?(asset_dir_path)
+      html_dir = File.expand_path('../../html', File.dirname(__FILE__))
 
-
-      Dir[File.join(File.dirname(__FILE__), "../../html/*.{js,css,png}")].each do |file|
+      Dir[File.join(html_dir, "*.{js,css,png}")].each do |file|
         FileUtils.cp file, File.join(asset_dir_path, File.basename(file))
       end
 
-      FileUtils.cp File.join(File.dirname(__FILE__), "../../html", "index.html"), File.join(path, 'sandi_meter', 'index.html')
+      FileUtils.cp File.join(html_dir, 'index.html'), File.join(path, 'index.html')
     end
 
     def generate_data!(path)
-      raw_data = File.read(File.join(path, 'sandi_meter', 'sandi_meter.log')).split("\n")
+      raw_data = File.read(File.join(path, 'sandi_meter.log')).split("\n")
       raw_data.map! { |row| row.split(';').map(&:to_i) }
 
       data = []
@@ -31,7 +31,7 @@ def generate_data!(path)
         data << hash
       end
 
-      index_file = File.join(path, 'sandi_meter', 'index.html')
+      index_file = File.join(path, 'index.html')
       index = File.read(index_file)
       index.gsub!('<% plot_data %>', data.to_json)
 
@@ -91,7 +91,7 @@ def generate_details!(path, data)
         )
       end
 
-      index_file = File.join(path, 'sandi_meter', 'index.html')
+      index_file = File.join(path, 'index.html')
       index = File.read(index_file)
       index.gsub!('<% details %>', details)
 

diff --git a/lib/sandi_meter/logger.rb b/lib/sandi_meter/logger.rb
@@ -3,7 +3,7 @@
 module SandiMeter
   class Logger < Struct.new(:data)
     def log!(path)
-      File.open(File.join(path, 'sandi_meter', 'sandi_meter.log'), 'a') do |file|
+      File.open(File.join(path, 'sandi_meter.log'), 'a') do |file|
         file.puts(log_line)
       end
     end

diff --git a/spec/cli_spec.rb b/spec/cli_spec.rb
@@ -2,8 +2,21 @@
 require_relative '../lib/sandi_meter/cli'
 
 describe SandiMeter::CLI do
+  include FakeFS::SpecHelpers
+
   let(:cli) { SandiMeter::CLI }
+  let(:gem_root) { File.expand_path('../', File.dirname(__FILE__)) }
 
+  before do
+    FakeFS.activate!
+
+    FakeFS::FileSystem.clone(gem_root)
+  end
+
+  after do
+    FakeFS.deactivate!
+  end
+
   describe '#execute' do
     before do 
       @original_argv = ARGV
@@ -40,5 +53,34 @@
         expect { cli.execute }.to raise_error(SystemExit)
       end
     end
+
+    context 'output path passed in' do
+      let(:test_path) { '/test_out_dir/test2' }
+      before do
+        ARGV.push('-q')
+        ARGV.push('-g')
+        ARGV.push('-o')
+        ARGV.push(test_path)
+      end
+
+      it 'saves output files to specified output path' do
+        expect { cli.execute }.to raise_error(SystemExit)
+        expect(File.directory?(test_path)).to eq(true)
+      end
+    end
+
+    context 'output path not specified' do
+      before do
+        ARGV.push('-q')
+        ARGV.push('-g')
+        ARGV.push('-p')
+        ARGV.push('/')
+      end
+
+      it 'saves output files in sandi_meter folder relative to scanned path' do
+        expect { cli.execute }.to raise_error(SystemExit)
+        expect(File.directory?(File.expand_path('/sandi_meter'))).to eq(true)
+      end
+    end
   end
 end
diff --git a/spec/test_helper.rb b/spec/test_helper.rb
@@ -1,4 +1,21 @@
+require 'pry'
 require 'rspec/autorun'
 require 'ripper'
+require 'fakefs/spec_helpers'
+
+# silence CLI output
+RSpec.configure do |config|
+  original_stderr = $stderr
+  original_stdout = $stdout
+  config.before(:all) do
+    # Redirect stderr and stdout
+    $stderr = File.open(File::NULL, "w")
+    $stdout = File.open(File::NULL, "w")
+  end
+  config.after(:all) do
+    $stderr = original_stderr
+    $stdout = original_stdout
+  end
+end
 
 Dir["#{Dir.pwd}/spec/support/**/*.rb"].each { |f| require f }