axr 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07cc36c3d0e6ff1efe1a1519a68cf8c9dacdf0ac8f61c73fdda1e69da7fc179c
-  data.tar.gz: aaca58deb866a1709cba78aeac7f264e3faa15476cefb1e24f761419aba15381
+  metadata.gz: 14c21dbe89798e76d232c029d5cae8843e1a25bc313453abbdb9ff6e3a7feed7
+  data.tar.gz: 14771453a1f39e857f5cb0edee0670ed332dfd71f90db6ae5e40579703037911
 SHA512:
-  metadata.gz: 76674bdd4990df3982fb13c4061e5494e55578bf2c612f1d27c6f0b04206adc1dc9e6879b3bb405155b989fa2b44d002f8b004f995cae1064e25d9b9236e5b63
-  data.tar.gz: 1473e443635bd793f7a7dfc9e261493d8076d0cbfad011e128ba0caf9ba622c20d1e2d07dd5e5f3d63bb7578fce564b5e7c55efc14312ff84637d5b00024505f
+  metadata.gz: d04a46e35c7ab0c314ae88dc431ceb373822074b146c92864a6c992df352bb1d53f3e3ee3d13130e23dda6de0463cf3a1455da26caf60b5ef4be29ba7d0824bb
+  data.tar.gz: 7d586e920c1b053fae07373a41a496a9c4a4a8b1e7de661a3c902ea461d9a8080dafc97b625ab40290e0f3ca5b3912f0d43a38057a41815d37c011b0d6b32fac

data/README.md

@@ -1,6 +1,6 @@
 # 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.
 
@@ -8,24 +8,27 @@ Few of us get to write software that survives 5-10 years or longer. 90% of our w
 
 This is just reality.
 
-(c) Me
+(c) Volodya Sveredyuk
 
-### Setup
+## Setup
 
 ```sh
 gem install axr
 ```
 
-or in your Gemfile:
+or in your Gemfile
 ```ruby
-gem 'axr', '~> 0.5'
+gem 'axr'
 ```
 
+in console
 ```sh
 bundle install
 ```
 
-Somewhere in your ruby app:
+## DSL
+
+In your ruby app: (for rails app put it into `config/initializers`)
 ```ruby
 require 'axr'
 
@@ -36,6 +39,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 +104,27 @@ Run for a specific file
 axr lib/adapters/youtube.rb
 ```
 
-### How it works
-...TODO
+## More examples
+
+**ERP system**
+
+<img src="docs/images/erp_example.png" alt="drawing" width="500"/>
+
+```ruby
+require 'axr'
+
+AxR.app.define(isolated: true) do
+  layer 'Api',    familiar_with: ['ERP']
+  layer 'UI',     familiar_with: ['ERP']
+  layer 'ERP',    familiar_with: %w[Inventory Sales Supply]
+  layer 'Sales',  familiar_with: 'Inventory'
+  layer 'Supply', familiar_with: 'Inventory'
+  layer 'Repo'
+  layer 'Change'
+  layer 'Query'
+end
+```
 
 ### TODO
 - Add sublayers
+- Add `axr check --exit-on-warning` cli flag

data/lib/axr/app.rb

@@ -37,7 +37,7 @@ module AxR
       dep = layers.find { |l| l.name.to_s == dependncy.to_s }
 
       return false unless ctx && dep
-      return false if ctx.isolated?
+      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

data/lib/axr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axr
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Volodya Sveredyuk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-30 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -145,6 +145,8 @@ files:
 - axr.gemspec
 - bin/console
 - bin/setup
+- docs/images/abcde_example.png
+- docs/images/erp_example.png
 - exe/axr
 - lib/axr.rb
 - lib/axr/app.rb