Skip to content
Simple architecture for the better ruby applications
Ruby Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Initial commit 🎉 Nov 7, 2019
docs/images 0.6.1 Fix isolation by default bug. Improve docs Dec 2, 2019
exe
lib 0.6.1 Fix isolation by default bug. Improve docs Dec 2, 2019
spec 0.6.1 Fix isolation by default bug. Improve docs Dec 2, 2019
.gitignore AxR::Runner with STDOUT Nov 7, 2019
.rspec Initial commit 🎉 Nov 7, 2019
.rubocop.yml 0.5 Release Nov 28, 2019
.travis.yml Initial commit 🎉 Nov 7, 2019
CHANGELOG.md Initial commit 🎉 Nov 7, 2019
CODE_OF_CONDUCT.md Initial commit 🎉 Nov 7, 2019
Gemfile Initial commit 🎉 Nov 7, 2019
Gemfile.lock AxR::App with default values Nov 30, 2019
Guardfile AxR::Runner with STDOUT Nov 7, 2019
LICENSE.txt Initial commit 🎉 Nov 7, 2019
README.md 0.6.1 Fix isolation by default bug. Improve docs Dec 2, 2019
Rakefile Initial commit 🎉 Nov 7, 2019
axr.gemspec 0.5 Release Nov 28, 2019

README.md

AXR

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.

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) Volodya Sveredyuk

Setup

gem install axr

or in your Gemfile

gem 'axr'

in console

bundle install

DSL

In your ruby app: (for rails app put it into config/initializers)

require 'axr'

AxR.app.define do
  layer 'Api'
  layer 'YourBusinessLogic'
  layer 'Repo'
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

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
# 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:

drawing

CLI

Run AxR checker in console

axr check . --load path/to/you/app/autoload.rb

For rails apps

axr check . --load config/environment

Run for a specific directory

axr lib/adapters

Run for a specific file

axr lib/adapters/youtube.rb

More examples

ERP system

drawing

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
You can’t perform that action at this time.