fukuzatsu 1.0.6 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60581ee307ba16c4cbc28ce085523b9eb8b2ab04
-  data.tar.gz: 29a01ba5038f7470b3041dee614fc41ae0427fc8
+  metadata.gz: 2f07664e5fec8ebb4806db7425780356672dbff2
+  data.tar.gz: d53ab4e6300ee913f663ab334cb71599a89a7d7b
 SHA512:
-  metadata.gz: 67cd3b33423fe20e3d76970ff0b6e94fb366f39d190b0f9e4d6624e967102591cc9ca89dfff9ea7df2f3dc71ece3a9ef835c5c2bc939bc099c9cffe7e75d6fc7
-  data.tar.gz: b9d7dca96fba0c396c547043796f6778a7da9f5fb182caf8d57bce1d9d29cc7e41812aa9918b8ed0c4c0f9c7da780f01a7ca98df922d2a2a33e438546784bfcf
+  metadata.gz: 32d568e9018a733ea7e9a3b98c3df9cabad1917aa5ce0d2ba96f2ade60d7f65677afae5939ffaa80db506aa8bff44b827f3407d3b160df05e050fdfde69c411f
+  data.tar.gz: 097cbc999cd38da8c69eab575c8143754f1498b97a5f6b861682b6d2057be2531ff9114f4dd7e756526d37517a0a0b5c54d601fb583b8d9ff5c55e030fdc83b1

data/.gitignore

