analyst 0.13.1 → 0.14.0

data/lib/analyst/fukuzatsu/formatters/base.rb

@@ -1,33 +0,0 @@
-module Formatters
-
-  module Base
-
-    def self.included(klass)
-      klass.send(:attr_accessor, :file)
-      klass.send(:attr_accessor, :source)
-      klass.send(:attr_accessor, :output_directory)
-    end
-
-    def initialize(file, output_directory=nil, source="")
-      self.file = file
-      self.source = source
-      self.output_directory = output_directory
-    end
-
-    def filename
-      File.basename(self.file.path_to_file) + file_extension
-    end
-
-    def output_path
-      output_path = File.dirname(File.join(self.output_directory, self.file.path_to_file))
-      FileUtils.mkpath(output_path)
-      output_path
-    end
-
-    def path_to_results
-      File.join(output_path, filename)
-    end
-
-  end
-
-end

data/lib/analyst/fukuzatsu/formatters/csv.rb

@@ -1,43 +0,0 @@
-module Formatters
-
-  class Csv
-
-    include Formatters::Base
-
-    def self.has_index?
-      false
-    end
-
-    def self.writes_to_file_system?
-      true
-    end
-
-    def content
-      rows + "\r\n"
-    end
-
-    def export
-      begin
-        File.open(path_to_results, 'a') {|outfile| outfile.write(content)}
-      rescue Exception => e
-        puts "Unable to write output: #{e} #{e.backtrace}"
-      end
-    end
-
-    def file_extension
-      ".csv"
-    end
-
-    def path_to_results
-      File.join(output_directory, "results#{file_extension}")
-    end
-
-    def rows
-      file.methods.map do |method|
-        "#{file.path_to_file},#{file.class_name},#{method.name},#{method.complexity}"
-      end.join("\r\n")
-    end
-
-  end
-
-end

data/lib/analyst/fukuzatsu/formatters/html.rb

@@ -1,87 +0,0 @@
-require 'rouge'
-
-module Formatters
-
-  class Html
-
-    include Formatters::Base
-
-    def self.has_index?
-      true
-    end
-
-    def self.writes_to_file_system?
-      true
-    end
-
-    def self.index_class
-      Formatters::HtmlIndex
-    end
-
-    def columns
-      ["class", "method", "complexity"]
-    end
-
-    def content
-      Haml::Engine.new(output_template).render(
-        Object.new, {
-          header: header,
-          rows: rows,
-          source_lines: preprocessed,
-          class_name: file.class_name,
-          complexity: file.complexity,
-          path_to_file: file.path_to_file,
-          date: Time.now.strftime("%Y/%m/%d"),
-          time: Time.now.strftime("%l:%M %P")
-        }
-      )
-    end
-
-    def export
-      begin
-        File.open(path_to_results, 'w') {|outfile| outfile.write(content)}
-      rescue Exception => e
-        puts "Unable to write output: #{e} #{e.backtrace}"
-      end
-    end
-
-    def formatter
-      Rouge::Formatters::HTML.new(line_numbers: true)
-    end
-
-    def header
-      columns.map{|col| "<th>#{col.titleize}</th>"}.join("\r\n")
-    end
-
-    def lexer
-      lexer = Rouge::Lexers::Ruby.new
-    end
-
-    def output_template
-      File.read(File.dirname(__FILE__) + "/templates/output.html.haml")
-    end
-
-    def preprocessed
-      formatter.format(lexer.lex(source))
-    end
-
-    def rows
-      i = 0
-      file.methods.inject([]) do |a, method|
-        i += 1
-        a << "<tr class='#{i % 2 == 1 ? 'even' : 'odd'}'>"
-        a << "  <td>#{file.class_name}</td>"
-        a << "  <td>#{method.name}</td>"
-        a << "  <td>#{method.complexity}</td>"
-        a << "</tr>"
-        a
-      end.join("\r\n")
-    end
-
-    def file_extension
-      ".htm"
-    end
-
-  end
-
-end

data/lib/analyst/fukuzatsu/formatters/html_index.rb

