fukuzatsu 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efab3a434a8c65a1adb32fd0d7094305b2b9d0af
-  data.tar.gz: 5c00a9a29a444a828ef9004ed6dd49973daf487d
+  metadata.gz: 1321229a0d5c57e3bd0b2938e295115514c2e73a
+  data.tar.gz: c205ccb2a0e79826e14c6988f1beba80cacff8c3
 SHA512:
-  metadata.gz: ae7fe25e982c111c13744a8d07ed9699e987a20d8ba15decd8cb2bc367e8f04e790b828968a0a69d94a0b98eadf88468288e2dbe19cb103d46c4f41a95ca8252
-  data.tar.gz: e10e18df2971b516b966508d68a747564e09a5a81fe344c058fbc0d6eb8cd0f7376b7b9c921895d41091d1e034a2ce17cd2f9b849535ecc9249308eda12e2d56
+  metadata.gz: 99cb838cafffc71182f18591d22d5ec89c3e5af058a19abd3e3792e0938f5f4a1554e4da4c6c1bf133d78e87bd19d60701513751a68554b962b379c653df5897
+  data.tar.gz: d7c6dfa10faf25af7b7b0cc6d431b02e05d4c09e058b52a5925e91d2bc8d8deef691d2e0c17c758382385b9a587cb01e863c60068668fe45b213950cba68b4d3

data/README.md

@@ -2,9 +2,7 @@
 
 *Note: this gem is a work in progress and should not be considered production-ready until version 1.0*
 
