archruby 0.1.0

data/lib/archruby/ruby/var_propagation.rb

@@ -0,0 +1,46 @@
+module Archruby
+  module Ruby
+    class VarPropagation
+      attr_reader :vars
+
+      def initialize
+        @vars = []
+      end
+
+      def push var_name, line_number, type = nil
+        var = find_var var_name
+        if var
+          lines = var[var.keys.first][:lines]
+          lines.push(line_number)
+        else
+          @vars.push(
+            {
+              var_name =>
+                {
+                  :lines => [line_number],
+                  :type => type
+                }
+            }
+          )
+        end
+      end
+
+      def put_type var_name, type
+        var = find_var var_name
+        if var
+          var[var.keys.first][:type] = type
+        end
+      end
+
+      def find_var var_name
+        vars.each do | var |
+          if var.keys.first == var_name
+            return var
+          end
+        end
+        return nil
+      end
+
+    end
+  end
+end

data/lib/archruby/version.rb

@@ -0,0 +1,3 @@
+module Archruby
+  VERSION = "0.1.0"
+end

data/spec/architecture/architecture_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Archruby::Architecture::Architecture do
+  let(:parser) { Archruby::Architecture::Parser.new(File.expand_path('../../fixtures/new_arch_definition.yml', __FILE__), File.expand_path('../../dummy_app/', __FILE__)) }
+  let(:architecture) { Archruby::Architecture::Architecture.new(parser.modules) }
+
+  it 'have an unknown_module' do
+    architecture.unknown_module.should_not be_nil
+    architecture.unknown_module.name.should be_eql("unknown")
+  end
+
+  it 'detect the amount of architecture erosion correctly' do
+    architecture.verify
+    architecture.constraints_breaks.count.should == 5
+  end
+
+  it 'raise and error if how_many_break is called without verify the architecture' do
+    lambda{ architecture.how_many_break("module_name", "module_target_name", "constraint_type") }.should raise_error(Archruby::ArchitectureNotVerified)
+  end
+
+  it 'return the amount of constraint breaks correctly' do
+    architecture.verify
+    puts architecture.constraints_breaks.inspect
+    controller_breaks = architecture.how_many_break "controller", "facebook", Archruby::Architecture::ConstraintBreak::DIVERGENCE
+    controller_breaks.should be_eql(1)
+
+    controller_breaks = architecture.how_many_break "model", "activerecord", Archruby::Architecture::ConstraintBreak::ABSENSE
+    controller_breaks.should be_eql(2)
+
+    controller_breaks = architecture.how_many_break "model", "facebook", Archruby::Architecture::ConstraintBreak::DIVERGENCE
+    controller_breaks.should be_eql(1)
+
+    controller_breaks = architecture.how_many_break "view", "model", Archruby::Architecture::ConstraintBreak::DIVERGENCE
+    controller_breaks.should be_eql(1)
+  end
+
+  it 'return the module name correctly' do
+    architecture.module_name("ActionController").should be_eql("actioncontroller")
+    architecture.module_name("Koala").should be_eql("facebook")
+    architecture.module_name("User").should be_eql("model")
+    architecture.module_name("NAOTEMNAO").should be_eql(architecture.unknown_module.name)
+  end
+
+  it 'return the correct amount of time that an module access another module' do
+    architecture.how_many_access_to("controller", "model").should be_eql(2)
+    architecture.how_many_access_to("model", "controller").should be_eql(1)
+  end
+end

data/spec/architecture/config_definition_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Archruby::Architecture::ConfigDefinition do
+  let(:parsed_yaml) {YAML.load_file(File.expand_path('../../fixtures/new_arch_definition.yml', __FILE__))}
+  let(:mocked_yaml) { {"controller"=> {"files"=>"app/controllers/**/*.rb", "allowed"=>"model, integracao_twitter, facebook_looker, actioncontroller", "forbidden" => ["forbidden_module"]}} }
+
+  it 'return all information correctly' do
+    config_definition = Archruby::Architecture::ConfigDefinition.new 'controller', parsed_yaml['controller']
+    config_definition.files.count.should == 1
+    config_definition.gems.should be_empty
+    config_definition.required_modules.should be_empty
+    config_definition.forbidden_modules.should be_empty
+    config_definition.allowed_modules.should include("integracao_twitter")
+    config_definition.allowed_modules.should include("model")
+  end
+
+  it 'throw an execption if allowed and forbidden is used thogheter' do
+    lambda { config_definition = Archruby::Architecture::ConfigDefinition.new 'controller', mocked_yaml['controller'] }.should raise_error(Archruby::MultipleConstraints)
+  end
+end

