axr 0.6.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d3de45148c936da6efb0f3f3ae56a53aa3574a52d64334c270a54addd16669
-  data.tar.gz: a4d246801ee4e301ba5e12230fc66488b90a6ce6ae6af9d6c510a90ff5e1c10c
+  metadata.gz: f72dad434e267f3a0b9576b013af83a164ac2bf87f3879b1652f17df793627fc
+  data.tar.gz: 91c2b57c9b973ca7069eca9b14363d73abd0f56bcbfa1ddb71a6342030d60c88
 SHA512:
-  metadata.gz: fb0e1511bd8dee8785c1f2aadec5e96140ad2d16dff6f4b3303a57e7f19b6b16236f62a7456bb6b2801f7439b2f270b3d92f1e8738ad1ba422896414b1fbc6fa
-  data.tar.gz: 876e391294b55080b4ca6eced2fee4788be6e3d9f1ffafdacba0a8fc884c76e236e08d1d572f32da277f7d110384ac69301eac3314a980f472860e6a4cabea42
+  metadata.gz: 35a230de00be2d28acb46c438287dd641900e03429f05928a9734d603cac8af7f3e6654b3b5683670936514c606f163cb5a99d940ad559b1705111273bb1d08c
+  data.tar.gz: cbe88f73c7e2e543c46d5d2a9a940b6fa92eb9e3a62143dcc1124b54baf2b51592265449394ca4eee910b39d0497609277648b0006e4095e574e01781c61ddff

data/.rubocop.yml

@@ -13,6 +13,9 @@ Style/Documentation:
 Metrics/LineLength:
   Max: 120
 
+Metrics/AbcSize:
+  Max: 20
+
 Metrics/BlockLength:
   ExcludedMethods: [
     'describe',

data/.travis.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    axr (0.6.2)
+    axr (0.7.1)
       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.3)
+    ffi (1.12.2)
     formatador (0.2.5)
     guard (2.16.1)
       formatador (>= 0.2.4)
@@ -32,14 +32,14 @@ GEM
     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.19.1)
-    parser (2.7.0.0)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -53,15 +53,15 @@ GEM
       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

data/README.md

@@ -2,11 +2,12 @@
 
 **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 a reality.
 
-This is just reality.
 
 (c) Volodya Sveredyuk
 
@@ -28,7 +29,7 @@ bundle install
 
 ## DSL
 
-In your ruby app: (for rails app put it into `config/initializers`)
+In your ruby app: (for rails app put it into `config/initializers/axr.rb` file)
 ```ruby
 require 'axr'
 
@@ -104,6 +105,11 @@ Run for a specific file
 axr lib/adapters/youtube.rb
 ```
 
+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-warning`
+```
+
 ## More examples
 
 **ERP system**
@@ -111,20 +117,24 @@ axr lib/adapters/youtube.rb
 <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'
+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
 - Add sublayers
-- Add `axr check --exit-on-warning` cli flag
+- Add rubocop cop
+- Add more app examples
+- Migrate to AST analyzer

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,16 +7,19 @@ 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)
@@ -24,7 +27,7 @@ module AxR
 
       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

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,7 +16,7 @@ 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) }

data/lib/axr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axr
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Volodya Sveredyuk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -182,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Code checker for AxR compliance.