fukuzatsu 0.9.8 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1321229a0d5c57e3bd0b2938e295115514c2e73a
-  data.tar.gz: c205ccb2a0e79826e14c6988f1beba80cacff8c3
+  metadata.gz: dc7d149f079d0f937f492a870b0afaf580b8a282
+  data.tar.gz: a07ef85ca31e0ac5091fc474f8b8624c31d378c0
 SHA512:
-  metadata.gz: 99cb838cafffc71182f18591d22d5ec89c3e5af058a19abd3e3792e0938f5f4a1554e4da4c6c1bf133d78e87bd19d60701513751a68554b962b379c653df5897
-  data.tar.gz: d7c6dfa10faf25af7b7b0cc6d431b02e05d4c09e058b52a5925e91d2bc8d8deef691d2e0c17c758382385b9a587cb01e863c60068668fe45b213950cba68b4d3
+  metadata.gz: 636161e9e1e6cb468d6027475aed98619ef62b624b2881f9bd52cff4ae83110ce605ee2826f624e1ac81b45ee9d4e08f76b40ea426a8ba0483cdc9d650aea22f
+  data.tar.gz: b62ff6dccd7cbbe91e5c8ca209c061008728e69e215d06f8436615453245cbe9152f17c5c65ef735e74a35808b8e67dd4b84080c441d7128365760a8b06ed419

data/.gitignore

@@ -20,4 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
-.console_history
+.console_history
+*.swp

data/README.md

@@ -2,11 +2,15 @@
 
 *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 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)
+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.
+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.
 
-Fukuzatsu was created by Coraline Ada Ehmke with invaluable assistance from Mike Ziwisky (mziwisky). It was inspired by Saikuro, written by Zev Blut.
+Fukuzatsu was created by Coraline Ada Ehmke with invaluable assistance from Mike Ziwisky (mziwisky). 
+It was inspired by Saikuro, written by Zev Blut.
 
 ## Installation
 
@@ -18,12 +22,12 @@ This installs the CLI tool.
 
 ## Usage
 
-    fuku parse path/to/file/my_file.rb
+    fuku check path/to/file/my_file.rb
 
-    fuku parse path/to/file/my_file.rb -f html
+    fuku check path/to/file/my_file.rb -f html
     # Writes to doc/fuzuzatsu/path/to_file/my_file.rb.htm
 
-    fuku parse path/to/file/my_file.rb -f csv
+    fuku check path/to/file/my_file.rb -f csv
     # Writes to doc/fuzuzatsu/path/to_file/my_file.rb.csv
 
 ## Contributing

data/lib/fukuzatsu/analyzer.rb

@@ -24,23 +24,23 @@ class Analyzer
 
   def extract_class_name
     return self.class_name if self.class_name
-    child = find_class(parsed)
-    return "?" unless child
-    name = child.loc.name
-    self.class_name = self.content[name.begin_pos..(name.end_pos - 1)]
+    find_class(parsed) || "?"
   end
 
   private
 
-  def find_class(parsed)
-    return parsed if parsed.respond_to?(:type) && (parsed.type == :class || (parsed.type == :module && parsed.children.empty?))
-    child_nodes = parsed.respond_to?(:children) ? parsed.children : parsed
-    child_nodes.each do |child_node|
-      next unless child_node.respond_to?(:type)
-      return child_node if child_node.type == :class
-      return find_class(child_node.children) if child_node.type == :module
+  def text_at(start_pos, end_pos)
+    content[start_pos..end_pos - 1]
+  end
+
+  def find_class(node)
+    return unless node && node.respond_to?(:type)
+    concat = []
+    if node.type == :module || node.type == :class
+      concat << text_at(node.loc.name.begin_pos, node.loc.name.end_pos)
     end
-    false
+    concat << node.children.map{|child| find_class(child)}.compact
+    concat.flatten.select(&:present?).join('::')
   end
 
   def extend_graph

data/lib/fukuzatsu/formatters/html.rb

@@ -25,6 +25,7 @@ module Formatters
           header: header,
           rows: rows,
           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")
@@ -59,4 +60,4 @@ module Formatters
 
   end
 
-end
+end

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

@@ -10,20 +10,28 @@
 
     %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)}
+      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.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}
+      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 }
-      h1 { color:#593232; font-size: 1.25em; }
-      h2 { color:#593232; font-size: .75em; margin-top: -1em}
+      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; }
@@ -31,6 +39,11 @@
   %body
     %table{class: "output-table"}
       %thead
+        %tr.header
+          %th{colspan: 4}
+            .file_meta
+              %h1
+                Project Overview
         %tr
           %th
             File

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

@@ -11,48 +11,60 @@
 
     %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)}
