fukuzatsu 0.9.16 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b054a0d43c6b8b6e0f8852e28673dc7322f5680f
-  data.tar.gz: 660bfe9cfa476992326d4f9e49575ad22e1ac543
+  metadata.gz: 98e183078ac1f80b93a9f0c432ff70a5a75fb156
+  data.tar.gz: 9ff83590fd2e21f4dab4100db0bb32dc51d09468
 SHA512:
-  metadata.gz: 1d1df3c294ac5b37313936f509eaef5798bddb17cc59b299d4fc6a01d08c4be7f804b40061419792bd40ce6558e925fe7adb28fe5d10997ff0ada829673004da
-  data.tar.gz: 6e3ffa2e9ecafb78e98301bcc5097f51548ee5762b3da2934610956b4653bc2e5bd05104d644626d43e29430905e62528ef8294046f4540a0d4de8a57a7328a5
+  metadata.gz: 361c28387778b0fa9211c4401dc9d6ebfd1ad491a0a1c6857a0c57ccc32b052d3b4ec81fefbd30ca02a0304800120b89ff6781ae3188c5de8e553cb834fbcc8b
+  data.tar.gz: e8d4b595508e6fd5db7d3f057dc2325d3d1c7c694729f6caf8b09fcf6c29f8cbc79d5ab5513df4a57f6daf5944a42d15295af2c8cfb00ec8e8db4c6fb6eeec39

data/CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
-# Contributor Code of Conduct
+ODE
 ## Version 0.4
 
 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/fukuzatsu.gemspec

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

data/lib/fukuzatsu.rb

@@ -10,6 +10,7 @@ require_relative "fukuzatsu/formatters/csv"
 require_relative "fukuzatsu/formatters/html"
 require_relative "fukuzatsu/formatters/html_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/version"

data/lib/fukuzatsu/cli.rb

@@ -30,7 +30,7 @@ module Fukuzatsu
 
     def file_list(start_file)
       if File.directory?(start_file)
-        return Dir.glob(File.join(start_file, "**", "*")).select{|n| n =~ /\.rb$/}
+        return Dir.glob(File.join(start_file, "**", "*.rb"))
       else
         return [start_file]
       end
@@ -50,13 +50,13 @@ module Fukuzatsu
     def handle_index(file_summary)
       return unless options['format'] == 'html'
       index = Formatters::HtmlIndex.new(file_summary)
-      self.last_file = "#{index.output_path}/#{index.filename}"
+      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)
+      parser = formatter.new(file, file.source)
       parser.export
       self.summaries ||= []
       self.summaries << file.summary.merge(results_file: parser.path_to_results)

data/lib/fukuzatsu/formatters/base.rb

@@ -4,10 +4,12 @@ module Formatters
 
     def self.included(klass)
       klass.send(:attr_accessor, :file)
+      klass.send(:attr_accessor, :source)
     end
 
-    def initialize(file)
+    def initialize(file, source="")
       self.file = file
+      self.source = source
     end
 
     def content
@@ -23,17 +25,17 @@ module Formatters
     end
 
     def output_path
-      output_path = "#{root_path}/#{self.file.path_to_file.split('/')[0..-2].join("/")}"
+      output_path = File.dirname(File.join(root_path, self.file.path_to_file))
       FileUtils.mkpath(output_path)
       output_path
     end
 
     def path_to_results
-      "#{output_path}/#{filename}"
+      File.join(output_path, filename)
     end
 
     def filename
-      self.file.path_to_file.split('/')[-1] + file_extension
+      File.basename(self.file.path_to_file) + file_extension
     end
 
     def file_extension
@@ -42,12 +44,9 @@ module Formatters
 
     def export
       begin
-        outfile = File.open("#{path_to_results}", 'w')
-        outfile.write(content)
+        File.open(path_to_results, 'w') {|outfile| outfile.write(content)}
       rescue Exception => e
         puts "Unable to write output: #{e} #{e.backtrace}"
-      ensure
-        outfile && outfile.close
       end
     end
 

data/lib/fukuzatsu/formatters/html.rb

@@ -1,3 +1,5 @@
+require 'rouge'
+
 module Formatters
 
   class Html
@@ -13,6 +15,7 @@ module Formatters
         Object.new, {
           header: header,
           rows: rows,
+          source_lines: preprocessed,
           class_name: file.class_name,
           complexity: file.complexity,
           path_to_file: file.path_to_file,
@@ -22,10 +25,22 @@ module Formatters
       )
     end
 
+    def formatter
+      Rouge::Formatters::HTML.new(line_numbers: true)
+    end
+
+    def lexer
+      lexer = Rouge::Lexers::Ruby.new
+    end
+
     def output_template
       File.read(File.dirname(__FILE__) + "/templates/output.html.haml")
     end
 
+    def preprocessed
+      formatter.format(lexer.lex(source))
+    end
+
     def rows
       i = 0
       file.methods.inject([]) do |a, method|
@@ -46,7 +61,6 @@ module Formatters
       ".htm"
     end
 
-
   end
 
 end

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

@@ -8,9 +8,38 @@
     %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"}