@@ -7,7 +7,7 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/*/
+doc/fukuzatsu/*
 lib/bundler/man
 pkg
 rdoc

data/README.md

@@ -1,23 +1,22 @@
 # Fukuzatsu
 
 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)
+generates scores based on cyclomatic complexity algorithms, which in simplest terms measure the number of execution paths through a given piece of code. (You can learn more about cyclomatic complexity [here](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.
 
-Fukuzatsu was created by [Coraline Ada Ehmke](http://where.coraline.codes/) with invaluable assistance from [Mike Ziwisky](https://github.com/mziwisky). It was inspired by Saikuro, written by Zev Blut.
+Fukuzatsu was created by [Coraline Ada Ehmke](http://where.coraline.codes/) and is maintained by [Coraline Ada Ehmke](http://where.coraline.codes/), [Mike Ziwisky](https://github.com/mziwisky), and the team at [Instructure](http://www.instructure.com/). It was originally inspired by Saikuro, written by Zev Blut.
 
 ## Screenshots
 
 These are screenshots of the `-f html` output. First, the overall project summary:
 
-![Project Summary](https://gitlab.com/coraline/fukuzatsu/raw/master/doc/overview.png)
+![Project Summary](https://gitlab.com/coraline/fukuzatsu/raw/master/doc/images/overview.png)
 
 Then the detail view of a single class:
 
-![Project Summary](https://gitlab.com/coraline/fukuzatsu/raw/master/doc/details.png)
+![Project Summary](https://gitlab.com/coraline/fukuzatsu/raw/master/doc/images/details.png)
 
 ## Installation
 
@@ -32,17 +31,20 @@ This installs the CLI tool.
     fuku check path/to/file/my_file.rb
 
     fuku check path/to/file/my_file.rb -f html
-    # Writes to doc/fuzuzatsu/path/to_file/my_file.rb.htm
+    # Writes to doc/fuzuzatsu/htm/index.htm
 
     fuku check path/to/file/my_file.rb -f csv
-    # Writes to doc/fuzuzatsu/path/to_file/my_file.rb.csv
+    # Writes to doc/fuzuzatsu/csv/results.csv
+
+    fuku check path/to/file/my_file.rb -f json
+    # Writes to doc/fuzuzatsu/json/results.json
 
 ## Contributing
 
-Please note that this project is released with a [Contributor Code of Conduct](https://gitlab.com/coraline/fukuzatsu/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+Please note that this project is released with a [Contributor Code of Conduct](http://contributor-covenant.org/version/1/0/0/). By participating in this project you agree to abide by its terms.
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request

data/fukuzatsu.gemspec

@@ -6,8 +6,8 @@ require 'fukuzatsu/version'
 Gem::Specification.new do |spec|
   spec.name          = "fukuzatsu"
   spec.version       = Fukuzatsu::VERSION
-  spec.authors       = ["Bantik"]
-  spec.email         = ["coraline@idolhands.com"]
+  spec.authors       = ["Coraline Ada Ehmke", "Mike Ziwisky"]
+  spec.email         = ["coraline@idolhands.com", "mikezx@gmail.com"]
   spec.summary       = "A simple code complexity analyzer."
   spec.description   = "Calculates code complexity as a measure of paths through code execution. CI integration and beautiful output options."
   spec.homepage      = "https://gitlab.com/coraline/fukuzatsu/tree/master"
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "analyst", ">= 0.16.0"
   spec.add_dependency "ephemeral"
   spec.add_dependency "poro_plus"
   spec.add_dependency "haml"
@@ -29,7 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
 
 end
+

data/lib/fukuzatsu.rb

@@ -2,19 +2,33 @@ require 'ephemeral'
 require 'poro_plus'
 require 'fileutils'
 require 'haml'
+require 'analyst'
+require 'pry'
 
-require_relative "fukuzatsu/analyzer"
 require_relative "fukuzatsu/cli"
+require_relative "fukuzatsu/file_reader"
 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/json"
+require_relative "fukuzatsu/formatters/json_index"
 require_relative "fukuzatsu/formatters/text"
-require_relative "fukuzatsu/line_of_code"
-require_relative "fukuzatsu/parsed_file"
-require_relative "fukuzatsu/parsed_method"
 require_relative "fukuzatsu/parser"
+require_relative "fukuzatsu/summary"
 require_relative "fukuzatsu/version"
 
 module Fukuzatsu
+  def self.new(path_to_files, formatter=:text, threshold=0)
+    Fukuzatsu::Parser.new(path_to_files, formatters[formatter], threshold)
+  end
+
+  def self.formatters
+    {
+      html: Fukuzatsu::Formatters::Html,
+      csv:  Fukuzatsu::Formatters::Csv,
+      json:  Fukuzatsu::Formatters::Json,
+      text: Fukuzatsu::Formatters::Text
+    }
+  end
 end

data/lib/fukuzatsu/cli.rb

@@ -13,13 +13,7 @@ module Fukuzatsu
     method_option :threshold, :type => :numeric, :default => 0, :aliases => "-t"
 
     def check(path="./")
-      parser = Fukuzatsu::Parser.new(
-        path,
-        formatter,
-        options['threshold']
-      )
-      parser.parse_files
-      parser.report
+      Fukuzatsu.new(path, formatter, options['threshold']).report
     end
 
     default_task :check
@@ -27,14 +21,7 @@ module Fukuzatsu
     private
 
     def formatter
-      case options['format']
-      when 'html'
-        Formatters::Html
-      when 'csv'
-        Formatters::Csv
-      else
-        Formatters::Text
-      end
+      options['format'] && options['format'].to_sym || :text
     end
 
   end

data/lib/fukuzatsu/file_reader.rb

@@ -0,0 +1,38 @@
+module Fukuzatsu
+  class FileReader
+
+    attr_reader :path_to_files
+
+    def initialize(path_to_files)
+      @path_to_files = path_to_files
+    end
+
+    def source_files
+      file_list.map{ |file_path| SourceFile.new(file_path) }
+    end
+
+    private
+
+    def file_list
+      if File.directory?(path_to_files)
+        return Dir.glob(File.join(path_to_files, "**", "*.rb"))
+      else
+        return [path_to_files]
+      end
+    end
+
+    class SourceFile
+      attr_reader :file
+      def initialize(file)
+        @file = File.open(file, "r")
+      end
+      def filename
+        file.path
+      end
+      def contents
+        self.file.read
+      end
+    end
+
+  end
+end

data/lib/fukuzatsu/formatters/base.rb

@@ -1,31 +1,70 @@
-module Formatters
+module Fukuzatsu
 
-  module Base
+  module Formatters
 
-    def self.included(klass)
-      klass.send(:attr_accessor, :file)
-      klass.send(:attr_accessor, :source)
-      klass.send(:attr_accessor, :output_directory)
-    end
+    module Base
 
-    def initialize(file, output_directory=nil, source="")
-      self.file = file
-      self.source = source
-      self.output_directory = output_directory
-    end
+      BASE_OUTPUT_DIRECTORY = "doc/fukuzatsu/"
 
-    def filename
-      File.basename(self.file.path_to_file) + file_extension
-    end
+      def self.included(klass)
+        klass.send(:attr_accessor, :summary)
+        klass.send(:attr_accessor, :source)
+        klass.extend(ClassMethods)
+      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 initialize(source: nil, summary:nil)
+        self.source = source
+        self.summary = summary
+      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
+        File.basename(self.summary.source_file) + file_extension
+      end
+
+      def output_directory
+        BASE_OUTPUT_DIRECTORY + file_extension.gsub(".","")
+      end
+
+      def output_path
+        if self.summary
+          output_path = output_directory + "/" + File.dirname(self.summary.source_file)
+          FileUtils.mkpath(output_path)
+        else
+          output_path = File.dirname(output_directory)
+        end
+        output_path
+      end
+
+      def path_to_results
+        File.join(output_path, filename)
+      end
+
+      module ClassMethods
+
+        def index(summaries)
+        end
+
+        def reset_output_directory
+          directory = new.output_directory
+          begin
+            FileUtils.remove_dir(directory)
+          rescue Errno::ENOENT
+          end
+          FileUtils.mkpath(directory)
+        end
 
-    def path_to_results
-      File.join(output_path, filename)
+        def explain(count)
+          puts "Processed #{count} file(s). Results written to #{new.output_directory}."
+        end
+      end
     end
 
   end

data/lib/fukuzatsu/formatters/csv.rb

@@ -1,43 +1,42 @@
-module Formatters
+module Fukuzatsu
 
-  class Csv
+  module Formatters
 
-    include Formatters::Base
+    class Csv
 
-    def self.has_index?
-      false
-    end
+      include Formatters::Base
 
-    def self.writes_to_file_system?
-      true
-    end
+      def self.writes_to_file_system?
+        true
+      end
 
-    def content
-      rows + "\r\n"
-    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}"
+      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
-    end
 
-    def file_extension
-      ".csv"
-    end
+      def file_extension
+        ".csv"
+      end
 
-    def path_to_results
-      File.join(output_directory, "results#{file_extension}")
-    end
+      def path_to_results
+        File.join(output_directory, "results#{file_extension}")
+      end
+
+      def rows
+        summary.summaries.map do |summary|
+          "#{summary.source_file},#{summary.container_name},#{summary.entity_name},#{summary.complexity}"
+        end.join("\r\n")
+      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/fukuzatsu/formatters/html.rb

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