archruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 045c1e67aaae360b110e2f9141b3b30bcc69c836
+  data.tar.gz: e4c92b6dfea42ffe218b4c5f26db3e8c1ad70021
+SHA512:
+  metadata.gz: 67f954a1279803d686c882e72cbd16a5d692b585c8e841c4a2d4c7959b08eea72cd18f5ca2c8fb4b9af85c62962dde443766d4c71246544f617a43df6eb5c43c
+  data.tar.gz: ead18f3112485bdaa5a369d7e99fe82554407393cec180a72e27e70d763ec6001627314989da588b69429526f8d0c48fe4af6baa88ad4a4b6ddfdcb7e4f8718f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sergio Henrique
+
+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,32 @@
+# ArchChecker
+
+This gem aims to verify whether the system architecture is being respected by the developers. The application architecture is defined by the Software Architect through a YML file. After defining the architecture, you can use the tool to analyze if any part of the architecture is being broken in the system. To do this analysis it is necessary to pass the architecture definition file and the root path of the application to the ArchChecker executable. The ArchChecker will do an static scan in the application and generate an yaml file containing the violations. One picture of the entire application with all the communications will be generated either.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'arch_checker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arch_checker
+
+## Usage
+
+### Defining the architecture
+
+### Invoking the arch_ckecker executable
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/archruby.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'archruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "archruby"
+  spec.version       = Archruby::VERSION
+  spec.authors       = ["Sergio Henrique"]
+  spec.email         = ["sergiohenriquetp@gmail.com"]
+  spec.description   = %q{Compliance and Architectural Visualization in Ruby systems}
+  spec.summary       = %q{Compliance and Architectural Visualization in Ruby systems}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "ruby_parser"
+  spec.add_runtime_dependency "sexp_processor"
+  spec.add_runtime_dependency "ruby-graphviz"
+
+end

data/bin/archruby

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'archruby'
+
+config_path = nil
+app_root_path = nil
+ARGV.each do |arg|
+  option, value = arg.split('=')
+  config_path = value if option.eql?('--arch_def_file')
+  app_root_path = value if option.eql?('--app_root_path')
+end
+
+arch_checker = Archruby::ExtractArchitecture.new(config_path, app_root_path)
+constraints_breaks = arch_checker.verify
+
+Archruby::Presenters::Yaml.new.render(arch_checker.architecture)
+Archruby::Presenters::Graph.new.render(arch_checker.architecture)

data/bin/constraints_breaks.yml

@@ -0,0 +1,29 @@
+---
+- divergence:
+    class_origin: TwitterController
+    line_origin: 21
+    class_target: Twitter::REST::Client
+    module_origin: controller
+    module_target: twitter
+    message: accessing a module not allowed
+- divergence:
+    class_origin: Teste
+    line_origin: 3
+    class_target: SearchTerm
+    module_origin: view
+    module_target: model
+    message: accessing a module which is forbidden
+- absence:
+    class_origin: TesteClass
+    line_origin: 
+    class_target: 
+    module_origin: model
+    module_target: activerecord
+    message: not implement a required module
+- divergence:
+    class_origin: TwitterIntegration
+    line_origin: 19
+    class_target: PdfIntegration
+    module_origin: integracao_twitter
+    module_target: integracao_pdf
+    message: accessing a module not allowed

data/constraints_breaks.yml

@@ -0,0 +1,22 @@
+---
+- divergence:
+    class_origin: ApplicationController
+    line_origin: 1
+    class_target: ActionController::Base
+    module_origin: controller
+    module_target: ''
+    message: accessing a module not allowed
+- divergence:
+    class_origin: ViewTest
+    line_origin: 3
+    class_target: User
+    module_origin: view
+    module_target: model
+    message: accessing a module which is forbidden
+- absence:
+    class_origin: Teste
+    line_origin: 
+    class_target: 
+    module_origin: model
+    module_target: activerecord
+    message: not implement a required module

data/lib/archruby.rb

@@ -0,0 +1,47 @@
+require "archruby/version"
+
+require 'archruby/architecture/parser'
+require 'archruby/architecture/config_definition'
+require 'archruby/ruby/parser'
+require 'archruby/ruby/std_library'
+require 'archruby/ruby/core_library'
+require 'archruby/ruby/var_propagation'
+require 'archruby/architecture/file_content'
+require 'archruby/architecture/module_definition'
+require 'archruby/architecture/dependency'
+require 'archruby/architecture/constraint_break'
+require 'archruby/architecture/architecture'
+require 'archruby/presenters/text'
+require 'archruby/presenters/graph'
+require 'archruby/presenters/yaml'
+
+module Archruby
+  class ExtractArchitecture
+    attr_reader :architecture
+
+    def initialize config_file_path = "", base_directory = ""
+      @config_file_path = config_file_path
+      @base_directory = base_directory
+      @architecture_definition = Archruby::Architecture::Parser.new(File.expand_path(@config_file_path, __FILE__), @base_directory)
+      @architecture = Archruby::Architecture::Architecture.new(@architecture_definition.modules)
+      @constraints_breaks = []
+    end
+
+    def verify
+      @constraints_breaks = @architecture.verify
+    end
+  end
+
+  class Error < StandardError
+    def self.status_code(code)
+      define_method(:status_code) { code }
+    end
+
+    def self.msg(msg)
+      define_method(:msg) { msg }
+    end
+  end
+
+  class MultipleConstraints < Archruby::Error; status_code(2) ; msg("Allowed and Forbidden in same module definition") end
+  class ArchitectureNotVerified < Archruby::Error; status_code(3) ; msg("The architecture need to be verified first") end
+end

data/lib/archruby/architecture/architecture.rb

