aidir 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7742d491ef0024bf96b42dc5702247322aa561cd
-  data.tar.gz: 77c3484dff8c9d897fec772ab81c39824c2b5bfd
+  metadata.gz: 3c2de8e8218ddccab613724408ddc4ecd97fcefb
+  data.tar.gz: cbaedbc1e39afd759eb67dd1d03226b633ea91d7
 SHA512:
-  metadata.gz: 8a567fe9d09b8326ba6458f25c6933564c1f831ab6deb118f5711a6fb387585fd70190d55544ed3f8e2cb0c6985194c0ddd7487497ac52242d0e8c31e818e800
-  data.tar.gz: 4816f092e78393dac48ea363ef4dffea115d70583f71eb34926f8c44b4401172bfcc96a7a6a6facacf6bc6ace49e1d2a9e53346e0795fc00717fa480657dd88b
+  metadata.gz: 85e838414ca0856f4edc386fc3be3a006a7a5d1f40d32f70fe93c062939882a33ab91fbf27265b70c94e116d6590a5b704558b33b38e4c77fa5cd9f86b723ed4
+  data.tar.gz: b9c8f0cf400e9d4f2d1a1cc52fadb9b131576e692b2a1a9f0f90d0e8587547f480b0d6eee25dfbd0da4f7bd4d0aae3598f7bb61f8cb6b4eb07ad75698c2ef4f0

data/lib/aidir.rb

@@ -1,5 +1,6 @@
 require_relative 'aidir/git'
 require_relative 'aidir/flog'
+require_relative 'aidir/formatter'
 require_relative 'aidir/scoreboard'
 require 'open3'
 
@@ -28,8 +29,7 @@ class Aidir
     git.clear_cached_files
 
     scoreboard = Scoreboard.new(@results)
-    output = scoreboard.results
-    print output
+    print scoreboard.results
   end
 
 end

data/lib/aidir/formatter.rb

@@ -0,0 +1,105 @@
+class Formatter
+
+  def caption(title)
+    "\n--- #{colors[:cyan]}#{title}#{color_end} ---\n"
+  end
+
+  def table_header(col1, col2, col3)
+    sprintf(format[:header], col1, col2, col3)
+  end
+
+  def method_row(method, info)
+    current = info[:current]
+    if info[:flag]
+      contents = preformat_flag(info[:flag])
+    else
+      contents = preformat_delta(info[:delta])
+    end
+    sprintf(format[:method_row], contents, preformat_current(current), method)
+  end
+
+  def file_row(metric, info)
+    filename = info[:file]
+    delta = info[:delta]
+    if metric == 'flog total'
+      current = preformat_file_total(info[:current])
+    elsif metric == 'flog/method average'
+      current = preformat_file_avg(info[:current])
+    end
+    sprintf(format[:method_row], preformat_delta(delta), current, filename)
+  end
+
+  private
+
+  # Preformatters
+
+  def preformat_current(score)
+    sprintf(format[:current], method_color(score), score, color_end)
+  end
+
+  def preformat_delta(score)
+    sprintf(format[:delta], delta_color(score), score, color_end)
+  end
+
+  def preformat_flag(flag)
+    sprintf(format[:flag], flag)
+  end
+
+  def preformat_file_total(score)
+    sprintf(format[:current], '', score, '')
+  end
+
+  def preformat_file_avg(score)
+    sprintf(format[:current], method_color(score), score, color_end)
+  end
+
+  # Format strings
+
+  def format
+    @format ||= {
+      header:     "%18s%10s   %-90s\n",
+      delta:      "%s%18.1f%s",
+      current:    "%s%10.1f%s",
+      method_row: "%s%s   %-90s\n",
+      flag:       "%18s",
+    }
+  end
+
+  # Score coloring logic
+
+  def delta_color(score)
+    delta_score_thresholds = [0, 5]
+    score_color(score, delta_score_thresholds)
+  end
+
+  def method_color(score)
+    method_score_thresholds = [20, 40]
+    score_color(score, method_score_thresholds)
+  end
+
+  def score_color(score, thresholds)
+    if score < thresholds[0]
+      colors[:green]
+    elsif score < thresholds[1]
+      colors[:yellow]
+    else
+      colors[:red]
+    end
+  end
+
+  # ASCII rainbows and unicorns go here
+
+  def colors
+    @colors ||= {
+      cyan:   "\033[36m",
+      red:    "\033[31m",
+      yellow: "\033[33m",
+      green:  "\033[32m"
+    }
+  end
+
+  def color_end
+    @color_end ||= "\033[0m"
+  end
+
+end

data/lib/aidir/scoreboard.rb

@@ -2,16 +2,17 @@ class Scoreboard
 
   def initialize(raw_data)
     @raw_data = raw_data
-    @diff_data = {}
+    @delta_data = {}
     @file_data = {}
     @method_data = {}
     @output = ''
+    @formatter = Formatter.new
   end
 
   def results
     get_relevant_scores
     if @method_data.empty?
-      print_no_diffs
+      print_no_deltas_found
       return
     end
     print_method_board
@@ -21,144 +22,40 @@ class Scoreboard
 
   private
 
+  def file_keys
+    @file_keys ||= [
+      'flog total',
+      'flog/method average'
+    ]
+  end
+
   def get_relevant_scores
-    get_diffs
+    get_deltas
     split_scores_by_type
     sort_scores
   end
 
