fukuzatsu 0.10.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98e183078ac1f80b93a9f0c432ff70a5a75fb156
-  data.tar.gz: 9ff83590fd2e21f4dab4100db0bb32dc51d09468
+  metadata.gz: d1fc37f05fcd183b24dbe2ed09a7d48b5214d5cb
+  data.tar.gz: fd03679df8338b84b667fb9c084fdc5466c442b3
 SHA512:
-  metadata.gz: 361c28387778b0fa9211c4401dc9d6ebfd1ad491a0a1c6857a0c57ccc32b052d3b4ec81fefbd30ca02a0304800120b89ff6781ae3188c5de8e553cb834fbcc8b
-  data.tar.gz: e8d4b595508e6fd5db7d3f057dc2325d3d1c7c694729f6caf8b09fcf6c29f8cbc79d5ab5513df4a57f6daf5944a42d15295af2c8cfb00ec8e8db4c6fb6eeec39
+  metadata.gz: 0e96102937e251544859c12e3bd403d07fb405d1509c4f46369122aeebb2eeea0037aece27e8c8f78d11ef07b9452ece1e6a2925d0962eaa5a8d5281c3021978
+  data.tar.gz: 453b198fd14b8eabd98ac67a9375fdcfd2f41ae64254ed0ab488718e80beb11d54660a34a8c12d280a4d0509a848933406b5c1ae0453fcff2a667ce4cccb45f7

data/CODE_OF_CONDUCT.md