@@ -0,0 +1,83 @@
+module Archruby
+  module Architecture
+
+    class Architecture
+      attr_reader :constraints_breaks, :modules, :unknown_module
+
+      def initialize modules
+        @modules = modules
+        @constraints_breaks = []
+        @unknown_module = @modules.select{ |module_definition| module_definition.name == "unknown" }.first
+      end
+
+      def verify
+        @modules.each do |module_name|
+          contraints_breaks = module_name.verify_constraints(self)
+          if !contraints_breaks.empty?
+            @constraints_breaks << contraints_breaks
+          end
+        end
+        @constraints_breaks = @constraints_breaks.flatten
+        @constraints_breaks
+      end
+
+      def how_many_break module_name, module_target, constraint_type
+        raise ArchitectureNotVerified if @constraints_breaks.empty?
+        count = 0
+        @constraints_breaks.each do |constraint_break|
+          if constraint_break.type == constraint_type && constraint_break.module_origin == module_name && constraint_break.module_target == module_target
+            count += 1
+          end
+        end
+        count
+      end
+
+      def module_name class_name
+        module_name_to_return = ''
+        @modules.each do |module_name|
+          if module_name.is_mine? class_name
+            module_name_to_return = module_name.name
+            break
+          end
+        end
+        if module_name_to_return.eql? ''
+          @unknown_module.name
+        else
+          module_name_to_return
+        end
+      end
+
+      def how_many_access_to module_origin, module_dest
+        module_origin = search_module module_origin
+        count = 0
+        module_origin.classes_and_dependencies.each do |class_dependencies|
+          class_dependencies.each do |klass, dependencies|
+            dependencies.each do |dependency|
+              dependency_module_name = module_name dependency.class_name
+              if dependency_module_name == module_dest
+                count += 1
+              end
+            end
+          end
+        end
+        count
+      end
+
+      def is_ruby_internals? module_name
+        module_name == Archruby::Ruby::STD_LIB_NAME || module_name == Archruby::Ruby::CORE_LIB_NAME
+      end
+
+    private
+
+      def search_module module_name
+        @modules.each do |module_definition|
+          if module_definition.name == module_name
+            return module_definition
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/archruby/architecture/config_definition.rb

@@ -0,0 +1,66 @@
+module Archruby
+  module Architecture
+
+    class ConfigDefinition
+
+      ALLOWED_CONSTRAINTS = ['required', 'allowed', 'forbidden']
+
+      attr_reader :module_name, :files, :gems, :allowed_modules, :required_modules, :forbidden_modules
+
+      def initialize module_name, definitions
+        @module_name = module_name
+        @files = parse_files definitions['files']
+        @gems = parse_gems definitions['gems']
+        parse_constraints definitions
+      end
+
+      def parse_files files
+        files = '' if files.nil?
+        files = files.split(',')
+        normalize_string_spaces files
+        files
+      end
+
+      def parse_gems gems
+        gems = '' if gems.nil?
+        gems = gems.split(',')
+        normalize_string_spaces gems
+        gems
+      end
+
+      def parse_constraints definitions
+        check_constraints definitions
+        ALLOWED_CONSTRAINTS.each do |constraint|
+          constraint_definition = definitions[constraint]
+          constraint_definition = '' if constraint_definition.nil?
+          send "#{constraint}_modules=", normalize_string_spaces(constraint_definition.split(','))
+        end
+      end
+
+      def normalize_string_spaces array_of_strings
+        array_of_strings.map! {|element| element.strip }
+      end
+
+      def allowed_modules=(modules)
+        @allowed_modules = modules
+      end
+
+      def required_modules=(modules)
+        @required_modules = modules
+      end
+
+      def forbidden_modules=(modules)
+        @forbidden_modules = modules
+      end
+
+    private
+
+      def check_constraints definitions
+        raise MultipleConstraints if definitions['allowed'] && !definitions['allowed'].empty? && definitions['forbidden'] && !definitions['forbidden'].empty?
+      end
+
+
+    end
+
+  end
+end

data/lib/archruby/architecture/constraint_break.rb

@@ -0,0 +1,22 @@
+module Archruby
+  module Architecture
+    class ConstraintBreak
+      attr_reader :type, :class_origin, :line_origin, :class_target, :module_origin,
+      :module_target, :msg
+
+      ABSENSE = "absence"
+      DIVERGENCE = "divergence"
+
+      def initialize options
+        @type = options[:type]
+        @class_origin = options[:class_origin]
+        @line_origin = options[:line_origin]
+        @class_target = options[:class_target]
+        @module_origin = options[:module_origin]
+        @module_target = options[:module_target]
+        @msg = options[:msg]
+      end
+
+    end
+  end
+end

data/lib/archruby/architecture/dependency.rb

@@ -0,0 +1,11 @@
+module Archruby
+  module Architecture
+    class Dependency
+      attr_reader :class_name, :line_number
+      def initialize class_name, line_number
+        @class_name = class_name.to_s
+        @line_number = line_number
+      end
+    end
+  end
+end

data/lib/archruby/architecture/file_content.rb

@@ -0,0 +1,24 @@
+module Archruby
+  module Architecture
+    class FileContent
+
+      def initialize base_directory
+        # base_directory "/Users/sergiomiranda/Labs/ruby_arch_checker/arch_checker/spec/dummy_app/app"
+        @base_directory = base_directory
+      end
+
+      def all_content_from_directory directory
+        return if directory.nil? || directory.eql?("")
+        content = {}
+        file_paths = Dir.glob("#{@base_directory}/#{directory}")
+        file_paths.each do | file_path |
+          file = File.open(file_path, 'r')
+          file_name = File.basename(file_path, '.rb')
+          content[file_name] = file.read
+        end
+        content
+      end
+
+    end
+  end
+end