axr 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c51859d7fd901aa0da185f5fa5a176bc6d6e177bbaa1a8f3d7e10f5aa65f1e7
+  data.tar.gz: 67e05aea13a6d3ac1399212f09c3b7768a5c76affc4d397a382a9fd43f4ba9c9
+SHA512:
+  metadata.gz: 7de34cef752456c2cc603f70ba36ddc4088ac1cb89c0dcf2b2231c73e7112042b7b2a7db201cd99d037a42f0e467649daffe8dca0556cf7d7cdddf16da44057b
+  data.tar.gz: 27e72299bb4860cda3d92285a62b1f2e9efd9502f03619b4b3eb454b0c6f1691c5ab8718f98e3441c3ff74ad4267e1526b1175b1dcbae8eab868b026ad1109ef

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,37 @@
+require: rubocop-rails
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - bin/*
+    - Guardfile
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  ExcludedMethods: [
+    'describe', 'xdescribe', 'context',  'xcontext', 'it', 'xit', 'let', 'before', 'after', 'aggregate_failures'
+  ]
+
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 150
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/*'
+    - 'spec/**/*'
+    - 'spec/***/**/*'
+    - 'spec/****/***/**/*'
+    - 'spec/*****/****/***/*'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1 @@
+# CHANGELOG

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sveredyuk@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in axr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    axr (0.5.0)
+      colorize (~> 0.8.1)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.16.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.4)
+    listen (3.2.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  axr!
+  bundler (~> 2.0)
+  guard-rspec (~> 4.7.3)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.76.0)
+
+BUNDLED WITH
+   2.0.2

data/Guardfile

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Volodya Sveredyuk
+
+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,63 @@
+# AXR
+
+### Ruby applications architecture for simplicity and team adoption
+
+Architecture is hard. It’s very easy to build a complex system; much harder to build a simple and adaptable one. The code doesn't matter and coding for the sake of writing code is foolish.
+
+Few of us get to write software that survives 5-10 years or longer. 90% of our work is garbage that becomes obsolete 1-3 years after release. Most of our work hours are wasted on features that never get shipped.
+
+This is just reality.
+
+(c) Me
+
+### Setup
+
+```sh
+gem install axr
+```
+
+or in your Gemfile:
+```ruby
+gem 'axr', '~> 0.5'
+```
+
+```sh
+bundle install
+```
+
+Somewhere in your ruby app:
+```ruby
+require 'axr'
+
+AxR.app.define do
+  layer 'Api'
+  layer 'YourBusinessLogic'
+  layer 'Repo'
+end
+```
+
+Run `AxR` checker in console
+```sh
+axr check . --load path/to/you/app/autoload.rb
+```
+
+For rails apps
+```sh
+axr check . --load config/environment
+```
+
+Run for a specific directory
+```sh
+axr lib/adapters
+```
+
+Run for a specific file
+```sh
+axr lib/adapters/youtube.rb
+```
+
+### How it works
+...TODO
+
+### TODO
+- Add sublayers

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/axr.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'axr/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'axr'
+  spec.version     = AxR::VERSION
+  spec.authors     = ['Volodya Sveredyuk']
+  spec.email       = ['sveredyuk@gmail.com']
+  spec.summary     = 'Code checker for AxR compliance.'
+  spec.description = 'Code checker for AxR compliance.'
+  spec.homepage    = 'https://github.com/sveredyuk/axr'
+  spec.license     = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/sveredyuk/axr'
+  spec.metadata['changelog_uri'] = 'https://github.com/sveredyuk/axr/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = 'lib'
+
+  spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  spec.add_development_dependency 'pry', '~> 0.12.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.76.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "axr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/axr

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'axr'
+
+AxR::CLI.start(ARGV)

data/lib/axr.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'axr/app'
+require 'axr/cli'
+require 'axr/runner'
+require 'axr/version'
+
+module AxR
+  def self.app
+    @app ||= App.instance
+  end
+end

