fukuzatsu 1.0.6 → 2.1.1

data/spec/formatters/text_spec.rb

@@ -1,25 +1,16 @@
 require 'spec_helper'
 
-describe "Formatters::Text" do
+describe Fukuzatsu::Formatters::Text do
 
-  let (:parsed_file) { ParsedFile.new(class_name: "Foo", complexity: 11) }
-  let (:method_1) { ParsedMethod.new(
-      name: "initialize",
-      complexity: 13,
-      type: "instance"
+  let (:summary) { Fukuzatsu::Summary.new(
+      :source => "foo.rb",
+      :entity => "Foo",
+      :container => "Foo",
+      :summaries => []
     )
   }
-  let (:method_2) { ParsedMethod.new(
-      name: "report",
-      complexity: 11,
-      type: "instance"
-    )
-  }
-
 
-  let(:parsed_file) { Struct.new(:path_to_file, :class_name, :average_complexity)}
-  let(:mock_parsed_file) { parsed_file.new("fred/foo.rb", "Foo", 12) }
-  let (:formatter) { Formatters::Text.new(mock_parsed_file) }
+  let (:formatter) { Fukuzatsu::Formatters::Text.new(summary: summary) }
 
   describe "#header" do
     it "returns a header array" do
@@ -28,10 +19,19 @@ describe "Formatters::Text" do
   end
 
   describe "#rows" do
+
+    before do
+      allow(summary).to receive(:container_name).and_return("Foo")
+      allow(summary).to receive(:entity_name).and_return("*")
+      allow(summary).to receive(:complexity).and_return(13)
+      allow(summary).to receive(:averge_complexity).and_return(11)
+    end
+
     it "returns formatted rows" do
-      allow(mock_parsed_file).to receive(:methods) { [method_1, method_2] }
       expect(formatter.rows).to eq(
-        [["\e[31mFoo\e[0m", "\e[31m*initialize\e[0m", "\e[31m13\e[0m"], ["\e[33mFoo\e[0m", "\e[33m*report\e[0m", "\e[33m11\e[0m"]]
+        [
+          ["\e[31mFoo\e[0m", "\e[31m*\e[0m", "\e[31m13\e[0m"]
+        ]
       )
     end
   end

data/spec/parser_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Fukuzatsu::Parser do
+
+  let(:parser) { Fukuzatsu::Parser.new(
+      "./fixtures/",
+      "formatter proxy",
+      14
+    )
+  }
+
+  describe "#initialize" do
+    it "initializes its path to files" do
+      expect(parser.path_to_files).to eq "./fixtures/"
+    end
+  end
+
+  describe "check_complexity" do
+    it "returns if no threshold is set" do
+      allow(parser).to receive(:threshold) { 0 }
+      expect(parser.send(:check_complexity)).to be_nil
+    end
+    it "returns if threshold is not exceeded" do
+      allow(parser).to receive(:threshold) { 5 }
+      allow(parser).to receive(:average_complexities) { [1,2,3,4,5] }
+      expect(parser.send(:check_complexity)).to be_nil
+    end
+    it "returns an exit code if threshold exceeded" do
+      allow(parser).to receive(:threshold) { 5 }
+      allow(parser).to receive(:average_complexities) { [1,2,3,4,5,6] }
+      begin
+        parser.send(:check_complexity)
+      rescue SystemExit => e
+        expect(e.message).to eq("exit")
+      end
+    end
+  end
+
+end

data/spec/summary_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Fukuzatsu::Summary do
+
+  describe "#complexity" do
+
+    let(:class_source) { File.open("./spec/fixtures/class.rb", "r").readlines }
+    let(:class_complexity) { class_source.first.split('complexity:')[1].to_i }
+
+    let(:module_source) { File.open("./spec/fixtures/module.rb", "r").readlines }
+    let(:module_complexity) { module_source.first.split('complexity:')[1].to_i }
+
+    let(:procedural_source) { File.open("./spec/fixtures/procedural.rb", "r").readlines }
+    let(:procedural_complexity) { procedural_source.first.split('complexity:')[1].to_i }
+
+    it "calculates complexity of a class" do
+      summary = Fukuzatsu::Summary.from(content: class_source.join("\n")).first
+      expect(summary.complexity).to eq(class_complexity)
+    end
+
+    it "calculates complexity of a module" do
+      summary = Fukuzatsu::Summary.from(content: module_source.join("\n")).first
+      expect(summary.complexity).to eq(module_complexity)
+    end
+
+  end
+
+end

metadata

@@ -1,15 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: fukuzatsu
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 2.1.1
 platform: ruby
 authors:
-- Bantik
+- Coraline Ada Ehmke
+- Mike Ziwisky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: analyst
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: ephemeral
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +211,7 @@ description: Calculates code complexity as a measure of paths through code execu
   CI integration and beautiful output options.
 email:
 - coraline@idolhands.com
+- mikezx@gmail.com
 executables:
 - fuku
 extensions: []
@@ -195,46 +225,35 @@ files:
 - README.md
 - Rakefile
 - bin/fuku
-- doc/details.png
-- doc/overview.png
+- doc/images/details.png
+- doc/images/overview.png
 - fukuzatsu.gemspec
 - lib/fukuzatsu.rb
-- lib/fukuzatsu/analyzer.rb
 - lib/fukuzatsu/cli.rb
+- lib/fukuzatsu/file_reader.rb
 - lib/fukuzatsu/formatters/base.rb
 - lib/fukuzatsu/formatters/csv.rb
 - lib/fukuzatsu/formatters/html.rb
 - lib/fukuzatsu/formatters/html_index.rb
+- lib/fukuzatsu/formatters/json.rb
+- lib/fukuzatsu/formatters/json_index.rb
 - lib/fukuzatsu/formatters/templates/index.html.haml
 - lib/fukuzatsu/formatters/templates/output.html.haml
 - lib/fukuzatsu/formatters/text.rb
-- lib/fukuzatsu/line_of_code.rb
-- lib/fukuzatsu/parsed_file.rb
-- lib/fukuzatsu/parsed_method.rb
 - lib/fukuzatsu/parser.rb
+- lib/fukuzatsu/summary.rb
 - lib/fukuzatsu/version.rb
-- spec/analyzer_spec.rb
 - spec/cli_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/module_with_class.rb
-- spec/fixtures/multiple_methods.rb
-- spec/fixtures/nested_methods.rb
-- spec/fixtures/program_1.rb
-- spec/fixtures/program_2.rb
-- spec/fixtures/program_3.rb
-- spec/fixtures/program_4.rb
-- spec/fixtures/single_class.rb
-- spec/fixtures/single_method.rb
+- spec/fixtures/class.rb
+- spec/fixtures/module.rb
+- spec/fixtures/procedural.rb
 - spec/formatters/csv_spec.rb
-- spec/formatters/html_index_spec.rb
 - spec/formatters/html_spec.rb
+- spec/formatters/json_spec.rb
 - spec/formatters/text_spec.rb
-- spec/parsed_file_spec.rb
-- spec/parsed_method_spec.rb
+- spec/parser_spec.rb
 - spec/spec_helper.rb
+- spec/summary_spec.rb
 - tags
 homepage: https://gitlab.com/coraline/fukuzatsu/tree/master
 licenses:
@@ -261,26 +280,15 @@ signing_key:
 specification_version: 4
 summary: A simple code complexity analyzer.
 test_files:
-- spec/analyzer_spec.rb
 - spec/cli_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/module_with_class.rb
-- spec/fixtures/multiple_methods.rb
-- spec/fixtures/nested_methods.rb
-- spec/fixtures/program_1.rb
-- spec/fixtures/program_2.rb
-- spec/fixtures/program_3.rb
-- spec/fixtures/program_4.rb
-- spec/fixtures/single_class.rb
-- spec/fixtures/single_method.rb
+- spec/fixtures/class.rb
+- spec/fixtures/module.rb
+- spec/fixtures/procedural.rb
 - spec/formatters/csv_spec.rb
-- spec/formatters/html_index_spec.rb
 - spec/formatters/html_spec.rb
+- spec/formatters/json_spec.rb
 - spec/formatters/text_spec.rb
-- spec/parsed_file_spec.rb
-- spec/parsed_method_spec.rb
+- spec/parser_spec.rb
 - spec/spec_helper.rb
+- spec/summary_spec.rb
 has_rdoc: 

data/lib/fukuzatsu/analyzer.rb

@@ -1,162 +0,0 @@
-require 'parser/current'
-
-class Analyzer
-
-  CONDITIONALS = [:if, :or_asgn, :and_asgn, :or, :and]
-
-  attr_accessor :content, :class_name, :edges, :nodes, :exits
-
-  DEFAULT_CLASS_NAME = "Unknown"
-
-  def initialize(content)
-    self.content = content
-    self.edges = 0
-    self.nodes = 1
-    self.exits = 1
-  end
-
-  def complexity
-    return unless traverse(parsed)
-    self.edges - self.nodes + exits
-  end
-
-  def class_name
-    find_class(parsed) || DEFAULT_CLASS_NAME
-  end
-
-  def methods
-    @methods ||= methods_from(parsed)
-  end
-
-  def constants
-    @constants ||= constants_from(parsed)
-  end
-
-  def method_names
-    @method_names ||= method_names_from(parsed)
-  end
-
-  def extract_methods
-    @methods ||= methods_from(parsed)
-  end
-
-  def extract_class_name
-    return self.class_name if self.class_name && ! self.class_name.empty?
-    found = find_class(parsed)
-    self.class_name = ! found.empty? && found || DEFAULT_CLASS_NAME
-  end
-
-  private
-
-  def method_list
-    @method_list ||= method_names
-  end
-
-  def method_names_from(node, found=[])
-    return found unless node.respond_to?(:type)
-    if node.type == :def || node.type == :defs
-      name = node.loc.name
-      found << content[name.begin_pos..name.end_pos - 1].to_sym
-    end
-    node.children.each do |child|
-      method_names_from(child, found) if parent_node?(child)
-    end
-    found
-  end
-
-  def constants_from(node, found=[])
-    if node.type == :const
-      expression = node.loc.expression
-      found << content[expression.begin_pos..expression.end_pos - 1]
-    end
-    node.children.each do |child|
-      constants_from(child, found) if parent_node?(child)
-    end
-    found.reject{ |constant| constant == class_name }
-  end
-
-  def extract_references_from(node, found=[])
-    return found unless node && node.respond_to?(:type)
-    if node.type == :send
-      reference = node.loc.expression
-      found << node.children.last
-    end
-    node.children.each do |child|
-      extract_references_from(child, found)
-    end
-    found.select{|name| method_list.include?(name)}
-  end
-
-  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
-    concat << node.children.map{|child| find_class(child)}.compact
-    concat.flatten.select(&:present?).join('::')
-  end
-
-  def extend_graph
-    self.edges += 2
-    self.nodes += 2
-    self.exits += 1
-  end
-
-  def methods_from(node, methods=[])
-    if node.type == :def || node.type == :defs
-      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: type,
-        refs: extract_references_from(node)
-      )
-    end
-    node.children.each do |child|
-      if parent_node?(child)
-        methods_from(child, methods)
-      end
-    end
-    methods.reject{ |m| m.name.empty? }
-  end
-
-  def parent_node?(node)
-    node.respond_to?(:type) || node.respond_to?(:children)
-  end
-
-  def parse!
-    traverse(parsed) && complexity
-  end
-
-  def parsed
-    @parsed ||= Parser::CurrentRuby.parse(content)
-  end
-
-  def traverse(node, accumulator=[], extract_methods=false)
-    accumulator << node.type
-    extend_graph if CONDITIONALS.include?(node.type)
-    node.children.each do |child|
-      if parent_node?(child)
-        accumulator << child.type
-        traverse(child, accumulator)
-      end
-    end
-    accumulator
-  end
-
-end
-

data/lib/fukuzatsu/line_of_code.rb

@@ -1,19 +0,0 @@
-class LineOfCode
-
-  include PoroPlus
-  include Ephemeral::Base
-
-  attr_accessor :line_number, :range, :content
-
-  def self.containing(locs, start_index, end_index)
-    locs.inject([]) do |a, loc|
-      a << loc if loc.in_range?(start_index) || loc.in_range?(end_index)
-      a
-    end.compact
-  end
-
-  def in_range?(index)
-    self.range.include?(index)
-  end
-
-end