-  def diff_format
-    @diff_format ||= "%s%18.1f%s"
-  end
-
-  def current_format
-    @current_format ||= "%s%10.1f%s"
-  end
-
-  def diff_output(score)
-    sprintf(diff_format, diff_prefix(score), score, color_end)
-  end
-
-  def current_output(score)
-    sprintf(current_format, current_prefix(score), score, color_end)
-  end
-
-  def total_current_output(score)
-    sprintf(current_format, "", score, "")
-  end
-
-  def avg_current_output(score)
-    sprintf(current_format, current_prefix(score), score, color_end)
-  end
-
-  def head_format
-    @head_format ||= "%18s%10s   %-90s\n"
-  end
-
-  def print_method_board
-    @output << "--- #{cyan_start}METHOD SCORES#{color_end} ---\n"
-
-    @output << sprintf(head_format, "Diff from master", "Current", "Method")
-    format = "%s%s   %-90s\n"
-
-    @method_data.each do |method, info|
-      current = info[:current]
-      unless info[:flag]
-        diff = info[:diff]
-        @output << sprintf(format, diff_output(diff), current_output(current), method)
-      else
-        flag_output = sprintf("%18s", info[:flag].to_s)
-        @output << sprintf(format, flag_output, current_output(current), method)
-      end
-    end
-  end
-
-  def print_file_board
-    @output << "--- #{cyan_start}FILE SCORES#{color_end} ---\n"
-
-    @output << sprintf(head_format, "Diff from master", "Current", "Method")
-    format = "%s%s   %-90s\n"
-
-    @file_data.each do |metric, files|
-      @output << sprintf("%-18s\n", "#{cyan_start}#{metric}#{color_end}")
-      files.each do |file|
-        filename = file[:file]
-        diff = file[:diff]
-        current = file[:current]
-        if metric == "flog total"
-          @output << sprintf(format, diff_output(diff), total_current_output(current), filename)
-        else
-          @output << sprintf(format, diff_output(diff), avg_current_output(current), filename)
-        end
-      end
-    end
-  end
-
-  def print_no_diffs
-    @output << "#{cyan_start}No changes detected#{color_end}\n"
-  end
-
-  def diff_prefix(score)
-    if score < 0
-      green_start
-    elsif score < 5
-      yellow_start
-    else
-      red_start
-    end
-  end
-
-  def current_prefix(score)
-    if score < 20
-      green_start
-    elsif score < 40
-      yellow_start
-    else
-      red_start
-    end
-  end
-
-  def cyan_start
-    "\033[36m"
-  end
-
-  def red_start
-    "\033[31m"
-  end
-
-  def yellow_start
-    "\033[33m"
-  end
-
-  def green_start
-    "\033[32m"
-  end
-
-  def color_end
-    "\033[0m"
-  end
-
   def split_scores_by_type
-    @method_data = @diff_data
+    @method_data = @delta_data
     file_keys.each do |key|
       @file_data[key] = @method_data.delete(key)
     end
   end
 
-  def get_diffs
+  def get_deltas
     @raw_data.each do |file, lines|
       lines.each do |metric, scores|
-        score = diff(scores[:branch], scores[:master])
+        score = calc_diff(scores[:branch], scores[:master])
         next if score == 0.0
-        @diff_data[metric] ||= []
+        @delta_data[metric] ||= []
         flag = nil
         if [:new, :deleted].include?(score)
           flag = score
           score = 0.0
         end
-        @diff_data[metric] << {
+        @delta_data[metric] << {
           file: file,
-          diff: score,
+          delta: score,
           current: scores[:branch],
           flag: flag
         }
@@ -169,13 +66,13 @@ class Scoreboard
   def sort_scores
     return if @method_data.empty?
     file_keys.each do |key|
-      @file_data[key].sort_by! { |f| -f[:diff] }
+      @file_data[key].sort_by! { |f| -f[:delta] }
     end
-    sorted_methods = @method_data.sort_by { |_, data| -data[0][:diff] }.flatten
+    sorted_methods = @method_data.sort_by { |_, data| -data[0][:delta] }.flatten
     @method_data = Hash[*sorted_methods]
   end
 
-  def diff(branch, master)
+  def calc_diff(branch, master)
     if master and branch
       (branch - master).round(2)
     elsif branch
@@ -185,11 +82,27 @@ class Scoreboard
     end
   end
 
-  def file_keys
-    [
-      'flog total',
-      'flog/method average'
-    ]
+  def print_method_board
+    @output << @formatter.caption('METHOD SCORES')
+    @output << @formatter.table_header('Diff from master', 'Current', 'Method')
+
+    @method_data.each do |method, info|
+      @output << @formatter.method_row(method, info)
+    end
+  end
+
+  def print_file_board
+    @file_data.each do |metric, files|
+      @output << @formatter.caption("FILE #{metric} SCORES")
+      @output << @formatter.table_header('Diff from master', 'Current', 'File')
+      files.each do |file_info|
+        @output << @formatter.file_row(metric, file_info)
+      end
+    end
+  end
+
+  def print_no_deltas_found
+    print @formatter.caption('No changes detected')
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aidir
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Adomas Sliužinskas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flog
@@ -38,9 +38,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.2
-description: 'aidir - Am I Doing It Right: track and improve your Flog (http://ruby.sadi.st/Flog.html)
-  score before merging code to master by getting Flog score differences between current
-  branch and master branch'
+description: 'aidir - Am I Doing It Right: track and improve your Flog score before
+  merging code to master by getting Flog score differences between current branch
+  and master branch'
 email: adomas.sliuzinskas@gmail.com
 executables:
 - aidir
@@ -49,6 +49,7 @@ extra_rdoc_files: []
 files:
 - lib/aidir.rb
 - lib/aidir/flog.rb
+- lib/aidir/formatter.rb
 - lib/aidir/git.rb
 - lib/aidir/scoreboard.rb
 - bin/aidir