xcperfect 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 856d2292fad7dc61c02839684c243049a2cf0f2f
-  data.tar.gz: 16f7d81e204f20d4d41a1aceb2579e48f063ae1e
+  metadata.gz: 2314ead27375f324020955f3715ab6857ba356cc
+  data.tar.gz: a1afc6fed3d96d64c6e36cc3c27bd2a0ac0be790
 SHA512:
-  metadata.gz: c81423d09bdeb9efe680980b4ace5ed652a564beeba4350d86e0a4103f031f654c8e7c27868ad4b3cdfa0d7fe102aa70a10cf0913bd0a3c33bc19c5f04a3faaa
-  data.tar.gz: b4f2343bf2b639e49a333c55727076bec0b5fda734244981ef68a6ae5eb37f06379b16b6d7571c1119f286f1dabcef455a1c977abf6f4370cc3d33947d04c0d7
+  metadata.gz: 69876044da3ecb662dc85ba25e4ceca6c18f8e0efe2db6d4533eb122f1767f7a36b7ab685c98a66a113f162a80526e7a0523cb3492bfada61f5dacb2c762bc40
+  data.tar.gz: 57b14bc960f08de8e4b0e36ce62ef33ed13828ab9405874d9b7fa00d98951f4646ccb7c72c95ab5d4517c326a7d7d553f936632a8cd22fa7f7e227a6547f30c3

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/README.md

@@ -5,6 +5,9 @@
     <a href="https://travis-ci.org/mkchoi212/xcperfect">
       <img src="https://travis-ci.org/mkchoi212/xcperfect.svg?branch=master">
     </a>
+    <a href="https://badge.fury.io/rb/xcperfect">
+      <img src="https://badge.fury.io/rb/xcperfect.svg">
+    </a>
   </p>
 </p>
 <br>
@@ -17,23 +20,20 @@ $ gem install xcperfect
 
 ## Usage
 
-```bash
-$ xcrun xccov --json [options] | xcperfect
-```
-
-or 
+- Pipe
 
 ```bash
-$ xcrun xccov --json [options] > report.json
-$ xcperfect report.json
+$ xcrun xccov --json [options] | xcperfect [options]
 ```
 
-or
+- Feed it in via flags
 
 ```bash
 $ xcperfect [--file | -f] report.json [options]
 ```
 
+> ⚠️ Please note that `xcperfect` only takes in `xccov` json output
+
 ## Formats
 
 - `--all`, `-a` **Default**

data/lib/xcperfect.rb

@@ -1,3 +1,4 @@
+require 'xcperfect/bar'
 require 'xcperfect/version'
 require 'xcperfect/printer'
 require 'xcperfect/parser'

data/lib/xcperfect/ansi.rb

@@ -27,6 +27,19 @@ module XCPerfect
       !!@colorize
     end
 
+    def color_for(percentage)
+      case (percentage * 100).round
+      when 0..33
+        ->(x) { red(x) }
+      when 33...66
+        ->(x) { yellow(x) }
+      when 66..100
+        ->(x) { green(x) }
+      else
+        raise "Percentage of #{percentage * 100} is not possible"
+      end
+    end
+
     def white(text)
       ansi_parse(text, :plain, :bold)
     end

data/lib/xcperfect/bar.rb

@@ -0,0 +1,24 @@
+require 'xcperfect/ansi'
+
+module XCPerfect
+  # Bar is a "progress bar" that is used to represent
+  # the code coverage percentage
+  class Bar
+    BLOCK = '█'.freeze
+    BLOCK_ASCII = '#'.freeze
+    extend ANSI
+
+    def self.create(percentage, bar_length, color, ascii)
+      @colorize = color
+      block_symbol = ascii ? BLOCK_ASCII : BLOCK
+
+      progress_length = (bar_length * percentage).round
+      filled = block_symbol * progress_length
+      remaining = red('-' * (bar_length - progress_length))
+
+      color_func = color_for(percentage)
+      bar = color_func.call(filled) + remaining
+      "|#{bar}| #{percentage * 100} %"
+    end
+  end
+end

data/lib/xcperfect/formatters/all.rb

@@ -3,6 +3,15 @@ module XCPerfect
   class All < Formatter
     DOWN = '▼'.freeze
     DOWN_ASCII = '->'.freeze
+    STAT_WIDTH = 10
+
+    def bar_width
+      ((@terminal_width - 8) * 0.3) - STAT_WIDTH
+    end
+
+    def signature_width
+      (@terminal_width - 8) * 0.62
+    end
 
     def pretty_name(target)
       symbol = yellow(@use_ascii ? DOWN_ASCII : DOWN)