data/spec/architecture/constraint_break_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Archruby::Architecture::ConstraintBreak do
+  it "receive an hash of options and put it in the correct attributes" do
+    arch_break = Archruby::Architecture::ConstraintBreak.new({
+      :type => Archruby::Architecture::ConstraintBreak::ABSENSE,
+      :class_origin => "Teste",
+      :line_origin => 12,
+      :class_target => "Target",
+      :module_origin => "moduloOrig",
+      :module_target => "moduloTarg",
+      :msg => "MSG"
+      })
+    arch_break.type.should == Archruby::Architecture::ConstraintBreak::ABSENSE
+    arch_break.class_origin.should == "Teste"
+    arch_break.line_origin.should == 12
+    arch_break.class_target.should == "Target"
+    arch_break.module_origin.should == "moduloOrig"
+    arch_break.module_target.should == "moduloTarg"
+    arch_break.msg.should == "MSG"
+  end
+end

data/spec/architecture/file_content_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Archruby::Architecture::FileContent do
+
+  it 'get the content from the right files' do
+    file_reader = Archruby::Architecture::FileContent.new("/Users/sergiomiranda/Labs/ruby_arch_checker/arch_checker/spec/dummy_app/app/")
+    content = file_reader.all_content_from_directory "controllers/**/*.rb"
+    content.keys.should include('application_controller')
+    content['application_controller'].should_not be_nil
+  end
+
+end

data/spec/architecture/module_definition_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Archruby::Architecture::ModuleDefinition do
+  let(:parsed_yaml) {YAML.load_file(File.expand_path('../../fixtures/new_arch_definition.yml', __FILE__))}
+  let(:parser) {Archruby::Architecture::Parser.new(File.expand_path('../../fixtures/new_arch_definition.yml', __FILE__), File.expand_path('../../dummy_app/', __FILE__)) }
+
+  it 'get file content correctly' do
+    base_directory = File.expand_path('../../dummy_app/', __FILE__)
+    config_definition = Archruby::Architecture::ConfigDefinition.new 'model', parsed_yaml['model']
+    module_definition = Archruby::Architecture::ModuleDefinition.new(config_definition, base_directory)
+    module_definition.classes.should include("Teste::Testando::VaiAcessar")
+    module_definition.classes.should include("Teste")
+    module_definition.classes.should include("User")
+    module_definition.dependencies.should include("ActiveRecord::Base")
+    module_definition.dependencies.should include("OutraClasse::De::Teste")
+    puts module_definition.classes_and_dependencies.first.should be_eql({})
+    module_definition.classes_and_dependencies[1].keys.should include("Teste")
+    module_definition.classes_and_dependencies.last.keys.should include("User")
+  end
+
+  it 'build the dependencies correctly' do
+    base_directory = File.expand_path('../../dummy_app/', __FILE__)
+    config_definition = Archruby::Architecture::ConfigDefinition.new 'model', parsed_yaml['model']
+    module_definition = Archruby::Architecture::ModuleDefinition.new(config_definition, base_directory)
+    module_definition.dependencies.count.should be_eql(6)
+    module_definition.dependencies.should include("Koala::Facebook::API")
+    module_definition.dependencies.should include("OutraClasse::De::Teste")
+    module_definition.dependencies.should include("ActiveRecord::Base")
+  end
+
+  it 'return true when the module has a particular class' do
+    base_directory = File.expand_path('../../dummy_app/', __FILE__)
+    config_definition = Archruby::Architecture::ConfigDefinition.new 'model', parsed_yaml['model']
+    module_definition = Archruby::Architecture::ModuleDefinition.new(config_definition, base_directory)
+    module_definition.is_mine?("Teste").should be_true
+    module_definition.is_mine?("User").should be_true
+    module_definition.is_mine?("ActiveRecord").should be_false
+    module_definition.is_mine?("QualquerCoisa").should be_false
+    module_definition.is_mine?("::User").should be_true
+    module_definition.is_mine?("::User::Nao::Sei").should be_false
+    module_definition.is_mine?("Testando::VaiAcessar").should be_true
+
+    config_definition = Archruby::Architecture::ConfigDefinition.new 'actioncontroller', parsed_yaml['actioncontroller']
+    module_definition = Archruby::Architecture::ModuleDefinition.new(config_definition, base_directory)
+    module_definition.is_mine?("ActionController::Base").should be_true
+  end
+
+  it 'verify required constraint correctly' do
+    architecture = Archruby::Architecture::Architecture.new(parser.modules)
+    base_directory = File.expand_path('../../dummy_app/', __FILE__)
+    config_definition = Archruby::Architecture::ConfigDefinition.new 'model', parsed_yaml['model']
+    module_definition = Archruby::Architecture::ModuleDefinition.new(config_definition, base_directory)
+    required_breaks = module_definition.verify_required architecture
+    puts required_breaks.inspect
+    required_breaks.count.should == 2
+    required_breaks.first.class_origin.should == "Teste::Testando"
+    required_breaks.last.class_origin.should == "Teste"
+  end
+
+  it 'verify forbidden constraint correctly' do
+    architecture = Archruby::Architecture::Architecture.new(parser.modules)
+    base_directory = File.expand_path('../../dummy_app/', __FILE__)
+    config_definition = Archruby::Architecture::ConfigDefinition.new 'view', parsed_yaml['view']
+    module_definition = Archruby::Architecture::ModuleDefinition.new(config_definition, base_directory)
+    forbidden_breaks = module_definition.verify_forbidden architecture
+    forbidden_breaks.count.should == 1
+    forbidden_breaks.first.class_origin.should == "ViewTest"
+  end
+
+end