+    %script{language: "javascript", src: "http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.0/highlight.min.js", type: "text/javascript"}
+    :css
+      #{Rouge::Theme.find('thankful_eyes').render(scope: '.highlight')}
       body { background: #593232; color: #fff; font-family: arial, sans-serif; padding: 2em; }
+      div.column { float: left; width: 45%; margin-left: 4%; }
+      div.file_listing { padding: .1em; border-radius: 5px; background: #000; width: 100%; border: 1px solid #000;}
+      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: 1.1em;margin-top: 1em; }
+      h3.highlighted { background: rgba(170, 161, 57, .6); border-radius: 100px; padding: .25em; padding-left: 1em; color: #000;}
+      h3.highlighted-method { background: rgba(153, 51, 80, .6); border-radius: 100px; padding-left: 1em; }
+      li { margin-bottom: 1em;}
+      pre { line-height: 1.75em;}
+      pre.lineno { margin-top: -1.4em !important;}
+      span.highlighted { padding-left: 1em; display: inline-block; position: absolute; left: 0px; padding-right: 90%}
+      a:link, a:visited { color: #aaa }
+
+      .file_listing table { width: 100%; box-shadow: 0 5px 0 rgba(0,0,0,.8); border-spacing: 0; border: 5px solid #000; border-radius: 5px; border-collapse: collapse; min-width: 50%; }
+      .file_listing td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
+      .file_listing td.gutter { background-color: rgb(109, 109, 109) !important; }
+      .file_listing tfoot { background: #000; border-top: 10px solid #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
+      .file_listing th { background: #000; text-align: left; padding: .5em; }
+      .file_listing tr.faint td { opacity: 0.5; font-style: italic; }
+      .file_listing tr.header { background-color: #222; }
+      .file_listing tr { background: rgba(0, 0, 0, 0.25) !important; border-bottom: 1px solid #000;}
+      .file_listing th { background: #000; text-align: left; padding: .5em;}
+      .file_listing td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
+      .file_listing td.center { text-align: center; }
+      .file_listing td.sorting_1 { background: none !important; padding-left: 1.25em !important; }
+      .file_listing tfoot { background: #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
+
       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}
@@ -27,15 +56,16 @@
       td.center { text-align: center; }
       td.sorting_1 { background: none !important; padding-left: 1.25em !important; }
       tfoot { background: #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
-      a:link, a:visited { color: #aaa }
-      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
     .container
       %table{class: "output-table"}
@@ -68,6 +98,11 @@
     %br
     %input{onclick: "history.back(-1)", type: "button", value: "Back"}
 
+    %br
+
+    .file_listing
+      = source_lines
+
     :javascript
       $(document).ready(function(){
         $('.output-table').dataTable({

data/lib/fukuzatsu/line_of_code.rb

@@ -0,0 +1,19 @@
+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

data/lib/fukuzatsu/parsed_file.rb

@@ -4,6 +4,7 @@ class ParsedFile
   include Ephemeral::Base
 
   attr_accessor :complexity, :path_to_file, :class_name, :path_to_results
+  attr_accessor :lines_of_code, :source
 
   def class_name
     @class_name ||= analyzer.extract_class_name
@@ -25,10 +26,23 @@ class ParsedFile
     @methods ||= analyzer.extract_methods
   end
 
+  def source
+    return @source if @source
+    end_pos = 0
+    self.lines_of_code = []
+    @source = File.readlines(self.path_to_file).each_with_index do |line, index|
+      start_pos = end_pos + 1
+      end_pos += line.size
+      self.lines_of_code << LineOfCode.new(line_number: index + 1, range: (start_pos..end_pos))
+      line
+    end.join
+  end
+
   def summary
     {
       results_file: self.path_to_results,
       path_to_file: self.path_to_file,
+      source: source,
       class_name: self.class_name,
       complexity: complexity
     }

data/lib/fukuzatsu/version.rb

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

data/spec/analyzer_spec.rb

@@ -58,6 +58,28 @@ describe Analyzer do
     end
   end
   
+  describe "extract_class_name" do
+    context "from a file with a class in it" do
+      let(:analyzer) { Analyzer.new(File.read("spec/fixtures/single_class.rb")) }
+      it "should return the name of the class" do
+        expect(analyzer.extract_class_name).to eq "Gown"
+      end
+    end
+    context "from a file with a class inside a module" do
+      let(:analyzer) { Analyzer.new(File.read("spec/fixtures/module_with_class.rb")) }
+      it "should return the name of the class" do
+        expect(analyzer.extract_class_name).to eq "Bee"
+      end
+    end
+    context "from a file with no class in it" do
+      let(:analyzer) { Analyzer.new(File.read("spec/fixtures/single_method.rb")) }
+      it "should return '?'" do
+        expect(analyzer.extract_class_name).to eq "?"
+      end
+    end
+    
+  end
+  
   describe "extract_methods" do
     # Note: should implicitly trust private method #methods_from
     context "from a file with a single method" do

data/spec/fixtures/module_with_class.rb

@@ -0,0 +1,9 @@
+module Symbolics
+  module Insects
+    class Bee
+      def correspond(letter)
+        @letter = letter
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fukuzatsu
 version: !ruby/object:Gem::Version
-  version: 0.9.16
+  version: 0.10.1
 platform: ruby
 authors:
 - Bantik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-09-22 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: rouge
+  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
@@ -166,6 +180,7 @@ files:
 - 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/version.rb
@@ -175,6 +190,7 @@ files:
 - 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
@@ -223,6 +239,7 @@ test_files:
 - 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