arquanator 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 046751197b1a7100e57e5cf651b888252c9a54b4
+  data.tar.gz: e0b83caa6c766c46e9e085841828c736c5b767e8
+SHA512:
+  metadata.gz: e4503847a0ae10ce78c53cedd92d815022bb630d09844ecbb0b704c7ad585f1694b11da0c992da35563432c11605c09af5a2cd1343601f2182eb4f99586f03ae
+  data.tar.gz: d6f9e6f0d44c003f532c3f5bfdfe006bdf6a76875a34d7e8df305c1e8addbba92d9b318eabd86c9db5c6fa4c7f55d90f7cadce7616b2ab338616587c617b2de9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Magnus Ernstsson
+
+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,36 @@
+# Arquanator
+
+TODO: Write a gem description
+
+## Installation
+
+    $ gem install arquanator
+
+## Usage
+
+    -i                               show files
+    -o                               show folders
+    -u                               show functions
+    -l [INTEGER]                     nbr of levels (default: all)
+    -p [PROVIDER]                    data provider (default: llvm)
+    -g [GENERATOR]                   report generator (default: graphviz)
+    -r [ROOT]                        analysis root
+
+### Available providers
+
+* llvm
+* gcc
+
+### Available generators
+
+* graphviz
+* smells
+* dependencies
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/arquanator.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arquanator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "arquanator"
+  gem.version       = Arquanator::VERSION
+  gem.authors       = ["Magnus Ernstsson"]
+  gem.email         = ["magnus@ernstsson.net"]
+  gem.description   = %q{Write a gem description}
+  gem.summary       = %q{Write a gem summary}
+  gem.homepage      = "https://github.com/ernstsson/Arquanator"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+end

data/bin/arquanator

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'arquanator'
+
+Arquanator.run ARGV
+

data/lib/arquanator.rb

@@ -0,0 +1,25 @@
+require 'arquanator_options'
+require 'providers/provider_factory'
+require 'generators/generator_factory'
+require 'model/folder_node'
+
+module Arquanator
+	def self.run(args)
+		options = ArquanatorOptions.new
+		config = options.parse args
+		puts args.empty? ? options.message : run_generator(config, args)
+	end
+
+	private
+
+	def self.run_generator(config, args)
+		root = FolderNode.new "", "", :public, 0
+		provider = ProviderFactory.create_provider config, root
+		generator = GeneratorFactory.create_generator config
+		args.each do |file_name|
+			file = File.open file_name, "r"
+			provider.parse file_name, file
+		end
+		generator.generate(root)
+	end
+end

data/lib/arquanator/version.rb

@@ -0,0 +1,3 @@
+module Arquanator
+  VERSION = "0.0.2"
+end

data/lib/arquanator_options.rb

@@ -0,0 +1,47 @@
+require 'optparse'
+
+class ArquanatorOptions
+	def initialize
+		@config = {
+			:levels => 0,
+			:provider => "llvm",
+			:generator => "graphviz",
+		}
+		@parser = OptionParser.new do |opts|
+			opts.on("-i", "show files") do |files|
+				@config[:files] = files
+			end
+			opts.on("-o", "show folders") do |folders|
+				@config[:folders] = folders
+			end
+			opts.on("-u", "show functions") do |functions|
+				@config[:functions] = functions
+			end
+			opts.on("-l [INTEGER]", OptionParser::DecimalInteger,
+					"nbr of levels (default: all)") do |levels|
+				@config[:levels] = levels
+			end
+			opts.on("-p [PROVIDER]",
+					"data provider (default: llvm)") do |provider|
+				@config[:provider] = provider
+			end
+			opts.on("-g [GENERATOR]",
+					"report generator (default: graphviz)") do |generator|
+				@config[:generator] = generator
+			end
+			opts.on("-r [ROOT]", "analysis root") do |root|
+				@config[:root] = root
+			end
+		end
+	end
+
+	def parse(args)
+		@parser.parse! args
+		@config
+	end
+
+	def message
+		msg = []
+		@parser.summarize msg
+	end
+end

data/lib/generators/dependency_list/dependency_list_generator.rb

@@ -0,0 +1,31 @@
+class DependencyListGenerator
+	def initialize(config)
+		@dependencies = []
+	end
+
+	def generate(node)
+		"#{generate_list node}"
+	end
+
+	private
+
+	def generate_list(node)
+		extract_dependencies node
+		@dependencies.sort!
+		@dependencies.join "\n"
+	end
+
+	def extract_dependencies(node)
+		if node.respond_to? :nodes
+			node.dependencies.each do |toname, fromdep|
+				fromdep.each do |fromname, value|
+					path = (node.path != "") ? "#{node.path}/" : ""
+					@dependencies << "#{path}#{fromname} -> #{path}#{toname}"
+				end
+			end
+			node.nodes.each_value do |subnode|
+				extract_dependencies subnode
+			end
+		end
+	end
+end

data/lib/generators/generator_factory.rb

@@ -0,0 +1,18 @@
+require "generators/nil_generator"
+require "generators/graphviz/graphviz_generator"
+require "generators/smell_list/smell_list_generator"
+require "generators/dependency_list/dependency_list_generator"
+
+class GeneratorFactory
+	@generators = {
+		"graphviz" => GraphvizGenerator,
+		"smells" => SmellListGenerator,
+		"dependencies" => DependencyListGenerator
+	}
+	@generators.default = NilGenerator
+
+	def self.create_generator(config)
+		generator_class = @generators[config[:generator]]
+		generator = generator_class.new config
+	end
+end

data/lib/generators/graphviz/collection_drawer.rb

