inch 0.5.0.rc4 → 0.5.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 204a55bbfb702da63ab9b62d8e68b6e97b46d7e8
-  data.tar.gz: 9237fdad678102759b3924c464718181560de4d9
+  metadata.gz: 93877a4281619360271a03029ae4368cf71c7e57
+  data.tar.gz: f76a3b46211e7d258a41bef437839a56ee66826c
 SHA512:
-  metadata.gz: d5e38320c4c26fcbb2bf22f67fce5f5fc1d6c8d6acd4953e069f106b6440d31b531179284611be268b26bc8cad49cd3722b9f8dd48e669ef067fbbab07b5f79f
-  data.tar.gz: 0c5772bcc6822ef6652611ec82ec370cb5b1f7fb122078055bcb69a53ab6efefad5fa10aa15e29312cb21a9eb2035894f7d60d56e18b43a693f5f26d9780432a
+  metadata.gz: fb8cb6914e685eed7eb4b008757bf91d4ab56efe96e74b6d4faa57321cc9b75fb259a05b085ff6a90b34321e5f2d2d8b8c07b0cfbdc7df4d03a5ea6afb5b6b3c
+  data.tar.gz: 1804964c134ae38cf0108cdeeafe5809af0114da80b65d583a6edb2bf20f7070c38142a10fc532d0121c59900e91fb8542ac8467a0044f2fe2f6b551731e18bc

data/lib/inch/cli/command/base.rb

@@ -105,6 +105,7 @@ module Inch
           options_class = Command::Options.const_get(name)
           @options = options_class.new
           @options.usage = usage
+          @options.ui = ui
         end
 
         # Creates a Config::Codebase object and returns it

data/lib/inch/cli/command/options/base.rb

@@ -42,6 +42,8 @@ module Inch
           attribute :paths, []    # the paths of the to-be-analysed sources
           attribute :excluded, [] # paths to be excluded from the analysis
 
+          attr_accessor :ui
+
           # Parses the given +args+ "into" the current Options object
           #
           # @param args [Array<String>] command-line arguments

data/lib/inch/cli/command/output/base.rb

@@ -30,6 +30,11 @@ module Inch
             end
             echo separator
           end
+
+          # this is used to use Inch::Utils::BufferedIO
+          def ui
+            @options.ui
+          end
         end
       end
     end

data/lib/inch/cli/command/output/stats.rb

@@ -30,29 +30,29 @@ module Inch
             print_grades
             print_grades_by_priority
             print_priorities
-            puts
-            puts "Try `--format json|yaml` for raw numbers.".dark
+            ui.trace
+            ui.trace "Try `--format json|yaml` for raw numbers.".dark
           end
 
           def print_grades
             sparkline = grade_lists_sparkline(@grade_lists).to_s(" ")
-            puts
-            puts "Grade distribution: (undocumented, C, B, A)"
-            puts
-            puts "  Overall:  #{sparkline}  #{objects.size.to_s.rjust(5)} " \
+            ui.trace
+            ui.trace "Grade distribution: (undocumented, C, B, A)"
+            ui.trace
+            ui.trace "  Overall:  #{sparkline}  #{objects.size.to_s.rjust(5)} " \
               "objects"
-            puts
+            ui.trace
           end
 
           def print_grades_by_priority
-            puts "Grade distribution by priority:"
-            puts
+            ui.trace "Grade distribution by priority:"
+            ui.trace
             Evaluation::PriorityRange.all.each do |priority_range|
               list = objects.select { |o| priority_range.include?(o.priority) }
               sparkline = grades_sparkline(list).to_s(" ")
-              puts "        #{priority_range.arrow}   #{sparkline}  " \
+              ui.trace "        #{priority_range.arrow}   #{sparkline}  " \
                     "#{list.size.to_s.rjust(5)} objects"
-              puts
+              ui.trace
             end
           end
 
@@ -68,27 +68,27 @@ module Inch
             sparkline.format do |tick, _count, index|
               tick.color(PRIORITY_COLORS[index])
             end
-            puts "  #{grade_list.grade}:  " + sparkline.to_s(" ") +
+            ui.trace "  #{grade_list.grade}:  " + sparkline.to_s(" ") +
                   " #{grade_list.objects.size.to_s.rjust(5)} objects"
-            puts
+            ui.trace
           end
 
           def print_priorities
             arrows = Evaluation::PriorityRange.all.map(&:arrow)
-            puts "Priority distribution in grades: (low to high)"
-            puts
-            puts "      #{arrows.reverse.join("      ")}"
+            ui.trace "Priority distribution in grades: (low to high)"
+            ui.trace
+            ui.trace "      #{arrows.reverse.join("      ")}"
             @grade_lists.reverse.each do |grade_list|
               print_grade_list(grade_list)
             end
           end
 
           def display_json
-            puts JSON.pretty_generate(stats_hash)
+            ui.trace JSON.pretty_generate(stats_hash)
           end
 
           def display_yaml
-            puts YAML.dump(stats_hash)
+            ui.trace YAML.dump(stats_hash)
           end
 
           def stats_hash

data/lib/inch/cli/command/output/suggest.rb

@@ -48,9 +48,9 @@ module Inch
 
           def display_distribution
             sparkline = grades_sparkline(@relevant_objects).to_s(" ")
-            puts "Grade distribution (undocumented, C, B, A):  " + sparkline
-            puts
-            puts priority_filter_hint
+            ui.trace "Grade distribution (undocumented, C, B, A):  " + sparkline
+            ui.trace
+            ui.trace priority_filter_hint
           end
 
           def priority_filter_hint

data/lib/inch/cli/yardopts_helper.rb

@@ -26,8 +26,10 @@ module Inch
           arg =~ /^\-/ && !VALID_YARD_SWITCHES.include?(arg)
         end
 
-        ui.debug "Sending args to YARD:\n" \
+        if ui
+          ui.debug "Sending args to YARD:\n" \
               "  args: #{dupped_args}"
+        end
 
         wrapper.parse_arguments(*dupped_args)
 

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.5.0.rc4"
+  VERSION = "0.5.0.rc5"
 end

data/test/integration/cli/command/suggest_test.rb

@@ -1,4 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + "/../../../test_helper")
+require 'inch/utils/buffered_ui'
 
 describe ::Inch::CLI::Command::Suggest do
   before do
@@ -81,6 +82,15 @@ describe ::Inch::CLI::Command::Suggest do
     assert err.empty?, "there should be no errors"
   end
 
+  it "should not output anything to stdout when used with BufferedUI" do
+    ui = ::Inch::Utils::BufferedUI.new
+    out, err = capture_io do
+      @command.run(:ui => ui)
+    end
+    assert out.empty?, "there should be no output"
+    assert err.empty?, "there should be no errors"
+  end
+
   # Edge case: Really good codebase
 
   it "should run without args on really good fixture" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.0.rc4
+  version: 0.5.0.rc5
 platform: ruby
 authors:
 - René Föhring