@@ -1,5 +1,6 @@
-ODE
-## Version 0.4
+# CODE OF CONDUCT
+
+This project has adopted version 0.4 of the [Contributor Covenant](https://github.com/bantik/contributor_covenant/).
 
 As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
 

data/README.md

@@ -1,16 +1,13 @@
 # Fukuzatsu
 
-*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. 
+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 
+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.
 
-It was inspired by Saikuro, written by Zev Blut.
-Fukuzatsu was created by [Coraline Ada Ehmke](http://where.coraline.codes/) with invaluable assistance from [Mike Ziwisky](https://github.com/mziwisky). 
+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.
 
 ## Screenshots
 

data/fukuzatsu.gemspec

@@ -22,7 +22,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "poro_plus"
   spec.add_dependency "haml"
   spec.add_dependency "parser"
+  spec.add_dependency "rainbow"
   spec.add_dependency "rouge"
+  spec.add_dependency "terminal-table"
   spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler", "~> 1.6"

data/lib/fukuzatsu.rb

@@ -13,6 +13,7 @@ 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/version"
 
 module Fukuzatsu

data/lib/fukuzatsu/analyzer.rb

@@ -53,10 +53,18 @@ class Analyzer
     if node.type == :def || node.type == :defs || node.type == :class
       name = node.loc.name
       expression = node.loc.expression
+      type = case(node.type)
+        when :defs
+          :class
+        when :def
+          :instance
+        when :class
+          :none
+      end
       methods << ParsedMethod.new(
         name: content[name.begin_pos..name.end_pos - 1],
         content: content[expression.begin_pos..expression.end_pos - 1],
-        type: [:defs, :class].include?(node.type) ? :class : :instance
+        type: type
       )
     end
     node.children.each do |child|

data/lib/fukuzatsu/cli.rb

@@ -13,29 +13,19 @@ module Fukuzatsu
     method_option :threshold, :type => :numeric, :default => 0, :aliases => "-t"
 
     def check(path="./")
-      file_list(path).each{ |path_to_file| parse(path_to_file) }
-      handle_index(summaries)
-      report
+      parser = Fukuzatsu::Parser.new(
+        path,
+        formatter,
+        options['threshold']
+      )
+      parser.parse_files
+      parser.report
     end
 
     default_task :check
 
-    attr_accessor :summaries, :last_file
-
     private
 
-    def complexities
-      summaries.to_a.map{|s| s[:complexity]}
-    end
-
-    def file_list(start_file)
-      if File.directory?(start_file)
-        return Dir.glob(File.join(start_file, "**", "*.rb"))
-      else
-        return [start_file]
-      end
-    end
-
     def formatter
       case options['format']
       when 'html'
@@ -47,41 +37,6 @@ module Fukuzatsu
       end
     end
 
-    def handle_index(file_summary)
-      return unless options['format'] == 'html'
-      index = Formatters::HtmlIndex.new(file_summary)
-      self.last_file = File.join(index.output_path, index.filename)
-      index.export
-    end
-
-    def parse(path_to_file, options={})
-      file = ParsedFile.new(path_to_file: path_to_file)
-      parser = formatter.new(file, file.source)
-      parser.export
-      self.summaries ||= []
-      self.summaries << file.summary.merge(results_file: parser.path_to_results)
-      last_file = file
-    end
-
-    def report
-      unless options['format'] == "text"
-        puts "Results written to:"
-        puts last_file.present? && "#{last_file}" || results_files.join("\r\n")
-      end
-      report_complexity
-    end
-
-    def report_complexity
-      return if options['threshold'].to_i == 0
-      return if complexities.max.to_i <= options['threshold']
-      puts "Maximum complexity of #{complexities.max} exceeds #{options['threshold']} threshold!"
-      exit 1
-    end
-
-    def results_files
-      summaries.map{|s| s[:results_file]}
-    end
-
   end
 
 end

data/lib/fukuzatsu/formatters/base.rb

@@ -5,27 +5,21 @@ module Formatters
     def self.included(klass)
       klass.send(:attr_accessor, :file)
       klass.send(:attr_accessor, :source)
+      klass.send(:attr_accessor, :output_directory)
     end
 
-    def initialize(file, source="")
+    def initialize(file, output_directory, source="")
       self.file = file
       self.source = source
+      self.output_directory = output_directory
     end
 
-    def content
-      [header, rows, footer].flatten.join("\r\n")
-    end
-
-    def columns
-      ["class", "method", "complexity"]
-    end
-
-    def root_path
-      "doc/fukuzatsu"
+    def filename
+      File.basename(self.file.path_to_file) + file_extension
     end
 
     def output_path
-      output_path = File.dirname(File.join(root_path, self.file.path_to_file))
+      output_path = File.dirname(File.join(self.output_directory, self.file.path_to_file))
       FileUtils.mkpath(output_path)
       output_path
     end
@@ -34,22 +28,6 @@ module Formatters
       File.join(output_path, filename)
     end
 
-    def filename
-      File.basename(self.file.path_to_file) + file_extension
-    end
-
-    def file_extension
-      ""
-    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
-
   end
 
 end

data/lib/fukuzatsu/formatters/csv.rb

@@ -4,24 +4,40 @@ module Formatters
 
     include Formatters::Base
 
-    def header
-      columns.join(',')
+    def self.has_index?
+      false
     end
 
-    def rows
-      file.methods.inject([]) do |a, method|
-        a << "#{file.class_name},#{method.prefix}#{method.name},#{method.complexity}"
-        a
-      end.join("\r\n")
+    def self.writes_to_file_system?
+      true
     end
 
-    def footer
+    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.prefix}#{method.name},#{method.complexity}"
+      end.join("\r\n")
+    end
+
   end
 
 end

data/lib/fukuzatsu/formatters/html.rb

@@ -6,8 +6,20 @@ module Formatters
 
     include Formatters::Base
 
-    def header
-      columns.map{|col| "<th>#{col.titleize}</th>"}.join("\r\n")
+    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
@@ -25,10 +37,22 @@ module Formatters
       )
     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
@@ -54,9 +78,6 @@ module Formatters
       end.join("\r\n")
     end
 
-    def footer
-    end
-
     def file_extension
       ".htm"
     end

data/lib/fukuzatsu/formatters/html_index.rb

