ducalis 0.5.8 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21e653839c1ac51f59d14a84abede1d7f3fc8d95
-  data.tar.gz: 89f274016015741d35d85b1c664191b41ec05948
+  metadata.gz: 9df1822f6834c733ed48f31e1957334cc59b5f42
+  data.tar.gz: 34669e5f892a97db37ef4af821e44f144d4a57df
 SHA512:
-  metadata.gz: e2ac4461691ba39f23a0e1f5fa7bef701daf5b50cad2c31bec1ced0556899f27923efc0490d37bbcffa00fec3c594015497e6c406d325dc5d40e40d7ff9e2a92
-  data.tar.gz: 78e397569b05a3859b4ef295298f03cf17ea91746a1791d86f01688712cb9ad0619c46259f2f171cf71a58967275886e9075acc6751a002d8e11af8b0878bc65
+  metadata.gz: 8e06ee445e45f02521f7b952ddfea25927dbe5fb4e04c6dad60b00f14dba0dce6f8a885483d5bf0389f05c853b7d7d15b067ab7f52294266fdaf336a08eace69
+  data.tar.gz: 93df41092dc3b5bf2f3668f6149fbb51f9ff728d3a67278a9e8b663309da626739d2af6e3bee020b543658755e623bb10214774043faafe94a51b7e3da231d4c

data/DOCUMENTATION.md

@@ -636,6 +636,11 @@ It's better to add exception class as raise argument. It will make
 raise "Something went wrong"
 ```
 
+![](https://placehold.it/10/f03c15/000000?text=+) raises when `raise` called without arguments
+```ruby
+raise
+```
+
 ![](https://placehold.it/10/2cbe4e/000000?text=+) ignores when `raise` called with exception class
 ```ruby
 raise StandardError, "Something went wrong"
@@ -780,6 +785,76 @@ before_save :set_full_name,
 ```ruby
 validates :file, if: -> { remote_url.blank? }
 ```
+## Ducalis::TooLongWorkers
+
+Seems like your worker is doing too much work, consider of moving business
+ logic to service object. As rule, workers should have only two responsibilities:
+ - __Model materialization__: As async jobs working with serialized attributes
+ it's nescessary to cast them into actual objects.
+ - __Errors handling__: Rescue errors and figure out what to do with them.
+
+![](https://placehold.it/10/f03c15/000000?text=+) raises for a class with more than 5 lines
+```ruby
+class TestWorker
+  a = 1
+  a = 2
+  a = 3
+  a = 4
+  a = 5
+  a = 6
+end
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) ignores non-worker classes
+```ruby
+class StrangeClass
+  a = 1
+  a = 2
+  a = 3
+  a = 4
+  a = 5
+  a = 6
+end
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) accepts a class with 5 lines
+```ruby
+class TestWorker
+  a = 1
+  a = 2
+  a = 3
+  a = 4
+  a = 5
+end
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) accepts a class with less than 5 lines
+```ruby
+class TestWorker
+  a = 1
+  a = 2
+  a = 3
+  a = 4
+end
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) accepts empty classes
+```ruby
+class TestWorker
+end
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) also counts commented lines
+```ruby
+class TestWorker
+  a = 1
+  #a = 2
+  a = 3
+  #a = 4
+  a = 5
+  a = 6
+end
+```
 ## Ducalis::UncommentedGem
 
 Please, add comment why are you including non-realized gem version for

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ducalis (0.5.8)
+    ducalis (0.5.9)
       git (~> 1.3, >= 1.3.0)
       policial (= 0.0.4)
       regexp-examples (~> 1.3, >= 1.3.2)

data/config/.ducalis.yml

@@ -2,6 +2,7 @@ AllCops:
   DisabledByDefault: true
   TargetRubyVersion: 2.3
   Exclude:
+    - 'db/**/*'
     - 'node_modules/**/*'
     - 'vendor/bundle/**/*'
 
@@ -33,6 +34,10 @@ Ducalis/PossibleTap:
 
 Ducalis/ProtectedScopeCop:
   Enabled: true
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'app/workers/**/*.rb'
+    - 'app/mailers/**/*.rb'
 
 Ducalis/RegexCop:
   Enabled: true
@@ -42,6 +47,10 @@ Ducalis/RegexCop:
 Ducalis/StringsInActiverecords:
   Enabled: true
 
+Ducalis/TooLongWorkers:
+  Enabled: true
+  Max: 25
+
 Ducalis/UselessOnly:
   Enabled: true
 

data/lib/ducalis.rb

@@ -47,5 +47,6 @@ require 'ducalis/cops/regex_cop'
 require 'ducalis/cops/rest_only_cop'
 require 'ducalis/cops/rubocop_disable'
 require 'ducalis/cops/strings_in_activerecords'
+require 'ducalis/cops/too_long_workers'
 require 'ducalis/cops/uncommented_gem'
 require 'ducalis/cops/useless_only'

data/lib/ducalis/cops/too_long_workers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Ducalis
+  class TooLongWorkers < RuboCop::Cop::Cop
+    include RuboCop::Cop::ClassishLength
+
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Seems like your worker is doing too much work, consider of moving business
+      | logic to service object. As rule, workers should have only two responsibilities:
+      | - __Model materialization__: As async jobs working with serialized attributes
+      | it's nescessary to cast them into actual objects.
+      | - __Errors handling__: Rescue errors and figure out what to do with them.
+    MESSAGE
+
+    WORKERS_SUFFIXES = %w(Worker Job).freeze
+
+    def on_class(node)
+      return unless worker_class?(node)
+      check_code_length(node)
+    end
+
+    private
+
+    def worker_class?(node)
+      classdef_node, _superclass, _body = *node
+      classdef_node.source.end_with?(*WORKERS_SUFFIXES)
+    end
+
+    def message(length, max_length)
+      format("#{OFFENSE} [%d/%d]", length, max_length)
+    end
+  end
+end

data/lib/ducalis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ducalis
-  VERSION = '0.5.8'
+  VERSION = '0.5.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducalis
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.9
 platform: ruby
 authors:
 - Ignat Zakrevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -146,6 +146,7 @@ files:
 - lib/ducalis/cops/rest_only_cop.rb
 - lib/ducalis/cops/rubocop_disable.rb
 - lib/ducalis/cops/strings_in_activerecords.rb
+- lib/ducalis/cops/too_long_workers.rb
 - lib/ducalis/cops/uncommented_gem.rb
 - lib/ducalis/cops/useless_only.rb
 - lib/ducalis/documentation.rb