fukuzatsu 1.0.6 → 2.1.1

data/lib/fukuzatsu/formatters/html_index.rb

@@ -1,47 +1,54 @@
-module Formatters
+module Fukuzatsu
 
-  class HtmlIndex
+  module Formatters
 
-    include Formatters::Base
+    class HtmlIndex
 
-    attr_reader :file_summary, :output_directory
+      include Formatters::Base
 
-    def initialize(file_summary, output_directory=nil)
-      @file_summary = file_summary
-      @output_directory = output_directory
-    end
+      attr_reader :summaries
 
-    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 initialize(summaries)
+        @summaries = summaries
+      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}"
+      def content
+        Haml::Engine.new(output_template).render(
+          Object.new, {
+            summaries: summaries,
+            date: Time.now.strftime("%Y/%m/%d"),
+            time: Time.now.strftime("%l:%M %P")
+          }
+        )
       end
-    end
 
-    def filename
-      "index.htm"
-    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 output_path
-      FileUtils.mkpath(self.output_directory)
-      self.output_directory
-    end
+      def filename
+        "index.htm"
+      end
+
+      def file_extension
+        ".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
 
-    def output_template
-      File.read(File.dirname(__FILE__) + "/templates/index.html.haml")
     end
 
   end
 
-end
+end

data/lib/fukuzatsu/formatters/json.rb

@@ -0,0 +1,37 @@
+module Fukuzatsu
+
+  module Formatters
+
+    class Json
+
+      include Formatters::Base
+
+      def self.index(summaries)
+        Fukuzatsu::Formatters::JsonIndex.new(summaries).export
+      end
+
+      def as_json
+        result = {
+          source_file: summary.source_file,
+          object: summary.container_name,
+          name: summary.entity_name,
+          complexity: summary.complexity
+        }
+        if summary.is_class_or_module?
+          result[:average_complexity] = summary.average_complexity
+          result[:methods] = summary.summaries.map { |s| Json.new(summary: s).as_json }
+        end
+        result
+      end
+
+      def content
+        as_json.to_json
+      end
+
+      def file_extension
+        ".json"
+      end
+    end
+
+  end
+end

data/lib/fukuzatsu/formatters/json_index.rb

@@ -0,0 +1,31 @@
+module Fukuzatsu
+
+  module Formatters
+
+    class JsonIndex
+
+      include Formatters::Base
+
+      attr_reader :summaries
+
+      def initialize(summaries)
+        @summaries = summaries
+      end
+
+      def content
+        summaries.map { |summary| Json.new(summary: summary).as_json }.to_json
+      end
+
+      def filename
+        "json/results.json"
+      end
+
+      def file_extension
+        ".json"
+      end
+
+    end
+
+  end
+
+end

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

@@ -9,30 +9,19 @@
     %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; }
