axr 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07cc36c3d0e6ff1efe1a1519a68cf8c9dacdf0ac8f61c73fdda1e69da7fc179c
-  data.tar.gz: aaca58deb866a1709cba78aeac7f264e3faa15476cefb1e24f761419aba15381
+  metadata.gz: 1c1451590219c2fdac14e2352ef0a6af39dd388b60cc8caa5c1a86fac06e901a
+  data.tar.gz: 54b6490d145aff76491361d3cfa05c892aeb4ada42f743617ebe0598a0e428bc
 SHA512:
-  metadata.gz: 76674bdd4990df3982fb13c4061e5494e55578bf2c612f1d27c6f0b04206adc1dc9e6879b3bb405155b989fa2b44d002f8b004f995cae1064e25d9b9236e5b63
-  data.tar.gz: 1473e443635bd793f7a7dfc9e261493d8076d0cbfad011e128ba0caf9ba622c20d1e2d07dd5e5f3d63bb7578fce564b5e7c55efc14312ff84637d5b00024505f
+  metadata.gz: 464f7640c98b92353df69f233210d896a7036a9b0e19a723e3b1480743e93bcfd40cd2c79affb4469eb48a1ffaf485984a95b0f8677c2384a77a30cbfac58468
+  data.tar.gz: 878bc7e2300eea09534bae0e33d24e303903a1b7be0479f12207da6e35822cb825460ee595c74a7955e7b507e44094e85357119367c025a92ea4bc7d3c200987

data/.gitignore

@@ -7,6 +7,10 @@
 /spec/reports/
 /tmp/
 
+# development files
+.ruby-gemset
+.ruby-version
+
 # rspec failure tracking
 .rspec_status
 *.gem

data/.rubocop.yml

@@ -1,10 +1,11 @@
-require: rubocop-rails
+require: rubocop
 
 AllCops:
   TargetRubyVersion: 2.6
   Exclude:
     - bin/*
     - Guardfile
+    - vendor/**/*
 
 Style/Documentation:
   Enabled: false
@@ -12,12 +13,23 @@ Style/Documentation:
 Metrics/LineLength:
   Max: 120
 
+Metrics/AbcSize:
+  Max: 20
+
 Metrics/BlockLength:
   ExcludedMethods: [
-    'describe', 'xdescribe', 'context',  'xcontext', 'it', 'xit', 'let', 'before', 'after', 'aggregate_failures'
+    'describe',
+    'xdescribe',
+    'context',
+    'xcontext',
+    'it',
+    'xit',
+    'let',
+    'before',
+    'after',
+    'aggregate_failures'
   ]
 
-
 Metrics/MethodLength:
   Max: 15
 

data/.travis.yml

@@ -1,7 +1,13 @@
 ---
-sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+before_install:
+  - gem install bundler
+  - bundle install
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    axr (0.6.0)
+    axr (0.8.0)
       colorize (~> 0.8.1)
       thor (~> 0.20)
 
@@ -12,7 +12,7 @@ GEM
     coderay (1.1.2)
     colorize (0.8.1)
     diff-lcs (1.3)
-    ffi (1.11.1)
+    ffi (1.12.2)
     formatador (0.2.5)
     guard (2.16.1)
       formatador (>= 0.2.4)
@@ -29,39 +29,39 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     jaro_winkler (1.5.4)
-    listen (3.2.0)
+    listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.0.13)
+    lumberjack (1.2.4)
     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)
+    parallel (1.19.1)
+    parser (2.7.0.5)
       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)
+    rake (12.3.3)
     rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    rb-inotify (0.10.1)
       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)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.2)
     rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -72,7 +72,7 @@ GEM
     ruby-progressbar (1.10.1)
     shellany (0.0.1)
     thor (0.20.3)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
 
 PLATFORMS
   ruby
@@ -82,7 +82,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   guard-rspec (~> 4.7.3)
   pry (~> 0.12.2)
-  rake (~> 10.0)
+  rake (~> 12.3.3)
   rspec (~> 3.0)
   rubocop (~> 0.76.0)
 

data/README.md

@@ -1,31 +1,44 @@
 # AXR
 
-### Ruby applications architecture for simplicity and team adoption
+**Ruby 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.
+Architecture's hard. It’s very easy to build a complex system. Much harder to build a simple and adaptable solution. The code doesn't matter. 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.
+Only a few of us get to write software that survives 5-10 years or longer. 90% of our work is garbage that becomes obsolete in 1-3 years after release. Most of our work hours are wasted on features that will never be useful.
 
