snuffle 0.9.1

data/lib/snuffle/formatters/html_index.rb

@@ -0,0 +1,39 @@
+module Snuffle
+  module Formatters
+
+    class HtmlIndex
+
+      include Formatters::Base
+
+      attr_accessor :summaries
+
+      def initialize(summaries)
+        self.summaries = summaries.sort{|a,b| a.cohorts.count <=> b.cohorts.count}.reverse
+      end
+
+      def header
+        ["File", "Class", "Object Candidates"].map{|col| "<th>#{col.titleize}</th>"}.join("\r\n")
+      end
+
+      def content
+        Haml::Engine.new(output_template).render(
+          Object.new, {
+            summaries: summaries,
+            date: Time.now.strftime("%Y/%m/%d"),
+            time: Time.now.strftime("%l:%M %P")
+          }
+        )
+      end
+
+      def filename
+        "index.htm"
+      end
+
+      def output_template
+        File.read(File.dirname(__FILE__) + "/templates/index.html.haml")
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,71 @@
+!!!
+%html
+  %head
+    %title
+      Fukuzatsu
+    %link{href: "http://cdn.datatables.net/1.10.0/css/jquery.dataTables.css", rel: "stylesheet"}
+
+    %style{media: "screen", type: "text/css"}
+      body { background: #49525a; color: #fff; font-family: arial, sans-serif; padding: 2em; }
+      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%; }
+      tr.header th:first-child { border-radius: 5px 0 0 0; }
+      tr.header th:last-child { border-radius: 0 5px 0 0; }
+      tr.header th:only-child { border-radius: 5px 5px 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.even:hover, tr.odd:hover { background: rgba(128, 128, 128, 0.75) !important;}
+      tr.faint td { opacity: 0.5; font-style: italic; }
+      th { background: #000; text-align: left; padding: .5em; }
+      td { text-align: left; padding: .5em; padding-left: 1.25em !important;}
+      td.center { text-align: center; }
+      tfoot { background: #000; border-top: 10px solid #000; font-family: courier; margin-top: 4em; font-size: .75em;  }
+      a:link, a:visited { color: #fff }
+      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; }
+
+  %body
+    %table{class: "output-table"}
+      %thead
+        %tr.header
+          %th{colspan: 3}
+            .file_meta
+              %h1
+                Snuffle Analysis
+        %tr
+          %th
+            File
+          %th
+            Host Module/Class
+          %th
+            Object Candidates
+      %tbody
+        - summaries.each_with_index do |summary, i|
+          %tr{class: "#{i % 2 == 1 ? 'odd' : 'even'} #{summary.cohorts.count == 0 ? 'faint' : ''}"}
+            %td
+              - if summary.cohorts.count == 0
+                = summary.path_to_file
+              - else
+                %a{href: "source/#{summary.class_filename}.htm"}
+                  = summary.path_to_file
+            %td
+              - if summary.class_name.size > 30
+                = "..."
+                = summary.class_name[-29..-1]
+              - else
+                = summary.class_name
+            %td
+              = summary.cohorts.count
+      %tfoot
+        %tr
+          %td.center{colspan: 3}
+            %em
+              Analyzed on
+              = date
+              at
+              = time
+              by
+              %a{href: "https://gitlab.com/coraline/snuffle", target: "_new"}
+                Snuffle

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

@@ -0,0 +1,56 @@
+!!!
+%html
+  %head
+    %title
+      Snuffle:
+      = summary.class_name
+    %link{href: "http://cdn.datatables.net/1.10.0/css/jquery.dataTables.css", rel: "stylesheet"}
+    %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"}
+      = Rouge::Theme.find('thankful_eyes').render(scope: '.highlight')
+      body { line-height: 1.5em; background: #49525a; color: #fff; font-family: arial, sans-serif; font-size: 14px; padding: 2em; }
+      pre.lineno { margin-top: -1.4em !important;}
+      pre { line-height: 1.75em;}
+      span.highlighted { background: rgba(200, 0, 0, .4); padding-left: 1em; border-radius: 100px; display: inline-block; position: absolute; left: 0px; padding-right: 90%}
+      div.file_meta { padding: 1em; border-radius: 5px; background: #000; height: 3em; width: 98%; }
+      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; }
+      = ".indented {margin-left: 4em; }"
+  %body
+
+    .file_meta
+      %h1
+        = summary.class_name
+      %h2
+        = summary.path_to_file
+
+    %h3.indented
+      Candidate object attributes:
+
+    %ul.indented
+      - summary.cohorts.group_by{|c| c.values.sort }.each do |values, cohorts|
+        - if cohorts.count > 0
+          %li
+            = values.map{|c| "##{c}" }.join(", ")
+            %br
+            = ":#{cohorts.map(&:line_numbers).join(', :')}"
+
+    = source_lines
+
+    %br
+    %input{onclick: "history.back(-1)", type: "button", value: "Back"}
+
+    :javascript
+
+      var line_numbers = #{summary.cohorts.map(&:line_numbers).flatten};
+
+      $('pre.lineno').html($('pre.lineno').html().split(/\s+/).map(function(val){ if (line_numbers.indexOf(parseInt(val)) > -1) { return "<span class='highlighted'>" + val + "</span>\n" } else { return "<span class='foo'>" + val + "</span>\n"};}))
+
+      for (i = 0; i <= line_numbers; i ++) {
+        $('.code pre').html($('.code pre').html().split(/\s+/)[i].html("<span class='highlighted'>" + i + "</span>\n"))
+      }
+

data/lib/snuffle/formatters/text.rb

@@ -0,0 +1,30 @@
+require 'text-table'
+
+module Snuffle
+  module Formatters
+
+    class Text
+
+      include Formatters::Base
+
+      def header
+        columns.map(&:titleize)
+      end
+
+      def export
+        table = ::Text::Table.new
+        table.head = header
+        table.rows = rows
+        table.to_s
+      end
+
+      def rows
+        summary.cohorts.group_by{|c| c.values}.map do |cohort|
+          [summary.path_to_file, summary.class_name, "#{cohort[0].join(', ')}", cohort[1].map(&:line_numbers).join(", ")]
+        end
+      end
+
+    end
+
+  end
+end

data/lib/snuffle/line_of_code.rb

@@ -0,0 +1,23 @@
+module Snuffle
+
+  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
+
+end

data/lib/snuffle/node.rb

@@ -0,0 +1,46 @@
+module Snuffle
+
+  class Node
+
+    include Ephemeral::Base
+    include PoroPlus
+
+    attr_accessor :id, :name, :type, :child_ids, :parent_id, :line_numbers
+
+    scope :by_id,       lambda{|id| where(:id => id)}
+    scope :by_type,     lambda{|type| where(:type => type)}
+    scope :with_parent, lambda{|parent_id| where(parent_id: parent_id) }
+    scope :hashes,      {type: :hash}
+
+    def self.nil
+      new(type: :nil)
+    end
+
+    def initialize(*args, &block)
+      @id = SecureRandom.uuid
+      super
+    end
+
+    def parent
+      Snuffle::Node.where(id: self.parent_id).first
+    end
+
+    def siblings
+      @siblings ||= Snuffle::Node.by_type(self.type).to_a - [self]
+    end
+
+    def children
+      Snuffle::Node.where(parent_id: self.id)
+    end
+
+    def inspect
+      {
+        id: self.id,
+        type: self.type,
+        parent_id: self.parent_id,
+        child_ids: self.child_ids
+      }.to_s
+    end
+
+  end
+end

data/lib/snuffle/source_file.rb

@@ -0,0 +1,112 @@
+# TODO factor out poroplus here
+
+require "parser/current"
+
+module Snuffle
+
+  class SourceFile
+
+    include PoroPlus
+
+    attr_accessor :path_to_file, :source, :lines_of_code
+
+    def class_name
+      return @class_name if @class_name
+      @class_name = find_class(ast) || "?"
+    end
+
+    def nodes
+      @nodes ||= extract_nodes_from(ast)
+    end
+
+    def cohorts
+      @cohorts ||= Cohort.from(self.nodes)
+    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
+      Summary.new(
+        source_file: self,
+        source: self.source,
+        class_name: class_name,
+        path_to_file: self.path_to_file,
+        cohorts: cohorts,
+        source: self.source
+      )
+    end
+
+    private
+
+    def text_at(start_pos, end_pos)
+      source[start_pos..end_pos - 1]
+    end
+
+    def find_class(node)
+      return unless 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
+      unless node.type == :class
+        concat << node.children.map{|child| find_class(child)}.compact
+      end
+      concat.flatten.select(&:present?).join('::')
+    end
+
+    def ast
+      @ast ||= Parser::CurrentRuby.parse(source)
+    end
+
+    def extract_nodes_from(ast_node, nodes=Ephemeral::Collection.new("Snuffle::Node"), parent_id=:root)
+      if name = name_from(ast_node)
+        if ast_node.respond_to?(:type)
+          lines = LineOfCode.containing(lines_of_code, ast_node.loc.expression.begin_pos, ast_node.loc.expression.end_pos)
+          extracted_node = Snuffle::Node.new(
+            type: ast_node.type,
+            parent_id: parent_id,
+            name: name_from(ast_node),
+            line_numbers: lines.map(&:line_number)
+          )
+        else
+          extracted_node = Snuffle::Node.new(
+            type: :nil,
+            parent_id: parent_id,
+            name: name
+          )
+        end
+        nodes << extracted_node
+        ast_node.children.each{|child| extract_nodes_from(child, nodes, extracted_node.id)} if ast_node.respond_to?(:children)
+      end
+      nodes
+    end
+
+    def name_from(node)
+      return if node.nil?
+      return node unless node.respond_to?(:children)
+      if node.respond_to?(:loc) && node.loc.respond_to?(:name)
+        if name_coords = node.loc.name
+          name = source[name_coords.begin_pos, name_coords.end_pos - 1]
+          return unless name =~ /[a-zA-Z]/
+          return name
+        else
+          "?"
+        end
+      else
+        return name_from(node.children.last)
+      end
+    end
+
+  end
+
+end

data/lib/snuffle/summary.rb

@@ -0,0 +1,13 @@
+module Snuffle
+
+  class Summary
+    include PoroPlus
+    attr_accessor :class_name, :path_to_file, :cohorts, :source
+
+    def class_filename
+      self.class_name.downcase.gsub(' ', '_')
+    end
+
+  end
+
+end

data/lib/snuffle/util/histogram.rb

@@ -0,0 +1,17 @@
+module Snuffle
+  module Util
+
+    class Histogram
+
+      def self.from(arrays)
+        arrays.flatten.inject({}) do |h, value|
+          h[value] ||= 0;
+          h[value] += 1
+          h
+        end
+      end
+
+    end
+
+  end
+end

data/lib/snuffle/version.rb

@@ -0,0 +1,3 @@
+module Snuffle
+  VERSION = "0.9.1"
+end

data/snuffle.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snuffle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snuffle"
+  spec.version       = Snuffle::VERSION
+  spec.authors       = ["Coraline Ada Ehmke", "Kerri Miller"]
+  spec.email         = ["coraline@idolhands.com"]
+  spec.summary       = %q{Snuffle detects data clumps in your Ruby code.}
+  spec.description   = %q{Snuffle detects data clumps and other hints of extractable objects in your Ruby code.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "parser"
+  spec.add_dependency "thor"
+  spec.add_dependency "ephemeral", "~> 2.3.2"
+  spec.add_dependency "poro_plus"
+  spec.add_dependency "rouge"
+  spec.add_dependency "text-table"
+  spec.add_dependency "haml"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
+
+end