data/lib/axr/app.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+require_relative 'layer'
+
+module AxR
+  class App
+    include Singleton
+
+    LayerConflictError = Class.new(StandardError)
+
+    attr_reader :layers
+
+    def initialize
+      @layers = []
+    end
+
+    def define(&block)
+      instance_eval(&block)
+    end
+
+    def layer(layer_name, options = {})
+      check_name_conflict!(layer_name)
+
+      layers << AxR::Layer.new(layer_name, layers.size, options)
+    end
+
+    def layer_names
+      layers.map(&:name).map(&:to_s)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def legal?(context, dependncy)
+      ctx = layers.find { |l| l.name.to_s == context.to_s }
+      dep = layers.find { |l| l.name.to_s == dependncy.to_s }
+
+      return false unless ctx && dep
+      return false if ctx.isolated?
+      return true if ctx.familiar_with.map(&:to_s).include?(dependncy.to_s)
+
+      ctx.level < dep.level
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    private
+
+    def check_name_conflict!(layer_name)
+      return unless layers.map(&:name).include?(layer_name)
+
+      raise LayerConflictError, "Layer #{layer_name} is already defined in the app"
+    end
+
+    # Use only for testing purpose!
+    def reset
+      @layers = []
+    end
+  end
+end

data/lib/axr/cli.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module AxR
+  class CLI < Thor
+    desc 'check PATH', 'Start AxR runner'
+
+    option :format # TODO: Add formats
+    option :load # TODO: Add formats
+
+    def check(pattern = nil)
+      $LOAD_PATH << Dir.pwd
+      require options['load'] if options['load']
+      AxR::Runner.new(pattern).invoke
+    end
+  end
+end

data/lib/axr/formatters/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'colorized_string'
+
+# TODO: test output format
+
+module AxR
+  module Formatters
+    class Base
+      def single_file(_scanner, _file_path)
+        raise NotImplementedError
+      end
+
+      def summary(_warnings)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/axr/formatters/default.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'colorized_string'
+require_relative 'base'
+
+# TODO: test output format
+module AxR
+  module Formatters
+    class Default < Base
+      DOT = '.'
+      STAR = '*'
+
+      def single_file(scanner, _file_path)
+        if scanner.warnings.any?
+          STDOUT.print ColorizedString[STAR].colorize(:yellow)
+        else
+          STDOUT.print ColorizedString[DOT].colorize(:green)
+        end
+      end
+
+      def summary(scanned_files, files_with_warnings)
+        STDOUT.puts
+        STDOUT.puts
+
+        issues_amount = 0
+
+        files_with_warnings.each_pair do |file_path, warnings|
+          warnings.each do |warning|
+            issues_amount += 1
+            msg = "#{file_path}:#{warning.loc_num} # => #{warning.message}"
+            STDOUT.puts ColorizedString[msg].colorize(:yellow)
+          end
+        end
+
+        STDOUT.puts
+        STDOUT.puts
+        STDOUT.puts("#{scanned_files.size} files scanned. #{issues_amount} issues detected")
+      end
+    end
+  end
+end

data/lib/axr/layer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module AxR
+  class Layer
+    attr_reader :name, :level, :isolated, :familiar_with
+
+    def initialize(name, level, options = {})
+      @name          = name
+      @level         = level
+      @isolated      = options.fetch(:isolated, false)
+      @familiar_with = *options.fetch(:familiar_with, [])
+    end
+
+    alias isolated? isolated
+  end
+end

data/lib/axr/runner.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'axr/scanner'
+require 'axr/formatters/default'
+
+module AxR
+  class Runner
+    DOT_RB = '.rb'
+
+    attr_reader :target, :formatter
+
+    def initialize(target = nil, formatter: AxR::Formatters::Default.new)
+      @target    = target
+      @formatter = formatter
+    end
+
+    def invoke
+      files_with_warnings = files_to_scan.each_with_object({}) do |file_path, issues|
+        scan_result = AxR::Scanner.new(file_path: file_path).scan
+        issues[file_path] = scan_result.warnings if scan_result.warnings.any?
+        formatter.single_file(scan_result, file_path)
+      end
+
+      formatter.summary(files_to_scan, files_with_warnings)
+
+      # exit 1 if files_with_warnings.any?
+
+      files_with_warnings
+    end
+
+    def files_to_scan
+      @files_to_scan ||= if scan_single_file?
+                           [target]
+                         else
+                           Dir.glob("#{target_dir}**/*.rb")
+                         end
+    end
+
+    private
+
+    def scan_single_file?
+      return false unless target
+      return false unless target.end_with?(DOT_RB)
+
+      target
+    end
+
+    def target_dir
+      return unless target
+
+      "#{target}/"
+    end
+  end
+end