data/spec/architecture/parser_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Archruby::Architecture::Parser do
+  let(:parser) {Archruby::Architecture::Parser.new(File.expand_path('../../fixtures/new_arch_definition.yml', __FILE__), File.expand_path('../../dummy_app/', __FILE__)) }
+
+  it 'extract correct modules from architecture definition file' do
+    parser.modules.should_not be_empty
+    parser.modules.count.should be_eql(12)
+  end
+
+end

data/spec/archruby_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Archruby::ExtractArchitecture do
+  let(:arch_extractor) { Archruby::ExtractArchitecture.new("../../spec/fixtures/arch_definition.yml", "/Users/sergiomiranda/Labs/ruby_arch_checker/arch_checker/spec/dummy_app/") }
+  let(:dependencies) { arch_extractor.extract_classes_and_dependencies }
+
+  it '' do
+  end
+
+end

data/spec/dummy_app/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy_app/Gemfile

@@ -0,0 +1,45 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.2'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.0'
+
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.2'
+
+group :doc do
+  # bundle exec rake doc:rails generates the API under doc/api.
+  gem 'sdoc', require: false
+end
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.1.2'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]

data/spec/dummy_app/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+DummyApp::Application.load_tasks

data/spec/dummy_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/dummy_app/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy_app/app/controllers/application_controller.rb

@@ -0,0 +1,17 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+  
+  def break_facebook_looker
+    @graph = Koala::Facebook::API.new("access_token_qualquer")
+  end
+  
+  def access_an_user_model
+    @users = User.all
+  end
+  
+  def access_an_teste_model
+    @teste = Teste.new
+  end
+end

data/spec/dummy_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy_app/app/models/module_test.rb

@@ -0,0 +1,5 @@
+module Teste::Testando
+  
+  class VaiAcessar
+  end
+end

data/spec/dummy_app/app/models/teste.rb

@@ -0,0 +1,11 @@
+class Teste
+  include ClassedeTeste
+
+  def method
+    a = OutraClasse::De::Teste.new
+  end
+  
+  def search_facebook
+    @graph = Koala::Facebook::API.new("access_token_qualquer")    
+  end
+end

data/spec/dummy_app/app/models/user.rb

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+  def teste
+    a = IntegracaoTwitter.new
+  end
+  
+  def break
+    b = ApplicationController.new
+  end
+end