Merge pull request whitesmith#113 from superiorlu/fix_and_refator_open_report_with_browser

add --no-browser options, refactor browser code

Author: Timo Rößner

features/command_line_interface/options.feature

@@ -29,7 +29,7 @@ Feature: Rubycritic can be controlled using command-line options
           -m, --mode-ci                    Use CI mode (faster, but only analyses last commit)
               --deduplicate-symlinks       De-duplicate symlinks based on their final target
               --suppress-ratings           Suppress letter ratings
-          -O, --open                       Open html report with browser: [:chrome, :chromium, :firefox, :safari]
+              --no-browser                 Do not open html report with browser
           -v, --version                    Show gem's version
           -h, --help                       Show this message
 

features/support/env.rb

@@ -16,7 +16,7 @@ def initialize
   end
 
   def rubycritic(args)
-    run_simple("rubycritic #{args}", false)
+    run_simple("rubycritic #{args}  --no-browser", false)
   end
 end
 

lib/rubycritic/browser.rb

@@ -1,22 +1,17 @@
-require 'rubycritic/platforms/linux'
-require 'rubycritic/platforms/darwin'
+require 'launchy'
 
 module Rubycritic
   class Browser
     attr_reader :report_path
 
-    SUPPORTS = Platforms::Linux::BROWSER_MAP.keys | Platforms::Darwin::BROWSER_MAP.keys
-
     def initialize(report_path)
       @report_path = report_path
     end
 
     def open
-      platform && platform.open(report_path)
-    end
-
-    def platform
-      @platform ||= [Platforms::Linux.new, Platforms::Darwin.new].find(&:can_open?)
+      Launchy.open(report_path) do |exception|
+        puts "Attempted to open #{report_path} and failed because #{exception}"
+      end
     end
   end
 end

lib/rubycritic/cli/options.rb

@@ -45,11 +45,8 @@ def parse
             @suppress_ratings = true
           end
 
-          opts.on('-O ', '--open',
-                  Rubycritic::Browser::SUPPORTS,
-                  "Open html report with browser: #{Rubycritic::Browser::SUPPORTS}"
-                 ) do |open_with|
-            @open_with = open_with
+          opts.on('--no-browser', 'Do not open html report with browser') do
+            @no_browser = true
           end
 
           opts.on_tail('-v', '--version', "Show gem's version") do
@@ -73,7 +70,7 @@ def to_h
           suppress_ratings: @suppress_ratings,
           help_text: @parser.help,
           minimum_score: @minimum_score || 0,
-          open_with: @open_with
+          no_browser: @no_browser
         }
       end
 

lib/rubycritic/configuration.rb

@@ -2,7 +2,7 @@ module Rubycritic
   class Configuration
     attr_reader :root
     attr_accessor :source_control_system, :mode, :format, :deduplicate_symlinks,
-                  :suppress_ratings, :open_with
+                  :suppress_ratings, :open_with, :no_browser
 
     def set(options)
       self.mode = options[:mode] || :default
@@ -11,6 +11,7 @@ def set(options)
       self.deduplicate_symlinks = options[:deduplicate_symlinks] || false
       self.suppress_ratings = options[:suppress_ratings] || false
       self.open_with = options[:open_with]
+      self.no_browser = options[:no_browser]
     end
 
     def root=(path)

lib/rubycritic/generators/html_report.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'rubycritic/configuration'
 require 'rubycritic/generators/html/overview'
 require 'rubycritic/generators/html/smells_index'
 require 'rubycritic/generators/html/code_index'
@@ -17,7 +18,7 @@ def generate_report
         create_directories_and_files
         copy_assets_to_report_directory
         puts "New critique at #{report_location}"
-        browser.open
+        browser.open unless Config.no_browser
       end
 
       def browser

lib/rubycritic/platforms/base.rb

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'reek', '3.9.1'
   spec.add_runtime_dependency 'parser', '~> 2.3'
   spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'launchy', '2.4.3'
 
   spec.add_development_dependency 'aruba'
   spec.add_development_dependency 'bundler', '~> 1.3'

lib/rubycritic/platforms/darwin.rb

@@ -1,67 +1,16 @@
 require 'test_helper'
 require 'rubycritic/browser'
-require 'rubycritic/platforms/linux'
-require 'rubycritic/platforms/darwin'
-require 'rubycritic/generators/html_report'
 
 describe Rubycritic::Browser do
   before do
     @report_path = 'tmp/rubycritic/overview.html'
     @browser = Rubycritic::Browser.new @report_path
   end
 
-  describe 'open report on different platform' do
-    context 'on linux' do
-      it 'open with default browser' do
-        Rubycritic::Config.set
-        Rubycritic::Browser.any_instance.stubs(:platform).returns(Rubycritic::Platforms::Linux.new)
-        @linux = @browser.platform
-        @linux.browser.must_equal 'firefox'
-      end
-
-      it 'open with google chrome browser ' do
-        Rubycritic::Config.stubs(:open_with).returns(:chrome)
-        Rubycritic::Browser.any_instance.stubs(:platform).returns(Rubycritic::Platforms::Linux.new)
-        @linux = @browser.platform
-        @linux.browser.must_equal 'google-chrome'
-      end
-
-      it 'open with chromium browser ' do
-        Rubycritic::Config.stubs(:open_with).returns(:chromium)
-        Rubycritic::Browser.any_instance.stubs(:platform).returns(Rubycritic::Platforms::Linux.new)
-        @linux = @browser.platform
-        @linux.browser.must_equal 'chromium-browser'
-      end
-    end
-
-    context 'on darwin' do
-      it 'open with default browser' do
-        Rubycritic::Browser.any_instance.stubs(:platform).returns(Rubycritic::Platforms::Darwin.new)
-        @darwin = @browser.platform
-        @darwin.browser.must_equal 'safari'
-      end
-
-      it 'open with google chrome browser ' do
-        Rubycritic::Config.stubs(:open_with).returns(:chrome)
-        Rubycritic::Browser.any_instance.stubs(:platform).returns(Rubycritic::Platforms::Darwin.new)
-        @darwin = @browser.platform
-        @darwin.browser.must_equal 'Google Chrome'
-      end
-
-      it 'open with firefox browser ' do
-        Rubycritic::Config.stubs(:open_with).returns(:firefox)
-        Rubycritic::Browser.any_instance.stubs(:platform).returns(Rubycritic::Platforms::Darwin.new)
-        @darwin = @browser.platform
-        @darwin.browser.must_equal 'firefox'
-      end
-    end
-
-    context 'on other platform' do
-      it 'not open with browser' do
-        Rubycritic::Browser.any_instance.stubs(:platform).returns(nil)
-        Rubycritic::Browser.any_instance.stubs(:report_path).returns('tmp/rubycritic/overview.html')
-        @browser.open.must_be_nil
-      end
+  describe '#open' do
+    it 'should be open report with launch browser' do
+      Launchy.stubs(:open).returns(true)
+      @browser.open.must_equal true
     end
   end
 end