reconn 0.1.0

data/spec/test_projects/multiple_files_project/analyzer.rb

@@ -0,0 +1,111 @@
+# @author Mateusz Czarnecki <mateusz.czarnecki92@gmail.com>
+
+require 'ruby_parser'
+require 'sexp_processor'
+require_relative 'util/project_scanner'
+require_relative 'analyzer/project_elements/class.rb'
+require_relative 'analyzer/project_elements/method.rb'
+
+module Analyzer
+  class Analyzer < MethodBasedSexpProcessor
+    def initialize
+      super()
+      self.auto_shift_type = false
+      @classes = []
+      @methods = []
+      @smells = []
+      @current_class = Class.new(:none)
+    end
+
+    # Analyzes all the ruby files in the given directory and its subdirectories
+    # @param dir [String] path to the directory
+    # @return [Array(Array<Class>, Array<Method>, Array<CodeSmell>)] found classes,
+    #  methods and code smells
+    def analyze(dir)
+      parser = RubyParser.new
+      paths = ProjectScanner.scan(dir)
+      paths.each do |path|
+        @current_path = path
+        ast = parser.process(File.binread(path), path)
+        process ast
+        @current_class = Class.new(:none)
+      end
+
+      @classes.each {|klass| klass.lines = count_lines_in_class(klass)}
+      prune_dependencies
+
+      return @classes, @methods, @smells
+    end
+
+    #########################################
+    # Process methods:
+
+    def process_class(exp)
+      exp.shift
+      class_name = exp.shift.to_s
+      @current_class = Class.new(class_name)
+      @classes << @current_class
+      process_until_empty exp
+      s()
+    end
+
+    def process_defn(exp)
+      exp.shift
+      method_name = exp.shift.to_s
+      lines = count_lines_in_method(method_name)
+      method = Method.new(method_name, @current_class.name, lines)
+      @methods << method
+      @current_class.add_method(method)
+      exp.shift
+      process_until_empty exp
+      s()
+    end
+
+    def process_const(exp)
+      exp.shift
+      name = exp.shift.to_s
+      is_class = !(Object.const_get(name) rescue nil).nil?
+      @current_class.add_dependency(name) if is_class
+
+      exp.shift
+      process_until_empty exp
+      s()
+    end
+
+    ########################################
+
+    #Counts lines of code in a method
+    #
+    #@param method_name [String] the name of the method
+    #@return [Integer] lines of code count
+    def count_lines_in_method(method_name)
+      flag = false
+      lines = []
+      File.foreach(@current_path) do |line|
+        break if line =~ /def/ && flag
+        lines << line if flag && line.strip != '' && line.strip[0] != '#'
+        flag = true if line =~ /def #{method_name}/
+      end
+
+      lines.size
+    end
+
+    #Counts lines of code in a class (sums LOC of methods)
+    #
+    #@param klass [Class] the class
+    #@return [Integer] lines of code count
+    def count_lines_in_class(klass)
+      lines = klass.methods.map {|method| method.lines}.inject(:+)
+      lines.nil? ? 0 : lines
+    end
+
+    #Deletes dependencies which are not classes within analyzed project
+    def prune_dependencies
+      class_names = @classes.map {|klass| klass.name}
+      @classes.each do |klass|
+        klass.dependencies = klass.dependencies.uniq.keep_if {|dep| class_names.include?(dep)}
+      end
+    end
+
+  end
+end

data/spec/test_projects/multiple_files_project/view.rb