+      body { font-family: Arial, sans-serif; font-size: 13px; padding: 2em; }
+
+      a { color: #900; }
+      table { border: 4px solid #444; width: 100%; }
+
+      tr.sort-controls th { background-color: #999 !important; font-size: .75em; text-transform: uppercase; text-align: left; }
+
+      tr.header th, tfoot { background-color: #444 !important; color: #fff; }
+      tfoot td { font-size: .75em; }
+      tr.odd td { background-color: #eee; }
+
       div.dataTables_filter { margin-bottom: 2em !important; }
-      div.dataTables_filter label { color: #fff; }
+      div.dataTables_filter label { color: ::fff; }
       div.dataTables_paginate { display: none !important; }
       div.dataTables_info { display: none !important; }
 
@@ -44,7 +33,7 @@
             .file_meta
               %h1
                 Project Overview
-        %tr
+        %tr.sort-controls
           %th
             File
           %th
@@ -54,21 +43,21 @@
           %th
             Details
       %tbody
-        - file_summary.each do |summary|
+        - summaries.each do |summary|
           %tr
             %td
-              %a{href: "#{summary[:path_to_file]}.htm"}
-                = summary[:path_to_file]
+              %a{href: "#{summary.source_file}.htm"}
+                = summary.source_file
             %td
-              - if summary[:class_name].size > 25
+              - if summary.entity.full_name.size > 50
                 = "..."
-                = summary[:class_name][-24..-1]
+                = summary.entity.full_name[-49..-1]
               - else
-                = summary[:class_name]
+                = summary.entity.full_name
             %td
-              = summary[:complexity]
+              = sprintf("%0.2f", summary.average_complexity)
             %td
-              %a{href: "#{summary[:path_to_file]}.htm"}
+              %a{href: "#{summary.source_file}.htm"}
                 View Details
       %tfoot
         %tr

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

@@ -11,61 +11,30 @@
     %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;  }
+      body {
+        font-family: Arial, sans-serif;
+        font-size: 13px;
+        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; }
-      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;  }
+      a { color: #fff; }
+      table { border: 4px solid #444; width: 100%; }
 
-      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; }
+      tr.sort-controls th {
+        background-color: #999 !important;
+        font-size: .75em;
+        text-transform: uppercase;
+        text-align: left;
+      }
 
+      tr.header th, tfoot { background-color: #444 !important; color: #fff; }
+      tfoot td { font-size: .75em; }
+      tr.odd td { background-color: #eee; }
       div.dataTables_filter { display: none !important; }
       div.dataTables_paginate { display: none !important; }
       div.dataTables_info { display: none !important; }
 
-
   %body
     .container
       %table{class: "output-table"}
@@ -79,8 +48,8 @@
                   = path_to_file
               .file_meta_right
                 %h3
-                  = "Overall Complexity: #{complexity}"
-          %tr
+                  = "Average Complexity: #{average_complexity}"
+          %tr.sort-controls
             = header
         %tbody
           = rows
@@ -97,7 +66,7 @@
                   Fukuzatsu
     %br
     %input{onclick: "history.back(-1)", type: "button", value: "Back"}
-
+    %br
     %br
 
     .file_listing

data/lib/fukuzatsu/formatters/text.rb

@@ -1,56 +1,68 @@
-module Formatters
+module Fukuzatsu
 
-  require 'terminal-table'
-  require 'rainbow/ext/string'
+  module Formatters
 
-  class Text
+    require 'terminal-table'
+    require 'rainbow/ext/string'
 
-    include Formatters::Base
+    class Text
 
-    def self.has_index?
-      false
-    end
+      include Formatters::Base
 
-    def self.writes_to_file_system?
-      false
-    end
+      def self.explain(count); 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 self.reset_output_directory
+      end
 
-    def header
-      ["Class/Module", "Method", "Complexity"]
-    end
+      def self.writes_to_file_system?
+        false
+      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 color_for(entity, average_complexity)
+        return :green if entity.complexity == 0
+        return :yellow if entity.complexity <= average_complexity
+        return :red if entity.complexity > average_complexity
+        return :white
+      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)]
+      def header
+        ["Class/Module", "Method", "Complexity"]
+      end
+
+      def export
+        table = Terminal::Table.new(
+          title: "#{summary.source_file}".color(:white),
+          headings: header,
+          rows: rows,
+        )
+        table.align_column(3, :right)
+        puts table
+      end
+
+      def rows
+        rows_for(
+          [self.summary, self.summary.summaries].flatten,
+          self.summary.average_complexity
+        )
+      end
+
+      def rows_for(summaries, average_complexity)
+        summaries.map do |summary|
+          color = color_for(summary, average_complexity)
+          [
+            wrap("#{summary.container_name}").color(color),
+            wrap("#{summary.entity_name}".color(color)),
+            "#{summary.complexity}".color(color)
+          ]
+        end.compact
+      end
+
+      def wrap(string)
+        return string if string.length < 50
+        string[0..49] << "..."
       end
-    end
 
-    def wrap(string)
-      return string if string.length < 25
-      string[0..20] << "..."
     end
 
   end
-
 end
-

data/lib/fukuzatsu/parser.rb

@@ -1,76 +1,58 @@
 require 'fileutils'
+require 'analyst'
 
 module Fukuzatsu
 
   class Parser
 
-    attr_reader :start_path, :parsed_files
-    attr_reader :threshold, :formatter
-    attr_reader :start_time
+    attr_reader :path_to_files, :formatter, :threshold
 
-    OUTPUT_DIRECTORY = "doc/fukuzatsu"
-
-    def initialize(path, formatter, threshold=0)
-      @start_path = path
-      @formatter  = formatter
-      @threshold  = threshold
-      @start_time = Time.now
-      reset_output_directory
-    end
-
-    def parse_files
-      @parsed_files = source_files.map do |path_to_file|
-         parse_source_file(path_to_file)
-      end
+    def initialize(path_to_files, formatter, threshold)
+      @path_to_files = path_to_files
+      @formatter = formatter
+      @threshold = threshold
     end
 
     def report
-      self.parsed_files.each do |file|
-        print "."
-        formatter.new(file, OUTPUT_DIRECTORY, file.source).export
+      self.formatter.reset_output_directory
+      self.formatter.index(summaries)
+      summaries.uniq(&:container_name).each do |summary|
+        self.formatter.new(summary: summary).export
       end
-      puts
-      write_report_index
-      report_complexity
+      self.formatter.explain(summaries.count)
+      check_complexity
     end
 
     private
 
-    def reset_output_directory
-      begin
-        FileUtils.remove_dir(OUTPUT_DIRECTORY)
-      rescue Errno::ENOENT
-      end
-      FileUtils.mkpath(OUTPUT_DIRECTORY)
+    def check_complexity
+      return if self.threshold == 0
+      return unless complexity_exceeds_threshold?
+      puts "Maximum average complexity of #{average_complexities.max} exceeds #{self.threshold.to_f} threshold!"
+      exit 1
     end
 
-    def source_files
-      if File.directory?(start_path)
-        return Dir.glob(File.join(start_path, "**", "*.rb"))
-      else
-        return [start_path]
-      end
+    def average_complexities
+      average_complexities ||= summaries.map(&:average_complexity)
     end
 
-    def parse_source_file(path_to_file, options={})
-      ParsedFile.new(path_to_file: path_to_file)
+    def complexity_exceeds_threshold?
+      average_complexities.max.to_f > self.threshold.to_f
     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
+    def summaries
+      @summaries ||= file_reader.source_files.map do |source_file|
+        Fukuzatsu::Summary.from(
+          content: source_file.contents,
+          source_file: source_file.filename
+        )
+      end.flatten
     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
+    def file_reader
+      @file_reader ||= Fukuzatsu::FileReader.new(self.path_to_files)
     end
 
   end
 
-end
+end