+      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; text-transform: uppercase; font-size: .8em}
+      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;  }
+      td.sorting_1 { background: none !important; padding-left: 1.25em !important; text-transform: uppercase; font-size: .8em}
+      tfoot { background: #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}
+      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; }
       div.dataTables_filter { display: none !important; }
       div.dataTables_paginate { display: none !important; }
       div.dataTables_info { display: none !important; }
 
   %body
-    %table{class: "output-table"}
-      %thead
-        %tr.header
-          %td{colspan: 3}
-            %h1
-              = class_name
-            %h2
-              = path_to_file
-        %tr
-          = header
-      %tbody
-        = rows
-      %tfoot
-        %tr
-          %td.center{colspan: 3}
-            %em
-              Analyzed on
-              = date
-              at
-              = time
-              by
-              %a{href: "https://gitlab.com/coraline/fukuzatsu", target: "_new"}
-                Fukuzatsu
+    .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/fukuzatsu", target: "_new"}
+                  Fukuzatsu
     :javascript
       $(document).ready(function(){
         $('.output-table').dataTable({

data/lib/fukuzatsu/version.rb

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

data/spec/analyzer_spec.rb

@@ -4,6 +4,37 @@ describe Analyzer do
 
   let(:content_1)   { File.read("spec/fixtures/program_1.rb") }
   let(:content_2)   { File.read("spec/fixtures/program_2.rb") }
+  let(:content_3)   { File.read("spec/fixtures/eg_class.rb") }
+  let(:content_4)   { File.read("spec/fixtures/eg_mod_class.rb") }
+  let(:content_5)   { File.read("spec/fixtures/eg_module.rb") }
+  let(:content_6)   { File.read("spec/fixtures/eg_mod_class_2.rb") }
+
+  context "#extract_class_name" do
+
+    context "from Class Foo" do
+      it "returns Foo" do
+        expect(Analyzer.new(content_3).extract_class_name).to eq("Foo")
+      end
+    end
+
+    context "from Module::Class Foo" do
+      it "returns Foo::Bar" do
+        expect(Analyzer.new(content_4).extract_class_name).to eq("Foo::Bar")
+      end
+    end
+  
+    context "from Module; Class" do
+      it "returns Extracted::Thing" do
+        expect(Analyzer.new(content_6).extract_class_name).to eq("Extracted::Thing")
+      end
+    end
+
+    context "from Module" do
+      it "returns Something" do
+        expect(Analyzer.new(content_5).extract_class_name).to eq("Something")
+      end
+    end
+  end
 
   context "program_1" do
 
@@ -25,4 +56,4 @@ describe Analyzer do
 
   end
 
-end
+end

data/spec/fixtures/eg_class.rb

@@ -0,0 +1,8 @@
+require 'fukuzatsu'
+
+class Foo
+  def say_hello
+    "Oh hi there."
+  end
+end
+

data/spec/fixtures/eg_mod_class.rb

@@ -0,0 +1,2 @@
+class Foo::Bar
+end

data/spec/fixtures/eg_mod_class_2.rb

@@ -0,0 +1,5 @@
+module Extracted
+  class Thing
+  end
+end
+

data/spec/fixtures/eg_module.rb

@@ -0,0 +1,2 @@
+module Something
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fukuzatsu
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.10
 platform: ruby
 authors:
 - Bantik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ephemeral
@@ -153,6 +153,10 @@ files:
 - lib/fukuzatsu/parsed_method.rb
 - lib/fukuzatsu/version.rb
 - spec/analyzer_spec.rb
+- spec/fixtures/eg_class.rb
+- spec/fixtures/eg_mod_class.rb
+- spec/fixtures/eg_mod_class_2.rb
+- spec/fixtures/eg_module.rb
 - spec/fixtures/program_1.rb
 - spec/fixtures/program_2.rb
 - spec/fixtures/program_3.rb
@@ -184,6 +188,10 @@ specification_version: 4
 summary: A simple code complexity analyzer.
 test_files:
 - spec/analyzer_spec.rb
+- spec/fixtures/eg_class.rb
+- spec/fixtures/eg_mod_class.rb
+- spec/fixtures/eg_mod_class_2.rb
+- spec/fixtures/eg_module.rb
 - spec/fixtures/program_1.rb
 - spec/fixtures/program_2.rb
 - spec/fixtures/program_3.rb