@@ -0,0 +1,93 @@
+require "generators/graphviz/graph_drawer"
+
+class CollectionDrawer < GraphDrawer
+	def initialize(node, config, factory)
+		super node, config, factory
+	end
+
+	def draw
+		"#{draw_header}#{draw_dependencies}#{draw_children}}\n"
+	end
+
+	private
+
+	def draw_dependencies
+		graph = ""
+		@node.dependencies.each do |todep, fromdeps|
+			fromdeps.each do |fromdep, params|
+				graph += show_dependency?(fromdep, todep) ?
+					draw_dependency(fromdep, todep, params) : ""
+			end
+		end
+		graph
+	end
+
+	def draw_dependency(fromdep, todep, params)
+		graph = ""
+		color = params[:circ] ?
+			", color=crimson, fontcolor=crimson, style=bold" : ""
+		graph += "\"#{@node.path}/#{fromdep}\"->\""
+		graph += "#{@node.path}/#{todep}\" "
+		graph += "[label=\"#{params[:dep]}\"#{color}"
+		if @node.level + 1 < @config[:levels] or @config[:levels] == 0
+			graph += show_tail?(fromdep, todep) ?
+				", ltail=\"cluster_#{@node.path}/#{fromdep}\"" : ""
+			graph += show_head?(fromdep, todep) ?
+				", lhead=\"cluster_#{@node.path}/#{todep}\"" : ""
+		end
+		graph += "];\n"
+	end
+
+	def show_file_dependency?(fromdep, todep)
+		@config[:files] or
+		!(@node.nodes[fromdep].file? or @node.nodes[todep].file?)
+	end
+
+	def show_function_dependency?(fromdep, todep)
+		@config[:functions] or
+		!(@node.nodes[fromdep].function? or @node.nodes[todep].function?)
+	end
+
+	def show_dependency?(fromdep, todep)
+		show_file_dependency?(fromdep, todep) and
+		show_function_dependency?(fromdep, todep)
+	end
+
+	def show_tail?(fromdep, todep)
+		@node.nodes[fromdep].file? and
+		@config[:functions] or @node.nodes[fromdep].folder?
+	end
+
+	def show_head?(fromdep, todep)
+		@node.nodes[todep].file? and
+		@config[:functions] or @node.nodes[todep].folder?
+	end
+
+	def draw_child(child)
+		drawer = @factory.create_drawer child
+		drawer.draw
+	end
+
+	def draw_children
+		graph = ""
+		@node.nodes.each_value do |child|
+			graph += draw_child child
+		end
+		graph
+	end
+
+	def draw_header
+		url = @config[:url] ? "#{draw_folder_url};" : ""
+		report_label = draw_report_label
+		report_label = report_label.empty? ?
+			report_label : "\\n#{report_label}"
+		"subgraph \"cluster_#{@node.path}\" {\n"\
+			"#{draw_report_color(";")};"\
+			"#{url}"\
+			"style=filled;"\
+			"label=\"#{draw_name_label}"\
+			"#{report_label}\";\n"\
+			"\"#{@node.path}\" "\
+			"[shape=none, label=\"\", width=0, style=invisible];\n"
+	end
+end

data/lib/generators/graphviz/empty_collection_drawer.rb

@@ -0,0 +1,26 @@
+require "generators/graphviz/graph_drawer"
+
+class EmptyCollectionDrawer < GraphDrawer
+	def initialize(node, config, factory)
+		super node, config, factory
+	end
+
+	def draw
+		draw_children
+	end
+
+	private
+
+	def draw_child(child)
+		drawer = @factory.create_drawer child
+		drawer.draw
+	end
+
+	def draw_children
+		graph = ""
+		@node.nodes.each_value do |child|
+			graph += draw_child child
+		end
+		graph
+	end
+end

data/lib/generators/graphviz/empty_drawer.rb

@@ -0,0 +1,11 @@
+require "generators/graphviz/graph_drawer"
+
+class EmptyDrawer < GraphDrawer
+	def initialize(node, config, factory)
+		super node, config, factory
+	end
+
+	def draw
+		""
+	end
+end

data/lib/generators/graphviz/file_leaf_drawer.rb

@@ -0,0 +1,24 @@
+require "generators/graphviz/graph_drawer"
+
+class FileLeafDrawer < GraphDrawer
+	def initialize(node, config, factory)
+		super node, config, factory
+	end
+
+	def draw
+		url = @config[:url] ? "#{draw_file_url}, " : ""
+		"\"#{@node.path}\" ["\
+			"#{url}"\
+			"#{draw_report_color(", ")}, "\
+			"label=\"{#{draw_name_label}"\
+			"|#{draw_report_label}|}\", shape=record, style=filled];\n"
+	end
+
+	private
+
+	def draw_file_url
+		offset =  @config[:root] ? @config[:root].length + 1 : 0
+		url = @node.path.slice offset..-1
+		"URL=\"#{url}.svg\" "
+	end
+end

data/lib/generators/graphviz/folder_leaf_drawer.rb

@@ -0,0 +1,19 @@
+require "generators/graphviz/graph_drawer"
+
+class FolderLeafDrawer < GraphDrawer
+	def initialize(node, config, factory)
+		super node, config, factory
+	end
+
+	def draw
+		url = @config[:url] ? "#{draw_folder_url}, " : ""
+		report_label = draw_report_label
+		report_label = report_label.empty? ?
+			report_label : "\\n#{report_label}"
+		"\"#{@node.path}\" ["\
+			"#{url}"\
+			"#{draw_report_color(", ")}, "\
+			"label=\"#{draw_name_label}#{report_label}\", "\
+			"shape=tab, style=filled];\n"
+	end
+end