uicov 0.0.1

data/lib/uicov/commands/merge.rb

@@ -0,0 +1,95 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class Merge < Command
+    DEFAULT_FILENAME = 'merged.uic'
+    OPTIONS = {
+      '--merged-file=FILE' => "File to store merged coverage [default is '#{DEFAULT_FILENAME}']",
+      # '--no-transitions' => 'Do not merge transitions coverage',
+      # '--no-actions    ' => 'Do not merge actions coverage',
+      # '--no-checks     ' => 'Do not merge checks coverage',
+      # '--no-elements   ' => 'Do not merge elements coverage'
+    }
+    USAGE_INFO = %Q^[options] template.uic file1.uic [file2.uic ... fileN.uic]
+      \n\rWhere options are:
+      #{OPTIONS.inject([]){|a, e| a << "\r\t#{e[0]}\t- #{e[1]}"; a}.join("\n")}
+    ^
+
+    def initialize
+      @merged_file = DEFAULT_FILENAME
+    end
+
+    def do_job(args)
+      usage 'Missed coverage file', USAGE_INFO if args.empty?
+      cov_files = process_args args
+      merge(cov_files)
+      @merged.save(@merged_file)
+    end
+
+    def merge(cov_files)
+      Log.warn 'Only one file is given. Nothing to merge.' if cov_files.size == 1
+      @merged = CovData.load cov_files[0]
+      cov_files[1..-1].each do |cov_file|
+        @cd = CovData.load cov_file
+        @cd.screens.each do |name, screen_data|
+          msd = @merged.screens[name]
+          if msd.nil?
+            @merged.screens[name] = screen_data.dup
+          else
+            merge_screen_data msd, screen_data
+          end
+        end
+        @merged.input_files.merge! @cd.input_files
+      end
+      return @merged
+    end
+
+    private
+    def process_args(args)
+      merged_file_option = args.grep(/--merged-file=.*/)[0]
+      if merged_file_option
+        @merged_file = File.expand_path merged_file_option.gsub(/.*=(.+)/, '\1')
+        args.delete_if { |e| e == merged_file_option }
+      end
+      return args
+    end
+
+    def merge_screen_data(msd, sd)
+      sd.elements.each do |name, sde|
+        me = msd.elements[name]
+        if me.nil?
+          msd.elements[name] = sde.dup
+        else
+          me.hit(sde.hits)
+        end
+      end
+      sd.transitions.each do |name, sde|
+        me = msd.transitions[name]
+        if me.nil?
+          msd.transitions[name] = sde.dup
+        else
+          me.hit(sde.hits)
+        end
+      end
+      sd.actions.each do |name, sde|
+        me = msd.actions[name]
+        if me.nil?
+          msd.actions[name] = sde.dup
+        else
+          me.hit(sde.hits)
+        end
+      end
+      sd.checks.each do |name, sde|
+        me = msd.checks[name]
+        if me.nil?
+          msd.checks[name] = sde.dup
+        else
+          me.hit(sde.hits)
+        end
+      end
+    end
+  end
+end
+

data/lib/uicov/commands/report.rb

