snuffle 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b33ac8a8524d501103f6b30117995298fab5060
+  data.tar.gz: 9f9e2c6e58f44b28fad06aaf7645ec213b6466aa
+SHA512:
+  metadata.gz: 43437ee9b3eb9fae5729d66253d082ecb508d29e4d8e28559fd75de58d8ed51b8da347cdcef25e5ff9a456a96052a1acffc4ad9a46054254b2135dda540cb60a
+  data.tar.gz: 9f1d620ee9123654237e532c3236da8493e6e492f4dcfe791de39746438f126a17017c6c6ea5d81a146e2bc9a9b68bea52297fe5e5f2a89d46681f6e75ffa152

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.console_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,12 @@
+# Contributor Code of Conduct
+## 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.
+
+If any participant in this project has issues or takes exception with a contribution, they are obligated to provide constructive feedback and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, ability or disability, ethnicity, religion, or level of experience.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in snuffle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bantik
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Snuffle
+
+Snuffle analyzes source code to identify "data clumps", clusters of attributes
+that are often used together. It uses this analysis to propose objects that
+may be extracted from a given class.
+
+## TODO
+
+* Ignore data clumps called in "loose" class methods (e.g. attr_accessor)
+* Match on string concatenation
+* Consider weighting based on match type
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'snuffle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snuffle
+
+## Usage
+
+    $ snuffle check example.rb
+
+    +----------------------------+------------+-----------------------------+
+    |          Filename          | Host Class | Candidate Object Attributes |
+    +----------------------------+------------+-----------------------------+
+    | example.rb                 | Customer   | company_name, customer_name |
+    +----------------------------+------------+-----------------------------+
+
+## Contributing
+
+Please note that this project is released with a [Contributor Code of Conduct](https://gitlab.com/coraline/snuffle/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+1. Fork the project
+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 Merge Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/snuffle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'snuffle/cli'
+Snuffle::CLI.start

data/lib/snuffle.rb

@@ -0,0 +1,23 @@
+require 'securerandom'
+require 'ephemeral'
+require 'poro_plus'
+require 'fileutils'
+require 'haml'
+
+require_relative "snuffle/version"
+require_relative "snuffle/cohort"
+require_relative "snuffle/cli"
+require_relative "snuffle/formatters/base"
+require_relative "snuffle/formatters/csv"
+require_relative "snuffle/formatters/html"
+require_relative "snuffle/formatters/html_index"
+require_relative "snuffle/formatters/text"
+require_relative "snuffle/line_of_code"
+require_relative "snuffle/node"
+require_relative "snuffle/source_file"
+require_relative "snuffle/summary"
+require_relative "snuffle/elements/hash"
+require_relative "snuffle/util/histogram"
+
+module Snuffle
+end

data/lib/snuffle/cli.rb

@@ -0,0 +1,74 @@
+require 'thor'
+require 'snuffle'
+
+module Snuffle
+
+  class CLI < Thor
+
+    desc_text = "Formats are text (default, to STDOUT), html, and csv. "
+    desc_text << "Example: snuffle check foo/ -f html"
+
+    desc "check PATH_TO_FILE [-f FORMAT] [-t MAX_COMPLEXITY_ALLOWED]", desc_text
+    method_option :format, :type => :string, :default => 'text', :aliases => "-f"
+
+    def check(path="./")
+      summaries = []
+      file_list(path).each do |path_to_file|
+        summary = Snuffle::SourceFile.new(path_to_file: path_to_file).summary
+        report(summary, summary.source)
+        summaries << summary
+      end
+      create_html_index(summaries)
+      puts results_files.join("\n")
+    end
+
+    default_task :check
+
+    attr_accessor :last_file
+
+    private
+
+    def file_list(start_file)
+      if File.directory?(start_file)
+        return Dir.glob(File.join(start_file, "**", "*")).select{|n| n =~ /\.rb$/}
+      else
+        return [start_file]
+      end
+    end
+
+    def report(summary, source)
+      text_report(summary)
+      cvs_report(summary)
+      html_report(summary, source)
+    end
+
+    def create_html_index(summaries)
+      return unless options['format'] == 'html'
+      results_files << Snuffle::Formatters::HtmlIndex.new(summaries).export
+    end
+
+    def cvs_report(summary)
+      return unless options['format'] == 'csv'
+      return unless summary.cohorts.count > 0
+      results_files << Snuffle::Formatters::Csv.new(summary).export
+    end
+
+    def html_report(summary, source)
+      return unless options['format'] == 'html'
+      return unless summary.cohorts.count > 0
+      results_files << Snuffle::Formatters::Html.new(summary, source).export
+    end
+
+    def text_report(summary)
+      return unless options['format'] == 'text'
+      puts
+      puts Snuffle::Formatters::Text.new(summary).export
+    end
+
+    def results_files
+      @results_files ||= []
+    end
+
+  end
+
+end

data/lib/snuffle/cohort.rb

@@ -0,0 +1,42 @@
+module Snuffle
+
+  class Cohort
+
+    include PoroPlus
+    attr_accessor :element, :neighbors, :line_numbers
+
+    def self.from(nodes)
+      cohorts = Element::Hash.materialize(nodes.hashes.to_a).inject([]) do |cohorts, element|
+        cohort = Cohort.new(element: element, line_numbers: element.node.line_numbers )
+        cohorts << cohort if cohort.values.count > 1 && cohort.near_neighbors.count > 0
+        cohorts
+      end
+    end
+
+    def has_near_neighbors?
+      near_neighbors.present?
+    end
+
+    def near_neighbors
+      @near_neighbors ||= neighbors.select{ |n| (n.values & values).size == values.size }
+    end
+
+    def neighbors
+      @neighbors ||= [element.node.siblings - [self.element.node]].flatten.map{|sibling| Element::Hash.materialize([sibling]).first}
+    end
+
+    def values
+      @values ||= self.element.values
+    end
+
+    def neighbor
+      Struct.new(:element, :distance)
+    end
+
+    def distance(primary_matrix, token_matrix)
+      Snuffle::Util::Correlation.distance(primary_matrix, token_matrix)
+    end
+
+  end
+
+end

data/lib/snuffle/elements/hash.rb

@@ -0,0 +1,37 @@
+module Snuffle
+
+  module Element
+
+    class Hash
+
+      attr_accessor :node
+
+      def self.materialize(nodes=[])
+        nodes.each.map{|hash_node| new(hash_node) }.select{|h| h.pairs.present?}
+      end
+
+      def initialize(node)
+        self.node = node
+      end
+
+      def pairs
+        @pairs ||= keys.zip(values).inject({}){|hash, pair| hash[pair[0]] = pair[1]; hash}
+      end
+
+      def keys
+        node.children.map{ |child| child.children.first && child.children.first.name }
+      end
+
+      def values
+        node.children.map{ |child| child.children.last && child.children.last.name }.map(&:to_s).sort
+      end
+
+      def inspect
+        pairs
+      end
+
+    end
+
+  end
+
+end

data/lib/snuffle/formatters/base.rb

@@ -0,0 +1,57 @@
+module Snuffle
+
+  module Formatters
+
+    module Base
+
+      def self.included(klass)
+        klass.send(:attr_accessor, :summary)
+        klass.send(:attr_accessor, :source)
+      end
+
+      def initialize(summary, source="")
+        self.summary = summary
+        self.source = source
+      end
+
+      def content
+        [header, rows, footer].flatten.join("\r\n")
+      end
+
+      def columns
+        ["filename", "host class", "candidate object attributes", "source line numbers"]
+      end
+
+      def root_path
+        "doc/snuffle"
+      end
+
+      def output_path
+        FileUtils.mkpath(root_path)
+        root_path
+      end
+
+      def path_to_results
+        "#{output_path}/#{filename}"
+      end
+
+      def filename
+        base = summary.class_filename
+        base + file_extension
+      end
+
+      def file_extension
+        ""
+      end
+
+      def export
+        outfile = File.open("#{path_to_results}", 'w')
+        outfile.write(content)
+        outfile.close
+        path_to_results
+      end
+
+    end
+
+  end
+end

data/lib/snuffle/formatters/csv.rb

@@ -0,0 +1,31 @@
+module Snuffle
+  module Formatters
+
+    class Csv
+
+      include Formatters::Base
+
+      def header
+        columns.join(',')
+      end
+
+      def rows
+      #   summary.object_candidates.map do |candidate|
+      #     [summary.path_to_file, summary.class_name, "##{candidate.join(" #")}"].join(',')
+      #   end
+        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("; ")].join(',')
+        end
+      end
+
+      def footer
+      end
+
+      def file_extension
+        ".csv"
+      end
+
+    end
+
+  end
+end

data/lib/snuffle/formatters/html.rb

@@ -0,0 +1,48 @@
+require 'rouge'
+
+module Snuffle
+  module Formatters
+
+    class Html
+
+      include Formatters::Base
+
+      def formatter
+        Rouge::Formatters::HTML.new(css_class: 'highlight', line_numbers: true)
+      end
+
+      def lexer
+        lexer = Rouge::Lexers::Ruby.new
+      end
+
+      def content
+        Haml::Engine.new(output_template).render(
+          Object.new, {
+            summary: summary,
+            source_lines: preprocessed,
+            date: Time.now.strftime("%Y/%m/%d"),
+            time: Time.now.strftime("%l:%M %P")
+          }
+        )
+      end
+
+      def output_template
+        File.read(File.dirname(__FILE__) + "/templates/output.html.haml")
+      end
+
+      def preprocessed
+        formatter.format(lexer.lex(source))
+      end
+
+      def root_path
+        "doc/snuffle/source"
+      end
+
+      def file_extension
+        ".htm"
+      end
+
+    end
+
+  end
+end