-This is just reality.
+This is just a reality.
 
-(c) Me
 
-### Setup
+(c) Volodya Sveredyuk
 
-```sh
-gem install axr
-```
+## Motivation
+Application engineering it's always about abstractions and how they describe the real world and business which pays our salaries for coding something that might improve it. Maybe. Sometimes.
+
+I hate doing something alone. I am a team player and as a team player, I prefer conventions over configuration. But this is not working with knowledge responsibility segregation inside the software app. In the Ruby world (especially Rails) it's so easy to add a new feature. Just add one line, one dependency, one callback and now you share knowledge about one entity into another entity. More dependencies - more spaghetti and legacy that in future we should REWRITE EVERYTHING!
+
+<img src="docs/images/rewrite.png" alt="drawing" width="500"/>
+
+Architecture's about knowledge responsibility and not the code.
+
+The worst thing that even we write the architecture document wherein a convenient way to agree on architecture and layers and entities, etc - We are not protected from violation of these conventions.
 
-or in your Gemfile:
+And this the place where AxR comes on the stage.
+
+Please, welcome the **DSL** that helps:
+1. Describes your application layers (modules)
+2. Defines knowledge responsibilities between them
+3. Checks if you did not violate anything
+
+## Setup
+
+In your Gemfile
 ```ruby
-gem 'axr', '~> 0.5'
+gem 'axr'
 ```
 
-```sh
-bundle install
-```
+## DSL
 
-Somewhere in your ruby app:
+In your ruby app: (for rails app put it into `config/initializers/axr.rb` file)
 ```ruby
 require 'axr'
 
@@ -36,6 +49,51 @@ AxR.app.define do
 end
 ```
 
+By default, layers will get level from top to bottom.
+```
+Api -> 0
+YourBusinessLogic -> 1
+Repo -> 2
+```
+
+Layers with lower-level have less isolation.
+
+- `Api` knows about `YourBusinessLogic` and `Repo`
+- `YourBusinessLogic` knows about `Repo` but don't know anything about `Api`
+- `Repo` fully isolated and don't familiar with `Api` and `YourBusinessLogic`
+
+**Options**
+
+```ruby
+require 'axr'
+
+AxR.app.define do
+  layer 'A'
+  layer 'B', familiar_with: 'C'
+  layer 'C', familiar_with: 'B'
+  layer 'D', isolated: true
+  layer 'E', isolated: true
+end
+```
+
+```ruby
+
+# app.define options
+AxR.app.define(isolated: true) # All layers will be isolated by default
+AxR.app.define(familiar_with: ['D', 'E') # All layers will be familiar with D and E by default
+
+# layer options
+familiar_with: [...] # Can operate with other layers
+isolated: true # 100% isolated and should not operate with other layers
+isolated: true, familiar_with: [...] # Isolated from all except familiars
+```
+
+Can organize knowledge structure like:
+
+<img src="docs/images/abcde_example.png" alt="drawing" width="500"/>
+
+## CLI
+
 Run `AxR` checker in console
 ```sh
 axr check . --load path/to/you/app/autoload.rb
@@ -56,8 +114,38 @@ Run for a specific file
 axr lib/adapters/youtube.rb
 ```
 
-### How it works
-...TODO
+Finish scanning with status code 1 in case of any warnings (you can use in CI environment to fail pipeline step)
+```sh
+axr check --exit-on-warnings
+```
+
+## More examples
+
+**ERP system**
+
+<img src="docs/images/erp_example.png" alt="drawing" width="500"/>
+
+```ruby
+if Rails.env.development? || Rails.env.test?
+  require 'axr'
+
+  AxR.app.define(isolated: true) do
+    layer 'UI',         familiar_with: %w[Docs Inventory Production]
+    layer 'API',        familiar_with: %w[Docs Inventory Production]
+    layer 'Docs',       familiar_with: %w[Inventory Accounts Repo]
+    layer 'Accounts',   familiar_with: %w[Repo]
+    layer 'Inventory',  familiar_with: %w[Repo]
+    layer 'Production', familiar_with: %w[Repo]
+    layer 'Repo'
+  end
+end
+
+```
 
 ### TODO
+- Ignore vendor or any other directories dir as configuration
 - Add sublayers