data/lib/axr/scanner.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'scanner/detection'
+require_relative 'scanner/warning'
+
+module AxR
+  class Scanner
+    attr_reader :file_path, :context, :dependecies, :warnings
+
+    def initialize(file_path:)
+      @file_path   = file_path
+      @dependecies = []
+      @warnings    = []
+      @context     = nil
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def scan
+      File.open(file_path).each.with_index do |line, index|
+        loc_num = index + 1
+
+        line_detection    = AxR.app.layer_names.detect { |layer| line.include?(layer) }
+        line_detection    = check_space_before(line, line_detection)
+        context_detection = AxR.app.layer_names.detect { |layer| line.include?("module #{layer}") }
+
+        next unless line_detection || context_detection
+
+        detect_context(context_detection, line, loc_num) if context_detection && !context
+        detect_dependency(line_detection, line, loc_num)
+        detect_warning(line_detection,    line, loc_num) if context
+      end
+
+      self
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    private
+
+    def detect_context(value, loc, loc_num)
+      @context = Detection.new(name: value, loc: cleanup_loc(loc), loc_num: loc_num)
+    end
+
+    def detect_dependency(value, loc, loc_num)
+      return if context && value == context.name
+
+      @dependecies << Detection.new(name: value, loc: cleanup_loc(loc), loc_num: loc_num)
+    end
+
+    def detect_warning(value, loc, loc_num)
+      return if value == context.name
+      return if AxR.app.legal?(context.name, value)
+
+      msg = "#{context.name} layer should not be familiar with #{value}"
+
+      @warnings << Warning.new(message: msg, loc: cleanup_loc(loc), loc_num: loc_num)
+    end
+
+    def cleanup_loc(loc)
+      loc.chomp.strip
+    end
+
+    SPACE = ' '
+
+    def check_space_before(line, line_detection)
+      return unless line_detection
+
+      line_detection if line[line.index(line_detection) - 1] == SPACE
+    end
+  end
+end

data/lib/axr/scanner/detection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'axr/scanner'
+
+module AxR
+  class Scanner
+    class Detection
+      attr_reader :name, :loc, :loc_num
+
+      def initialize(name:, loc:, loc_num:)
+        @name    = name
+        @loc     = loc
+        @loc_num = loc_num
+      end
+    end
+  end
+end

data/lib/axr/scanner/warning.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'axr/scanner'
+
+module AxR
+  class Scanner
+    class Warning
+      attr_reader :message, :loc, :loc_num
+
+      def initialize(message:, loc:, loc_num:)
+        @message = message
+        @loc     = loc
+        @loc_num = loc_num
+      end
+    end
+  end
+end

data/lib/axr/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AxR
+  VERSION = '0.5.0'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: axr
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Volodya Sveredyuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+description: Code checker for AxR compliance.
+email:
+- sveredyuk@gmail.com
+executables:
+- axr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- axr.gemspec
+- bin/console
+- bin/setup
+- exe/axr
+- lib/axr.rb
+- lib/axr/app.rb
+- lib/axr/cli.rb
+- lib/axr/formatters/base.rb
+- lib/axr/formatters/default.rb
+- lib/axr/layer.rb
+- lib/axr/runner.rb
+- lib/axr/scanner.rb
+- lib/axr/scanner/detection.rb
+- lib/axr/scanner/warning.rb
+- lib/axr/version.rb
+homepage: https://github.com/sveredyuk/axr
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/sveredyuk/axr
+  source_code_uri: https://github.com/sveredyuk/axr
+  changelog_uri: https://github.com/sveredyuk/axr/CHANGELOG.md
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Code checker for AxR compliance.
+test_files: []