@@ -4,19 +4,11 @@ module Formatters
 
     include Formatters::Base
 
-    attr_accessor :file_summary
+    attr_reader :file_summary, :output_directory
 
-    def initialize(file_summary)
-      self.file_summary = file_summary
-    end
-
-    def filename
-      "index.htm"
-    end
-
-    def output_path
-      FileUtils.mkpath(root_path)
-      root_path
+    def initialize(file_summary, output_directory)
+      @file_summary = file_summary
+      @output_directory = output_directory
     end
 
     def content
@@ -29,6 +21,23 @@ module Formatters
       )
     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

data/lib/fukuzatsu/formatters/text.rb

@@ -1,26 +1,50 @@
 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
-      "#{file.class_name}\t\t#{file.complexity}"
+      ["Class/Module", "Method", "Complexity"]
     end
 
     def export
-      puts content
+      return if rows.empty?
+      table = Terminal::Table.new(
+        title: file.path_to_file.color(:white),
+        headings: header,
+        rows: rows,
+        style: {width: 80}
+      )
+      table.align_column(3, :right)
+      puts table
     end
 
     def rows
       file.methods.map do |method|
-        "#{file.class_name}\t#{method.prefix}#{method.name}\t#{method.complexity}"
+        color = color_for(method)
+        ["#{file.class_name}".color(color), "#{method.name}".color(color), "#{method.complexity}".color(color)]
       end
     end
 
-    def footer
-    end
-
   end
 
 end

data/lib/fukuzatsu/parsed_file.rb

@@ -18,6 +18,10 @@ class ParsedFile
     @analyzer ||= Analyzer.new(content)
   end
 
+  def average_complexity
+    methods.map(&:complexity).reduce(:+) / methods.count.to_f
+  end
+
   def complexity
     @complexity ||= analyzer.complexity
   end
@@ -40,7 +44,6 @@ class ParsedFile
 
   def summary
     {
-      results_file: self.path_to_results,
       path_to_file: self.path_to_file,
       source: source,
       class_name: self.class_name,

data/lib/fukuzatsu/parsed_method.rb

@@ -8,8 +8,15 @@ class ParsedMethod
     @complexity ||= analyzer.complexity
   end
 
+  def name
+    return "" if self.type == :none
+    "#{prefix}#{@name}"
+  end
+
   def prefix
-    self.type.to_s == 'class' ? "." : "#"
+    return "." if self.type == :class
+    return "#" if self.type == :instance
+    return "*"
   end
 
   def analyzer

data/lib/fukuzatsu/parser.rb

@@ -0,0 +1,68 @@
+require 'fileutils'
+
+module Fukuzatsu
+
+  class Parser
+
+    attr_reader :start_path, :parsed_files
+    attr_reader :threshold, :formatter
+
+    OUTPUT_DIRECTORY = "doc/fukuzatsu"
+
+    def initialize(path, formatter, threshold=0)
+      @start_path = path
+      @formatter  = formatter
+      @threshold  = threshold
+      reset_output_directory
+    end
+
+    def parse_files
+      @parsed_files = source_files.map{ |path_to_file| parse_source_file(path_to_file) }
+    end
+
+    def report
+      self.parsed_files.each{ |file| formatter.new(file, OUTPUT_DIRECTORY, file.source).export }
+      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

data/lib/fukuzatsu/version.rb

@@ -1,3 +1,3 @@
 module Fukuzatsu
-  VERSION = "0.10.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fukuzatsu
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Bantik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ephemeral
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +211,7 @@ files:
 - lib/fukuzatsu/line_of_code.rb
 - lib/fukuzatsu/parsed_file.rb
 - lib/fukuzatsu/parsed_method.rb
+- lib/fukuzatsu/parser.rb
 - lib/fukuzatsu/version.rb
 - spec/analyzer_spec.rb
 - spec/cli_spec.rb