@@ -12,21 +21,25 @@ module XCPerfect
     def pretty_functions(file)
       file['functions'].map do |function|
         filename = file['name']
-        signature, covered, total, percentage = pretty_coverage_info(function)
-        line_stat = [covered, total].join(' / ').ljust(10)
-        stats = [line_stat, percentage].join("\t\t")
+        signature, covered, total, percentage = @parser.extract_coverage_info(function)
+
+        line_stats = "#{covered} / #{total}".ljust(STAT_WIDTH)
         highlighted = Syntax.highlight(filename, signature)
+
         delta = highlighted.length - signature.length
-        fill_size = (@terminal_width / 1.5) + delta
-        "\t\t" + [highlighted.ljust(fill_size), stats].join(' ')
+        highlighted = highlighted.ljust(signature_width + delta)
+
+        texts = spaces(8) + [highlighted, line_stats].join(' ')
+        bar = Bar.create(percentage, bar_width, @colorize, @use_ascii)
+        texts + bar
       end
     end
 
     def pretty_files(target)
       target['files'].map do |file|
-        name = "\t" + pretty_name(file)
-        function = pretty_functions(file)
-        [name, function]
+        name = spaces(4) + pretty_name(file)
+        functions = pretty_functions(file)
+        [name, functions]
       end.join("\n")
     end
 

data/lib/xcperfect/formatters/formatter.rb

@@ -1,4 +1,5 @@
 require 'xcperfect/ansi'
+require 'xcperfect/bar'
 require 'xcperfect/parser'
 
 module XCPerfect
@@ -19,19 +20,14 @@ module XCPerfect
       puts @json
     end
 
-    def color_percentage(percentage)
-      percent_str = percentage.to_s + ' %'
+    def spaces(cnt)
+      ' ' * cnt
+    end
 
-      case percentage.round
-      when 0..33
-        red(percent_str)
-      when 33...66
-        orange(percent_str)
-      when 66..100
-        green(percent_str)
-      else
-        raise "Percentage of #{percentage} % is not possible :("
-      end
+    def color_percentage(percentage)
+      color_func = color_for(percentage)
+      str_rep = (percentage * 100).to_s + ' %'
+      color_func.call(str_rep)
     end
 
     def pretty_coverage_info(target)

data/lib/xcperfect/parser.rb

@@ -39,7 +39,7 @@ module XCPerfect
     end
 
     def coverage_percentage(target)
-      (target['lineCoverage'] * 100).round(2)
+      target['lineCoverage'].round(2)
     end
 
     def covered_line_num(target)

data/lib/xcperfect/printer.rb

@@ -1,5 +1,3 @@
-require 'xcperfect/ansi'
-
 module XCPerfect
   # Printer handles the initialization of the output formatter
   # and is directly called by the main `xcperfect` file during execution

data/lib/xcperfect/version.rb

@@ -1,5 +1,5 @@
 # VERSION is used in the `Gemfile`, and when displaying the
 # version to the user via `xcperfect -v`
 module XCPerfect
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/xcperfect.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
   spec.description =
     %q{
-    Formatter for Apple's xccov json output because who doesn't
+    Make your xccov output prettier. Because who doesn't
     like pretty outputs? Am I rite?
     }
-  spec.summary       = %q(Make your xccov outputs prettier)
+  spec.summary       = %q(Better looking xccov reports)
   spec.homepage      = 'https://github.com/mkchoi212/xcperfect'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcperfect
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Mike JS. Choi
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.49.0
-description: "\n    Formatter for Apple's xccov json output because who doesn't\n
-  \   like pretty outputs? Am I rite?\n    "
+description: "\n    Make your xccov output prettier. Because who doesn't\n    like
+  pretty outputs? Am I rite?\n    "
 email:
 - mkchoi212@icloud.com
 executables:
@@ -76,6 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
@@ -89,6 +90,7 @@ files:
 - bin/xcperfect
 - lib/xcperfect.rb
 - lib/xcperfect/ansi.rb
+- lib/xcperfect/bar.rb
 - lib/xcperfect/formatters/all.rb
 - lib/xcperfect/formatters/formatter.rb
 - lib/xcperfect/formatters/simple.rb
@@ -120,5 +122,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Make your xccov outputs prettier
+summary: Better looking xccov reports
 test_files: []