@@ -0,0 +1,189 @@
+require_relative '../analyzer.rb'
+require_relative '../visualizer.rb'
+
+class View
+
+	include GladeGUI
+
+	def before_show()
+    dialog_response, dialog = show_file_chooser_dialog
+    if dialog_response == Gtk::Dialog::RESPONSE_ACCEPT
+      analyzer = Analyzer::Analyzer.new
+      @classes, @methods, @smells = analyzer.analyze(dialog.filename)
+
+      @general_stats_view = build_general_stats_view
+      @builder['dataviewport'].add(@general_stats_view)
+    end
+    dialog.destroy
+	end
+
+#########################################
+  # On button clicked methods
+
+	def on_general_stats_button_clicked
+    clean_data_view
+
+    unless @general_stats_view
+      @general_stats_view = build_general_stats_view
+    end
+
+    @builder['dataviewport'].add(@general_stats_view)
+	end
+
+  def on_class_stats_button_clicked
+    clean_data_view
+
+    unless @class_stats_view
+      @class_stats_view = build_class_stats_view
+    end
+
+    @builder['dataviewport'].add(@class_stats_view)
+  end
+
+  def on_class_diag_button_clicked
+    clean_data_view
+
+    unless @class_diag_view
+      @class_diag_view = build_class_diag_view
+    end
+
+    @builder['dataviewport'].add(@class_diag_view)
+  end
+
+  def on_class_dep_button_clicked
+    clean_data_view
+
+    unless @class_dep_view
+    end
+
+    @builder['dataviewport'].add(Gtk::TextView.new)
+  end
+
+  def on_method_stats_button_clicked
+    clean_data_view
+
+    unless @method_stats_view
+      @method_stats_view = build_method_stats_view
+    end
+
+    @builder['dataviewport'].add(@method_stats_view)
+  end
+
+  def on_method_diag_button_clicked
+    clean_data_view
+
+    unless @method_diag_view
+    end
+
+    @builder['dataviewport'].add(Gtk::TextView.new)
+  end
+
+  def on_if_smell_button_clicked
+    clean_data_view
+
+    unless @if_smell_view
+      @if_smell_view = build_if_smell_view
+    end
+
+    @builder['dataviewport'].add(@if_smell_view)
+  end
+
+  def on_method_smell_button_clicked
+    clean_data_view
+
+    unless @method_smell_view
+      @method_smell_view = build_method_smell_view
+    end
+
+    @builder['dataviewport'].add(@method_smell_view)
+  end
+
+###########################################
+    # View builders
+
+  def build_general_stats_view
+      lines = 0
+      @methods.each do |method|
+        lines += method.lines
+      end
+
+      text_arr = ["Total number of classes: #{@classes.length} \n"]
+      text_arr << "Total number of methods: #{@methods.length} \n"
+      text_arr << "Total number of lines of code: #{lines}"
+      build_text_view(text_arr.join)
+  end
+
+  def build_class_stats_view
+    largest_class = @classes.sort.pop
+
+    class_methodnum = Hash.new(0)
+    @classes.each do |klass|
+      class_methodnum.store(klass.name, klass.methods.size)
+    end
+    class_methodnum = class_methodnum.sort_by {|name, methods| methods}
+
+    text_arr = ["Largest class: #{largest_class} \n"]
+    text_arr << "Number of lines: #{largest_class.lines} \n"
+    text_arr << "\n"
+    text_arr << "Class with largest number of methods: #{class_methodnum.last[0]} \n"
+    text_arr << "Number of methods: #{class_methodnum.last[1]} \n"
+    build_text_view(text_arr.join)
+  end
+
+  def build_method_stats_view
+    largest_method = @methods.sort.pop
+    text_arr = ["Largest method: #{largest_method} \n"]
+    text_arr << "Number of lines: #{largest_method.lines}"
+    build_text_view(text_arr.join)
+  end
+
+  def build_if_smell_view
+      text_arr = []
+      build_text_view(text_arr.join)
+  end
+
+  def build_method_smell_view
+      text_arr = []
+      build_text_view(text_arr.join)
+  end
+
+  def build_text_view(text)
+      stats_view = Gtk::TextView.new
+      stats_view.editable = false
+      stats_view.cursor_visible = false
+      stats_view.buffer.text = text
+      stats_view.show
+      stats_view
+  end
+
+  def build_class_diag_view
+    binary_chart = Visualizer.make_class_pie_chart(@classes)
+    loader = Gdk::PixbufLoader.new("png")
+    loader.last_write(binary_chart)
+    chart = loader.pixbuf
+    Gtk::Image.new(chart).show
+  end
+
+##########################################
+
+  def show_file_chooser_dialog
+    dialog = Gtk::FileChooserDialog.new("Open File",
+                                       nil,
+                                       Gtk::FileChooser::ACTION_SELECT_FOLDER,
+                                       nil,
+                                       [Gtk::Stock::CANCEL, Gtk::Dialog::RESPONSE_CANCEL],
+                                       [Gtk::Stock::OPEN, Gtk::Dialog::RESPONSE_ACCEPT])
+    dialog_response = dialog.run
+    return dialog_response, dialog
+  end
+
+  def clean_data_view
+    @builder['dataviewport'].each do |child|
+      @builder['dataviewport'].remove(child)
+    end
+  end
+
+  private :build_general_stats_view, :build_class_stats_view,
+    :build_method_stats_view, :build_if_smell_view,
+    :build_method_smell_view, :build_text_view
+end

data/spec/test_projects/one_file_project/analyzer.rb