-Fukuzatsu ("complexity") is a tool for measuring code complexity in Ruby class files. Its analysis is based on a cycomatic complexity algorithm.
-
-You can learn more about cyclomatic complexity at http://en.wikipedia.org/wiki/Cyclomatic_complexity
+Fukuzatsu ("complexity") is a tool for measuring code complexity in Ruby class files. Its analysis generates relative complexity figures similar to the results of cyclomatic complexity algorithms. (You can learn more about cyclomatic complexity at http://en.wikipedia.org/wiki/Cyclomatic_complexity)
 
 Why should you care about this kind of complexity? More complex code tends to attract bugs and to increase the friction around extending features or refactoring code.
 

data/lib/fukuzatsu.rb

@@ -8,6 +8,7 @@ require_relative "fukuzatsu/cli"
 require_relative "fukuzatsu/formatters/base"
 require_relative "fukuzatsu/formatters/csv"
 require_relative "fukuzatsu/formatters/html"
+require_relative "fukuzatsu/formatters/html_index"
 require_relative "fukuzatsu/formatters/text"
 require_relative "fukuzatsu/parsed_file"
 require_relative "fukuzatsu/parsed_method"

data/lib/fukuzatsu/cli.rb

@@ -14,8 +14,11 @@ module Fukuzatsu
 
     def check(path)
 
-      file_complexities = file_list(path).map do |file|
-        file = ParsedFile.new(path_to_file: file)
+      file_summary = []
+      file_complexities = []
+
+      file_list(path).each do |path_to_file|
+        file = ParsedFile.new(path_to_file: path_to_file)
         case options['format']
         when 'html'
           Formatters::Html.new(file).export
@@ -24,20 +27,31 @@ module Fukuzatsu
         else
           Formatters::Text.new(file).export
         end
-        file.complexity
+        file_summary << {path_to_file: path_to_file, class_name: file.class_name, complexity: file.complexity}
+        file_complexities << file.complexity
       end
 
-      highest_complexity = file_complexities.sort.last
+      Formatters::HtmlIndex.new(file_summary).export if options['format'] == 'html'
 
-      if options['threshold'] != 0 && highest_complexity > options['threshold']
-        puts "Maximum complexity is #{highest_complexity}, which is greater than the threshold of #{options['threshold']}."
-        exit 1
-      end
+      handle_complexity(file_complexities.sort.last, options['threshold'])
 
     end
 
     private
 
+    def write_index(file_list)
+      Formatters::Html.write_index(file_list)
+    end
+
+    def handle_complexity(max, threshold)
+      return if options['threshold'] == 0
+      return if highest_complexity <= options['threshold']
+      puts "=" * 40
+      puts "Maximum complexity is #{highest_complexity}, which is greater than the threshold of #{options['threshold']}."
+      puts "=" * 40
+      exit 1
+    end
+
     def file_list(start_file)
       if File.directory?(start_file)
         return Dir.glob(File.join(start_file, "**", "*")).select{|n| n =~ /\.rb$/}

data/lib/fukuzatsu/formatters/html.rb

@@ -4,12 +4,24 @@ module Formatters
 
     include Formatters::Base
 
+    def self.write_index(file_list)
+      index_template = File.read(File.dirname(__FILE__) + "/templates/index.html.haml")
+      Haml::Engine.new(index_template).render(
+        Object.new, {
+          file_list: file_list,
+          date: Time.now.strftime("%Y/%m/%d"),
+          time: Time.now.strftime("%l:%M %P")
+        }
+      )
+    end
+
     def header
       columns.map{|col| "<th>#{col.titleize}</th>"}.join("\r\n")
     end
 
     def content
-      Haml::Engine.new(template).render(Object.new, {
+      Haml::Engine.new(output_template).render(
+        Object.new, {
           header: header,
           rows: rows,
           class_name: file.class_name,
@@ -20,7 +32,7 @@ module Formatters
       )
     end
 
-    def template
+    def output_template
       File.read(File.dirname(__FILE__) + "/templates/output.html.haml")
     end
 

data/lib/fukuzatsu/formatters/html_index.rb

@@ -0,0 +1,39 @@
+module Formatters
+
+  class HtmlIndex
+
+    include Formatters::Base
+
+    attr_accessor :file_summary
+
+    def initialize(file_summary)
+      self.file_summary = file_summary
+    end
+
+    def filename
+      "index.htm"
+    end
+
+    def output_path
+      output_path = "doc/fukuzatsu/"
+      FileUtils.mkpath(output_path)
+      output_path
+    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 output_template
+      File.read(File.dirname(__FILE__) + "/templates/index.html.haml")
+    end
+
+  end
+
+end

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

@@ -0,0 +1,73 @@
+!!!
+%html
+  %head
+    %title
+      Fukuzatsu
+    %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 { border: 10px solid #000; border-collapse: collapse; min-width: 50%; }
+      tr { border-top: 1px solid #000; }
+      tr.header { background: rgba(255, 255, 255, 0.75)}
+      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; text-transform: uppercase; font-size: .8em}
+      td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
+      td.center { text-align: center; }
+      tfoot { background: #000; border-top: 10px solid #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
+      a:link, a:visited { color: #aaa }
+      h1 { color:#593232; font-size: 1.25em; }
+      h2 { color:#593232; font-size: .75em; margin-top: -1em}
+      td.sorting_1 { background: none !important; padding-left: 1.25em !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
+          %th
+            File
+          %th
+            Module/Class Name
+          %th
+            Complexity
+          %th
+            Details
+      %tbody
+        - file_summary.each do |summary|
+          %tr
+            %td
+              = summary[:path_to_file]
+            %td
+              = 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/fukuzatsu", target: "_new"}
+                Fukuzatsu
+    :javascript
+      $(document).ready(function(){
+        $('.output-table').dataTable({
+          bLengthChange: false,
+          iDisplayLength: 25000
+        });
+      });
+

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

@@ -16,14 +16,15 @@
       tr.header { background: rgba(255, 255, 255, 0.75)}
       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; text-transform: uppercase; font-size: .8em}
-      td { 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 }
       h1 { color:#593232; font-size: 1.25em; }
       h2 { color:#593232; font-size: .75em; margin-top: -1em}
-      td.sorting_1 { background: none !important; }
       div.dataTables_filter { display: none !important; }
       div.dataTables_paginate { display: none !important; }
       div.dataTables_info { display: none !important; }

data/lib/fukuzatsu/version.rb

@@ -1,3 +1,3 @@
 module Fukuzatsu
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fukuzatsu
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Bantik
@@ -145,11 +145,12 @@ files:
 - lib/fukuzatsu/formatters/base.rb
 - lib/fukuzatsu/formatters/csv.rb
 - lib/fukuzatsu/formatters/html.rb
+- lib/fukuzatsu/formatters/html_index.rb
+- lib/fukuzatsu/formatters/templates/index.html.haml
 - lib/fukuzatsu/formatters/templates/output.html.haml
 - lib/fukuzatsu/formatters/text.rb
 - lib/fukuzatsu/parsed_file.rb
 - lib/fukuzatsu/parsed_method.rb
-- lib/fukuzatsu/util.rb
 - lib/fukuzatsu/version.rb
 - spec/analyzer_spec.rb
 - spec/fixtures/program_1.rb

data/lib/fukuzatsu/util.rb

@@ -1 +0,0 @@
-util.rb