@@ -1,47 +0,0 @@
-module Formatters
-
-  class HtmlIndex
-
-    include Formatters::Base
-
-    attr_reader :file_summary, :output_directory
-
-    def initialize(file_summary, output_directory=nil)
-      @file_summary = file_summary
-      @output_directory = output_directory
-    end
-
-    def content
-      Haml::Engine.new(output_template).render(
-        Object.new, {
-          file_summary: file_summary,
-          date: Time.now.strftime("%Y/%m/%d"),
-          time: Time.now.strftime("%l:%M %P")
-        }
-      )
-    end
-
-    def export
-      begin
-        File.open(path_to_results, 'w') {|outfile| outfile.write(content)}
-      rescue Exception => e
-        puts "Unable to write output: #{e} #{e.backtrace}"
-      end
-    end
-
-    def filename
-      "index.htm"
-    end
-
-    def output_path
-      FileUtils.mkpath(self.output_directory)
-      self.output_directory
-    end
-
-    def output_template
-      File.read(File.dirname(__FILE__) + "/templates/index.html.haml")
-    end
-
-  end
-
-end

data/lib/analyst/fukuzatsu/formatters/templates/index.html.haml

@@ -1,92 +0,0 @@
-!!!
-%html
-  %head
-    %title
-      Analyst
-    %link{href: "http://cdn.datatables.net/1.10.0/css/jquery.dataTables.css", rel: "stylesheet"}
-    %script{language: "javascript", src: "http://code.jquery.com/jquery-1.11.0.min.js", type: "text/javascript"}
-    %script{language: "javascript", src: "http://code.jquery.com/jquery-migrate-1.2.1.min.js", type: "text/javascript"}
-    %script{language: "javascript", src: "http://cdn.datatables.net/1.10.0/js/jquery.dataTables.js", type: "text/javascript"}
-
-    %style{media: "screen", type: "text/css"}
-      body { background: #593232; color: #fff; font-family: arial, sans-serif; padding: 2em; }
-      table { box-shadow: 0 5px 0 rgba(0,0,0,.8); background: #444; border-spacing: 0; border: 5px solid #000; border-radius: 25px; border-collapse: collapse; min-width: 50%; }
-      th.sorting_asc, th.sorting_desc { text-transform: uppercase !important; font-size: .8em !important; background-image: none !important; background: rgba(64, 41, 41, .5) !important;}
-      th.sorting { background-position: left !important; border-right: 1px solid #222; text-transform: uppercase !important; font-size: .8em !important}
-      tr.header th:first-child { border-radius: 6px 0 0 0; }
-      tr.header th:last-child { border-radius: 0 6px 0 0; }
-      tr.header th:only-child { border-radius: 6px 6px 0 0; }
-      tr.header { background-color: #222; }
-      tr.even { background: rgba(128, 128, 128, 0.5) !important;}
-      tr.odd { background: rgba(128, 128, 128, 0.25) !important}
-      tr.even:hover, tr.odd:hover { background: rgba(128, 128, 128, 0.75) !important;}
-      th { background: #000; text-align: left; padding: .5em; }
-      td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
-      td.center { text-align: center; }
-      td.sorting_1 { background: none !important; padding-left: 1.25em !important; }
-      tfoot { background: #000; border-top: 10px solid #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
-      a:link, a:visited { color: #aaa }
-      div.file_meta { float: left; height: 3em; width: 30%; }
-      h1 { color:#fff; font-size: 1.25em; margin-top: .25em; }
-      h2 { color:#fff; font-size: .75em; margin-top: -1em; }
-      h3 { color:#fff; font-size: 1em; float: right; margin-top: 1em; }
-      td.sorting_1 { background: none !important; padding-left: 1.25em !important; }
-      div.dataTables_filter { margin-bottom: 2em !important; }
-      div.dataTables_filter label { color: #fff; }
-      div.dataTables_paginate { display: none !important; }
-      div.dataTables_info { display: none !important; }
-
-  %body
-    %table{class: "output-table"}
-      %thead
-        %tr.header
-          %th{colspan: 4}
-            .file_meta
-              %h1
-                Project Overview
-        %tr
-          %th
-            File
-          %th
-            Module/Class Name
-          %th
-            Complexity
-          %th
-            Details
-      %tbody
-        - file_summary.each do |summary|
-          %tr
-            %td
-              %a{href: "#{summary[:path_to_file]}.htm"}
-                = summary[:path_to_file]
-            %td
-              - if summary[:class_name].size > 25
-                = "..."
-                = summary[:class_name][-24..-1]
-              - else
-                = summary[:class_name]
-            %td
-              = summary[:complexity]
-            %td
-              %a{href: "#{summary[:path_to_file]}.htm"}
-                View Details
-      %tfoot
-        %tr
-          %td.center{colspan: 4}
-            %em
-              Analyzed on
-              = date
-              at
-              = time
-              by
-              %a{href: "https://gitlab.com/coraline/Analyst", target: "_new"}
-                Analyst
-    :javascript
-      $(document).ready(function(){
-        $('.output-table').dataTable({
-          bLengthChange: false,
-          iDisplayLength: 25000,
-          "order": [[2, "desc"]]
-        });
-      });
-

data/lib/analyst/fukuzatsu/formatters/templates/output.html.haml

@@ -1,114 +0,0 @@
-!!!
-%html
-  %head
-    %title
-      Analyst:
-      = class_name
-    %link{href: "http://cdn.datatables.net/1.10.0/css/jquery.dataTables.css", rel: "stylesheet"}
-    %script{language: "javascript", src: "http://code.jquery.com/jquery-1.11.0.min.js", type: "text/javascript"}
-    %script{language: "javascript", src: "http://code.jquery.com/jquery-migrate-1.2.1.min.js", type: "text/javascript"}
-    %script{language: "javascript", src: "http://cdn.datatables.net/1.10.0/js/jquery.dataTables.js", type: "text/javascript"}
-    %script{language: "javascript", src: "http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.0/highlight.min.js", type: "text/javascript"}
-    :css
-      #{Rouge::Theme.find('thankful_eyes').render(scope: '.highlight')}
-      body { background: #593232; color: #fff; font-family: arial, sans-serif; padding: 2em; }
-      div.column { float: left; width: 45%; margin-left: 4%; }
-      div.file_listing { padding: .1em; border-radius: 5px; background: #000; width: 100%; border: 1px solid #000;}
-      div.file_meta { float: left; height: 3em; width: 30%; }
-      h1 { color:#fff; font-size: 1.25em; margin-top: .25em; }
-      h2 { color:#fff; font-size: .75em; margin-top: -1em; }
-      h3 { color:#fff; font-size: 1.1em;margin-top: 1em; }
-      h3.highlighted { background: rgba(170, 161, 57, .6); border-radius: 100px; padding: .25em; padding-left: 1em; color: #000;}
-      h3.highlighted-method { background: rgba(153, 51, 80, .6); border-radius: 100px; padding-left: 1em; }
-      li { margin-bottom: 1em;}
-      pre { line-height: 1.75em;}
-      pre.lineno { margin-top: -1.4em !important;}
-      span.highlighted { padding-left: 1em; display: inline-block; position: absolute; left: 0px; padding-right: 90%}
-      a:link, a:visited { color: #aaa }
-
-      .file_listing table { width: 100%; box-shadow: 0 5px 0 rgba(0,0,0,.8); border-spacing: 0; border: 5px solid #000; border-radius: 5px; border-collapse: collapse; min-width: 50%; }
-      .file_listing td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
-      .file_listing td.gutter { background-color: rgb(109, 109, 109) !important; }
-      .file_listing tfoot { background: #000; border-top: 10px solid #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
-      .file_listing th { background: #000; text-align: left; padding: .5em; }
-      .file_listing tr.faint td { opacity: 0.5; font-style: italic; }
-      .file_listing tr.header { background-color: #222; }
-      .file_listing tr { background: rgba(0, 0, 0, 0.25) !important; border-bottom: 1px solid #000;}
-      .file_listing th { background: #000; text-align: left; padding: .5em;}
-      .file_listing td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
-      .file_listing td.center { text-align: center; }
-      .file_listing td.sorting_1 { background: none !important; padding-left: 1.25em !important; }
-      .file_listing tfoot { background: #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
-
-      table { box-shadow: 0 5px 0 rgba(0,0,0,.8); background: #444; border-spacing: 0; border: 5px solid #000; border-radius: 25px; border-collapse: collapse; min-width: 50%; }
-      th.sorting_asc, th.sorting_desc { text-transform: uppercase !important; font-size: .8em !important; background-image: none !important; background: rgba(64, 41, 41, .5) !important;}
-      th.sorting { background-position: left !important; border-right: 1px solid #222; text-transform: uppercase !important; font-size: .8em !important}
-      tr.header th:first-child { border-radius: 6px 0 0 0; }
-      tr.header th:last-child { border-radius: 0 6px 0 0; }
-      tr.header th:only-child { border-radius: 6px 6px 0 0; }
-      tfoot tr { border-radius: 6px 6px 6px 6px; }
-      tr.header { background-color: #222; }
-      tr.even { background: rgba(128, 128, 128, 0.5) !important;}
-      tr.odd { background: rgba(128, 128, 128, 0.25) !important}
-      tr.even:hover, tr.odd:hover { background: rgba(128, 128, 128, 0.75) !important;}
-      th { background: #000; text-align: left; padding: .5em;}
-      td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
-      td.center { text-align: center; }
-      td.sorting_1 { background: none !important; padding-left: 1.25em !important; }
-      tfoot { background: #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
-
-      h1 { color:#fff; font-size: 1.25em; margin-top: .25em; }
-      h2 { color:#fff; font-size: .75em; margin-top: -1em; }
-      h3 { color:#fff; font-size: 1em; float: right; margin-top: 1em; }
-
-      div.dataTables_filter { display: none !important; }
-      div.dataTables_paginate { display: none !important; }
-      div.dataTables_info { display: none !important; }
-
-
-  %body
-    .container
-      %table{class: "output-table"}
-        %thead
-          %tr.header
-            %th{colspan: 3}
-              .file_meta
-                %h1
-                  = class_name
-                %h2
-                  = path_to_file
-              .file_meta_right
-                %h3
-                  = "Overall Complexity: #{complexity}"
-          %tr
-            = header
-        %tbody
-          = rows
-        %tfoot
-          %tr
-            %td.center{colspan: 3}
-              %em
-                Analyzed on
-                = date
-                at
-                = time
-                by
-                %a{href: "https://gitlab.com/coraline/Analyst", target: "_new"}
-                  Analyst
-    %br
-    %input{onclick: "history.back(-1)", type: "button", value: "Back"}
-
-    %br
-
-    .file_listing
-      = source_lines
-
-    :javascript
-      $(document).ready(function(){
-        $('.output-table').dataTable({
-          bLengthChange: false,
-          iDisplayLength: 25000,
-          "order": [[2, "desc"]]
-        });
-      });
-

data/lib/analyst/fukuzatsu/formatters/text.rb

@@ -1,56 +0,0 @@
-module Formatters
-
-  require 'terminal-table'
-  require 'rainbow/ext/string'
-
-  class Text
-
-    include Formatters::Base
-
-    def self.has_index?
-      false
-    end
-
-    def self.writes_to_file_system?
-      false
-    end
-
-    def color_for(row)
-      return :green if row.complexity == 0
-      return :yellow if row.complexity <= file.average_complexity
-      return :red if row.complexity > file.average_complexity
-      return :white
-    end
-
-    def header
-      ["Class/Module", "Method", "Complexity"]
-    end
-
-    def export
-      return if rows.empty?
-      table = Terminal::Table.new(
-        title: file.path_to_file.color(:white),
-        headings: header,
-        rows: rows,
-        style: {width: 90}
-      )
-      table.align_column(3, :right)
-      puts table
-    end
-
-    def rows
-      file.methods.map do |method|
-        color = color_for(method)
-        [wrap("#{file.class_name}").color(color), wrap("#{method.name}".color(color)), "#{method.complexity}".color(color)]
-      end
-    end
-
-    def wrap(string)
-      return string if string.length < 25
-      string[0..20] << "..."
-    end
-
-  end
-
-end
-

data/lib/analyst/fukuzatsu/line_of_code.rb

@@ -1,19 +0,0 @@
-class LineOfCode
-
-  include PoroPlus
-  include Ephemeral::Base
-
-  attr_accessor :line_number, :range, :content
-
-  def self.containing(locs, start_index, end_index)
-    locs.inject([]) do |a, loc|
-      a << loc if loc.in_range?(start_index) || loc.in_range?(end_index)
-      a
-    end.compact
-  end
-
-  def in_range?(index)
-    self.range.include?(index)
-  end
-
-end

data/lib/analyst/fukuzatsu/parsed_file.rb

@@ -1,85 +0,0 @@
-class ParsedFile
-
-  attr_accessor :lines_of_code, :source
-  attr_accessor :complexity, :path_to_file, :class_name, :path_to_results
-
-  def initialize(path_to_file: path_to_file, class_name: class_name=nil, complexity: complexity)
-    @path_to_file = path_to_file
-    @class_name = class_name
-    @lines_of_code = []
-    @complexity = complexity
-    @source = parse!
-  end
-
-  def class_name
-    @class_name ||= analyzer.class_name
-  end
-
-  def class_references
-    @class_references ||= analyzer.constants
-  end
-
-  def average_complexity
-    methods.map(&:complexity).reduce(:+) / methods.count.to_f
-  end
-
-  def complexity
-    @complexity ||= analyzer.complexity
-  end
-
-  def methods
-    @methods ||= analyzer.methods
-  end
-
-  def method_counts
-    referenced_methods = methods.map(&:references).flatten
-    referenced_methods.inject({}) do |hash, method|
-      hash[method] ||= 0
-      hash[method] += 1
-      hash
-    end
-  end
-
-  def source
-    return @source if @source
-    end_pos = 0
-    self.lines_of_code = []
-    @source = File.readlines(self.path_to_file).each_with_index do |line, index|
-      start_pos = end_pos + 1
-      end_pos += line.size
-      self.lines_of_code << LineOfCode.new(line_number: index + 1, range: (start_pos..end_pos))
-      line
-    end.join
-  end
-
-  def summary
-    {
-      path_to_file: self.path_to_file,
-      results_file: self.path_to_results,
-      source: source,
-      class_name: self.class_name,
-      complexity: complexity
-    }
-  end
-
-  private
-
-  def analyzer
-    @analyzer ||= Analyzer.new(content)
-  end
-
-  def content
-    @content ||= File.open(path_to_file, "r").read
-  end
-
-  def parse!
-    end_pos = 0
-    File.readlines(self.path_to_file).each_with_index do |line, index|
-      start_pos = end_pos + 1
-      end_pos += line.size
-      self.lines_of_code << LineOfCode.new(line_number: index + 1, range: (start_pos..end_pos))
-      line
-    end.join
-  end
-
-end

data/lib/analyst/fukuzatsu/parsed_method.rb

@@ -1,32 +0,0 @@
-class ParsedMethod
-
-  attr_reader :name, :content, :type, :complexity, :references
-
-  def initialize(name: name, content: content, type: type, refs: refs=[], complexity: complexity)
-    @name = name
-    @content = content
-    @type = type
-    @references = refs
-    @complexity = complexity
-  end
-
-  def complexity
-    @complexity ||= analyzer.complexity
-  end
-
-  def name
-    return "" if self.type == :none
-    "#{prefix}#{@name}"
-  end
-
-  def prefix
-    return "." if self.type == :class
-    return "#" if self.type == :instance
-    return "*"
-  end
-
-  def analyzer
-    Analyzer.new(self.content)
-  end
-
-end

data/lib/analyst/fukuzatsu/parser_original.rb

@@ -1,76 +0,0 @@
-require 'fileutils'
-
-module Analyst
-
-  class Parser
-
-    attr_reader :start_path, :parsed_files
-    attr_reader :threshold, :formatter
-    attr_reader :start_time
-
-    OUTPUT_DIRECTORY = "doc/Analyst"
-
-    def initialize(path, formatter, threshold=0)
-      @start_path = path
-      @formatter  = formatter
-      @threshold  = threshold
-      @start_time = Time.now
-      reset_output_directory
-    end
-
-    def parsed_files
-      @parsed_files = source_files.map do |path_to_file|
-         parse_source_file(path_to_file)
-      end
-    end
-
-    def report
-      self.parsed_files.each do |file|
-        print "."
-        formatter.new(file, OUTPUT_DIRECTORY, file.source).export
-      end
-      puts
-      write_report_index
-      report_complexity
-    end
-
-    private
-
-    def reset_output_directory
-      begin
-        FileUtils.remove_dir(OUTPUT_DIRECTORY)
-      rescue Errno::ENOENT
-      end
-      FileUtils.mkpath(OUTPUT_DIRECTORY)
-    end
-
-    def source_files
-      if File.directory?(start_path)
-        return Dir.glob(File.join(start_path, "**", "*.rb"))
-      else
-        return [start_path]
-      end
-    end
-
-    def parse_source_file(path_to_file, options={})
-      ParsedFile.new(path_to_file: path_to_file)
-    end
-
-    def report_complexity
-      return if self.threshold == 0
-      complexities = self.parsed_files.map(&:complexity)
-      return if complexities.max.to_i <= self.threshold
-      puts "Maximum complexity of #{complexities.max} exceeds #{options['threshold']} threshold!"
-      exit 1
-    end
-
-    def write_report_index
-      return unless self.formatter.writes_to_file_system?
-      puts "Results written to #{OUTPUT_DIRECTORY} "
-      return unless self.formatter.has_index?
-      formatter.index_class.new(parsed_files.map(&:summary), OUTPUT_DIRECTORY).export
-    end
-
-  end
-
-end