@@ -0,0 +1,111 @@
+# @author Mateusz Czarnecki <mateusz.czarnecki92@gmail.com>
+
+require 'ruby_parser'
+require 'sexp_processor'
+require_relative 'util/project_scanner'
+require_relative 'analyzer/project_elements/class.rb'
+require_relative 'analyzer/project_elements/method.rb'
+
+module Analyzer
+  class Analyzer < MethodBasedSexpProcessor
+    def initialize
+      super()
+      self.auto_shift_type = false
+      @classes = []
+      @methods = []
+      @smells = []
+      @current_class = Class.new(:none)
+    end
+
+    # Analyzes all the ruby files in the given directory and its subdirectories
+    # @param dir [String] path to the directory
+    # @return [Array(Array<Class>, Array<Method>, Array<CodeSmell>)] found classes,
+    #  methods and code smells
+    def analyze(dir)
+      parser = RubyParser.new
+      paths = ProjectScanner.scan(dir)
+      paths.each do |path|
+        @current_path = path
+        ast = parser.process(File.binread(path), path)
+        process ast
+        @current_class = Class.new(:none)
+      end
+
+      @classes.each {|klass| klass.lines = count_lines_in_class(klass)}
+      prune_dependencies
+
+      return @classes, @methods, @smells
+    end
+
+    #########################################
+    # Process methods:
+
+    def process_class(exp)
+      exp.shift
+      class_name = exp.shift.to_s
+      @current_class = Class.new(class_name)
+      @classes << @current_class
+      process_until_empty exp
+      s()
+    end
+
+    def process_defn(exp)
+      exp.shift
+      method_name = exp.shift.to_s
+      lines = count_lines_in_method(method_name)
+      method = Method.new(method_name, @current_class.name, lines)
+      @methods << method
+      @current_class.add_method(method)
+      exp.shift
+      process_until_empty exp
+      s()
+    end
+
+    def process_const(exp)
+      exp.shift
+      name = exp.shift.to_s
+      is_class = !(Object.const_get(name) rescue nil).nil?
+      @current_class.add_dependency(name) if is_class
+
+      exp.shift
+      process_until_empty exp
+      s()
+    end
+
+    ########################################
+
+    #Counts lines of code in a method
+    #
+    #@param method_name [String] the name of the method
+    #@return [Integer] lines of code count
+    def count_lines_in_method(method_name)
+      flag = false
+      lines = []
+      File.foreach(@current_path) do |line|
+        break if line =~ /def/ && flag
+        lines << line if flag && line.strip != '' && line.strip[0] != '#'
+        flag = true if line =~ /def #{method_name}/
+      end
+
+      lines.size
+    end
+
+    #Counts lines of code in a class (sums LOC of methods)
+    #
+    #@param klass [Class] the class
+    #@return [Integer] lines of code count
+    def count_lines_in_class(klass)
+      lines = klass.methods.map {|method| method.lines}.inject(:+)
+      lines.nil? ? 0 : lines
+    end
+
+    #Deletes dependencies which are not classes within analyzed project
+    def prune_dependencies
+      class_names = @classes.map {|klass| klass.name}
+      @classes.each do |klass|
+        klass.dependencies = klass.dependencies.uniq.keep_if {|dep| class_names.include?(dep)}
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: reconn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Czarnecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vrlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.16
+- !ruby/object:Gem::Dependency
+  name: gtk2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.6.3
+- !ruby/object:Gem::Dependency
+  name: sexp_processor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.4.4
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mateusz.czarnecki92@gmail.com
+executables:
+- reconn
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/reconn
+- lib/reconn.rb
+- lib/reconn/analyzer.rb
+- lib/reconn/analyzer/code_smell.rb
+- lib/reconn/analyzer/project_elements/class.rb
+- lib/reconn/analyzer/project_elements/method.rb
+- lib/reconn/util/project_scanner.rb
+- lib/reconn/version.rb
+- lib/reconn/view/glade/View.glade
+- lib/reconn/view/view.rb
+- lib/reconn/visualizer.rb
+- reconn.gemspec
+- spec/reconn/analyzer/analyzer_spec.rb
+- spec/reconn/analyzer/code_smells/code_smell_spec.rb
+- spec/reconn/analyzer/code_smells/if_smell_spec.rb
+- spec/reconn/analyzer/code_smells/too_big_method_smell_spec.rb
+- spec/reconn/analyzer/project_elements/class_spec.rb
+- spec/reconn/analyzer/project_elements/method_spec.rb
+- spec/reconn/util/project_scanner_spec.rb
+- spec/spec_helper.rb
+- spec/test_projects/empty_project/not_rb_file
+- spec/test_projects/multiple_files_project/analyzer.rb
+- spec/test_projects/multiple_files_project/view.rb
+- spec/test_projects/one_file_project/analyzer.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A tool for analysis and visualization of projects written in Ruby
+test_files:
+- spec/reconn/analyzer/analyzer_spec.rb
+- spec/reconn/analyzer/code_smells/code_smell_spec.rb
+- spec/reconn/analyzer/code_smells/if_smell_spec.rb
+- spec/reconn/analyzer/code_smells/too_big_method_smell_spec.rb
+- spec/reconn/analyzer/project_elements/class_spec.rb
+- spec/reconn/analyzer/project_elements/method_spec.rb
+- spec/reconn/util/project_scanner_spec.rb
+- spec/spec_helper.rb
+- spec/test_projects/empty_project/not_rb_file
+- spec/test_projects/multiple_files_project/analyzer.rb
+- spec/test_projects/multiple_files_project/view.rb
+- spec/test_projects/one_file_project/analyzer.rb