@@ -0,0 +1,119 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class Report < Command
+    DEFAULT_FILENAME = 'uicov.report.html'
+    OPTIONS = {
+      '--report-file=FILE' => "File to store report [default is '#{DEFAULT_FILENAME}']",
+      # '--format=FORMAT  ' => 'Report format. One of: html, puml [default is "html"]',
+      # '--no-transitions ' => 'Do not report transitions coverage',
+      # '--no-actions     ' => 'Do not report actions coverage',
+      # '--no-checks      ' => 'Do not report checks coverage',
+      # '--no-elements    ' => 'Do not report elements coverage'
+    }
+    USAGE_INFO = %Q^[options] file1.uic [file2.uic ... fileN.uic]
+      \n\rWhere options are:
+      #{OPTIONS.inject([]){|a, e| a << "\r\t#{e[0]}\t- #{e[1]}"; a}.join("\n")}
+    ^
+
+    def initialize
+      @report_file = DEFAULT_FILENAME
+    end
+
+    def do_job(args)
+      usage 'Missed coverage file', USAGE_INFO if args.empty?
+      cov_files = process_args args
+      @cd = merged_file(cov_files)
+      @html = ''
+      @html << add_header
+      @html << create_summary_report
+      @html << create_screens_summary_report
+      @html << create_per_screen_report
+      save @report_file
+    end
+
+    private
+    def process_args(args)
+      report_file_option = args.grep(/--report-file=.*/)[0]
+      if report_file_option
+        @report_file = File.expand_path report_file_option.gsub(/.*=(.+)/, '\1')
+        args.delete_if { |e| e == report_file_option }
+      end
+      return args
+    end
+
+    def merged_file(cov_files)
+      cov_files.size > 1 ? Merge.new.merge(cov_files) : CovData.load(cov_files.first)
+    end
+
+    def add_header
+      %Q^
+<style>
+.covtable{
+  border: thin solid black;
+  text-align: left;
+}
+BODY,TABLE {font-size: small}
+H2{text-align:center;}
+TH{border:thin solid black;text-align:center; background-color: #CCCCCC}
+TD{border:thin solid black;text-align:right}
+TD.namecol{border:thin solid black;text-align:left}
+CAPTION{text-align: left; font-weight: bold}
+</style>
+      ^
+    end
+
+    def create_summary_report
+      %Q^
+        <h1>Summary Report</h1>
+      ^
+    end
+
+    def create_screens_summary_report
+      # tr_line1 = "<tr><td><b>%s</b></td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>"
+      tr_line2 = "<tr>
+        <td class='namecol'><b>%s</b></td>
+        <td>%s</td><td>%s</td><td>%s</td>
+        <td>%s</td><td>%s</td><td>%s</td>
+        <td>%s</td><td>%s</td><td>%s</td>
+        <td>%s</td><td>%s</td><td>%s</td>
+      </tr>"
+      str_res = %Q^
+        <h1>Screens Summary Report</h1>
+        <table width='80%'>
+        <tr><th rowspan='2'>Screen</th><th colspan='3'>Elements</th><th colspan='3'>Transitions</th><th colspan='3'>Actions</th><th colspan='3'>Checks</th></tr>
+        <tr><th>Hit</th><th>All</th><th>%</th><th>Hit</th><th>All</th><th>%</th><th>Hit</th><th>All</th><th>%</th><th>Hit</th><th>All</th><th>%</th></tr>
+      ^
+      total = @cd.screens.inject([0,0,0, 0,0,0, 0,0,0, 0,0,0]) do |arr, pair|
+        name, screen = pair
+        ec = [screen.get_count(:elements, true), screen.get_count(:elements), screen.get_coverage(:elements)]
+        tc = [screen.get_count(:transitions, true), screen.get_count(:transitions), screen.get_coverage(:transitions)]
+        ac = [screen.get_count(:actions, true), screen.get_count(:actions), screen.get_coverage(:actions)]
+        cc = [screen.get_count(:checks, true), screen.get_count(:checks), screen.get_coverage(:checks)]
+        str_res << tr_line2 % [name, *ec, *tc, *ac, *cc]
+        arr
+      end
+      str_res << %Q^
+        #{tr_line2 % ['Total', *total]}
+        </table>
+      ^
+    end
+    #{@cd.screens.keys.map{|k| "#{tr_line % [k,'','','','']}".join("\n")}
+
+    def create_per_screen_report
+      %Q^
+        <h1>Detailed Report</h1>
+        #{@cd.screens.values.map{ |s| s.report }.join("\n")}
+      ^
+    end
+
+    def save(filename)
+      report_file = File.expand_path filename
+      File.open(report_file, 'w'){|f| f.write(@html)}
+      Log.info "Result saved into file #{report_file}"
+    end
+  end
+end
+

data/lib/uicov/consts.rb

@@ -0,0 +1,78 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  GEM_TESTS_DIR = "#{GEM_HOME}/test"
+  GEM_TESTS_DATA_DIR = "#{GEM_TESTS_DIR}/data"
+  GEM_LIB_DIR = "#{GEM_HOME}/lib/uicov"
+
+  require "#{GEM_LIB_DIR}/ruby_patches"
+  require "#{GEM_LIB_DIR}/version"
+  
+  require "#{GEM_LIB_DIR}/commands/command"
+  require "#{GEM_LIB_DIR}/main"
+  
+  require "#{GEM_LIB_DIR}/coverage/types"
+  require "#{GEM_LIB_DIR}/coverage/data"
+  require "#{GEM_LIB_DIR}/coverage/member_data"
+  require "#{GEM_LIB_DIR}/coverage/transition_data"
+  require "#{GEM_LIB_DIR}/coverage/action_data"
+  require "#{GEM_LIB_DIR}/coverage/check_data"
+  require "#{GEM_LIB_DIR}/coverage/element_data"
+  require "#{GEM_LIB_DIR}/coverage/screen_data"
+
+  require "#{GEM_LIB_DIR}/opts"
+  require "#{GEM_LIB_DIR}/coverage_info"
+  require "#{GEM_LIB_DIR}/screen_info"
+  require "#{GEM_LIB_DIR}/transition_info"
+  require "#{GEM_LIB_DIR}/coverage_data"
+  require "#{GEM_LIB_DIR}/ui_coverage"
+
+  Log = Logger.new STDOUT
+  Log.level = Logger::DEBUG
+
+  SKIN_PARAMS=%q^
+skinparam state {
+  FontSize 10
+  AttributeFontSize 10
+
+  BackgroundColor #FCFCFC
+  BorderColor #C0C0C0
+  FontColor #808080
+  ArrowColor #C0C0C0
+  AttributeFontColor #808080
+  ArrowFontColor #808080
+
+  BackgroundColor<<Covered>> #CCFFCC
+  BorderColor<<Covered>> #008800
+  FontColor<<Covered>> #004400
+  AttributeFontColor<<Covered>> #004400
+
+  BackgroundColor<<Missed>> #FFEE88
+  BorderColor<<Missed>> #FF8800
+  FontColor<<Missed>> #886622
+  AttributeFontColor<<Missed>> #886622
+}
+^
+
+  LEGEND=%q^
+state Legend {
+    state "Uncovered Screen from Model" as UncoveredScreen
+    UncoveredScreen -> CoveredScreen : uncovered_transition {0, 0}
+    state "Covered screen from Model" as CoveredScreen<<Covered>>
+    CoveredScreen -[#orange]-> MissedScreen : <font color=orange><b>UNKNOWN</b></font> {1, 1} - covered transition missed in Model
+    CoveredScreen : <b>covered_action_with_3_calls_from_2_tests</b> {3, 2}
+    CoveredScreen : <font color=orange><b>covered_action_missed_in_model</b></font> {1, 1}
+    state "Screen missed in Model" as MissedScreen<<Missed>>
+    CoveredScreen -[#green]-> CoveredScreen : <font color=green><b>covered_transition_to_self</b></font> {1, 1}
+    MissedScreen : uncovered_action {0, 0}
+    MissedScreen : <b>covered_action_missed_in_model</b> {1, 1}
+    state "Another Covered Screen from Model" as AnotherCoveredScreen<<Covered>>
+    MissedScreen -left[#blue]-> AnotherCoveredScreen : <font color=blue><b>DEEP_LINK</b></font> {1, 1}
+    AnotherCoveredScreen -[#green]-> CoveredScreen : <font color=green><b>covered_transition</b></font> {1, 1}
+    CoveredScreen --> AnotherCoveredScreen : <font color=red>NOT_SET</font> {0, 0} - missed transition name in Model
+    AnotherCoveredScreen : uncovered_action {0 ,0}
+}
+^
+end

data/lib/uicov/coverage/action_data.rb

@@ -0,0 +1,8 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class ActionData < MemberData
+  end
+end

data/lib/uicov/coverage/check_data.rb

@@ -0,0 +1,8 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class CheckData < MemberData
+  end
+end

data/lib/uicov/coverage/data.rb

@@ -0,0 +1,45 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class CovData
+    attr_reader :screens, :input_files
+    attr_accessor :type
+
+    def self.load(filename)
+      YAML.load_file(filename)
+    end
+
+    def initialize(cov_file=nil)
+      @type = CoverageDataType::UNKNOWN
+      @input_files = {}
+      @screens = {}
+      load(cov_file) unless cov_file.nil?
+    end
+
+    def set_processing_date(date=Time.now)
+      @data_gathered_at = date.strftime('%F %R:%S.%3N')
+    end
+
+    def add_screen(name)
+      @screens[name] ||= ScreenData.new name
+    end
+
+    def add_covered_screen(name)
+      scd = add_screen name
+      scd.hit
+      return scd
+    end
+
+    def add_input_file(filename, filedate)
+      @input_files[filename] = filedate
+    end
+
+    def save(filename)
+      File.open(filename, 'w') { |f| f.write YAML.dump(self) }
+      Log.info "Result saved to '#{File.expand_path(filename)}'"
+    end
+  end
+end
+

data/lib/uicov/coverage/element_data.rb

@@ -0,0 +1,8 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class ElementData < MemberData
+  end
+end

data/lib/uicov/coverage/member_data.rb

@@ -0,0 +1,18 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class MemberData
+    attr_reader :display_name, :hits
+    def initialize(name)
+      @display_name = name
+      @hits = 0
+    end
+
+    def hit(increment=1)
+      @hits += increment
+    end
+  end
+end
+

data/lib/uicov/coverage/screen_data.rb

@@ -0,0 +1,109 @@
+#=======
+# Author: Alexey Lyanguzov (budabum@gmail.com)
+#=======
+
+module UICov
+  class ScreenData
+    attr_reader :elements, :transitions, :actions, :checks
+    def initialize(name)
+      @name = name
+      @hits = 0
+      @elements = {}
+      @transitions = {}
+      @actions = {}
+      @checks = {}
+    end
+
+    def hit
+      @hits += 1
+    end
+
+    def add_transition(name, to)
+      tr_key = TransitionData.get_key(name, to)
+      transitions[tr_key] ||= TransitionData.new name, to
+    end
+
+    def add_covered_transition(name, to)
+      add_transition(name, to).hit
+    end
+
+    def add_action(name)
+      actions[name] ||= ActionData.new name
+    end
+
+    def add_covered_action(name)
+      add_action(name).hit
+    end
+
+    def add_check(name)
+      checks[name] ||= CheckData.new name
+    end
+
+    def add_covered_check(name)
+      add_check(name).hit
+    end
+
+    def add_element(name)
+      elements[name] ||= ElementData.new name
+    end
+
+    def add_covered_element(name)
+      add_element(name).hit
+    end
+
+    def report
+      %Q^
+<h2>Screen: <span>#{@name}</span></h2>
+<h3>Coverage summary</h3>
+#{report_members_summary 'elements' unless elements.empty?}
+#{report_members_summary 'transitions' unless transitions.empty?}
+#{report_members_summary 'actions' unless actions.empty?}
+#{report_members_summary 'checks' unless checks.empty?}
+<h3>Coverage details</h3>
+#{report_members 'elements' unless elements.empty?}
+#{report_members 'transitions' unless transitions.empty?}
+#{report_members 'actions' unless actions.empty?}
+#{report_members 'checks' unless checks.empty?}
+<hr/>
+      ^
+    end
+
+    def get_coverage(members_name)
+      members = instance_variable_get("@#{members_name}")
+      uncovered = members.values.select{|e| e.hits == 0}
+      cov = ((members.size.to_f - uncovered.size) / members.size) * 100
+      return cov.nan? ? 100.0 : cov.round(2)
+    end
+
+    def get_count(members_name, hitted=false)
+      members = instance_variable_get("@#{members_name}")
+      if hitted
+        members.values.keep_if{ |e| 0 < e.hits}.size
+      else
+        members.size
+      end
+    end
+
+    private
+    def report_members(members_name)
+      members = instance_variable_get("@#{members_name}")
+      %Q^
+<table class='covtable' width='25%'>
+<thead><caption>#{members_name.capitalize}:</caption></thead>
+<tbody>
+<tr><th>Name</th><th>Hits</th></tr>
+#{members.values.map{|e| "<tr><td class='namecol'>#{e.display_name}</td><td>#{e.hits}</td></tr>"}.join("\n") }
+</tbody>
+</table>
+<br/>
+      ^
+    end
+
+    def report_members_summary(members_name)
+      coverage = get_coverage members_name
+      %Q^
+<div>#{members_name.capitalize}: #{coverage}%</div>
+      ^
+    end
+  end
+end