+- Add rubocop cop
+- Add more app examples
+- Migrate to AST analyzer
+

data/axr.gemspec

@@ -30,12 +30,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = 'lib'
 
   spec.add_dependency 'colorize', '~> 0.8.1'
-  spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'thor',     '~> 0.20'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  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'
+  spec.add_development_dependency 'pry',         '~> 0.12.2'
+  spec.add_development_dependency 'rake',        '~> 12.3.3'
+  spec.add_development_dependency 'rspec',       '~> 3.0'
+  spec.add_development_dependency 'rubocop',     '~> 0.76.0'
 end

data/lib/axr/app.rb

@@ -37,8 +37,8 @@ module AxR
       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)
+      return false if ctx.isolated? && ctx.familiar_with.empty?
+      return true  if ctx.familiar_with.map(&:to_s).include?(dependncy.to_s)
 
       ctx.level < dep.level
     end

data/lib/axr/cli.rb

@@ -4,15 +4,18 @@ require 'thor'
 
 module AxR
   class CLI < Thor
-    desc 'check PATH', 'Start AxR runner'
+    desc 'check PATH',           'Start AxR runner'
+    desc '--load APP_INIT_PATH', 'Specify file to load your ruby application'
+    desc '--exit-on-warnings',   'Finish with status code 1 on any warnings'
 
-    option :format # TODO: Add formats
-    option :load # TODO: Add formats
+    option :format # TODO: Add more output formats
+    option :load
+    option :'exit-on-warnings'
 
     def check(pattern = nil)
       $LOAD_PATH << Dir.pwd
       require options['load'] if options['load']
-      AxR::Runner.new(pattern).invoke
+      AxR::Runner.new(pattern, exit_on_warnings: !options['exit-on-warnings'].nil?).invoke
     end
   end
 end

data/lib/axr/runner.rb

@@ -7,33 +7,33 @@ module AxR
   class Runner
     DOT_RB = '.rb'
 
-    attr_reader :target, :formatter
+    attr_reader :target, :formatter, :exit_on_warnings
 
-    def initialize(target = nil, formatter: AxR::Formatters::Default.new)
-      @target    = target
-      @formatter = formatter
+    def initialize(target = nil, formatter: AxR::Formatters::Default.new, exit_on_warnings: false)
+      @target            = target
+      @formatter         = formatter
+      @exit_on_warnings = exit_on_warnings
     end
 
+    alias exit_on_warnings? exit_on_warnings
+
     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
+        scan_result       = AxR::Scanner.new(source: File.open(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?
+      exit 1 if exit_on_warnings? && 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
+      @files_to_scan ||= scan_single_file? ? [target] : Dir.glob("#{target_dir}**/*#{DOT_RB}")
     end
 
     private

data/lib/axr/scanner.rb

@@ -5,10 +5,10 @@ require_relative 'scanner/warning'
 
 module AxR
   class Scanner
-    attr_reader :file_path, :context, :dependecies, :warnings
+    attr_reader :source, :context, :dependecies, :warnings
 
-    def initialize(file_path:)
-      @file_path   = file_path
+    def initialize(source: [])
+      @source      = source
       @dependecies = []
       @warnings    = []
       @context     = nil
@@ -16,18 +16,19 @@ module AxR
 
     # rubocop:disable Metrics/AbcSize
     def scan
-      File.open(file_path).each.with_index do |line, index|
+      source.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}") }
+        line_detection    = nil if context && module_definition?(line, line_detection)
+        context_detection = AxR.app.layer_names.detect { |layer| module_definition?(line, layer) }
 
-        next unless line_detection || context_detection
+        next unless context_detection || line_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
+        detect_warning(line_detection,    line, loc_num) if context && line_detection
       end
 
       self
@@ -66,5 +67,11 @@ module AxR
 
       line_detection if line[line.index(line_detection) - 1] == SPACE
     end
+
+    MODULE = 'module'
+
+    def module_definition?(line, layer)
+      line.include?("#{MODULE} #{layer}")
+    end
   end
 end

data/lib/axr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axr
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Volodya Sveredyuk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-30 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +145,9 @@ files:
 - axr.gemspec
 - bin/console
 - bin/setup
+- docs/images/abcde_example.png
+- docs/images/erp_example.png
+- docs/images/rewrite.png
 - exe/axr
 - lib/axr.rb
 - lib/axr/app.rb
@@ -180,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Code checker for AxR compliance.